terminal-shop 1.0.0 → 1.2.0

data/lib/terminal-shop/base_page.rb

@@ -5,6 +5,26 @@ module TerminalShop
   #
   # @abstract
   #
+  # @example
+  # ```ruby
+  # if page.has_next?
+  #   page = page.next_page
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # page.auto_paging_each do |product|
+  #   puts(product)
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # products = page.to_enum.take(2)
+  #
+  # products => Array
+  # ```
   module BasePage
     # @return [Boolean]
     #

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

@@ -41,6 +41,16 @@ module TerminalShop
       #   # @return [String]
       #   attr_writer :card_id
 
+      # @!attribute [r] gift_card_id
+      #   ID of the gift card applied to the current user's cart.
+      #
+      #   @return [String, nil]
+      optional :gift_card_id, String, api_name: :giftCardID
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :gift_card_id
+
       # @!attribute [r] shipping
       #   Shipping information for the current user's cart.
       #
@@ -59,9 +69,10 @@ module TerminalShop
       #   # @param subtotal [Integer]
       #   # @param address_id [String]
       #   # @param card_id [String]
+      #   # @param gift_card_id [String]
       #   # @param shipping [TerminalShop::Models::CartAPI::Shipping]
       #   #
-      #   def initialize(amount:, items:, subtotal:, address_id: nil, card_id: nil, shipping: nil, **) = super
+      #   def initialize(amount:, items:, subtotal:, address_id: nil, card_id: nil, gift_card_id: nil, shipping: nil, **) = super
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
 
@@ -72,6 +83,16 @@ module TerminalShop
         #   @return [Integer]
         required :subtotal, Integer
 
+        # @!attribute [r] gift_card
+        #   Amount applied from gift card on the current user's cart, in cents (USD).
+        #
+        #   @return [Integer, nil]
+        optional :gift_card, Integer, api_name: :giftCard
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :gift_card
+
         # @!attribute [r] shipping
         #   Shipping amount of the current user's cart, in cents (USD).
         #
@@ -82,13 +103,25 @@ module TerminalShop
         #   # @return [Integer]
         #   attr_writer :shipping
 
+        # @!attribute [r] total
+        #   Total amount after gift card applied, in cents (USD).
+        #
+        #   @return [Integer, nil]
+        optional :total, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :total
+
         # @!parse
         #   # The subtotal and shipping amounts for the current user's cart.
         #   #
         #   # @param subtotal [Integer]
+        #   # @param gift_card [Integer]
         #   # @param shipping [Integer]
+        #   # @param total [Integer]
         #   #
-        #   def initialize(subtotal:, shipping: nil, **) = super
+        #   def initialize(subtotal:, gift_card: nil, shipping: nil, total: nil, **) = super
 
         # def initialize: (Hash | TerminalShop::BaseModel) -> void
       end

data/lib/terminal-shop/models/cart_convert_params.rb

@@ -7,10 +7,20 @@ module TerminalShop
       #   extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # @!attribute [r] recipient_email
+      #
+      #   @return [String, nil]
+      optional :recipient_email, String, api_name: :recipientEmail
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :recipient_email
+
       # @!parse
+      #   # @param recipient_email [String]
       #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
       #   #
-      #   def initialize(request_options: {}, **) = super
+      #   def initialize(recipient_email: nil, request_options: {}, **) = super
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
     end

data/lib/terminal-shop/models/cart_redeem_gift_card_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartRedeemGiftCardParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::RequestParameters
+
+      # @!attribute gift_card_id
+      #
+      #   @return [String]
+      required :gift_card_id, String, api_name: :giftCardID
+
+      # @!parse
+      #   # @param gift_card_id [String]
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(gift_card_id:, request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_redeem_gift_card_response.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartRedeemGiftCardResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   Gift card redemption result
+      #
+      #   @return [TerminalShop::Models::CartRedeemGiftCardResponse::Data]
+      required :data, -> { TerminalShop::Models::CartRedeemGiftCardResponse::Data }
+
+      # @!parse
+      #   # @param data [TerminalShop::Models::CartRedeemGiftCardResponse::Data]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+
+      class Data < TerminalShop::BaseModel
+        # @!attribute applied_amount
+        #
+        #   @return [Integer]
+        required :applied_amount, Integer, api_name: :appliedAmount
+
+        # @!attribute gift_card_id
+        #
+        #   @return [String]
+        required :gift_card_id, String, api_name: :giftCardID
+
+        # @!attribute remaining_balance
+        #
+        #   @return [Integer]
+        required :remaining_balance, Integer, api_name: :remainingBalance
+
+        # @!parse
+        #   # Gift card redemption result
+        #   #
+        #   # @param applied_amount [Integer]
+        #   # @param gift_card_id [String]
+        #   # @param remaining_balance [Integer]
+        #   #
+        #   def initialize(applied_amount:, gift_card_id:, remaining_balance:, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/terminal-shop/models/cart_remove_gift_card_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartRemoveGiftCardParams < TerminalShop::BaseModel
+      # @!parse
+      #   extend TerminalShop::RequestParameters::Converter
+      include TerminalShop::RequestParameters
+
+      # @!parse
+      #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

data/lib/terminal-shop/models/cart_remove_gift_card_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CartRemoveGiftCardResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #
+      #   @return [Symbol, :ok]
+      required :data, const: :ok
+
+      # @!parse
+      #   # @param data [Symbol, :ok]
+      #   #
+      #   def initialize(data: :ok, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -80,11 +80,6 @@ module TerminalShop
         REQUIRED = :required
 
         finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   #
-        #   def self.values; end
       end
 
       class Tags < TerminalShop::BaseModel
@@ -133,6 +128,15 @@ module TerminalShop
         #   # @return [Boolean]
         #   attr_writer :market_na
 
+        # @!attribute [r] type
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :type
+
         # @!parse
         #   # Tags for the product.
         #   #
@@ -141,8 +145,9 @@ module TerminalShop
         #   # @param featured [Boolean]
         #   # @param market_eu [Boolean]
         #   # @param market_na [Boolean]
+        #   # @param type [String]
         #   #
-        #   def initialize(app: nil, color: nil, featured: nil, market_eu: nil, market_na: nil, **) = super
+        #   def initialize(app: nil, color: nil, featured: nil, market_eu: nil, market_na: nil, type: nil, **) = super
 
         # def initialize: (Hash | TerminalShop::BaseModel) -> void
       end

data/lib/terminal-shop/pooled_net_requester.rb

@@ -48,9 +48,11 @@ module TerminalShop
       #
       #   @option request [Hash{String=>String}] :headers
       #
+      # @param blk [Proc]
+      #
       # @return [Net::HTTPGenericRequest]
       #
-      def build_request(request)
+      def build_request(request, &)
         method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
         req = Net::HTTPGenericRequest.new(
           method.to_s.upcase,
@@ -64,12 +66,14 @@ module TerminalShop
         case body
         in nil
         in String
-          req.body = body
+          req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
+          req.body_stream = TerminalShop::Util::ReadIOAdapter.new(body, &)
         in StringIO
-          req.body = body.string
-        in IO
-          body.rewind
-          req.body_stream = body
+          req["content-length"] ||= body.size.to_s unless req["transfer-encoding"]
+          req.body_stream = TerminalShop::Util::ReadIOAdapter.new(body, &)
+        in IO | Enumerator
+          req["transfer-encoding"] ||= "chunked" unless req["content-length"]
+          req.body_stream = TerminalShop::Util::ReadIOAdapter.new(body, &)
         end
 
         req
@@ -97,7 +101,7 @@ module TerminalShop
 
       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
@@ -128,7 +132,6 @@ module TerminalShop
     #
     def execute(request)
       url, deadline = request.fetch_values(:url, :deadline)
-      req = self.class.build_request(request)
 
       eof = false
       finished = false
@@ -136,6 +139,10 @@ module TerminalShop
         with_pool(url) 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)
           conn.start unless conn.started?
 
@@ -156,19 +163,25 @@ module TerminalShop
       end
 
       conn, response = enum.next
-      body = TerminalShop::Util.fused_enum(enum) do
+      body = TerminalShop::Util.fused_enum(enum, external: true) do
         finished = true
         tap do
           enum.next
         rescue StopIteration
+          nil
         end
         conn.finish if !eof && conn&.started?
       end
       [response, (response.body = body)]
     end
 
-    def initialize
+    # @private
+    #
+    # @param size [Integer]
+    #
+    def initialize(size: Etc.nprocessors)
       @mutex = Mutex.new
+      @size = size
       @pools = {}
     end
   end

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}] .