onebusaway-sdk 0.1.0.pre.alpha.203

data/rbi/lib/onebusaway-sdk/client.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OnebusawaySDK
+  class Client < OnebusawaySDK::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    def api_key
+    end
+
+    sig { returns(OnebusawaySDK::Resources::AgenciesWithCoverage) }
+    def agencies_with_coverage
+    end
+
+    sig { returns(OnebusawaySDK::Resources::Agency) }
+    def agency
+    end
+
+    sig { returns(OnebusawaySDK::Resources::VehiclesForAgency) }
+    def vehicles_for_agency
+    end
+
+    sig { returns(OnebusawaySDK::Resources::Config) }
+    def config
+    end
+
+    sig { returns(OnebusawaySDK::Resources::CurrentTime) }
+    def current_time
+    end
+
+    sig { returns(OnebusawaySDK::Resources::StopsForLocation) }
+    def stops_for_location
+    end
+
+    sig { returns(OnebusawaySDK::Resources::StopsForRoute) }
+    def stops_for_route
+    end
+
+    sig { returns(OnebusawaySDK::Resources::StopsForAgency) }
+    def stops_for_agency
+    end
+
+    sig { returns(OnebusawaySDK::Resources::Stop) }
+    def stop
+    end
+
+    sig { returns(OnebusawaySDK::Resources::StopIDsForAgency) }
+    def stop_ids_for_agency
+    end
+
+    sig { returns(OnebusawaySDK::Resources::ScheduleForStop) }
+    def schedule_for_stop
+    end
+
+    sig { returns(OnebusawaySDK::Resources::Route) }
+    def route
+    end
+
+    sig { returns(OnebusawaySDK::Resources::RouteIDsForAgency) }
+    def route_ids_for_agency
+    end
+
+    sig { returns(OnebusawaySDK::Resources::RoutesForLocation) }
+    def routes_for_location
+    end
+
+    sig { returns(OnebusawaySDK::Resources::RoutesForAgency) }
+    def routes_for_agency
+    end
+
+    sig { returns(OnebusawaySDK::Resources::ScheduleForRoute) }
+    def schedule_for_route
+    end
+
+    sig { returns(OnebusawaySDK::Resources::ArrivalAndDeparture) }
+    def arrival_and_departure
+    end
+
+    sig { returns(OnebusawaySDK::Resources::Trip) }
+    def trip
+    end
+
+    sig { returns(OnebusawaySDK::Resources::TripsForLocation) }
+    def trips_for_location
+    end
+
+    sig { returns(OnebusawaySDK::Resources::TripDetails) }
+    def trip_details
+    end
+
+    sig { returns(OnebusawaySDK::Resources::TripForVehicle) }
+    def trip_for_vehicle
+    end
+
+    sig { returns(OnebusawaySDK::Resources::TripsForRoute) }
+    def trips_for_route
+    end
+
+    sig { returns(OnebusawaySDK::Resources::ReportProblemWithStop) }
+    def report_problem_with_stop
+    end
+
+    sig { returns(OnebusawaySDK::Resources::ReportProblemWithTrip) }
+    def report_problem_with_trip
+    end
+
+    sig { returns(OnebusawaySDK::Resources::SearchForStop) }
+    def search_for_stop
+    end
+
+    sig { returns(OnebusawaySDK::Resources::SearchForRoute) }
+    def search_for_route
+    end
+
+    sig { returns(OnebusawaySDK::Resources::Block) }
+    def block
+    end
+
+    sig { returns(OnebusawaySDK::Resources::Shape) }
+    def shape
+    end
+
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_query
+    end
+
+    sig do
+      params(
+        base_url: T.nilable(String),
+        api_key: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      )
+        .void
+    end
+    def initialize(
+      base_url: nil,
+      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
+    )
+    end
+  end
+end

data/rbi/lib/onebusaway-sdk/errors.rbi

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

data/rbi/lib/onebusaway-sdk/extern.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Extern
+    abstract!
+  end
+end

data/rbi/lib/onebusaway-sdk/models/agencies_with_coverage_list_params.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Models
+    class AgenciesWithCoverageListParams < OnebusawaySDK::BaseModel
+      extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      sig { params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])).void }
+      def initialize(request_options: {})
+      end
+
+      sig { override.returns({request_options: OnebusawaySDK::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/onebusaway-sdk/models/agencies_with_coverage_list_response.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Models
+    class AgenciesWithCoverageListResponse < OnebusawaySDK::Models::ResponseWrapper
+      sig { returns(OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data) }
+      def data
+      end
+
+      sig do
+        params(_: OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data)
+          .returns(OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data)
+      end
+      def data=(_)
+      end
+
+      sig { params(data: OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data).void }
+      def initialize(data:)
+      end
+
+      sig { override.returns({data: OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data}) }
+      def to_hash
+      end
+
+      class Data < OnebusawaySDK::BaseModel
+        sig { returns(T::Boolean) }
+        def limit_exceeded
+        end
+
+        sig { params(_: T::Boolean).returns(T::Boolean) }
+        def limit_exceeded=(_)
+        end
+
+        sig { returns(T::Array[OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List]) }
+        def list
+        end
+
+        sig do
+          params(_: T::Array[OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List])
+            .returns(T::Array[OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List])
+        end
+        def list=(_)
+        end
+
+        sig { returns(OnebusawaySDK::Models::References) }
+        def references
+        end
+
+        sig { params(_: OnebusawaySDK::Models::References).returns(OnebusawaySDK::Models::References) }
+        def references=(_)
+        end
+
+        sig do
+          params(
+            limit_exceeded: T::Boolean,
+            list: T::Array[OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List],
+            references: OnebusawaySDK::Models::References
+          )
+            .void
+        end
+        def initialize(limit_exceeded:, list:, references:)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                limit_exceeded: T::Boolean,
+                list: T::Array[OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List],
+                references: OnebusawaySDK::Models::References
+              }
+            )
+        end
+        def to_hash
+        end
+
+        class List < OnebusawaySDK::BaseModel
+          sig { returns(String) }
+          def agency_id
+          end
+
+          sig { params(_: String).returns(String) }
+          def agency_id=(_)
+          end
+
+          sig { returns(Float) }
+          def lat
+          end
+
+          sig { params(_: Float).returns(Float) }
+          def lat=(_)
+          end
+
+          sig { returns(Float) }
+          def lat_span
+          end
+
+          sig { params(_: Float).returns(Float) }
+          def lat_span=(_)
+          end
+
+          sig { returns(Float) }
+          def lon
+          end
+
+          sig { params(_: Float).returns(Float) }
+          def lon=(_)
+          end
+
+          sig { returns(Float) }
+          def lon_span
+          end
+
+          sig { params(_: Float).returns(Float) }
+          def lon_span=(_)
+          end
+
+          sig { params(agency_id: String, lat: Float, lat_span: Float, lon: Float, lon_span: Float).void }
+          def initialize(agency_id:, lat:, lat_span:, lon:, lon_span:)
+          end
+
+          sig do
+            override.returns({agency_id: String, lat: Float, lat_span: Float, lon: Float, lon_span: Float})
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/onebusaway-sdk/models/agency_retrieve_params.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Models
+    class AgencyRetrieveParams < OnebusawaySDK::BaseModel
+      extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      sig { params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])).void }
+      def initialize(request_options: {})
+      end
+
+      sig { override.returns({request_options: OnebusawaySDK::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/onebusaway-sdk/models/agency_retrieve_response.rbi

@@ -0,0 +1,210 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Models
+    class AgencyRetrieveResponse < OnebusawaySDK::Models::ResponseWrapper
+      sig { returns(OnebusawaySDK::Models::AgencyRetrieveResponse::Data) }
+      def data
+      end
+
+      sig do
+        params(_: OnebusawaySDK::Models::AgencyRetrieveResponse::Data)
+          .returns(OnebusawaySDK::Models::AgencyRetrieveResponse::Data)
+      end
+      def data=(_)
+      end
+
+      sig { params(data: OnebusawaySDK::Models::AgencyRetrieveResponse::Data).void }
+      def initialize(data:)
+      end
+
+      sig { override.returns({data: OnebusawaySDK::Models::AgencyRetrieveResponse::Data}) }
+      def to_hash
+      end
+
+      class Data < OnebusawaySDK::BaseModel
+        sig { returns(OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry) }
+        def entry
+        end
+
+        sig do
+          params(_: OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry)
+            .returns(OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry)
+        end
+        def entry=(_)
+        end
+
+        sig { returns(T::Boolean) }
+        def limit_exceeded
+        end
+
+        sig { params(_: T::Boolean).returns(T::Boolean) }
+        def limit_exceeded=(_)
+        end
+
+        sig { returns(OnebusawaySDK::Models::References) }
+        def references
+        end
+
+        sig { params(_: OnebusawaySDK::Models::References).returns(OnebusawaySDK::Models::References) }
+        def references=(_)
+        end
+
+        sig do
+          params(
+            entry: OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry,
+            limit_exceeded: T::Boolean,
+            references: OnebusawaySDK::Models::References
+          )
+            .void
+        end
+        def initialize(entry:, limit_exceeded:, references:)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                entry: OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry,
+                limit_exceeded: T::Boolean,
+                references: OnebusawaySDK::Models::References
+              }
+            )
+        end
+        def to_hash
+        end
+
+        class Entry < OnebusawaySDK::BaseModel
+          sig { returns(String) }
+          def id
+          end
+
+          sig { params(_: String).returns(String) }
+          def id=(_)
+          end
+
+          sig { returns(String) }
+          def name
+          end
+
+          sig { params(_: String).returns(String) }
+          def name=(_)
+          end
+
+          sig { returns(String) }
+          def timezone
+          end
+
+          sig { params(_: String).returns(String) }
+          def timezone=(_)
+          end
+
+          sig { returns(String) }
+          def url
+          end
+
+          sig { params(_: String).returns(String) }
+          def url=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def disclaimer
+          end
+
+          sig { params(_: String).returns(String) }
+          def disclaimer=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def email
+          end
+
+          sig { params(_: String).returns(String) }
+          def email=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def fare_url
+          end
+
+          sig { params(_: String).returns(String) }
+          def fare_url=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def lang
+          end
+
+          sig { params(_: String).returns(String) }
+          def lang=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def phone
+          end
+
+          sig { params(_: String).returns(String) }
+          def phone=(_)
+          end
+
+          sig { returns(T.nilable(T::Boolean)) }
+          def private_service
+          end
+
+          sig { params(_: T::Boolean).returns(T::Boolean) }
+          def private_service=(_)
+          end
+
+          sig do
+            params(
+              id: String,
+              name: String,
+              timezone: String,
+              url: String,
+              disclaimer: String,
+              email: String,
+              fare_url: String,
+              lang: String,
+              phone: String,
+              private_service: T::Boolean
+            )
+              .void
+          end
+          def initialize(
+            id:,
+            name:,
+            timezone:,
+            url:,
+            disclaimer: nil,
+            email: nil,
+            fare_url: nil,
+            lang: nil,
+            phone: nil,
+            private_service: nil
+          )
+          end
+
+          sig do
+            override
+              .returns(
+                {
+                  id: String,
+                  name: String,
+                  timezone: String,
+                  url: String,
+                  disclaimer: String,
+                  email: String,
+                  fare_url: String,
+                  lang: String,
+                  phone: String,
+                  private_service: T::Boolean
+                }
+              )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end