colrapi 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aea2e44a818d41cd832614bd00cb148714061db766ef82a61be48a036568d032
-  data.tar.gz: d7b3de2c633901fc8e30f6f80fb8fe47bbb1b9702d016f1240fed959c26479ba
+  metadata.gz: 07aa378c2254f300d7086a0a2679e36a594a99a939d4487adb8745f96abe50b6
+  data.tar.gz: ada0fe3d028b8a20be01c229165fdff97ee67fd0684d078989891e067d68a862
 SHA512:
-  metadata.gz: a24bec052600b4f5cf3402e5cf8b5ad62e40dd5178d79285812acd594caaa91d18c4dd28c29bbb4eba6eb9da8aaec5a619d2263c929c49edc1b91dfef9caa5f9
-  data.tar.gz: 7b495d6b3ea866840958a56334a1493f94b39568df0a474b6de5cae4940c18206a3041c9920b2567ade50d71326d13861502722bfaa1433e0e45e3a626c33b2e
+  metadata.gz: 12513f5a616691d81568970d0f5e65c9198990c8a167327c0e9d36b856f562f2cbb56004a7a78a01e6e6a2d7be5c3d3cfbd51c51f67f561c63ff2b480ebe0b20
+  data.tar.gz: 9245c8a61aa5f716467cf64d8bafb00a6d0987d88a2055411c3baa8ee9a62b8b04f14a882987f65b4b6e9003bd228004cae950e1ff5cadb21ae69fb5c03c82b2

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [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/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]
@@ -108,16 +119,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,
+               status: @status, 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.6"
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colrapi
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Matt Yoder, Geoff Ower
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 2025-04-01 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.5
+  changelog_uri: https://github.com/SpeciesFileGroup/colrapi/releases/tag/v0.1.6
 post_install_message:
 rdoc_options: []
 require_paths: