globus_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b27d41e017d13090e7a92e046534b7f0cee1fa368fb56599cdbafdcd8e10e5b6
-  data.tar.gz: a265b2f06f90e90ada9bb8c89f5ded515ace614dbf107aabff94ad0c8ec810d3
+  metadata.gz: 77e44f70f4c6ee02299ac4718e8ed5d1c2c88d58c71a4ba2c3bfbe970e2bb5df
+  data.tar.gz: b74fbc9c11f7b9c9fdadac074fe8709711f0065d03ab01fcecb159374446bb9b
 SHA512:
-  metadata.gz: 3415d9b36af6b543b62b1c723ef7fd4caa601cff3f727e5657b052eb341c28efe208188d36a2c39181f56f1a88016b5f79a3f3a7f932ba979765b94dc18d7931
-  data.tar.gz: a8a480efefdeccc418ce7a2e0cd3b25905f4ea426cfd40dd4c886e7f39e4ea7457a474297d83b6d98d162153bf2fd980f83b83b908d83bd6109d3498195aff80
+  metadata.gz: 26d0923724fc1301b344b190d347abd25a1c6e17c57214f424df46d3739fc64ead270e9ae8eb3eddecdfc6700d6c52bc935cda654aef8109a01b45a5d187ca39
+  data.tar.gz: a5c9e21ec3917f8c560ed34eaefb38af1253cddd582223e1986a78d165301443b689875a20a96f24ef1eb514aca19fbc7994af52c1f441b5db60d9428592cd0b

data/.autoupdate/postupdate

@@ -0,0 +1,19 @@
+#!/bin/bash --login
+
+# This script is called by our weekly dependency update job in Jenkins after updating Ruby and other deps
+
+# Switch to Ruby 3.1 for Globus::Client (3.0 is default in Jenkinsfile)
+rvm use 3.1.2@globus_client --create &&
+    gem install bundler &&
+    bundle install --gemfile Gemfile
+
+standardrb --fix > globus_client_standard.txt
+
+retVal=$?
+
+git commit -am "Update to latest standard style guide"
+
+if [ $retVal -ne 0 ]; then
+    echo "ERROR UPDATING RUBY TO STANDARD STYLE (globus_client)"
+    cat globus_client_standard.txt
+fi

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop/custom.yml

@@ -0,0 +1,50 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  DisplayCopNames: true
+  SuggestExtensions: false
+  Exclude:
+    - bin/**
+    - vendor/bundle/**/*
+
+# Per team developer playbook
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11
+  Enabled: true
+RSpec/ClassCheck: # new in 2.13
+  Enabled: true
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+RSpec/NoExpectationExample: # new in 2.13
+  Enabled: true
+RSpec/SortMetadata: # new in 2.14
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true
+RSpec/Capybara/NegationMatcher: # new in 2.14
+  Enabled: true
+RSpec/Capybara/SpecificActions: # new in 2.14
+  Enabled: true
+RSpec/Capybara/SpecificFinders: # new in 2.13
+  Enabled: true
+RSpec/Capybara/SpecificMatcher: # new in 2.12
+  Enabled: true
+RSpec/FactoryBot/ConsistentParenthesesStyle: # new in 2.14
+  Enabled: true
+RSpec/FactoryBot/SyntaxMethods: # new in 2.7
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true
+RSpec/Rails/HaveHttpStatus: # new in 2.12
+  Enabled: true
+RSpec/Rails/InferredSpecType: # new in 2.14
+  Enabled: true

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
+
+inherit_from:
+  - .rubocop/custom.yml
+  - .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-10-27 22:53:23 UTC using RuboCop version 1.37.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.standard.yml

@@ -0,0 +1 @@
+parallel: true

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in globus_client.gemspec
+gemspec
+
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    globus_client (0.1.0)
+      activesupport (>= 4.2, < 8)
+      faraday
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.7.1)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.18.0)
+      rubocop (= 1.39.0)
+      rubocop-performance (= 1.15.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  globus_client!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop-rspec
+  simplecov
+  standard
+  webmock
+
+BUNDLED WITH
+   2.3.19

data/LICENSE

@@ -0,0 +1,15 @@
+
+Copyright (c) 2022 by The Board of Trustees of the Leland Stanford
+Junior University.  All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License.  You
+may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.

data/README.md

@@ -0,0 +1,69 @@
+[![Gem Version](https://badge.fury.io/rb/globus_client.svg)](https://badge.fury.io/rb/globus_client)
+[![CircleCI](https://circleci.com/gh/sul-dlss/globus_client.svg?style=svg)](https://circleci.com/gh/sul-dlss/globus_client)
+[![Code Climate](https://codeclimate.com/github/sul-dlss/globus_client/badges/gpa.svg)](https://codeclimate.com/github/sul-dlss/globus_client)
+[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/8e6bf1a5d3fc86a6fbd0/test_coverage)](https://codeclimate.com/github/sul-dlss/globus_client/test_coverage)
+
+# Globus::Client
+
+Globus::Client is a Ruby gem that acts as a client to the RESTful HTTP APIs provided by the [Globus service](https://docs.globus.org/api/).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add globus_client
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install globus_client
+
+## Usage
+
+For one-off requests:
+
+```ruby
+require 'globus/client'
+
+# NOTE: The settings below live in the consumer, not in the gem.
+client = Globus::Client.configure(
+  client_id: Settings.globus.client_id,
+  client_secret: Settings.globus.client_secret,
+  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)
+```
+
+You can also invoke methods directly on the client class, which is useful in a
+Rails application environment where you might initialize the client in an
+initializer and then invoke client methods in many other contexts where you want
+to be sure configuration has already occurred, e.g.:
+
+```ruby
+# config/initializers/globus_client.rb
+Globus::Client.configure(
+  client_id: Settings.globus.client_id,
+  client_secret: Settings.globus.client_secret,
+  uploads_directory: Settings.globus.uploads_directory,
+  transfer_endpoint_id: Settings.globus.transfer_endpoint_id
+)
+
+# app/services/my_globus_service.rb
+# ...
+def create_user_directory
+  Globus::Client.mkdir(user_id: 'mjgiarlo', work_id: 1234, work_version: 1)
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/globus_client.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/globus_client.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "globus/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "globus_client"
+  spec.version = Globus::Client::VERSION
+  spec.authors = ["Aaron Collier", "Laura Wrubel", "Mike Giarlo"]
+  spec.email = ["aaron.collier@stanford.edu", "lwrubel@stanford.edu", "mjgiarlo@stanford.edu"]
+
+  spec.summary = "Interface for interacting with the Globus API."
+  spec.description = "This provides API interaction with the Globus API"
+  spec.homepage = "https://github.com/sul-dlss/globus_client"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sul-dlss/globus_client"
+  spec.metadata["changelog_uri"] = "https://github.com/sul-dlss/globus_client/releases"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.2", "< 8"
+  spec.add_dependency "faraday"
+  spec.add_dependency "zeitwerk"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+end

data/lib/globus/client/authenticator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Globus
+  class Client
+    # The namespace for the "login" command
+    class Authenticator
+      def self.token(client_id, client_secret, auth_url)
+        new(client_id, client_secret, auth_url).token
+      end
+
+      def initialize(client_id, client_secret, auth_url)
+        @client_id = client_id
+        @client_secret = client_secret
+        @auth_url = auth_url
+      end
+
+      # Request an access_token
+      def token
+        response = connection.post("/v2/oauth2/token", form_data)
+
+        JSON.parse(response.body)["access_token"]
+      end
+
+      private
+
+      attr_reader :client_id, :client_secret, :auth_url
+
+      def connection
+        Faraday.new(url: auth_url)
+      end
+
+      def form_data
+        {
+          client_id:,
+          client_secret:,
+          encoding: "form",
+          grant_type: "client_credentials",
+          scope: "urn:globus:auth:scope:transfer.api.globus.org:all"
+        }
+      end
+    end
+  end
+end

data/lib/globus/client/endpoint.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Globus
+  class Client
+    # The namespace for endpoint API operations
+    class Endpoint
+      # @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:)
+        @config = config
+        @user_id = user_id
+        @work_id = work_id
+        @work_version = work_version
+      end
+
+      # This is a temporary method to show parsing of data returned.
+      def length
+        objects["total"]
+      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)
+          next if response.success?
+
+          # if directory already exists
+          if response.status == 502
+            error = JSON.parse(response.body)
+            next if error["code"] == "ExternalError.MkdirFailedExists"
+          end
+
+          UnexpectedResponse.call(response)
+        end
+      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:)
+      end
+
+      private
+
+      attr_reader :config, :user_id, :work_id, :work_version
+
+      def connection
+        # Transfer API connection
+        Faraday.new(
+          url: config.transfer_url,
+          headers: {Authorization: "Bearer #{config.token}"}
+        )
+      end
+
+      # Builds up a path from a list of path elements. E.g., input would look like:
+      #     ["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("/")
+        end
+      end
+
+      def path_segments
+        [user_id, "work#{work_id}", "version#{work_version}"]
+      end
+
+      def endpoint
+        "/v0.10/operation/endpoint/#{config.transfer_endpoint_id}"
+      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
+        end
+      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
+          req.headers["Content-Type"] = "application/json"
+        end
+        UnexpectedResponse.call(response) unless response.success?
+
+        response
+      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)
+      end
+    end
+  end
+end

data/lib/globus/client/identity.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Globus
+  class Client
+    # Lookup of a Globus identity ID
+    class Identity
+      def initialize(config)
+        @config = config
+      end
+
+      def get_identity_id(sunetid)
+        @email = "#{sunetid}@stanford.edu"
+
+        response = lookup_identity
+        UnexpectedResponse.call(response) unless response.success?
+
+        data = JSON.parse(response.body)
+        extract_id(data)
+      end
+
+      private
+
+      attr_reader :config
+
+      def connection
+        Faraday.new(url: config.auth_url)
+      end
+
+      def lookup_identity
+        id_endpoint = "/v2/api/identities"
+        connection.get(id_endpoint) do |req|
+          req.params["usernames"] = @email
+          req.headers["Authorization"] = "Bearer #{config.token}"
+        end
+      end
+
+      def extract_id(data)
+        identities = data["identities"]
+        # Select identity with "used" or "private" status
+        matching_users = identities.select { |id| id["username"] == @email }
+        active_users = matching_users.select { |user| (user["status"] == "used" || user["status"] == "private") }
+        raise "No matching active Globus user found for #{@email}." if active_users.empty?
+
+        active_users.first["id"]
+      end
+    end
+  end
+end

data/lib/globus/client/unexpected_response.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Globus
+  class Client
+    # 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
+      # https://docs.globus.org/api/transfer/acl/#common_errors
+      # https://docs.globus.org/api/auth/reference/
+      def self.call(response)
+        case response.status
+        when 400
+          raise 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} "
+        when 403
+          raise 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}"
+        when 502
+          raise EndpointError, "Other error with endpoint: #{response.body}"
+        when 503
+          raise ServiceUnavailable, "The service is down for maintenance."
+        else
+          raise StandardError, "Unexpected response: #{response.status} #{response.body}"
+        end
+      end
+    end
+  end
+end

data/lib/globus/client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Globus
+  class Client
+    VERSION = "0.2.0"
+  end
+end

data/lib/globus/client.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation"
+require "faraday"
+require "ostruct"
+require "singleton"
+require "zeitwerk"
+
+# Load the gem's internal dependencies
+loader = Zeitwerk::Loader.new
+loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
+loader.push_dir(File.absolute_path("#{__FILE__}/../.."))
+loader.setup
+
+module Globus
+  # Client for interacting with the Globus API
+  class Client
+    include Singleton
+
+    class << self
+      # @param client_id [String] the client identifier registered with Globus
+      # @param client_secret [String] the client secret to authenticate with Globus
+      # @param uploads_directory [String] where to upload files
+      # @param transfer_endpoint_id [String] the transfer API endpoint ID supplied by Globus
+      # @param transfer_url [String] the transfer API URL
+      # @param auth_url [String] the authentication API URL
+      def configure(client_id:, client_secret:, uploads_directory:, transfer_endpoint_id:, transfer_url: default_transfer_url, auth_url: default_auth_url)
+        instance.config = OpenStruct.new(
+          token: Globus::Client::Authenticator.token(client_id, client_secret, auth_url),
+          uploads_directory:,
+          transfer_endpoint_id:,
+          transfer_url:,
+          auth_url:
+        )
+
+        self
+      end
+
+      delegate :mkdir, :config, to: :instance
+
+      def default_transfer_url
+        "https://transfer.api.globusonline.org"
+      end
+
+      def default_auth_url
+        "https://auth.globus.org"
+      end
+    end
+
+    attr_accessor :config
+
+    def mkdir(...)
+      endpoint = Globus::Client::Endpoint.new(config, ...)
+      endpoint.mkdir
+      endpoint.set_permissions
+    end
+  end
+end

data/sig/globus_client.rbs

@@ -0,0 +1,4 @@
+module GlobusClient
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: globus_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aaron Collier
-autorequire:
+- Laura Wrubel
+- Mike Giarlo
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,7 +33,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8'
 - !ruby/object:Gem::Dependency
-  name: config
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,7 +47,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,19 +89,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -145,10 +147,31 @@ dependencies:
 description: This provides API interaction with the Globus API
 email:
 - aaron.collier@stanford.edu
+- lwrubel@stanford.edu
+- mjgiarlo@stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".autoupdate/postupdate"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop/custom.yml"
+- ".rubocop_todo.yml"
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- globus_client.gemspec
+- lib/globus/client.rb
+- lib/globus/client/authenticator.rb
+- lib/globus/client/endpoint.rb
+- lib/globus/client/identity.rb
+- lib/globus/client/unexpected_response.rb
+- lib/globus/client/version.rb
+- sig/globus_client.rbs
 homepage: https://github.com/sul-dlss/globus_client
 licenses: []
 metadata:
@@ -156,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
@@ -171,8 +194,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Interface for interacting with the Globus API.
 test_files: []