terminal-shop 1.6.0 → 1.8.0

data/lib/terminal-shop/base_page.rb

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  # @private
-  #
-  # @abstract
-  #
   # @example
   # ```ruby
   # if page.has_next?
@@ -21,40 +17,44 @@ module TerminalShop
   #
   # @example
   # ```ruby
-  # products = page.to_enum.take(2)
+  # products = page
+  #   .to_enum
+  #   .lazy
+  #   .select { _1.object_id.even? }
+  #   .map(&:itself)
+  #   .take(2)
+  #   .to_a
   #
   # products => Array
   # ```
   module BasePage
     # @return [Boolean]
-    #
     def next_page? = (raise NotImplementedError)
 
     # @raise [TerminalShop::APIError]
     # @return [TerminalShop::BasePage]
-    #
     def next_page = (raise NotImplementedError)
 
     # @param blk [Proc]
     #
     # @return [void]
-    #
     def auto_paging_each(&) = (raise NotImplementedError)
 
     # @return [Enumerable]
-    #
     def to_enum = super(:auto_paging_each)
 
     alias_method :enum_for, :to_enum
 
-    # @!parse
-    #   # @private
-    #   #
-    #   # @param client [TerminalShop::BaseClient]
-    #   # @param req [Hash{Symbol=>Object}]
-    #   # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    #   # @param page_data [Object]
-    #   #
-    #   def initialize(client:, req:, headers:, page_data:); end
+    # @api private
+    #
+    # @param client [TerminalShop::BaseClient]
+    # @param req [Hash{Symbol=>Object}]
+    # @param headers [Hash{String=>String}, Net::HTTPHeader]
+    # @param page_data [Object]
+    def initialize(client:, req:, headers:, page_data:)
+      @client = client
+      @req = req
+      super()
+    end
   end
 end

data/lib/terminal-shop/client.rb

@@ -58,10 +58,9 @@ module TerminalShop
     # @return [TerminalShop::Resources::View]
     attr_reader :view
 
-    # @private
+    # @api private
     #
     # @return [Hash{String=>String}]
-    #
     private def auth_headers
       return {} if @bearer_token.nil?
 
@@ -90,7 +89,6 @@ module TerminalShop
     # @param initial_retry_delay [Float]
     #
     # @param max_retry_delay [Float]
-    #
     def initialize(
       environment: nil,
       base_url: nil,

data/lib/terminal-shop/errors.rb

@@ -4,7 +4,7 @@ module TerminalShop
   class Error < StandardError
     # @!parse
     #   # @return [StandardError, nil]
-    #   attr_reader :cause
+    #   attr_accessor :cause
   end
 
   class ConversionError < TerminalShop::Error
@@ -12,15 +12,15 @@ module TerminalShop
 
   class APIError < TerminalShop::Error
     # @return [URI::Generic]
-    attr_reader :url
+    attr_accessor :url
 
     # @return [Integer, nil]
-    attr_reader :status
+    attr_accessor :status
 
     # @return [Object, nil]
-    attr_reader :body
+    attr_accessor :body
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer, nil]
@@ -28,7 +28,6 @@ module TerminalShop
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
       @url = url
       @status = status
@@ -42,13 +41,13 @@ module TerminalShop
   class APIConnectionError < TerminalShop::APIError
     # @!parse
     #   # @return [nil]
-    #   attr_reader :status
+    #   attr_accessor :status
 
     # @!parse
     #   # @return [nil]
-    #   attr_reader :body
+    #   attr_accessor :body
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [nil]
@@ -56,7 +55,6 @@ module TerminalShop
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(
       url:,
       status: nil,
@@ -70,7 +68,7 @@ module TerminalShop
   end
 
   class APITimeoutError < TerminalShop::APIConnectionError
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [nil]
@@ -78,7 +76,6 @@ module TerminalShop
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(
       url:,
       status: nil,
@@ -92,7 +89,7 @@ module TerminalShop
   end
 
   class APIStatusError < TerminalShop::APIError
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer]
@@ -102,7 +99,6 @@ module TerminalShop
     # @param message [String, nil]
     #
     # @return [TerminalShop::APIStatusError]
-    #
     def self.for(url:, status:, body:, request:, response:, message: nil)
       kwargs = {url: url, status: status, body: body, request: request, response: response, message: message}
 
@@ -130,9 +126,9 @@ module TerminalShop
 
     # @!parse
     #   # @return [Integer]
-    #   attr_reader :status
+    #   attr_accessor :status
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer]
@@ -140,7 +136,6 @@ module TerminalShop
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(url:, status:, body:, request:, response:, message: nil)
       message ||= {url: url.to_s, status: status, body: body}
       super(

data/lib/terminal-shop/extern.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  # @private
-  #
-  # @abstract
-  #
+  # @api private
   module Extern
   end
 end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    # @abstract
+    #
+    # A Terminal shop user's region.
+    class Region < TerminalShop::Enum
+      EU = :eu
+      NA = :na
+
+      finalize!
+    end
+  end
+end

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

@@ -109,6 +109,12 @@ module TerminalShop
 
           # def initialize: (Hash | TerminalShop::BaseModel) -> void
         end
+
+        # @!parse
+        #   class << self
+        #     # @return [Array(TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly)]
+        #     def variants; end
+        #   end
       end
     end
   end

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

@@ -57,8 +57,8 @@ module TerminalShop
         # @!attribute region
         #   A Terminal shop user's region.
         #
-        #   @return [Symbol, TerminalShop::Models::ViewInitResponse::Data::Region]
-        required :region, enum: -> { TerminalShop::Models::ViewInitResponse::Data::Region }
+        #   @return [Symbol, TerminalShop::Models::Region]
+        required :region, enum: -> { TerminalShop::Models::Region }
 
         # @!attribute subscriptions
         #
@@ -80,23 +80,13 @@ module TerminalShop
         #   # @param orders [Array<TerminalShop::Models::OrderAPI>]
         #   # @param products [Array<TerminalShop::Models::ProductAPI>]
         #   # @param profile [TerminalShop::Models::ProfileAPI]
-        #   # @param region [Symbol, TerminalShop::Models::ViewInitResponse::Data::Region]
+        #   # @param region [Symbol, TerminalShop::Models::Region]
         #   # @param subscriptions [Array<TerminalShop::Models::SubscriptionAPI>]
         #   # @param tokens [Array<TerminalShop::Models::TokenAPI>]
         #   #
         #   def initialize(addresses:, apps:, cards:, cart:, orders:, products:, profile:, region:, subscriptions:, tokens:, **) = super
 
         # def initialize: (Hash | TerminalShop::BaseModel) -> void
-
-        # @abstract
-        #
-        # A Terminal shop user's region.
-        class Region < TerminalShop::Enum
-          EU = :eu
-          NA = :na
-
-          finalize!
-        end
       end
     end
   end

data/lib/terminal-shop/pooled_net_requester.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  # @private
-  #
+  # @api private
   class PooledNetRequester
     class << self
-      # @private
+      # @api private
       #
       # @param url [URI::Generic]
       #
       # @return [Net::HTTP]
-      #
       def connect(url)
         port =
           case [url.port, url.scheme]
@@ -28,17 +26,16 @@ module TerminalShop
         end
       end
 
-      # @private
+      # @api private
       #
       # @param conn [Net::HTTP]
       # @param deadline [Float]
-      #
       def calibrate_socket_timeout(conn, deadline)
         timeout = deadline - TerminalShop::Util.monotonic_secs
         conn.open_timeout = conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout
       end
 
-      # @private
+      # @api private
       #
       # @param request [Hash{Symbol=>Object}] .
       #
@@ -51,7 +48,6 @@ module TerminalShop
       # @param blk [Proc]
       #
       # @return [Net::HTTPGenericRequest]
-      #
       def build_request(request, &)
         method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
         req = Net::HTTPGenericRequest.new(
@@ -65,6 +61,7 @@ module TerminalShop
 
         case body
         in nil
+          nil
         in String
           req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
           req.body_stream = TerminalShop::Util::ReadIOAdapter.new(body, &)
@@ -80,13 +77,14 @@ module TerminalShop
       end
     end
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
+    # @param deadline [Float]
     # @param blk [Proc]
-    #
-    private def with_pool(url, &)
+    private def with_pool(url, deadline:, &blk)
       origin = TerminalShop::Util.uri_origin(url)
+      timeout = deadline - TerminalShop::Util.monotonic_secs
       pool =
         @mutex.synchronize do
           @pools[origin] ||= ConnectionPool.new(size: @size) do
@@ -94,10 +92,10 @@ module TerminalShop
           end
         end
 
-      pool.with(&)
+      pool.with(timeout: timeout, &blk)
     end
 
-    # @private
+    # @api private
     #
     # @param request [Hash{Symbol=>Object}] .
     #
@@ -111,15 +109,14 @@ module TerminalShop
     #
     #   @option request [Float] :deadline
     #
-    # @return [Array(Net::HTTPResponse, Enumerable)]
-    #
+    # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
     def execute(request)
       url, deadline = request.fetch_values(:url, :deadline)
 
       eof = false
       finished = false
       enum = Enumerator.new do |y|
-        with_pool(url) do |conn|
+        with_pool(url, deadline: deadline) do |conn|
           next if finished
 
           req = self.class.build_request(request) do
@@ -131,7 +128,7 @@ module TerminalShop
 
           self.class.calibrate_socket_timeout(conn, deadline)
           conn.request(req) do |rsp|
-            y << [conn, rsp]
+            y << [conn, req, rsp]
             break if finished
 
             rsp.read_body do |bytes|
@@ -143,9 +140,11 @@ module TerminalShop
             eof = true
           end
         end
+      rescue Timeout::Error
+        raise TerminalShop::APITimeoutError
       end
 
-      conn, response = enum.next
+      conn, _, response = enum.next
       body = TerminalShop::Util.fused_enum(enum, external: true) do
         finished = true
         tap do
@@ -155,13 +154,12 @@ module TerminalShop
         end
         conn.finish if !eof && conn&.started?
       end
-      [response, (response.body = body)]
+      [Integer(response.code), response, (response.body = body)]
     end
 
-    # @private
+    # @api private
     #
     # @param size [Integer]
-    #
     def initialize(size: Etc.nprocessors)
       @mutex = Mutex.new
       @size = size

data/lib/terminal-shop/request_options.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  # @private
-  #
-  # @abstract
-  #
+  # @api private
   module RequestParameters
     # @!parse
     #   # Options to specify HTTP behaviour for this request.
@@ -12,7 +9,6 @@ module TerminalShop
     #   attr_accessor :request_options
 
     # @param mod [Module]
-    #
     def self.included(mod)
       return unless mod <= TerminalShop::BaseModel
 
@@ -20,15 +16,13 @@ module TerminalShop
       mod.optional(:request_options, TerminalShop::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 TerminalShop
   #   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 < TerminalShop::BaseModel
-    # @private
+    # @api private
     #
     # @param opts [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
     #
     # @raise [ArgumentError]
-    #
     def self.validate!(opts)
       case opts
       in TerminalShop::RequestOptions | Hash

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

@@ -26,7 +26,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AddressCreateResponse]
-      #
       def create(params)
         parsed, options = TerminalShop::Models::AddressCreateParams.dump_request(params)
         @client.request(
@@ -45,7 +44,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AddressListResponse]
-      #
       def list(params = {})
         @client.request(
           method: :get,
@@ -64,7 +62,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AddressDeleteResponse]
-      #
       def delete(id, params = {})
         @client.request(
           method: :delete,
@@ -83,7 +80,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AddressGetResponse]
-      #
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -94,7 +90,6 @@ module TerminalShop
       end
 
       # @param client [TerminalShop::Client]
-      #
       def initialize(client:)
         @client = client
       end

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

@@ -14,7 +14,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AppCreateResponse]
-      #
       def create(params)
         parsed, options = TerminalShop::Models::AppCreateParams.dump_request(params)
         @client.request(
@@ -33,7 +32,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AppListResponse]
-      #
       def list(params = {})
         @client.request(
           method: :get,
@@ -52,7 +50,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AppDeleteResponse]
-      #
       def delete(id, params = {})
         @client.request(
           method: :delete,
@@ -71,7 +68,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::AppGetResponse]
-      #
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -82,7 +78,6 @@ module TerminalShop
       end
 
       # @param client [TerminalShop::Client]
-      #
       def initialize(client:)
         @client = client
       end

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

@@ -13,7 +13,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CardCreateResponse]
-      #
       def create(params)
         parsed, options = TerminalShop::Models::CardCreateParams.dump_request(params)
         @client.request(
@@ -32,7 +31,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CardListResponse]
-      #
       def list(params = {})
         @client.request(
           method: :get,
@@ -51,7 +49,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CardDeleteResponse]
-      #
       def delete(id, params = {})
         @client.request(
           method: :delete,
@@ -69,7 +66,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CardCollectResponse]
-      #
       def collect(params = {})
         @client.request(
           method: :post,
@@ -88,7 +84,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CardGetResponse]
-      #
       def get(id, params = {})
         @client.request(
           method: :get,
@@ -99,7 +94,6 @@ module TerminalShop
       end
 
       # @param client [TerminalShop::Client]
-      #
       def initialize(client:)
         @client = client
       end

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

@@ -10,7 +10,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CartClearResponse]
-      #
       def clear(params = {})
         @client.request(
           method: :delete,
@@ -27,7 +26,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CartConvertResponse]
-      #
       def convert(params = {})
         @client.request(
           method: :post,
@@ -44,7 +42,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CartGetResponse]
-      #
       def get(params = {})
         @client.request(
           method: :get,
@@ -63,7 +60,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CartSetAddressResponse]
-      #
       def set_address(params)
         parsed, options = TerminalShop::Models::CartSetAddressParams.dump_request(params)
         @client.request(
@@ -84,7 +80,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CartSetCardResponse]
-      #
       def set_card(params)
         parsed, options = TerminalShop::Models::CartSetCardParams.dump_request(params)
         @client.request(
@@ -107,7 +102,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::CartSetItemResponse]
-      #
       def set_item(params)
         parsed, options = TerminalShop::Models::CartSetItemParams.dump_request(params)
         @client.request(
@@ -120,7 +114,6 @@ module TerminalShop
       end
 
       # @param client [TerminalShop::Client]
-      #
       def initialize(client:)
         @client = client
       end

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

@@ -12,7 +12,6 @@ module TerminalShop
       #   @option params [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [TerminalShop::Models::EmailCreateResponse]
-      #
       def create(params)
         parsed, options = TerminalShop::Models::EmailCreateParams.dump_request(params)
         @client.request(
@@ -25,7 +24,6 @@ module TerminalShop
       end
 
       # @param client [TerminalShop::Client]
-      #
       def initialize(client:)
         @client = client
       end