globus_client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9de93796688ebf5d55d620e0cb290ed7e6b86f67ed1212e7847281ea5ac44d
-  data.tar.gz: b298b6a3744471cb4199e9c9f4ae2c69ece63dd9a3898dc058844d6bad22279c
+  metadata.gz: 23d56c1a01cd643aafec353ff36adf2ad15b4792ebbd3091745415d5fcce68eb
+  data.tar.gz: 0d6acdff1f5a627b6a9030bf1e5154c4efef845bab052c27d4d84206ee04c822
 SHA512:
-  metadata.gz: ad0fe7f847270e9534458577dda9a75dad2e83298f0d8232ee8ccd7eca6e127a7290db944ac4dac31cad2df7b42f3e2b7ecc4f273a75059c1c39de2cdf820b09
-  data.tar.gz: 3488ec985fee144991bbe90c29345a7717cae4e371a843bdb0947a6042128391bf7442e522c03494340acfb1ce31b61dc23ca7a30f05bedc667fc459bcfeaea8
+  metadata.gz: 6c6ea6b0df9c20fddb7157cd5c7a0dc3270308ce11805f1fbaebb35f704647e7bc4d097ab5a89edc68c1c87274d3adaa52abd6928d9c5d89a214eb99cf7193ac
+  data.tar.gz: e25b26ab750b5b176279e26de6887bafc9fc25cce8b406d2aabec931978858580d26f816e9c2c6e92e3b7cca81afaf1cee6aa84490f88c152a65c2d35ee8c3ec

data/Gemfile.lock

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

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,7 @@ 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
 # ...
 ```

data/api_test.rb

@@ -11,24 +11,24 @@ 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:)
 
 # 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}"

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
@@ -58,7 +58,7 @@ class GlobusClient
 
     private
 
-    attr_reader :config, :user_id, :work_id, :work_version
+    attr_reader :config, :path, :user_id
 
     def connection
       # Transfer API connection
@@ -68,17 +68,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 +90,7 @@ class GlobusClient
     end
 
     def path_segments
-      [user_id, "work#{work_id}", "version#{work_version}"]
+      path.split(PATH_SEPARATOR)
     end
 
     def objects
@@ -117,16 +119,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.5.0"
 end

metadata

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