onebusaway-sdk 0.1.0.pre.alpha.203

data/lib/onebusaway-sdk/base_page.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  # @private
+  #
+  # @abstract
+  #
+  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
+  end
+end

data/lib/onebusaway-sdk/client.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  class Client < OnebusawaySDK::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [OnebusawaySDK::Resources::AgenciesWithCoverage]
+    attr_reader :agencies_with_coverage
+
+    # @return [OnebusawaySDK::Resources::Agency]
+    attr_reader :agency
+
+    # @return [OnebusawaySDK::Resources::VehiclesForAgency]
+    attr_reader :vehicles_for_agency
+
+    # @return [OnebusawaySDK::Resources::Config]
+    attr_reader :config
+
+    # @return [OnebusawaySDK::Resources::CurrentTime]
+    attr_reader :current_time
+
+    # @return [OnebusawaySDK::Resources::StopsForLocation]
+    attr_reader :stops_for_location
+
+    # @return [OnebusawaySDK::Resources::StopsForRoute]
+    attr_reader :stops_for_route
+
+    # @return [OnebusawaySDK::Resources::StopsForAgency]
+    attr_reader :stops_for_agency
+
+    # @return [OnebusawaySDK::Resources::Stop]
+    attr_reader :stop
+
+    # @return [OnebusawaySDK::Resources::StopIDsForAgency]
+    attr_reader :stop_ids_for_agency
+
+    # @return [OnebusawaySDK::Resources::ScheduleForStop]
+    attr_reader :schedule_for_stop
+
+    # @return [OnebusawaySDK::Resources::Route]
+    attr_reader :route
+
+    # @return [OnebusawaySDK::Resources::RouteIDsForAgency]
+    attr_reader :route_ids_for_agency
+
+    # @return [OnebusawaySDK::Resources::RoutesForLocation]
+    attr_reader :routes_for_location
+
+    # @return [OnebusawaySDK::Resources::RoutesForAgency]
+    attr_reader :routes_for_agency
+
+    # @return [OnebusawaySDK::Resources::ScheduleForRoute]
+    attr_reader :schedule_for_route
+
+    # @return [OnebusawaySDK::Resources::ArrivalAndDeparture]
+    attr_reader :arrival_and_departure
+
+    # @return [OnebusawaySDK::Resources::Trip]
+    attr_reader :trip
+
+    # @return [OnebusawaySDK::Resources::TripsForLocation]
+    attr_reader :trips_for_location
+
+    # @return [OnebusawaySDK::Resources::TripDetails]
+    attr_reader :trip_details
+
+    # @return [OnebusawaySDK::Resources::TripForVehicle]
+    attr_reader :trip_for_vehicle
+
+    # @return [OnebusawaySDK::Resources::TripsForRoute]
+    attr_reader :trips_for_route
+
+    # @return [OnebusawaySDK::Resources::ReportProblemWithStop]
+    attr_reader :report_problem_with_stop
+
+    # @return [OnebusawaySDK::Resources::ReportProblemWithTrip]
+    attr_reader :report_problem_with_trip
+
+    # @return [OnebusawaySDK::Resources::SearchForStop]
+    attr_reader :search_for_stop
+
+    # @return [OnebusawaySDK::Resources::SearchForRoute]
+    attr_reader :search_for_route
+
+    # @return [OnebusawaySDK::Resources::Block]
+    attr_reader :block
+
+    # @return [OnebusawaySDK::Resources::Shape]
+    attr_reader :shape
+
+    # @private
+    #
+    # @return [Hash{String=>String}]
+    #
+    private def auth_query
+      {"key" => @api_key}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    #
+    # @param api_key [String, nil] Defaults to `ENV["ONEBUSAWAY_API_KEY"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    #
+    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
+    )
+      base_url ||= "https://api.pugetsound.onebusaway.org"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required")
+      end
+
+      @api_key = api_key.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @agencies_with_coverage = OnebusawaySDK::Resources::AgenciesWithCoverage.new(client: self)
+      @agency = OnebusawaySDK::Resources::Agency.new(client: self)
+      @vehicles_for_agency = OnebusawaySDK::Resources::VehiclesForAgency.new(client: self)
+      @config = OnebusawaySDK::Resources::Config.new(client: self)
+      @current_time = OnebusawaySDK::Resources::CurrentTime.new(client: self)
+      @stops_for_location = OnebusawaySDK::Resources::StopsForLocation.new(client: self)
+      @stops_for_route = OnebusawaySDK::Resources::StopsForRoute.new(client: self)
+      @stops_for_agency = OnebusawaySDK::Resources::StopsForAgency.new(client: self)
+      @stop = OnebusawaySDK::Resources::Stop.new(client: self)
+      @stop_ids_for_agency = OnebusawaySDK::Resources::StopIDsForAgency.new(client: self)
+      @schedule_for_stop = OnebusawaySDK::Resources::ScheduleForStop.new(client: self)
+      @route = OnebusawaySDK::Resources::Route.new(client: self)
+      @route_ids_for_agency = OnebusawaySDK::Resources::RouteIDsForAgency.new(client: self)
+      @routes_for_location = OnebusawaySDK::Resources::RoutesForLocation.new(client: self)
+      @routes_for_agency = OnebusawaySDK::Resources::RoutesForAgency.new(client: self)
+      @schedule_for_route = OnebusawaySDK::Resources::ScheduleForRoute.new(client: self)
+      @arrival_and_departure = OnebusawaySDK::Resources::ArrivalAndDeparture.new(client: self)
+      @trip = OnebusawaySDK::Resources::Trip.new(client: self)
+      @trips_for_location = OnebusawaySDK::Resources::TripsForLocation.new(client: self)
+      @trip_details = OnebusawaySDK::Resources::TripDetails.new(client: self)
+      @trip_for_vehicle = OnebusawaySDK::Resources::TripForVehicle.new(client: self)
+      @trips_for_route = OnebusawaySDK::Resources::TripsForRoute.new(client: self)
+      @report_problem_with_stop = OnebusawaySDK::Resources::ReportProblemWithStop.new(client: self)
+      @report_problem_with_trip = OnebusawaySDK::Resources::ReportProblemWithTrip.new(client: self)
+      @search_for_stop = OnebusawaySDK::Resources::SearchForStop.new(client: self)
+      @search_for_route = OnebusawaySDK::Resources::SearchForRoute.new(client: self)
+      @block = OnebusawaySDK::Resources::Block.new(client: self)
+      @shape = OnebusawaySDK::Resources::Shape.new(client: self)
+    end
+  end
+end

data/lib/onebusaway-sdk/errors.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  class Error < StandardError
+    # @!parse
+    #   # @return [StandardError, nil]
+    #   attr_reader :cause
+  end
+
+  class ConversionError < OnebusawaySDK::Error
+  end
+
+  class APIError < OnebusawaySDK::Error
+    # @return [URI::Generic]
+    attr_reader :url
+
+    # @return [Integer, nil]
+    attr_reader :status
+
+    # @return [Object, nil]
+    attr_reader :body
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer, nil]
+    # @param body [Object, nil]
+    # @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
+      @body = body
+      @request = request
+      @response = response
+      super(message)
+    end
+  end
+
+  class APIConnectionError < OnebusawaySDK::APIError
+    # @!parse
+    #   # @return [nil]
+    #   attr_reader :status
+
+    # @!parse
+    #   # @return [nil]
+    #   attr_reader :body
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [nil]
+    # @param body [nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @param message [String, nil]
+    #
+    def initialize(
+      url:,
+      status: nil,
+      body: nil,
+      request: nil,
+      response: nil,
+      message: "Connection error."
+    )
+      super
+    end
+  end
+
+  class APITimeoutError < OnebusawaySDK::APIConnectionError
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [nil]
+    # @param body [nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @param message [String, nil]
+    #
+    def initialize(
+      url:,
+      status: nil,
+      body: nil,
+      request: nil,
+      response: nil,
+      message: "Request timed out."
+    )
+      super
+    end
+  end
+
+  class APIStatusError < OnebusawaySDK::APIError
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer]
+    # @param body [Object, nil]
+    # @param request [nil]
+    # @param response [nil]
+    #
+    # @return [OnebusawaySDK::APIStatusError]
+    #
+    def self.for(url:, status:, body:, request:, response:)
+      kwargs = {url: url, status: status, body: body, request: request, response: response}
+
+      case status
+      in 400
+        OnebusawaySDK::BadRequestError.new(**kwargs)
+      in 401
+        OnebusawaySDK::AuthenticationError.new(**kwargs)
+      in 403
+        OnebusawaySDK::PermissionDeniedError.new(**kwargs)
+      in 404
+        OnebusawaySDK::NotFoundError.new(**kwargs)
+      in 409
+        OnebusawaySDK::ConflictError.new(**kwargs)
+      in 422
+        OnebusawaySDK::UnprocessableEntityError.new(**kwargs)
+      in 429
+        OnebusawaySDK::RateLimitError.new(**kwargs)
+      in (500..)
+        OnebusawaySDK::InternalServerError.new(**kwargs)
+      else
+        OnebusawaySDK::APIStatusError.new(**kwargs)
+      end
+    end
+
+    # @!parse
+    #   # @return [Integer]
+    #   attr_reader :status
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer]
+    # @param body [Object, nil]
+    # @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(
+        url: url,
+        status: status,
+        body: body,
+        request: request,
+        response: response,
+        message: message&.to_s
+      )
+    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 = (500..)
+  end
+end

data/lib/onebusaway-sdk/extern.rb

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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class AgenciesWithCoverageListParams < OnebusawaySDK::BaseModel
+      # @!parse
+      #   extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      # @!parse
+      #   # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class AgenciesWithCoverageListResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data }
+
+      # @!parse
+      #   # @param data [OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+      class Data < OnebusawaySDK::BaseModel
+        # @!attribute limit_exceeded
+        #
+        #   @return [Boolean]
+        required :limit_exceeded, OnebusawaySDK::BooleanModel, api_name: :limitExceeded
+
+        # @!attribute list
+        #
+        #   @return [Array<OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List>]
+        required :list,
+                 -> { OnebusawaySDK::ArrayOf[OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List] }
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::Models::References]
+        required :references, -> { OnebusawaySDK::Models::References }
+
+        # @!parse
+        #   # @param limit_exceeded [Boolean]
+        #   # @param list [Array<OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List>]
+        #   # @param references [OnebusawaySDK::Models::References]
+        #   #
+        #   def initialize(limit_exceeded:, list:, references:, **) = super
+
+        # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+        class List < OnebusawaySDK::BaseModel
+          # @!attribute agency_id
+          #
+          #   @return [String]
+          required :agency_id, String, api_name: :agencyId
+
+          # @!attribute lat
+          #
+          #   @return [Float]
+          required :lat, Float
+
+          # @!attribute lat_span
+          #
+          #   @return [Float]
+          required :lat_span, Float, api_name: :latSpan
+
+          # @!attribute lon
+          #
+          #   @return [Float]
+          required :lon, Float
+
+          # @!attribute lon_span
+          #
+          #   @return [Float]
+          required :lon_span, Float, api_name: :lonSpan
+
+          # @!parse
+          #   # @param agency_id [String]
+          #   # @param lat [Float]
+          #   # @param lat_span [Float]
+          #   # @param lon [Float]
+          #   # @param lon_span [Float]
+          #   #
+          #   def initialize(agency_id:, lat:, lat_span:, lon:, lon_span:, **) = super
+
+          # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class AgencyRetrieveParams < OnebusawaySDK::BaseModel
+      # @!parse
+      #   extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      # @!parse
+      #   # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class AgencyRetrieveResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::AgencyRetrieveResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::AgencyRetrieveResponse::Data }
+
+      # @!parse
+      #   # @param data [OnebusawaySDK::Models::AgencyRetrieveResponse::Data]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+      class Data < OnebusawaySDK::BaseModel
+        # @!attribute entry
+        #
+        #   @return [OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry]
+        required :entry, -> { OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry }
+
+        # @!attribute limit_exceeded
+        #
+        #   @return [Boolean]
+        required :limit_exceeded, OnebusawaySDK::BooleanModel, api_name: :limitExceeded
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::Models::References]
+        required :references, -> { OnebusawaySDK::Models::References }
+
+        # @!parse
+        #   # @param entry [OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry]
+        #   # @param limit_exceeded [Boolean]
+        #   # @param references [OnebusawaySDK::Models::References]
+        #   #
+        #   def initialize(entry:, limit_exceeded:, references:, **) = super
+
+        # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+        class Entry < OnebusawaySDK::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute timezone
+          #
+          #   @return [String]
+          required :timezone, String
+
+          # @!attribute url
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!attribute [r] disclaimer
+          #
+          #   @return [String, nil]
+          optional :disclaimer, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :disclaimer
+
+          # @!attribute [r] email
+          #
+          #   @return [String, nil]
+          optional :email, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :email
+
+          # @!attribute [r] fare_url
+          #
+          #   @return [String, nil]
+          optional :fare_url, String, api_name: :fareUrl
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :fare_url
+
+          # @!attribute [r] lang
+          #
+          #   @return [String, nil]
+          optional :lang, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :lang
+
+          # @!attribute [r] phone
+          #
+          #   @return [String, nil]
+          optional :phone, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :phone
+
+          # @!attribute [r] private_service
+          #
+          #   @return [Boolean, nil]
+          optional :private_service, OnebusawaySDK::BooleanModel, api_name: :privateService
+
+          # @!parse
+          #   # @return [Boolean]
+          #   attr_writer :private_service
+
+          # @!parse
+          #   # @param id [String]
+          #   # @param name [String]
+          #   # @param timezone [String]
+          #   # @param url [String]
+          #   # @param disclaimer [String]
+          #   # @param email [String]
+          #   # @param fare_url [String]
+          #   # @param lang [String]
+          #   # @param phone [String]
+          #   # @param private_service [Boolean]
+          #   #
+          #   def initialize(
+          #     id:,
+          #     name:,
+          #     timezone:,
+          #     url:,
+          #     disclaimer: nil,
+          #     email: nil,
+          #     fare_url: nil,
+          #     lang: nil,
+          #     phone: nil,
+          #     private_service: nil,
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+        end
+      end
+    end
+  end
+end