modern_treasury 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

data/README.md

@@ -1,12 +1,12 @@
 # Modern Treasury Ruby API library
 
-The Modern Treasury Ruby library provides convenient access to the Modern Treasury REST API from any Ruby 3.1.0+ application.
+The Modern Treasury Ruby library provides convenient access to the Modern Treasury REST API from any Ruby 3.2.0+ application.
 
 ## Documentation
 
-Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/modern_treasury).
+Documentation for releases 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).
+The REST API documentation can be found on [docs.moderntreasury.com](https://docs.moderntreasury.com).
 
 ## Installation
 
@@ -15,17 +15,11 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "modern_treasury", "~> 0.1.0.pre.alpha.16"
+gem "modern_treasury", "~> 0.1.0.pre.alpha.19"
 ```
 
 <!-- x-release-please-end -->
 
-To fetch an initial copy of the gem:
-
-```sh
-bundle install
-```
-
 ## Usage
 
 ```ruby
@@ -33,8 +27,8 @@ require "bundler/setup"
 require "modern_treasury"
 
 modern_treasury = ModernTreasury::Client.new(
-  organization_id: "my-organization-ID", # defaults to ENV["MODERN_TREASURY_ORGANIZATION_ID"]
-  api_key: "My API Key" # defaults to ENV["MODERN_TREASURY_API_KEY"]
+  organization_id: ENV["MODERN_TREASURY_ORGANIZATION_ID"], # This is the default and can be omitted
+  api_key: ENV["MODERN_TREASURY_API_KEY"] # This is the default and can be omitted
 )
 
 counterparty = modern_treasury.counterparties.create(name: "my first counterparty")
@@ -42,6 +36,16 @@ counterparty = modern_treasury.counterparties.create(name: "my first counterpart
 puts(counterparty.id)
 ```
 
+## Sorbet
+
+This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
+
+When using sorbet, it is recommended to use model classes as below. This provides stronger type checking and tooling integration.
+
+```ruby
+modern_treasury.counterparties.create(name: "my first counterparty")
+```
+
 ### Pagination
 
 List methods in the Modern Treasury API are paginated.
@@ -61,9 +65,34 @@ page.auto_paging_each do |counterparty|
 end
 ```
 
+### File uploads
+
+Request parameters that correspond to file uploads can be passed as `StringIO`, or a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance.
+
+```ruby
+require "pathname"
+
+# using `Pathname`, the file will be lazily read, without reading everything in to memory
+document = modern_treasury.documents.create(
+  documentable_id: "24c6b7a3-02...",
+  documentable_type: "counterparties",
+  file: Pathname("my/file.txt")
+)
+
+file = File.read("my/file.txt")
+# using `StringIO`, useful if you already have the data in memory
+document = modern_treasury.documents.create(
+  documentable_id: "24c6b7a3-02...",
+  documentable_type: "counterparties",
+  file: StringIO.new(file)
+)
+
+puts(document.id)
+```
+
 ### 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::Errors::APIError` will be thrown:
 
 ```ruby
 begin
@@ -73,7 +102,7 @@ rescue ModernTreasury::Errors::APIError => e
 end
 ```
 
-Error codes are as followed:
+Error codes are as follows:
 
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
@@ -125,54 +154,32 @@ 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
+## Model DSL
 
-This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
+This library uses a simple DSL to represent request parameters and response shapes in `lib/modern_treasury/models`.
 
-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.
+With the right [editor plugins](https://shopify.github.io/ruby-lsp), you can ctrl-click on elements of the DSL to navigate around and explore the library.
 
-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.
+In all places where a `BaseModel` type is specified, vanilla Ruby `Hash` can also be used. For example, the following are interchangeable as arguments:
 
 ```ruby
+# This has tooling readability, for auto-completion, static analysis, and goto definition with supported language services
 params = ModernTreasury::Models::CounterpartyCreateParams.new(name: "my first counterparty")
 
-modern_treasury.counterparties.create(**params)
+# This also works
+params = {
+  name: "my first counterparty"
+}
 ```
 
-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
+## Editor support
 
-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.
+A combination of [Shopify LSP](https://shopify.github.io/ruby-lsp) and [Solargraph](https://solargraph.org/) is recommended for non-[Sorbet](https://sorbet.org) users. The former is especially good at go to definition, while the latter has much better auto-completion support.
 
-## Advanced
+## Advanced concepts
 
 ### 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.
@@ -182,17 +189,16 @@ If you want to explicitly send an extra param, you can do so with the `extra_que
 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"},
-  )
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"he": "llo"},
+)
 ```
 
-### Concurrency & Connection Pooling
+### 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.
 
@@ -202,6 +208,30 @@ Unless otherwise specified, other classes in the SDK do not have locks protectin
 
 Currently, `ModernTreasury::Client` instances are only fork-safe if there are no in-flight HTTP requests.
 
+### Sorbet
+
+#### Enums
+
+Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbet.org/docs/tenum) from the `sorbet-runtime` gem.
+
+Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead.
+
+```ruby
+module ModernTreasury::AccountsType
+  # This alias aids language service driven navigation.
+  TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::AccountsType) }
+end
+```
+
+#### Argument passing trick
+
+It is possible to pass a compatible model / parameter class to a method that expects keyword arguments by using the `**` splat operator.
+
+```ruby
+params = ModernTreasury::Models::CounterpartyCreateParams.new(name: "my first counterparty")
+modern_treasury.counterparties.create(**params)
+```
+
 ## 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.
@@ -210,4 +240,8 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.1.0 or higher.
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/Modern-Treasury/modern-treasury-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Modern Treasury please follow the respective company's security reporting guidelines.
+
+### Modern Treasury Terms and Policies
+
+Please contact sdk-feedback@moderntreasury.com for any questions or concerns regarding security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/modern_treasury/client.rb

@@ -139,14 +139,14 @@ module ModernTreasury
     #
     # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
     #
-    # @return [ModernTreasury::Models::PingResponse]
+    # @return [ModernTreasury::PingResponse]
     #
     # @see ModernTreasury::Models::ClientPingParams
     def ping(params = {})
       request(
         method: :get,
         path: "api/ping",
-        model: ModernTreasury::Models::PingResponse,
+        model: ModernTreasury::PingResponse,
         options: params[:request_options]
       )
     end
@@ -167,7 +167,8 @@ module ModernTreasury
     #
     # @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 base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["MODERN_TREASURY_BASE_URL"]`
     #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
@@ -181,11 +182,11 @@ module ModernTreasury
     def initialize(
       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,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY,
+      base_url: ENV["MODERN_TREASURY_BASE_URL"],
+      max_retries: ModernTreasury::Client::DEFAULT_MAX_RETRIES,
+      timeout: ModernTreasury::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: ModernTreasury::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: ModernTreasury::Client::DEFAULT_MAX_RETRY_DELAY,
       idempotency_header: "Idempotency-Key"
     )
       base_url ||= "https://app.moderntreasury.com"

data/lib/modern_treasury/errors.rb

@@ -3,9 +3,9 @@
 module ModernTreasury
   module Errors
     class Error < StandardError
-      # @!parse
-      #   # @return [StandardError, nil]
-      #   attr_accessor :cause
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
     end
 
     class ConversionError < ModernTreasury::Errors::Error
@@ -40,13 +40,13 @@ module ModernTreasury
     end
 
     class APIConnectionError < ModernTreasury::Errors::APIError
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :status
+      # @!attribute status
+      #
+      #   @return [nil]
 
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :body
+      # @!attribute body
+      #
+      #   @return [nil]
 
       # @api private
       #
@@ -99,7 +99,7 @@ module ModernTreasury
       # @param response [nil]
       # @param message [String, nil]
       #
-      # @return [ModernTreasury::Errors::APIStatusError]
+      # @return [self]
       def self.for(url:, status:, body:, request:, response:, message: nil)
         kwargs = {
           url: url,

data/lib/modern_treasury/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        else
+          filename.nil? ? nil : ::File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end

data/lib/modern_treasury/internal/page.rb

@@ -22,34 +22,13 @@ module ModernTreasury
       # @return [String]
       attr_accessor :after_cursor
 
-      # @api private
-      #
-      # @param client [ModernTreasury::Internal::Transport::BaseClient]
-      # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
-      # @param page_data [Hash{Symbol=>Object}]
-      def initialize(client:, req:, headers:, page_data:)
-        super
-        model = req.fetch(:model)
-
-        case page_data
-        in Array
-          replace(page_data.map { ModernTreasury::Internal::Type::Converter.coerce(model, _1) })
-        else
-        end
-
-        @per_page = ModernTreasury::Internal::Util.coerce_integer(headers["X-Per-Page"])
-
-        @after_cursor = headers["X-After-Cursor"]&.to_s
-      end
-
       # @return [Boolean]
       def next_page?
-        !after_cursor.nil?
+        !empty? && !after_cursor.to_s.empty?
       end
 
       # @raise [ModernTreasury::HTTP::Error]
-      # @return [ModernTreasury::Internal::Page]
+      # @return [self]
       def next_page
         unless next_page?
           message = "No more pages available. Please check #next_page? before calling ##{__method__}"
@@ -67,18 +46,43 @@ module ModernTreasury
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")
         end
+
         page = self
         loop do
-          page.each { blk.call(_1) }
+          page.each(&blk)
+
           break unless page.next_page?
           page = page.next_page
         end
       end
 
+      # @api private
+      #
+      # @param client [ModernTreasury::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in Array
+          replace(page_data.map { ModernTreasury::Internal::Type::Converter.coerce(@model, _1) })
+        else
+        end
+
+        @per_page = ModernTreasury::Internal::Util.coerce_integer(headers["X-Per-Page"])
+        @after_cursor = headers["X-After-Cursor"]&.to_s
+      end
+
+      # @api private
+      #
       # @return [String]
       def inspect
         # rubocop:disable Layout/LineLength
-        "#<#{self.class}:0x#{object_id.to_s(16)} per_page=#{per_page.inspect} after_cursor=#{after_cursor.inspect}>"
+        model = ModernTreasury::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} per_page=#{per_page.inspect} after_cursor=#{after_cursor.inspect}>"
         # rubocop:enable Layout/LineLength
       end
     end