terminal-shop 1.8.0 → 2.0.0

data/lib/terminal-shop/base_page.rb

@@ -2,32 +2,29 @@
 
 module TerminalShop
   # @example
-  # ```ruby
-  # if page.has_next?
-  #   page = page.next_page
-  # end
-  # ```
+  #   if page.has_next?
+  #     page = page.next_page
+  #   end
   #
   # @example
-  # ```ruby
-  # page.auto_paging_each do |product|
-  #   puts(product)
-  # end
-  # ```
+  #   page.auto_paging_each do |product|
+  #     puts(product)
+  #   end
   #
   # @example
-  # ```ruby
-  # products = page
-  #   .to_enum
-  #   .lazy
-  #   .select { _1.object_id.even? }
-  #   .map(&:itself)
-  #   .take(2)
-  #   .to_a
+  #   products =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # products => Array
-  # ```
+  #   products => Array
   module BasePage
+    # rubocop:disable Lint/UnusedMethodArgument
+
     # @return [Boolean]
     def next_page? = (raise NotImplementedError)
 
@@ -56,5 +53,7 @@ module TerminalShop
       @req = req
       super()
     end
+
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/terminal-shop/client.rb

@@ -16,6 +16,7 @@ module TerminalShop
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
     # rubocop:disable Style/MutableConstant
+    # @type [Hash{Symbol=>String}]
     ENVIRONMENTS = {production: "https://api.terminal.shop/", dev: "https://api.dev.terminal.shop/"}
     # rubocop:enable Style/MutableConstant
 

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

@@ -72,14 +72,18 @@ module TerminalShop
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
 
-      # @abstract
-      #
       # Whether the product must be or can be subscribed to.
-      class Subscription < TerminalShop::Enum
+      module Subscription
+        extend TerminalShop::Enum
+
         ALLOWED = :allowed
         REQUIRED = :required
 
         finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
       end
 
       class Tags < TerminalShop::BaseModel

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

@@ -2,14 +2,18 @@
 
 module TerminalShop
   module Models
-    # @abstract
-    #
     # A Terminal shop user's region.
-    class Region < TerminalShop::Enum
+    module Region
+      extend TerminalShop::Enum
+
       EU = :eu
       NA = :na
 
       finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   def self.values; end
     end
   end
 end

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

@@ -68,10 +68,10 @@ module TerminalShop
 
       # def initialize: (Hash | TerminalShop::BaseModel) -> void
 
-      # @abstract
-      #
       # Schedule of the subscription.
-      class Schedule < TerminalShop::Union
+      module Schedule
+        extend TerminalShop::Union
+
         variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Fixed }
 
         variant -> { TerminalShop::Models::SubscriptionAPI::Schedule::Weekly }
@@ -111,10 +111,8 @@ module TerminalShop
         end
 
         # @!parse
-        #   class << self
-        #     # @return [Array(TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly)]
-        #     def variants; end
-        #   end
+        #   # @return [Array(TerminalShop::Models::SubscriptionAPI::Schedule::Fixed, TerminalShop::Models::SubscriptionAPI::Schedule::Weekly)]
+        #   def self.variants; end
       end
     end
   end

data/lib/terminal-shop/pooled_net_requester.rb

@@ -3,6 +3,10 @@
 module TerminalShop
   # @api private
   class PooledNetRequester
+    # from the golang stdlib
+    #   https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+    KEEP_ALIVE_TIMEOUT = 30
+
     class << self
       # @api private
       #
@@ -47,6 +51,7 @@ module TerminalShop
       #
       # @param blk [Proc]
       #
+      # @yieldparam [String]
       # @return [Net::HTTPGenericRequest]
       def build_request(request, &)
         method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
@@ -82,6 +87,9 @@ module TerminalShop
     # @param url [URI::Generic]
     # @param deadline [Float]
     # @param blk [Proc]
+    #
+    # @raise [Timeout::Error]
+    # @yieldparam [Net::HTTP]
     private def with_pool(url, deadline:, &blk)
       origin = TerminalShop::Util.uri_origin(url)
       timeout = deadline - TerminalShop::Util.monotonic_secs
@@ -124,7 +132,10 @@ module TerminalShop
           end
 
           self.class.calibrate_socket_timeout(conn, deadline)
-          conn.start unless conn.started?
+          unless conn.started?
+            conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+            conn.start
+          end
 
           self.class.calibrate_socket_timeout(conn, deadline)
           conn.request(req) do |rsp|

data/lib/terminal-shop/request_options.rb

@@ -83,7 +83,7 @@ module TerminalShop
     #   Extra data to send with the request. These are deep merged into any data
     #     generated as part of the normal request.
     #
-    #   @return [Hash{Symbol=>Object}, nil]
+    #   @return [Object, nil]
     optional :extra_body, TerminalShop::HashOf[TerminalShop::Unknown]
 
     # @!attribute max_retries

data/lib/terminal-shop/util.rb

@@ -367,13 +367,14 @@ module TerminalShop
       # @return [Hash{String=>String}]
       def normalized_headers(*headers)
         {}.merge(*headers.compact).to_h do |key, val|
-          case val
-          in Array
-            val.map { _1.to_s.strip }.join(", ")
-          else
-            val&.to_s&.strip
-          end
-          [key.downcase, val]
+          value =
+            case val
+            in Array
+              val.map { _1.to_s.strip }.join(", ")
+            else
+              val&.to_s&.strip
+            end
+          [key.downcase, value]
         end
       end
     end
@@ -428,6 +429,8 @@ module TerminalShop
       #
       # @param stream [String, IO, StringIO, Enumerable]
       # @param blk [Proc]
+      #
+      # @yieldparam [String]
       def initialize(stream, &blk)
         @stream = stream.is_a?(String) ? StringIO.new(stream) : stream
         @buf = String.new.b
@@ -438,6 +441,7 @@ module TerminalShop
     class << self
       # @param blk [Proc]
       #
+      # @yieldparam [Enumerator::Yielder]
       # @return [Enumerable]
       def string_io(&blk)
         Enumerator.new do |y|
@@ -452,6 +456,8 @@ module TerminalShop
     end
 
     class << self
+      # rubocop:disable Naming/MethodParameterName
+
       # @api private
       #
       # @param y [Enumerator::Yielder]
@@ -490,6 +496,8 @@ module TerminalShop
         y << "\r\n"
       end
 
+      # rubocop:enable Naming/MethodParameterName
+
       # @api private
       #
       # @param body [Object]
@@ -628,6 +636,7 @@ module TerminalShop
       # @param enum [Enumerable, nil]
       # @param blk [Proc]
       #
+      # @yieldparam [Enumerator::Yielder]
       # @return [Enumerable]
       def chain_fused(enum, &blk)
         iter = Enumerator.new { blk.call(_1) }

data/lib/terminal-shop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TerminalShop
-  VERSION = "1.8.0"
+  VERSION = "2.0.0"
 end

data/lib/terminal-shop.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) && caller_locations.any? { _1.path.end_with?("tapioca/cli.rb") }
+  Warning.warn(
+    <<~WARN
+      \n
+      ⚠️ skipped loading of "terminal-shop" gem under `tapioca`.
+
+      This message is normal and expected if you are running a `tapioca` command, and does not impact `.rbi` generation.
+      \n
+    WARN
+  )
+  return
+end
+
 # Standard libraries.
 require "cgi"
 require "date"

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

@@ -5,41 +5,44 @@ module TerminalShop
   class BaseClient
     abstract!
 
-    RequestComponentsShape = T.type_alias do
-      {
-        method: Symbol,
-        path: T.any(String, T::Array[String]),
-        query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
-        headers: T.nilable(
-          T::Hash[String,
-                  T.nilable(
-                    T.any(
-                      String,
-                      Integer,
-                      T::Array[T.nilable(T.any(String, Integer))]
-                    )
-                  )]
-        ),
-        body: T.nilable(T.anything),
-        unwrap: T.nilable(Symbol),
-        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]))
-      }
-    end
+    RequestComponentsShape =
+      T.type_alias do
+        {
+          method: Symbol,
+          path: T.any(String, T::Array[String]),
+          query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
+          headers: T.nilable(
+            T::Hash[String,
+                    T.nilable(
+                      T.any(
+                        String,
+                        Integer,
+                        T::Array[T.nilable(T.any(String, Integer))]
+                      )
+                    )]
+          ),
+          body: T.nilable(T.anything),
+          unwrap: T.nilable(Symbol),
+          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, TerminalShop::Util::AnyHash))
+        }
+      end
 
-    RequestInputShape = T.type_alias do
-      {
-        method: Symbol,
-        url: URI::Generic,
-        headers: T::Hash[String, String],
-        body: T.anything,
-        max_retries: Integer,
-        timeout: Float
-      }
-    end
+    RequestInputShape =
+      T.type_alias do
+        {
+          method: Symbol,
+          url: URI::Generic,
+          headers: T::Hash[String, String],
+          body: T.anything,
+          max_retries: Integer,
+          timeout: Float
+        }
+      end
 
+    # from whatwg fetch spec
     MAX_REDIRECTS = 20
 
     PLATFORM_HEADERS = T::Hash[String, String]
@@ -81,13 +84,9 @@ module TerminalShop
       end
     end
 
+    # @api private
     sig { returns(T.anything) }
-    def requester
-    end
-
-    sig { params(_: T.anything).returns(T.anything) }
-    def requester=(_)
-    end
+    attr_accessor :requester
 
     # @api private
     sig do
@@ -127,7 +126,7 @@ module TerminalShop
     # @api private
     sig do
       overridable
-        .params(req: TerminalShop::BaseClient::RequestComponentsShape, opts: T::Hash[Symbol, T.anything])
+        .params(req: TerminalShop::BaseClient::RequestComponentsShape, opts: TerminalShop::Util::AnyHash)
         .returns(TerminalShop::BaseClient::RequestInputShape)
     end
     private def build_request(req, opts)
@@ -173,7 +172,7 @@ module TerminalShop
         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]))
+        options: T.nilable(T.any(TerminalShop::RequestOptions, TerminalShop::Util::AnyHash))
       )
         .returns(T.anything)
     end