globus_client 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40f9903f67d10be16104fe3664bf68dd467b24414cb7f0c84bfb6539cd2acee5
-  data.tar.gz: bbcc3c1f811df83d8a4d473ff3cd646b33d6f7f950aaa99c0f86e0e10165130d
+  metadata.gz: 4b87c64f97dd930fde77d12e01206ceb2b81900b987d1b47d8c0feb559255ef9
+  data.tar.gz: df241413512d952ff06fc81a7f216b79268903f5aed15147faa6f28fefa5e75d
 SHA512:
-  metadata.gz: f5334d262c97ac5512d5a6bbaf9a0927e98fea577a318ba0b08c3dbac33bfbb53c01bdb95205df271886c36df2ce7144c078e7ae8deadc5bea8af9a8d9180479
-  data.tar.gz: a850d0854a936f24653d0ebf0bfd96be478ab2a0c6be908c1cd47defb3872b306281a35d56b76cff898cc48ba9340d20dde4d4a96051d36007d6c29d3f5a4a53
+  metadata.gz: 6bcb102fa5457fc3f8ef38794efa9b2528c1ab608c62c54657f8d65bc0073e2d5f7e564a37f91ec111f91bfdbaa2e5900fd3f9b487896ef79069178d0c5be98c
+  data.tar.gz: 977be8baca2ebdbcecc0d47d26ccb8b273a199252ee71a56cff3d25751dd3d5c58fd46b5a5abe57324d3005a1f699e87832df345c808a13229473c2ce30708a2

data/Gemfile.lock

@@ -1,15 +1,16 @@
 PATH
   remote: .
   specs:
-    globus_client (0.8.0)
+    globus_client (0.9.1)
       activesupport (>= 4.2, < 8)
       faraday
+      faraday-retry
       zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -18,59 +19,64 @@ GEM
       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.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
+    faraday-retry (2.0.0)
+      faraday (~> 2.0)
     hashdiff (1.0.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    language_server-protocol (3.17.0.2)
+    language_server-protocol (3.17.0.3)
     minitest (5.17.0)
     parallel (1.22.1)
-    parser (3.2.0.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.7.0)
     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.1)
       rspec-support (~> 3.12.0)
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.2)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.42.0)
+    rubocop (1.44.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       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)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
     rubocop-performance (1.15.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.16.0)
+    rubocop-rspec (2.18.1)
       rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     simplecov (0.22.0)
@@ -79,23 +85,24 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.21.1)
+    standard (1.24.3)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.42.0)
+      rubocop (= 1.44.1)
       rubocop-performance (= 1.15.2)
-    tzinfo (2.0.5)
+    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.7)
 
 PLATFORMS
   x86_64-darwin-19
   x86_64-darwin-20
   x86_64-darwin-21
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES

data/api_test.rb

@@ -30,6 +30,10 @@ Benchmark.bm(20) do |benchmark|
     @before_permissions = GlobusClient::Endpoint.new(GlobusClient.config, user_id:, path:).send(:access_rule)["permissions"]
   end
 
+  benchmark.report("has_files?:") do
+    @has_files = GlobusClient.has_files?(user_id:, path:)
+  end
+
   benchmark.report("list_files:") do
     GlobusClient.list_files(user_id:, path:) do |files|
       @files_count = files.count
@@ -49,6 +53,7 @@ Benchmark.bm(20) do |benchmark|
 
   puts "User #{user_id} exists: #{@user_exists}"
   puts "Initial directory permissions: #{@before_permissions}"
+  puts "Directory has files? #{@has_files}"
   puts "Number of files in directory: #{@files_count}"
   puts "Total size of files in directory: #{@total_size}"
   puts "List of files in directory: #{@files_list}"

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

@@ -16,6 +16,10 @@ class GlobusClient
       @path = path
     end
 
+    def has_files?
+      ls_path(full_path, [], return_presence: true)
+    end
+
     def list_files
       ls_path(full_path, []).tap do |files|
         yield files if block_given?
@@ -61,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
@@ -90,25 +103,38 @@ class GlobusClient
     end
 
     def path_segments
+      raise ArgumentError, "Unexpected path provided: #{path.inspect}" unless path.respond_to?(:split)
+
       path.split(PATH_SEPARATOR)
     end
 
+    # List files recursively at an endpoint https://docs.globus.org/api/transfer/file_operations/#list_directory_contents
     # @param filepath [String] an absolute path to look up contents e.g. /uploads/example/work123/version1
     # @param files [Array<FileInfo>] an array of FileInfo structs, each of which has a name and a size
-    def ls_path(filepath, files)
-      # List files recursively at an endpoint https://docs.globus.org/api/transfer/file_operations/#list_directory_contents
+    # @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=#{filepath}")
-      if response.success?
-        data = JSON.parse(response.body)["DATA"]
-        data
-          .select { |object| object["type"] == "file" }
-          .each { |file| files << FileInfo.new("#{filepath}#{file["name"]}", file["size"]) }
-        data
-          .select { |object| object["type"] == "dir" }
-          .each { |dir| ls_path("#{filepath}#{dir["name"]}/", files) }
-      else
-        UnexpectedResponse.call(response)
+      return UnexpectedResponse.call(response) unless response.success?
+
+      data = JSON.parse(response.body)["DATA"]
+      data
+        .select { |object| object["type"] == "file" }
+        .each do |file|
+        return true if return_presence
+
+        files << FileInfo.new("#{filepath}#{file["name"]}", file["size"])
+      end
+      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
       end
+
+      return false if return_presence
+
       files
     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.8.0"
+  VERSION = "0.9.1"
 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"
@@ -34,7 +35,8 @@ class GlobusClient
       self
     end
 
-    delegate :config, :disallow_writes, :file_count, :list_files, :mkdir, :total_size, :user_exists?, :get_filenames, to: :instance
+    delegate :config, :disallow_writes, :file_count, :list_files, :mkdir, :total_size,
+      :user_exists?, :get_filenames, :has_files?, to: :instance
 
     def default_transfer_url
       "https://transfer.api.globusonline.org"
@@ -93,6 +95,13 @@ class GlobusClient
     end
   end
 
+  def has_files?(...)
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, ...)
+      endpoint.has_files?
+    end
+  end
+
   def user_exists?(...)
     TokenWrapper.refresh(config) do
       identity = Identity.new(config)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Aaron Collier
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-03-01 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
@@ -195,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the Globus API.