globus_client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77e44f70f4c6ee02299ac4718e8ed5d1c2c88d58c71a4ba2c3bfbe970e2bb5df
-  data.tar.gz: b74fbc9c11f7b9c9fdadac074fe8709711f0065d03ab01fcecb159374446bb9b
+  metadata.gz: 7a4c2d5c57d5c7439a64bf4a0c9da297422987a026ff9eafdb38722df11de72c
+  data.tar.gz: 48b723cfdcad41ccd033dcb57ea2e09ad1da8ec139f7a98cf36a6c264565898c
 SHA512:
-  metadata.gz: 26d0923724fc1301b344b190d347abd25a1c6e17c57214f424df46d3739fc64ead270e9ae8eb3eddecdfc6700d6c52bc935cda654aef8109a01b45a5d187ca39
-  data.tar.gz: a5c9e21ec3917f8c560ed34eaefb38af1253cddd582223e1986a78d165301443b689875a20a96f24ef1eb514aca19fbc7994af52c1f441b5db60d9428592cd0b
+  metadata.gz: fc74c6a8123ff04756bffcb06e6f0765eba0aaa18c634dd1d4481767392f320aa57bf0dec54904b92d92d88c6fa239dff417fec6c372f0b5af7293f61dc00dcd
+  data.tar.gz: 1b0b02bcbfe3964fb4f8e526af347403654a93441ddebe8fb3ea3ea8bd5cde326a3327c026114a2309f6650d029f0c4c3484bd8a831a2b55867b1d67436fc5f4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.1.0)
+    globus_client (0.2.1)
       activesupport (>= 4.2, < 8)
       faraday
       zeitwerk
@@ -31,9 +31,10 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
+    language_server-protocol (3.17.0.1)
     minitest (5.16.3)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
     public_suffix (5.0.0)
     rainbow (3.1.1)
@@ -63,9 +64,9 @@ GEM
       rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.15.0)
+    rubocop-performance (1.15.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rspec (2.15.0)
@@ -78,9 +79,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.18.0)
+    standard (1.19.0)
+      language_server-protocol (= 3.17.0.1)
       rubocop (= 1.39.0)
-      rubocop-performance (= 1.15.0)
+      rubocop-performance (= 1.15.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
@@ -91,6 +93,7 @@ GEM
     zeitwerk (2.6.6)
 
 PLATFORMS
+  x86_64-darwin-19
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-linux
@@ -106,4 +109,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.19
+   2.3.26

data/README.md

@@ -32,6 +32,8 @@ client = Globus::Client.configure(
   transfer_endpoint_id: Settings.globus.transfer_endpoint_id
 )
 client.mkdir(user_id: 'mjgiarlo', work_id: 1234, work_version: 1)
+
+result = client.user_exists?('mjgiarlo')
 ```
 
 You can also invoke methods directly on the client class, which is useful in a
@@ -58,12 +60,31 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake spec` to run the tests. You can also run `bin/console` for an interactive
-prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Integration Testing
+
+To test that the gem works against the Globus APIs, run `api_test.rb` via:
+
+```shell
+# NOTE: This is bash syntax, YMMV
+$ export GLOBUS_CLIENT_ID=$(vault kv get -field=content puppet/application/sdr/globus/{prod|qa|stage}/client_id)
+$ 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
+
+Initial directory permissions: rw
+Number of files in directory: 2
+Total size of files in directory: 66669
+Final directory permissions: r
+```
+
+Inspect the output and compare it to what you see in Globus Personal Connect to determine if behavior is correct.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/globus_client.

data/api_test.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "globus/client"
+
+Globus::Client.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, work_id, work_version = *ARGV
+
+# Test public API methods here.
+Globus::Client.mkdir(user_id:, work_id:, work_version:)
+
+user_exists = Globus::Client.user_exists?(user_id)
+
+# Not part of the public API but this allows us to test access changes
+before_permissions = Globus::Client::Endpoint.new(Globus::Client.config, user_id: user_id, work_id: work_id, work_version: work_version).send(:access_rule)["permissions"]
+
+files_count = Globus::Client.file_count(user_id:, work_id:, work_version:)
+
+total_size = Globus::Client.total_size(user_id:, work_id:, work_version:)
+
+Globus::Client.disallow_writes(user_id:, work_id:, work_version:)
+
+# Not part of the public API but this allows us to test access changes
+after_permissions = Globus::Client::Endpoint.new(Globus::Client.config, user_id: user_id, work_id: work_id, work_version: work_version).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}"

data/lib/globus/client/endpoint.rb

@@ -15,22 +15,32 @@ module Globus
         @work_version = work_version
       end
 
-      # This is a temporary method to show parsing of data returned.
-      def length
+      def file_count
         objects["total"]
       end
 
+      def total_size
+        files.sum { |file| file["size"] }
+      end
+
       # Create a directory https://docs.globus.org/api/transfer/file_operations/#make_directory
       def mkdir
         # transfer API does not support recursive directory creation
         paths.each do |path|
-          response = call_mkdir(path)
+          response = connection.post("#{transfer_path}/mkdir") do |req|
+            req.headers["Content-Type"] = "application/json"
+            req.body = {
+              DATA_TYPE: "mkdir",
+              path:
+            }.to_json
+          end
+
           next if response.success?
 
-          # if directory already exists
+          # Ignore error if directory already exists
           if response.status == 502
             error = JSON.parse(response.body)
-            next if error["code"] == "ExternalError.MkdirFailedExists"
+            next if error["code"] == "ExternalError.MkdirFailed.Exists"
           end
 
           UnexpectedResponse.call(response)
@@ -38,11 +48,13 @@ module Globus
       end
 
       # Assign a user read/write permissions for a directory https://docs.globus.org/api/transfer/acl/#rest_access_create
-      def set_permissions
-        path = "#{config.uploads_directory}/#{user_id}/work#{work_id}/version#{work_version}/"
-        identity = Globus::Client::Identity.new(config)
-        id = identity.get_identity_id(user_id)
-        call_access(path:, id:, user_id:)
+      def allow_writes
+        access_request(permissions: "rw")
+      end
+
+      # Assign a user read-only permissions for a directory https://docs.globus.org/api/transfer/acl/#rest_access_create
+      def disallow_writes
+        access_request(permissions: "r")
       end
 
       private
@@ -57,6 +69,10 @@ module Globus
         )
       end
 
+      def user
+        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"]
       # And this method returns:
@@ -67,52 +83,79 @@ module Globus
         end
       end
 
+      # @see #paths
+      def full_path
+        paths.last
+      end
+
       def path_segments
         [user_id, "work#{work_id}", "version#{work_version}"]
       end
 
-      def endpoint
-        "/v0.10/operation/endpoint/#{config.transfer_endpoint_id}"
+      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
 
-      # @return [Faraday::Response]
-      def call_mkdir(path)
-        connection.post("#{endpoint}/mkdir") do |req|
-          req.headers["Content-Type"] = "application/json"
-          req.body = {
-            DATA_TYPE: "mkdir",
-            path:
-          }.to_json
+      def files
+        objects["DATA"].select { |object| object["DATA_TYPE"] == "file" }
+      end
+
+      def access_request(permissions:)
+        response = if access_rule_id
+          connection.put("#{access_path}/#{access_rule_id}") do |req|
+            req.body = {
+              DATA_TYPE: "access",
+              permissions:
+            }.to_json
+            req.headers["Content-Type"] = "application/json"
+          end
+        else
+          connection.post(access_path) do |req|
+            req.body = {
+              DATA_TYPE: "access",
+              principal_type: "identity",
+              principal: user,
+              path: full_path,
+              permissions:,
+              notify_email: "#{user_id}@stanford.edu"
+            }.to_json
+            req.headers["Content-Type"] = "application/json"
+          end
         end
+
+        return response if response.success?
+
+        UnexpectedResponse.call(response)
       end
 
-      # Makes the API call to Globus to set permissions
-      # @param path [String] the directory on the globus endpoint
-      # @param id [String] globus identifier associated with the user_id email
-      # @param user_id [String] user_id, not email address
-      # @return [Faraday::Response]
-      def call_access(path:, id:, user_id:)
-        response = connection.post("#{endpoint}/access") do |req|
-          req.body = {
-            DATA_TYPE: "access",
-            principal_type: "identity",
-            principal: id,
-            path:,
-            permissions: "rw",
-            notify_email: "#{user_id}@stanford.edu"
-          }.to_json
+      def access_rule
+        response = connection.get(access_list_path) do |req|
           req.headers["Content-Type"] = "application/json"
         end
-        UnexpectedResponse.call(response) unless response.success?
 
-        response
+        JSON
+          .parse(response.body)["DATA"]
+          .find { |acl| acl["path"] == full_path }
       end
 
-      def objects
-        # List files at an endpoint https://docs.globus.org/api/transfer/file_operations/#list_directory_contents
-        response = connection.get("#{endpoint}/ls")
-        UnexpectedResponse.call(response) unless response.success?
-        JSON.parse(response.body)
+      def access_rule_id
+        access_rule&.fetch("id")
+      end
+
+      def transfer_path
+        "/v0.10/operation/endpoint/#{config.transfer_endpoint_id}"
+      end
+
+      def access_path
+        "/v0.10/endpoint/#{config.transfer_endpoint_id}/access"
+      end
+
+      def access_list_path
+        "/v0.10/endpoint/#{config.transfer_endpoint_id}/access_list"
       end
     end
   end

data/lib/globus/client/identity.rb

@@ -18,6 +18,13 @@ module Globus
         extract_id(data)
       end
 
+      def exists?(sunetid)
+        get_identity_id(sunetid)
+        true
+      rescue
+        false
+      end
+
       private
 
       attr_reader :config

data/lib/globus/client/version.rb

@@ -2,6 +2,6 @@
 
 module Globus
   class Client
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/globus/client.rb

@@ -36,7 +36,7 @@ module Globus
         self
       end
 
-      delegate :mkdir, :config, to: :instance
+      delegate :config, :disallow_writes, :file_count, :mkdir, :total_size, :user_exists?, to: :instance
 
       def default_transfer_url
         "https://transfer.api.globusonline.org"
@@ -52,7 +52,27 @@ module Globus
     def mkdir(...)
       endpoint = Globus::Client::Endpoint.new(config, ...)
       endpoint.mkdir
-      endpoint.set_permissions
+      endpoint.allow_writes
+    end
+
+    def disallow_writes(...)
+      endpoint = Globus::Client::Endpoint.new(config, ...)
+      endpoint.disallow_writes
+    end
+
+    def file_count(...)
+      endpoint = Globus::Client::Endpoint.new(config, ...)
+      endpoint.file_count
+    end
+
+    def total_size(...)
+      endpoint = Globus::Client::Endpoint.new(config, ...)
+      endpoint.total_size
+    end
+
+    def user_exists?(...)
+      identity = Globus::Client::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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aaron Collier
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2022-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,6 +164,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- api_test.rb
 - globus_client.gemspec
 - lib/globus/client.rb
 - lib/globus/client/authenticator.rb