colrapi 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fdc3cd60c5c9678fa5f5feb8706a91ff121374f9a84966224b8824ff4a97397
-  data.tar.gz: b2a57d1fc5eaa08288359b44905358511d75a5dfa084368b9f77c8e70c488447
+  metadata.gz: aea2e44a818d41cd832614bd00cb148714061db766ef82a61be48a036568d032
+  data.tar.gz: d7b3de2c633901fc8e30f6f80fb8fe47bbb1b9702d016f1240fed959c26479ba
 SHA512:
-  metadata.gz: 6d0f6fc5211efc5da06e31c56188fd039d1ab8bef714a969d87db5398ea8ec1f5e9d49f0762019c51e11050ed85a80e4c18543d5310f29e5dcfe85161da8a9c6
-  data.tar.gz: 8101188650f8034ecc4ae36a51bdc57d132984f85a908ae35b906e5f79e00737c29b8b4d27f65e749e7e6f9586e47b11ce66e45e64523be619192e54fd2a41b1
+  metadata.gz: a24bec052600b4f5cf3402e5cf8b5ad62e40dd5178d79285812acd594caaa91d18c4dd28c29bbb4eba6eb9da8aaec5a619d2263c929c49edc1b91dfef9caa5f9
+  data.tar.gz: 7b495d6b3ea866840958a56334a1493f94b39568df0a474b6de5cae4940c18206a3041c9920b2567ade50d71326d13861502722bfaa1433e0e45e3a626c33b2e

data/CHANGELOG.md

@@ -1,8 +1,15 @@
 ## [Unreleased]
- - Updated license from NCSA to MIT
+
+## [0.1.5] - 2025-03-25
+ - Added usage_id to nameusage_search
+
+## [0.1.4] - 2025-03-05
+ - Fixed authentication
+ - Kept depreciated ChecklistBank preview endpoint functionality by using /dataset/{dataset_id}LRC.json instead (now requires a token)
 
 ## [0.1.3] - 2025-03-04
  - Added environment and highest_taxon_id to name_usage_search
+ - Updated license from NCSA to MIT
 
 ## [0.1.2] - 2024-09-11
  - Removed Gemfile.lock

data/lib/colrapi/faraday.rb

@@ -20,7 +20,7 @@ module Faraday
           when 502
             raise Colrapi::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
           when 503
-            raise Colrapi::ServiceUnavailable, error_message_500(response, "Crossref is rate limiting your requests.")
+            raise Colrapi::ServiceUnavailable, error_message_500(response, "The service is unavailable.")
           when 504
             raise Colrapi::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
           end

data/lib/colrapi/request.rb

@@ -1,15 +1,11 @@
-require_relative "faraday" # !! Potential ruby 3.0 difference in module loading? relative differs from Serrano
+require_relative "faraday"
 require "faraday/follow_redirects"
 require_relative "utils"
 require "colrapi/error"
 
 module Colrapi
   class Request
-    attr_accessor :endpoint
-    attr_accessor :q
-    attr_accessor :verbose
-
-    attr_accessor :options
+    attr_accessor :endpoint, :q, :verbose, :options
 
     def initialize(**args)
       @endpoint = args[:endpoint]
@@ -31,6 +27,7 @@ module Colrapi
       @max_rank = args[:max_rank]
       @environment = args[:environment]
       @highest_taxon_id = args[:highest_taxon_id]
+      @usage_id = args[:usage_id]
       @parent_rank = args[:parent_rank]
       @root_id = Array(args[:root_id]) if args[:root_id]
       @root2_id = Array(args[:root2_id]) if args[:root2_id]
@@ -61,7 +58,7 @@ module Colrapi
       @term_operator = args[:term_operator]
       @issued = args[:issued]
       @issued_before = args[:issued]
-      @modified_after =  args[:modified_after]
+      @modified_after = args[:modified_after]
       @modified_before = args[:modified_before]
       @last_synced_before = args[:last_synced_before]
       @min = args[:min]
@@ -132,30 +129,18 @@ module Colrapi
                subgenus: @within_subgenus, section: @within_section, species: @within_species,
                nidx: @nidx_id, state: @state, running: @running, notCurrentOnly: @not_current_only,
                broken: @broken, subjectDatasetKey: @subject_dataset_id, mode: @mode, subject: @subject,
-               TAXON_ID: @highest_taxon_id, environment: @environment,
-               sortBy: @sort_by, reverse: @reverse, url: @url, offset: @offset, limit: @limit}
+               TAXON_ID: @highest_taxon_id, USAGE_ID: @usage_id, environment: @environment,
+               sortBy: @sort_by, reverse: @reverse, url: @url, body: @body, offset: @offset, limit: @limit }
       opts = args.delete_if { |_k, v| v.nil? }
 
-      conn = if verbose
-               Faraday.new(url: Colrapi.base_url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |f|
-                 if !@user.nil? and !@password.nil?
-                   f.request(:basic_auth, @user, @password)
-                 end
-                 f.response :logger
-                 f.use Faraday::ColrapiErrors::Middleware
-                 f.adapter Faraday.default_adapter
-               end
-             else
-               Faraday.new(url: Colrapi.base_url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |f|
-                 if !@user.nil? and !@password.nil?
-                   f.request(:basic_auth, @user, @password)
-                 end
-                 f.use Faraday::ColrapiErrors::Middleware
-                 f.adapter Faraday.default_adapter
-               end
-             end
+      conn = Faraday.new(url: Colrapi.base_url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |f|
+        f.request :authorization, :basic, @user, @password if @user && @password
+        f.response :logger if @verbose
+        f.use Faraday::ColrapiErrors::Middleware
+        f.adapter Faraday.default_adapter
+      end
 
-      conn.headers['Authorization'] = "Bearer #{@token}" unless @token.nil?
+      conn.headers['Authorization'] = "Bearer #{@token}" if @token
       conn.headers['Accept'] = 'application/json,*/*'
       conn.headers[:user_agent] = make_user_agent
       conn.headers["X-USER-AGENT"] = make_user_agent
@@ -168,7 +153,6 @@ module Colrapi
       rescue MultiJson::ParseError
         res.body
       end
-      
     end
   end
 end

data/lib/colrapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Colrapi
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/colrapi.rb

@@ -42,6 +42,7 @@ module Colrapi
   # Search datasets:
   #   @param q [String] A search query for datasets
   #   @param short_title [String] A dataset alias
+  #   @param title [String] A dataset title
   #   @param code [String] The nomenclatural code (bacterial, botanical, cultivars, phytosociological, virus, zoological)
   #   @param private [Boolean] Whether the dataset is private or not
   #   @param released_from [Integer] Filter by a project id that a dataset was released from
@@ -64,6 +65,7 @@ module Colrapi
   #   @param modified_after [Date] Filter by modified after date
   #   @param modified_before [Date] Filter by modified before date
   #   @param min_size [Integer] Filter by minimum record size
+  #   @param token [String, nil] An authentication token from Colrapi.user_login()
   #
   #   @param sort_by [String] Sort by (key, alias, title, creator, relevance, created, modified, imported, size)
   #   @param reverse [Boolean] Sort in reverse
@@ -76,7 +78,7 @@ module Colrapi
                    contributes_to: nil, has_source_dataset: nil, has_gbif_id: nil, gbif_id: nil, gbif_publisher_id: nil,
                    editor: nil, reviewer: nil, modified_by: nil, origin: nil, type: nil, license: nil, row_type: nil,
                    created_after: nil, created_before: nil, issued_after: nil, issued_before: nil, modified_after: nil,
-                   modified_before: nil, min_size: nil, sort_by: nil, reverse: nil, offset: nil, limit: nil,
+                   modified_before: nil, min_size: nil, sort_by: nil, token: nil, reverse: nil, offset: nil, limit: nil,
                    verbose: false)
     endpoint = "dataset"
     unless dataset_id.nil?
@@ -94,7 +96,7 @@ module Colrapi
                   row_type: row_type, created_after: created_after, created_before: created_before,
                   issued_after: issued_after, issued_before: issued_before, modified_after: modified_after,
                   modified_before: modified_before, min_size: min_size, sort_by: sort_by, reverse: reverse,
-                  offset: offset, limit: limit, verbose: verbose).perform
+                  offset: offset, limit: limit, token: token, verbose: verbose).perform
     end
   end
 
@@ -553,6 +555,7 @@ module Colrapi
   # @param facet [Array, String, nil] the search facet
   # @param environment [Array, String, nil] filter by environment (MARINE, TERRESTRIAL, FRESHWATER, BRACKISH)
   # @param highest_taxon_id [String, nil] Filter by highest taxon ID
+  # @param usage_id [String, nil] Filter by usage ID
   #
   # @param sort_by [String, nil] sort results by NAME, TAXONOMIC, INDEX_NAME_ID, NATIVE, or RELEVANCE
   # @param reverse [Boolean] sort in reverse order
@@ -563,7 +566,7 @@ module Colrapi
   # @return [Array, Boolean] An array of hashes
   def self.nameusage_search(q: nil, dataset_id: nil, endpoint: 'nameusage/search', content: nil, issue: nil,
                             type: nil, rank: nil, min_rank: nil, max_rank: nil, environment: nil, facet: nil,
-                            highest_taxon_id: nil, sort_by: nil, reverse: nil, offset: nil, limit: nil, 
+                            highest_taxon_id: nil, usage_id: nil, sort_by: nil, reverse: nil, offset: nil, limit: nil, 
                             verbose: false)
 
     # a nil dataset_id will search name usages from all datasets in ChecklistBank
@@ -573,7 +576,7 @@ module Colrapi
 
     Request.new(endpoint: endpoint, q: q, content: content, issue: issue, type: type,
                 rank: rank, min_rank: min_rank, max_rank: max_rank, facet: facet, environment: environment,
-                highest_taxon_id: highest_taxon_id, sort_by: sort_by, reverse: reverse,
+                highest_taxon_id: highest_taxon_id, usage_id: usage_id, sort_by: sort_by, reverse: reverse,
                 offset: offset, limit: limit, verbose: verbose).perform
   end
 
@@ -693,11 +696,12 @@ module Colrapi
   #   (Note: you can also use 3LRC where 3 is the project_id as an ID on any endpoint with dataset_id or project_id
   #    to get data from the latest release candidate, or 3LR gets the latest release)
   # @param project_id [String] The project id
+  # @param token [String, nil] The authentication token from retrieved with Colrapi.user_login(user, password)
   #
   # @param verbose [Boolean] Print headers to STDOUT
   # @return [Array, Boolean] An array of hashes
-  def self.preview(project_id, verbose: false)
-    Request.new(endpoint: "dataset/#{project_id}/preview", verbose: verbose).perform
+  def self.preview(project_id, token, verbose: false)
+    Request.new(endpoint: "dataset/#{project_id}LRC.json", token: token, verbose: verbose).perform
   end
 
   # Get a reference with @reference_id from dataset @dataset_id via the reference route

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colrapi
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Matt Yoder, Geoff Ower
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,7 +198,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/SpeciesFileGroup/colrapi
   source_code_uri: https://github.com/SpeciesFileGroup/colrapi
-  changelog_uri: https://github.com/SpeciesFileGroup/colrapi/releases/tag/v0.1.3
+  changelog_uri: https://github.com/SpeciesFileGroup/colrapi/releases/tag/v0.1.5
 post_install_message:
 rdoc_options: []
 require_paths: