globus_client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23d56c1a01cd643aafec353ff36adf2ad15b4792ebbd3091745415d5fcce68eb
-  data.tar.gz: 0d6acdff1f5a627b6a9030bf1e5154c4efef845bab052c27d4d84206ee04c822
+  metadata.gz: 48a7e0a937ea5e51b5803b69237c2d03afdc95a14a26008b6df31b708b086600
+  data.tar.gz: 431c01307b660f6cab3240963e508f57d1d1a8412e75b3468b7c16a48fc220c6
 SHA512:
-  metadata.gz: 6c6ea6b0df9c20fddb7157cd5c7a0dc3270308ce11805f1fbaebb35f704647e7bc4d097ab5a89edc68c1c87274d3adaa52abd6928d9c5d89a214eb99cf7193ac
-  data.tar.gz: e25b26ab750b5b176279e26de6887bafc9fc25cce8b406d2aabec931978858580d26f816e9c2c6e92e3b7cca81afaf1cee6aa84490f88c152a65c2d35ee8c3ec
+  metadata.gz: ccb73a4b9709b88f4bcf2bfcd59775beeee645c3b79b7c9a1083cb922ea4cb014ed07141579bf92532be103eb79bf23b7a65b727f0343b8f4ecec9f294fdfd05
+  data.tar.gz: 4aa6ff81e7ac5109526ca7608c089e2b5a1f8f7ce4e4f9a8c4eabaf14805dc22d4c0380624aef82179dee222ef1e7997fd7a485355e152a13fd81f1f64e20425

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.5.0)
+    globus_client (0.6.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,10 @@ GlobusClient.configure(
 def create_user_directory
   GlobusClient.mkdir(user_id: 'mjgiarlo@stanford.edu', path: 'mjgiarlo/work1234/version1')
 end
+
+def lookup_dir_contents
+  GlobusClient.get_filenames(user_id: 'mjgiarlo@stanford.edu', path: 'mjgiarlo/work1234/version1')
+end
 # ...
 ```
 

data/api_test.rb

@@ -27,6 +27,8 @@ 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"]
 
@@ -34,4 +36,5 @@ 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}"

data/lib/globus_client/endpoint.rb

@@ -56,6 +56,10 @@ class GlobusClient
       access_request(permissions: "r")
     end
 
+    def get_filenames
+      ls_path(full_path, [])
+    end
+
     private
 
     attr_reader :config, :path, :user_id
@@ -105,6 +109,23 @@ class GlobusClient
       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)
+      # 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) }
+      else
+        UnexpectedResponse.call(response)
+      end
+      filenames
+    end
+
     def access_request(permissions:)
       response = if access_rule_id
         connection.put("#{access_path}/#{access_rule_id}") do |req|

data/lib/globus_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GlobusClient
-  VERSION = "0.5.0"
+  VERSION = "0.6.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, :mkdir, :total_size, :user_exists?, :get_filenames, to: :instance
 
     def default_transfer_url
       "https://transfer.api.globusonline.org"
@@ -66,6 +66,11 @@ class GlobusClient
     endpoint.total_size
   end
 
+  def get_filenames(...)
+    endpoint = Endpoint.new(config, ...)
+    endpoint.get_filenames
+  end
+
   def user_exists?(...)
     identity = Identity.new(config)
     identity.exists?(...)

metadata

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