terminal-shop 0.1.0.pre.alpha.15 → 1.1.0

data/lib/terminal-shop/pooled_net_requester.rb

@@ -131,16 +131,23 @@ module TerminalShop
       req = self.class.build_request(request)
 
       eof = false
+      finished = false
       enum = Enumerator.new do |y|
         with_pool(url) do |conn|
+          next if finished
+
           self.class.calibrate_socket_timeout(conn, deadline)
           conn.start unless conn.started?
 
           self.class.calibrate_socket_timeout(conn, deadline)
           conn.request(req) do |rsp|
             y << [conn, rsp]
+            break if finished
+
             rsp.read_body do |bytes|
               y << bytes
+              break if finished
+
               self.class.calibrate_socket_timeout(conn, deadline)
             end
             eof = true
@@ -148,16 +155,14 @@ module TerminalShop
         end
       end
 
-      # need to protect the `Enumerator` against `#.rewind`
-      fused = false
       conn, response = enum.next
-      body = Enumerator.new do |y|
-        next if fused
-
-        fused = true
-        loop { y << enum.next }
-      ensure
-        conn.finish if !eof && conn.started?
+      body = TerminalShop::Util.fused_enum(enum) do
+        finished = true
+        tap do
+          enum.next
+        rescue StopIteration
+        end
+        conn.finish if !eof && conn&.started?
       end
       [response, (response.body = body)]
     end

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

@@ -74,6 +74,25 @@ module TerminalShop
         )
       end
 
+      # Get the shipping address with the given ID.
+      #
+      # @param id [String] ID of the shipping address to get.
+      #
+      # @param params [TerminalShop::Models::AddressGetParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [TerminalShop::Models::AddressGetResponse]
+      #
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["address/%0s", id],
+          model: TerminalShop::Models::AddressGetResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @param client [TerminalShop::Client]
       #
       def initialize(client:)

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

@@ -7,13 +7,9 @@ module TerminalShop
       #
       # @param params [TerminalShop::Models::AppCreateParams, Hash{Symbol=>Object}] .
       #
-      #   @option params [String] :id Unique object identifier. The format and length of IDs may change over time.
+      #   @option params [String] :name
       #
-      #   @option params [String] :name Name of the app.
-      #
-      #   @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 [String] :redirect_uri
       #
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #

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

@@ -79,6 +79,25 @@ module TerminalShop
         )
       end
 
+      # Get a credit card by ID associated with the current user.
+      #
+      # @param id [String] ID of the card to get.
+      #
+      # @param params [TerminalShop::Models::CardGetParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [TerminalShop::Models::CardGetResponse]
+      #
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["card/%0s", id],
+          model: TerminalShop::Models::CardGetResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @param client [TerminalShop::Client]
       #
       def initialize(client:)

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

@@ -7,16 +7,20 @@ module TerminalShop
       #
       # @param params [TerminalShop::Models::CartConvertParams, Hash{Symbol=>Object}] .
       #
+      #   @option params [String] :recipient_email
+      #
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CartConvertResponse]
       #
       def convert(params = {})
+        parsed, options = TerminalShop::Models::CartConvertParams.dump_request(params)
         @client.request(
           method: :post,
           path: "cart/convert",
+          body: parsed,
           model: TerminalShop::Models::CartConvertResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -37,6 +41,44 @@ module TerminalShop
         )
       end
 
+      # Apply a gift card to the current user's cart.
+      #
+      # @param params [TerminalShop::Models::CartRedeemGiftCardParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :gift_card_id
+      #
+      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [TerminalShop::Models::CartRedeemGiftCardResponse]
+      #
+      def redeem_gift_card(params)
+        parsed, options = TerminalShop::Models::CartRedeemGiftCardParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: "cart/gift-card",
+          body: parsed,
+          model: TerminalShop::Models::CartRedeemGiftCardResponse,
+          options: options
+        )
+      end
+
+      # Remove the gift card from the current user's cart.
+      #
+      # @param params [TerminalShop::Models::CartRemoveGiftCardParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [TerminalShop::Models::CartRemoveGiftCardResponse]
+      #
+      def remove_gift_card(params = {})
+        @client.request(
+          method: :delete,
+          path: "cart/gift-card",
+          model: TerminalShop::Models::CartRemoveGiftCardResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Set the shipping address for the current user's cart.
       #
       # @param params [TerminalShop::Models::CartSetAddressParams, Hash{Symbol=>Object}] .

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

@@ -20,6 +20,25 @@ module TerminalShop
         )
       end
 
+      # Get a product by ID from the Terminal shop.
+      #
+      # @param id [String] ID of the product to get.
+      #
+      # @param params [TerminalShop::Models::ProductGetParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [TerminalShop::Models::ProductGetResponse]
+      #
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["product/%0s", id],
+          model: TerminalShop::Models::ProductGetResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @param client [TerminalShop::Client]
       #
       def initialize(client:)

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

@@ -7,15 +7,15 @@ module TerminalShop
       #
       # @param params [TerminalShop::Models::ProfileUpdateParams, Hash{Symbol=>Object}] .
       #
-      #   @option params [String, nil] :email Email address of the user.
+      #   @option params [String] :email
       #
-      #   @option params [String, nil] :name Name of the user.
+      #   @option params [String] :name
       #
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::ProfileUpdateResponse]
       #
-      def update(params = {})
+      def update(params)
         parsed, options = TerminalShop::Models::ProfileUpdateParams.dump_request(params)
         @client.request(
           method: :put,

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

@@ -72,6 +72,25 @@ module TerminalShop
         )
       end
 
+      # Get the subscription with the given ID.
+      #
+      # @param id [String] ID of the subscription to get.
+      #
+      # @param params [TerminalShop::Models::SubscriptionGetParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [TerminalShop::Models::SubscriptionGetResponse]
+      #
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["subscription/%0s", id],
+          model: TerminalShop::Models::SubscriptionGetResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @param client [TerminalShop::Client]
       #
       def initialize(client:)

data/lib/terminal-shop/util.rb

@@ -496,7 +496,7 @@ module TerminalShop
       #
       def decode_content(headers, stream:, suppress_error: false)
         case headers["content-type"]
-        in %r{^application/json}
+        in %r{^application/(?:vnd\.api\+)?json}
           json = stream.to_a.join
           begin
             JSON.parse(json, symbolize_names: true)
@@ -504,6 +504,11 @@ module TerminalShop
             raise e unless suppress_error
             json
           end
+        in %r{^text/event-stream}
+          lines = decode_lines(stream)
+          decode_sse(lines)
+        in %r{^application/(?:x-)?jsonl}
+          decode_lines(stream)
         in %r{^text/}
           stream.to_a.join
         else
@@ -512,6 +517,135 @@ module TerminalShop
         end
       end
     end
+
+    class << self
+      # @private
+      #
+      # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
+      #
+      # @param enum [Enumerable]
+      # @param close [Proc]
+      #
+      # @return [Enumerable]
+      #
+      def fused_enum(enum, &close)
+        fused = false
+        iter = Enumerator.new do |y|
+          next if fused
+
+          fused = true
+          loop { y << enum.next }
+        ensure
+          close&.call
+          close = nil
+        end
+
+        iter.define_singleton_method(:rewind) do
+          fused = true
+          self
+        end
+        iter
+      end
+
+      # @private
+      #
+      # @param enum [Enumerable, nil]
+      #
+      def close_fused!(enum)
+        return unless enum.is_a?(Enumerator)
+
+        # rubocop:disable Lint/UnreachableLoop
+        enum.rewind.each { break }
+        # rubocop:enable Lint/UnreachableLoop
+      end
+
+      # @private
+      #
+      # @param enum [Enumerable, nil]
+      # @param blk [Proc]
+      #
+      def chain_fused(enum, &blk)
+        iter = Enumerator.new { blk.call(_1) }
+        fused_enum(iter) { close_fused!(enum) }
+      end
+    end
+
+    class << self
+      # @private
+      #
+      # @param enum [Enumerable]
+      #
+      # @return [Enumerable]
+      #
+      def decode_lines(enum)
+        re = /(\r\n|\r|\n)/
+        buffer = String.new.b
+        cr_seen = nil
+
+        chain_fused(enum) do |y|
+          enum.each do |row|
+            buffer << row
+            while (match = re.match(buffer, cr_seen.to_i))
+              case [match.captures.first, cr_seen]
+              in ["\r", nil]
+                cr_seen = match.end(1)
+                next
+              in ["\r" | "\r\n", Integer]
+                y << buffer.slice!(..(cr_seen.pred))
+              else
+                y << buffer.slice!(..(match.end(1).pred))
+              end
+              cr_seen = nil
+            end
+          end
+
+          y << buffer.slice!(..(cr_seen.pred)) unless cr_seen.nil?
+          y << buffer unless buffer.empty?
+        end
+      end
+
+      # @private
+      #
+      # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
+      #
+      # @param lines [Enumerable]
+      #
+      # @return [Hash{Symbol=>Object}]
+      #
+      def decode_sse(lines)
+        chain_fused(lines) do |y|
+          blank = {event: nil, data: nil, id: nil, retry: nil}
+          current = {}
+
+          lines.each do |line|
+            case line.sub(/\R$/, "")
+            in ""
+              next if current.empty?
+              y << {**blank, **current}
+              current = {}
+            in /^:/
+              next
+            in /^([^:]+):\s?(.*)$/
+              field, value = Regexp.last_match.captures
+              case field
+              in "event"
+                current.merge!(event: value)
+              in "data"
+                (current[:data] ||= String.new.b) << value << "\n"
+              in "id" unless value.include?("\0")
+                current.merge!(id: value)
+              in "retry" if /^\d+$/ =~ value
+                current.merge!(retry: Integer(value))
+              else
+              end
+            else
+            end
+          end
+
+          y << {**blank, **current} unless current.empty?
+        end
+      end
+    end
   end
 
   # rubocop:enable Metrics/ModuleLength

data/lib/terminal-shop/version.rb

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

data/lib/terminal-shop.rb

@@ -28,15 +28,17 @@ require_relative "terminal-shop/errors"
 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_delete_params"
 require_relative "terminal-shop/models/address_delete_response"
+require_relative "terminal-shop/models/address_get_params"
+require_relative "terminal-shop/models/address_get_response"
 require_relative "terminal-shop/models/address_list_params"
 require_relative "terminal-shop/models/address_list_response"
+require_relative "terminal-shop/models/app"
 require_relative "terminal-shop/models/app_create_params"
 require_relative "terminal-shop/models/app_create_response"
 require_relative "terminal-shop/models/app_delete_params"
@@ -52,6 +54,8 @@ require_relative "terminal-shop/models/card_create_params"
 require_relative "terminal-shop/models/card_create_response"
 require_relative "terminal-shop/models/card_delete_params"
 require_relative "terminal-shop/models/card_delete_response"
+require_relative "terminal-shop/models/card_get_params"
+require_relative "terminal-shop/models/card_get_response"
 require_relative "terminal-shop/models/card_list_params"
 require_relative "terminal-shop/models/card_list_response"
 require_relative "terminal-shop/models/cart"
@@ -59,6 +63,10 @@ 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_redeem_gift_card_params"
+require_relative "terminal-shop/models/cart_redeem_gift_card_response"
+require_relative "terminal-shop/models/cart_remove_gift_card_params"
+require_relative "terminal-shop/models/cart_remove_gift_card_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"
@@ -75,6 +83,8 @@ require_relative "terminal-shop/models/order_get_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_get_params"
+require_relative "terminal-shop/models/product_get_response"
 require_relative "terminal-shop/models/product_list_params"
 require_relative "terminal-shop/models/product_list_response"
 require_relative "terminal-shop/models/product_variant"
@@ -87,6 +97,8 @@ require_relative "terminal-shop/models/subscription_create_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_get_params"
+require_relative "terminal-shop/models/subscription_get_response"
 require_relative "terminal-shop/models/subscription_list_params"
 require_relative "terminal-shop/models/subscription_list_response"
 require_relative "terminal-shop/models/token"

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

@@ -21,7 +21,8 @@ module TerminalShop
         ),
         body: T.nilable(T.anything),
         unwrap: T.nilable(Symbol),
-        page: T.nilable(T::Class[TerminalShop::BaseModel]),
+        page: T.nilable(T::Class[TerminalShop::BasePage[TerminalShop::BaseModel]]),
+        stream: T.nilable(T::Class[T.anything]),
         model: T.nilable(TerminalShop::Converter::Input),
         options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
       }
@@ -42,25 +43,27 @@ module TerminalShop
 
     PLATFORM_HEADERS = T::Hash[String, String]
 
-    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:)
+    class << self
+      sig { params(req: TerminalShop::BaseClient::RequestComponentsShape).void }
+      def validate!(req)
+      end
+
+      sig do
+        params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean)
+      end
+      def 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 follow_redirect(request, status:, response_headers:)
+      end
     end
 
     sig { returns(T.anything) }
@@ -82,9 +85,9 @@ module TerminalShop
                          T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))],
         idempotency_header: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(
+    def self.new(
       base_url:,
       timeout: 0.0,
       max_retries: 0,
@@ -122,22 +125,11 @@ module TerminalShop
         retry_count: Integer,
         send_retry_header: T::Boolean
       )
-        .returns([Net::HTTPResponse, T::Enumerable[String]])
+        .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
     end
     private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
     end
 
-    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
       params(
         method: Symbol,
@@ -155,7 +147,8 @@ module TerminalShop
         ),
         body: T.nilable(T.anything),
         unwrap: T.nilable(Symbol),
-        page: T.nilable(T::Class[TerminalShop::BaseModel]),
+        page: T.nilable(T::Class[TerminalShop::BasePage[TerminalShop::BaseModel]]),
+        stream: T.nilable(T::Class[T.anything]),
         model: T.nilable(TerminalShop::Converter::Input),
         options: T.nilable(T.any(TerminalShop::RequestOptions, T::Hash[Symbol, T.anything]))
       )
@@ -169,6 +162,7 @@ module TerminalShop
       body: nil,
       unwrap: nil,
       page: nil,
+      stream: nil,
       model: TerminalShop::Unknown,
       options: {}
     )