onebusaway-sdk 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5efb8777d95707d7922ca9c1f2ae57ee8063e491174b372de6987a9e8d66a431
-  data.tar.gz: 02451bf9e991392aa1d37cf4399db90d03dabeb459d2cb19303c079c08361888
+  metadata.gz: 774a62ce95d40bc273371794f6ad2bd15ee81408c68cfe8982090b197c57fe1a
+  data.tar.gz: c1f16accdf042a20ad534cf27a5a99ca49a1ee1d014f21f655d704cbee586cac
 SHA512:
-  metadata.gz: d2149d8622b2424b970c039f732c2fcacd012f35b321aca851037a501ba1672c343c55fbbd79eafe194bedf8bbe83c4888c0faacbc71a70358199b6fda5cea77
-  data.tar.gz: 792061d7fb4336a3cd19f7717595c2d327045097827c355709f351565f6742876c1b9c5794eba0597e5e2f9b72bea769622ac8c9cc28297de23563d239446768
+  metadata.gz: 6c3a21bb95898bc7e909497f4768be5e7bc641982e19427656433d3e08df0aa7250cd3491eba7d12b8812ac8ecc3b5972e6a278a7309b8dbfce58ca6b9c1d4e3
+  data.tar.gz: 40c5c2ee398039cb03e138d9c73dc7fe08a487e0273e915047805a5cd666eca1b5eee97c3bef8a1d32e03839d88143067963d1dfd0008676d0248f1b5d37de28

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.0.3 (2025-05-28)
+
+Full Changelog: [v1.0.2...v1.0.3](https://github.com/OneBusAway/ruby-sdk/compare/v1.0.2...v1.0.3)
+
+### Bug Fixes
+
+* correctly instantiate sorbet type aliases for enums and unions ([c3220da](https://github.com/OneBusAway/ruby-sdk/commit/c3220da9c8dd308037e8713b34a9925c3b2305c9))
+* prevent rubocop from mangling `===` to `is_a?` check ([4cc7c41](https://github.com/OneBusAway/ruby-sdk/commit/4cc7c41e75e9bc5589998af5b40398632242bd08))
+* sorbet types for enums, and make tapioca detection ignore `tapioca dsl` ([457b3f7](https://github.com/OneBusAway/ruby-sdk/commit/457b3f74152c42720d9daa4d2050a3a93bd8a6ce))
+
+
+### Chores
+
+* **docs:** grammar improvements ([fb664c1](https://github.com/OneBusAway/ruby-sdk/commit/fb664c14ed7536ceb8f8e0a3981466572b9924b3))
+* force utf-8 locale via `RUBYOPT` when formatting ([40072fa](https://github.com/OneBusAway/ruby-sdk/commit/40072fa08f936bb71c630cbab264def3d5f68fca))
+* **internal:** version bump ([736a6f9](https://github.com/OneBusAway/ruby-sdk/commit/736a6f9a6f1536797d992536102ec93ff1c80984))
+* refine Yard and Sorbet types and ensure linting is turned on for examples ([4491574](https://github.com/OneBusAway/ruby-sdk/commit/44915748e1ed515f15805d3f7a2f5e73d9d4e8f7))
+* use fully qualified names for yard annotations and rbs aliases ([836f0a6](https://github.com/OneBusAway/ruby-sdk/commit/836f0a68ded83ff27a8dcf0c28e07bd1f29f8cba))
+* whitespaces ([6588d9a](https://github.com/OneBusAway/ruby-sdk/commit/6588d9a87f890cdedbe288172f074332e34a48ff))
+
 ## 1.0.2 (2025-05-20)
 
 Full Changelog: [v1.0.1...v1.0.2](https://github.com/OneBusAway/ruby-sdk/compare/v1.0.1...v1.0.2)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "onebusaway-sdk", "~> 1.0.2"
+gem "onebusaway-sdk", "~> 1.0.3"
 ```
 
 <!-- x-release-please-end -->
@@ -144,7 +144,7 @@ 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.
+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 the examples above.
 
 #### Undocumented endpoints
 
@@ -162,7 +162,7 @@ response = client.request(
 
 ### Concurrency & connection pooling
 
-The `OnebusawaySDK::Client` instances are threadsafe, but only are fork-safe when there are no in-flight HTTP requests.
+The `OnebusawaySDK::Client` instances are threadsafe, but are 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.
 
@@ -212,7 +212,7 @@ onebusaway_sdk.report_problem_with_stop.retrieve(
   # …
 )
 
-# Literal values is also permissible:
+# Literal values are also permissible:
 onebusaway_sdk.report_problem_with_stop.retrieve(
   code: :stop_name_wrong,
   # …

data/SECURITY.md

@@ -16,11 +16,11 @@ 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.
+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.
+Please contact info@onebusaway.org for any questions or concerns regarding the security of our services.
 
 ---
 

data/lib/onebusaway_sdk/internal/type/array_of.rb

@@ -12,6 +12,7 @@ module OnebusawaySDK
       # Array of items of a given type.
       class ArrayOf
         include OnebusawaySDK::Internal::Type::Converter
+        include OnebusawaySDK::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -110,6 +111,13 @@ module OnebusawaySDK
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Array[OnebusawaySDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

data/lib/onebusaway_sdk/internal/type/base_model.rb

@@ -312,6 +312,13 @@ module OnebusawaySDK
 
             acc
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            self
+          end
         end
 
         class << self

data/lib/onebusaway_sdk/internal/type/boolean.rb

@@ -10,6 +10,7 @@ module OnebusawaySDK
       # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend OnebusawaySDK::Internal::Type::Converter
+        extend OnebusawaySDK::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -56,6 +57,13 @@ module OnebusawaySDK
           #     @option state [Boolean] :can_retry
           #
           #   @return [Boolean, Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T::Boolean
+          end
         end
       end
     end

data/lib/onebusaway_sdk/internal/type/enum.rb

@@ -87,6 +87,18 @@ module OnebusawaySDK
         #
         #   @return [Symbol, Object]
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case values
+          in []
+            T.noreturn
+          in [value, *_]
+            T.all(OnebusawaySDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          end
+        end
+
         # @api private
         #
         # @param depth [Integer]

data/lib/onebusaway_sdk/internal/type/file_input.rb

@@ -89,6 +89,13 @@ module OnebusawaySDK
 
             value
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.any(Pathname, StringIO, IO, String, OnebusawaySDK::FilePart)
+          end
         end
       end
     end

data/lib/onebusaway_sdk/internal/type/hash_of.rb

@@ -12,6 +12,7 @@ module OnebusawaySDK
       # Hash of items of a given type.
       class HashOf
         include OnebusawaySDK::Internal::Type::Converter
+        include OnebusawaySDK::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -130,6 +131,13 @@ module OnebusawaySDK
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Hash[OnebusawaySDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

data/lib/onebusaway_sdk/internal/type/union.rb

@@ -197,6 +197,18 @@ module OnebusawaySDK
           super
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case (v = variants)
+          in []
+            T.noreturn
+          else
+            T.any(*v.map { OnebusawaySDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+          end
+        end
+
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
 

data/lib/onebusaway_sdk/internal/type/unknown.rb

@@ -10,6 +10,7 @@ module OnebusawaySDK
       # When we don't know what to expect for the value.
       class Unknown
         extend OnebusawaySDK::Internal::Type::Converter
+        extend OnebusawaySDK::Internal::Util::SorbetRuntimeSupport
 
         # rubocop:disable Lint/UnusedMethodArgument
 
@@ -58,6 +59,13 @@ module OnebusawaySDK
           #     @option state [Boolean] :can_retry
           #
           #   @return [Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.anything
+          end
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

data/lib/onebusaway_sdk/internal/util.rb

@@ -9,6 +9,23 @@ module OnebusawaySDK
       # @return [Float]
       def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
+      # @api private
+      #
+      # @param ns [Module, Class]
+      #
+      # @return [Enumerable<Module, Class>]
+      def self.walk_namespaces(ns)
+        ns.constants(false).lazy.flat_map do
+          case (c = ns.const_get(_1, false))
+          in Module | Class
+            walk_namespaces(c)
+          else
+            []
+          end
+        end
+          .chain([ns])
+      end
+
       class << self
         # @api private
         #
@@ -583,11 +600,13 @@ module OnebusawaySDK
         #
         # @return [Object]
         def encode_content(headers, body)
+          # rubocop:disable Style/CaseEquality
+          # rubocop:disable Layout/LineLength
           content_type = headers["content-type"]
           case [content_type, body]
           in [OnebusawaySDK::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.generate(body)]
-          in [OnebusawaySDK::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(OnebusawaySDK::Internal::Type::FileInput)
+          in [OnebusawaySDK::Internal::Util::JSONL_CONTENT, Enumerable] unless OnebusawaySDK::Internal::Type::FileInput === body
             [headers, body.lazy.map { JSON.generate(_1) }]
           in [%r{^multipart/form-data}, Hash | OnebusawaySDK::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
@@ -602,6 +621,8 @@ module OnebusawaySDK
           else
             [headers, body]
           end
+          # rubocop:enable Layout/LineLength
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -826,11 +847,43 @@ module OnebusawaySDK
           sorbet_runtime_constants.fetch(name).call
         end
 
+        # @api private
+        #
+        # @param name [Symbol]
+        #
+        # @return [Boolean]
+        def sorbet_constant_defined?(name) = sorbet_runtime_constants.key?(name)
+
         # @api private
         #
         # @param name [Symbol]
         # @param blk [Proc]
         def define_sorbet_constant!(name, &blk) = sorbet_runtime_constants.store(name, blk)
+
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type = raise NotImplementedError
+
+        class << self
+          # @api private
+          #
+          # @param type [OnebusawaySDK::Internal::Util::SorbetRuntimeSupport, Object]
+          #
+          # @return [Object]
+          def to_sorbet_type(type)
+            case type
+            in OnebusawaySDK::Internal::Util::SorbetRuntimeSupport
+              type.to_sorbet_type
+            in Class | Module
+              type
+            in true | false
+              T::Boolean
+            else
+              type.class
+            end
+          end
+        end
       end
 
       extend OnebusawaySDK::Internal::Util::SorbetRuntimeSupport

data/lib/onebusaway_sdk/internal.rb

@@ -13,5 +13,8 @@ module OnebusawaySDK
     define_sorbet_constant!(:AnyHash) do
       T.type_alias { T::Hash[Symbol, T.anything] }
     end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, OnebusawaySDK::FilePart) }
+    end
   end
 end

data/lib/onebusaway_sdk/models/agencies_with_coverage_list_response.rb

@@ -26,13 +26,13 @@ module OnebusawaySDK
 
         # @!attribute references
         #
-        #   @return [OnebusawaySDK::References]
+        #   @return [OnebusawaySDK::Models::References]
         required :references, -> { OnebusawaySDK::References }
 
         # @!method initialize(limit_exceeded:, list:, references:)
         #   @param limit_exceeded [Boolean]
         #   @param list [Array<OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List>]
-        #   @param references [OnebusawaySDK::References]
+        #   @param references [OnebusawaySDK::Models::References]
 
         class List < OnebusawaySDK::Internal::Type::BaseModel
           # @!attribute agency_id

data/lib/onebusaway_sdk/models/agency_retrieve_response.rb

@@ -25,13 +25,13 @@ module OnebusawaySDK
 
         # @!attribute references
         #
-        #   @return [OnebusawaySDK::References]
+        #   @return [OnebusawaySDK::Models::References]
         required :references, -> { OnebusawaySDK::References }
 
         # @!method initialize(entry:, limit_exceeded:, references:)
         #   @param entry [OnebusawaySDK::Models::AgencyRetrieveResponse::Data::Entry]
         #   @param limit_exceeded [Boolean]
-        #   @param references [OnebusawaySDK::References]
+        #   @param references [OnebusawaySDK::Models::References]
 
         # @see OnebusawaySDK::Models::AgencyRetrieveResponse::Data#entry
         class Entry < OnebusawaySDK::Internal::Type::BaseModel

data/lib/onebusaway_sdk/models/arrival_and_departure_list_response.rb

@@ -20,12 +20,12 @@ module OnebusawaySDK
 
         # @!attribute references
         #
-        #   @return [OnebusawaySDK::References]
+        #   @return [OnebusawaySDK::Models::References]
         required :references, -> { OnebusawaySDK::References }
 
         # @!method initialize(entry:, references:)
         #   @param entry [OnebusawaySDK::Models::ArrivalAndDepartureListResponse::Data::Entry]
-        #   @param references [OnebusawaySDK::References]
+        #   @param references [OnebusawaySDK::Models::References]
 
         # @see OnebusawaySDK::Models::ArrivalAndDepartureListResponse::Data#entry
         class Entry < OnebusawaySDK::Internal::Type::BaseModel

data/lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb

@@ -20,12 +20,12 @@ module OnebusawaySDK
 
         # @!attribute references
         #
-        #   @return [OnebusawaySDK::References]
+        #   @return [OnebusawaySDK::Models::References]
         required :references, -> { OnebusawaySDK::References }
 
         # @!method initialize(entry:, references:)
         #   @param entry [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry]
-        #   @param references [OnebusawaySDK::References]
+        #   @param references [OnebusawaySDK::Models::References]
 
         # @see OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data#entry
         class Entry < OnebusawaySDK::Internal::Type::BaseModel

data/lib/onebusaway_sdk/models/block_retrieve_response.rb

@@ -20,12 +20,12 @@ module OnebusawaySDK
 
         # @!attribute references
         #
-        #   @return [OnebusawaySDK::References]
+        #   @return [OnebusawaySDK::Models::References]
         required :references, -> { OnebusawaySDK::References }
 
         # @!method initialize(entry:, references:)
         #   @param entry [OnebusawaySDK::Models::BlockRetrieveResponse::Data::Entry]
-        #   @param references [OnebusawaySDK::References]
+        #   @param references [OnebusawaySDK::Models::References]
 
         # @see OnebusawaySDK::Models::BlockRetrieveResponse::Data#entry
         class Entry < OnebusawaySDK::Internal::Type::BaseModel

data/lib/onebusaway_sdk/models/config_retrieve_response.rb

@@ -20,12 +20,12 @@ module OnebusawaySDK
 
         # @!attribute references
         #
-        #   @return [OnebusawaySDK::References]
+        #   @return [OnebusawaySDK::Models::References]
         required :references, -> { OnebusawaySDK::References }
 
         # @!method initialize(entry:, references:)
         #   @param entry [OnebusawaySDK::Models::ConfigRetrieveResponse::Data::Entry]
-        #   @param references [OnebusawaySDK::References]
+        #   @param references [OnebusawaySDK::Models::References]
 
         # @see OnebusawaySDK::Models::ConfigRetrieveResponse::Data#entry
         class Entry < OnebusawaySDK::Internal::Type::BaseModel

data/lib/onebusaway_sdk/models/current_time_retrieve_response.rb

@@ -20,12 +20,12 @@ module OnebusawaySDK
 
         # @!attribute references
         #
-        #   @return [OnebusawaySDK::References]
+        #   @return [OnebusawaySDK::Models::References]
         required :references, -> { OnebusawaySDK::References }
 
         # @!method initialize(entry:, references:)
         #   @param entry [OnebusawaySDK::Models::CurrentTimeRetrieveResponse::Data::Entry]
-        #   @param references [OnebusawaySDK::References]
+        #   @param references [OnebusawaySDK::Models::References]
 
         # @see OnebusawaySDK::Models::CurrentTimeRetrieveResponse::Data#entry
         class Entry < OnebusawaySDK::Internal::Type::BaseModel