globus_client 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9de93796688ebf5d55d620e0cb290ed7e6b86f67ed1212e7847281ea5ac44d
-  data.tar.gz: b298b6a3744471cb4199e9c9f4ae2c69ece63dd9a3898dc058844d6bad22279c
+  metadata.gz: 48a7e0a937ea5e51b5803b69237c2d03afdc95a14a26008b6df31b708b086600
+  data.tar.gz: 431c01307b660f6cab3240963e508f57d1d1a8412e75b3468b7c16a48fc220c6
 SHA512:
-  metadata.gz: ad0fe7f847270e9534458577dda9a75dad2e83298f0d8232ee8ccd7eca6e127a7290db944ac4dac31cad2df7b42f3e2b7ecc4f273a75059c1c39de2cdf820b09
-  data.tar.gz: 3488ec985fee144991bbe90c29345a7717cae4e371a843bdb0947a6042128391bf7442e522c03494340acfb1ce31b61dc23ca7a30f05bedc667fc459bcfeaea8
+  metadata.gz: ccb73a4b9709b88f4bcf2bfcd59775beeee645c3b79b7c9a1083cb922ea4cb014ed07141579bf92532be103eb79bf23b7a65b727f0343b8f4ecec9f294fdfd05
+  data.tar.gz: 4aa6ff81e7ac5109526ca7608c089e2b5a1f8f7ce4e4f9a8c4eabaf14805dc22d4c0380624aef82179dee222ef1e7997fd7a485355e152a13fd81f1f64e20425

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.4.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

@@ -31,9 +31,9 @@ client = GlobusClient.configure(
   uploads_directory: Settings.globus.uploads_directory,
   transfer_endpoint_id: Settings.globus.transfer_endpoint_id
 )
-client.mkdir(user_id: 'mjgiarlo', work_id: 1234, work_version: 1)
+client.mkdir(user_id: 'mjgiarlo@stanford.edu', path: 'mjgiarlo/work1234/version1')
 
-result = client.user_exists?('mjgiarlo')
+result = client.user_exists?('mjgiarlo@stanford.edu')
 ```
 
 You can also invoke methods directly on the client class, which is useful in a
@@ -53,7 +53,11 @@ GlobusClient.configure(
 # app/services/my_globus_service.rb
 # ...
 def create_user_directory
-  GlobusClient.mkdir(user_id: 'mjgiarlo', work_id: 1234, work_version: 1)
+  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

@@ -11,27 +11,30 @@ GlobusClient.configure(
   transfer_endpoint_id: ENV["GLOBUS_ENDPOINT"]
 )
 
-user_id, work_id, work_version = *ARGV
+user_id, path = *ARGV
 
 # Test public API methods here.
-GlobusClient.mkdir(user_id:, work_id:, work_version:)
+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: user_id, work_id: work_id, work_version: work_version).send(:access_rule)["permissions"]
+before_permissions = GlobusClient::Endpoint.new(GlobusClient.config, user_id:, path:).send(:access_rule)["permissions"]
 
-files_count = GlobusClient.file_count(user_id:, work_id:, work_version:)
+files_count = GlobusClient.file_count(user_id:, path:)
 
-total_size = GlobusClient.total_size(user_id:, work_id:, work_version:)
+total_size = GlobusClient.total_size(user_id:, path:)
 
-GlobusClient.disallow_writes(user_id:, work_id:, work_version:)
+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: user_id, work_id: work_id, work_version: work_version).send(:access_rule)["permissions"]
+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}"

data/lib/globus_client/endpoint.rb

@@ -3,15 +3,15 @@
 class GlobusClient
   # The namespace for endpoint API operations
   class Endpoint
+    PATH_SEPARATOR = "/"
+
     # @param config [#token, #uploads_directory, #transfer_endpoint_id, #transfer_url, #auth_url] configuration for the gem
-    # @param user_id [String] conventionally, we use the SUNet ID, not an email address
-    # @param work_id [#to_s] the identifier of the work (e.g., an H2 work)
-    # @param work_version [#to_s] the version of the work (e.g., an H2 version)
-    def initialize(config, user_id:, work_id:, work_version:)
+    # @param path [String] the path to operate on
+    # @param user_id [String] a Globus user ID (e.g., a @stanford.edu email address)
+    def initialize(config, path:, user_id:)
       @config = config
       @user_id = user_id
-      @work_id = work_id
-      @work_version = work_version
+      @path = path
     end
 
     def file_count
@@ -56,9 +56,13 @@ class GlobusClient
       access_request(permissions: "r")
     end
 
+    def get_filenames
+      ls_path(full_path, [])
+    end
+
     private
 
-    attr_reader :config, :user_id, :work_id, :work_version
+    attr_reader :config, :path, :user_id
 
     def connection
       # Transfer API connection
@@ -68,17 +72,19 @@ class GlobusClient
       )
     end
 
-    def user
+    def globus_identity_id
       Identity.new(config).get_identity_id(user_id)
     end
 
     # Builds up a path from a list of path elements. E.g., input would look like:
-    #     ["mjgiarlo", "work123", "version1"]
+    #     "mjgiarlo/work123/version1"
     # And this method returns:
     #     ["/uploads/mjgiarlo/", "/uploads/mjgiarlo/work123/", "/uploads/mjgiarlo/work123/version1/"]
     def paths
       path_segments.map.with_index do |_segment, index|
-        File.join(config.uploads_directory, path_segments.slice(..index)).concat("/")
+        File
+          .join(config.uploads_directory, path_segments.slice(..index))
+          .concat(PATH_SEPARATOR)
       end
     end
 
@@ -88,7 +94,7 @@ class GlobusClient
     end
 
     def path_segments
-      [user_id, "work#{work_id}", "version#{work_version}"]
+      path.split(PATH_SEPARATOR)
     end
 
     def objects
@@ -103,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|
@@ -117,16 +140,16 @@ class GlobusClient
           req.body = {
             DATA_TYPE: "access",
             principal_type: "identity",
-            principal: user,
+            principal: globus_identity_id,
             path: full_path,
             permissions:,
-            notify_email: "#{user_id}@stanford.edu"
+            notify_email: user_id
           }.to_json
           req.headers["Content-Type"] = "application/json"
         end
       end
 
-      return response if response.success?
+      return true if response.success?
 
       UnexpectedResponse.call(response)
     end

data/lib/globus_client/identity.rb

@@ -7,8 +7,8 @@ class GlobusClient
       @config = config
     end
 
-    def get_identity_id(sunetid)
-      @email = "#{sunetid}@stanford.edu"
+    def get_identity_id(user_id)
+      @email = user_id
 
       response = lookup_identity
       UnexpectedResponse.call(response) unless response.success?
@@ -17,8 +17,8 @@ class GlobusClient
       extract_id(data)
     end
 
-    def exists?(sunetid)
-      get_identity_id(sunetid)
+    def exists?(user_id)
+      get_identity_id(user_id)
       true
     rescue
       false

data/lib/globus_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GlobusClient
-  VERSION = "0.4.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.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Aaron Collier
 - Laura Wrubel
 - Mike Giarlo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-07 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: []