folio_client 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f400cbad25cc1f7a7a4af985a510c597af5dea7b18cf636d5e6cb8196b4ef059
-  data.tar.gz: 26d9485bebd8780fafe498b15827575703316c229ed8c35e361aee3246ee70fd
+  metadata.gz: ad8e1c9733f1bba9dc63d5f8c19edb7f4b40a7c16084c3f434175582d466d70a
+  data.tar.gz: 32beb6817690d4e95a7ce741fbde1466ccc75b7a13489230b0f1d859af6b7baa
 SHA512:
-  metadata.gz: 472ca9f6c928aa3353b8f928cce63030329e62a7c26655700aaaef6c835e777f58d0771c8b58d8bfd50ee59a7c2c1724063246884ab529556b7cd92ee2065dfd
-  data.tar.gz: 2add95c0f3492db0c80f1770c40576d7bbac019a31674a9b0124a47706b065e1b02e67735519dddc2cf4f832216d453ddb3126906a4c89f4d4eac1f59c70fd6d
+  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.9.0)
+    folio_client (0.10.0)
       activesupport (>= 4.2, < 8)
       dry-monads
       faraday
@@ -77,7 +77,7 @@ GEM
       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)
@@ -96,10 +96,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.25.2)
+    standard (1.25.3)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.48.1)
-      rubocop-performance (= 1.16.0)
+      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
@@ -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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioClient
-  VERSION = "0.9.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.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Peter Mangiafico
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-22 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
@@ -206,7 +205,7 @@ metadata:
   source_code_uri: https://github.com/sul-dlss/folio_client
   changelog_uri: https://github.com/sul-dlss/folio_client/releases
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,8 +220,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.5
+signing_key:
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.
 test_files: []

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,26 +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 record belongs
-    def initialize(client, instance_id:)
-      @client = client
-      @instance_id = instance_id
-    end
-
-    # create a holdings record for the instance
-    # @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