globus_client 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48a7e0a937ea5e51b5803b69237c2d03afdc95a14a26008b6df31b708b086600
-  data.tar.gz: 431c01307b660f6cab3240963e508f57d1d1a8412e75b3468b7c16a48fc220c6
+  metadata.gz: 40f9903f67d10be16104fe3664bf68dd467b24414cb7f0c84bfb6539cd2acee5
+  data.tar.gz: bbcc3c1f811df83d8a4d473ff3cd646b33d6f7f950aaa99c0f86e0e10165130d
 SHA512:
-  metadata.gz: ccb73a4b9709b88f4bcf2bfcd59775beeee645c3b79b7c9a1083cb922ea4cb014ed07141579bf92532be103eb79bf23b7a65b727f0343b8f4ecec9f294fdfd05
-  data.tar.gz: 4aa6ff81e7ac5109526ca7608c089e2b5a1f8f7ce4e4f9a8c4eabaf14805dc22d4c0380624aef82179dee222ef1e7997fd7a485355e152a13fd81f1f64e20425
+  metadata.gz: f5334d262c97ac5512d5a6bbaf9a0927e98fea577a318ba0b08c3dbac33bfbb53c01bdb95205df271886c36df2ce7144c078e7ae8deadc5bea8af9a8d9180479
+  data.tar.gz: a850d0854a936f24653d0ebf0bfd96be478ab2a0c6be908c1cd47defb3872b306281a35d56b76cff898cc48ba9340d20dde4d4a96051d36007d6c29d3f5a4a53

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.6.0)
+    globus_client (0.8.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/README.md

@@ -57,7 +57,13 @@ def create_user_directory
 end
 
 def lookup_dir_contents
-  GlobusClient.get_filenames(user_id: 'mjgiarlo@stanford.edu', path: 'mjgiarlo/work1234/version1')
+  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
 # ...
 ```
@@ -78,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,40 +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:)
-
-files_list = GlobusClient.get_filenames(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 "List of files in directory: #{files_list}"
-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
@@ -56,17 +56,13 @@ class GlobusClient
       access_request(permissions: "r")
     end
 
-    def get_filenames
-      ls_path(full_path, [])
-    end
-
     private
 
     attr_reader :config, :path, :user_id
 
     def connection
       # Transfer API connection
-      Faraday.new(
+      @connection ||= Faraday.new(
         url: config.transfer_url,
         headers: {Authorization: "Bearer #{config.token}"}
       )
@@ -81,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)
@@ -97,33 +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" }
-    end
-
     # @param filepath [String] an absolute path to look up contents e.g. /uploads/example/work123/version1
-    # @param filenames [Array<String>] a list of filenames, with absolute filepaths
-    def ls_path(filepath, filenames)
+    # @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" }.map { |file| file["name"] }
-          .each { |file| filenames << "#{filepath}#{file}" }
-        data.select { |object| object["type"] == "dir" }.map { |dir| dir["name"] }
-          .each { |dir| ls_path("#{filepath}#{dir}/", filenames) }
+        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
-      filenames
+      files
     end
 
     def access_request(permissions:)

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.6.0"
+  VERSION = "0.8.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,7 @@ class GlobusClient
       self
     end
 
-    delegate :config, :disallow_writes, :file_count, :mkdir, :total_size, :user_exists?, :get_filenames, 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"
@@ -46,33 +48,55 @@ 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)
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, **keywords)
+      endpoint.list_files(&block)
+    end
   end
 
   def file_count(...)
-    endpoint = Endpoint.new(config, ...)
-    endpoint.file_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.total_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.get_filenames
+    TokenWrapper.refresh(config) do
+      endpoint = Endpoint.new(config, ...)
+      endpoint.list_files { |files| return files.map(&:name) }
+    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.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aaron Collier
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-01-09 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