bok_choy 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c0f176e351a57af03be2b64c8f3b41e9dd16514057a230900424f0d08e28609
-  data.tar.gz: c33e18c4b41338c1d58a916cc501810a4f27db0f1add72e550507a901adb7d2b
+  metadata.gz: 7e3c63c503bd9e51206ea7d6d854ecda2fbfaabc83c731a2b2affa805b9215cf
+  data.tar.gz: c193032071ef68f7d85544787e7d03ac525ab67c9940838cae7a45674d1cdcb3
 SHA512:
-  metadata.gz: 579e78cfc22b095fe3b930e3a0ec630ea90668eafd88c2b16efa7766129a8cb0a87e32056575ac934f918167b050ab79169992d284619d21bf501fe8426ae31d
-  data.tar.gz: f4d2363a3d23cbd93f4b5101752ee2ede20a97710078836e391833167eeda0ff1b12ccbba0d31515f5cce2236164c23006da2c4f9a2fda43aaaf1ef780bfd355
+  metadata.gz: 4dd25ad34de7f6ad7ec24a3d4834269b386ddfdf525c68075d895b04506752d551c7c19da820de3bb19e0920e5ee8155f4d7ab2a1161b95b1c721481729b3c9c
+  data.tar.gz: 00e3ee3cf9c92f5c5c98fccdfd49749800fe04f334e47d509568fb98d035c2ca16fb1be2d7962ebe263d4c6d4abe831bc8b46bdca9b2cfc892b4d6d2ead99cbe

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,18 @@
 ## [Unreleased]
 
+## [0.0.5] - 2026-06-18
+ - 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
+    - Added `rexml` and `irb` development dependencies (no longer in stdlib on Ruby 4)
+ - Fixed copy-paste residue: 503 error message said "Crossref is rate limiting your requests." (Crossref is the upstream serrano template's API) — changed to "BHLnames is rate limiting your requests."
+
+## [0.0.4] - 2025-10-28
+ - Updated license from NCSA to MIT
+ - Added item_page endpoint
+
 ## [0.0.3] - 2024-09-11
 - Removed Gemfile.lock
 - Bumped development depency versions to avoid CVE-2024-43398

data/LICENSE.txt

@@ -1,13 +1,10 @@
-Copyright © 2023 Species File Group. All rights reserved.
+The MIT License (MIT)
 
-Developed by: Species File Group 
-Illinois Natural History Survey
-https://github.com/SpeciesFileGroup/bok_choy
+Copyright © 2024 Species File Group
 
-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:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in 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 above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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 AUTHORS 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 IN THE SOFTWARE.
 
-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

@@ -56,6 +56,19 @@ Get BHL item metadata by item ID:
 BokChoy.items(73397) #  => Hash
 ```
 
+---
+### [Items page nums](https://bhlnames.globalnames.org/apidoc/index.html#/default/get-refs-by-item-page)
+Get BHL page information by item_id and page_num:
+```ruby
+BokChoy.items_page_nums(item_id: 15402, page_num: 191) #  => Hash
+```
+This corresponds with the identifiers in the BHL item endpoint URLs: [https://www.biodiversitylibrary.org/item/15402#page/191/mode/1up](https://www.biodiversitylibrary.org/item/15402#page/191/mode/1up)
+
+The endpoint returns information about the page including the corresponding pageId and url:
+
+[https://www.biodiversitylibrary.org/page/15402](https://www.biodiversitylibrary.org/page/747872)
+
+
 ---
 ### [Page reference metadata](https://bhlnames.globalnames.org/apidoc/index.html#/default/get-refs)
 Get BHL reference metadata by a page ID:
@@ -98,7 +111,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Specie
 
 ## 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/).
+The gem is available as open source under the terms of the [MIT license](https://github.com/SpeciesFileGroup/bok_choy/blob/main/LICENSE.txt). You can learn more about the MIT license on [Wikipedia](https://en.wikipedia.org/wiki/MIT_License) and compare it with other open source licenses at the [Open Source Initiative](https://opensource.org/license/mit/).
 
 ## Code of Conduct
 

data/bok_choy.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.summary       = "BHL Names Client"
   s.description   = "Bok Choy is a low-level wrapper around the BHLnames API."
   s.homepage      = "https://github.com/SpeciesFileGroup/bok_choy"
-  s.license       = "NCSA"
-  s.required_ruby_version = ">= 2.5.0"
+  s.license       = "MIT"
+  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 "codecov", "~> 0.5.0"
   # s.add_development_dependency "json", "~> 2.3", ">= 2.3.1"
   s.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
@@ -41,9 +40,11 @@ Gem::Specification.new do |s|
   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_development_dependency "rexml", "~> 3.3", ">= 3.3.6"
+  s.add_development_dependency "irb", "~> 1.0"
 
   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"
 
   # TODO: comment out

data/lib/bok_choy/faraday.rb

@@ -20,7 +20,7 @@ module Faraday
           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.")
+            raise BokChoy::ServiceUnavailable, error_message_500(response, "BHLnames is rate limiting your requests.")
           when 504
             raise BokChoy::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
           end

data/lib/bok_choy/request.rb

@@ -8,6 +8,8 @@ module BokChoy
     attr_accessor :endpoint
     attr_accessor :q
     attr_accessor :verbose
+    attr_accessor :item_id
+    attr_accessor :page_num
 
     attr_accessor :options
 
@@ -15,6 +17,8 @@ module BokChoy
       @endpoint = args[:endpoint]
       @verbose = args[:verbose]
       @q = args[:q]
+      @item_id = args[:item_id]
+      @page_num = args[:page_num]
       @json = args[:json].to_json
       @options = args[:options] # TODO: not added at bok_choy.rb
     end
@@ -22,9 +26,12 @@ module BokChoy
     def perform
 
       args = {
-        json: @json
+        json: @json,
+        item_id: @item_id,
+        page_num: @page_num
       }
       opts = args.delete_if { |_k, v| v.nil? }
+      opts = args.delete_if { |_k, v| v == 'null' }
 
       Faraday::Utils.default_space_encoding = "+"
 

data/lib/bok_choy/version.rb

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

data/lib/bok_choy.rb

@@ -50,6 +50,20 @@ module BokChoy
     Request.new(endpoint: endpoint, verbose: verbose).perform
   end
 
+  # Get a page by item ID and page number
+  #
+  # @param item_id [String] A BHL item ID
+  # @param page_num [String] A BHL page number
+  # @param verbose [Boolean] Print headers to STDOUT
+  #
+  # @return [Hash] A result hash
+  def self.items_page_nums(item_id: nil, page_num: nil, verbose: false)
+    raise "Item ID and page number required" if item_id.nil? || page_num.nil?
+
+    endpoint = "items_page_nums"
+    Request.new(endpoint: endpoint, item_id: item_id, page_num: page_num, verbose: verbose).perform
+  end
+
   # Get metadata and taxonomic statistics for a BHL item
   # 
   # @param id [String] A BHL item ID

metadata

@@ -1,35 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bok_choy
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Geoff Ower, Matt Yoder
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-11 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
@@ -98,6 +77,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  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: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +134,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
@@ -131,7 +144,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
@@ -187,12 +200,11 @@ files:
 - lib/bok_choy/version.rb
 homepage: https://github.com/SpeciesFileGroup/bok_choy
 licenses:
-- NCSA
+- MIT
 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.3
-post_install_message:
+  changelog_uri: https://github.com/SpeciesFileGroup/bok_choy/releases/tag/v0.0.5
 rdoc_options: []
 require_paths:
 - lib
@@ -201,14 +213,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.11
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: BHL Names Client
 test_files: []