modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/page.rb

@@ -2,25 +2,26 @@
 
 module ModernTreasury
   # @example
-  # ```ruby
-  # if page.has_next?
-  #   page = page.next_page
-  # end
-  # ```
+  #   if page.has_next?
+  #     page = page.next_page
+  #   end
   #
   # @example
-  # ```ruby
-  # page.auto_paging_each do |item|
-  # #   item ...
-  # end
-  # ```
+  #   page.auto_paging_each do |connection|
+  #     puts(connection)
+  #   end
   #
   # @example
-  # ```ruby
-  # items = page.to_enum.take(2)
+  #   connections =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # items => Array
-  # ```
+  #   connections => Array
   class Page < ::Array
     include ModernTreasury::BasePage
 
@@ -30,23 +31,20 @@ module ModernTreasury
     # @return [String]
     attr_accessor :after_cursor
 
-    # @private
+    # @api private
     #
     # @param client [ModernTreasury::BaseClient]
     # @param req [Hash{Symbol=>Object}]
     # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    # @param unwrapped [Hash{Symbol=>Object}]
-    #
-    def initialize(client:, req:, headers:, unwrapped:)
-      @client = client
-      @req = req
+    # @param page_data [Hash{Symbol=>Object}]
+    def initialize(client:, req:, headers:, page_data:)
+      super
       model = req.fetch(:model)
 
-      case unwrapped
+      case page_data
       in Array
-        super(unwrapped&.map { model.coerce(_1) })
+        replace(page_data.map { model.coerce(_1) })
       else
-        super([])
       end
 
       @per_page = ModernTreasury::Util.coerce_integer(headers["X-Per-Page"])
@@ -61,10 +59,10 @@ module ModernTreasury
 
     # @raise [ModernTreasury::HTTP::Error]
     # @return [ModernTreasury::Page]
-    #
     def next_page
       unless next_page?
-        raise RuntimeError.new("No more pages available; please check #next_page? before calling #next_page")
+        message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+        raise RuntimeError.new(message)
       end
 
       req = ModernTreasury::Util.deep_merge(@req, {query: {after_cursor: after_cursor}})
@@ -72,10 +70,9 @@ module ModernTreasury
     end
 
     # @param blk [Proc]
-    #
     def auto_paging_each(&blk)
       unless block_given?
-        raise ArgumentError.new("A block must be given to #auto_paging_each")
+        raise ArgumentError.new("A block must be given to ##{__method__}")
       end
       page = self
       loop do
@@ -86,9 +83,10 @@ module ModernTreasury
     end
 
     # @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}>"
+      # rubocop:enable Layout/LineLength
     end
   end
 end

data/lib/modern_treasury/pooled_net_requester.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  # @private
-  #
+  # @api private
   class PooledNetRequester
+    # from the golang stdlib
+    #   https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+    KEEP_ALIVE_TIMEOUT = 30
+
     class << self
-      # @private
+      # @api private
       #
       # @param url [URI::Generic]
       #
       # @return [Net::HTTP]
-      #
       def connect(url)
         port =
           case [url.port, url.scheme]
@@ -28,83 +30,80 @@ module ModernTreasury
         end
       end
 
-      # @private
+      # @api private
       #
       # @param conn [Net::HTTP]
       # @param deadline [Float]
-      #
-      private def calibrate_socket_timeout(conn, deadline)
+      def calibrate_socket_timeout(conn, deadline)
         timeout = deadline - ModernTreasury::Util.monotonic_secs
-        conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout
+        conn.open_timeout = conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout
       end
 
-      # @private
+      # @api private
+      #
+      # @param request [Hash{Symbol=>Object}] .
+      #
+      #   @option request [Symbol] :method
+      #
+      #   @option request [URI::Generic] :url
+      #
+      #   @option request [Hash{String=>String}] :headers
       #
-      # @param conn [Net::HTTP]
-      # @param req [Net::HTTPGenericRequest]
-      # @param deadline [Float]
       # @param blk [Proc]
       #
-      def transport(conn, req, deadline, &blk)
-        unless conn.started?
-          conn.open_timeout = deadline - ModernTreasury::Util.monotonic_secs
-          conn.start
+      # @yieldparam [String]
+      # @return [Net::HTTPGenericRequest]
+      def build_request(request, &)
+        method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
+        req = Net::HTTPGenericRequest.new(
+          method.to_s.upcase,
+          !body.nil?,
+          method != :head,
+          url.to_s
+        )
+
+        headers.each { req[_1] = _2 }
+
+        case body
+        in nil
+          nil
+        in String
+          req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
+          req.body_stream = ModernTreasury::Util::ReadIOAdapter.new(body, &)
+        in StringIO
+          req["content-length"] ||= body.size.to_s unless req["transfer-encoding"]
+          req.body_stream = ModernTreasury::Util::ReadIOAdapter.new(body, &)
+        in IO | Enumerator
+          req["transfer-encoding"] ||= "chunked" unless req["content-length"]
+          req.body_stream = ModernTreasury::Util::ReadIOAdapter.new(body, &)
         end
 
-        calibrate_socket_timeout(conn, deadline)
-        conn.request(req) do |rsp|
-          blk.call(rsp)
-          rsp.read_body do |bytes|
-            blk.call(bytes)
-            calibrate_socket_timeout(conn, deadline)
-          end
-        end
+        req
       end
     end
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
-    # @param streaming [Boolean]
+    # @param deadline [Float]
     # @param blk [Proc]
     #
-    private def with_pool(url, streaming:, &blk)
+    # @raise [Timeout::Error]
+    # @yieldparam [Net::HTTP]
+    private def with_pool(url, deadline:, &blk)
       origin = ModernTreasury::Util.uri_origin(url)
-      th = Thread.current
-      key = :"#{object_id}-#{self.class.name}-connection_in_use_for_#{origin}"
-
-      if th[key] || streaming
-        return Enumerator.new do |y|
-          conn = self.class.connect(url)
-          blk.call(conn, y)
-        end
-      end
-
+      timeout = deadline - ModernTreasury::Util.monotonic_secs
       pool =
         @mutex.synchronize do
-          @pools[origin] ||= ConnectionPool.new(size: Etc.nprocessors) do
+          @pools[origin] ||= ConnectionPool.new(size: @size) do
             self.class.connect(url)
           end
         end
 
-      Enumerator.new do |y|
-        pool.with do |conn|
-          th[key] = true
-
-          blk.call(conn, y)
-          # rubocop:disable Lint/RescueException
-        rescue Exception => e
-          # rubocop:enable Lint/RescueException
-          # should close connection on all errors to ensure no invalid state persists
-          conn.finish if conn.started?
-          raise e
-        ensure
-          th[key] = nil
-        end
-      end
+      pool.with(timeout: timeout, &blk)
     end
 
-    # @private
+    # @api private
     #
     # @param request [Hash{Symbol=>Object}] .
     #
@@ -116,47 +115,65 @@ module ModernTreasury
     #
     #   @option request [Object] :body
     #
-    #   @option request [Boolean] :streaming
-    #
-    #   @option request [Integer] :max_retries
-    #
     #   @option request [Float] :deadline
     #
-    # @return [Array(Net::HTTPResponse, Enumerable)]
-    #
+    # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
     def execute(request)
-      method, url, headers, body, deadline = request.fetch_values(:method, :url, :headers, :body, :deadline)
-      streaming = request.fetch(:streaming)
-
-      req = Net::HTTPGenericRequest.new(
-        method.to_s.upcase,
-        !body.nil?,
-        method != :head,
-        url.to_s
-      )
-
-      headers.each { req[_1] = _2 }
-      case body
-      in nil
-      in String
-        req.body = body
-      in IO | StringIO
-        body.rewind
-        req.body_stream = body
-      end
+      url, deadline = request.fetch_values(:url, :deadline)
+
+      eof = false
+      finished = false
+      enum = Enumerator.new do |y|
+        with_pool(url, deadline: deadline) do |conn|
+          next if finished
+
+          req = self.class.build_request(request) do
+            self.class.calibrate_socket_timeout(conn, deadline)
+          end
+
+          self.class.calibrate_socket_timeout(conn, deadline)
+          unless conn.started?
+            conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+            conn.start
+          end
+
+          self.class.calibrate_socket_timeout(conn, deadline)
+          conn.request(req) do |rsp|
+            y << [conn, req, rsp]
+            break if finished
 
-      enum =
-        with_pool(url, streaming: streaming) do |conn, y|
-          self.class.transport(conn, req, deadline, &y)
+            rsp.read_body do |bytes|
+              y << bytes
+              break if finished
+
+              self.class.calibrate_socket_timeout(conn, deadline)
+            end
+            eof = true
+          end
         end
+      rescue Timeout::Error
+        raise ModernTreasury::APITimeoutError
+      end
 
-      enum = streaming ? enum.lazy : enum.to_a
-      response = enum.take(1).first
-      [response, (response.body = enum.drop(1))]
+      conn, _, response = enum.next
+      body = ModernTreasury::Util.fused_enum(enum, external: true) do
+        finished = true
+        tap do
+          enum.next
+        rescue StopIteration
+          nil
+        end
+        conn.finish if !eof && conn&.started?
+      end
+      [Integer(response.code), response, (response.body = body)]
     end
 
-    def initialize
+    # @api private
+    #
+    # @param size [Integer]
+    def initialize(size: Etc.nprocessors)
       @mutex = Mutex.new
+      @size = size
       @pools = {}
     end
   end

data/lib/modern_treasury/request_options.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  # @private
-  #
-  # @abstract
-  #
+  # @api private
   module RequestParameters
     # @!parse
     #   # Options to specify HTTP behaviour for this request.
@@ -12,7 +9,6 @@ module ModernTreasury
     #   attr_accessor :request_options
 
     # @param mod [Module]
-    #
     def self.included(mod)
       return unless mod <= ModernTreasury::BaseModel
 
@@ -20,15 +16,13 @@ module ModernTreasury
       mod.optional(:request_options, ModernTreasury::RequestOptions)
     end
 
-    # @private
-    #
+    # @api private
     module Converter
-      # @private
+      # @api private
       #
       # @param params [Object]
       #
       # @return [Array(Object, Hash{Symbol=>Object})]
-      #
       def dump_request(params)
         case (dumped = dump(params))
         in Hash
@@ -46,12 +40,11 @@ module ModernTreasury
   #   When making a request, you can pass an actual {RequestOptions} instance, or
   #   simply pass a Hash with symbol keys matching the attributes on this class.
   class RequestOptions < ModernTreasury::BaseModel
-    # @private
+    # @api private
     #
     # @param opts [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     #
     # @raise [ArgumentError]
-    #
     def self.validate!(opts)
       case opts
       in ModernTreasury::RequestOptions | Hash
@@ -90,7 +83,7 @@ module ModernTreasury
     #   Extra data to send with the request. These are deep merged into any data
     #     generated as part of the normal request.
     #
-    #   @return [Hash{Symbol=>Object}, nil]
+    #   @return [Object, nil]
     optional :extra_body, ModernTreasury::HashOf[ModernTreasury::Unknown]
 
     # @!attribute max_retries

data/lib/modern_treasury/resources/account_collection_flows.rb

@@ -16,7 +16,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
-      #
       def create(params)
         parsed, options = ModernTreasury::Models::AccountCollectionFlowCreateParams.dump_request(params)
         @client.request(
@@ -37,7 +36,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
-      #
       def retrieve(id, params = {})
         @client.request(
           method: :get,
@@ -59,7 +57,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
-      #
       def update(id, params)
         parsed, options = ModernTreasury::Models::AccountCollectionFlowUpdateParams.dump_request(params)
         @client.request(
@@ -90,7 +87,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Page<ModernTreasury::Models::AccountCollectionFlow>]
-      #
       def list(params = {})
         parsed, options = ModernTreasury::Models::AccountCollectionFlowListParams.dump_request(params)
         @client.request(
@@ -104,7 +100,6 @@ module ModernTreasury
       end
 
       # @param client [ModernTreasury::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/account_details.rb

@@ -19,16 +19,16 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::AccountDetail]
-      #
       def create(account_id, params)
         parsed, options = ModernTreasury::Models::AccountDetailCreateParams.dump_request(params)
-        accounts_type = parsed.fetch(:accounts_type) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        accounts_type =
+          parsed.delete(:accounts_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :post,
           path: ["api/%0s/%1s/account_details", accounts_type, account_id],
-          body: parsed.except(:accounts_type),
+          body: parsed,
           model: ModernTreasury::Models::AccountDetail,
           options: options
         )
@@ -47,15 +47,16 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::AccountDetail]
-      #
       def retrieve(id, params)
         parsed, options = ModernTreasury::Models::AccountDetailRetrieveParams.dump_request(params)
-        accounts_type = parsed.fetch(:accounts_type) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
-        account_id = parsed.fetch(:account_id) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        accounts_type =
+          parsed.delete(:accounts_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        account_id =
+          parsed.delete(:account_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :get,
           path: ["api/%0s/%1s/account_details/%2s", accounts_type, account_id, id],
@@ -79,16 +80,16 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Page<ModernTreasury::Models::AccountDetail>]
-      #
       def list(account_id, params)
         parsed, options = ModernTreasury::Models::AccountDetailListParams.dump_request(params)
-        accounts_type = parsed.fetch(:accounts_type) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        accounts_type =
+          parsed.delete(:accounts_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :get,
           path: ["api/%0s/%1s/account_details", accounts_type, account_id],
-          query: parsed.except(:accounts_type),
+          query: parsed,
           page: ModernTreasury::Page,
           model: ModernTreasury::Models::AccountDetail,
           options: options
@@ -108,15 +109,16 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [nil]
-      #
       def delete(id, params)
         parsed, options = ModernTreasury::Models::AccountDetailDeleteParams.dump_request(params)
-        accounts_type = parsed.fetch(:accounts_type) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
-        account_id = parsed.fetch(:account_id) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        accounts_type =
+          parsed.delete(:accounts_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        account_id =
+          parsed.delete(:account_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :delete,
           path: ["api/%0s/%1s/account_details/%2s", accounts_type, account_id, id],
@@ -126,7 +128,6 @@ module ModernTreasury
       end
 
       # @param client [ModernTreasury::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/bulk_requests.rb

@@ -20,7 +20,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::BulkRequest]
-      #
       def create(params)
         parsed, options = ModernTreasury::Models::BulkRequestCreateParams.dump_request(params)
         @client.request(
@@ -41,7 +40,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::BulkRequest]
-      #
       def retrieve(id, params = {})
         @client.request(
           method: :get,
@@ -72,7 +70,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Page<ModernTreasury::Models::BulkRequest>]
-      #
       def list(params = {})
         parsed, options = ModernTreasury::Models::BulkRequestListParams.dump_request(params)
         @client.request(
@@ -86,7 +83,6 @@ module ModernTreasury
       end
 
       # @param client [ModernTreasury::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/bulk_results.rb

@@ -12,7 +12,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::BulkResult]
-      #
       def retrieve(id, params = {})
         @client.request(
           method: :get,
@@ -46,7 +45,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Page<ModernTreasury::Models::BulkResult>]
-      #
       def list(params = {})
         parsed, options = ModernTreasury::Models::BulkResultListParams.dump_request(params)
         @client.request(
@@ -60,7 +58,6 @@ module ModernTreasury
       end
 
       # @param client [ModernTreasury::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/connection_legal_entities.rb

@@ -16,7 +16,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
-      #
       def create(params)
         parsed, options = ModernTreasury::Models::ConnectionLegalEntityCreateParams.dump_request(params)
         @client.request(
@@ -37,7 +36,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
-      #
       def retrieve(id, params = {})
         @client.request(
           method: :get,
@@ -58,7 +56,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
-      #
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::ConnectionLegalEntityUpdateParams.dump_request(params)
         @client.request(
@@ -87,7 +84,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Page<ModernTreasury::Models::ConnectionLegalEntity>]
-      #
       def list(params = {})
         parsed, options = ModernTreasury::Models::ConnectionLegalEntityListParams.dump_request(params)
         @client.request(
@@ -101,7 +97,6 @@ module ModernTreasury
       end
 
       # @param client [ModernTreasury::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/connections.rb

@@ -18,7 +18,6 @@ module ModernTreasury
       #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [ModernTreasury::Page<ModernTreasury::Models::Connection>]
-      #
       def list(params = {})
         parsed, options = ModernTreasury::Models::ConnectionListParams.dump_request(params)
         @client.request(
@@ -32,7 +31,6 @@ module ModernTreasury
       end
 
       # @param client [ModernTreasury::Client]
-      #
       def initialize(client:)
         @client = client
       end