onebusaway-sdk 0.1.0.pre.alpha.203

data/lib/onebusaway-sdk/request_options.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  # @private
+  #
+  # @abstract
+  #
+  module RequestParameters
+    # @!parse
+    #   # Options to specify HTTP behaviour for this request.
+    #   # @return [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+    #   attr_accessor :request_options
+
+    # @param mod [Module]
+    #
+    def self.included(mod)
+      return unless mod <= OnebusawaySDK::BaseModel
+
+      mod.extend(OnebusawaySDK::RequestParameters::Converter)
+      mod.optional(:request_options, OnebusawaySDK::RequestOptions)
+    end
+
+    # @private
+    #
+    module Converter
+      # @private
+      #
+      # @param params [Object]
+      #
+      # @return [Array(Object, Hash{Symbol=>Object})]
+      #
+      def dump_request(params)
+        case (dumped = dump(params))
+        in Hash
+          [dumped.except(:request_options), dumped[:request_options]]
+        else
+          [dumped, nil]
+        end
+      end
+    end
+  end
+
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  #   or override those provided at the client level.
+  #
+  #   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
+    #
+    # @param opts [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    #
+    def self.validate!(opts)
+      case opts
+      in OnebusawaySDK::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #     sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #     `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, OnebusawaySDK::HashOf[OnebusawaySDK::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #     `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, OnebusawaySDK::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   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]
+    optional :extra_body, OnebusawaySDK::HashOf[OnebusawaySDK::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!parse
+    #   # Returns a new instance of RequestOptions.
+    #   #
+    #   # @param values [Hash{Symbol=>Object}]
+    #   #
+    #   def initialize(values = {}) = super
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class AgenciesWithCoverage
+      # Returns a list of all transit agencies currently supported by OneBusAway along
+      #   with the center of their coverage area.
+      #
+      # @param params [OnebusawaySDK::Models::AgenciesWithCoverageListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::AgenciesWithCoverageListResponse]
+      #
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "api/where/agencies-with-coverage.json",
+          model: OnebusawaySDK::Models::AgenciesWithCoverageListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class Agency
+      # Retrieve information for a specific transit agency identified by its unique ID.
+      #
+      # @param agency_id [String] The ID of the transit agency.
+      #
+      # @param params [OnebusawaySDK::Models::AgencyRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::AgencyRetrieveResponse]
+      #
+      def retrieve(agency_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/agency/%0s.json", agency_id],
+          model: OnebusawaySDK::Models::AgencyRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class ArrivalAndDeparture
+      # arrival-and-departure-for-stop
+      #
+      # @param stop_id [String]
+      #
+      # @param params [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer] :service_date
+      #
+      #   @option params [String] :trip_id
+      #
+      #   @option params [Integer] :stop_sequence
+      #
+      #   @option params [Integer] :time
+      #
+      #   @option params [String] :vehicle_id
+      #
+      #   @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(
+          method: :get,
+          path: ["api/where/arrival-and-departure-for-stop/%0s.json", stop_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse,
+          options: options
+        )
+      end
+
+      # arrivals-and-departures-for-stop
+      #
+      # @param stop_id [String]
+      #
+      # @param params [OnebusawaySDK::Models::ArrivalAndDepartureListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer] :minutes_after Include vehicles arriving or departing in the next n minutes.
+      #
+      #   @option params [Integer] :minutes_before Include vehicles having arrived or departed in the previous n minutes.
+      #
+      #   @option params [Time] :time The specific time for querying the system status.
+      #
+      #   @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(
+          method: :get,
+          path: ["api/where/arrivals-and-departures-for-stop/%0s.json", stop_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::ArrivalAndDepartureListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class Block
+      # Get details of a specific block by ID
+      #
+      # @param block_id [String] ID of the block
+      #
+      # @param params [OnebusawaySDK::Models::BlockRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::BlockRetrieveResponse]
+      #
+      def retrieve(block_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/block/%0s.json", block_id],
+          model: OnebusawaySDK::Models::BlockRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class Config
+      # config
+      #
+      # @param params [OnebusawaySDK::Models::ConfigRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::ConfigRetrieveResponse]
+      #
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "api/where/config.json",
+          model: OnebusawaySDK::Models::ConfigRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class CurrentTime
+      # current-time
+      #
+      # @param params [OnebusawaySDK::Models::CurrentTimeRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::CurrentTimeRetrieveResponse]
+      #
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "api/where/current-time.json",
+          model: OnebusawaySDK::Models::CurrentTimeRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class ReportProblemWithStop
+      # Submit a user-generated problem report for a stop
+      #
+      # @param stop_id [String] The ID of the stop
+      #
+      # @param params [OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams::Code] :code A string code identifying the nature of the problem
+      #
+      #   @option params [String] :user_comment Additional comment text supplied by the user describing the problem
+      #
+      #   @option params [Float] :user_lat The reporting user’s current latitude
+      #
+      #   @option params [Float] :user_location_accuracy The reporting user’s location accuracy, in meters
+      #
+      #   @option params [Float] :user_lon The reporting user’s current longitude
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::ResponseWrapper]
+      #
+      def retrieve(stop_id, params = {})
+        parsed, options = OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/report-problem-with-stop/%0s.json", stop_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::ResponseWrapper,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class ReportProblemWithTrip
+      # Submit a user-generated problem report for a particular trip.
+      #
+      # @param trip_id [String] The ID of the trip
+      #
+      # @param params [OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams::Code] :code A string code identifying the nature of the problem
+      #
+      #   @option params [Integer] :service_date The service date of the trip
+      #
+      #   @option params [String] :stop_id A stop ID indicating where the user is experiencing the problem
+      #
+      #   @option params [String] :user_comment Additional comment text supplied by the user describing the problem
+      #
+      #   @option params [Float] :user_lat The reporting user’s current latitude
+      #
+      #   @option params [Float] :user_location_accuracy The reporting user’s location accuracy, in meters
+      #
+      #   @option params [Float] :user_lon The reporting user’s current longitude
+      #
+      #   @option params [Boolean] :user_on_vehicle Indicator if the user is on the transit vehicle experiencing the problem
+      #
+      #   @option params [String] :user_vehicle_number The vehicle number, as reported by the user
+      #
+      #   @option params [String] :vehicle_id The vehicle actively serving the trip
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::ResponseWrapper]
+      #
+      def retrieve(trip_id, params = {})
+        parsed, options = OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/report-problem-with-trip/%0s.json", trip_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::ResponseWrapper,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class Route
+      # Retrieve information for a specific route identified by its unique ID.
+      #
+      # @param route_id [String] The ID of the route.
+      #
+      # @param params [OnebusawaySDK::Models::RouteRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::RouteRetrieveResponse]
+      #
+      def retrieve(route_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/route/%0s.json", route_id],
+          model: OnebusawaySDK::Models::RouteRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class RouteIDsForAgency
+      # Get route IDs for a specific agency
+      #
+      # @param agency_id [String] ID of the agency
+      #
+      # @param params [OnebusawaySDK::Models::RouteIDsForAgencyListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::RouteIDsForAgencyListResponse]
+      #
+      def list(agency_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/route-ids-for-agency/%0s.json", agency_id],
+          model: OnebusawaySDK::Models::RouteIDsForAgencyListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class RoutesForAgency
+      # Retrieve the list of all routes for a particular agency by id
+      #
+      # @param agency_id [String] The id of the agency
+      #
+      # @param params [OnebusawaySDK::Models::RoutesForAgencyListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::RoutesForAgencyListResponse]
+      #
+      def list(agency_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/routes-for-agency/%0s.json", agency_id],
+          model: OnebusawaySDK::Models::RoutesForAgencyListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class RoutesForLocation
+      # routes-for-location
+      #
+      # @param params [OnebusawaySDK::Models::RoutesForLocationListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Float] :lat
+      #
+      #   @option params [Float] :lon
+      #
+      #   @option params [Float] :lat_span
+      #
+      #   @option params [Float] :lon_span
+      #
+      #   @option params [String] :query
+      #
+      #   @option params [Float] :radius
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::RoutesForLocationListResponse]
+      #
+      def list(params)
+        parsed, options = OnebusawaySDK::Models::RoutesForLocationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/where/routes-for-location.json",
+          query: parsed,
+          model: OnebusawaySDK::Models::RoutesForLocationListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class ScheduleForRoute
+      # Retrieve the full schedule for a route on a particular day
+      #
+      # @param route_id [String] The route id to request the schedule for
+      #
+      # @param params [OnebusawaySDK::Models::ScheduleForRouteRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Date] :date The date for which you want to request a schedule in the format YYYY-MM-DD
+      #     (optional, defaults to current date)
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::ScheduleForRouteRetrieveResponse]
+      #
+      def retrieve(route_id, params = {})
+        parsed, options = OnebusawaySDK::Models::ScheduleForRouteRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/schedule-for-route/%0s.json", route_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::ScheduleForRouteRetrieveResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class ScheduleForStop
+      # Get schedule for a specific stop
+      #
+      # @param stop_id [String] The stop id to request the schedule for, encoded directly in the URL
+      #
+      # @param params [OnebusawaySDK::Models::ScheduleForStopRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Date] :date The date for which you want to request a schedule in the format YYYY-MM-DD
+      #     (optional, defaults to the current date)
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::ScheduleForStopRetrieveResponse]
+      #
+      def retrieve(stop_id, params = {})
+        parsed, options = OnebusawaySDK::Models::ScheduleForStopRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/schedule-for-stop/%0s.json", stop_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::ScheduleForStopRetrieveResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end