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

data/lib/onebusaway-sdk/request_options.rb

@@ -1,115 +0,0 @@
-# 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/arrival_and_departure.rb

@@ -1,71 +0,0 @@
-# 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/report_problem_with_stop.rb

@@ -1,44 +0,0 @@
-# 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

@@ -1,54 +0,0 @@
-# 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/routes_for_location.rb

@@ -1,44 +0,0 @@
-# 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/stops_for_location.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module OnebusawaySDK
-  module Resources
-    class StopsForLocation
-      # stops-for-location
-      #
-      # @param params [OnebusawaySDK::Models::StopsForLocationListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Float] :lat
-      #
-      #   @option params [Float] :lon
-      #
-      #   @option params [Float] :lat_span An alternative to radius to set the search bounding box (optional)
-      #
-      #   @option params [Float] :lon_span An alternative to radius to set the search bounding box (optional)
-      #
-      #   @option params [String] :query A search query string to filter the results
-      #
-      #   @option params [Float] :radius The radius in meters to search within
-      #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [OnebusawaySDK::Models::StopsForLocationListResponse]
-      #
-      def list(params)
-        parsed, options = OnebusawaySDK::Models::StopsForLocationListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "api/where/stops-for-location.json",
-          query: parsed,
-          model: OnebusawaySDK::Models::StopsForLocationListResponse,
-          options: options
-        )
-      end
-
-      # @param client [OnebusawaySDK::Client]
-      #
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module OnebusawaySDK
-  module Resources
-    class StopsForRoute
-      # Get stops for a specific route
-      #
-      # @param route_id [String] ID of the route
-      #
-      # @param params [OnebusawaySDK::Models::StopsForRouteListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Boolean] :include_polylines Include polyline elements in the response (default true)
-      #
-      #   @option params [String] :time Specify service date (YYYY-MM-DD or epoch) (default today)
-      #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [OnebusawaySDK::Models::StopsForRouteListResponse]
-      #
-      def list(route_id, params = {})
-        parsed, options = OnebusawaySDK::Models::StopsForRouteListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: ["api/where/stops-for-route/%0s.json", route_id],
-          query: parsed,
-          model: OnebusawaySDK::Models::StopsForRouteListResponse,
-          options: options
-        )
-      end
-
-      # @param client [OnebusawaySDK::Client]
-      #
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module OnebusawaySDK
-  module Resources
-    class TripDetails
-      # Retrieve Trip Details
-      #
-      # @param trip_id [String] ID of the trip to retrieve details for.
-      #
-      # @param params [OnebusawaySDK::Models::TripDetailRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Boolean] :include_schedule Whether to include the full schedule element in the tripDetails section
-      #     (defaults to true).
-      #
-      #   @option params [Boolean] :include_status Whether to include the full status element in the tripDetails section (defaults
-      #     to true).
-      #
-      #   @option params [Boolean] :include_trip Whether to include the full trip element in the references section (defaults to
-      #     true).
-      #
-      #   @option params [Integer] :service_date Service date for the trip as Unix time in milliseconds (optional).
-      #
-      #   @option params [Integer] :time Time parameter to query the system at a specific time (optional).
-      #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [OnebusawaySDK::Models::TripDetailRetrieveResponse]
-      #
-      def retrieve(trip_id, params = {})
-        parsed, options = OnebusawaySDK::Models::TripDetailRetrieveParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: ["api/where/trip-details/%0s.json", trip_id],
-          query: parsed,
-          model: OnebusawaySDK::Models::TripDetailRetrieveResponse,
-          options: options
-        )
-      end
-
-      # @param client [OnebusawaySDK::Client]
-      #
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module OnebusawaySDK
-  module Resources
-    class TripForVehicle
-      # Retrieve trip for a specific vehicle
-      #
-      # @param vehicle_id [String] ID of the vehicle to retrieve trip details for.
-      #
-      # @param params [OnebusawaySDK::Models::TripForVehicleRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Boolean] :include_schedule Determines whether full <schedule/> element is included in the <tripDetails/>
-      #     section. Defaults to false.
-      #
-      #   @option params [Boolean] :include_status Determines whether the full <status/> element is included in the <tripDetails/>
-      #     section. Defaults to true.
-      #
-      #   @option params [Boolean] :include_trip Determines whether full <trip/> element is included in the <references/>
-      #     section. Defaults to false.
-      #
-      #   @option params [Integer] :time Time parameter to query the system at a specific time (optional).
-      #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [OnebusawaySDK::Models::TripForVehicleRetrieveResponse]
-      #
-      def retrieve(vehicle_id, params = {})
-        parsed, options = OnebusawaySDK::Models::TripForVehicleRetrieveParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: ["api/where/trip-for-vehicle/%0s.json", vehicle_id],
-          query: parsed,
-          model: OnebusawaySDK::Models::TripForVehicleRetrieveResponse,
-          options: options
-        )
-      end
-
-      # @param client [OnebusawaySDK::Client]
-      #
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OnebusawaySDK
-  module Resources
-    class TripsForLocation
-      # Retrieve trips for a given location
-      #
-      # @param params [OnebusawaySDK::Models::TripsForLocationListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Float] :lat The latitude coordinate of the search center
-      #
-      #   @option params [Float] :lat_span Latitude span of the search bounding box
-      #
-      #   @option params [Float] :lon The longitude coordinate of the search center
-      #
-      #   @option params [Float] :lon_span Longitude span of the search bounding box
-      #
-      #   @option params [Boolean] :include_schedule Whether to include full schedule elements in the tripDetails section. Defaults
-      #     to false.
-      #
-      #   @option params [Boolean] :include_trip Whether to include full trip elements in the references section. Defaults to
-      #     false.
-      #
-      #   @option params [Integer] :time Specific time for the query. Defaults to the current time.
-      #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [OnebusawaySDK::Models::TripsForLocationListResponse]
-      #
-      def list(params)
-        parsed, options = OnebusawaySDK::Models::TripsForLocationListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "api/where/trips-for-location.json",
-          query: parsed,
-          model: OnebusawaySDK::Models::TripsForLocationListResponse,
-          options: options
-        )
-      end
-
-      # @param client [OnebusawaySDK::Client]
-      #
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module OnebusawaySDK
-  module Resources
-    class TripsForRoute
-      # Search for active trips for a specific route.
-      #
-      # @param route_id [String] The ID of the route.
-      #
-      # @param params [OnebusawaySDK::Models::TripsForRouteListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Boolean] :include_schedule Determine whether full schedule elements are included. Defaults to false.
-      #
-      #   @option params [Boolean] :include_status Determine whether full tripStatus elements with real-time information are
-      #     included. Defaults to false.
-      #
-      #   @option params [Integer] :time Query the system at a specific time. Useful for testing.
-      #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [OnebusawaySDK::Models::TripsForRouteListResponse]
-      #
-      def list(route_id, params = {})
-        parsed, options = OnebusawaySDK::Models::TripsForRouteListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: ["api/where/trips-for-route/%0s.json", route_id],
-          query: parsed,
-          model: OnebusawaySDK::Models::TripsForRouteListResponse,
-          options: options
-        )
-      end
-
-      # @param client [OnebusawaySDK::Client]
-      #
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end