bok_choy 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0af780bde560345f4d936f5fcd3efe6ba54f62859352f106a6d46dd1f076118b
-  data.tar.gz: da3226c89b622eaf26d04bef06f9db84044f2c6e79983ca58e5cb408b792b08e
+  metadata.gz: e973871c42073b45f70862f7e513e04dcfdcc3aa9f22036e27f689e849d3c0e0
+  data.tar.gz: f6b2202540eb7bbb7821cb79578bb2aafd42a5368dd3869992f27235098eef48
 SHA512:
-  metadata.gz: 04e4456d86a9375bb112b89202347ae0314e7d9b9d9262681190a1c9918f66441a9f534b8f4ad16148b0522249d2357d10c2f54ee9245f9d3f7c4c58ac626d1b
-  data.tar.gz: 0f05e72fec74c81b591e3ad0d9b76c46d56190756be52ba08dc41dfe7513373419e83467e4835fb0cc139bbde08853be9c6fce245a9d59676256926da930c679
+  metadata.gz: 810b566a9758fbaf49da9f36bf85eff97774813cefa0762abf1d2359197bcbfd78a9f221e6926cdb0f787a1197bb798d5d971a82f8d47fb0219167290b98a458
+  data.tar.gz: feb4b2af45b1fe162abdf6d5c34eeed9fe0c4577b0f8012bc8f48520b8252ac1b544c06851cde78e0359399541cb498f84aa02464c4c111047459cd3f339f60b

data/.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.1.3
+        ruby-version: 3.3.4
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.0.4]
+ - 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
+
 ## [0.0.2] - 2024-09-11
 - Fixed name/description issues
 

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,13 @@ 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.item_page(item_id: 15402, page_num: 183) #  => Hash
+```
+
 ---
 ### [Page reference metadata](https://bhlnames.globalnames.org/apidoc/index.html#/default/get-refs)
 Get BHL reference metadata by a page ID:
@@ -98,7 +105,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.4.0"
+  s.license       = "MIT"
+  s.required_ruby_version = ">= 2.5.0"
 
  # s.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
 

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.2"
+  VERSION = "0.0.4"
 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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bok_choy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 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
@@ -172,7 +171,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -188,12 +186,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.2
-post_install_message:
+  changelog_uri: https://github.com/SpeciesFileGroup/bok_choy/releases/tag/v0.0.4
 rdoc_options: []
 require_paths:
 - lib
@@ -201,15 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.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: 3.6.7
 specification_version: 4
 summary: BHL Names Client
 test_files: []

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bok_choy (0.0.2)
-      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