globus_client 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9129e55c5e5e6f4f62fc0d8912eca9310eff036e1c0095d24cae07367947054c
-  data.tar.gz: 1265f2f6c1b68bb6d76634f7bd636ed920b1095fd3bfd5ab6702525d994bf295
+  metadata.gz: e189003b0a3f0592abd4fb7fabb006a3367f3cd330d83d7e46da2c2993bbbc21
+  data.tar.gz: 36c6ff9a70ddcfea7be6e1ca044b110adb536aa911adbb1626f5086737342d88
 SHA512:
-  metadata.gz: 407e55c907f990f0492898e636525c8238221167fabf6d0b4bccef0c9eb163f0d75b5bb3b05b58130be46bb823b809a524490f762cbd5b3c56143e2abf9fd7c4
-  data.tar.gz: e7300d3adbaa6b75d43cafe1faae5eccfc212f558ce7d38889438d3ceaac99becc55242d2a10f2ec3eba759d2038649fe2b80585e97cba4e58ebd215b4767594
+  metadata.gz: 02cd08266cd52d2a3dd86ded97c8ce0085832fb446223375ab69164ed087187611e184e7cb4555208a0fb30b477e6c8b0e212041073cce2a3c328ddf6412e0c3
+  data.tar.gz: 1d54da5c74f41e1a98ecdf0296ee948e14a9e569ed1f58a20f52c96347b1b215a4121050cef2e9c7f3d25d525a5b061e9cfe79cc8517efb1ff896cb517226962

data/.rubocop.yml

@@ -1,18 +1,28 @@
-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:
+  ForbiddenPrefixes:
+    - is_
+    - have_

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,8 +1,8 @@
 PATH
   remote: .
   specs:
-    globus_client (0.13.0)
-      activesupport (>= 4.2, < 8)
+    globus_client (0.15.0)
+      activesupport (>= 4.2)
       faraday
       faraday-retry
       zeitwerk
@@ -10,111 +10,110 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    addressable (2.8.5)
-      public_suffix (>= 2.0.2, < 6.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
-    base64 (0.1.1)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     byebug (11.1.3)
-    concurrent-ruby (1.2.2)
-    crack (0.4.5)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    faraday (2.7.11)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    faraday-retry (2.2.0)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    drb (2.2.1)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    faraday-retry (2.2.1)
       faraday (~> 2.0)
-    hashdiff (1.0.1)
-    i18n (1.14.1)
+    hashdiff (1.1.2)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    minitest (5.20.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    json (2.9.1)
+    language_server-protocol (3.17.0.4)
+    logger (1.6.6)
+    minitest (5.25.4)
+    net-http (0.6.0)
+      uri
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
-    public_suffix (5.0.3)
-    racc (1.7.1)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.56.3)
-      base64 (~> 0.1.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.71.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       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)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.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.1)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.4.0)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     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)
-    webmock (3.19.1)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.2)
+    webmock (3.25.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.11)
+    zeitwerk (2.7.1)
 
 PLATFORMS
   x86_64-darwin-19
@@ -128,9 +127,9 @@ DEPENDENCIES
   globus_client!
   rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop-performance
   rubocop-rspec
   simplecov
-  standard
   webmock
 
 BUNDLED WITH

data/README.md

@@ -1,7 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/globus_client.svg)](https://badge.fury.io/rb/globus_client)
 [![CircleCI](https://circleci.com/gh/sul-dlss/globus_client.svg?style=svg)](https://circleci.com/gh/sul-dlss/globus_client)
-[![Code Climate](https://codeclimate.com/github/sul-dlss/globus_client/badges/gpa.svg)](https://codeclimate.com/github/sul-dlss/globus_client)
-[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/8e6bf1a5d3fc86a6fbd0/test_coverage)](https://codeclimate.com/github/sul-dlss/globus_client/test_coverage)
+[![codecov](https://codecov.io/github/sul-dlss/globus_client/graph/badge.svg?token=ARR042OHR8)](https://codecov.io/github/sul-dlss/globus_client)
 
 # GlobusClient
 

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,40 @@
 #!/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.instance, user_id:, path:).send(:access_rule)["permissions"]
+    @before_permissions = GlobusClient::Endpoint.new(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 +42,13 @@ 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.instance, user_id:, path:).send(:access_rule)["permissions"]
+    @after_permissions = GlobusClient::Endpoint.new(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'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday-retry'
+  spec.add_dependency 'zeitwerk'
 end

data/lib/globus_client/authenticator.rb

@@ -3,40 +3,32 @@
 class GlobusClient
   # The namespace for the "login" command
   class Authenticator
-    def self.token(client_id, client_secret, auth_url)
-      new(client_id, client_secret, auth_url).token
-    end
-
-    def initialize(client_id, client_secret, auth_url)
-      @client_id = client_id
-      @client_secret = client_secret
-      @auth_url = auth_url
+    def self.token
+      new.token
     end
 
     # Request an access_token
     def token
-      response = connection.post("/v2/oauth2/token", form_data)
+      response = connection.post('/v2/oauth2/token', form_data)
 
       UnexpectedResponse.call(response) unless response.success?
 
-      JSON.parse(response.body)["access_token"]
+      JSON.parse(response.body)['access_token']
     end
 
     private
 
-    attr_reader :client_id, :client_secret, :auth_url
-
     def connection
-      Faraday.new(url: auth_url)
+      Faraday.new(url: GlobusClient.config.auth_url)
     end
 
     def form_data
       {
-        client_id:,
-        client_secret:,
-        encoding: "form",
-        grant_type: "client_credentials",
-        scope: "urn:globus:auth:scope:transfer.api.globus.org:all"
+        client_id: GlobusClient.config.client_id,
+        client_secret: GlobusClient.config.client_secret,
+        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,18 @@
 
 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 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(client, path:, user_id:)
-      @client = client
+    # @param notify_email [Boolean] indicates if we should ask Globus to send emails on access change (default: true)
+    def initialize(path:, user_id:, notify_email: true)
       @user_id = user_id
       @path = path
+      @notify_email = notify_email
     end
 
     def has_files?
@@ -30,41 +30,43 @@ class GlobusClient
     def mkdir
       # transfer API does not support recursive directory creation
       paths.each do |path|
-        client.post(
-          base_url: client.config.transfer_url,
+        GlobusClient.instance.post(
+          base_url: GlobusClient.config.transfer_url,
           path: "#{transfer_path}/mkdir",
-          body: {DATA_TYPE: "mkdir", path:},
-          expected_response: ->(resp) { resp.status == 502 && JSON.parse(resp.body)["code"] == "ExternalError.MkdirFailed.Exists" }
+          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
 
-      client.delete(
-        base_url: client.config.transfer_url,
+      GlobusClient.instance.delete(
+        base_url: GlobusClient.config.transfer_url,
         path: "#{access_path}/#{access_rule_id}"
       )
     end
 
     private
 
-    attr_reader :client, :path, :user_id
+    attr_reader :path, :user_id, :notify_email
 
     def globus_identity_id
-      Identity.new(client).get_identity_id(user_id)
+      Identity.new.get_identity_id(user_id)
     end
 
     # Builds up a path from a list of path elements. E.g., input would look like:
@@ -74,7 +76,7 @@ class GlobusClient
     def paths
       @paths ||= path_segments.map.with_index do |_segment, index|
         File
-          .join(client.config.uploads_directory, path_segments.slice(..index))
+          .join(GlobusClient.config.uploads_directory, path_segments.slice(..index))
           .concat(PATH_SEPARATOR)
       end
     end
@@ -95,27 +97,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 = client.get(
-        base_url: client.config.transfer_url,
+      response = GlobusClient.instance.get(
+        base_url: GlobusClient.config.transfer_url,
         path: "#{transfer_path}/ls",
-        params: {path: filepath}
+        params: { path: filepath }
       )
 
-      response["DATA"]
-        .select { |object| object["type"] == "file" }
+      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
 
-      response["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
@@ -127,58 +129,59 @@ class GlobusClient
       if access_rule_id
         update_access_request(permissions:)
       else
-        client.post(
-          base_url: client.config.transfer_url,
+        body = {
+          DATA_TYPE: 'access',
+          principal_type: 'identity',
+          principal: globus_identity_id,
+          path: full_path,
+          permissions:
+        }
+        body[:notify_email] = user_id if notify_email
+        GlobusClient.instance.post(
+          base_url: GlobusClient.config.transfer_url,
           path: access_path,
-          body: {
-            DATA_TYPE: "access",
-            principal_type: "identity",
-            principal: globus_identity_id,
-            path: full_path,
-            permissions:,
-            notify_email: user_id
-          }
+          body:
         )
       end
     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
 
-      client.put(
-        base_url: client.config.transfer_url,
+      GlobusClient.instance.put(
+        base_url: GlobusClient.config.transfer_url,
         path: "#{access_path}/#{access_rule_id}",
         body: {
-          DATA_TYPE: "access",
+          DATA_TYPE: 'access',
           permissions:
         }
       )
     end
 
     def access_rule
-      response = client.get(
-        base_url: client.config.transfer_url,
+      response = GlobusClient.instance.get(
+        base_url: GlobusClient.config.transfer_url,
         path: access_list_path,
-        content_type: "application/json"
+        content_type: 'application/json'
       )
 
-      response.fetch("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/#{client.config.transfer_endpoint_id}"
+      "/v0.10/operation/endpoint/#{GlobusClient.config.transfer_endpoint_id}"
     end
 
     def access_path
-      "/v0.10/endpoint/#{client.config.transfer_endpoint_id}/access"
+      "/v0.10/endpoint/#{GlobusClient.config.transfer_endpoint_id}/access"
     end
 
     def access_list_path
-      "/v0.10/endpoint/#{client.config.transfer_endpoint_id}/access_list"
+      "/v0.10/endpoint/#{GlobusClient.config.transfer_endpoint_id}/access_list"
     end
   end
 end

data/lib/globus_client/identity.rb

@@ -3,36 +3,28 @@
 class GlobusClient
   # Lookup of a Globus identity ID
   class Identity
-    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)
-      response = client.get(
-        base_url: client.config.auth_url,
-        path: "/v2/api/identities",
-        params: {usernames: user_id}
+      response = GlobusClient.instance.get(
+        base_url: GlobusClient.config.auth_url,
+        path: '/v2/api/identities',
+        params: { usernames: user_id }
       )
 
-      response["identities"].find { |id| id["username"] == user_id }
+      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 :client
   end
 end

data/lib/globus_client/unexpected_response.rb

@@ -39,7 +39,7 @@ class GlobusClient
       when 502
         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}."
       end

data/lib/globus_client/version.rb

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

data/lib/globus_client.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/module/delegation"
-require "active_support/core_ext/object/blank"
-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
@@ -22,8 +21,10 @@ 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 `with_token_refresh_when_unauthorized` to handle
         # auto-magic token refreshing. Why not immediately get a valid token? Our apps
@@ -34,7 +35,7 @@ class GlobusClient
         # 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 `with_token_refresh_when_unauthorized`
-        token: "a temporary dummy token to avoid hitting the API before it is needed",
+        token: 'a temporary dummy token to avoid hitting the API before it is needed',
         client_id:,
         client_secret:,
         uploads_directory:,
@@ -45,16 +46,17 @@ 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?, :delete, :get, :post, :put, 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
 
@@ -67,8 +69,8 @@ class GlobusClient
   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
+        request.headers['Authorization'] = "Bearer #{config.token}"
+        request.headers['Content-Type'] = content_type if content_type
       end
     end
 
@@ -84,11 +86,11 @@ class GlobusClient
   # @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 })
+  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.headers['Authorization'] = "Bearer #{config.token}"
+        request.headers['Content-Type'] = 'application/json'
         request.body = body.to_json
       end
     end
@@ -107,8 +109,8 @@ class GlobusClient
   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.headers['Authorization'] = "Bearer #{config.token}"
+        request.headers['Content-Type'] = 'application/json'
         request.body = body.to_json
       end
     end
@@ -126,7 +128,7 @@ class GlobusClient
   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}"
+        request.headers['Authorization'] = "Bearer #{config.token}"
       end
     end
 
@@ -138,7 +140,7 @@ class GlobusClient
   end
 
   def mkdir(...)
-    Endpoint.new(self, ...).tap do |endpoint|
+    Endpoint.new(...).tap do |endpoint|
       endpoint.mkdir
       endpoint.allow_writes
     end
@@ -146,57 +148,59 @@ class GlobusClient
 
   def disallow_writes(...)
     Endpoint
-      .new(self, ...)
+      .new(...)
       .disallow_writes
   end
 
   def delete_access_rule(...)
     Endpoint
-      .new(self, ...)
+      .new(...)
       .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)
+  def list_files(**keywords, &)
     Endpoint
-      .new(self, **keywords)
-      .list_files(&block)
+      .new(**keywords)
+      .list_files(&)
   end
 
   def file_count(...)
     Endpoint
-      .new(self, ...)
+      .new(...)
       .list_files { |files| return files.count }
   end
 
   def total_size(...)
     Endpoint
-      .new(self, ...)
+      .new(...)
       .list_files { |files| return files.sum(&:size) }
   end
 
   def get_filenames(...)
     Endpoint
-      .new(self, ...)
+      .new(...)
       .list_files { |files| return files.map(&:name) }
   end
 
   def has_files?(...)
     Endpoint
-      .new(self, ...)
+      .new(...)
       .has_files?
   end
 
   def user_valid?(...)
     Identity
-      .new(self)
+      .new
       .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, {
@@ -226,7 +230,7 @@ class GlobusClient
 
     # 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)
+      config.token = Authenticator.token
       response = yield
     end
 

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Aaron Collier
 - Laura Wrubel
 - Mike Giarlo
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,9 +18,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,9 +25,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -74,90 +67,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 +76,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".autoupdate/postupdate"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop/custom.yml"
-- ".standard.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -192,7 +99,6 @@ metadata:
   source_code_uri: https://github.com/sul-dlss/globus_client
   changelog_uri: https://github.com/sul-dlss/globus_client/releases
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,15 +106,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Interface for interacting with the Globus API.
 test_files: []

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