colrapi 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aea2e44a818d41cd832614bd00cb148714061db766ef82a61be48a036568d032
-  data.tar.gz: d7b3de2c633901fc8e30f6f80fb8fe47bbb1b9702d016f1240fed959c26479ba
+  metadata.gz: 3f9ef87ffca0e6ba50430ddbdff7fb385adfd38427338179ee4b4ae1ed774145
+  data.tar.gz: 3204710f6cac4d68b0699cc478a297205f5767f0368599f61ea27d99a99cdc42
 SHA512:
-  metadata.gz: a24bec052600b4f5cf3402e5cf8b5ad62e40dd5178d79285812acd594caaa91d18c4dd28c29bbb4eba6eb9da8aaec5a619d2263c929c49edc1b91dfef9caa5f9
-  data.tar.gz: 7b495d6b3ea866840958a56334a1493f94b39568df0a474b6de5cae4940c18206a3041c9920b2567ade50d71326d13861502722bfaa1433e0e45e3a626c33b2e
+  metadata.gz: 6056004c3f1b6bb3d2e3751e1a06d8178e3b33ddb4615de5413d465565eb8a58bc115af123e95915a138ea51190fa89eeefb3dd6dc30a8aeb3a8129983318ea6
+  data.tar.gz: d15bdd735d0ef7315fe1e7cf5d000a9bd68520ce3608552f4473954ef872537569e376767f70d94febc667b97c886fab475593da562239e646d2ad769f9f22f5

data/.github/workflows/main.yml

@@ -5,12 +5,15 @@ on: [push,pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.3.4', '4.0.0']
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
+    - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.3.4
+        ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## [Unreleased]
 
+## [0.1.7] - 2026-06-17
+ - Allow Ruby 4.0.0:
+    - Relaxed `required_ruby_version` to `>= 2.5.0, < 5.0`
+    - Added Ruby 4.0.0 to the CI matrix
+    - Bumped `faraday-follow_redirects` upper bound to allow 0.5+ (which lifts the Ruby < 4 cap)
+    - Dropped the `bundler` development dependency
+ - Fixed duplicate `:status` argument in `Colrapi::Request`
+ - Updated tests to match current ChecklistBank API responses
+
+## [0.1.6] - 2025-03-25
+ - Added more nameusage_search parameters:
+    - authorship
+    - authorship_year
+    - extinct
+    - field
+    - name_type
+    - nomenclatural_code
+    - nomenclatural_status
+    - origin
+    - secondary_source
+    - sector_dataset_id
+    - sector_mode
+    - status
+    - taxonomic_group
+
 ## [0.1.5] - 2025-03-25
  - Added usage_id to nameusage_search
 

data/colrapi.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.description   = "colrapi (a play on Kholrabi) is a low-level wrapper around the Catalog of Life API."
   s.homepage      = "https://github.com/SpeciesFileGroup/colrapi"
   s.license       = "MIT"
-  s.required_ruby_version = ">= 2.5.0"
+  s.required_ruby_version = [">= 2.5.0", "< 5.0"]
 
  # s.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
 
@@ -32,7 +32,6 @@ Gem::Specification.new do |s|
   # Uncomment to register a new dependency of your gem
   # s.add_dependency "example-gem", "~> 1.0"
 
-  s.add_development_dependency "bundler", "~> 2.1", ">= 2.1.4"
   s.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
   s.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.6"
   s.add_development_dependency "vcr", "~> 6.0"
@@ -40,7 +39,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rexml", "~> 3.3", ">= 3.3.6"
 
   s.add_runtime_dependency "faraday", "~> 2.2"
-  s.add_runtime_dependency "faraday-follow_redirects", ">= 0.1", "< 0.4"
+  s.add_runtime_dependency "faraday-follow_redirects", ">= 0.1", "< 0.6"
   s.add_runtime_dependency "multi_json", "~> 1.15"
 
   #  s.add_runtime_dependency "thor", "~> 1.0", ">= 1.0.1"

data/lib/colrapi/request.rb

@@ -18,14 +18,18 @@ module Colrapi
       @regexp = args[:regexp]
       @content = Array(args[:content]) if args[:content]
       @name = args[:name]
-      @authorship = args[:authorship]
-      @code = args[:code]
+      @authorship = Array(args[:authorship]) if args[:authorship]
+      @authorship_year = Array(args[:authorship_year]) if args[:authorship_year]
+      @code = Array(args[:code]) if args[:code]
+      @nomenclatural_code = Array(args[:nomenclatural_code]) if args[:nomenclatural_code]  # unfortunately code and nom_code get used on different endpoints
+      @field = Array(args[:field]) if args[:field]
       @type = Array(args[:type]) if args[:type]
       @rank = Array(args[:rank]) if args[:rank]
       @facet = Array(args[:facet]) if args[:facet]
+      @extinct = Array(args[:extinct]) if args[:extinct]
       @min_rank = args[:min_rank]
       @max_rank = args[:max_rank]
-      @environment = args[:environment]
+      @environment = Array(args[:environment]) if args[:environment]
       @highest_taxon_id = args[:highest_taxon_id]
       @usage_id = args[:usage_id]
       @parent_rank = args[:parent_rank]
@@ -43,6 +47,7 @@ module Colrapi
       @has_gbif_id = args[:has_gbif_id]
       @gbif_id = args[:gbif_id]
       @gbif_publisher_id = args[:gbif_publisher_id]
+      @taxonomic_group = Array(args[:taxonomic_group]) if args[:taxonomic_group]
       @editor = args[:editor]
       @reviewer = args[:reviewer]
       @modified_by = args[:modified_by]
@@ -64,6 +69,12 @@ module Colrapi
       @min = args[:min]
       @max = args[:max]
       @min_size = args[:min_size]
+      @name_type = Array(args[:name_type]) if args[:name_type]
+      @nomenclatural_status = Array(args[:nomenclatural_status]) if args[:nomenclatural_status]
+      @status = Array(args[:status]) if args[:status]
+      @sector_mode = Array(args[:sector_mode]) if args[:sector_mode]
+      @sector_dataset_id = Array(args[:sector_dataset_id]) if args[:sector_dataset_id]
+      @secondary_source = Array(args[:secondary_source]) if args[:secondary_source]
       @size = args[:size]
       @within_superkingdom = args[:within_superkingdom]
       @within_kingdom = args[:within_kingdom]
@@ -97,7 +108,6 @@ module Colrapi
       @reverse = args[:reverse]
       @limit = args[:limit]
       @offset = args[:offset]
-      @status = args[:status]
       @state = Array(args[:state]) if args[:state]
       @running = args[:running]
       @user = args[:user]
@@ -108,16 +118,19 @@ module Colrapi
 
     def perform
 
-      args = { q: @q, regex: @regexp, attempt: @attempt, content: @content, name: @name, authorship: @authorship, code: @code, type: @type,
+      args = { q: @q, regex: @regexp, attempt: @attempt, content: @content, name: @name, authorship: @authorship, 
+               authorshipYear: @authorship_year, code: @code, nomCode: @nomenclatural_code, field: @field, extinct: @extinct, type: @type,
                rank: @rank, minRank: @min_rank, maxRank: @max_rank, parentRank: @parent_rank, projectKey: @project_id,
                term: @term, termOp: @term_operator, status: @status, decisionMode: @decision_mode,
                alias: @short_title, private: @private, releasedFrom: @released_from, contributesTo: @contributes_to,
-               hasSourceDataset: @has_source_dataset, hasGbifKey: @has_gbif_id, gbifKey: @gbif_id,
+               hasSourceDataset: @has_source_dataset, hasGbifKey: @has_gbif_id, group: @taxonomic_group, gbifKey: @gbif_id,
                gbifPublisherKey: @gbif_publisher_id, editor: @editor, reviewer: @reviewer, modifiedBy: @modified_by,
                id: @id, format: @format, root: @root_id, root2: @root2_id, synonyms: @include_synonyms,
                showParent: @include_parent, origin: @origin, original: @original, license: @license, rowType: @row_type,
                created: @created_after, createdBefore: @created_before, issued: @issued, issuedBefore: @issued_before,
                modified: @modified_after, modifiedBefore: @modified_before, lastSync: @last_synced_before,
+               nomStatus: @nomenclatural_status, nameType: @name_type,
+               sectorMode: @sector_mode, sectorDatasetKey: @sector_dataset_id, secondarySourceGroup: @secondary_source,
                minSize: @min_size, size: @size, issue: @issue, min: @min, max: @max, datasetKey: @dataset_id_filter,
                withoutData: @without_data, superkingdom: @within_superkingdom, kingdom: @within_kingdom,
                subkingdom: @within_subkingdom, superphylum: @within_superphylum, phylum: @within_phylum,

data/lib/colrapi/version.rb

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

data/lib/colrapi.rb

@@ -543,20 +543,33 @@ module Colrapi
 
   # Search the nameusage route, which uses Elastic Search
   #
-  # @param q [String] A query string
+  # @param authorship [Array, String, nil] filters by authorship
+  # @param authorship_year [Array, String, nil] filters by authorship year
+  # @param content [Array, String, nil] restrict search to SCIENTIFIC_NAME, or AUTHORSHIP
   # @param dataset_id [String, nil] restricts name usage search within a dataset
   # @param endpoint [String, nil] some endpoints have nested options
-  # @param content [Array, String, nil] restrict search to SCIENTIFIC_NAME, or AUTHORSHIP
-  # @param issue [Array, String, nil] the data quality issue
-  # @param type [String, nil] sets the type of search to PREFIX, WHOLE_WORDS, or EXACT
-  # @param rank [String, nil] taxonomic rank of name usages
-  # @param min_rank [String, nil] minimum taxonomic rank of name usages
-  # @param max_rank [String, nil] maximum taxonomic rank of name usages
-  # @param facet [Array, String, nil] the search facet
   # @param environment [Array, String, nil] filter by environment (MARINE, TERRESTRIAL, FRESHWATER, BRACKISH)
+  # @param extinct [Array, int, nil] filter by extinct status (0, 1)
+  # @param facet [Array, String, nil] the search facet
+  # @param field [Array, String, nil] filter by name field (see: http://api.checklistbank.org/vocab/namefield)
   # @param highest_taxon_id [String, nil] Filter by highest taxon ID
+  # @param issue [Array, String, nil] the data quality issue
+  # @param max_rank [String, nil] maximum taxonomic rank of name usages
+  # @param min_rank [String, nil] minimum taxonomic rank of name usages
+  # @param name_type [Array, String, nil] filter by name type (hybrid formula, informal, no name, otu, placeholder, scientific, virus)
+  # @param nomenclatural_code [Array, String, nil] filter by nomenclatural code (botanical, zoological, bacterial, viral, phytosociological, cultivars)
+  # @param nomenclatural_status [Array, String, nil] filter by nomenclatural status (acceptable, conserved, doubtful, established, manuscript, not established, rejected, unacceptable)
+  # @param origin [Array, String, nil] filter by origin of the name usage (see: http://api.checklistbank.org/vocab/origin)
+  # @param q [String] A query string
+  # @param rank [Array, String, nil] taxonomic rank of name usages
+  # @param secondary_source [Array, String, nil] filter by secondary source (authorship, basionym, extinct, holotype, parent, published in, rank, temporal range)
+  # @param sector_dataset_id [Array, String, nil] filter by the sector source dataset ID
+  # @param sector_mode [Array, String, nil] filter by the sector mode (attach, merge, union)
+  # @param status [Array, String, nil] filter by taxonomic status (accepted, ambiguous synonym, misapplied, provisionally accepted, synonym)
+  # @param taxonomic_group [Array, String, nil] filter by taxonomic group (see: http://api.checklistbank.org/vocab/taxgroup)
+  # @param type [String, nil] sets the type of search to PREFIX, WHOLE_WORDS, or EXACT
   # @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
   # @param offset [Integer] Offset for pagination
@@ -564,20 +577,29 @@ module Colrapi
   # @param verbose [Boolean] Print headers to STDOUT
   #
   # @return [Array, Boolean] An array of hashes
-  def self.nameusage_search(q: nil, dataset_id: nil, endpoint: 'nameusage/search', content: nil, issue: nil,
+  def self.nameusage_search(q: nil, authorship: nil, authorship_year: nil, dataset_id: nil, 
+                            endpoint: 'nameusage/search', extinct: nil, field: nil, content: nil, issue: nil,
                             type: nil, rank: nil, min_rank: nil, max_rank: nil, environment: nil, facet: nil,
-                            highest_taxon_id: nil, usage_id: nil, sort_by: nil, reverse: nil, offset: nil, limit: nil, 
-                            verbose: false)
+                            nomenclatural_code: nil, highest_taxon_id: nil, usage_id: nil, nomenclatural_status: nil, 
+                            name_type: nil, origin: nil, secondary_source: nil, 
+                            sector_mode: nil, sector_dataset_id: nil, status: nil, taxonomic_group: 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
     unless dataset_id.nil?
       endpoint = "dataset/#{dataset_id}/nameusage/search"
     end
 
-    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, usage_id: usage_id, sort_by: sort_by, reverse: reverse,
-                offset: offset, limit: limit, verbose: verbose).perform
+    Request.new(endpoint: endpoint, q: q, authorship: authorship, authorship_year: authorship_year, 
+                extinct: extinct, field: field, content: content, issue: issue, type: type,
+                rank: rank, min_rank: min_rank, max_rank: max_rank, facet: facet, 
+                nomenclatural_code: nomenclatural_code,environment: environment, 
+                highest_taxon_id: highest_taxon_id, usage_id: usage_id, 
+                name_type: name_type, nomenclatural_status: nomenclatural_status, origin: origin,
+                secondary_source: secondary_source, sector_mode: sector_mode, 
+                sector_dataset_id: sector_dataset_id, status: status, taxonomic_group: taxonomic_group, 
+                sort_by: sort_by, reverse: reverse,  offset: offset, limit: limit, 
+                verbose: verbose).perform
   end
 
   # Get a name usage suggestion

metadata

@@ -1,35 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colrapi
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Matt Yoder, Geoff Ower
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +120,7 @@ dependencies:
         version: '0.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -151,7 +130,7 @@ dependencies:
         version: '0.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -198,8 +177,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.5
-post_install_message:
+  changelog_uri: https://github.com/SpeciesFileGroup/colrapi/releases/tag/v0.1.7
 rdoc_options: []
 require_paths:
 - lib
@@ -208,14 +186,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.5.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '5.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Catalog of Life Client
 test_files: []