onebusaway-sdk 0.1.0.pre.alpha.206 → 0.1.0.pre.alpha.208

data/rbi/{lib/onebusaway-sdk → onebusaway_sdk}/client.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 
 module OnebusawaySDK
-  class Client < OnebusawaySDK::BaseClient
+  class Client < OnebusawaySDK::Internal::Transport::BaseClient
     DEFAULT_MAX_RETRIES = 2
 
     DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
@@ -11,143 +11,119 @@ module OnebusawaySDK
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
     sig { returns(String) }
-    def api_key
-    end
+    attr_reader :api_key
 
     sig { returns(OnebusawaySDK::Resources::AgenciesWithCoverage) }
-    def agencies_with_coverage
-    end
+    attr_reader :agencies_with_coverage
 
     sig { returns(OnebusawaySDK::Resources::Agency) }
-    def agency
-    end
+    attr_reader :agency
 
     sig { returns(OnebusawaySDK::Resources::VehiclesForAgency) }
-    def vehicles_for_agency
-    end
+    attr_reader :vehicles_for_agency
 
     sig { returns(OnebusawaySDK::Resources::Config) }
-    def config
-    end
+    attr_reader :config
 
     sig { returns(OnebusawaySDK::Resources::CurrentTime) }
-    def current_time
-    end
+    attr_reader :current_time
 
     sig { returns(OnebusawaySDK::Resources::StopsForLocation) }
-    def stops_for_location
-    end
+    attr_reader :stops_for_location
 
     sig { returns(OnebusawaySDK::Resources::StopsForRoute) }
-    def stops_for_route
-    end
+    attr_reader :stops_for_route
 
     sig { returns(OnebusawaySDK::Resources::StopsForAgency) }
-    def stops_for_agency
-    end
+    attr_reader :stops_for_agency
 
     sig { returns(OnebusawaySDK::Resources::Stop) }
-    def stop
-    end
+    attr_reader :stop
 
     sig { returns(OnebusawaySDK::Resources::StopIDsForAgency) }
-    def stop_ids_for_agency
-    end
+    attr_reader :stop_ids_for_agency
 
     sig { returns(OnebusawaySDK::Resources::ScheduleForStop) }
-    def schedule_for_stop
-    end
+    attr_reader :schedule_for_stop
 
     sig { returns(OnebusawaySDK::Resources::Route) }
-    def route
-    end
+    attr_reader :route
 
     sig { returns(OnebusawaySDK::Resources::RouteIDsForAgency) }
-    def route_ids_for_agency
-    end
+    attr_reader :route_ids_for_agency
 
     sig { returns(OnebusawaySDK::Resources::RoutesForLocation) }
-    def routes_for_location
-    end
+    attr_reader :routes_for_location
 
     sig { returns(OnebusawaySDK::Resources::RoutesForAgency) }
-    def routes_for_agency
-    end
+    attr_reader :routes_for_agency
 
     sig { returns(OnebusawaySDK::Resources::ScheduleForRoute) }
-    def schedule_for_route
-    end
+    attr_reader :schedule_for_route
 
     sig { returns(OnebusawaySDK::Resources::ArrivalAndDeparture) }
-    def arrival_and_departure
-    end
+    attr_reader :arrival_and_departure
 
     sig { returns(OnebusawaySDK::Resources::Trip) }
-    def trip
-    end
+    attr_reader :trip
 
     sig { returns(OnebusawaySDK::Resources::TripsForLocation) }
-    def trips_for_location
-    end
+    attr_reader :trips_for_location
 
     sig { returns(OnebusawaySDK::Resources::TripDetails) }
-    def trip_details
-    end
+    attr_reader :trip_details
 
     sig { returns(OnebusawaySDK::Resources::TripForVehicle) }
-    def trip_for_vehicle
-    end
+    attr_reader :trip_for_vehicle
 
     sig { returns(OnebusawaySDK::Resources::TripsForRoute) }
-    def trips_for_route
-    end
+    attr_reader :trips_for_route
 
     sig { returns(OnebusawaySDK::Resources::ReportProblemWithStop) }
-    def report_problem_with_stop
-    end
+    attr_reader :report_problem_with_stop
 
     sig { returns(OnebusawaySDK::Resources::ReportProblemWithTrip) }
-    def report_problem_with_trip
-    end
+    attr_reader :report_problem_with_trip
 
     sig { returns(OnebusawaySDK::Resources::SearchForStop) }
-    def search_for_stop
-    end
+    attr_reader :search_for_stop
 
     sig { returns(OnebusawaySDK::Resources::SearchForRoute) }
-    def search_for_route
-    end
+    attr_reader :search_for_route
 
     sig { returns(OnebusawaySDK::Resources::Block) }
-    def block
-    end
+    attr_reader :block
 
     sig { returns(OnebusawaySDK::Resources::Shape) }
-    def shape
-    end
+    attr_reader :shape
 
+    # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_query
     end
 
+    # Creates and returns a new client for interacting with the API.
     sig do
       params(
-        base_url: T.nilable(String),
         api_key: T.nilable(String),
+        base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
         initial_retry_delay: Float,
         max_retry_delay: Float
-      )
-        .void
+      ).returns(T.attached_class)
     end
-    def initialize(
-      base_url: nil,
+    def self.new(
+      # Defaults to `ENV["ONEBUSAWAY_API_KEY"]`
       api_key: ENV["ONEBUSAWAY_API_KEY"],
-      max_retries: DEFAULT_MAX_RETRIES,
-      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["ONEBUSAWAY_SDK_BASE_URL"]`
+      base_url: ENV["ONEBUSAWAY_SDK_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: OnebusawaySDK::Client::DEFAULT_MAX_RETRIES,
+      timeout: OnebusawaySDK::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: OnebusawaySDK::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: OnebusawaySDK::Client::DEFAULT_MAX_RETRY_DELAY
     )
     end
   end

data/rbi/onebusaway_sdk/errors.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < OnebusawaySDK::Errors::Error
+    end
+
+    class APIError < OnebusawaySDK::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < OnebusawaySDK::Errors::APIError
+      sig { void }
+      attr_accessor :status
+
+      sig { void }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < OnebusawaySDK::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < OnebusawaySDK::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
+      end
+    end
+
+    class BadRequestError < OnebusawaySDK::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < OnebusawaySDK::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < OnebusawaySDK::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < OnebusawaySDK::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < OnebusawaySDK::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < OnebusawaySDK::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < OnebusawaySDK::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < OnebusawaySDK::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/onebusaway_sdk/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module OnebusawaySDK
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(String),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end

data/rbi/onebusaway_sdk/internal/transport/base_client.rbi

@@ -0,0 +1,301 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Internal
+    module Transport
+      # @api private
+      class BaseClient
+        extend OnebusawaySDK::Internal::Util::SorbetRuntimeSupport
+
+        abstract!
+
+        RequestComponents =
+          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(
+                  T.any(
+                    Symbol,
+                    Integer,
+                    T::Array[T.any(Symbol, Integer)],
+                    T.proc.params(arg0: T.anything).returns(T.anything)
+                  )
+                ),
+              page:
+                T.nilable(
+                  T::Class[
+                    OnebusawaySDK::Internal::Type::BasePage[
+                      OnebusawaySDK::Internal::Type::BaseModel
+                    ]
+                  ]
+                ),
+              stream: T.nilable(T::Class[T.anything]),
+              model: T.nilable(OnebusawaySDK::Internal::Type::Converter::Input),
+              options: T.nilable(OnebusawaySDK::RequestOptions::OrHash)
+            }
+          end
+
+        RequestInput =
+          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]
+
+        class << self
+          # @api private
+          sig do
+            params(
+              req:
+                OnebusawaySDK::Internal::Transport::BaseClient::RequestComponents
+            ).void
+          end
+          def validate!(req)
+          end
+
+          # @api private
+          sig do
+            params(
+              status: Integer,
+              headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+            ).returns(T::Boolean)
+          end
+          def should_retry?(status, headers:)
+          end
+
+          # @api private
+          sig do
+            params(
+              request:
+                OnebusawaySDK::Internal::Transport::BaseClient::RequestInput,
+              status: Integer,
+              response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+            ).returns(
+              OnebusawaySDK::Internal::Transport::BaseClient::RequestInput
+            )
+          end
+          def follow_redirect(request, status:, response_headers:)
+          end
+
+          # @api private
+          sig do
+            params(
+              status: T.any(Integer, OnebusawaySDK::Errors::APIConnectionError),
+              stream: T.nilable(T::Enumerable[String])
+            ).void
+          end
+          def reap_connection!(status, stream:)
+          end
+        end
+
+        sig { returns(URI::Generic) }
+        attr_reader :base_url
+
+        sig { returns(Float) }
+        attr_reader :timeout
+
+        sig { returns(Integer) }
+        attr_reader :max_retries
+
+        sig { returns(Float) }
+        attr_reader :initial_retry_delay
+
+        sig { returns(Float) }
+        attr_reader :max_retry_delay
+
+        sig { returns(T::Hash[String, String]) }
+        attr_reader :headers
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_header
+
+        # @api private
+        sig { returns(OnebusawaySDK::Internal::Transport::PooledNetRequester) }
+        attr_reader :requester
+
+        # @api private
+        sig do
+          params(
+            base_url: String,
+            timeout: Float,
+            max_retries: Integer,
+            initial_retry_delay: Float,
+            max_retry_delay: Float,
+            headers:
+              T::Hash[
+                String,
+                T.nilable(
+                  T.any(
+                    String,
+                    Integer,
+                    T::Array[T.nilable(T.any(String, Integer))]
+                  )
+                )
+              ],
+            idempotency_header: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          base_url:,
+          timeout: 0.0,
+          max_retries: 0,
+          initial_retry_delay: 0.0,
+          max_retry_delay: 0.0,
+          headers: {},
+          idempotency_header: nil
+        )
+        end
+
+        # @api private
+        sig { overridable.returns(T::Hash[String, String]) }
+        private def auth_query
+        end
+
+        # @api private
+        sig { returns(String) }
+        private def generate_idempotency_key
+        end
+
+        # @api private
+        sig do
+          overridable
+            .params(
+              req:
+                OnebusawaySDK::Internal::Transport::BaseClient::RequestComponents,
+              opts: OnebusawaySDK::Internal::AnyHash
+            )
+            .returns(
+              OnebusawaySDK::Internal::Transport::BaseClient::RequestInput
+            )
+        end
+        private def build_request(req, opts)
+        end
+
+        # @api private
+        sig do
+          params(
+            headers: T::Hash[String, String],
+            retry_count: Integer
+          ).returns(Float)
+        end
+        private def retry_delay(headers, retry_count:)
+        end
+
+        # @api private
+        sig do
+          params(
+            request:
+              OnebusawaySDK::Internal::Transport::BaseClient::RequestInput,
+            redirect_count: Integer,
+            retry_count: Integer,
+            send_retry_header: T::Boolean
+          ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+        end
+        private def send_request(
+          request,
+          redirect_count:,
+          retry_count:,
+          send_retry_header:
+        )
+        end
+
+        # Execute the request specified by `req`. This is the method that all resource
+        # methods call into.
+        #
+        # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: OnebusawaySDK::Internal::Type::Unknown, options: {})
+        sig do
+          params(
+            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(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
+            page:
+              T.nilable(
+                T::Class[
+                  OnebusawaySDK::Internal::Type::BasePage[
+                    OnebusawaySDK::Internal::Type::BaseModel
+                  ]
+                ]
+              ),
+            stream: T.nilable(T::Class[T.anything]),
+            model: T.nilable(OnebusawaySDK::Internal::Type::Converter::Input),
+            options: T.nilable(OnebusawaySDK::RequestOptions::OrHash)
+          ).returns(T.anything)
+        end
+        def request(
+          method,
+          path,
+          query: {},
+          headers: {},
+          body: nil,
+          unwrap: nil,
+          page: nil,
+          stream: nil,
+          model: OnebusawaySDK::Internal::Type::Unknown,
+          options: {}
+        )
+        end
+
+        # @api private
+        sig { returns(String) }
+        def inspect
+        end
+      end
+    end
+  end
+end