folio_client 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3b597d27e912d256a895af940e312d24e85acf5c234f48788c6716a4e8947de
-  data.tar.gz: 9700fb07ff086e5b6c833897abd921adaa8efd19e173c8948484ad5d554614a2
+  metadata.gz: d0d61214a5547fd8ff28b9e79cef6eae123bddea9b060039163a1d8d7e3a8b91
+  data.tar.gz: f343f324c6bd48998394d3bc3badeff7aa010cdafcf171d53c076df44c341756
 SHA512:
-  metadata.gz: a8256c90e8c80390e5536d4c988140d30074481d6d8b958a3e8321b81e6dc0f2f7634f3e5253abe7c9b60b22fbebb5246fe6f9052c93b658d621a108a1598ff9
-  data.tar.gz: 99e52e340c66cc0233e577e73840880c2a0f9b2eea758b42418784124a524d1c7d1fc73ede20dd8bdd77aa0d69f44843eebd0f82e08067306b687b0082dc326b
+  metadata.gz: ba5f952cf9c4449adece5c15496832bb89a73cba6fcc866e4f7024c393f22fedab0be86c4a8a394c4d893b8c9a224e38305dc79e3d0a657c76c8413658600a88
+  data.tar.gz: c747fa00a2e6f51ba219116bc197922fab303bda976fc0945d9e906d3160813206ae434c2d8c791f66c41a92781d288eaaae40401ed03db83d4eded7783d17a1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (0.13.0)
+    folio_client (0.15.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.2)
+      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)
+    base64 (0.2.0)
+    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.2.0)
+      ruby2_keywords
     dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
@@ -33,7 +42,7 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
-    faraday (2.7.11)
+    faraday (2.7.12)
       base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
@@ -49,15 +58,16 @@ GEM
       scrub_rb (>= 1.0.1, < 2)
       unf
     minitest (5.20.0)
+    mutex_m (0.2.0)
     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)
+    public_suffix (5.0.4)
+    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,19 +82,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.56.4)
-      base64 (~> 0.1.1)
+    rubocop (1.57.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       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.19.0)
       rubocop (~> 1.41)
@@ -93,8 +102,8 @@ GEM
     rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.24.1)
-      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,23 +115,23 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.31.1)
+    standard (1.32.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.56.2)
+      rubocop (~> 1.57.2)
       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)
+    unf_ext (0.0.9.1)
     unicode-display_width (2.5.0)
     webmock (3.19.1)
       addressable (>= 2.8.0)

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

data/api_test.rb

@@ -23,6 +23,8 @@ 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/lib/folio_client/job_status.rb

@@ -35,8 +35,8 @@ class FolioClient
       Failure(:not_found)
     end
 
-    def wait_until_complete(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs)
-      wait_with_timeout(wait_secs: wait_secs, timeout_secs: timeout_secs) { status }
+    def wait_until_complete(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs, max_checks: default_max_checks)
+      wait_with_timeout(wait_secs: wait_secs, timeout_secs: timeout_secs, max_checks: max_checks) { status }
     end
 
     def instance_hrids
@@ -66,13 +66,18 @@ class FolioClient
       10 * 60
     end
 
-    def wait_with_timeout(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs)
+    def default_max_checks
+      # arbitrary best guess at number of times to check for job status before erroring
+      10
+    end
+
+    def wait_with_timeout(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs, max_checks: default_max_checks)
       Timeout.timeout(timeout_secs) do
         loop.with_index do |_, i|
           result = yield
 
           # If a 404, wait a bit longer before raising an error.
-          check_not_found(result, i)
+          check_not_found(result, i, max_checks)
           return result if done_waiting?(result)
 
           sleep(wait_secs)
@@ -86,10 +91,10 @@ class FolioClient
       result.success? || (result.failure? && result.failure == :error)
     end
 
-    def check_not_found(result, index)
-      return unless result.failure? && result.failure == :not_found && index > 2
+    def check_not_found(result, index, max_checks)
+      return unless result.failure? && result.failure == :not_found && index > max_checks
 
-      raise ResourceNotFound, "Job #{job_execution_id} not found after #{index} retries"
+      raise ResourceNotFound, "Job #{job_execution_id} not found after #{index} retries. The data import job may still have completed."
     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.13.0"
+  VERSION = "0.15.0"
 end

data/lib/folio_client.rb

@@ -75,7 +75,8 @@ class FolioClient
       :edit_marc_json, :fetch_external_id, :fetch_hrid, :fetch_instance_info,
       :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, :post, :put, to:
+      :job_profiles, :organization_interfaces, :organizations, :users, :user_details,
+      :post, :put, to:
       :instance end
 
   attr_accessor :config
@@ -232,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.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Peter Mangiafico
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2023-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -198,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: []
@@ -221,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.