folio_client 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7918be772bc1758840166cbb6f0fb66bfbf4765f636118d971efef2192a947df
-  data.tar.gz: 86d3c7e5656e849cf3358ddf7e22463bd65527cedf017a9a31dfdd2606bad88a
+  metadata.gz: 52b3024a210528d439f1d65a9e8a0b62b1b5359d0ae639612f46b7f2808759e2
+  data.tar.gz: 168ccfccfa8155171bd0ccba099ad91bd16533ea148b87867f6df3fd3aa617fb
 SHA512:
-  metadata.gz: 9471247fec95c9df775cd359896c788d124173477b74f1124d41641f76e6d61438fe7b5e7c10fb3ee7d6efb9f5dba11c9b0b7b45fb9040520f6668cba626fc1d
-  data.tar.gz: 4f0adf00bb277b709a68552e7f2b5119e7b8597723ffc3c4f500d850e2c8470df0249a19e35a98bcfcf2ef6daa3befb8155e57d5f69c8d825fe3b1806cd240a5
+  metadata.gz: 618c561b2f7f69baa03733e9a4f1cca3cf50e3d2bdc98924a9d759639634e98fc2f27f8868c8876eab034da6963976d58e54d396f39379f9e9223a762584490a
+  data.tar.gz: f0ddf15d1b38e14f3e8b506fbf6aa6249b05c77c35192c7a0315307e6ffe48c586ed66863f200279360217f8edc15f705c8d83b0d7c0c710a1ab9b047ec35f6f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.12.0)
+    folio_client (0.14.0)
       activesupport (>= 4.2, < 8)
       dry-monads
       faraday
@@ -11,21 +11,30 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.1.1)
+    bigdecimal (3.1.4)
     byebug (11.1.3)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
+    drb (2.1.1)
+      ruby2_keywords
     dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
@@ -49,15 +58,16 @@ GEM
       scrub_rb (>= 1.0.1, < 2)
       unf
     minitest (5.20.0)
+    mutex_m (0.1.2)
     parallel (1.23.0)
-    parser (3.2.2.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
     public_suffix (5.0.3)
-    racc (1.7.1)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -72,7 +82,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.56.3)
+    rubocop (1.56.4)
       base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -84,17 +94,17 @@ GEM
       rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
     rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.24.0)
-      rubocop (~> 1.33)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
@@ -106,29 +116,29 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.31.1)
+    standard (1.31.2)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.56.2)
+      rubocop (~> 1.56.4)
       standard-custom (~> 1.0.0)
       standard-performance (~> 1.2)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.2.0)
+    standard-performance (1.2.1)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.19.0)
+      rubocop-performance (~> 1.19.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
     webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.11)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   x86_64-darwin-19

data/README.md

@@ -123,6 +123,47 @@ client.interface_details(id: 'c6f7470e-6229-45ce-b3f9-32006e9affcf')
     "createdByUserId"=>"38524916-598d-4edf-a2ef-04bba7e78ad6",
     "updatedDate"=>"2023-02-16T22:27:51.515+00:00",
     "updatedByUserId"=>"38524916-598d-4edf-a2ef-04bba7e78ad6"}}
+
+# Get list of users (filtered with an optional query)
+# see https://s3.amazonaws.com/foliodocs/api/mod-users/r/users.html#users_get
+client.users(query: 'username=="test*"')
+=> {"users"=>
+  [{"username"=>"testing",
+    "id"=>"bbbadd51-c2f1-4107-a54d-52b39087725c",
+    "externalSystemId"=>"00324439",
+    "barcode"=>"2559202566",
+    "active"=>false,
+    "departments"=>[],
+    "proxyFor"=>[],
+    "personal"=>
+     {"lastName"=>"Testing",
+      "firstName"=>"Test",
+      "email"=>"foliotesting@lists.stanford.edu",
+      "addresses"=>
+       [{"countryId"=>"US",
+         "addressLine1"=>"13 Fake St",
+         "city"=>"Palo Alto",
+         "region"=>"California",
+         "postalCode"=>"94301",
+         "addressTypeId"=>"93d3d88d-499b-45d0-9bc7-ac73c3a19880",
+         "primaryAddress"=>true}]},
+    "createdDate"=>"2023-10-01T08:50:37.203+00:00",
+    "updatedDate"=>"2023-10-01T08:50:37.203+00:00",
+    "metadata"=>
+     {"createdDate"=>"2023-09-02T02:51:43.448+00:00",
+      "createdByUserId"=>"58d0aaf6-dcda-4d5e-92da-012e6b7dd766",
+      "updatedDate"=>"2023-10-01T08:50:37.196+00:00",
+      "updatedByUserId"=>"58d0aaf6-dcda-4d5e-92da-012e6b7dd766"},
+    "customFields"=>{"affiliation"=>"affiliate:sponsored"}}],
+ "totalRecords"=>1,
+ "resultInfo"=>{"totalRecords"=>1, "facets"=>[], "diagnostics"=>[]}}
+
+# Get specific user info
+# see https://s3.amazonaws.com/foliodocs/api/mod-users/r/users.html#users_get
+client.user_details(id: 'bbbadd51-c2f1-4107-a54d-52b39087725c')
+=> {"username"=>"testing",
+    "id"=>"bbbadd51-c2f1-4107-a54d-52b39087725c",
+    "externalSystemId"=>"00324439", ... # same response as above, but for single user
 ```
 
 ## Development
@@ -131,6 +172,22 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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`, 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).
 
+## Integration Testing
+
+To test that the gem works against the Folio APIs, run `api_test.rb` via:
+
+```shell
+# NOTE: This is bash syntax, YMMV
+$ export OKAPI_PASSWORD=$(vault kv get --field=content puppet/application/folio/stage/app_sdr_password)
+$ export OKAPI_TENANT=sul
+$ export OKAPI_USER=app_sdr
+$ export OKAPI_URL=https://okapi-stage.stanford.edu
+# NOTE: The args below are a list of MARC files
+$ bundle exec ruby ./api_test.rb /path/to/marc/files/test.mrc /another/marc/file/at/foobar.marc
+```
+
+Inspect the output and make sure there are no errors.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/folio_client.

data/api_test.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "folio_client"
+
+marc_files = *ARGV
+
+client =
+  FolioClient.configure(
+    url: ENV["OKAPI_URL"],
+    login_params: {
+      username: ENV["OKAPI_USER"],
+      password: ENV["OKAPI_PASSWORD"]
+    },
+    okapi_headers: {
+      "X-Okapi-Tenant": ENV["OKAPI_TENANT"],
+      "User-Agent": "folio_client gem (testing)"
+    }
+  )
+
+pp(client.fetch_marc_hash(instance_hrid: "a666"))
+
+puts client.fetch_marc_xml(instance_hrid: "a666")
+puts client.fetch_marc_xml(barcode: "20503330279")
+
+puts client.users(query: 'username=="pet*"')
+
+records = marc_files.flat_map do |marc_file_path|
+  MARC::Reader.new(marc_file_path).to_a
+end
+
+data_importer =
+  client.data_import(
+    records: records,
+    job_profile_id: "e34d7b92-9b83-11eb-a8b3-0242ac130003",
+    job_profile_name: "Default - Create instance and SRS MARC Bib"
+  )
+
+puts data_importer.wait_until_complete
+puts data_importer.instance_hrids

data/lib/folio_client/data_import.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "date"
-require "marc"
 require "stringio"
 
 class FolioClient

data/lib/folio_client/source_storage.rb

@@ -3,6 +3,8 @@
 class FolioClient
   # Lookup records in Folio Source Storage
   class SourceStorage
+    FIELDS_TO_REMOVE = %w[001 003].freeze
+
     attr_accessor :client
 
     # @param client [FolioClient] the configured client
@@ -24,5 +26,36 @@ class FolioClient
 
       response_hash["sourceRecords"].first["parsedRecord"]["content"]
     end
+
+    # get marc bib data as MARCXML from folio given an instance HRID
+    # @param instance_hrid [String] the instance HRID to use for MARC lookup
+    # @param barcode [String] the barcode to use for MARC lookup
+    # @return [String] MARCXML string
+    # @raise [ResourceNotFound]
+    # @raise [MultipleResourcesFound]
+    def fetch_marc_xml(instance_hrid: nil, barcode: nil)
+      raise ArgumentError, "Either a barcode or a Folio instance HRID must be provided" if barcode.nil? && instance_hrid.nil?
+
+      instance_hrid ||= client.fetch_hrid(barcode: barcode)
+
+      raise ResourceNotFound, "Catalog record not found. HRID: #{instance_hrid} | Barcode: #{barcode}" if instance_hrid.blank?
+
+      marc_record = MARC::Record.new_from_hash(
+        fetch_marc_hash(instance_hrid: instance_hrid)
+      )
+      updated_marc = MARC::Record.new
+      updated_marc.leader = marc_record.leader
+      marc_record.fields.each do |field|
+        # explicitly remove all listed tags from the record
+        next if FIELDS_TO_REMOVE.include?(field.tag)
+
+        updated_marc.fields << field
+      end
+      # explicitly inject the instance_hrid into the 001 field
+      updated_marc.fields << MARC::ControlField.new("001", instance_hrid)
+      # explicitly inject FOLIO into the 003 field
+      updated_marc.fields << MARC::ControlField.new("003", "FOLIO")
+      updated_marc.to_xml.to_s
+    end
   end
 end

data/lib/folio_client/users.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class FolioClient
+  # Query user records in Folio; see
+  # https://s3.amazonaws.com/foliodocs/api/mod-users/r/users.html
+  class Users
+    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 users 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("/users", params)
+    end
+
+    # @param id [String] id for requested user
+    # @param lang [String] language code for returned results (defaults to 'en')
+    def fetch_user_details(id:, lang: "en")
+      client.get("/users/#{id}", {
+        lang: lang
+      })
+    end
+  end
+end

data/lib/folio_client/version.rb

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

data/lib/folio_client.rb

@@ -3,8 +3,9 @@
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/object/blank"
 require "faraday"
-require "singleton"
+require "marc"
 require "ostruct"
+require "singleton"
 require "zeitwerk"
 
 # Load the gem's internal dependencies: use Zeitwerk instead of needing to manually require classes
@@ -72,10 +73,11 @@ class FolioClient
 
     delegate :config, :connection, :data_import, :default_timeout,
       :edit_marc_json, :fetch_external_id, :fetch_hrid, :fetch_instance_info,
-      :fetch_marc_hash, :get, :has_instance_status?, :http_get_headers,
-      :http_post_and_put_headers, :interface_details, :job_profiles,
-      :organization_interfaces, :organizations, :post, :put, to: :instance
-  end
+      :fetch_marc_hash, :fetch_marc_xml, :get, :has_instance_status?,
+      :http_get_headers, :http_post_and_put_headers, :interface_details,
+      :job_profiles, :organization_interfaces, :organizations, :users, :user_details,
+      :post, :put, to:
+      :instance end
 
   attr_accessor :config
 
@@ -175,6 +177,13 @@ class FolioClient
       .fetch_marc_hash(...)
   end
 
+  # @see SourceStorage#fetch_marc_xml
+  def fetch_marc_xml(...)
+    SourceStorage
+      .new(self)
+      .fetch_marc_xml(...)
+  end
+
   # @see Inventory#has_instance_status?
   def has_instance_status?(...)
     Inventory
@@ -224,6 +233,20 @@ class FolioClient
       .fetch_interface_details(...)
   end
 
+  # @see Users#fetch_list
+  def users(...)
+    Users
+      .new(self)
+      .fetch_list(...)
+  end
+
+  # @see Users#fetch_user_details
+  def user_details(...)
+    Users
+      .new(self)
+      .fetch_user_details(...)
+  end
+
   def default_timeout
     120
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-22 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -187,6 +187,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- api_test.rb
 - folio_client.gemspec
 - lib/folio_client.rb
 - lib/folio_client/authenticator.rb
@@ -197,6 +198,7 @@ files:
 - lib/folio_client/records_editor.rb
 - lib/folio_client/source_storage.rb
 - lib/folio_client/unexpected_response.rb
+- lib/folio_client/users.rb
 - lib/folio_client/version.rb
 homepage: https://github.com/sul-dlss/folio_client
 licenses: []
@@ -220,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.