eol 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2662b8d0df748e74e3a92a3b540c0608623f89ed
+  data.tar.gz: 50b0ff770d5ab2f8cf7ddc901a1df9e1cd631c19
+SHA512:
+  metadata.gz: ece05a50c31c0c369bb467fb7c244e0167341c607b00475e50ecb8ce9d9b9f75948c3d8422d4600c3ebca6dacf4e72310d5ebdd2856d0ce989284fc48cded616
+  data.tar.gz: b284bd2bf417542905c86addead556a988d4b2d2a261ea767440b553b7975756530e2924343ed5138d38052146636d31f62531e51a9367e317dfd7835c80e452

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+dist: trusty
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.14.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at romanrob2003@yahoo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eol.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rob Roman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Encyclopedia of Life API Wrapper
+
+[![Build Status](https://travis-ci.org/itroman/eol.svg?branch=master)](https://travis-ci.org/itroman/eol)
+
+## 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:
+
+```ruby
+gem 'eol'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eol
+
+## Examples
+
+#### Search for some orchids
+```ruby
+# 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
+```ruby
+# 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](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # rspec not available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eol"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/eol.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eol/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eol"
+  spec.version       = Eol::VERSION
+  spec.authors       = ["Rob Roman"]
+  spec.email         = ["rob@romancoding.com"]
+
+  spec.summary       = "A comprehensive Encyclopedia of Life API wrapper"
+  spec.description   = "A wrapper for the Encyclopedia of Life API.  It provides simple methods to call all of the available EOL API endpoints."
+  spec.homepage      = "http://github.com/itroman/eol-ruby"
+  spec.license       = "MIT"
+  
+  spec.required_ruby_version  = '>= 2.0.0'
+  
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.49.1"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+  
+  spec.add_dependency "httparty", "~> 0.15"
+end

data/lib/eol.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+require_relative 'eol/version'
+require_relative 'eol/search'
+require_relative 'eol/ping'
+require_relative 'eol/pages'
+require_relative 'eol/collections'
+require_relative 'eol/data_objects'
+require_relative 'eol/hierarchy_entries'
+require_relative 'eol/hierarchies'
+require_relative 'eol/provider_hierarchies'
+require_relative 'eol/search_by_provider'
+require 'httparty'
+
+# The Eol namespace holds all methods and classes that interact with the
+# Encyclopedia of Life API.
+module Eol
+  include HTTParty
+
+  base_uri 'eol.org/api'
+
+  # Pings the EOL API
+  #
+  # @see http://www.eol.org/api/docs/ping
+  # @example
+  #   Eol.ping ==> #<Eol::Ping:0x000000027ffcb8 @message="Success">
+  # @return [Eol::Ping] Success or failure results
+  def self.ping
+    response = get('/ping/1.0.json')
+    response.code == 200 ? Eol::Ping.new(response['response']['message']) : bad_response(response)
+  end
+
+  # Returns one page of results from the EOL API search
+  #
+  # @see http://www.eol.org/api/docs/search
+  # @param [String] query The species you're looking for.
+  # @param [Hash] query_options
+  # @option query_options [Integer] :page a maximum of 30 results are returned
+  #   per page. This parameter allows you to fetch more pages of results if
+  #   there are more than 30 matches
+  # @option query_options [String] :exact will find taxon pages if the preferred
+  #  name or any synonym or common name exactly matches the search term, `true`
+  #  or `false`
+  # @option query_options [Integer] :filter_by_taxon_concept_id given an EOL
+  #   page ID, search results will be limited to members of that taxonomic group
+  # @option query_options [Integer] :filter_by_hierarchy_entry_id given a
+  #   Hierarchy Entry ID, search results will be limited to members of that
+  #   taxonomic group
+  # @option query_options [String] :filter_by_string given a search term, an
+  #   exact search will be made and that matching page will be used as the
+  #   taxonomic group against which to filter search results
+  # @option query_options [Integer] :cache_ttl the number of seconds you wish to
+  #   have the response cached
+  # @example
+  #   Eol.search("dendrophylax", 'exact':true) ==> [#<Eol::Search:0x000000023e0a10 @id=37413, @title="Dendrophylax", @link= ...>]
+  # @return [Array<Eol::Search>]
+  def self.search(query, query_options = {})
+    @query = { q: query }.merge!(query_options)
+    response = get('/search/1.0.json', query: @query)
+    response.code == 200 ? response['results'].map { |item| Eol::Search.new(item) } : bad_response(response)
+  end
+
+  # Returns all results from an EOL API search
+  #
+  # @see http://www.eol.org/api/docs/search
+  # @param [String] query The species you're looking for.
+  # @note this method does not accept query options, for a more customized search
+  #   use Eol.search
+  # @example
+  #   Eol.search_all("dendrophylax") ==> [#<Eol::Search:0x000000023e0a10 @id=37413, @title="Dendrophylax", @link= ...>]
+  # @return (see search)
+  def self.search_all(query)
+    @query = { q: query }
+    response = get('/search/1.0.json', query: @query)
+    response.code == 200 ? all_pages(query, response) : bad_response(response)
+  end
+
+  # This method takes an EOL page identifier and returns the scientific name for
+  # that page, and optionally returns information about common names, media
+  # (text, images and videos), and references to the hierarchies which
+  # recognize the taxon described on the page.
+  #
+  # @see http://eol.org/api/docs/pages
+  # @param [String] id identifier for node in hierarchies which EOL indexes
+  # @param [Hash] query_options
+  # @option query_options [Boolean] :batch (False) returns either a batch or not
+  # @option query_options [0-75] :images_per_page limits the number of returned
+  #   image objects
+  # @option query_options [Integer] :images_page (1) images page
+  # @option query_options [0-75] :videos_per_page limits the number of returned
+  # @option query_options [Integer] :videos_page (1) videos page
+  # @option query_options [0-75] :sounds_per_page limits the number of returned
+  # @option query_options [Integer] :sounds_page (1) sounds page
+  # @option query_options [0-75] :maps_per_page limits the number of returned
+  # @option query_options [Integer] :maps_page (1) maps page
+  # @option query_options [0-75] :texts_per_page limites the number of returned
+  # @option query_options [Integer] :texts_page (1) texts page
+  # @option query_options [String] :subjects
+  #   'overview' to return the overview text (if exists), a pipe | delimited
+  #   list of subject names from the list of EOL accepted subjects (e.g.
+  #   TaxonBiology, FossilHistory), or 'all' to get text in any subject.
+  #   options at: http://eol.org/info/toc_subjects
+  # @option query_options [cc-by, cc-by-nc, cc-by-sa, cc-by-nc-sa, pd [public
+  #   domain], na [not applicable], all] :license (all) a pipe | delimited
+  #   list of licenses or 'all' to get objects under any license. Licenses
+  #   abbreviated cc- are all Creative Commons licenses.
+  # @option query_options [Boolean] :details (false) include all metadata for
+  #   data objects
+  # @option query_options [Boolean] :common_names (false) return all common
+  #   names for the page's taxon
+  # @option query_options [Boolean] :synonyms (false) return all synonyms for
+  #   the page's taxon
+  # @option query_options [Boolean] :references (false) return all references
+  #   for the page's taxon
+  # @option query_options [Boolean] :taxonomy (true) return any taxonomy details
+  #   from different taxon hierarchy providers, in an array named
+  #   "taxonConcepts"
+  # @option query_options [0,1,2,3,4] :vetted (0) If 'vetted' is given a value
+  #   of '1', then only trusted content will be returned. If 'vetted' is '2',
+  #   then only trusted and unreviewed content will be returned (untrusted
+  #   content will not be returned). If 'vetted' is '3', then only unreviewed
+  #   content will be returned. If 'vetted' is '4', then only untrusted content
+  #   will be returned.The default is to return all content.
+  # @option query_options [Integer] :cache_ttl the number of seconds you wish to
+  #   have the response cached
+  # @option query_options [ms, de, en, es, fr, gl, it, nl, nb, oc, pt-BR, sv,
+  #   tl, mk, sr, uk, ar, zh-Hans, zh-Hant, ko] :language (en) provides the
+  #   results in the specified language.
+  # @example
+  #   Eol.pages('1045608', images_per_page: 10, cache_ttl: 30) ==> #<Eol::Pages:0x00000001024058 @scientific_name="Apis mellifera Linnaeus 1758"...>
+  # @return <Eol::Pages>
+  def self.pages(id, query_options = {})
+    @query = { id: id }.merge!(query_options)
+    response = get('/pages/1.0.json', query: @query)
+    response.code == 200 ? Eol::Pages.new(response) : bad_response(response)
+  end
+
+  # Given the identifier for a collection this API will return all metadata
+  # about the collection and the items it contains.
+  #
+  # @see http://eol.org/api/docs/collections
+  # @param [Integer] id any integer
+  # @param [Hash] query_options
+  # @option query_options [Integer] :page (1) fetches page of results
+  # @option query_options [0-500] :per_page (50) sets number of results per page
+  # @option query_options [articles, collections, communities, images, sounds,
+  #   taxa, users, video] :filter filters search results
+  # @option query_options [recently_added, oldest, alphabetical,
+  #   reverse_alphabetical, richness, rating, sort_field, reverse_sort_field]
+  #   :sort_by (recently_added) sorts results
+  # @option query_options [String] :sort_field If a sort_field parameter is
+  #   included, only collection items whose sort field exactly matches the given
+  #   string will be returned
+  # @option query_options [Integer] :cache_ttl the number of seconds you wish to
+  #   have the response cached
+  # @option query_options [ms, de, en, es, fr, gl, it, nl, nb, oc, pt-BR, sv,
+  #   tl, mk, sr, uk, ar, zh-Hans, zh-Hant, ko] :language (en) provides the
+  #   results in the specified language.
+  # @example
+  #   Eol.collections('176', sort_by: 'oldest', cache_ttl: 30) ==> #<Eol::Collections:0x0000000147d078 @name="EOL Group on Flickr", @description="This group...>
+  # @return <Eol::Collections>
+  def self.collections(id, query_options = {})
+    @query = { id: id }.merge!(query_options)
+    response = get('/collections/1.0.json', query: @query)
+    response.code == 200 ? Eol::Collections.new(response) : bad_response(response)
+  end
+
+  # Given the identifier for a data object this API will return all metadata
+  # about the object as submitted to EOL by the contributing content partner
+  #
+  # @see http://eol.org/api/docs/data_objects
+  # @param [String] id the ID parameter can either be an integer (a DataObject
+  #   version ID) or a 16 character GUID which will return the latest version of
+  #   that object
+  # @param [Hash] query_options
+  # @option query_options [Boolean] :taxonomy (true) return any taxonomy details
+  #   from different taxon hierarchy providers, in an array named
+  #   "taxonConcepts"
+  # @option query_options [Integer] :cache_ttl the number of seconds you wish to
+  #   have the response cached
+  # @opation query_options [ms, de, en, es, fr, gl, it, nl, nb, oc, pt-BR, sv,
+  #   tl, mk, sr, uk, ar, zh-Hans, zh-Hant, ko] :language	(en) provides the
+  #   results in the specified language
+  # @example
+  #   Eol.data_objects('30073527', language: 'it', cache_ttl: 30) ==> #<Eol::DataObjects:0x00000000fc75b0 @identifier=1045608...>
+  # @return <Eol::DataObjects>
+  def self.data_objects(id, query_options = {})
+    @query = { id: id }.merge!(query_options)
+    response = get('/data_objects/1.0.json', query: @query)
+    response.code == 200 ? Eol::DataObjects.new(response) : bad_response(response)
+  end
+
+  # Gives access to a single hierarchy and its internal relationships
+  #
+  # @see http://eol.org/api/docs/hierarchy_entries
+  # @param [Integer] id any integer
+  # @param [Hash] query_options
+  # @option query_options [Boolean] :common_names (false) return all common
+  #   names for this taxon
+  # @option query_options [Boolean] :synonyms (false) return all synonyms for
+  #   this taxon
+  # @option query_options [Integer] :cache_ttl the number of seconds you wish to
+  #   have the response cached
+  # @option query_options [ms, de, en, es, fr, gl, it, nl, nb, oc, pt-BR, sv,
+  #   tl, mk, sr, uk, ar, zh-Hans, zh-Hant, ko] :language (en) provides the
+  #   results in the specified language
+  # @example
+  #   Eol.hierarchy_entries('30408282', common_names: true) ==> #<Eol::HierarchyEntries:0x000000015b8c08 @source_identifier="taxon:142651"...>
+  # @return <Eol::HierarchyEntries>
+  def self.hierarchy_entries(id, query_options = {})
+    @query = { id: id }.merge!(query_options)
+    response = get('/hierarchy_entries/1.0.json', query: @query)
+    response.code == 200 ? Eol::HierarchyEntries.new(response) : bad_response(response)
+  end
+
+  # Lists metadata about a hierarchy such as the provider name and source URL,
+  # as well as lists all the taxa which are the root taxa of the taxonomic tree
+  #
+  # @see http://eol.org/api/docs/hierarchies
+  # @param [Integer] id any integer
+  # @param [Hash] query_options
+  # @option query_options [Integer] :cache_ttl the number of seconds you wish to
+  #   have the response cached
+  # @option query_options [ms, de, en, es, fr, gl, it, nl, nb, oc, pt-BR, sv,
+  #   tl, mk, sr, uk, ar, zh-Hans, zh-Hant, ko] :language (en) provides the
+  #   results in the specified language
+  # @example
+  #   Eol.hierarchies('1188', language: 'de', cache_ttl: 30) ==> #<Eol::Hierarchies:0x000000015e7a08 @title="Species 2000 & ITIS Catalogue of Life: April 2013"...>
+  # @return <Eol::Hierarchies>
+  def self.hierarchies(id, query_options = {})
+    @query = { id: id }.merge!(query_options)
+    response = get('/hierarchies/1.0.json', query: @query)
+    response.code == 200 ? Eol::Hierarchies.new(response) : bad_response(response)
+  end
+
+  # This method will return references to all hierarchies supplied by EOL
+  # Content Partners. The response will include the label of the hierarchy and
+  # the EOL unique ID representing the hierarchy
+  #
+  # @see http://eol.org/api/docs/provider_hierarchies
+  # @example
+  #   Eol.provider_hierarchies ==> [#<Eol::ProviderHierarchies:0x000000016080f0 @id=121, @label="AntWeb (Ant Species)">...]
+  # @return [Array<Eol::ProviderHierarchies>]
+  def self.provider_hierarchies
+    response = get('/provider_hierarchies/1.0.json')
+    response.code == 200 ? response.map { |item| Eol::ProviderHierarchies.new(item) } : bad_response(response)
+  end
+
+  # This method takes an integer or string which is the unique identifier for a
+  # taxon from some provider's database, and a hierarchy_id which represents the
+  # provider and returns the EOL page ID for that taxon.
+  #
+  # @see http://eol.org/api/docs/search_by_provider
+  # @param [String] id any string
+  # @param [Integer] hierarchy_id the ID of the provider's hierarchy you are
+  #   searching within.
+  # @param [Hash] query_options
+  # @option query_options [Boolean] :batch (false) returns either a batch or not
+  # @option query_options [Integer] :cache_ttl the number of seconds you wish to
+  #   have the response cached
+  # @example
+  #   Eol.search_by_provider('180542', 903) ==> [#<Eol::SearchByProvider:0x000000022bf3c0 @eol_page_id=328580>, #<Eol::SearchByProvider:0x000000022bf398...>]
+  # @return [Array<Eol::SearchByProvider>]
+  def self.search_by_provider(id, hierarchy_id, query_options = {})
+    @query = { id: id, hierarchy_id: hierarchy_id }.merge!(query_options)
+    response = get('/search_by_provider/1.0.json?', query: @query)
+    response.code == 200 ? response.map { |item| Eol::SearchByProvider.new(item) } : bad_response(response)
+  end
+
+  def self.all_pages(query, response)
+    @n = 0
+    total = (response['totalResults'] / 30.to_f).ceil
+    total.times.collect {
+      response = get('/search/1.0.json', query: { q: query, page: (@n += 1) })
+      response['results'].map { |item| Eol::Search.new(item) }
+    }.flatten
+  end
+
+  def self.bad_response(response)
+    raise Error, "Error code #{response.code}" if response.class == HTTParty::Response
+    raise StandardError, 'Unknown Error'
+  end
+
+  private_class_method :all_pages, :bad_response
+end

data/lib/eol/collections.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains metadata about the collection and the items it contains
+  class Collections
+    include Enumerable
+    # @return [String] collections name
+    attr_accessor :name
+    # @return [String] collections description
+    attr_accessor :description
+    # @return [String] a hyperlink to the logo
+    attr_accessor :logo_url
+    # @return [String] created timestamp
+    attr_accessor :created
+    # @return [String] modified timestamp
+    attr_accessor :modified
+    # @return [Integer] total collections items
+    attr_accessor :total_items
+    # @return [Array] an Array of Hashes
+    attr_accessor :item_types
+    # @return [Array] an Array of Hashes
+    attr_accessor :collection_items
+
+    def initialize(response)
+      self.name = response['name']
+      self.description = response['description']
+      self.logo_url = response['logo_url']
+      self.created = response['created']
+      self.modified = response['modified']
+      self.total_items = response['total_items']
+      self.item_types = response['item_types']
+      self.collection_items = response['collection_items']
+    end
+
+    def each
+      yield @name
+      yield @description
+      yield @logo_url
+      yield @created
+      yield @modified
+      yield @total_items
+      yield @item_types
+      yield @collection_items
+    end
+  end
+end

data/lib/eol/data_objects.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains all metadata about the object as submitted to EOL by the
+  # contributing content partner.
+  class DataObjects
+    include Enumerable
+    # @return [Integer] an identifier number
+    attr_accessor :identifier
+    # @return [String]the  binomial nomenclature in zoology
+    attr_accessor :scientific_name
+    # @return [FalseClass or TrueClass] status of exemplar
+    attr_accessor :exemplar
+    # @return [Integer]
+    # EOL has developed a 'Richness Score' for taxon pages which provides a
+    # simple summary number for comparing the amount of information available
+    # for different pages.
+    # @see http://eol.org/info/521
+    attr_accessor :richness_score
+    # @return [Array] An Array of Hashes
+    attr_accessor :taxon_concepts
+    # @return [Array] An Array of Hashes
+    attr_accessor :data_objects
+
+    def initialize(response)
+      self.identifier = response['identifier']
+      self.scientific_name = response['scientificName']
+      self.exemplar = response['exemplar']
+      self.richness_score = response['richness_score']
+      self.taxon_concepts = response['taxonConcepts']
+      self.data_objects = response['dataObjects']
+    end
+
+    def each
+      yield @identifier
+      yield @scientific_name
+      yield @exemplar
+      yield @richness_score
+      yield @taxon_concepts
+      yield @data_objects
+    end
+  end
+end

data/lib/eol/hierarchies.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains metadata about a hierarchy such as the provider name and source URL,
+  # as well as lists all the taxa which are the root taxa of the taxonomic tree
+  class Hierarchies
+    include Enumerable
+    # @return [String] the Hierarchies title
+    attr_accessor :title
+    # @return [String] the name of the Hierarchies contributor
+    attr_accessor :contributor
+    # @return [String] date of submission
+    attr_accessor :date_submitted
+    # @return [String] the Hierarchies source
+    attr_accessor :source
+    # @return [Array] An Array of Hashes
+    attr_accessor :roots
+
+    def initialize(response)
+      self.title = response['title']
+      self.contributor = response['contributor']
+      self.date_submitted = response['dateSubmitted']
+      self.source = response['source']
+      self.roots = response['roots']
+    end
+
+    def each
+      yield @title
+      yield @contributor
+      yield @date_submitted
+      yield @source
+      yield @roots
+    end
+  end
+end

data/lib/eol/hierarchy_entries.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains data on a single hierarchy and its internal relationships
+  class HierarchyEntries
+    include Enumerable
+    # @return [String]
+    attr_accessor :source_identifier
+    # @return [Integer]
+    attr_accessor :parent_name_usage_id
+    # @return [Integer]
+    attr_accessor :taxon_concept_id
+    # @return [String] binomial nomenclature in zoology
+    attr_accessor :scientific_name
+    # @return [String] a link
+    attr_accessor :source
+    # @return [Array]
+    attr_accessor :name_according_to
+    # @return [Array]
+    attr_accessor :vernacular_names
+    # @return [Array]
+    attr_accessor :synonyms
+    # @return [Array]
+    attr_accessor :ancestors
+    # @return [Array]
+    attr_accessor :children
+
+    def initialize(response)
+      self.source_identifier = response['sourceIdentifier']
+      self.parent_name_usage_id = response['parentNameUsageID']
+      self.taxon_concept_id = response['taxonConceptID']
+      self.scientific_name = response['scientificName']
+      self.source = response['source']
+      self.name_according_to = response['nameAccordingTo']
+      self.vernacular_names = response['vernacularNames']
+      self.synonyms = response['synonyms']
+      self.ancestors = response['ancestors']
+      self.children = response['children']
+    end
+
+    def each
+      yield @source_identifier
+      yield @parent_name_usage_id
+      yield @taxon_concept_id
+      yield @scientific_name
+      yield @source
+      yield @name_according_to
+      yield @vernacular_names
+      yield @synonyms
+      yield @ancestors
+      yield @children
+    end
+  end
+end

data/lib/eol/pages.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains returns the scientific name for that page, and optionally contains
+  # information about common names, media (text, images and videos),
+  # and references to the hierarchies which recognize the taxon described on
+  # the page.
+  class Pages
+    include Enumerable
+    # @return [String] binomial nomenclature in zoology
+    attr_accessor :scientific_name
+    # @return [Integer]
+    # EOL has developed a 'Richness Score' for taxon pages which provides a
+    # simple summary number for comparing the amount of information available
+    # for different pages.
+    # @see http://eol.org/info/521
+    attr_accessor :richness_score
+    # @return [Array] an Array of Hashes
+    attr_accessor :taxon_concepts
+    # @return [Array] an Array of Hashes
+    attr_accessor :data_objects
+
+    def initialize(response)
+      self.scientific_name = response['scientificName']
+      self.richness_score = response['richness_score']
+      self.taxon_concepts = response['taxonConcepts']
+      self.data_objects = response['dataObjects']
+    end
+
+    def each
+      yield @scientific_name
+      yield @richness_score
+      yield @taxon_concepts
+      yield @data_objects
+    end
+  end
+end

data/lib/eol/ping.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains response message indicating API status
+  class Ping
+    # @return [String] success or failure message
+    attr_accessor :message
+
+    def initialize(response)
+      self.message = response
+    end
+  end
+end

data/lib/eol/provider_hierarchies.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains references to all hierarchies supplied by EOL Content Partners.
+  class ProviderHierarchies
+    include Enumerable
+    # @return [Integer]
+    attr_accessor :id
+    # @return [String]
+    attr_accessor :label
+
+    def initialize(response)
+      self.id = response['id']
+      self.label = response['label']
+    end
+
+    def each
+      yield @id
+      yield @label
+    end
+  end
+end

data/lib/eol/search.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains search results from the Encyclopedia of Life database.
+  class Search
+    include Enumerable
+    # @return [Integer] the id of the species
+    attr_accessor :id
+    # @return [String] title of the entry
+    attr_accessor :title
+    # @return [String] link to article on the EOL homepage
+    attr_accessor :link
+    # @return [String] classification content
+    attr_accessor :content
+
+    def initialize(response)
+      self.id = response['id']
+      self.title = response['title']
+      self.link = response['link']
+      self.content = response['content']
+    end
+
+    def each
+      yield @id
+      yield @title
+      yield @link
+      yield @content
+    end
+  end
+end

data/lib/eol/search_by_provider.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Eol
+  # Contains the EOL page ID and link for taxon queried.
+  class SearchByProvider
+    include Enumerable
+    # @return [Integer]
+    attr_accessor :eol_page_id
+    # @return [String]
+    attr_accessor :eol_page_link
+
+    def initialize(response)
+      self.eol_page_id = response['eol_page_id'] if response['eol_page_id'] != nil
+      self.eol_page_link = response['eol_page_link'] if response['eol_page_link'] != nil
+    end
+
+    def each
+      yield @eol_page_id
+      yield @eol_page_link
+    end
+  end
+end

data/lib/eol/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Eol
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: eol
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Roman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: A wrapper for the Encyclopedia of Life API.  It provides simple methods
+  to call all of the available EOL API endpoints.
+email:
+- rob@romancoding.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eol.gemspec
+- lib/eol.rb
+- lib/eol/collections.rb
+- lib/eol/data_objects.rb
+- lib/eol/hierarchies.rb
+- lib/eol/hierarchy_entries.rb
+- lib/eol/pages.rb
+- lib/eol/ping.rb
+- lib/eol/provider_hierarchies.rb
+- lib/eol/search.rb
+- lib/eol/search_by_provider.rb
+- lib/eol/version.rb
+homepage: http://github.com/itroman/eol-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A comprehensive Encyclopedia of Life API wrapper
+test_files: []