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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3091f60527a7010ac8c95c545b0d74fdf801d4275fc573515a720cbe178fe8
-  data.tar.gz: 25cef1faf2a04c0aaf4695e8c9c5ac03b51006cb69e119efa6ffd8c8967080c0
+  metadata.gz: fd3056ca007a3676c2e4252263dc95c4dd9be5f7d3ab71d38d103b1f3aaa7959
+  data.tar.gz: a691229e58ecdd3d431ccd2fcd1b3c4b18a19d4d16384f849b18778667913e96
 SHA512:
-  metadata.gz: 31a440c12cd9f04c420d2baccb9d31f592d66cec2ad7bba4b240543cfd07ce5bb3a8155499154f835b13b95e737d2a70ac3fabfad3e30b3721ec7fe306124911
-  data.tar.gz: 0c9d51f4b0e74fd05220865b119d4a9e7f23270eafee16348fc2f5ae0369f1dc89131e19607185817f3f1dfa75d34a308728ad97b2ba15d4e3c2db82352a6e19
+  metadata.gz: ac245487879b8e27da712e0c72574951d025f9ecd0f79973fce79062932dcae12abc5a9fce374d33556d013ae555751277737ee700825b79e9aea896b9ac392a
+  data.tar.gz: 457fcb73956a5e4091fa6f4fbd25b78c1e06b6dcf770e4a6df3667d51e328b010eed9f1260a4c44bf4501c30725cf8d72ae5fe739e733d8740ba9a90a321a9ba

data/lib/terminal-shop/base_client.rb

@@ -28,7 +28,7 @@ module TerminalShop
       # @raise [ArgumentError]
       #
       def validate!(req)
-        keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :model, :options]
+        keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :stream, :model, :options]
         case req
         in Hash
           req.each_key do |k|
@@ -201,6 +201,8 @@ module TerminalShop
     #
     #   @option req [Class, nil] :page
     #
+    #   @option req [Class, nil] :stream
+    #
     #   @option req [TerminalShop::Converter, Class, nil] :model
     #
     # @param opts [Hash{Symbol=>Object}] .
@@ -244,8 +246,8 @@ module TerminalShop
       end
 
       timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..))
-      unless headers.key?("x-stainless-read-timeout") || timeout.zero?
-        headers["x-stainless-read-timeout"] = timeout.to_s
+      unless headers.key?("x-stainless-timeout") || timeout.zero?
+        headers["x-stainless-timeout"] = timeout.to_s
       end
 
       headers.reject! { |_, v| v.to_s.empty? }
@@ -319,7 +321,7 @@ module TerminalShop
     # @param send_retry_header [Boolean]
     #
     # @raise [TerminalShop::APIError]
-    # @return [Array(Net::HTTPResponse, Enumerable)]
+    # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
     #
     private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
       url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
@@ -342,7 +344,7 @@ module TerminalShop
 
       case status
       in ..299
-        [response, stream]
+        [status, response, stream]
       in 300..399 if redirect_count >= self.class::MAX_REDIRECTS
         message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects."
 
@@ -360,13 +362,15 @@ module TerminalShop
         )
       in TerminalShop::APIConnectionError if retry_count >= max_retries
         raise status
-      in (400..) if retry_count >= max_retries || (response && !self.class.should_retry?(
-        status,
-        headers: response
-      ))
+      in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
         decoded = TerminalShop::Util.decode_content(response, stream: stream, suppress_error: true)
 
-        stream.each { srv_fault ? break : next }
+        if srv_fault
+          TerminalShop::Util.close_fused!(stream)
+        else
+          stream.each { next }
+        end
+
         raise TerminalShop::APIStatusError.for(
           url: url,
           status: status,
@@ -377,7 +381,11 @@ module TerminalShop
       in (400..) | TerminalShop::APIConnectionError
         delay = retry_delay(response, retry_count: retry_count)
 
-        stream&.each { srv_fault ? break : next }
+        if srv_fault
+          TerminalShop::Util.close_fused!(stream)
+        else
+          stream&.each { next }
+        end
         sleep(delay)
 
         send_request(
@@ -389,48 +397,6 @@ module TerminalShop
       end
     end
 
-    # @private
-    #
-    # @param req [Hash{Symbol=>Object}] .
-    #
-    #   @option req [Symbol] :method
-    #
-    #   @option req [String, Array<String>] :path
-    #
-    #   @option req [Hash{String=>Array<String>, String, nil}, nil] :query
-    #
-    #   @option req [Hash{String=>String, Integer, Array<String, Integer, nil>, nil}, nil] :headers
-    #
-    #   @option req [Object, nil] :body
-    #
-    #   @option req [Symbol, nil] :unwrap
-    #
-    #   @option req [Class, nil] :page
-    #
-    #   @option req [TerminalShop::Converter, Class, nil] :model
-    #
-    #   @option req [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :options
-    #
-    # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    #
-    # @param stream [Enumerable]
-    #
-    # @return [Object]
-    #
-    private def parse_response(req, headers:, stream:)
-      decoded = TerminalShop::Util.decode_content(headers, stream: stream)
-      unwrapped = TerminalShop::Util.dig(decoded, req[:unwrap])
-
-      case [req[:page], req.fetch(:model, TerminalShop::Unknown)]
-      in [Class => page, _]
-        page.new(client: self, req: req, headers: headers, unwrapped: unwrapped)
-      in [nil, Class | TerminalShop::Converter => model]
-        TerminalShop::Converter.coerce(model, unwrapped)
-      in [nil, nil]
-        unwrapped
-      end
-    end
-
     # Execute the request specified by `req`. This is the method that all resource
     #   methods call into.
     #
@@ -450,6 +416,8 @@ module TerminalShop
     #
     #   @option req [Class, nil] :page
     #
+    #   @option req [Class, nil] :stream
+    #
     #   @option req [TerminalShop::Converter, Class, nil] :model
     #
     #   @option req [TerminalShop::RequestOptions, Hash{Symbol=>Object}, nil] :options
@@ -459,19 +427,31 @@ module TerminalShop
     #
     def request(req)
       self.class.validate!(req)
+      model = req.fetch(:model) { TerminalShop::Unknown }
       opts = req[:options].to_h
       TerminalShop::RequestOptions.validate!(opts)
       request = build_request(req.except(:options), opts)
+      url = request.fetch(:url)
 
       # Don't send the current retry count in the headers if the caller modified the header defaults.
       send_retry_header = request.fetch(:headers)["x-stainless-retry-count"] == "0"
-      response, stream = send_request(
+      status, response, stream = send_request(
         request,
         redirect_count: 0,
         retry_count: 0,
         send_retry_header: send_retry_header
       )
-      parse_response(req, headers: response, stream: stream)
+
+      decoded = TerminalShop::Util.decode_content(response, stream: stream)
+      case req
+      in { stream: Class => st }
+        st.new(model: model, url: url, status: status, response: response, messages: decoded)
+      in { page: Class => page }
+        page.new(client: self, req: req, headers: response, page_data: decoded)
+      else
+        unwrapped = TerminalShop::Util.dig(decoded, req[:unwrap])
+        TerminalShop::Converter.coerce(model, unwrapped)
+      end
     end
 
     # @return [String]

data/lib/terminal-shop/base_model.rb

@@ -839,6 +839,15 @@ module TerminalShop
   #
   # @abstract
   #
+  # @example
+  # ```ruby
+  # # `product_api` is a `TerminalShop::Models::ProductAPI`
+  # product_api => {
+  #   id: id,
+  #   description: description,
+  #   name: name
+  # }
+  # ```
   class BaseModel
     extend TerminalShop::Converter
 

data/lib/terminal-shop/base_page.rb

@@ -33,8 +33,8 @@ module TerminalShop
     #   # @param client [TerminalShop::BaseClient]
     #   # @param req [Hash{Symbol=>Object}]
     #   # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    #   # @param unwrapped [Object]
+    #   # @param page_data [Object]
     #   #
-    #   def initialize(client:, req:, headers:, unwrapped:); end
+    #   def initialize(client:, req:, headers:, page_data:); end
   end
 end

data/lib/terminal-shop/client.rb

@@ -65,7 +65,7 @@ module TerminalShop
     private def auth_headers
       return {} if @bearer_token.nil?
 
-      {"Authorization" => "Bearer #{@bearer_token}"}
+      {"authorization" => "Bearer #{@bearer_token}"}
     end
 
     # Creates and returns a new client for interacting with the API.

data/lib/terminal-shop/errors.rb

@@ -99,11 +99,12 @@ module TerminalShop
     # @param body [Object, nil]
     # @param request [nil]
     # @param response [nil]
+    # @param message [String, nil]
     #
     # @return [TerminalShop::APIStatusError]
     #
-    def self.for(url:, status:, body:, request:, response:)
-      kwargs = {url: url, status: status, body: body, request: request, response: response}
+    def self.for(url:, status:, body:, request:, response:, message: nil)
+      kwargs = {url: url, status: status, body: body, request: request, response: response, message: message}
 
       case status
       in 400

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class AddressGetParams < 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/address_get_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class AddressGetResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   Physical address associated with a Terminal shop user.
+      #
+      #   @return [TerminalShop::Models::AddressAPI]
+      required :data, -> { TerminalShop::Models::AddressAPI }
+
+      # @!parse
+      #   # @param data [TerminalShop::Models::AddressAPI]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -2,15 +2,27 @@
 
 module TerminalShop
   module Models
-    class AppCreateParams < TerminalShop::Models::AppAPI
+    class AppCreateParams < TerminalShop::BaseModel
       # @!parse
       #   extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute redirect_uri
+      #
+      #   @return [String]
+      required :redirect_uri, String, api_name: :redirectURI
+
       # @!parse
+      #   # @param name [String]
+      #   # @param redirect_uri [String]
       #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
       #   #
-      #   def initialize(request_options: {}, **) = super
+      #   def initialize(name:, redirect_uri:, request_options: {}, **) = super
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
     end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CardGetParams < 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/card_get_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class CardGetResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   Credit card used for payments in the Terminal shop.
+      #
+      #   @return [TerminalShop::Models::CardAPI]
+      required :data, -> { TerminalShop::Models::CardAPI }
+
+      # @!parse
+      #   # @param data [TerminalShop::Models::CardAPI]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -15,11 +15,6 @@ module TerminalShop
       #   @return [String]
       required :description, String
 
-      # @!attribute filters
-      #
-      #   @return [Array<Symbol, TerminalShop::Models::ProductAPI::Filter>]
-      required :filters, -> { TerminalShop::ArrayOf[enum: TerminalShop::Models::ProductAPI::Filter] }
-
       # @!attribute name
       #   Name of the product.
       #
@@ -55,11 +50,11 @@ module TerminalShop
       # @!attribute [r] tags
       #   Tags for the product.
       #
-      #   @return [Hash{Symbol=>String}, nil]
-      optional :tags, TerminalShop::HashOf[String]
+      #   @return [TerminalShop::Models::ProductAPI::Tags, nil]
+      optional :tags, -> { TerminalShop::Models::ProductAPI::Tags }
 
       # @!parse
-      #   # @return [Hash{Symbol=>String}]
+      #   # @return [TerminalShop::Models::ProductAPI::Tags]
       #   attr_writer :tags
 
       # @!parse
@@ -67,31 +62,22 @@ module TerminalShop
       #   #
       #   # @param id [String]
       #   # @param description [String]
-      #   # @param filters [Array<Symbol, TerminalShop::Models::ProductAPI::Filter>]
       #   # @param name [String]
       #   # @param variants [Array<TerminalShop::Models::ProductVariant>]
       #   # @param order [Integer]
       #   # @param subscription [Symbol, TerminalShop::Models::ProductAPI::Subscription]
-      #   # @param tags [Hash{Symbol=>String}]
+      #   # @param tags [TerminalShop::Models::ProductAPI::Tags]
       #   #
-      #   def initialize(id:, description:, filters:, name:, variants:, order: nil, subscription: nil, tags: nil, **) = super
+      #   def initialize(id:, description:, name:, variants:, order: nil, subscription: nil, tags: nil, **) = super
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
 
       # @abstract
       #
-      # @example
-      # ```ruby
-      # case filter
-      # in :eu
-      #   # ...
-      # in :na
-      #   # ...
-      # end
-      # ```
-      class Filter < TerminalShop::Enum
-        EU = :eu
-        NA = :na
+      # Whether the product must be or can be subscribed to.
+      class Subscription < TerminalShop::Enum
+        ALLOWED = :allowed
+        REQUIRED = :required
 
         finalize!
 
@@ -101,29 +87,64 @@ module TerminalShop
         #   def self.values; end
       end
 
-      # @abstract
-      #
-      # Whether the product must be or can be subscribed to.
-      #
-      # @example
-      # ```ruby
-      # case subscription
-      # in :allowed
-      #   # ...
-      # in :required
-      #   # ...
-      # end
-      # ```
-      class Subscription < TerminalShop::Enum
-        ALLOWED = :allowed
-        REQUIRED = :required
+      class Tags < TerminalShop::BaseModel
+        # @!attribute [r] app
+        #
+        #   @return [String, nil]
+        optional :app, String
 
-        finalize!
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :app
+
+        # @!attribute [r] color
+        #
+        #   @return [String, nil]
+        optional :color, String
 
         # @!parse
-        #   # @return [Array<Symbol>]
+        #   # @return [String]
+        #   attr_writer :color
+
+        # @!attribute [r] featured
+        #
+        #   @return [Boolean, nil]
+        optional :featured, TerminalShop::BooleanModel
+
+        # @!parse
+        #   # @return [Boolean]
+        #   attr_writer :featured
+
+        # @!attribute [r] market_eu
+        #
+        #   @return [Boolean, nil]
+        optional :market_eu, TerminalShop::BooleanModel
+
+        # @!parse
+        #   # @return [Boolean]
+        #   attr_writer :market_eu
+
+        # @!attribute [r] market_na
+        #
+        #   @return [Boolean, nil]
+        optional :market_na, TerminalShop::BooleanModel
+
+        # @!parse
+        #   # @return [Boolean]
+        #   attr_writer :market_na
+
+        # @!parse
+        #   # Tags for the product.
         #   #
-        #   def self.values; end
+        #   # @param app [String]
+        #   # @param color [String]
+        #   # @param featured [Boolean]
+        #   # @param market_eu [Boolean]
+        #   # @param market_na [Boolean]
+        #   #
+        #   def initialize(app: nil, color: nil, featured: nil, market_eu: nil, market_na: nil, **) = super
+
+        # def initialize: (Hash | TerminalShop::BaseModel) -> void
       end
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class ProductGetParams < 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/product_get_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class ProductGetResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   Product sold in the Terminal shop.
+      #
+      #   @return [TerminalShop::Models::ProductAPI]
+      required :data, -> { TerminalShop::Models::ProductAPI }
+
+      # @!parse
+      #   # @param data [TerminalShop::Models::ProductAPI]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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

@@ -8,23 +8,21 @@ module TerminalShop
       include TerminalShop::RequestParameters
 
       # @!attribute email
-      #   Email address of the user.
       #
-      #   @return [String, nil]
-      optional :email, String, nil?: true
+      #   @return [String]
+      required :email, String
 
       # @!attribute name
-      #   Name of the user.
       #
-      #   @return [String, nil]
-      optional :name, String, nil?: true
+      #   @return [String]
+      required :name, String
 
       # @!parse
-      #   # @param email [String, nil]
-      #   # @param name [String, nil]
+      #   # @param email [String]
+      #   # @param name [String]
       #   # @param request_options [TerminalShop::RequestOptions, Hash{Symbol=>Object}]
       #   #
-      #   def initialize(email: nil, name: nil, request_options: {}, **) = super
+      #   def initialize(email:, name:, request_options: {}, **) = super
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
     end

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

@@ -71,16 +71,6 @@ module TerminalShop
       # @abstract
       #
       # Schedule of the subscription.
-      #
-      # @example
-      # ```ruby
-      # case schedule
-      # in TerminalShop::Models::SubscriptionAPI::Schedule::Fixed
-      #   # ...
-      # in TerminalShop::Models::SubscriptionAPI::Schedule::Weekly
-      #   # ...
-      # end
-      # ```
       class Schedule < TerminalShop::Union
         variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Fixed }
 

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class SubscriptionGetParams < 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/subscription_get_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Models
+    class SubscriptionGetResponse < TerminalShop::BaseModel
+      # @!attribute data
+      #   Subscription to a Terminal shop product.
+      #
+      #   @return [TerminalShop::Models::SubscriptionAPI]
+      required :data, -> { TerminalShop::Models::SubscriptionAPI }
+
+      # @!parse
+      #   # @param data [TerminalShop::Models::SubscriptionAPI]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | TerminalShop::BaseModel) -> void
+    end
+  end
+end

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