bok_choy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43d055eafd9af6679bee016cb2b4dfd03ad76b8debba36c94ccbaf137053ac85
+  data.tar.gz: 819fe37ee40adff0d6bedfe98c6105cbe737dffaca202222c52b22489e7dc990
+SHA512:
+  metadata.gz: 5503ffdf0f89da4f9618b3ffeacdc6725e59f932a4eb9578aa11acc82ecef55769da86c3ff57911f4780985aa4462c9768f1d51353895a00d461f6dad48c8c13
+  data.tar.gz: bc37a4f7606991fcb59dcf9c9d3f4925e0611c6538a217e8e687360e1cbaa80a7b1f9fd5dad0e821ca2b56b2e351fd65409475d7e3e65c50cfa9139b06a674c2

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1.3
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake
+      env:
+        USER: ${{ vars.USER }}
+        PASSWORD: ${{ secrets.PASSWORD }}

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2024-09-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at diapriid@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bok_choy.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    bok_choy (0.0.1)
+      faraday (~> 2.2)
+      faraday-follow_redirects (>= 0.1, < 0.4)
+      multi_json (~> 1.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    faraday (2.11.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      logger
+    faraday-follow_redirects (0.3.0)
+      faraday (>= 1, < 3)
+    faraday-net_http (3.3.0)
+      net-http
+    hashdiff (1.0.1)
+    logger (1.6.1)
+    minitest (5.15.0)
+    multi_json (1.15.0)
+    net-http (0.4.1)
+      uri
+    power_assert (2.0.1)
+    public_suffix (5.0.1)
+    rake (13.0.6)
+    rexml (3.2.5)
+    test-unit (3.5.3)
+      power_assert
+    uri (0.13.1)
+    vcr (6.0.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bok_choy!
+  bundler (~> 2.1, >= 2.1.4)
+  byebug
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  test-unit (~> 3.3, >= 3.3.6)
+  vcr (~> 6.0)
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.3.24

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright © 2023 Species File Group. All rights reserved.
+
+Developed by: Species File Group 
+Illinois Natural History Survey
+https://github.com/SpeciesFileGroup/bok_choy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal with 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:
+
+    Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
+    Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimers in the documentation and/or other materials provided with the distribution.
+    Neither the names of <Name of Development Group, Name of Institution>, nor the names of its contributors may be used to endorse or promote products derived from this Software without specific prior written permission.
+
+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 CONTRIBUTORS 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 WITH THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# BokChoy
+
+BokChoy is a Ruby wrapper on the [BHLNames](https://github.com/gnames/bhlnames) API. Code follow the spirit/approach of the Gem [serrano](https://github.com/sckott/serrano), and indeed much of the wrapping utility is copied 1:1 from that repo, thanks [@sckott](https://github.com/sckott).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bok_choy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bok_choy
+
+## Usage
+
+### [Name references](https://bhlnames.globalnames.org/apidoc/index.html#/default/post-name-refs)
+Although BHLnames offers a GET endpoint, the API wrapper always encodes the input parameters into JSON and uses the POST endpoint. 
+For more control of the input parameters, you can omit all other parameters and directly post JSON. See the [API docs](https://bhlnames.globalnames.org/apidoc/index.html#/default/post-name-refs) for the full list of possible inputs in the JSON.
+
+Find BHL reference matches for a scientific name
+```ruby
+BokChoy.name_refs(name: 'Pardosa moesta') #  => Hash
+```
+
+Find BHL reference matches with a scientific name, author and year:
+```ruby
+BokChoy.name_refs(name: 'Pardosa moesta', author: 'Banks', year: 1892, reference: 'Bulletin of the American Museum of Natural History v.29 (1911)', nomen_event: false) #  => Hash
+```
+
+Find BHL reference matches for a scientific name with a reference string:
+```ruby
+BokChoy.name_refs(name: 'Pardosa moesta', reference: 'Bulletin of the American Museum of Natural History v.29 (1911)') #  => Hash
+```
+
+Find BHL reference matches for a nomenclatural event:
+```ruby
+BokChoy.name_refs(name: 'Pardosa moesta', nomen_event: true) #  => Hash
+```
+
+Find BHL reference matches with json input:
+```ruby
+BokChoy.name_refs(json: {"name": {"nameString": "Pardosa moesta", "author": "Banks", "year": 1892}, "reference": {}, "params": {"nomenEvent": true}}) #  => Hash
+```
+
+---
+### [Item metadata](https://bhlnames.globalnames.org/apidoc/index.html#/default/get-item)
+Get BHL item metadata by item ID:
+```ruby
+BokChoy.items(73397) #  => Hash
+```
+
+---
+### [Page reference metadata](https://bhlnames.globalnames.org/apidoc/index.html#/default/get-refs)
+Get BHL reference metadata by a page ID:
+```ruby
+BokChoy.references(6589171) #  => Hash
+```
+
+---
+### [External identifiers](https://bhlnames.globalnames.org/apidoc/index.html#/default/get-cached-refs)
+Get a nomenclatural event in BHL by an external identifier:
+```ruby
+BokChoy.cached_refs('6C8Q2') #  => Hash
+```
+
+---
+### [Ping](https://bhlnames.globalnames.org/apidoc/index.html#/default/get-ping)
+Test the status of the API service:
+```ruby
+BokChoy.ping  #  => String
+```
+
+---
+### [Version](https://bhlnames.globalnames.org/apidoc/index.html#/default/get-version)
+Get the version of the BHLnames API service:
+```ruby
+BokChoy.version  #  => Hash
+```
+
+---
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, update the `CHANGELOG.md`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SpeciesFileGroup/bok_choy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/SpeciesFileGroup/bok_choy/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [NCSA/Illinois](https://github.com/SpeciesFileGroup/bok_choy/blob/main/LICENSE.txt) license. You can learn more about the NCSA license on [Wikipedia](https://en.wikipedia.org/wiki/University_of_Illinois/NCSA_Open_Source_License) and compare it with other open source licenses at the [Open Source Initiative](https://opensource.org/license/uoi-ncsa-php/).
+
+## Code of Conduct
+
+Everyone interacting in the BokChoy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SpeciesFileGroup/bok_choy/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc "Run tests"
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bok_choy"
+
+# 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/bok_choy.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "lib/bok_choy/version"
+
+Gem::Specification.new do |s|
+  s.name          = "bok_choy"
+  s.version       = BokChoy::VERSION
+  s.authors       = ["Geoff Ower, Matt Yoder"]
+  s.email         = ["gdower@illinois.edu"]
+
+  s.summary       = "BHL Names Client"
+  s.description   = "Bok Choy is a low-level wrapper around the Bionomia API."
+  s.homepage      = "https://github.com/SpeciesFileGroup/bok_choy"
+  s.license       = "NCSA"
+  s.required_ruby_version = ">= 2.4.0"
+
+ # s.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/SpeciesFileGroup/bok_choy"
+  s.metadata["changelog_uri"] = "https://github.com/SpeciesFileGroup/bok_choy/releases/tag/v#{s.version}"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|s|features)/}) }
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # 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 "codecov", "~> 0.5.0"
+  # s.add_development_dependency "json", "~> 2.3", ">= 2.3.1"
+  s.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
+  # s.add_development_dependency "standard", "~> 1.0"
+  # s.add_development_dependency "simplecov", "~> 0.21.2"
+  s.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.6"
+  s.add_development_dependency "vcr", "~> 6.0"
+  s.add_development_dependency "webmock", "~> 3.18"
+
+  s.add_runtime_dependency "faraday", "~> 2.2"
+  s.add_runtime_dependency "faraday-follow_redirects", ">= 0.1", "< 0.4"
+  s.add_runtime_dependency "multi_json", "~> 1.15"
+
+  # TODO: comment out
+  s.add_development_dependency "byebug"
+
+  #  s.add_runtime_dependency "thor", "~> 1.0", ">= 1.0.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/bok_choy/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BokChoy
+    # Custom error class for rescuing from all BokChoy errors
+    class Error < StandardError; end
+  
+    # Raised when Bionomia returns the HTTP status code 400
+    class BadRequest < Error; end
+  
+    # Raised when Bionomia returns the HTTP status code 404
+    class NotFound < Error; end
+  
+    # Raised when Bionomia returns the HTTP status code 500
+    class InternalServerError < Error; end
+  
+    # Raised when Bionomia returns the HTTP status code 502
+    class BadGateway < Error; end
+  
+    # Raised when Bionomia returns the HTTP status code 503
+    class ServiceUnavailable < Error; end
+  
+    # Raised when Bionomia returns the HTTP status code 504
+    class GatewayTimeout < Error; end
+  end

data/lib/bok_choy/faraday.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "multi_json"
+
+# @private
+module Faraday
+  module BokChoyErrors
+    # @private
+    class Middleware < Faraday::Middleware
+      def call(env)
+        @app.call(env).on_complete do |response|
+          case response[:status].to_i
+          when 400
+            raise BokChoy::BadRequest, error_message_400(response)
+          when 404
+            raise BokChoy::NotFound, error_message_400(response)
+          when 500
+            raise BokChoy::InternalServerError, error_message_500(response, "Something is technically wrong.")
+          when 502
+            raise BokChoy::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+          when 503
+            raise BokChoy::ServiceUnavailable, error_message_500(response, "Crossref is rate limiting your requests.")
+          when 504
+            raise BokChoy::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+          end
+        end
+      end
+
+      def initialize(app)
+        super app
+        @parser = nil
+      end
+
+      private
+
+      def error_message_400(response)
+        "\n   #{response[:method].to_s.upcase} #{response[:url]}\n   Status #{response[:status]}#{error_body(response[:body])}"
+      end
+
+      def error_body(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          if json?(body)
+            body = ::MultiJson.load(body)
+            if body["message"].nil?
+              body = nil
+            else
+              body = body["message"]
+            end
+          end
+        end
+
+        if body.nil?
+          nil
+        else
+          ": #{body}"
+        end
+      end
+
+      def error_message_500(response, body = nil)
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ":", body].compact.join(" ")}"
+      end
+
+      def json?(string)
+        MultiJson.load(string)
+        true
+      rescue MultiJson::ParseError
+        false
+      end
+    end
+  end
+end
+

data/lib/bok_choy/helpers/configuration.rb

@@ -0,0 +1,26 @@
+# taken from https://raw.githubusercontent.com/sckott/serrano/main/lib/serrano/helpers/configuration.rb
+# taken from: https://viget.com/extend/easy-gem-configuration-variables-with-defaults
+module Configuration
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end
+

data/lib/bok_choy/request.rb

@@ -0,0 +1,64 @@
+require_relative "faraday" # !! Potential ruby 3.0 difference in module loading? relative differs from Serrano
+require "faraday/follow_redirects"
+require_relative "utils"
+
+module BokChoy
+
+  class Request
+    attr_accessor :endpoint
+    attr_accessor :q
+    attr_accessor :verbose
+
+    attr_accessor :options
+
+    def initialize(**args)
+      @endpoint = args[:endpoint]
+      @verbose = args[:verbose]
+      @q = args[:q]
+      @json = args[:json].to_json
+      @options = args[:options] # TODO: not added at bok_choy.rb
+    end
+
+    def perform
+
+      args = {
+        json: @json
+      }
+      opts = args.delete_if { |_k, v| v.nil? }
+
+      Faraday::Utils.default_space_encoding = "+"
+
+      conn = if verbose
+               Faraday.new(url: BokChoy.base_url) do |f|
+                 f.response :logger
+                 f.use Faraday::BokChoyErrors::Middleware
+                 f.adapter Faraday.default_adapter
+               end
+             else
+               Faraday.new(url: BokChoy.base_url) do |f|
+                 f.use Faraday::BokChoyErrors::Middleware
+                 f.adapter Faraday.default_adapter
+               end
+             end
+
+      conn.headers['Accept'] = 'application/json,*/*'
+      conn.headers[:user_agent] = make_user_agent
+      conn.headers["X-USER-AGENT"] = make_user_agent
+      conn.headers['Content-Type'] = 'application/json'
+
+      if %w[name_refs].include? endpoint
+        res = conn.post(endpoint, opts[:json])
+      else
+        res = conn.get(endpoint, opts)
+      end
+
+      # Handles endpoints that do not return JSON
+      begin
+        MultiJson.load(res.body)
+      rescue MultiJson::ParseError
+        res.body
+      end
+      
+    end
+  end
+end

data/lib/bok_choy/utils.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# From https://raw.githubusercontent.com/sckott/serrano/main/lib/serrano/utils.rb
+
+def make_user_agent
+  requa = "Faraday/v" + Faraday::VERSION
+  habua = "BokChoy/v" + BokChoy::VERSION
+  ua = requa + " " + habua
+  if BokChoy.mailto
+    ua += " (mailto:%s)" % BokChoy.mailto
+  end
+  # ua += format(' (mailto:%s)', BokChoy.mailto) if BokChoy.mailto
+  ua
+end
+
+def field_query_handler(x)
+  tmp = x.keep_if { |z| z.match(/query_/) }
+  rename_query_filters(tmp)
+end
+
+def rename_query_filters(foo)
+  foo = foo.tostrings
+  foo = foo.map { |x, y| [x.to_s.sub("container_title", "container-title"), y] }.to_h
+  foo.map { |x, y| [x.to_s.sub("query_", "query."), y] }.to_h
+end
+
+class Hash
+  def tostrings
+    map { |(k, v)| [k.to_s, v] }.to_h
+  end
+end
+
+class Hash
+  def tosymbols
+    map { |(k, v)| [k.to_sym, v] }.to_h
+  end
+end
+

data/lib/bok_choy/version.rb

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

data/lib/bok_choy.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+require "erb"
+require_relative "bok_choy/error"
+require_relative "bok_choy/version"
+require_relative "bok_choy/request"
+require "bok_choy/helpers/configuration"
+
+# The BokChoy module provides a Ruby interface to the BHL Names API
+module BokChoy
+  extend Configuration
+
+  define_setting :base_url, "https://bhlnames.globalnames.org/api/v1/"
+  define_setting :mailto, ENV["BOK_CHOY_API_EMAIL"]
+
+  # Finds BHL references for a name
+  # @param name [String] A canonical scientific name (e.g., Pardosa moesta)
+  # @param author [String, nil] An author string (e.g., Banks)
+  # @param year [String, nil] A year string (e.g., 1892)
+  # @param reference [String, nil] A reference string (e.g., Docums Mycol. 34(nos 135-136))
+  # @param nomen_event [Boolean, nil] If true, tries to find nomenclatural event reference (default: true)
+  # @param json [Hash, nil] An optional JSON hash of name and reference data (overrides all other parameters)
+  # @param verbose [Boolean] Print headers to STDOUT
+  #
+  # @return [Hash] A result hash
+  def self.name_refs(name: nil, author: nil, year: nil, reference: nil, nomen_event: true, json: nil, verbose: false)
+    raise "Name or json required" if name.nil? && json.nil?
+
+    if json.nil?
+      json = {'name': {}, 'reference': {}, 'params': {}}
+      json[:name][:nameString] = name
+      json[:name][:author] = author unless author.nil?
+      json[:name][:year] = year unless year.nil?
+      json[:reference][:refString] = reference unless reference.nil?
+      json[:params][:nomenEvent] = nomen_event
+    end
+    endpoint = "name_refs"
+    Request.new(endpoint: endpoint, json: json, verbose: verbose).perform
+  end
+
+  # Finds a nomenclatural event in BHL by an external ID from a data source
+  # 
+  # @param id [String] An external ID from a data source
+  # @param verbose [Boolean] Print headers to STDOUT
+  # 
+  # @return [Hash] A result hash
+  def self.cached_refs(id, verbose: false)
+    raise "ID required" if id.nil?
+
+    endpoint = "cached_refs/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get metadata and taxonomic statistics for a BHL item
+  # 
+  # @param id [String] A BHL item ID
+  # @param verbose [Boolean] Print headers to STDOUT
+  # 
+  # @return [Hash] A result hash
+  def self.items(id, verbose: false)
+    raise "ID required" if id.nil?
+
+    endpoint = "items/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get BHL reference metadata by page ID
+  #
+  # @param id [String] A page ID from BHL
+  # @param verbose [Boolean] Print headers to STDOUT
+  #
+  # @return [Hash, String, Boolean] A JSON-LD hash or CSV
+  def self.page(id, verbose: false)
+    raise "ID required" if id.nil?
+
+    endpoint = "references/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Finds BHL items in which a given higher taxon is prevalent
+  # 
+  # @param taxon_name [String] A taxonomic name (e.g., Lepidoptera)
+  # @param verbose [Boolean] Print headers to STDOUT
+  #
+  # @return [Hash] A result hash
+  def self.taxon_items(taxon_name: nil, verbose: false)
+    raise "Taxon name required" if taxon_name.nil?
+
+    taxon_url = ERB::Util.url_encode(taxon_name)
+    endpoint = "taxon_items/#{taxon_url}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Gets BHL reference metadata by page ID
+  # 
+  # @param id [String] A page ID from BHL
+  # @param verbose [Boolean] Print headers to STDOUT
+  # 
+  # @return [Hash] A result hash
+  def self.references(id, verbose: false)
+    raise "ID required" if id.nil?
+
+    endpoint = "references/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Check the API status
+  #
+  # @param verbose [Boolean] Print headers to STDOUT
+  #
+  # @return [String] A pong string
+  def self.ping(verbose: false)
+    endpoint = "ping"
+    Request.new(
+      endpoint: endpoint,
+      verbose: verbose
+    ).perform
+  end
+
+  # Check the API version
+  #
+  # @param verbose [Boolean] Print headers to STDOUT
+  #
+  # @return [Hash] A version hash
+  def self.version(verbose: false)
+    endpoint = "version"
+    Request.new(
+      endpoint: endpoint,
+      verbose: verbose
+    ).perform
+  end
+
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: bok_choy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Geoff Ower, Matt Yoder
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-11 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bok Choy is a low-level wrapper around the Bionomia API.
+email:
+- gdower@illinois.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bok_choy.gemspec
+- lib/bok_choy.rb
+- lib/bok_choy/error.rb
+- lib/bok_choy/faraday.rb
+- lib/bok_choy/helpers/configuration.rb
+- lib/bok_choy/request.rb
+- lib/bok_choy/utils.rb
+- lib/bok_choy/version.rb
+homepage: https://github.com/SpeciesFileGroup/bok_choy
+licenses:
+- NCSA
+metadata:
+  homepage_uri: https://github.com/SpeciesFileGroup/bok_choy
+  source_code_uri: https://github.com/SpeciesFileGroup/bok_choy
+  changelog_uri: https://github.com/SpeciesFileGroup/bok_choy/releases/tag/v0.0.1
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: BHL Names Client
+test_files: []