globus_client 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1fb97800b48bd1cd82b00c43cc82ea71e24212a4d1385bb84ffb432aaa61715
-  data.tar.gz: e29d9c2ee049c83d0e3c63fbcee2abedbdb1706f3fc29ad907870acad06e88e9
+  metadata.gz: 98ab11c317225b75273064fa994c5959d2dd5de9e5276f0c3cc81e264d52140c
+  data.tar.gz: 445c5c522f4e41a735331f3cf3c47a07a6854cc39c308e028bab616759f07703
 SHA512:
-  metadata.gz: 1b2fd795460970e2eb1449d1053a6baafa14a584d892ec2fa00c778e0921a5f23e7d6824cf98641a1c9d0a54c8d5644a563bcde93e935a42f21f4e0f0bd5e743
-  data.tar.gz: deb0f58b722e3c12208bbede68147d6d0311e0a3bbc85740dcfa764fdf46b2a57836e6e6391306aade37f93c182b7e3865ae37700485bdb17b5746b2a36a3b21
+  metadata.gz: 332fdd907867b012edb68cdb145241dcd666f264a8afc806eaf41028af8af3addcd76b16560c79a2db49c69ecce1d9b3cc5cdb4a718e07fe6ede80b117dc7387
+  data.tar.gz: f614098b8258b8598f92fe4fd1e73257e1b413cb8573bb2ccb84235278ebe93f0c249392a5113bc56dae88f3b55b09dc876ed11c20e40fabd0ee4d55b7ec18a4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.7.0)
+    globus_client (0.9.0)
       activesupport (>= 4.2, < 8)
       faraday
       zeitwerk
@@ -23,7 +23,7 @@ GEM
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.7.1)
+    faraday (2.7.2)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -32,9 +32,9 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.2)
-    minitest (5.16.3)
+    minitest (5.17.0)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
     rainbow (3.1.1)
@@ -47,45 +47,45 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.39.0)
+    rubocop (1.42.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.15.1)
+    rubocop-performance (1.15.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.15.0)
+    rubocop-rspec (2.16.0)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.19.1)
+    standard (1.21.1)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.39.0)
-      rubocop-performance (= 1.15.1)
+      rubocop (= 1.42.0)
+      rubocop-performance (= 1.15.2)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)

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/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?
@@ -90,25 +94,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/identity.rb

@@ -20,7 +20,8 @@ class GlobusClient
     def exists?(user_id)
       get_identity_id(user_id)
       true
-    rescue
+    # if no active user is returned
+    rescue RuntimeError
       false
     end
 

data/lib/globus_client/token_wrapper.rb

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

data/lib/globus_client/version.rb

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

data/lib/globus_client.rb

@@ -23,6 +23,8 @@ class GlobusClient
     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(
         token: Authenticator.token(client_id, client_secret, auth_url),
+        client_id:,
+        client_secret:,
         uploads_directory:,
         transfer_endpoint_id:,
         transfer_url:,
@@ -32,7 +34,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"
@@ -46,41 +49,62 @@ class GlobusClient
   attr_accessor :config
 
   def mkdir(...)
-    endpoint = Endpoint.new(config, ...)
-    endpoint.mkdir
-    endpoint.allow_writes
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, ...)
+      endpoint.mkdir
+      endpoint.allow_writes
+    end
   end
 
   def disallow_writes(...)
-    endpoint = Endpoint.new(config, ...)
-    endpoint.disallow_writes
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, ...)
+      endpoint.disallow_writes
+    end
   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)
-    endpoint = Endpoint.new(config, **keywords)
-    endpoint.list_files(&block)
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, **keywords)
+      endpoint.list_files(&block)
+    end
   end
 
   def file_count(...)
-    endpoint = Endpoint.new(config, ...)
-    endpoint.list_files { |files| return files.count }
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, ...)
+      endpoint.list_files { |files| return files.count }
+    end
   end
 
   def total_size(...)
-    endpoint = Endpoint.new(config, ...)
-    endpoint.list_files { |files| return files.sum(&:size) }
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, ...)
+      endpoint.list_files { |files| return files.sum(&:size) }
+    end
   end
 
   def get_filenames(...)
-    endpoint = Endpoint.new(config, ...)
-    endpoint.list_files { |files| return files.map(&:name) }
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, ...)
+      endpoint.list_files { |files| return files.map(&:name) }
+    end
+  end
+
+  def has_files?(...)
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, ...)
+      endpoint.has_files?
+    end
   end
 
   def user_exists?(...)
-    identity = Identity.new(config)
-    identity.exists?(...)
+    TokenWrapper.refresh(config) do
+      identity = Identity.new(config)
+      identity.exists?(...)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Aaron Collier
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,6 +170,7 @@ 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