onebusaway-sdk 0.1.0.pre.alpha.205 → 0.1.0.pre.alpha.207

data/lib/onebusaway-sdk/base_page.rb

@@ -1,40 +1,60 @@
 # frozen_string_literal: true
 
 module OnebusawaySDK
-  # @private
+  # @example
+  # ```ruby
+  # if page.has_next?
+  #   page = page.next_page
+  # end
+  # ```
   #
-  # @abstract
+  # @example
+  # ```ruby
+  # page.auto_paging_each do |agencies_with_coverage|
+  #   puts(agencies_with_coverage)
+  # end
+  # ```
   #
+  # @example
+  # ```ruby
+  # agencies_with_coverages = page
+  #   .to_enum
+  #   .lazy
+  #   .select { _1.object_id.even? }
+  #   .map(&:itself)
+  #   .take(2)
+  #   .to_a
+  #
+  # agencies_with_coverages => Array
+  # ```
   module BasePage
     # @return [Boolean]
-    #
     def next_page? = (raise NotImplementedError)
 
     # @raise [OnebusawaySDK::APIError]
     # @return [OnebusawaySDK::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 [OnebusawaySDK::BaseClient]
-    #   # @param req [Hash{Symbol=>Object}]
-    #   # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    #   # @param unwrapped [Object]
-    #   #
-    #   def initialize(client:, req:, headers:, unwrapped:); end
+    # @api private
+    #
+    # @param client [OnebusawaySDK::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/onebusaway-sdk/client.rb

@@ -102,10 +102,9 @@ module OnebusawaySDK
     # @return [OnebusawaySDK::Resources::Shape]
     attr_reader :shape
 
-    # @private
+    # @api private
     #
     # @return [Hash{String=>String}]
-    #
     private def auth_query
       {"key" => @api_key}
     end
@@ -123,7 +122,6 @@ module OnebusawaySDK
     # @param initial_retry_delay [Float]
     #
     # @param max_retry_delay [Float]
-    #
     def initialize(
       base_url: nil,
       api_key: ENV["ONEBUSAWAY_API_KEY"],

data/lib/onebusaway-sdk/errors.rb

@@ -4,7 +4,7 @@ module OnebusawaySDK
   class Error < StandardError
     # @!parse
     #   # @return [StandardError, nil]
-    #   attr_reader :cause
+    #   attr_accessor :cause
   end
 
   class ConversionError < OnebusawaySDK::Error
@@ -12,15 +12,15 @@ module OnebusawaySDK
 
   class APIError < OnebusawaySDK::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 OnebusawaySDK
     # @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 OnebusawaySDK
   class APIConnectionError < OnebusawaySDK::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 OnebusawaySDK
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(
       url:,
       status: nil,
@@ -70,7 +68,7 @@ module OnebusawaySDK
   end
 
   class APITimeoutError < OnebusawaySDK::APIConnectionError
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [nil]
@@ -78,7 +76,6 @@ module OnebusawaySDK
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(
       url:,
       status: nil,
@@ -92,18 +89,18 @@ module OnebusawaySDK
   end
 
   class APIStatusError < OnebusawaySDK::APIError
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer]
     # @param body [Object, nil]
     # @param request [nil]
     # @param response [nil]
+    # @param message [String, nil]
     #
     # @return [OnebusawaySDK::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
@@ -129,9 +126,9 @@ module OnebusawaySDK
 
     # @!parse
     #   # @return [Integer]
-    #   attr_reader :status
+    #   attr_accessor :status
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer]
@@ -139,7 +136,6 @@ module OnebusawaySDK
     # @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/onebusaway-sdk/extern.rb

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

data/lib/onebusaway-sdk/models/references.rb

@@ -671,22 +671,6 @@ module OnebusawaySDK
         # @abstract
         #
         # Reason for the service alert, taken from TPEG codes.
-        #
-        # @example
-        # ```ruby
-        # case reason
-        # in :equipmentReason
-        #   # ...
-        # in :environmentReason
-        #   # ...
-        # in :personnelReason
-        #   # ...
-        # in :miscellaneousReason
-        #   # ...
-        # in :securityAlert
-        #   # ...
-        # end
-        # ```
         class Reason < OnebusawaySDK::Enum
           EQUIPMENT_REASON = :equipmentReason
           ENVIRONMENT_REASON = :environmentReason
@@ -695,11 +679,6 @@ module OnebusawaySDK
           SECURITY_ALERT = :securityAlert
 
           finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   #
-          #   def self.values; end
         end
 
         class Summary < OnebusawaySDK::BaseModel

data/lib/onebusaway-sdk/models/report_problem_with_stop_retrieve_params.rb

@@ -82,22 +82,6 @@ module OnebusawaySDK
       # @abstract
       #
       # A string code identifying the nature of the problem
-      #
-      # @example
-      # ```ruby
-      # case code
-      # in :stop_name_wrong
-      #   # ...
-      # in :stop_number_wrong
-      #   # ...
-      # in :stop_location_wrong
-      #   # ...
-      # in :route_or_trip_missing
-      #   # ...
-      # in :other
-      #   # ...
-      # end
-      # ```
       class Code < OnebusawaySDK::Enum
         STOP_NAME_WRONG = :stop_name_wrong
         STOP_NUMBER_WRONG = :stop_number_wrong
@@ -106,11 +90,6 @@ module OnebusawaySDK
         OTHER = :other
 
         finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   #
-        #   def self.values; end
       end
     end
   end

data/lib/onebusaway-sdk/models/report_problem_with_trip_retrieve_params.rb

@@ -142,24 +142,6 @@ module OnebusawaySDK
       # @abstract
       #
       # A string code identifying the nature of the problem
-      #
-      # @example
-      # ```ruby
-      # case code
-      # in :vehicle_never_came
-      #   # ...
-      # in :vehicle_came_early
-      #   # ...
-      # in :vehicle_came_late
-      #   # ...
-      # in :wrong_headsign
-      #   # ...
-      # in :vehicle_does_not_stop_here
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
       class Code < OnebusawaySDK::Enum
         VEHICLE_NEVER_CAME = :vehicle_never_came
         VEHICLE_CAME_EARLY = :vehicle_came_early
@@ -169,11 +151,6 @@ module OnebusawaySDK
         OTHER = :other
 
         finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   #
-        #   def self.values; end
       end
     end
   end

data/lib/onebusaway-sdk/pooled_net_requester.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
 module OnebusawaySDK
-  # @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 OnebusawaySDK
         end
       end
 
-      # @private
+      # @api private
       #
       # @param conn [Net::HTTP]
       # @param deadline [Float]
-      #
       def calibrate_socket_timeout(conn, deadline)
         timeout = deadline - OnebusawaySDK::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}] .
       #
@@ -48,9 +45,10 @@ module OnebusawaySDK
       #
       #   @option request [Hash{String=>String}] :headers
       #
-      # @return [Net::HTTPGenericRequest]
+      # @param blk [Proc]
       #
-      def build_request(request)
+      # @return [Net::HTTPGenericRequest]
+      def build_request(request, &)
         method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
         req = Net::HTTPGenericRequest.new(
           method.to_s.upcase,
@@ -63,54 +61,41 @@ module OnebusawaySDK
 
         case body
         in nil
+          nil
         in String
-          req.body = body
+          req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
+          req.body_stream = OnebusawaySDK::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 = OnebusawaySDK::Util::ReadIOAdapter.new(body, &)
+        in IO | Enumerator
+          req["transfer-encoding"] ||= "chunked" unless req["content-length"]
+          req.body_stream = OnebusawaySDK::Util::ReadIOAdapter.new(body, &)
         end
 
         req
       end
     end
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
+    # @param deadline [Float]
     # @param blk [Proc]
-    #
-    private def with_pool(url, &blk)
+    private def with_pool(url, deadline:, &blk)
       origin = OnebusawaySDK::Util.uri_origin(url)
-      th = Thread.current
-      key = :"#{object_id}-#{self.class.name}-connection_in_use_for_#{origin}"
-
-      if th[key]
-        tap do
-          conn = self.class.connect(url)
-          return blk.call(conn)
-        ensure
-          conn.finish if conn&.started?
-        end
-      end
-
+      timeout = deadline - OnebusawaySDK::Util.monotonic_secs
       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
 
-      pool.with do |conn|
-        th[key] = true
-        blk.call(conn)
-      ensure
-        th[key] = nil
-      end
+      pool.with(timeout: timeout, &blk)
     end
 
-    # @private
+    # @api private
     #
     # @param request [Hash{Symbol=>Object}] .
     #
@@ -124,46 +109,60 @@ module OnebusawaySDK
     #
     #   @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)
-      req = self.class.build_request(request)
 
       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
+            self.class.calibrate_socket_timeout(conn, deadline)
+          end
+
           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]
+            y << [conn, req, rsp]
+            break if finished
+
             rsp.read_body do |bytes|
               y << bytes
+              break if finished
+
               self.class.calibrate_socket_timeout(conn, deadline)
             end
             eof = true
           end
         end
+      rescue Timeout::Error
+        raise OnebusawaySDK::APITimeoutError
       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?
+      conn, _, response = enum.next
+      body = OnebusawaySDK::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)]
+      [Integer(response.code), response, (response.body = body)]
     end
 
-    def initialize
+    # @api private
+    #
+    # @param size [Integer]
+    def initialize(size: Etc.nprocessors)
       @mutex = Mutex.new
+      @size = size
       @pools = {}
     end
   end

data/lib/onebusaway-sdk/request_options.rb

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

data/lib/onebusaway-sdk/resources/agencies_with_coverage.rb

@@ -11,7 +11,6 @@ module OnebusawaySDK
       #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [OnebusawaySDK::Models::AgenciesWithCoverageListResponse]
-      #
       def list(params = {})
         @client.request(
           method: :get,
@@ -22,7 +21,6 @@ module OnebusawaySDK
       end
 
       # @param client [OnebusawaySDK::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/onebusaway-sdk/resources/agency.rb

@@ -12,7 +12,6 @@ module OnebusawaySDK
       #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [OnebusawaySDK::Models::AgencyRetrieveResponse]
-      #
       def retrieve(agency_id, params = {})
         @client.request(
           method: :get,
@@ -23,7 +22,6 @@ module OnebusawaySDK
       end
 
       # @param client [OnebusawaySDK::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/onebusaway-sdk/resources/arrival_and_departure.rb

@@ -22,7 +22,6 @@ module OnebusawaySDK
       #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse]
-      #
       def retrieve(stop_id, params)
         parsed, options = OnebusawaySDK::Models::ArrivalAndDepartureRetrieveParams.dump_request(params)
         @client.request(
@@ -49,7 +48,6 @@ module OnebusawaySDK
       #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [OnebusawaySDK::Models::ArrivalAndDepartureListResponse]
-      #
       def list(stop_id, params = {})
         parsed, options = OnebusawaySDK::Models::ArrivalAndDepartureListParams.dump_request(params)
         @client.request(
@@ -62,7 +60,6 @@ module OnebusawaySDK
       end
 
       # @param client [OnebusawaySDK::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/onebusaway-sdk/resources/block.rb

@@ -12,7 +12,6 @@ module OnebusawaySDK
       #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [OnebusawaySDK::Models::BlockRetrieveResponse]
-      #
       def retrieve(block_id, params = {})
         @client.request(
           method: :get,
@@ -23,7 +22,6 @@ module OnebusawaySDK
       end
 
       # @param client [OnebusawaySDK::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/onebusaway-sdk/resources/config.rb

@@ -10,7 +10,6 @@ module OnebusawaySDK
       #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [OnebusawaySDK::Models::ConfigRetrieveResponse]
-      #
       def retrieve(params = {})
         @client.request(
           method: :get,
@@ -21,7 +20,6 @@ module OnebusawaySDK
       end
 
       # @param client [OnebusawaySDK::Client]
-      #
       def initialize(client:)
         @client = client
       end

data/lib/onebusaway-sdk/resources/current_time.rb

@@ -10,7 +10,6 @@ module OnebusawaySDK
       #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
       #
       # @return [OnebusawaySDK::Models::CurrentTimeRetrieveResponse]
-      #
       def retrieve(params = {})
         @client.request(
           method: :get,
@@ -21,7 +20,6 @@ module OnebusawaySDK
       end
 
       # @param client [OnebusawaySDK::Client]
-      #
       def initialize(client:)
         @client = client
       end