globus_client 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23d56c1a01cd643aafec353ff36adf2ad15b4792ebbd3091745415d5fcce68eb
-  data.tar.gz: 0d6acdff1f5a627b6a9030bf1e5154c4efef845bab052c27d4d84206ee04c822
+  metadata.gz: d1fb97800b48bd1cd82b00c43cc82ea71e24212a4d1385bb84ffb432aaa61715
+  data.tar.gz: e29d9c2ee049c83d0e3c63fbcee2abedbdb1706f3fc29ad907870acad06e88e9
 SHA512:
-  metadata.gz: 6c6ea6b0df9c20fddb7157cd5c7a0dc3270308ce11805f1fbaebb35f704647e7bc4d097ab5a89edc68c1c87274d3adaa52abd6928d9c5d89a214eb99cf7193ac
-  data.tar.gz: e25b26ab750b5b176279e26de6887bafc9fc25cce8b406d2aabec931978858580d26f816e9c2c6e92e3b7cca81afaf1cee6aa84490f88c152a65c2d35ee8c3ec
+  metadata.gz: 1b2fd795460970e2eb1449d1053a6baafa14a584d892ec2fa00c778e0921a5f23e7d6824cf98641a1c9d0a54c8d5644a563bcde93e935a42f21f4e0f0bd5e743
+  data.tar.gz: deb0f58b722e3c12208bbede68147d6d0311e0a3bbc85740dcfa764fdf46b2a57836e6e6391306aade37f93c182b7e3865ae37700485bdb17b5746b2a36a3b21

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.5.0)
+    globus_client (0.7.0)
       activesupport (>= 4.2, < 8)
       faraday
       zeitwerk
@@ -30,13 +30,13 @@ GEM
     hashdiff (1.0.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    language_server-protocol (3.17.0.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
     minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.3.0)
       ast (~> 2.4.1)
-    public_suffix (5.0.0)
+    public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.1)
@@ -50,7 +50,7 @@ GEM
     rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
@@ -79,8 +79,8 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.19.0)
-      language_server-protocol (= 3.17.0.1)
+    standard (1.19.1)
+      language_server-protocol (~> 3.17.0.2)
       rubocop (= 1.39.0)
       rubocop-performance (= 1.15.1)
     tzinfo (2.0.5)

data/README.md

@@ -55,6 +55,16 @@ GlobusClient.configure(
 def create_user_directory
   GlobusClient.mkdir(user_id: 'mjgiarlo@stanford.edu', path: 'mjgiarlo/work1234/version1')
 end
+
+def lookup_dir_contents
+  GlobusClient.list_files(user_id: "mjgiarlo@stanford.edu", path: "mjgiarlo/work1234/version1") do |files|
+    files_count = files.count
+    total_size = files.sum(&:size)
+    files_list = files.map(&:name)
+
+    return [files_count, total_size, files_list]
+  end
+end
 # ...
 ```
 
@@ -74,8 +84,8 @@ $ export GLOBUS_CLIENT_ID=$(vault kv get -field=content puppet/application/sdr/g
 $ export GLOBUS_CLIENT_SECRET=$(vault kv get -field=content puppet/application/sdr/globus/{prod|qa|stage}/client_secret)
 $ export GLOBUS_ENDPOINT=$(vault kv get -field=content puppet/application/sdr/globus/{prod|qa|stage}/endpoint_uuid)
 $ export GLOBUS_UPLOADS_DIRECTORY=from_shared_configs
-# NOTE: The three args below are a user ID, a work ID, and a work version
-$ ./api_test.rb mjgiarlo 987 1
+# NOTE: The two args below are a user ID (email) and a path such as a consumer might construct
+$ ./api_test.rb mjgiarlo@stanford.edu mjgiarlo/work987/version1
 
 Initial directory permissions: rw
 Number of files in directory: 2

data/api_test.rb

@@ -1,37 +1,56 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require "benchmark"
 require "bundler/setup"
 require "globus_client"
 
-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"]
-)
-
-user_id, path = *ARGV
-
-# Test public API methods here.
-GlobusClient.mkdir(user_id:, path:)
-
-user_exists = GlobusClient.user_exists?(user_id)
-
-# Not part of the public API but this allows us to test access changes
-before_permissions = GlobusClient::Endpoint.new(GlobusClient.config, user_id:, path:).send(:access_rule)["permissions"]
-
-files_count = GlobusClient.file_count(user_id:, path:)
-
-total_size = GlobusClient.total_size(user_id:, path:)
-
-GlobusClient.disallow_writes(user_id:, path:)
-
-# Not part of the public API but this allows us to test access changes
-after_permissions = GlobusClient::Endpoint.new(GlobusClient.config, user_id:, path:).send(:access_rule)["permissions"]
-
-puts "User #{user_id} exists: #{user_exists}"
-puts "Initial directory permissions: #{before_permissions}"
-puts "Number of files in directory: #{files_count}"
-puts "Total size of files in directory: #{total_size}"
-puts "Final directory permissions: #{after_permissions}"
+Benchmark.bm(20) do |benchmark|
+  user_id, path = *ARGV
+
+  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"]
+    )
+  end
+
+  benchmark.report("mkdir:") do
+    GlobusClient.mkdir(user_id:, path:)
+  end
+
+  benchmark.report("user_exists?:") do
+    @user_exists = GlobusClient.user_exists?(user_id)
+  end
+
+  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.config, user_id:, path:).send(:access_rule)["permissions"]
+  end
+
+  benchmark.report("list_files:") do
+    GlobusClient.list_files(user_id:, path:) do |files|
+      @files_count = files.count
+      @total_size = files.sum(&:size)
+      @files_list = files.map(&:name)
+    end
+  end
+
+  benchmark.report("disallow_writes:") do
+    GlobusClient.disallow_writes(user_id:, path:)
+  end
+
+  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.config, user_id:, path:).send(:access_rule)["permissions"]
+  end
+
+  puts "User #{user_id} exists: #{@user_exists}"
+  puts "Initial directory permissions: #{@before_permissions}"
+  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}"
+  puts "Final directory permissions: #{@after_permissions}"
+end

data/lib/globus_client/endpoint.rb

@@ -5,6 +5,8 @@ class GlobusClient
   class Endpoint
     PATH_SEPARATOR = "/"
 
+    FileInfo = Struct.new(:name, :size)
+
     # @param config [#token, #uploads_directory, #transfer_endpoint_id, #transfer_url, #auth_url] configuration for the gem
     # @param path [String] the path to operate on
     # @param user_id [String] a Globus user ID (e.g., a @stanford.edu email address)
@@ -14,12 +16,10 @@ class GlobusClient
       @path = path
     end
 
-    def file_count
-      objects["total"]
-    end
-
-    def total_size
-      files.sum { |file| file["size"] }
+    def list_files
+      ls_path(full_path, []).tap do |files|
+        yield files if block_given?
+      end
     end
 
     # Create a directory https://docs.globus.org/api/transfer/file_operations/#make_directory
@@ -62,7 +62,7 @@ class GlobusClient
 
     def connection
       # Transfer API connection
-      Faraday.new(
+      @connection ||= Faraday.new(
         url: config.transfer_url,
         headers: {Authorization: "Bearer #{config.token}"}
       )
@@ -77,7 +77,7 @@ class GlobusClient
     # And this method returns:
     #     ["/uploads/mjgiarlo/", "/uploads/mjgiarlo/work123/", "/uploads/mjgiarlo/work123/version1/"]
     def paths
-      path_segments.map.with_index do |_segment, index|
+      @paths ||= path_segments.map.with_index do |_segment, index|
         File
           .join(config.uploads_directory, path_segments.slice(..index))
           .concat(PATH_SEPARATOR)
@@ -93,16 +93,23 @@ class GlobusClient
       path.split(PATH_SEPARATOR)
     end
 
-    def objects
-      # List files at an endpoint https://docs.globus.org/api/transfer/file_operations/#list_directory_contents
-      response = connection.get("#{transfer_path}/ls?path=#{full_path}")
-      return JSON.parse(response.body) if response.success?
-
-      UnexpectedResponse.call(response)
-    end
-
-    def files
-      objects["DATA"].select { |object| object["DATA_TYPE"] == "file" }
+    # @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
+      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)
+      end
+      files
     end
 
     def access_request(permissions:)

data/lib/globus_client/version.rb

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

data/lib/globus_client.rb

@@ -32,7 +32,7 @@ class GlobusClient
       self
     end
 
-    delegate :config, :disallow_writes, :file_count, :mkdir, :total_size, :user_exists?, to: :instance
+    delegate :config, :disallow_writes, :file_count, :list_files, :mkdir, :total_size, :user_exists?, :get_filenames, to: :instance
 
     def default_transfer_url
       "https://transfer.api.globusonline.org"
@@ -56,14 +56,27 @@ class GlobusClient
     endpoint.disallow_writes
   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)
+  end
+
   def file_count(...)
     endpoint = Endpoint.new(config, ...)
-    endpoint.file_count
+    endpoint.list_files { |files| return files.count }
   end
 
   def total_size(...)
     endpoint = Endpoint.new(config, ...)
-    endpoint.total_size
+    endpoint.list_files { |files| return files.sum(&:size) }
+  end
+
+  def get_filenames(...)
+    endpoint = Endpoint.new(config, ...)
+    endpoint.list_files { |files| return files.map(&:name) }
   end
 
   def user_exists?(...)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Aaron Collier
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport