Project

eol

0.0
No commit activity in last 3 years
No release in over 3 years
A wrapper for the Encyclopedia of Life API. It provides simple methods to call all of the available EOL API endpoints.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.14
~> 10.0
~> 3.6
~> 0.49.1
~> 0.10
~> 3.0
~> 3.0
~> 0.9

Runtime

~> 0.15
 Project Readme

Encyclopedia of Life API Wrapper

Build Status Gem Version

Description

A wrapper for the Encyclopedia of Life API. It provides simple methods to call all of the available EOL API endpoints.

Installation

Add this line to your application's Gemfile:

gem 'eol'

And then execute:

$ bundle

Or install it yourself as:

$ gem install eol

Examples

Search for some orchids

# create a search
search = Eol.search("tolumnia")

# decide to modify the search
search = Eol.search("tolumnia", exact: true)

# print links to your results
search.each do |search|
  puts search.link
end

Make requests with or without options

# get collections
collections = Eol.collections("176")

# get sorted and cached collections
collections = Eol.collections('176', sort_by: 'oldest', cache_ttl: 30)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/itroman/eol. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.