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

data/README.md

@@ -1,43 +1,35 @@
 # Onebusaway SDK Ruby API library
 
-The Onebusaway SDK Ruby library provides convenient access to the Onebusaway SDK REST API from any Ruby 3.0.0+ application.
+The Onebusaway SDK Ruby library provides convenient access to the Onebusaway SDK REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/OneBusAway/ruby-sdk#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
 It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/onebusaway-sdk).
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/onebusaway-sdk).
 
-The underlying REST API documentation can be found on [developer.onebusaway.org](https://developer.onebusaway.org).
+The REST API documentation can be found on [developer.onebusaway.org](https://developer.onebusaway.org).
 
 ## Installation
 
-To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's `Gemfile`:
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
-```ruby
-gem "onebusaway-sdk", git: "https://github.com/OneBusAway/ruby-sdk", branch: "main"
-```
+<!-- x-release-please-start-version -->
 
-To fetch an initial copy of the gem:
-
-```sh
-bundle install
+```ruby
+gem "onebusaway-sdk", "~> 0.1.0.pre.alpha.208"
 ```
 
-To update the version used by your application when updates are pushed to GitHub:
-
-```sh
-bundle update onebusaway-sdk
-```
+<!-- x-release-please-end -->
 
 ## Usage
 
 ```ruby
 require "bundler/setup"
-require "onebusaway-sdk"
+require "onebusaway_sdk"
 
 onebusaway_sdk = OnebusawaySDK::Client.new(
-  api_key: "My API Key" # defaults to ENV["ONEBUSAWAY_API_KEY"]
+  api_key: ENV["ONEBUSAWAY_API_KEY"] # This is the default and can be omitted
 )
 
 current_time = onebusaway_sdk.current_time.retrieve
@@ -45,19 +37,25 @@ current_time = onebusaway_sdk.current_time.retrieve
 puts(current_time)
 ```
 
-### Errors
+### Handling errors
 
-When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `OnebusawaySDK::Error` will be thrown:
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `OnebusawaySDK::Errors::APIError` will be thrown:
 
 ```ruby
 begin
   current_time = onebusaway_sdk.current_time.retrieve
-rescue OnebusawaySDK::Error => e
-  puts(e.status) # 400
+rescue OnebusawaySDK::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue OnebusawaySDK::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue OnebusawaySDK::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
 end
 ```
 
-Error codes are as followed:
+Error codes are as follows:
 
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
@@ -68,7 +66,7 @@ Error codes are as followed:
 | HTTP 409         | `ConflictError`            |
 | HTTP 422         | `UnprocessableEntityError` |
 | HTTP 429         | `RateLimitError`           |
-| HTTP >=500       | `InternalServerError`      |
+| HTTP >= 500      | `InternalServerError`      |
 | Other HTTP error | `APIStatusError`           |
 | Timeout          | `APITimeoutError`          |
 | Network error    | `APIConnectionError`       |
@@ -93,11 +91,7 @@ onebusaway_sdk.current_time.retrieve(request_options: {max_retries: 5})
 
 ### Timeouts
 
-By default, requests will time out after 60 seconds.
-
-Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2\*timeout seconds before it fails.
-
-You can use the `timeout` option to configure or disable this:
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
 
 ```ruby
 # Configure the default for all requests:
@@ -109,20 +103,120 @@ onebusaway_sdk = OnebusawaySDK::Client.new(
 onebusaway_sdk.current_time.retrieve(request_options: {timeout: 5})
 ```
 
-## Sorbet Support
+On timeout, `OnebusawaySDK::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `OnebusawaySDK::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
+
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+current_time =
+  onebusaway_sdk.current_time.retrieve(
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(current_time[:my_undocumented_property])
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request as seen in examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `OnebusawaySDK::Client` instances are threadsafe, but only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `OnebusawaySDK::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
 
-This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
 
-What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself.
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
 
-Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `OnebusawaySDK::BaseModel` class, you will need to use the `**` splat operator to pass the arguments:
+## Sorbet
 
-Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
 
 ```ruby
-model = CurrentTimeRetrieveParams.new
+onebusaway_sdk.current_time.retrieve
+```
 
-onebusaway_sdk.current_time.retrieve(**model)
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+onebusaway_sdk.current_time.retrieve
+
+# You can also splat a full Params class:
+params = OnebusawaySDK::CurrentTimeRetrieveParams.new
+onebusaway_sdk.current_time.retrieve(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :stop_name_wrong
+puts(OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code::STOP_NAME_WRONG)
+
+# Revealed type: `T.all(OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code, Symbol)`
+T.reveal_type(OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code::STOP_NAME_WRONG)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+onebusaway_sdk.report_problem_with_stop.retrieve(
+  code: OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code::STOP_NAME_WRONG,
+  # …
+)
+
+# Literal values is also permissible:
+onebusaway_sdk.report_problem_with_stop.retrieve(
+  code: :stop_name_wrong,
+  # …
+)
 ```
 
 ## Versioning
@@ -133,4 +227,8 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.0.0 or higher.
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/OneBusAway/ruby-sdk/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Onebusaway SDK please follow the respective company's security reporting guidelines.
+
+### Onebusaway SDK Terms and Policies
+
+Please contact info@onebusaway.org for any questions or concerns regarding security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module OnebusawaySDK
-  class Client < OnebusawaySDK::BaseClient
+  class Client < OnebusawaySDK::Internal::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 
@@ -111,10 +111,11 @@ module OnebusawaySDK
 
     # 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 base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["ONEBUSAWAY_SDK_BASE_URL"]`
+    #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
     # @param timeout [Float]
@@ -123,17 +124,17 @@ module OnebusawaySDK
     #
     # @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: ENV["ONEBUSAWAY_SDK_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
       base_url ||= "https://api.pugetsound.onebusaway.org"
 
       if api_key.nil?
-        raise ArgumentError.new("api_key is required")
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"ONEBUSAWAY_API_KEY\"")
       end
 
       @api_key = api_key.to_s

data/lib/onebusaway_sdk/errors.rb

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

data/lib/onebusaway_sdk/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        else
+          filename.nil? ? nil : ::File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end