globus_client 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40f9903f67d10be16104fe3664bf68dd467b24414cb7f0c84bfb6539cd2acee5
-  data.tar.gz: bbcc3c1f811df83d8a4d473ff3cd646b33d6f7f950aaa99c0f86e0e10165130d
+  metadata.gz: 98ab11c317225b75273064fa994c5959d2dd5de9e5276f0c3cc81e264d52140c
+  data.tar.gz: 445c5c522f4e41a735331f3cf3c47a07a6854cc39c308e028bab616759f07703
 SHA512:
-  metadata.gz: f5334d262c97ac5512d5a6bbaf9a0927e98fea577a318ba0b08c3dbac33bfbb53c01bdb95205df271886c36df2ce7144c078e7ae8deadc5bea8af9a8d9180479
-  data.tar.gz: a850d0854a936f24653d0ebf0bfd96be478ab2a0c6be908c1cd47defb3872b306281a35d56b76cff898cc48ba9340d20dde4d4a96051d36007d6c29d3f5a4a53
+  metadata.gz: 332fdd907867b012edb68cdb145241dcd666f264a8afc806eaf41028af8af3addcd76b16560c79a2db49c69ecce1d9b3cc5cdb4a718e07fe6ede80b117dc7387
+  data.tar.gz: f614098b8258b8598f92fe4fd1e73257e1b413cb8573bb2ccb84235278ebe93f0c249392a5113bc56dae88f3b55b09dc876ed11c20e40fabd0ee4d55b7ec18a4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.8.0)
+    globus_client (0.9.0)
       activesupport (>= 4.2, < 8)
       faraday
       zeitwerk

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/version.rb

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

data/lib/globus_client.rb

@@ -34,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"
@@ -93,6 +94,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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Aaron Collier
 - Laura Wrubel
 - Mike Giarlo
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -180,7 +180,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 +195,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Interface for interacting with the Globus API.
 test_files: []