globus_client 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e189003b0a3f0592abd4fb7fabb006a3367f3cd330d83d7e46da2c2993bbbc21
-  data.tar.gz: 36c6ff9a70ddcfea7be6e1ca044b110adb536aa911adbb1626f5086737342d88
+  metadata.gz: e08e97fbfd4a9b84d55f71a12289777a097f650de25717e9823e6bc8654d2237
+  data.tar.gz: ca58e7a6b52206fa2bef9a57f65fb3481ceac9036d07ff3779f9a23e7fbd4b7a
 SHA512:
-  metadata.gz: 02cd08266cd52d2a3dd86ded97c8ce0085832fb446223375ab69164ed087187611e184e7cb4555208a0fb30b477e6c8b0e212041073cce2a3c328ddf6412e0c3
-  data.tar.gz: 1d54da5c74f41e1a98ecdf0296ee948e14a9e569ed1f58a20f52c96347b1b215a4121050cef2e9c7f3d25d525a5b061e9cfe79cc8517efb1ff896cb517226962
+  metadata.gz: fe82ef0a3bf4bf62ba8ea77d5d504915be2ccb860c28afdd7b2fcfab7231df1df205390d712b7ac83ff21346bd6a28c29c00672fa0bc80105a2a57c82e0bb697
+  data.tar.gz: d26b68220d051ab56d04ed21459a29c64b62fe24aa8012760ae80e0e02d8afd28de764248a7ad69e49292683262ecdc6ce268dbd9244e6bd2b48ab5628a6ed90

data/.rubocop.yml

@@ -1,6 +1,6 @@
 inherit_from: .rubocop_todo.yml
 
-require:
+plugins:
   - rubocop-performance
   - rubocop-rspec
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globus_client (0.15.0)
+    globus_client (0.17.0)
       activesupport (>= 4.2)
       faraday
       faraday-retry
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.1)
+    activesupport (8.0.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -25,76 +25,82 @@ GEM
       uri (>= 0.13.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
-    byebug (11.1.3)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.1)
+    byebug (12.0.0)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
+    connection_pool (2.5.3)
     crack (1.0.0)
       bigdecimal
       rexml
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.2)
     docile (1.4.1)
-    drb (2.2.1)
-    faraday (2.12.2)
+    drb (2.2.3)
+    faraday (2.13.1)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
     faraday-net_http (3.4.0)
       net-http (>= 0.5.0)
-    faraday-retry (2.2.1)
+    faraday-retry (2.3.1)
       faraday (~> 2.0)
-    hashdiff (1.1.2)
+    hashdiff (1.2.0)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.9.1)
-    language_server-protocol (3.17.0.4)
-    logger (1.6.6)
-    minitest (5.25.4)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
     net-http (0.6.0)
       uri
-    parallel (1.26.3)
-    parser (3.3.7.1)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    public_suffix (6.0.1)
+    prism (1.4.0)
+    public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
+    rake (13.3.0)
     regexp_parser (2.10.0)
-    rexml (3.4.0)
-    rspec (3.13.0)
+    rexml (3.4.1)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.4)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    rubocop (1.71.2)
+    rspec-support (3.13.4)
+    rubocop (1.75.8)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.23.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.4.0)
-      rubocop (~> 1.61)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     simplecov (0.22.0)
@@ -108,14 +114,15 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
-    webmock (3.25.0)
+    uri (1.0.3)
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.7.1)
+    zeitwerk (2.7.3)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-darwin-19
   x86_64-darwin-20
   x86_64-darwin-21
@@ -133,4 +140,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.4.13
+   2.6.9

data/lib/globus_client/endpoint.rb

@@ -53,7 +53,7 @@ class GlobusClient
 
     # Delete the access rule https://docs.globus.org/api/transfer/acl/#delete_access_rule
     def delete_access_rule
-      raise(StandardError, "Access rule not found for #{path}") unless access_rule_id
+      raise GlobusClient::AccessRuleNotFound, "Access rule not found for #{path}" unless access_rule_id
 
       GlobusClient.instance.delete(
         base_url: GlobusClient.config.transfer_url,
@@ -61,6 +61,28 @@ class GlobusClient
       )
     end
 
+    # Renames a directory https://docs.globus.org/api/transfer/file_operations/#rename
+    def rename(new_path:)
+      GlobusClient.instance.post(
+        base_url: GlobusClient.config.transfer_url,
+        path: "#{transfer_path}/rename",
+        body: { DATA_TYPE: 'rename', old_path: path, new_path: }
+      )
+    end
+
+    # @returns true if the file / directory exists at the path
+    # See https://docs.globus.org/api/transfer/file_operations/#stat
+    def exists?
+      GlobusClient.instance.get(
+        base_url: GlobusClient.config.transfer_url,
+        path: "#{transfer_path}/stat",
+        params: { path: }
+      )
+      true
+    rescue GlobusClient::ResourceNotFound
+      false
+    end
+
     private
 
     attr_reader :path, :user_id, :notify_email
@@ -146,7 +168,7 @@ class GlobusClient
     end
 
     def update_access_request(permissions:)
-      raise(StandardError, "Access rule not found for #{path}") unless access_rule_id
+      raise GlobusClient::AccessRuleNotFound, "Access rule not found for #{path}" unless access_rule_id
 
       GlobusClient.instance.put(
         base_url: GlobusClient.config.transfer_url,

data/lib/globus_client/endpoint_manager.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class GlobusClient
+  # The namespace for endpoint management API operations
+  class EndpointManager
+    IN_PROGRESS_STATUSES = %w[ACTIVE INACTIVE].freeze
+
+    # List tasks for the configured transfer endpoint
+    # https://docs.globus.org/api/transfer/advanced_collection_management/#get_tasks
+    # Note that this method does not support pagination, as there are unlikely to be many tasks.
+    # Also note that if destination_path is provided, only transfer tasks will be returned.
+    # @param owner_id [String] the Globus user ID (a UUID, not email address)
+    # @param status [Array] the status of the tasks to filter on. Values are ACTIVE, INACTIVE, SUCCEEDED, or FAILED.
+    # @param destination_path [String] the destination path to filter tasks by
+    # @return [Array] list of task documents
+    def task_list(owner_id: nil, status: [], destination_path: nil)
+      tasks = GlobusClient.instance.get(
+        base_url: GlobusClient.config.transfer_url,
+        path: '/v0.10/endpoint_manager/task_list',
+        params: task_list_params(owner_id:, status:)
+      )['DATA']
+      return tasks unless destination_path
+
+      destination_base_path = destination_path.delete_suffix('/') << '/'
+      tasks.select { |task| task['destination_base_path']&.start_with?(destination_base_path) }
+    end
+
+    # @param owner_id [String] the Globus user ID (a UUID, not email address)
+    # @param destination_path [String] the destination path to filter tasks by
+    # @return [boolean] true if there are tasks in progress
+    def tasks_in_progress?(owner_id: nil, destination_path: nil)
+      task_list(owner_id:, destination_path:, status: IN_PROGRESS_STATUSES).present?
+    end
+
+    private
+
+    def task_list_params(owner_id:, status:)
+      {
+        filter_endpoint: GlobusClient.config.transfer_endpoint_id,
+        filter_owner_id: owner_id,
+        filter_status: Array(status).join(',').presence
+      }.compact
+    end
+  end
+end

data/lib/globus_client/errors.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class GlobusClient
+  # Holds all of the client's custom exception classes
+  module Errors
+    # Error raised when the Globus Auth or Transfer API returns a 400 error
+    class BadRequestError < StandardError; end
+
+    # Error raised by the Globus Auth API returns a 401 Unauthorized
+    class UnauthorizedError < StandardError; end
+
+    # Error raised when the Globus Auth or Transfer API returns a 403 Forbidden
+    class ForbiddenError < StandardError; end
+
+    # Error raised when the Globus Auth or Transfer API returns a 404 NotFound
+    class ResourceNotFound < StandardError; end
+
+    # Error raised when a consumer acts upon an access rule that was not found
+    class AccessRuleNotFound < StandardError; end
+
+    # Error raised when response has an unexpected error (e.g., an HTTP 500)
+    class InternalServerError < StandardError; end
+
+    # Error raised when the Globus Transfer API returns a 502 Bad Gateway
+    class EndpointError < StandardError; end
+
+    # Error raised when the remote server returns a 503 Bad Gateway
+    class ServiceUnavailable < StandardError; end
+  end
+end

data/lib/globus_client/unexpected_response.rb

@@ -3,24 +3,6 @@
 class GlobusClient
   # Handles unexpected responses when communicating with Globus
   class UnexpectedResponse
-    # Error raised when the Globus Auth or Transfer API returns a 400 error
-    class BadRequestError < StandardError; end
-
-    # Error raised by the Globus Auth API returns a 401 Unauthorized
-    class UnauthorizedError < StandardError; end
-
-    # Error raised when the Globus Auth or Transfer API returns a 403 Forbidden
-    class ForbiddenError < StandardError; end
-
-    # Error raised when the Globus Auth or Transfer API returns a 404 NotFound
-    class ResourceNotFound < StandardError; end
-
-    # Error raised when the Globus Transfer API returns a 502 Bad Gateway
-    class EndpointError < StandardError; end
-
-    # Error raised when the remote server returns a 503 Bad Gateway
-    class ServiceUnavailable < StandardError; end
-
     # @param [Faraday::Response] response
     # https://docs.globus.org/api/transfer/file_operations/#common_errors
     # https://docs.globus.org/api/transfer/file_operations/#errors
@@ -29,19 +11,19 @@ class GlobusClient
     def self.call(response)
       case response.status
       when 400
-        raise BadRequestError, "Invalid path or another error with the request: #{response.body}"
+        raise GlobusClient::BadRequestError, "Invalid path or another error with the request: #{response.body}"
       when 401
-        raise UnauthorizedError, "There was a problem with the access token: #{response.body} "
+        raise GlobusClient::UnauthorizedError, "There was a problem with the access token: #{response.body} "
       when 403
-        raise ForbiddenError, "The operation requires privileges which the client does not have: #{response.body}"
+        raise GlobusClient::ForbiddenError, "The operation requires privileges which the client does not have: #{response.body}"
       when 404
-        raise ResourceNotFound, "Endpoint ID not found or resource does not exist: #{response.body}"
+        raise GlobusClient::ResourceNotFound, "Endpoint ID not found or resource does not exist: #{response.body}"
       when 502
-        raise EndpointError, "Other error with endpoint: #{response.status} #{response.body}."
+        raise GlobusClient::EndpointError, "Other error with endpoint: #{response.status} #{response.body}."
       when 503
-        raise ServiceUnavailable, 'The service is down for maintenance.'
+        raise GlobusClient::ServiceUnavailable, 'The service is down for maintenance.'
       else
-        raise StandardError, "Unexpected response: #{response.status} #{response.body}."
+        raise GlobusClient::InternalServerError, "Unexpected response: #{response.status} #{response.body}."
       end
     end
   end

data/lib/globus_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GlobusClient
-  VERSION = '0.15.0'
+  VERSION = '0.17.0'
 end

data/lib/globus_client.rb

@@ -12,6 +12,7 @@ Zeitwerk::Loader.for_gem.setup
 
 # Client for interacting with the Globus API
 class GlobusClient # rubocop:disable Metrics/ClassLength
+  include Errors
   include Singleton
 
   class << self
@@ -48,8 +49,9 @@ class GlobusClient # rubocop:disable Metrics/ClassLength
     end
     # rubocop:enable Metrics/ParameterLists
 
-    delegate :config, :disallow_writes, :delete_access_rule, :file_count, :list_files, :mkdir, :total_size,
-             :user_valid?, :get_filenames, :has_files?, :delete, :get, :post, :put, to: :instance
+    delegate :config, :disallow_writes, :allow_writes, :delete_access_rule, :file_count, :list_files, :mkdir, :rename, :total_size,
+             :user_valid?, :get_filenames, :has_files?, :exists?, :task_list, :tasks_in_progress?,
+             :delete, :get, :post, :put, to: :instance
 
     def default_transfer_url
       'https://transfer.api.globusonline.org'
@@ -152,12 +154,24 @@ class GlobusClient # rubocop:disable Metrics/ClassLength
       .disallow_writes
   end
 
+  def allow_writes(...)
+    Endpoint
+      .new(...)
+      .allow_writes
+  end
+
   def delete_access_rule(...)
     Endpoint
       .new(...)
       .delete_access_rule
   end
 
+  def rename(new_path:, **args)
+    Endpoint
+      .new(**args)
+      .rename(new_path:)
+  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`
@@ -191,12 +205,30 @@ class GlobusClient # rubocop:disable Metrics/ClassLength
       .has_files?
   end
 
+  def exists?(...)
+    Endpoint
+      .new(...)
+      .exists?
+  end
+
   def user_valid?(...)
     Identity
       .new
       .valid?(...)
   end
 
+  def task_list(...)
+    EndpointManager
+      .new
+      .task_list(...)
+  end
+
+  def tasks_in_progress?(...)
+    EndpointManager
+      .new
+      .tasks_in_progress?(...)
+  end
+
   private
 
   Config = Struct.new(:client_id, :auth_url, :client_secret, :transfer_endpoint_id, :transfer_url, :uploads_directory, :token, keyword_init: true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Aaron Collier
@@ -9,7 +9,7 @@ authors:
 - Mike Giarlo
 bindir: exe
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,6 +89,8 @@ files:
 - lib/globus_client.rb
 - lib/globus_client/authenticator.rb
 - lib/globus_client/endpoint.rb
+- lib/globus_client/endpoint_manager.rb
+- lib/globus_client/errors.rb
 - lib/globus_client/identity.rb
 - lib/globus_client/unexpected_response.rb
 - lib/globus_client/version.rb
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Interface for interacting with the Globus API.
 test_files: []