terminal-shop 0.1.0.pre.alpha.9 → 0.1.0.pre.alpha.11

data/lib/terminal-shop/pooled_net_requester.rb

@@ -4,91 +4,160 @@ module TerminalShop
   # @private
   #
   class PooledNetRequester
-    def initialize
-      @mutex = Mutex.new
-      @pools = {}
+    class << self
+      # @private
+      #
+      # @param url [URI::Generic]
+      #
+      # @return [Net::HTTP]
+      #
+      def connect(url)
+        port =
+          case [url.port, url.scheme]
+          in [Integer, _]
+            url.port
+          in [nil, "http" | "ws"]
+            Net::HTTP.http_default_port
+          in [nil, "https" | "wss"]
+            Net::HTTP.https_default_port
+          end
+
+        Net::HTTP.new(url.host, port).tap do
+          _1.use_ssl = %w[https wss].include?(url.scheme)
+          _1.max_retries = 0
+        end
+      end
+
+      # @private
+      #
+      # @param conn [Net::HTTP]
+      # @param deadline [Float]
+      #
+      private def calibrate_socket_timeout(conn, deadline)
+        timeout = deadline - TerminalShop::Util.monotonic_secs
+        conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout
+      end
+
+      # @private
+      #
+      # @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 - TerminalShop::Util.monotonic_secs
+          conn.start
+        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
+      end
     end
 
     # @private
     #
-    # @param url [URL::Generic]
-    # @param timeout [Float]
+    # @param url [URI::Generic]
+    # @param streaming [Boolean]
+    # @param blk [Proc]
     #
-    # @return [ConnectionPool]
-    #
-    private def get_pool(url)
+    private def with_pool(url, streaming:, &blk)
       origin = TerminalShop::Util.uri_origin(url)
-      @mutex.synchronize do
-        @pools[origin] ||= ConnectionPool.new(size: Etc.nprocessors) do
-          port =
-            case [url.port, url.scheme]
-            in [Integer, _]
-              url.port
-            in [nil, "http" | "ws"]
-              Net::HTTP.http_default_port
-            in [nil, "https" | "wss"]
-              Net::HTTP.https_default_port
-            end
-
-          session = Net::HTTP.new(url.host, port)
-          session.use_ssl = %w[https wss].include?(url.scheme)
-          session.max_retries = 0
-          session
+      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
+
+      pool =
+        @mutex.synchronize do
+          @pools[origin] ||= ConnectionPool.new(size: Etc.nprocessors) 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
     end
 
     # @private
     #
-    # @param req [Hash{Symbol => Object}]
-    #   @option req [Symbol] :method
-    #   @option req [URI::Generic] :url
-    #   @option req [Hash{String => String}] :headers
-    #   @option req [String, Hash] :body
-    #   @option req [Float] :timeout
+    # @param request [Hash{Symbol=>Object}] .
+    #
+    #   @option request [Symbol] :method
+    #
+    #   @option request [URI::Generic] :url
+    #
+    #   @option request [Hash{String=>String}] :headers
+    #
+    #   @option request [Object] :body
+    #
+    #   @option request [Boolean] :streaming
     #
-    # @return [Net::HTTPResponse]
+    #   @option request [Integer] :max_retries
     #
-    def execute(req)
-      method, url, headers, body, timeout = req.fetch_values(:method, :url, :headers, :body, :timeout)
+    #   @option request [Float] :deadline
+    #
+    # @return [Array(Net::HTTPResponse, Enumerable)]
+    #
+    def execute(request)
+      method, url, headers, body, deadline = request.fetch_values(:method, :url, :headers, :body, :deadline)
+      streaming = request.fetch(:streaming)
 
-      request = Net::HTTPGenericRequest.new(
+      req = Net::HTTPGenericRequest.new(
         method.to_s.upcase,
         !body.nil?,
-        ![:head, :options].include?(method),
+        method != :head,
         url.to_s
       )
 
-      headers.each { |k, v| request[k] = v }
+      headers.each { req[_1] = _2 }
       case body
-      in String | nil
-        request.body = body
+      in nil
+      in String
+        req.body = body
       in IO | StringIO
-        request.body_stream = body
+        body.rewind
+        req.body_stream = body
       end
 
-      # This timeout is for acquiring a connection from the pool
-      # The default 5 seconds seems too short, lets just have a nearly unbounded queue for now
-      #
-      # TODO: revisit this around granular timeout / concurrency control
-      get_pool(url).with(timeout: 600) do |conn|
-        conn.open_timeout = timeout
-        conn.read_timeout = timeout
-        conn.write_timeout = timeout
-        conn.continue_timeout = timeout
-
-        conn.start unless conn.started?
-
-        conn.request(request)
-        # 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
-      end
-    rescue ConnectionPool::TimeoutError
-      raise TerminalShop::APITimeoutError.new(url: url)
+      enum =
+        with_pool(url, streaming: streaming) do |conn, y|
+          self.class.transport(conn, req, deadline, &y)
+        end
+
+      enum = streaming ? enum.lazy : enum.to_a
+      response = enum.take(1).first
+      [response, (response.body = enum.drop(1))]
+    end
+
+    def initialize
+      @mutex = Mutex.new
+      @pools = {}
     end
   end
 end

data/lib/terminal-shop/resources/app.rb

@@ -13,6 +13,8 @@ module TerminalShop
       #
       #   @option params [String] :redirect_uri Redirect URI of the app.
       #
+      #   @option params [String] :secret OAuth 2.0 client secret of the app (obfuscated).
+      #
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AppCreateResponse]

data/lib/terminal-shop/util.rb

@@ -105,6 +105,12 @@ module TerminalShop
       end
     end
 
+    # @private
+    #
+    # @return [Float]
+    #
+    def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
     # @private
     #
     # @param exceptions [Array<Exception>]
@@ -384,6 +390,11 @@ module TerminalShop
           "transfer-encoding" => "chunked"
         }
         [headers, strio]
+      in [_, StringIO]
+        [headers, body.string]
+      in [_, IO]
+        headers = {**headers, "transfer-encoding" => "chunked"}
+        [headers, body]
       else
         [headers, body]
       end
@@ -391,24 +402,28 @@ module TerminalShop
 
     # @private
     #
-    # @param response [Net::HTTPResponse]
+    # @param headers [Hash{String=>String}, Net::HTTPHeader]
+    # @param stream [Enumerable]
     # @param suppress_error [Boolean]
     #
     # @raise [JSON::ParserError]
     # @return [Object]
     #
-    def self.decode_content(response, suppress_error: false)
-      case response.content_type
-      in "application/json"
+    def self.decode_content(headers, stream:, suppress_error: false)
+      case headers["content-type"]
+      in %r{^application/json}
+        json = stream.to_a.join("")
         begin
-          JSON.parse(response.body, symbolize_names: true)
+          JSON.parse(json, symbolize_names: true)
         rescue JSON::ParserError => e
           raise e unless suppress_error
-          response.body
+          json
         end
+      in %r{^text/}
+        stream.to_a.join("")
       else
         # TODO: parsing other response types
-        response.body
+        StringIO.new(stream.to_a.join(""))
       end
     end
 

data/lib/terminal-shop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  VERSION = "0.1.0-alpha.9"
+  VERSION = "0.1.0-alpha.11"
 end

data/lib/terminal-shop.rb

@@ -17,94 +17,94 @@ require "uri"
 require "connection_pool"
 
 # Package files.
-require_relative "terminal-shop/pooled_net_requester"
 require_relative "terminal-shop/version"
 require_relative "terminal-shop/util"
 require_relative "terminal-shop/extern"
 require_relative "terminal-shop/base_model"
 require_relative "terminal-shop/base_page"
 require_relative "terminal-shop/request_options"
-require_relative "terminal-shop/base_client"
 require_relative "terminal-shop/errors"
-require_relative "terminal-shop/models/product"
-require_relative "terminal-shop/models/product_variant"
-require_relative "terminal-shop/models/product_list_response"
-require_relative "terminal-shop/models/profile"
-require_relative "terminal-shop/models/profile_update_response"
-require_relative "terminal-shop/models/profile_me_response"
+require_relative "terminal-shop/base_client"
+require_relative "terminal-shop/pooled_net_requester"
+require_relative "terminal-shop/client"
+require_relative "terminal-shop/models/app"
+require_relative "terminal-shop/models/subscription"
 require_relative "terminal-shop/models/address"
+require_relative "terminal-shop/models/address_create_params"
 require_relative "terminal-shop/models/address_create_response"
-require_relative "terminal-shop/models/address_list_response"
+require_relative "terminal-shop/models/address_delete_params"
 require_relative "terminal-shop/models/address_delete_response"
+require_relative "terminal-shop/models/address_list_params"
+require_relative "terminal-shop/models/address_list_response"
+require_relative "terminal-shop/models/app_create_params"
+require_relative "terminal-shop/models/app_create_response"
+require_relative "terminal-shop/models/app_delete_params"
+require_relative "terminal-shop/models/app_delete_response"
+require_relative "terminal-shop/models/app_get_params"
+require_relative "terminal-shop/models/app_get_response"
+require_relative "terminal-shop/models/app_list_params"
+require_relative "terminal-shop/models/app_list_response"
 require_relative "terminal-shop/models/card"
+require_relative "terminal-shop/models/card_collect_params"
+require_relative "terminal-shop/models/card_collect_response"
+require_relative "terminal-shop/models/card_create_params"
 require_relative "terminal-shop/models/card_create_response"
-require_relative "terminal-shop/models/card_list_response"
+require_relative "terminal-shop/models/card_delete_params"
 require_relative "terminal-shop/models/card_delete_response"
-require_relative "terminal-shop/models/card_collect_response"
+require_relative "terminal-shop/models/card_list_params"
+require_relative "terminal-shop/models/card_list_response"
 require_relative "terminal-shop/models/cart"
+require_relative "terminal-shop/models/cart_convert_params"
 require_relative "terminal-shop/models/cart_convert_response"
+require_relative "terminal-shop/models/cart_get_params"
 require_relative "terminal-shop/models/cart_get_response"
+require_relative "terminal-shop/models/cart_set_address_params"
 require_relative "terminal-shop/models/cart_set_address_response"
+require_relative "terminal-shop/models/cart_set_card_params"
 require_relative "terminal-shop/models/cart_set_card_response"
+require_relative "terminal-shop/models/cart_set_item_params"
 require_relative "terminal-shop/models/cart_set_item_response"
+require_relative "terminal-shop/models/email_create_params"
+require_relative "terminal-shop/models/email_create_response"
 require_relative "terminal-shop/models/order"
-require_relative "terminal-shop/models/order_list_response"
+require_relative "terminal-shop/models/order_get_params"
 require_relative "terminal-shop/models/order_get_response"
-require_relative "terminal-shop/models/subscription"
-require_relative "terminal-shop/models/subscription_create_response"
-require_relative "terminal-shop/models/subscription_list_response"
-require_relative "terminal-shop/models/subscription_delete_response"
-require_relative "terminal-shop/models/token"
-require_relative "terminal-shop/models/token_create_response"
-require_relative "terminal-shop/models/token_list_response"
-require_relative "terminal-shop/models/token_delete_response"
-require_relative "terminal-shop/models/token_get_response"
-require_relative "terminal-shop/models/app"
-require_relative "terminal-shop/models/app_create_response"
-require_relative "terminal-shop/models/app_list_response"
-require_relative "terminal-shop/models/app_delete_response"
-require_relative "terminal-shop/models/app_get_response"
-require_relative "terminal-shop/models/email_create_response"
-require_relative "terminal-shop/models/view_init_response"
+require_relative "terminal-shop/models/order_list_params"
+require_relative "terminal-shop/models/order_list_response"
+require_relative "terminal-shop/models/product"
 require_relative "terminal-shop/models/product_list_params"
-require_relative "terminal-shop/models/profile_update_params"
+require_relative "terminal-shop/models/product_list_response"
+require_relative "terminal-shop/models/product_variant"
+require_relative "terminal-shop/models/profile"
 require_relative "terminal-shop/models/profile_me_params"
-require_relative "terminal-shop/models/address_create_params"
-require_relative "terminal-shop/models/address_list_params"
-require_relative "terminal-shop/models/address_delete_params"
-require_relative "terminal-shop/models/card_create_params"
-require_relative "terminal-shop/models/card_list_params"
-require_relative "terminal-shop/models/card_delete_params"
-require_relative "terminal-shop/models/card_collect_params"
-require_relative "terminal-shop/models/cart_convert_params"
-require_relative "terminal-shop/models/cart_get_params"
-require_relative "terminal-shop/models/cart_set_address_params"
-require_relative "terminal-shop/models/cart_set_card_params"
-require_relative "terminal-shop/models/cart_set_item_params"
-require_relative "terminal-shop/models/order_list_params"
-require_relative "terminal-shop/models/order_get_params"
+require_relative "terminal-shop/models/profile_me_response"
+require_relative "terminal-shop/models/profile_update_params"
+require_relative "terminal-shop/models/profile_update_response"
 require_relative "terminal-shop/models/subscription_create_params"
-require_relative "terminal-shop/models/subscription_list_params"
+require_relative "terminal-shop/models/subscription_create_response"
 require_relative "terminal-shop/models/subscription_delete_params"
+require_relative "terminal-shop/models/subscription_delete_response"
+require_relative "terminal-shop/models/subscription_list_params"
+require_relative "terminal-shop/models/subscription_list_response"
+require_relative "terminal-shop/models/token"
 require_relative "terminal-shop/models/token_create_params"
-require_relative "terminal-shop/models/token_list_params"
+require_relative "terminal-shop/models/token_create_response"
 require_relative "terminal-shop/models/token_delete_params"
+require_relative "terminal-shop/models/token_delete_response"
 require_relative "terminal-shop/models/token_get_params"
-require_relative "terminal-shop/models/app_create_params"
-require_relative "terminal-shop/models/app_list_params"
-require_relative "terminal-shop/models/app_delete_params"
-require_relative "terminal-shop/models/app_get_params"
-require_relative "terminal-shop/models/email_create_params"
+require_relative "terminal-shop/models/token_get_response"
+require_relative "terminal-shop/models/token_list_params"
+require_relative "terminal-shop/models/token_list_response"
 require_relative "terminal-shop/models/view_init_params"
-require_relative "terminal-shop/client"
-require_relative "terminal-shop/resources/product"
-require_relative "terminal-shop/resources/profile"
+require_relative "terminal-shop/models/view_init_response"
 require_relative "terminal-shop/resources/address"
+require_relative "terminal-shop/resources/app"
 require_relative "terminal-shop/resources/card"
 require_relative "terminal-shop/resources/cart"
+require_relative "terminal-shop/resources/email"
 require_relative "terminal-shop/resources/order"
+require_relative "terminal-shop/resources/product"
+require_relative "terminal-shop/resources/profile"
 require_relative "terminal-shop/resources/subscription"
 require_relative "terminal-shop/resources/token"
-require_relative "terminal-shop/resources/app"
-require_relative "terminal-shop/resources/email"
 require_relative "terminal-shop/resources/view"

data/rbi/lib/terminal-shop/base_client.rbi

@@ -4,7 +4,7 @@ module TerminalShop
   class BaseClient
     abstract!
 
-    RequestShape = T.type_alias do
+    RequestComponentsShape = T.type_alias do
       {
         method: Symbol,
         path: T.any(String, T::Array[String]),
@@ -18,12 +18,13 @@ module TerminalShop
       }
     end
 
-    NormalizedRequestShape = T.type_alias do
+    RequestInputShape = T.type_alias do
       {
         method: Symbol,
         url: URI::Generic,
         headers: T::Hash[String, String],
         body: T.anything,
+        streaming: T::Boolean,
         max_retries: Integer,
         timeout: Float
       }
@@ -31,10 +32,27 @@ module TerminalShop
 
     MAX_REDIRECTS = 20
 
-    sig { params(req: TerminalShop::BaseClient::RequestShape).void }
+    sig { params(req: TerminalShop::BaseClient::RequestComponentsShape).void }
     def self.validate!(req)
     end
 
+    sig do
+      params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean)
+    end
+    def self.should_retry?(status, headers:)
+    end
+
+    sig do
+      params(
+        request: TerminalShop::BaseClient::RequestInputShape,
+        status: Integer,
+        response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+      )
+        .returns(TerminalShop::BaseClient::RequestInputShape)
+    end
+    def self.follow_redirect(request, status:, response_headers:)
+    end
+
     sig { returns(T.anything) }
     def requester
     end
@@ -52,7 +70,8 @@ module TerminalShop
         max_retry_delay: Float,
         headers: T::Hash[String, T.nilable(String)],
         idempotency_header: T.nilable(String)
-      ).void
+      )
+        .void
     end
     def initialize(
       base_url:,
@@ -74,45 +93,38 @@ module TerminalShop
     end
 
     sig do
-      params(
-        req: TerminalShop::BaseClient::RequestShape,
-        opts: T::Hash[Symbol, T.anything]
-      ).returns(TerminalShop::BaseClient::NormalizedRequestShape)
+      overridable
+        .params(req: TerminalShop::BaseClient::RequestComponentsShape, opts: T::Hash[Symbol, T.anything])
+        .returns(TerminalShop::BaseClient::RequestInputShape)
     end
     private def build_request(req, opts)
     end
 
-    sig { params(status: Integer, headers: T::Hash[String, String]).returns(T::Boolean) }
-    private def should_retry?(status, headers:)
-    end
-
     sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) }
     private def retry_delay(headers, retry_count:)
     end
 
     sig do
       params(
-        request: TerminalShop::BaseClient::NormalizedRequestShape,
-        status: Integer,
-        location_header: String
-      ).returns(TerminalShop::BaseClient::NormalizedRequestShape)
-    end
-    private def follow_redirect(request, status:, location_header:)
-    end
-
-    sig do
-      params(
-        request: TerminalShop::BaseClient::NormalizedRequestShape,
+        request: TerminalShop::BaseClient::RequestInputShape,
         redirect_count: Integer,
         retry_count: Integer,
         send_retry_header: T::Boolean
-      ).returns(Net::HTTPResponse)
+      )
+        .returns([Net::HTTPResponse, T::Enumerable[String]])
     end
     private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
     end
 
-    sig { params(req: TerminalShop::BaseClient::RequestShape, response: NilClass).returns(T.anything) }
-    private def parse_response(req, response)
+    sig do
+      params(
+        req: TerminalShop::BaseClient::RequestComponentsShape,
+        headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+        stream: T::Enumerable[String]
+      )
+        .returns(T.anything)
+    end
+    private def parse_response(req, headers:, stream:)
     end
 
     sig do
@@ -126,7 +138,8 @@ module TerminalShop
         page: T.nilable(T::Class[TerminalShop::BaseModel]),
         model: T.nilable(TerminalShop::Converter::Input),
         options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
-      ).returns(T.anything)
+      )
+        .returns(T.anything)
     end
     def request(
       method,