taxa 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d02a59f702859db4b8816859d1ac70a36c53840c243d58c4924b85fe1b6766e1
-  data.tar.gz: b38261c5222c2ab544d641e9845f648edd9ff56fd94cc9a94866822de8cb8c18
+  metadata.gz: 2f22b781a534e5778cfe117a963ec4984f17eda86c757a05a21d012088644996
+  data.tar.gz: cd39b3a350ad83c26a7d1e60fece8964b7bb68fb82907305f8aec8d6c1e434d3
 SHA512:
-  metadata.gz: 00d336dc76b870722fc395678c1a338e5fc8f65d0339beb19896f81eca4cf896f4d7c7e9cb2af63ef2981746c4f7ff3ff622f5868967ee4151ccbb1e678d3a4c
-  data.tar.gz: 54146c3bd2a1b52a3b9fbc4c67887d247a4da3f3c679a7e20f89668724df20ec3bb0d3486ec772f3e130a3e43561857642e61d76df34ced9f571b129e17d78a6
+  metadata.gz: '09e294e750b886dc5a5248c66cc5c13d5ca284dfadea44fe8cdbfd3218b3f835907fe2158f1669b12741ae186f55a7b362e0c350b2735656b1582a89c99f6fe7'
+  data.tar.gz: 7239b7a6efcc5d822bb78ea6ab1cd3bfecabf1373036fbf53b1fce8e267d26a7e946fd104a53ea36bb04d4e010dfcdd89cc6f75d307579163f58d587beaa9b66

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/CHANGELOG.md

@@ -1,18 +1,24 @@
-# Taxa Changelog
-
-## [0.1.0]
-
-### Highlights
-Support for Open Tree of Life API v3
-https://github.com/OpenTreeOfLife/germinator/wiki/Open-Tree-of-Life-Web-APIs
-
-## [0.2.0]
-
-### Highlights
-Support for the classic API for EOL
-https://eol.org/docs/what-is-eol/classic-apis
-
-## [0.2.1]
-
-### Highlights
-Update JSON gem to 2.5.x
+# Taxa Changelog
+
+## [0.1.0]
+
+### Highlights
+Support for Open Tree of Life API v3
+https://github.com/OpenTreeOfLife/germinator/wiki/Open-Tree-of-Life-Web-APIs
+
+## [0.2.0]
+
+### Highlights
+Support for the classic API for EOL
+https://eol.org/docs/what-is-eol/classic-apis
+
+## [0.2.1]
+
+### Highlights
+Update JSON gem to 2.5.x
+
+## [0.3.0]
+
+### Highlights
+Support for Plants of the World Online
+http://plantsoftheworldonline.org/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    taxa (0.2.0)
+    taxa (0.2.1)
       faraday (~> 1.1)
       json (~> 2.5)
 
@@ -13,7 +13,7 @@ GEM
       faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
-    faraday-net_http (1.0.0)
+    faraday-net_http (1.0.1)
     json (2.5.1)
     minitest (5.14.2)
     multipart-post (2.1.1)
@@ -36,7 +36,7 @@ GEM
     rubocop-ast (1.3.0)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.4)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -49,4 +49,4 @@ DEPENDENCIES
   taxa!
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -25,8 +25,16 @@ tol_client.tnrs.match_names('Cotyledon') # can be an array or a string
 
 eol_client = Taxa::EOLClassic::Client.new
 eol_client.hierarchy_entries(7834469)
+
+powo_client = Taxa::PlantsOfTheWorldOnline::Client.new
+powo_client.search('Crassula alata')
+powo_client.search('Crassula', ['species_f', 'has_images'])
+powo_client.search('family:Crassulaceae', ['species_f', 'has_images'])
 ```
 
+For Plants of the World Online please see their official python library for available search terms: 
+https://github.com/RBGKew/pykew#available-search-terms-1
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/taxa.rb

@@ -4,6 +4,7 @@ require 'taxa/version'
 require 'faraday'
 require_relative './taxa/open_tree_of_life/client'
 require_relative './taxa/eol_classic/client'
+require_relative './taxa/plants_of_the_world_online/client'
 
 module Taxa
   # include OpenTreeOfLife

data/lib/taxa/plants_of_the_world_online/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative '../utils'
+module Taxa
+  module PlantsOfTheWorldOnline
+    # API client for Open Tree of Life
+    class Client
+      attr_accessor :options
+      attr_reader :http_client
+
+      POWO_URL = 'http://www.plantsoftheworldonline.org/api/2'
+
+      FILTERS = %w[accepted_names has_images families_f genus_f species__f infraspecific_f].freeze
+
+      def initialize(**options)
+        @options = options
+        @http_client = options[:http_client] || Faraday.new
+      end
+
+      def search(query, options = {})
+        options.transform_keys!(&:to_sym)
+
+        page = options[:page] || 0
+        filters = Array.wrap(options[:filters])
+        validate_search_parameters(query, page, filters)
+
+        payload = { q: query, p: page }
+        payload.merge!({ f: filters.join(',') }) unless filters.empty?
+        response = @http_client.get("#{POWO_URL}/search", payload, { 'Accept' => 'application/json' })
+        parse_response(response)
+      end
+
+      def lookup(id, include = nil)
+        raise ArgumentError, 'id can not be nil' if id.nil?
+
+        include = Array.wrap(include)
+        payload = {}
+        payload.merge!({ fields: include.join(',') }) unless include.empty?
+        response = @http_client.get("#{POWO_URL}/taxon/#{id}", payload, { 'Accept' => 'application/json' })
+        parse_response(response)
+      end
+
+      private
+
+      def validate_search_parameters(query, page, filters)
+        raise ArgumentError, 'query can not be nil' if query.nil?
+
+        if !filters.empty? && (filters & FILTERS).empty?
+          raise ArgumentError,
+                "filter is invalid. It must be one of these: #{FILTERS.join(', ')} can not be nil"
+        end
+
+        raise ArgumentError, 'page must be an integer' unless page.is_a?(Integer)
+      end
+
+      def parse_response(response)
+        JSON.parse(response.body)
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/taxa/utils.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# https://stackoverflow.com/questions/18358717/ruby-elegantly-convert-variable-to-an-array-if-not-an-array-already
+class Array
+  def self.wrap(object)
+    if object.nil?
+      []
+    elsif object.respond_to?(:to_ary)
+      object.to_ary || [object]
+    else
+      [object]
+    end
+  end
+end

data/lib/taxa/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Taxa
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taxa
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Shane Sherman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -97,6 +98,8 @@ files:
 - lib/taxa/open_tree_of_life/tree_of_life/mrca.rb
 - lib/taxa/open_tree_of_life/tree_of_life/node_info.rb
 - lib/taxa/open_tree_of_life/tree_of_life/subtree.rb
+- lib/taxa/plants_of_the_world_online/client.rb
+- lib/taxa/utils.rb
 - lib/taxa/version.rb
 - taxa.gemspec
 homepage: https://github.com/ssherman/taxa