modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 532a13898e83bd67cf04e925798b3650896608d5ff442dfa914de2863283f185
-  data.tar.gz: 1339f144efd62f1d6a8bf6d18872dece722854dae0e620133c47d62841ecac7a
+  metadata.gz: a2499ad41049cfca8eb8a9c6256721a6b6401ee528a681067b22f701aea56f25
+  data.tar.gz: 428b1bee894cbda110b6e463fa66edbfa43bcad236b80ae077dc4e003de7a90c
 SHA512:
-  metadata.gz: 7df9bb854141f00220a0e6520e7721593e14fc1d2e37053f145582e438beeb4d944f993fe3e7fc46fe78bc6ca9990db83fd6287fea746d5e949241f4545f5728
-  data.tar.gz: 7ba3abad5876a55d1b58c949ccaf88c0d9d0d4b5928d39e4d33f97c5e578f4b8d8317d5767490749855f1ae7856786834ad474b377853f850afb7a90929b82d2
+  metadata.gz: 6abf5ca2634d076ad4aa9d2d8e8954de8e638808cacbe28a085c1a177f44b2f688dc1f39f67de71d1032ebb05b98f805da6d6ee8dd7d675459fefb26468eff13
+  data.tar.gz: 05b48dcfea21479acff75bca8b21f2f5a46606bb04fbe56e9ae525b89ce95956c5f616cb0dbea0b65950ec1791e6c601fca3ed2b13681cde8010413d6a487b55

data/README.md

@@ -1,36 +1,31 @@
 # Modern Treasury Ruby API library
 
-The Modern Treasury Ruby library provides convenient access to the Modern Treasury REST API from any Ruby 3.0.0+
-application.
+The Modern Treasury Ruby library provides convenient access to the Modern Treasury REST API from any Ruby 3.1.0+ application.
 
 ## Documentation
 
-Documentation for the most recent release of this gem can be found [on RubyDoc](https://gemdocs.org/gems/modern_treasury/latest).
+Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/modern_treasury).
 
 The underlying REST API documentation can be found on [docs.moderntreasury.com](https://docs.moderntreasury.com).
 
 ## Installation
 
-To use this gem during the beta, install directly from GitHub with Bundler by
-adding the following to your application's `Gemfile`:
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
 
 ```ruby
-gem "modern_treasury", git: "https://github.com/Modern-Treasury/modern-treasury-ruby", branch: "main"
+gem "modern_treasury", "~> 0.1.0.pre.alpha.16"
 ```
 
+<!-- x-release-please-end -->
+
 To fetch an initial copy of the gem:
 
 ```sh
 bundle install
 ```
 
-To update the version used by your application when updates are pushed to
-GitHub:
-
-```sh
-bundle update modern_treasury
-```
-
 ## Usage
 
 ```ruby
@@ -47,16 +42,33 @@ counterparty = modern_treasury.counterparties.create(name: "my first counterpart
 puts(counterparty.id)
 ```
 
+### Pagination
+
+List methods in the Modern Treasury API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```ruby
+page = modern_treasury.counterparties.list
+
+# Fetch single item from page.
+counterparty = page.items[0]
+puts(counterparty.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |counterparty|
+  puts(counterparty.id)
+end
+```
+
 ### Errors
 
-When the library is unable to connect to the API, or if the API returns a
-non-success status code (i.e., 4xx or 5xx response), a subclass of
-`ModernTreasury::Error` will be thrown:
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `ModernTreasury::Error` will be thrown:
 
 ```ruby
 begin
   external_account = modern_treasury.external_accounts.create(counterparty_id: "missing")
-rescue ModernTreasury::Error => e
+rescue ModernTreasury::Errors::APIError => e
   puts(e.status) # 400
 end
 ```
@@ -72,17 +84,16 @@ Error codes are as followed:
 | HTTP 409         | `ConflictError`            |
 | HTTP 422         | `UnprocessableEntityError` |
 | HTTP 429         | `RateLimitError`           |
-| HTTP >=500       | `InternalServerError`      |
+| HTTP >= 500      | `InternalServerError`      |
 | Other HTTP error | `APIStatusError`           |
 | Timeout          | `APITimeoutError`          |
 | Network error    | `APIConnectionError`       |
 
 ### Retries
 
-Certain errors will be automatically retried 2 times by default, with a short
-exponential backoff. Connection errors (for example, due to a network
-connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors,
-and timeouts will all be retried by default.
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
 
 You can use the `max_retries` option to configure or disable this:
 
@@ -99,8 +110,8 @@ modern_treasury.counterparties.create(name: "my first counterparty", request_opt
 ### Timeouts
 
 By default, requests will time out after 60 seconds.
-Timeouts are applied separately to the initial connection and the overall request time,
-so in some cases a request could wait 2\*timeout seconds before it fails.
+
+Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2\*timeout seconds before it fails.
 
 You can use the `timeout` option to configure or disable this:
 
@@ -114,12 +125,89 @@ modern_treasury = ModernTreasury::Client.new(
 modern_treasury.counterparties.create(name: "my first counterparty", request_options: {timeout: 5})
 ```
 
+## LSP Support
+
+### Solargraph
+
+This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition.
+
+```ruby
+gem "solargraph", group: :development
+```
+
+After Solargraph is installed, **you must populate its index** either via the provided editor command, or by running the following in your terminal:
+
+```sh
+bundle exec solargraph gems
+```
+
+Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
+
+### Sorbet
+
+This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
+
+What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself.
+
+Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `ModernTreasury::BaseModel` class, you will need to use the `**` splat operator to pass the arguments:
+
+Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
+
+```ruby
+params = ModernTreasury::Models::CounterpartyCreateParams.new(name: "my first counterparty")
+
+modern_treasury.counterparties.create(**params)
+```
+
+Note: **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+
+### Ruby LSP
+
+The Ruby LSP has [best effort support](https://shopify.github.io/ruby-lsp/#guessed-types) for inferring type information from Ruby code, and as such it may not always be able to provide accurate type information.
+
+## Advanced
+
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API.
+
+If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a requests as seen in examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.
+
+```ruby
+response =
+  client.request(
+    method: :post,
+    path: '/undocumented/endpoint',
+    query: {"dog": "woof"},
+    headers: {"useful-header": "interesting-value"},
+    body: {"he": "llo"},
+  )
+```
+
+### Concurrency & Connection Pooling
+
+The `ModernTreasury::Client` instances are thread-safe, and should be re-used across multiple threads. By default, each `Client` have their own HTTP connection pool, with a maximum number of connections equal to thread count.
+
+When the maximum number of connections has been checked out from the connection pool, the `Client` will wait for an in use connection to become available. The queue time for this mechanism is accounted for by the per-request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+Currently, `ModernTreasury::Client` instances are only fork-safe if there are no in-flight HTTP requests.
+
 ## Versioning
 
-This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the
-library is in initial development and has a major version of `0`, APIs may change
-at any time.
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
 
 ## Requirements
 
-Ruby 3.0 or higher.
+Ruby 3.1.0 or higher.

data/lib/modern_treasury/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  class Client < ModernTreasury::BaseClient
+  class Client < ModernTreasury::Internal::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 
@@ -15,11 +15,9 @@ module ModernTreasury
     # Default max retry delay in seconds.
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
-    # Client option
     # @return [String]
     attr_reader :api_key
 
-    # Client option
     # @return [String]
     attr_reader :organization_id
 
@@ -134,25 +132,43 @@ module ModernTreasury
     # @return [ModernTreasury::Resources::LegalEntityAssociations]
     attr_reader :legal_entity_associations
 
-    # @private
+    # A test endpoint often used to confirm credentials and headers are being passed
+    # in correctly.
     #
-    # @return [Hash{String=>String}]
+    # @overload ping(request_options: {})
+    #
+    # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
+    #
+    # @return [ModernTreasury::Models::PingResponse]
+    #
+    # @see ModernTreasury::Models::ClientPingParams
+    def ping(params = {})
+      request(
+        method: :get,
+        path: "api/ping",
+        model: ModernTreasury::Models::PingResponse,
+        options: params[:request_options]
+      )
+    end
+
+    # @api private
     #
+    # @return [Hash{String=>String}]
     private def auth_headers
       return {} if @organization_id.nil? || @api_key.nil?
 
       base64_credentials = ["#{@organization_id}:#{@api_key}"].pack("m0")
-      {"Authorization" => "Basic #{base64_credentials}"}
+      {"authorization" => "Basic #{base64_credentials}"}
     end
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
-    #
     # @param api_key [String, nil] Defaults to `ENV["MODERN_TREASURY_API_KEY"]`
     #
     # @param organization_id [String, nil] Defaults to `ENV["MODERN_TREASURY_ORGANIZATION_ID"]`
     #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
     # @param timeout [Float]
@@ -162,11 +178,10 @@ module ModernTreasury
     # @param max_retry_delay [Float]
     #
     # @param idempotency_header [String]
-    #
     def initialize(
-      base_url: nil,
       api_key: ENV["MODERN_TREASURY_API_KEY"],
       organization_id: ENV["MODERN_TREASURY_ORGANIZATION_ID"],
+      base_url: nil,
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
@@ -176,10 +191,10 @@ module ModernTreasury
       base_url ||= "https://app.moderntreasury.com"
 
       if api_key.nil?
-        raise ArgumentError.new("api_key is required")
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"MODERN_TREASURY_API_KEY\"")
       end
       if organization_id.nil?
-        raise ArgumentError.new("organization_id is required")
+        raise ArgumentError.new("organization_id is required, and can be set via environ: \"MODERN_TREASURY_ORGANIZATION_ID\"")
       end
 
       @api_key = api_key.to_s
@@ -210,7 +225,8 @@ module ModernTreasury
       @ledgerable_events = ModernTreasury::Resources::LedgerableEvents.new(client: self)
       @ledger_account_categories = ModernTreasury::Resources::LedgerAccountCategories.new(client: self)
       @ledger_accounts = ModernTreasury::Resources::LedgerAccounts.new(client: self)
-      @ledger_account_balance_monitors = ModernTreasury::Resources::LedgerAccountBalanceMonitors.new(client: self)
+      @ledger_account_balance_monitors =
+        ModernTreasury::Resources::LedgerAccountBalanceMonitors.new(client: self)
       @ledger_account_statements = ModernTreasury::Resources::LedgerAccountStatements.new(client: self)
       @ledger_entries = ModernTreasury::Resources::LedgerEntries.new(client: self)
       @ledger_event_handlers = ModernTreasury::Resources::LedgerEventHandlers.new(client: self)

data/lib/modern_treasury/errors.rb

@@ -1,187 +1,192 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  class Error < StandardError
-    # @!parse
-    #   # @return [StandardError, nil]
-    #   attr_reader :cause
-  end
-
-  class ConversionError < ModernTreasury::Error
-  end
-
-  class APIError < ModernTreasury::Error
-    # @return [URI::Generic]
-    attr_reader :url
-
-    # @return [Integer, nil]
-    attr_reader :status
-
-    # @return [Object, nil]
-    attr_reader :body
-
-    # @private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer, nil]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    #
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
-      @url = url
-      @status = status
-      @body = body
-      @request = request
-      @response = response
-      super(message)
+  module Errors
+    class Error < StandardError
+      # @!parse
+      #   # @return [StandardError, nil]
+      #   attr_accessor :cause
     end
-  end
 
-  class APIConnectionError < ModernTreasury::APIError
-    # @!parse
-    #   # @return [nil]
-    #   attr_reader :status
-
-    # @!parse
-    #   # @return [nil]
-    #   attr_reader :body
-
-    # @private
-    #
-    # @param url [URI::Generic]
-    # @param status [nil]
-    # @param body [nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    #
-    def initialize(
-      url:,
-      status: nil,
-      body: nil,
-      request: nil,
-      response: nil,
-      message: "Connection error."
-    )
-      super
+    class ConversionError < ModernTreasury::Errors::Error
     end
-  end
 
-  class APITimeoutError < ModernTreasury::APIConnectionError
-    # @private
-    #
-    # @param url [URI::Generic]
-    # @param status [nil]
-    # @param body [nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    #
-    def initialize(
-      url:,
-      status: nil,
-      body: nil,
-      request: nil,
-      response: nil,
-      message: "Request timed out."
-    )
-      super
+    class APIError < ModernTreasury::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
     end
-  end
 
-  class APIStatusError < ModernTreasury::APIError
-    # @private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    #
-    # @return [ModernTreasury::APIStatusError]
-    #
-    def self.for(url:, status:, body:, request:, response:)
-      kwargs = {url: url, status: status, body: body, request: request, response: response}
-
-      case status
-      in 400
-        ModernTreasury::BadRequestError.new(**kwargs)
-      in 401
-        ModernTreasury::AuthenticationError.new(**kwargs)
-      in 403
-        ModernTreasury::PermissionDeniedError.new(**kwargs)
-      in 404
-        ModernTreasury::NotFoundError.new(**kwargs)
-      in 409
-        ModernTreasury::ConflictError.new(**kwargs)
-      in 422
-        ModernTreasury::UnprocessableEntityError.new(**kwargs)
-      in 429
-        ModernTreasury::RateLimitError.new(**kwargs)
-      in (500..)
-        ModernTreasury::InternalServerError.new(**kwargs)
-      else
-        ModernTreasury::APIStatusError.new(**kwargs)
+    class APIConnectionError < ModernTreasury::Errors::APIError
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :status
+
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
       end
     end
 
-    # @!parse
-    #   # @return [Integer]
-    #   attr_reader :status
-
-    # @private
-    #
-    # @param url [URI::Generic]
-    # @param status [Integer]
-    # @param body [Object, nil]
-    # @param request [nil]
-    # @param response [nil]
-    # @param message [String, nil]
-    #
-    def initialize(url:, status:, body:, request:, response:, message: nil)
-      message ||= {url: url.to_s, status: status, body: body}
-      super(
-        url: url,
-        status: status,
-        body: body,
-        request: request,
-        response: response,
-        message: message&.to_s
+    class APITimeoutError < ModernTreasury::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
       )
+        super
+      end
     end
-  end
 
-  class BadRequestError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 400
-  end
+    class APIStatusError < ModernTreasury::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [ModernTreasury::Errors::APIStatusError]
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+        kwargs = {
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case status
+        in 400
+          ModernTreasury::Errors::BadRequestError.new(**kwargs)
+        in 401
+          ModernTreasury::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          ModernTreasury::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          ModernTreasury::Errors::NotFoundError.new(**kwargs)
+        in 409
+          ModernTreasury::Errors::ConflictError.new(**kwargs)
+        in 422
+          ModernTreasury::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          ModernTreasury::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          ModernTreasury::Errors::InternalServerError.new(**kwargs)
+        else
+          ModernTreasury::Errors::APIStatusError.new(**kwargs)
+        end
+      end
 
-  class AuthenticationError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 401
-  end
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
 
-  class PermissionDeniedError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 403
-  end
+    class BadRequestError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
 
-  class NotFoundError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 404
-  end
+    class AuthenticationError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
 
-  class ConflictError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 409
-  end
+    class PermissionDeniedError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
 
-  class UnprocessableEntityError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 422
-  end
+    class NotFoundError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
 
-  class RateLimitError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 429
-  end
+    class ConflictError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
 
-  class InternalServerError < ModernTreasury::APIStatusError
-    HTTP_STATUS = (500..)
+    class RateLimitError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
   end
 end