folio_client 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 726191de10d2f5974ac8294f2c4f93a75146631dd2c86200d2de53f9c72cd76f
-  data.tar.gz: 2ec95c6e87c4541fb1b2b7050c2bd84d5bd3a46f948b0b711b8f042f58ddf6e5
+  metadata.gz: ad8e1c9733f1bba9dc63d5f8c19edb7f4b40a7c16084c3f434175582d466d70a
+  data.tar.gz: 32beb6817690d4e95a7ce741fbde1466ccc75b7a13489230b0f1d859af6b7baa
 SHA512:
-  metadata.gz: ce0de774a34bbc7eda7a97d26e9ac12d49297a804994425045fe7a8b85017401f54dd11fd43952e4f75e799e232979475f3881eb6f9a211e6f4e32df48168424
-  data.tar.gz: eb31f66db330ab973060794cfcfb30471c02d21529c5242f62fc11a5d97542f1ce13587af5f8d6b2057d5b709951f9c49690725937e39f3d84236df144da3b73
+  metadata.gz: c49e0286404a94fc67bc973b40501885410e5b560e24a922664c2d8e9031766fdfb85af55896cadf21ea8eb91fe85eea6829fa35f7a0645d6a543055c63ef44b
+  data.tar.gz: 6f1deeee160c8625a5c84c68c57cfb35e3d28d16af0b08c4423478dc8026ebc8a637dcda752b21b814169c49970c0d399511d9c79020ead609470c90ecb150f8

data/.rubocop/custom.yml

@@ -11,6 +11,8 @@ RSpec/MultipleMemoizedHelpers:
   Enabled: false
 RSpec/MultipleExpectations:
   Max: 3
+RSpec/ExampleLength:
+  Max: 15
 
 RSpec/BeEq: # new in 2.9.0
   Enabled: true
@@ -60,3 +62,9 @@ RSpec/FactoryBot/FactoryNameStyle: # new in 2.16
   Enabled: true
 RSpec/Rails/MinitestAssertions: # new in 2.17
   Enabled: true
+RSpec/RedundantAround: # new in 2.19
+  Enabled: true
+RSpec/SkipBlockInsideExample: # new in 2.19
+  Enabled: true
+RSpec/Rails/TravelAround: # new in 2.19
+  Enabled: true

data/.rubocop.yml

@@ -12,4 +12,3 @@ inherit_gem:
 
 inherit_from:
   - .rubocop/custom.yml
-  - .rubocop_todo.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.8.0)
+    folio_client (0.10.0)
       activesupport (>= 4.2, < 8)
       dry-monads
       faraday
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.2)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -67,21 +67,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.44.1)
+    rubocop (1.48.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
+    rubocop-ast (1.28.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.17.1)
       rubocop (~> 1.41)
-    rubocop-performance (1.15.2)
+    rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rspec (2.19.0)
@@ -96,10 +96,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.24.3)
+    standard (1.25.3)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.44.1)
-      rubocop-performance (= 1.15.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)

data/README.md

@@ -5,7 +5,7 @@
 
 # FolioClient
 
-FolioClient is a Ruby gem that acts as a client to the RESTful HTTP APIs provided by the Folio ILS API.  It requires ruby 3.0 or better.
+FolioClient is a Ruby gem that acts as a client to the RESTful HTTP APIs provided by the Folio ILS API. It requires ruby 3.0 or better.
 
 ## Installation
 
@@ -48,7 +48,7 @@ client = FolioClient.configure(
 )
 ```
 
-The client is smart enough to automatically request a new token if it detects the one it is using has expired.  If for some reason, you want to immediately request a new token, you can do this:
+The client is smart enough to automatically request a new token if it detects the one it is using has expired. If for some reason, you want to immediately request a new token, you can do this:
 
 ```ruby
 client.config.token = FolioClient::Authenticator.token(client.config.login_params, client.connection)
@@ -56,7 +56,7 @@ client.config.token = FolioClient::Authenticator.token(client.config.login_param
 
 ## API Coverage
 
-FolioClient provides a number of methods to simplify connecting to the RESTful HTTP API of the Folio API. In this section we list all of the available methods, reflecting how much of the API the client covers.  Note that this assumes the client has already been configured, as described above.  See dor-services-app for an example of configuration and usage.
+FolioClient provides a number of methods to simplify connecting to the RESTful HTTP API of the Folio API. In this section we list all of the available methods, reflecting how much of the API the client covers. Note that this assumes the client has already been configured, as described above. See dor-services-app for an example of configuration and usage.
 
 ```ruby
 # Lookup an instance hrid given a barcode
@@ -65,13 +65,13 @@ client.fetch_hrid(barcode: "12345")
  => "a7927874"
 
 # Request a MARC record given an instance hrid
-# returns a hash if found; raises FolioClient::UnexpectedResponse::ResourceNotFound if instance_hrid not found
+# returns a hash if found; raises FolioClient::ResourceNotFound if instance_hrid not found
 client.fetch_marc_hash(instance_hrid: "a7927874")
  => {"fields"=>
   [{"003"=>"FOLIO"}....]
   }
 
-# Import a MARC record
+# Import a MARC record into FOLIO
 data_importer = client.data_import(marc: my_marc, job_profile_id: '4ba4f4ab', job_profile_name: 'ETDs')
 # If called too quickly, might get Failure(:not_found)
 data_importer.status
@@ -81,16 +81,48 @@ data_importer.wait_until_complete
 data_importer.instance_hrid
  => Success("in00000000010")
 
-# Create a Holdings record
-holdings_client = client.holdings(instance_id: "99a6d818-d523-42f3-9844-81cf3187dbad")
-holdings_client.create(permanent_location_id: "1b14e21c-8d47-45c7-bc49-456a0086422b", holdings_type_id: "996f93e2-5b5e-4cf2-9168-33ced1f95eed")
- => {
-    "id" => "581f6289-001f-49d1-bab7-035f4d878cbd",
-    "_version" => 1,
-    "hrid" => "ho00000000065",
-    "holdingsTypeId" => "996f93e2-5b5e-4cf2-9168-33ced1f95eed"
-    ...
- }
+# Get list of organizations (filtered with an optional query)
+# see https://s3.amazonaws.com/foliodocs/api/mod-organizations/p/organizations.html#organizations_organizations_get
+ client.organizations
+ => {"organizations"=>[
+     {"id"=>"4b1a42f9-b310-492c-a71d-b8edcd30ac0c",
+    "name"=>"Seventh Art Releasing",
+    "code"=>"7ART-SUL",
+    "exportToAccounting"=>true,
+    "status"=>"Active",
+    "organizationTypes"=>[],
+    "aliases"=>[],
+    "addresses"=>],.....
+    "totalRecords"=>100}
+
+client.organizations(query: 'name="Seventh"')
+=> {"organizations"=>[....
+
+# Get list of organization interface items (filtered with an optional query)
+# see https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/interface.html#organizations_storage_interfaces_get
+client.organization_interfaces
+ => {"interfaces"=>
+        [{"id"=>"c6f7470e-6229-45ce-b3f9-32006e9affcf",
+          "name"=>"tes",
+          "type"=>["Invoices"],
+    .....],....
+    "totalRecords"=>100}
+
+ client.organization_interfaces(query: 'name="tes"')
+  => {"interfaces"=>....
+
+# Get details for a specific organization interface
+# see https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/interface.html#organizations_storage_interfaces__id__get
+client.interface_details(id: 'c6f7470e-6229-45ce-b3f9-32006e9affcf')
+ =>
+    {"id"=>"c6f7470e-6229-45ce-b3f9-32006e9affcf",
+    "name"=>"tes",
+    "type"=>["Invoices"],
+    "metadata"=>
+    {"createdDate"=>"2023-02-16T22:27:51.515+00:00",
+    "createdByUserId"=>"38524916-598d-4edf-a2ef-04bba7e78ad6",
+    "updatedDate"=>"2023-02-16T22:27:51.515+00:00",
+    "updatedByUserId"=>"38524916-598d-4edf-a2ef-04bba7e78ad6"}}
 ```
 
 ## Development

data/lib/folio_client/inventory.rb

@@ -10,8 +10,9 @@ class FolioClient
       @client = client
     end
 
-    # @param barcode [String] barcode to search by to fetch the HRID
-    # @return [String,nil] HRID if present, otherwise nil.
+    # get instance HRID from barcode
+    # @param barcode [String] barcode
+    # @return [String,nil] instance HRID if present, otherwise nil.
     def fetch_hrid(barcode:)
       # find the instance UUID for this barcode
       instance = client.get("/search/instances", {query: "items.barcode==#{barcode}"})
@@ -24,8 +25,9 @@ class FolioClient
       result.dig("hrid")
     end
 
-    # @param hrid [String] HRID to search by to fetch the external ID
-    # @return [String,nil] external ID if present, otherwise nil.
+    # get instance external ID from HRID
+    # @param hrid [String] instance HRID
+    # @return [String,nil] instance external ID if present, otherwise nil.
     # @raise [ResourceNotFound, MultipleResourcesFound] if search does not return exactly 1 result
     def fetch_external_id(hrid:)
       instance_response = client.get("/search/instances", {query: "hrid==#{hrid}"})
@@ -36,11 +38,11 @@ class FolioClient
       instance_response.dig("instances", 0, "id")
     end
 
-    # Retrieve basic information about a record.  Example usage: get the external ID and _version for update using
+    # Retrieve basic information about a instance record.  Example usage: get the external ID and _version for update using
     #  optimistic locking when the HRID is available: `fetch_instance_info(hrid: 'a1234').slice('id', '_version')`
     #  (or vice versa if the external ID is available).
-    # @param external_id [String] an external ID for looking up info about the record
-    # @param hrid [String] an HRID for looking up info about the record
+    # @param external_id [String] an external ID for the desired instance record
+    # @param hrid [String] an instance HRID for the desired instance record
     # @return [Hash] information about the record.
     # @raise [ArgumentError] if the caller does not provide exactly one of external_id or hrid
     def fetch_instance_info(external_id: nil, hrid: nil)
@@ -51,9 +53,10 @@ class FolioClient
       client.get("/inventory/instances/#{external_id}")
     end
 
-    # @param hrid [String] folio instance HRID
+    # @param hrid [String] instance HRID
     # @param status_id [String] uuid for an instance status code
-    # @raise [ResourceNotFound] if search by hrid returns 0 results
+    # @return true if instance status matches the uuid param, false otherwise
+    # @raise [ResourceNotFound] if search by instance HRID returns 0 results
     def has_instance_status?(hrid:, status_id:)
       # get the instance record and its statusId
       instance = client.get("/inventory/instances", {query: "hrid==#{hrid}"})

data/lib/folio_client/job_status.rb

@@ -87,7 +87,7 @@ class FolioClient
     def check_not_found(result, index)
       return unless result.failure? && result.failure == :not_found && index > 2
 
-      raise ResourceNotFound, "Job not found"
+      raise ResourceNotFound, "Job #{job_execution_id} not found after #{index} retries"
     end
   end
 end

data/lib/folio_client/organizations.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class FolioClient
+  # Query organization records in Folio; see
+  # https://s3.amazonaws.com/foliodocs/api/mod-organizations/p/organizations.html
+  # https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/interface.html
+  class Organizations
+    attr_accessor :client
+
+    # @param client [FolioClient] the configured client
+    def initialize(client)
+      @client = client
+    end
+
+    # @param query [String] an optional query to limit the number of organizations returned
+    # @param limit [Integer] the number of results to return (defaults to 10,000)
+    # @param offset [Integer] the offset for results returned (defaults to 0)
+    # @param lang [String] language code for returned results (defaults to 'en')
+    def fetch_list(query: nil, limit: 10000, offset: 0, lang: "en")
+      params = {limit: limit, offset: offset, lang: lang}
+      params[:query] = query if query
+      client.get("/organizations/organizations", params)
+    end
+
+    # @param query [String] an optional query to limit the number of organization interfaces returned
+    # @param limit [Integer] the number of results to return (defaults to 10,000)
+    # @param offset [Integer] the offset for results returned (defaults to 0)
+    # @param lang [String] language code for returned results (defaults to 'en')
+    def fetch_interface_list(query: nil, limit: 10000, offset: 0, lang: "en")
+      params = {limit: limit, offset: offset, lang: lang}
+      params[:query] = query if query
+      client.get("/organizations-storage/interfaces", params)
+    end
+
+    # @param id [String] id for requested storage interface
+    # @param lang [String] language code for returned result (defaults to 'en')
+    def fetch_interface_details(id:, lang: "en")
+      client.get("/organizations-storage/interfaces/#{id}", {
+        lang: lang
+      })
+    end
+  end
+end

data/lib/folio_client/source_storage.rb

@@ -10,6 +10,7 @@ class FolioClient
       @client = client
     end
 
+    # get marc bib data from folio given an instance HRID
     # @param instance_hrid [String] the key to use for MARC lookup
     # @return [Hash] hash representation of the MARC. should be usable by MARC::Record.new_from_hash (from ruby-marc gem)
     # @raises NotFound, MultipleRecordsForIdentifier

data/lib/folio_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioClient
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 end

data/lib/folio_client.rb

@@ -53,7 +53,8 @@ class FolioClient
     end
 
     delegate :config, :connection, :get, :post, :put, to: :instance
-    delegate :fetch_hrid, :fetch_external_id, :fetch_instance_info, :fetch_marc_hash, :has_instance_status?, :data_import, :holdings, :edit_marc_json, to: :instance
+    delegate :fetch_hrid, :fetch_external_id, :fetch_instance_info, :fetch_marc_hash, :has_instance_status?, :data_import, :edit_marc_json,
+      :organizations, :organization_interfaces, :interface_details, to: :instance
   end
 
   attr_accessor :config
@@ -124,50 +125,71 @@ class FolioClient
   end
 
   # Public methods available on the FolioClient below
+
+  # @see Inventory#fetch_hrid
   def fetch_hrid(...)
     Inventory
       .new(self)
       .fetch_hrid(...)
   end
 
+  # @see Inventory#fetch_external_id
   def fetch_external_id(...)
     Inventory
       .new(self)
       .fetch_external_id(...)
   end
 
+  # @see Inventory#fetch_instance_info
   def fetch_instance_info(...)
     Inventory
       .new(self)
       .fetch_instance_info(...)
   end
 
+  # @see SourceStorage#fetch_marc_hash
   def fetch_marc_hash(...)
     SourceStorage
       .new(self)
       .fetch_marc_hash(...)
   end
 
+  # @see Inventory#has_instance_status?
   def has_instance_status?(...)
     Inventory
       .new(self)
       .has_instance_status?(...)
   end
 
+  # @ see DataImport#import
   def data_import(...)
     DataImport
       .new(self)
       .import(...)
   end
 
-  def holdings(...)
-    Holdings
-      .new(self, ...)
-  end
-
+  # @see RecordsEditor.edit_marc_json
   def edit_marc_json(...)
     RecordsEditor
       .new(self)
       .edit_marc_json(...)
   end
+
+  def organizations(...)
+    Organizations
+      .new(self)
+      .fetch_list(...)
+  end
+
+  def organization_interfaces(...)
+    Organizations
+      .new(self)
+      .fetch_interface_list(...)
+  end
+
+  def interface_details(...)
+    Organizations
+      .new(self)
+      .fetch_interface_details(...)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -180,7 +180,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop/custom.yml"
-- ".rubocop_todo.yml"
 - ".standard.yml"
 - Gemfile
 - Gemfile.lock
@@ -191,9 +190,9 @@ files:
 - lib/folio_client.rb
 - lib/folio_client/authenticator.rb
 - lib/folio_client/data_import.rb
-- lib/folio_client/holdings.rb
 - lib/folio_client/inventory.rb
 - lib/folio_client/job_status.rb
+- lib/folio_client/organizations.rb
 - lib/folio_client/records_editor.rb
 - lib/folio_client/source_storage.rb
 - lib/folio_client/token_wrapper.rb
@@ -221,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.5
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.

data/.rubocop_todo.yml

@@ -1,7 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2023-03-03 17:57:09 UTC using RuboCop version 1.44.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.

data/lib/folio_client/holdings.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-class FolioClient
-  # Manage holdings records in the Folio inventory
-  class Holdings
-    attr_accessor :client, :instance_id
-
-    # @param client [FolioClient] the configured client
-    # @param instance_id [String] the UUID of the instance to which the holdings records belongs
-    def initialize(client, instance_id:)
-      @client = client
-      @instance_id = instance_id
-    end
-
-    # @param permanent_location_id [String] the UUID of the permanent location
-    # @param holdings_type_id [String] the UUID of the holdings type
-    def create(holdings_type_id:, permanent_location_id:)
-      client.post("/holdings-storage/holdings", {
-        instanceId: instance_id,
-        permanentLocationId: permanent_location_id,
-        holdingsTypeId: holdings_type_id
-      })
-    end
-  end
-end