globus_client 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98ab11c317225b75273064fa994c5959d2dd5de9e5276f0c3cc81e264d52140c
-  data.tar.gz: 445c5c522f4e41a735331f3cf3c47a07a6854cc39c308e028bab616759f07703
+  metadata.gz: 5427a4692e19e5eedb9cd6e3e90d6951e5a4adc1135ca713ca72c81ca09f9deb
+  data.tar.gz: 25f9816388cf1ca0c9ff908df97f5257a246b94c20ce3ecc7fce98a4d7ca3bbe
 SHA512:
-  metadata.gz: 332fdd907867b012edb68cdb145241dcd666f264a8afc806eaf41028af8af3addcd76b16560c79a2db49c69ecce1d9b3cc5cdb4a718e07fe6ede80b117dc7387
-  data.tar.gz: f614098b8258b8598f92fe4fd1e73257e1b413cb8573bb2ccb84235278ebe93f0c249392a5113bc56dae88f3b55b09dc876ed11c20e40fabd0ee4d55b7ec18a4
+  metadata.gz: 476a72181dc845cb4e3b5fa6a16cfc4962d23abdd2b058a544668969db70b9fc46d3f88afcc28e876ada57e92bf00d40bce3b5f6ec2d0567d8dbbf326c48b0c5
+  data.tar.gz: d89e245e9f05d6826206ac000f283f50454798771137a3727004027bee771befa498bbe01513dc4c6ba804120c544b1d5268a0886acba1b5369f34e6df9bd00f

data/Gemfile.lock

@@ -1,77 +1,89 @@
 PATH
   remote: .
   specs:
-    globus_client (0.9.0)
+    globus_client (0.10.0)
       activesupport (>= 4.2, < 8)
       faraday
+      faraday-retry
       zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     byebug (11.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.7.2)
+    faraday (2.7.7)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
+    faraday-retry (2.2.0)
+      faraday (~> 2.0)
     hashdiff (1.0.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    language_server-protocol (3.17.0.2)
-    minitest (5.17.0)
-    parallel (1.22.1)
-    parser (3.2.0.0)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     public_suffix (5.0.1)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.2)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.42.0)
+    rubocop (1.52.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.15.2)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.18.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.16.0)
+    rubocop-rspec (2.22.0)
       rubocop (~> 1.33)
-    ruby-progressbar (1.11.0)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -79,23 +91,31 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.21.1)
+    standard (1.29.0)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.42.0)
-      rubocop-performance (= 1.15.2)
-    tzinfo (2.0.5)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.6)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   x86_64-darwin-19
   x86_64-darwin-20
   x86_64-darwin-21
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -109,4 +129,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.26
+   2.4.13

data/README.md

@@ -33,7 +33,7 @@ client = GlobusClient.configure(
 )
 client.mkdir(user_id: 'mjgiarlo@stanford.edu', path: 'mjgiarlo/work1234/version1')
 
-result = client.user_exists?('mjgiarlo@stanford.edu')
+result = client.user_valid?('mjgiarlo@stanford.edu')
 ```
 
 You can also invoke methods directly on the client class, which is useful in a

data/globus_client.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
 
   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"

data/lib/globus_client/endpoint.rb

@@ -65,11 +65,20 @@ class GlobusClient
     attr_reader :config, :path, :user_id
 
     def connection
-      # Transfer API 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
 
     def globus_identity_id

data/lib/globus_client/identity.rb

@@ -7,9 +7,10 @@ class GlobusClient
       @config = config
     end
 
-    def get_identity_id(user_id)
+    # @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?
 
@@ -17,12 +18,16 @@ class GlobusClient
       extract_id(data)
     end
 
-    def exists?(user_id)
-      get_identity_id(user_id)
-      true
-    # if no active user is returned
-    rescue RuntimeError
-      false
+    # @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"])
+    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"]
     end
 
     private
@@ -43,12 +48,7 @@ class GlobusClient
 
     def extract_id(data)
       identities = data["identities"]
-      # Select identity with "used" or "private" status
-      matching_users = identities.select { |id| id["username"] == @email }
-      active_users = matching_users.select { |user| (user["status"] == "used" || user["status"] == "private") }
-      raise "No matching active Globus user found for #{@email}." if active_users.empty?
-
-      active_users.first["id"]
+      identities.find { |id| id["username"] == @email }
     end
   end
 end

data/lib/globus_client/token_wrapper.rb

@@ -3,7 +3,7 @@
 class GlobusClient
   # Wraps API operations to request new access token if expired
   class TokenWrapper
-    def self.refresh(config, &block)
+    def self.refresh(config)
       yield
     rescue UnexpectedResponse::UnauthorizedError
       config.token = Authenticator.token(config.client_id, config.client_secret, config.auth_url)

data/lib/globus_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GlobusClient
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/lib/globus_client.rb

@@ -2,6 +2,7 @@
 
 require "active_support/core_ext/module/delegation"
 require "faraday"
+require "faraday/retry"
 require "ostruct"
 require "singleton"
 require "zeitwerk"
@@ -35,7 +36,7 @@ class GlobusClient
     end
 
     delegate :config, :disallow_writes, :file_count, :list_files, :mkdir, :total_size,
-      :user_exists?, :get_filenames, :has_files?, to: :instance
+      :user_valid?, :get_filenames, :has_files?, to: :instance
 
     def default_transfer_url
       "https://transfer.api.globusonline.org"
@@ -101,10 +102,10 @@ class GlobusClient
     end
   end
 
-  def user_exists?(...)
+  def user_valid?(...)
     TokenWrapper.refresh(config) do
       identity = Identity.new(config)
-      identity.exists?(...)
+      identity.valid?(...)
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Aaron Collier
 - Laura Wrubel
 - Mike Giarlo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,6 +46,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -180,7 +194,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,8 +209,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Interface for interacting with the Globus API.
 test_files: []