globus_client 0.12.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65d27626412e2eff8ff6514be3ece81fd5f27e471137fcfd8409e51cd6e0f105
-  data.tar.gz: 321b1d89734daacb8ad54487836a68f1fdf1af931fad426d72ec35bc2f355ec8
+  metadata.gz: bae9be2599dca47133561cc9f50d02118d633e973f973619bf642a890d266d7d
+  data.tar.gz: 032a19fb8edf3b11740dd487415a98f14522daac3ae4966302376b902c787e01
 SHA512:
-  metadata.gz: a4ce82aac85e8c00df5310cdb3b4f821cd1415ee0d525938562b20d97c86f330707691a8ee69dcbfeee53d0e20064f78fd902678d5aa4a0113cc7ce38f209c9a
-  data.tar.gz: 75888830f1b0660f78d551eb3fd2a323f40fb21e5ac9a361c0f8ea22be0b32a11a014dd42719e4b25c33f5f497e2d1b6b296c8db15f5dc89abaed5d4f03ff5e1
+  metadata.gz: f66705c5adbda9f69f8ab99b8c02ad8b16dafcf4760b0918f63191874066691c1c46211588a197629206f6e53f72b1893748bcac04594db44afeaa1f3a40706a
+  data.tar.gz: f901d249a7b112efb537e88387aa6833759f2ec6f801277d4970a0830d7761abfe64e8a4163337ce252e2b9beb4e46410757832ecc300f649d8e21a5a6381669

data/.rubocop.yml

@@ -1,18 +1,27 @@
-inherit_mode:
-  merge:
-    - Exclude
+inherit_from: .rubocop_todo.yml
 
 require:
-  - standard
-  - standard-custom
-  - standard-performance
   - rubocop-performance
   - rubocop-rspec
 
-inherit_gem:
-  standard: config/base.yml
-  standard-performance: config/base.yml
-  standard-custom: config/base.yml
+AllCops:
+  TargetRubyVersion: 3.1
+  DisplayCopNames: true
+  SuggestExtensions: false
+  NewCops: disable
+  Exclude:
+    - bin/**
+    - vendor/bundle/**/*
 
-inherit_from:
-  - .rubocop/custom.yml
+# Per team developer playbook
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+# Layout
+Layout/LineLength:
+  Max: 150
+
+# Naming
+Naming/PredicateName:
+  NamePrefix:
+    - has

data/.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude`
+# on 2023-09-29 23:59:42 UTC using RuboCop version 1.56.3.
+# 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.
+
+# Offense count: 1
+Lint/StructNewOverride:
+  Exclude:
+    - 'lib/globus_client/endpoint.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/globus_client.rb'
+    - 'lib/globus_client/endpoint.rb'
+    - 'lib/globus_client/unexpected_response.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/globus_client/endpoint.rb'
+
+# Offense count: 3
+# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/globus_client/endpoint.rb'
+    - 'lib/globus_client/unexpected_response.rb'

data/Gemfile

@@ -1,8 +1,16 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in globus_client.gemspec
 gemspec
 
-gem "byebug"
+group :deployment do
+  gem 'byebug'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
+  gem 'simplecov'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.12.1)
+    globus_client (0.14.0)
       activesupport (>= 4.2, < 8)
       faraday
       faraday-retry
@@ -10,21 +10,30 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8)
+    activesupport (7.1.0)
+      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
     faraday (2.7.11)
       base64
       faraday-net_http (>= 2.0, < 3.1)
@@ -37,10 +46,10 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
     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)
@@ -62,7 +71,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)
@@ -76,14 +85,14 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.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-rspec (2.24.1)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
@@ -95,26 +104,14 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.31.1)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.56.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)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.19.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    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
@@ -128,9 +125,9 @@ DEPENDENCIES
   globus_client!
   rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop-performance
   rubocop-rspec
   simplecov
-  standard
   webmock
 
 BUNDLED WITH

data/Rakefile

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new

data/api_test.rb

@@ -1,40 +1,41 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "benchmark"
-require "bundler/setup"
-require "globus_client"
+require 'benchmark'
+require 'bundler/setup'
+require 'globus_client'
 
-Benchmark.bm(20) do |benchmark|
+Benchmark.bm(20) do |benchmark| # rubocop:disable Metrics/BlockLength
   user_id, path = *ARGV
 
-  benchmark.report("Configure:") do
+  benchmark.report('Configure:') do
     GlobusClient.configure(
-      client_id: ENV["GLOBUS_CLIENT_ID"],
-      client_secret: ENV["GLOBUS_CLIENT_SECRET"],
-      uploads_directory: ENV["GLOBUS_UPLOADS_DIRECTORY"],
-      transfer_endpoint_id: ENV["GLOBUS_ENDPOINT"]
+      client_id: ENV.fetch('GLOBUS_CLIENT_ID', nil),
+      client_secret: ENV.fetch('GLOBUS_CLIENT_SECRET', nil),
+      uploads_directory: ENV.fetch('GLOBUS_UPLOADS_DIRECTORY', nil),
+      transfer_endpoint_id: ENV.fetch('GLOBUS_ENDPOINT', nil)
     )
   end
 
-  benchmark.report("mkdir:") do
+  benchmark.report('mkdir:') do
     GlobusClient.mkdir(user_id:, path:)
   end
 
-  benchmark.report("user_valid?:") do
+  benchmark.report('user_valid?:') do
     @user_exists = GlobusClient.user_valid?(user_id)
   end
 
-  benchmark.report("before_perms:") do
+  benchmark.report('before_perms:') do
     # Not part of the public API but this allows us to test access changes
-    @before_permissions = GlobusClient::Endpoint.new(GlobusClient.config, user_id:, path:).send(:access_rule)["permissions"]
+    @before_permissions = GlobusClient::Endpoint.new(GlobusClient.instance, user_id:,
+                                                                            path:).send(:access_rule)['permissions']
   end
 
-  benchmark.report("has_files?:") do
+  benchmark.report('has_files?:') do
     @has_files = GlobusClient.has_files?(user_id:, path:)
   end
 
-  benchmark.report("list_files:") do
+  benchmark.report('list_files:') do
     GlobusClient.list_files(user_id:, path:) do |files|
       @files_count = files.count
       @total_size = files.sum(&:size)
@@ -42,13 +43,14 @@ Benchmark.bm(20) do |benchmark|
     end
   end
 
-  benchmark.report("disallow_writes:") do
+  benchmark.report('disallow_writes:') do
     GlobusClient.disallow_writes(user_id:, path:)
   end
 
-  benchmark.report("after_perms:") do
+  benchmark.report('after_perms:') do
     # Not part of the public API but this allows us to test access changes
-    @after_permissions = GlobusClient::Endpoint.new(GlobusClient.config, user_id:, path:).send(:access_rule)["permissions"]
+    @after_permissions = GlobusClient::Endpoint.new(GlobusClient.instance, user_id:,
+                                                                           path:).send(:access_rule)['permissions']
   end
 
   puts "User #{user_id} exists: #{@user_exists}"

data/globus_client.gemspec

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "globus_client/version"
+require 'globus_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "globus_client"
+  spec.name = 'globus_client'
   spec.version = GlobusClient::VERSION
-  spec.authors = ["Aaron Collier", "Laura Wrubel", "Mike Giarlo"]
-  spec.email = ["aaron.collier@stanford.edu", "lwrubel@stanford.edu", "mjgiarlo@stanford.edu"]
+  spec.authors = ['Aaron Collier', 'Laura Wrubel', 'Mike Giarlo']
+  spec.email = ['aaron.collier@stanford.edu', 'lwrubel@stanford.edu', 'mjgiarlo@stanford.edu']
 
-  spec.summary = "Interface for interacting with the Globus API."
-  spec.description = "This provides API interaction with the Globus API"
-  spec.homepage = "https://github.com/sul-dlss/globus_client"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = 'Interface for interacting with the Globus API.'
+  spec.description = 'This provides API interaction with the Globus API'
+  spec.homepage = 'https://github.com/sul-dlss/globus_client'
+  spec.required_ruby_version = '>= 3.1.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/sul-dlss/globus_client"
-  spec.metadata["changelog_uri"] = "https://github.com/sul-dlss/globus_client/releases"
-  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sul-dlss/globus_client'
+  spec.metadata['changelog_uri'] = 'https://github.com/sul-dlss/globus_client/releases'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,19 +27,12 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "activesupport", ">= 4.2", "< 8"
-  spec.add_dependency "faraday"
-  spec.add_dependency "faraday-retry"
-  spec.add_dependency "zeitwerk"
-
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "standard"
-  spec.add_development_dependency "rubocop-rspec"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "webmock"
+  spec.add_dependency 'activesupport', '>= 4.2', '< 8'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday-retry'
+  spec.add_dependency 'zeitwerk'
 end

data/lib/globus_client/authenticator.rb

@@ -15,9 +15,11 @@ class GlobusClient
 
     # Request an access_token
     def token
-      response = connection.post("/v2/oauth2/token", form_data)
+      response = connection.post('/v2/oauth2/token', form_data)
 
-      JSON.parse(response.body)["access_token"]
+      UnexpectedResponse.call(response) unless response.success?
+
+      JSON.parse(response.body)['access_token']
     end
 
     private
@@ -32,9 +34,9 @@ class GlobusClient
       {
         client_id:,
         client_secret:,
-        encoding: "form",
-        grant_type: "client_credentials",
-        scope: "urn:globus:auth:scope:transfer.api.globus.org:all"
+        encoding: 'form',
+        grant_type: 'client_credentials',
+        scope: 'urn:globus:auth:scope:transfer.api.globus.org:all'
       }
     end
   end

data/lib/globus_client/endpoint.rb

@@ -2,18 +2,20 @@
 
 class GlobusClient
   # The namespace for endpoint API operations
-  class Endpoint
-    PATH_SEPARATOR = "/"
+  class Endpoint # rubocop:disable Metrics/ClassLength
+    PATH_SEPARATOR = '/'
 
     FileInfo = Struct.new(:name, :size)
 
-    # @param config [#token, #uploads_directory, #transfer_endpoint_id, #transfer_url, #auth_url] configuration for the gem
+    # @param client [GlobusClient] a configured instance of the GlobusClient
     # @param path [String] the path to operate on
     # @param user_id [String] a Globus user ID (e.g., a @stanford.edu email address)
-    def initialize(config, path:, user_id:)
-      @config = config
+    # @param notify_email [Boolean] indicates if we should ask Globus to send emails on access change (default: true)
+    def initialize(client, path:, user_id:, notify_email: true)
+      @client = client
       @user_id = user_id
       @path = path
+      @notify_email = notify_email
     end
 
     def has_files?
@@ -30,69 +32,43 @@ class GlobusClient
     def mkdir
       # transfer API does not support recursive directory creation
       paths.each do |path|
-        response = connection.post("#{transfer_path}/mkdir") do |req|
-          req.headers["Content-Type"] = "application/json"
-          req.body = {
-            DATA_TYPE: "mkdir",
-            path:
-          }.to_json
-        end
-
-        next if response.success?
-
-        # Ignore error if directory already exists
-        if response.status == 502
-          error = JSON.parse(response.body)
-          next if error["code"] == "ExternalError.MkdirFailed.Exists"
-        end
-
-        UnexpectedResponse.call(response)
+        client.post(
+          base_url: client.config.transfer_url,
+          path: "#{transfer_path}/mkdir",
+          body: { DATA_TYPE: 'mkdir', path: },
+          expected_response: lambda { |resp|
+                               resp.status == 502 && JSON.parse(resp.body)['code'] == 'ExternalError.MkdirFailed.Exists'
+                             }
+        )
       end
     end
 
     # Assign a user read/write permissions for a directory https://docs.globus.org/api/transfer/acl/#rest_access_create
     def allow_writes
-      access_request(permissions: "rw")
+      access_request(permissions: 'rw')
     end
 
     # Assign a user read-only permissions for a directory https://docs.globus.org/api/transfer/acl/#rest_access_create
     def disallow_writes
-      update_access_request(permissions: "r")
+      update_access_request(permissions: 'r')
     end
 
     # Delete the access rule https://docs.globus.org/api/transfer/acl/#delete_access_rule
     def delete_access_rule
-      raise(StandardError, "Access rule not found for #{path}") if !access_rule_id
+      raise(StandardError, "Access rule not found for #{path}") unless access_rule_id
 
-      response = connection.delete("#{access_path}/#{access_rule_id}")
-      return true if response.success?
-
-      UnexpectedResponse.call(response)
+      client.delete(
+        base_url: client.config.transfer_url,
+        path: "#{access_path}/#{access_rule_id}"
+      )
     end
 
     private
 
-    attr_reader :config, :path, :user_id
-
-    def connection
-      # faraday/retry is used here to catch Faraday::ConnectionFailed exceptions
-      # see: https://github.com/sul-dlss/happy-heron/issues/3008
-      @connection ||= Faraday.new(
-        url: config.transfer_url,
-        headers: {Authorization: "Bearer #{config.token}"}
-      ) do |faraday|
-        faraday.request :retry, {
-          max: 10,
-          interval: 0.05,
-          interval_randomness: 0.5,
-          backoff_factor: 2,
-          exceptions: Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
-        }
-      end
-    end
+    attr_reader :client, :path, :user_id, :notify_email
 
     def globus_identity_id
-      Identity.new(config).get_identity_id(user_id)
+      Identity.new(client).get_identity_id(user_id)
     end
 
     # Builds up a path from a list of path elements. E.g., input would look like:
@@ -102,7 +78,7 @@ class GlobusClient
     def paths
       @paths ||= path_segments.map.with_index do |_segment, index|
         File
-          .join(config.uploads_directory, path_segments.slice(..index))
+          .join(client.config.uploads_directory, path_segments.slice(..index))
           .concat(PATH_SEPARATOR)
       end
     end
@@ -123,24 +99,27 @@ class GlobusClient
     # @param files [Array<FileInfo>] an array of FileInfo structs, each of which has a name and a size
     # @param return_presence [Boolean] if true, return a boolean to indicate if any files at all are present, short-circuiting the recursive operation
     def ls_path(filepath, files, return_presence: false)
-      response = connection.get("#{transfer_path}/ls?path=#{CGI.escape(filepath)}")
-      return UnexpectedResponse.call(response) unless response.success?
-
-      data = JSON.parse(response.body)["DATA"]
-      data
-        .select { |object| object["type"] == "file" }
+      response = client.get(
+        base_url: client.config.transfer_url,
+        path: "#{transfer_path}/ls",
+        params: { path: filepath }
+      )
+
+      response['DATA']
+        .select { |object| object['type'] == 'file' }
         .each do |file|
         return true if return_presence
 
-        files << FileInfo.new("#{filepath}#{file["name"]}", file["size"])
+        files << FileInfo.new("#{filepath}#{file['name']}", file['size'])
       end
-      data
-        .select { |object| object["type"] == "dir" }
+
+      response['DATA']
+        .select { |object| object['type'] == 'dir' }
         .each do |dir|
         # NOTE: This allows the recursive method to short-circuit iff ls_path
         #       returns true, which only happens when return_presence is true
         #       and the first file is found in the ls operation.
-        return true if ls_path("#{filepath}#{dir["name"]}/", files, return_presence:) == true
+        return true if ls_path("#{filepath}#{dir['name']}/", files, return_presence:) == true
       end
 
       return false if return_presence
@@ -149,78 +128,62 @@ class GlobusClient
     end
 
     def access_request(permissions:)
-      response = if access_rule_id
-        connection.put("#{access_path}/#{access_rule_id}") do |req|
-          req.body = {
-            DATA_TYPE: "access",
-            permissions:
-          }.to_json
-          req.headers["Content-Type"] = "application/json"
-        end
+      if access_rule_id
+        update_access_request(permissions:)
       else
-        connection.post(access_path) do |req|
-          req.body = {
-            DATA_TYPE: "access",
-            principal_type: "identity",
-            principal: globus_identity_id,
-            path: full_path,
-            permissions:,
-            notify_email: user_id
-          }.to_json
-          req.headers["Content-Type"] = "application/json"
-        end
+        body = {
+          DATA_TYPE: 'access',
+          principal_type: 'identity',
+          principal: globus_identity_id,
+          path: full_path,
+          permissions:
+        }
+        body[:notify_email] = user_id if notify_email
+        client.post(
+          base_url: client.config.transfer_url,
+          path: access_path,
+          body:
+        )
       end
-
-      return true if response.success?
-
-      UnexpectedResponse.call(response)
     end
 
     def update_access_request(permissions:)
-      raise(StandardError, "Access rule not found for #{path}") if !access_rule_id
+      raise(StandardError, "Access rule not found for #{path}") unless access_rule_id
 
-      response = connection.put("#{access_path}/#{access_rule_id}") do |req|
-        req.body = {
-          DATA_TYPE: "access",
+      client.put(
+        base_url: client.config.transfer_url,
+        path: "#{access_path}/#{access_rule_id}",
+        body: {
+          DATA_TYPE: 'access',
           permissions:
-        }.to_json
-        req.headers["Content-Type"] = "application/json"
-      end
-
-      return true if response.success?
-
-      UnexpectedResponse.call(response)
+        }
+      )
     end
 
     def access_rule
-      response = connection.get(access_list_path) do |req|
-        req.headers["Content-Type"] = "application/json"
-      end
-
-      # debugging of Globus responses
-      response_body = JSON.parse(response.body)
-
-      UnexpectedResponse.call(response, message: "Response is missing DATA in: #{response_body}") unless response.success? && response_body.key?("DATA")
+      response = client.get(
+        base_url: client.config.transfer_url,
+        path: access_list_path,
+        content_type: 'application/json'
+      )
 
-      JSON
-        .parse(response.body)["DATA"]
-        .find { |acl| acl["path"] == full_path }
+      response.fetch('DATA').find { |acl| acl['path'] == full_path }
     end
 
     def access_rule_id
-      access_rule&.fetch("id")
+      access_rule&.fetch('id')
     end
 
     def transfer_path
-      "/v0.10/operation/endpoint/#{config.transfer_endpoint_id}"
+      "/v0.10/operation/endpoint/#{client.config.transfer_endpoint_id}"
     end
 
     def access_path
-      "/v0.10/endpoint/#{config.transfer_endpoint_id}/access"
+      "/v0.10/endpoint/#{client.config.transfer_endpoint_id}/access"
     end
 
     def access_list_path
-      "/v0.10/endpoint/#{config.transfer_endpoint_id}/access_list"
+      "/v0.10/endpoint/#{client.config.transfer_endpoint_id}/access_list"
     end
   end
 end

data/lib/globus_client/identity.rb

@@ -3,52 +3,36 @@
 class GlobusClient
   # Lookup of a Globus identity ID
   class Identity
-    def initialize(config)
-      @config = config
+    def initialize(client)
+      @client = client
     end
 
     # @param user_id [String] the username in the form of an email addresss
     # @return [Hash] id and status of Globus identity
     def get_identity(user_id)
-      @email = user_id
-      response = lookup_identity
-      UnexpectedResponse.call(response) unless response.success?
+      response = client.get(
+        base_url: client.config.auth_url,
+        path: '/v2/api/identities',
+        params: { usernames: user_id }
+      )
 
-      data = JSON.parse(response.body)
-      extract_id(data)
+      response['identities'].find { |id| id['username'] == user_id }
     end
 
     # @param user_id [String] the username in the form of an email addresss
     # @return [Boolean] whether the account has a valid status
     def valid?(user_id)
-      ["used", "private", "unused"].include?(get_identity(user_id)["status"])
+      %w[used private unused].include?(get_identity(user_id)['status'])
     end
 
     # @param user_id [String] the username in the form of an email addresss
     # @return [String] UUID for Globus identity
     def get_identity_id(user_id)
-      get_identity(user_id)["id"]
+      get_identity(user_id)['id']
     end
 
     private
 
-    attr_reader :config
-
-    def connection
-      Faraday.new(url: config.auth_url)
-    end
-
-    def lookup_identity
-      id_endpoint = "/v2/api/identities"
-      connection.get(id_endpoint) do |req|
-        req.params["usernames"] = @email
-        req.headers["Authorization"] = "Bearer #{config.token}"
-      end
-    end
-
-    def extract_id(data)
-      identities = data["identities"]
-      identities.find { |id| id["username"] == @email }
-    end
+    attr_reader :client
   end
 end

data/lib/globus_client/unexpected_response.rb

@@ -26,7 +26,7 @@ class GlobusClient
     # https://docs.globus.org/api/transfer/file_operations/#errors
     # https://docs.globus.org/api/transfer/acl/#common_errors
     # https://docs.globus.org/api/auth/reference/
-    def self.call(response, message: "")
+    def self.call(response)
       case response.status
       when 400
         raise BadRequestError, "Invalid path or another error with the request: #{response.body}"
@@ -37,11 +37,11 @@ class GlobusClient
       when 404
         raise ResourceNotFound, "Endpoint ID not found or resource does not exist: #{response.body}"
       when 502
-        raise EndpointError, "Other error with endpoint: #{response.status} #{response.body}. #{message}"
+        raise EndpointError, "Other error with endpoint: #{response.status} #{response.body}."
       when 503
-        raise ServiceUnavailable, "The service is down for maintenance."
+        raise ServiceUnavailable, 'The service is down for maintenance.'
       else
-        raise StandardError, "Unexpected response: #{response.status} #{response.body}. #{message}"
+        raise StandardError, "Unexpected response: #{response.status} #{response.body}."
       end
     end
   end

data/lib/globus_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GlobusClient
-  VERSION = "0.12.1"
+  VERSION = '0.14.0'
 end

data/lib/globus_client.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/module/delegation"
-require "faraday"
-require "faraday/retry"
-require "ostruct"
-require "singleton"
-require "zeitwerk"
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+require 'faraday'
+require 'faraday/retry'
+require 'singleton'
+require 'zeitwerk'
 
 # Load the gem's internal dependencies: use Zeitwerk instead of needing to manually require classes
 Zeitwerk::Loader.for_gem.setup
 
 # Client for interacting with the Globus API
-class GlobusClient
+class GlobusClient # rubocop:disable Metrics/ClassLength
   include Singleton
 
   class << self
@@ -21,19 +21,21 @@ class GlobusClient
     # @param transfer_endpoint_id [String] the transfer API endpoint ID supplied by Globus
     # @param transfer_url [String] the transfer API URL
     # @param auth_url [String] the authentication API URL
-    def configure(client_id:, client_secret:, uploads_directory:, transfer_endpoint_id:, transfer_url: default_transfer_url, auth_url: default_auth_url)
-      instance.config = OpenStruct.new(
+    # rubocop:disable Metrics/ParameterLists
+    def configure(client_id:, client_secret:, uploads_directory:, transfer_endpoint_id:,
+                  transfer_url: default_transfer_url, auth_url: default_auth_url)
+      instance.config = Config.new(
         # For the initial token, use a dummy value to avoid hitting any APIs
-        # during configuration, allowing the `TokenWrapper` to handle auto-magic
-        # token refreshing. Why not immediately get a valid token? Our apps
+        # during configuration, allowing `with_token_refresh_when_unauthorized` to handle
+        # auto-magic token refreshing. Why not immediately get a valid token? Our apps
         # commonly invoke client `.configure` methods in the initializer in all
         # application environments, even those that are never expected to
         # connect to production APIs, such as local development machines.
         #
         # NOTE: `nil` and blank string cannot be used as dummy values here as
         # they lead to a malformed request to be sent, which triggers an
-        # exception not rescued by `TokenWrapper`
-        token: "a temporary dummy token to avoid hitting the API before it is needed",
+        # exception not rescued by `with_token_refresh_when_unauthorized`
+        token: 'a temporary dummy token to avoid hitting the API before it is needed',
         client_id:,
         client_secret:,
         uploads_directory:,
@@ -44,85 +46,194 @@ class GlobusClient
 
       self
     end
+    # rubocop:enable Metrics/ParameterLists
 
     delegate :config, :disallow_writes, :delete_access_rule, :file_count, :list_files, :mkdir, :total_size,
-      :user_valid?, :get_filenames, :has_files?, to: :instance
+             :user_valid?, :get_filenames, :has_files?, :delete, :get, :post, :put, to: :instance
 
     def default_transfer_url
-      "https://transfer.api.globusonline.org"
+      'https://transfer.api.globusonline.org'
     end
 
     def default_auth_url
-      "https://auth.globus.org"
+      'https://auth.globus.org'
     end
   end
 
   attr_accessor :config
 
+  # Send an authenticated GET request
+  # @param base_url [String] the base URL of the Globus API
+  # @param path [String] the path to the Globus API request
+  # @param params [Hash] params to get to the API
+  def get(base_url:, path:, params: {}, content_type: nil)
+    response = with_token_refresh_when_unauthorized do
+      connection(base_url).get(path, params) do |request|
+        request.headers['Authorization'] = "Bearer #{config.token}"
+        request.headers['Content-Type'] = content_type if content_type
+      end
+    end
+
+    UnexpectedResponse.call(response) unless response.success?
+
+    return nil if response.body.blank?
+
+    JSON.parse(response.body)
+  end
+
+  # Send an authenticated POST request
+  # @param base_url [String] the base URL of the Globus API
+  # @param path [String] the path to the Globus API request
+  # @param body [String] the body of the Globus API request
+  # @param expected_response [#call] an expected response handler to allow short-circuiting the unexpected response
+  def post(base_url:, path:, body:, expected_response: ->(_resp) { false })
+    response = with_token_refresh_when_unauthorized do
+      connection(base_url).post(path) do |request|
+        request.headers['Authorization'] = "Bearer #{config.token}"
+        request.headers['Content-Type'] = 'application/json'
+        request.body = body.to_json
+      end
+    end
+
+    UnexpectedResponse.call(response) unless response.success? || expected_response.call(response)
+
+    return nil if response.body.blank?
+
+    JSON.parse(response.body)
+  end
+
+  # Send an authenticated PUT request
+  # @param base_url [String] the base URL of the Globus API
+  # @param path [String] the path to the Globus API request
+  # @param body [String] the body of the Globus API request
+  def put(base_url:, path:, body:)
+    response = with_token_refresh_when_unauthorized do
+      connection(base_url).put(path) do |request|
+        request.headers['Authorization'] = "Bearer #{config.token}"
+        request.headers['Content-Type'] = 'application/json'
+        request.body = body.to_json
+      end
+    end
+
+    UnexpectedResponse.call(response) unless response.success?
+
+    return nil if response.body.blank?
+
+    JSON.parse(response.body)
+  end
+
+  # Send an authenticated DELETE request
+  # @param base_url [String] the base URL of the Globus API
+  # @param path [String] the path to the Globus API request
+  def delete(base_url:, path:)
+    response = with_token_refresh_when_unauthorized do
+      connection(base_url).delete(path) do |request|
+        request.headers['Authorization'] = "Bearer #{config.token}"
+      end
+    end
+
+    UnexpectedResponse.call(response) unless response.success?
+
+    return nil if response.body.blank?
+
+    JSON.parse(response.body)
+  end
+
   def mkdir(...)
-    TokenWrapper.refresh(config) do
-      endpoint = Endpoint.new(config, ...)
+    Endpoint.new(self, ...).tap do |endpoint|
       endpoint.mkdir
       endpoint.allow_writes
     end
   end
 
   def disallow_writes(...)
-    TokenWrapper.refresh(config) do
-      endpoint = Endpoint.new(config, ...)
-      endpoint.disallow_writes
-    end
+    Endpoint
+      .new(self, ...)
+      .disallow_writes
   end
 
   def delete_access_rule(...)
-    TokenWrapper.refresh(config) do
-      endpoint = Endpoint.new(config, ...)
-      endpoint.delete_access_rule
-    end
+    Endpoint
+      .new(self, ...)
+      .delete_access_rule
   end
 
   # NOTE: Can't use the `...` (argument forwarding) operator here because we
   #       want to route the keyword args to `Endpoint#new` and the block arg to
   #       `Endpoint#list_files`
-  def list_files(**keywords, &block)
-    TokenWrapper.refresh(config) do
-      endpoint = Endpoint.new(config, **keywords)
-      endpoint.list_files(&block)
-    end
+  def list_files(**keywords, &)
+    Endpoint
+      .new(self, **keywords)
+      .list_files(&)
   end
 
   def file_count(...)
-    TokenWrapper.refresh(config) do
-      endpoint = Endpoint.new(config, ...)
-      endpoint.list_files { |files| return files.count }
-    end
+    Endpoint
+      .new(self, ...)
+      .list_files { |files| return files.count }
   end
 
   def total_size(...)
-    TokenWrapper.refresh(config) do
-      endpoint = Endpoint.new(config, ...)
-      endpoint.list_files { |files| return files.sum(&:size) }
-    end
+    Endpoint
+      .new(self, ...)
+      .list_files { |files| return files.sum(&:size) }
   end
 
   def get_filenames(...)
-    TokenWrapper.refresh(config) do
-      endpoint = Endpoint.new(config, ...)
-      endpoint.list_files { |files| return files.map(&:name) }
-    end
+    Endpoint
+      .new(self, ...)
+      .list_files { |files| return files.map(&:name) }
   end
 
   def has_files?(...)
-    TokenWrapper.refresh(config) do
-      endpoint = Endpoint.new(config, ...)
-      endpoint.has_files?
-    end
+    Endpoint
+      .new(self, ...)
+      .has_files?
   end
 
   def user_valid?(...)
-    TokenWrapper.refresh(config) do
-      identity = Identity.new(config)
-      identity.valid?(...)
+    Identity
+      .new(self)
+      .valid?(...)
+  end
+
+  private
+
+  Config = Struct.new(:client_id, :auth_url, :client_secret, :transfer_endpoint_id, :transfer_url, :uploads_directory, :token, keyword_init: true)
+
+  def connection(base_url)
+    Faraday.new(url: base_url) do |conn|
+      conn.request :retry, {
+        max: 10,
+        interval: 0.05,
+        interval_randomness: 0.5,
+        backoff_factor: 2,
+        exceptions: Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
+      }
     end
   end
+
+  # Wraps API operations to request new access token if expired.
+  # @yieldreturn response [Faraday::Response] the response to inspect
+  #
+  # @note You likely want to make sure you're wrapping a _single_ HTTP request in this
+  # method, because 1) all calls in the block will be retried from the top if there's
+  # an authN failure detected, and 2) only the response returned by the block will be
+  # inspected for authN failure.
+  # Related: consider that the client instance and its token will live across many
+  # invocations of the GlobusClient methods once the client is configured by a consuming application,
+  # since this class is a Singleton.  Thus, a token may expire between any two calls (i.e. it
+  # isn't necessary for a set of operations to collectively take longer than the token lifetime for
+  # expiry to fall in the middle of that related set of HTTP calls).
+  def with_token_refresh_when_unauthorized
+    response = yield
+
+    # if unauthorized, token has likely expired. try to get a new token and then retry the same request(s).
+    if response.status == 401
+      config.token = Authenticator.token(config.client_id, config.client_secret, config.auth_url)
+      response = yield
+    end
+
+    response
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Aaron Collier
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-22 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,90 +74,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This provides API interaction with the Globus API
 email:
 - aaron.collier@stanford.edu
@@ -167,11 +83,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".autoupdate/postupdate"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop/custom.yml"
-- ".standard.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -183,7 +97,6 @@ files:
 - lib/globus_client/authenticator.rb
 - lib/globus_client/endpoint.rb
 - lib/globus_client/identity.rb
-- lib/globus_client/token_wrapper.rb
 - lib/globus_client/unexpected_response.rb
 - lib/globus_client/version.rb
 homepage: https://github.com/sul-dlss/globus_client
@@ -201,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.autoupdate/postupdate

@@ -1,19 +0,0 @@
-#!/bin/bash --login
-
-# This script is called by our weekly dependency update job in Jenkins after updating Ruby and other deps
-
-# Switch to Ruby 3.1 for GlobusClient (3.0 is default in Jenkinsfile)
-rvm use 3.1.2@globus_client --create &&
-    gem install bundler &&
-    bundle install --gemfile Gemfile
-
-standardrb --fix > globus_client_standard.txt
-
-retVal=$?
-
-git commit -am "Update to latest standard style guide"
-
-if [ $retVal -ne 0 ]; then
-    echo "ERROR UPDATING RUBY TO STANDARD STYLE (globus_client)"
-    cat globus_client_standard.txt
-fi

data/.rubocop/custom.yml

@@ -1,80 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.1
-  DisplayCopNames: true
-  SuggestExtensions: false
-  Exclude:
-    - bin/**
-    - vendor/bundle/**/*
-
-# Per team developer playbook
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false
-
-RSpec/BeEq: # new in 2.9.0
-  Enabled: true
-RSpec/BeNil: # new in 2.9.0
-  Enabled: true
-RSpec/ChangeByZero: # new in 2.11
-  Enabled: true
-RSpec/ClassCheck: # new in 2.13
-  Enabled: true
-RSpec/ExcessiveDocstringSpacing: # new in 2.5
-  Enabled: true
-RSpec/IdenticalEqualityAssertion: # new in 2.4
-  Enabled: true
-RSpec/NoExpectationExample: # new in 2.13
-  Enabled: true
-RSpec/SortMetadata: # new in 2.14
-  Enabled: true
-RSpec/SubjectDeclaration: # new in 2.5
-  Enabled: true
-RSpec/VerifiedDoubleReference: # new in 2.10.0
-  Enabled: true
-Capybara/NegationMatcher: # new in 2.14
-  Enabled: true
-Capybara/SpecificActions: # new in 2.14
-  Enabled: true
-Capybara/SpecificFinders: # new in 2.13
-  Enabled: true
-Capybara/SpecificMatcher: # new in 2.12
-  Enabled: true
-FactoryBot/ConsistentParenthesesStyle: # new in 2.14
-  Enabled: true
-FactoryBot/SyntaxMethods: # new in 2.7
-  Enabled: true
-RSpec/Rails/AvoidSetupHook: # new in 2.4
-  Enabled: true
-RSpec/Rails/HaveHttpStatus: # new in 2.12
-  Enabled: true
-RSpec/Rails/InferredSpecType: # new in 2.14
-  Enabled: true
-Capybara/MatchStyle: # new in 2.17
-  Enabled: true
-FactoryBot/AssociationStyle: # new in 2.23
-  Enabled: true
-FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
-  Enabled: true
-FactoryBot/FactoryNameStyle: # new in 2.16
-  Enabled: true
-FactoryBot/RedundantFactoryOption: # new in 2.23
-  Enabled: true
-RSpec/BeEmpty: # new in 2.20
-  Enabled: true
-RSpec/ContainExactly: # new in 2.19
-  Enabled: true
-RSpec/DuplicatedMetadata: # new in 2.16
-  Enabled: true
-RSpec/IndexedLet: # new in 2.20
-  Enabled: false # Sometimes indices *are* meaningful
-RSpec/MatchArray: # new in 2.19
-  Enabled: true
-RSpec/PendingWithoutReason: # new in 2.16
-  Enabled: true
-RSpec/RedundantAround: # new in 2.19
-  Enabled: true
-RSpec/SkipBlockInsideExample: # new in 2.19
-  Enabled: true
-RSpec/Rails/MinitestAssertions: # new in 2.17
-  Enabled: true
-RSpec/Rails/TravelAround: # new in 2.19
-  Enabled: true

data/.standard.yml

@@ -1 +0,0 @@
-parallel: true

data/lib/globus_client/token_wrapper.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-class GlobusClient
-  # Wraps API operations to request new access token if expired
-  class TokenWrapper
-    def self.refresh(config)
-      yield
-    rescue UnexpectedResponse::UnauthorizedError
-      config.token = Authenticator.token(config.client_id, config.client_secret, config.auth_url)
-      yield
-    end
-  end
-end