finch-api 0.1.0.pre.alpha.13 → 0.1.0.pre.alpha.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fba7c8f7c2915872fe46805c61d1b3d2642e182fe1fc8f388c2ac1ccaffe4ee2
-  data.tar.gz: 91a48ef6711acedd26bb0ddc648823886606ff5217ddea3d94fb707c5f51b889
+  metadata.gz: 2c37d2aee31747587b9942cf19e907e69ff5d4e27c53e671a7be421ebe40e1b5
+  data.tar.gz: 4fd9f8fd024e335999ac23951a84427a2897a8d5331ce4d32a104ae32bd54103
 SHA512:
-  metadata.gz: b6d1214361cda01b3fee4a511837b79ea029246bc26d24c985b69f06fa679f3a1212f1cf193c1245f47aa88f749a7ff9e228c95dd5235b51936e996e93c4e237
-  data.tar.gz: 2b1d9737c56f95eaaf1f5f5ba81c9dcb95399ceb678c1bc09eeb1ab32744a50630939e6c0dd2603e9c9c898d7b97e43e6f3a1ccec305c71218fd8f4cbe1c0038
+  metadata.gz: 912cc67b4837f36a734cc87f1d0be3d3a70ec839f2a4e5abaf8dc14514becec74cd1cecd574de375d3adc3aa8e71faeb77d749be84b38493dcbdc51c851159a2
+  data.tar.gz: be1c5c14fa6bc2cd37861ce3c617759302c282023acb6d52da1809a0ef50dee1aaf38ddc97640f08a88a48d8f37b1d0bb81efcd94116549267b4379275549619

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## 0.1.0-alpha.14 (2025-05-07)
+
+Full Changelog: [v0.1.0-alpha.13...v0.1.0-alpha.14](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.13...v0.1.0-alpha.14)
+
+### Features
+
+* **api:** api update ([a1e63ab](https://github.com/Finch-API/finch-api-ruby/commit/a1e63ab1e953ca1a3745ec158e5cbba3336e8cc4))
+* **api:** api update ([131b860](https://github.com/Finch-API/finch-api-ruby/commit/131b8600623807e6f9fe61eec0008f466ea9bf51))
+* **api:** api update ([0cb263a](https://github.com/Finch-API/finch-api-ruby/commit/0cb263a792ddcd544d4b790dcb87a49af23798de))
+* **api:** api update ([664ac2e](https://github.com/Finch-API/finch-api-ruby/commit/664ac2e40a5f79294e19f2536241e3e3080b35bd))
+* **api:** api update ([f4d4ab0](https://github.com/Finch-API/finch-api-ruby/commit/f4d4ab0dcfb81d75e0f7fe5bee9583a616e39ac6))
+* **api:** api update ([bdab477](https://github.com/Finch-API/finch-api-ruby/commit/bdab47770cdc398d71349734d214d365569311a0))
+
+
+### Bug Fixes
+
+* **internal:** ensure formatting always uses c.utf-8 locale ([4b68a42](https://github.com/Finch-API/finch-api-ruby/commit/4b68a42729fba915f1d778b306f9a1120f936012))
+* **internal:** fix formatting script for macos ([549b415](https://github.com/Finch-API/finch-api-ruby/commit/549b415b8fbb8baf6de342de32798d3096085a3c))
+
+
+### Chores
+
+* accept all nd-json mimetype variants ([53a8863](https://github.com/Finch-API/finch-api-ruby/commit/53a8863036254bd052c47fb283c82798784859f6))
+* always check if current page is empty in `next_page?` ([89f7522](https://github.com/Finch-API/finch-api-ruby/commit/89f7522c76cbf4cb79a171b842fdb9db8ca0fb1f))
+* **internal:** codegen related update ([15d107c](https://github.com/Finch-API/finch-api-ruby/commit/15d107cee7ff974a750f1cbfa812392ac1b7fc47))
+* **internal:** codegen related update ([bcaecfa](https://github.com/Finch-API/finch-api-ruby/commit/bcaecfa4b137a6a767d69ea15c77885185d8368c))
+* **internal:** codegen related update ([f328b3a](https://github.com/Finch-API/finch-api-ruby/commit/f328b3a5c3ea6ffeb01186ea929b4eb6f70ef1aa))
+* re-export top level models under library namespace ([e8cc430](https://github.com/Finch-API/finch-api-ruby/commit/e8cc430134d053ce8e3e5d31aea2c43270eb2ffa))
+* remove Gemfile.lock during bootstrap ([6a383f0](https://github.com/Finch-API/finch-api-ruby/commit/6a383f0228803c29f1a22658821311ad3239aa97))
+* reorganize type aliases ([e527e5d](https://github.com/Finch-API/finch-api-ruby/commit/e527e5d5d118f2d00611a2f790e9fcc67a4794b0))
+* revert ignoring Gemfile.lock ([8abcd39](https://github.com/Finch-API/finch-api-ruby/commit/8abcd39a9a0ba36ac5e1a8b65e69762c174408e4))
+* validate request option coercion correctness ([41e068d](https://github.com/Finch-API/finch-api-ruby/commit/41e068d7304cd25e4e250a2c724cb99b1bf9d9b8))
+
+
+### Documentation
+
+* **readme:** fix typo ([15960ca](https://github.com/Finch-API/finch-api-ruby/commit/15960caf4fd7cfd3596326a0605ab61a64441558))
+
 ## 0.1.0-alpha.13 (2025-04-29)
 
 Full Changelog: [v0.1.0-alpha.12...v0.1.0-alpha.13](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.12...v0.1.0-alpha.13)

data/README.md

@@ -1,6 +1,6 @@
 # Finch Ruby API library
 
-The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.1.0+ application.
+The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.2.0+ application.
 
 It is generated with [Stainless](https://www.stainless.com/).
 
@@ -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 "finch-api", "~> 0.1.0.pre.alpha.13"
+gem "finch-api", "~> 0.1.0.pre.alpha.14"
 ```
 
 <!-- x-release-please-end -->
@@ -76,7 +76,7 @@ rescue FinchAPI::Errors::APIError => e
 end
 ```
 
-Error codes are as followed:
+Error codes are as follows:
 
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
@@ -191,9 +191,9 @@ Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbe
 Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead.
 
 ```ruby
-module FinchAPI::Models::ConnectionStatusType
+module FinchAPI::ConnectionStatusType
   # This alias aids language service driven navigation.
-  TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::ConnectionStatusType) }
+  TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::ConnectionStatusType) }
 end
 ```
 
@@ -214,7 +214,7 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.1.0 or higher.
+Ruby 3.2.0 or higher.
 
 ## Contributing
 

data/lib/finch_api/file_part.rb

@@ -45,9 +45,9 @@ module FinchAPI
       @filename =
         case content
         in Pathname
-          filename.nil? ? content.basename.to_path : File.basename(filename)
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
         else
-          filename.nil? ? nil : File.basename(filename)
+          filename.nil? ? nil : ::File.basename(filename)
         end
       @content_type = content_type
     end

data/lib/finch_api/internal/individuals_page.rb

@@ -19,12 +19,12 @@ module FinchAPI
       # @return [Array<generic<Elem>>, nil]
       attr_accessor :individuals
 
-      # @return [FinchAPI::Models::Paging]
+      # @return [FinchAPI::Paging]
       attr_accessor :paging
 
       # @return [Boolean]
       def next_page?
-        paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i
+        !individuals.to_a.empty? && (paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i)
       end
 
       # @raise [FinchAPI::HTTP::Error]
@@ -69,13 +69,13 @@ module FinchAPI
         super
 
         case page_data
-        in {individuals: Array | nil => individuals}
-          @individuals = individuals&.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) }
+        in {individuals: Array => individuals}
+          @individuals = individuals.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) }
         else
         end
         case page_data
         in {paging: Hash | nil => paging}
-          @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Models::Paging, paging)
+          @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Paging, paging)
         else
         end
       end

data/lib/finch_api/internal/page.rb

@@ -19,12 +19,12 @@ module FinchAPI
       # @return [Array<generic<Elem>>, nil]
       attr_accessor :data
 
-      # @return [FinchAPI::Models::Paging]
+      # @return [FinchAPI::Paging]
       attr_accessor :paging
 
       # @return [Boolean]
       def next_page?
-        paging&.offset.to_i + data.to_a.size < paging&.count.to_i
+        !data.to_a.empty? && (paging&.offset.to_i + data.to_a.size < paging&.count.to_i)
       end
 
       # @raise [FinchAPI::HTTP::Error]
@@ -69,13 +69,13 @@ module FinchAPI
         super
 
         case page_data
-        in {data: Array | nil => data}
-          @data = data&.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) }
+        in {data: Array => data}
+          @data = data.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) }
         else
         end
         case page_data
         in {paging: Hash | nil => paging}
-          @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Models::Paging, paging)
+          @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Paging, paging)
         else
         end
       end

data/lib/finch_api/internal/responses_page.rb

@@ -57,8 +57,8 @@ module FinchAPI
         super
 
         case page_data
-        in {responses: Array | nil => responses}
-          @responses = responses&.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) }
+        in {responses: Array => responses}
+          @responses = responses.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) }
         else
         end
       end

data/lib/finch_api/internal/transport/base_client.rb

@@ -261,7 +261,7 @@ module FinchAPI
             headers["x-stainless-retry-count"] = "0"
           end
 
-          timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..))
+          timeout = opts.fetch(:timeout, @timeout).to_f.clamp(0..)
           unless headers.key?("x-stainless-timeout") || timeout.zero?
             headers["x-stainless-timeout"] = timeout.to_s
           end
@@ -458,9 +458,9 @@ module FinchAPI
 
           decoded = FinchAPI::Internal::Util.decode_content(response, stream: stream)
           case req
-          in { stream: Class => st }
+          in {stream: Class => st}
             st.new(model: model, url: url, status: status, response: response, stream: decoded)
-          in { page: Class => page }
+          in {page: Class => page}
             page.new(client: self, req: req, headers: response, page_data: decoded)
           else
             unwrapped = FinchAPI::Internal::Util.dig(decoded, req[:unwrap])

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

@@ -397,15 +397,7 @@ module FinchAPI
         # Create a new instance of a model.
         #
         # @param data [Hash{Symbol=>Object}, self]
-        def initialize(data = {})
-          case FinchAPI::Internal::Util.coerce_hash(data)
-          in Hash => coerced
-            @data = coerced
-          else
-            message = "Expected a #{Hash} or #{FinchAPI::Internal::Type::BaseModel}, got #{data.inspect}"
-            raise ArgumentError.new(message)
-          end
-        end
+        def initialize(data = {}) = (@data = FinchAPI::Internal::Util.coerce_hash!(data).to_h)
 
         class << self
           # @api private

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

@@ -17,13 +17,13 @@ module FinchAPI
       # values safely.
       #
       # @example
-      #   # `connection_status_type` is a `FinchAPI::Models::ConnectionStatusType`
+      #   # `connection_status_type` is a `FinchAPI::ConnectionStatusType`
       #   case connection_status_type
-      #   when FinchAPI::Models::ConnectionStatusType::PENDING
+      #   when FinchAPI::ConnectionStatusType::PENDING
       #     # ...
-      #   when FinchAPI::Models::ConnectionStatusType::PROCESSING
+      #   when FinchAPI::ConnectionStatusType::PROCESSING
       #     # ...
-      #   when FinchAPI::Models::ConnectionStatusType::CONNECTED
+      #   when FinchAPI::ConnectionStatusType::CONNECTED
       #     # ...
       #   else
       #     puts(connection_status_type)

data/lib/finch_api/internal/type/request_parameters.rb

@@ -5,10 +5,10 @@ module FinchAPI
     module Type
       # @api private
       module RequestParameters
-        # @!parse
-        #   # Options to specify HTTP behaviour for this request.
-        #   # @return [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   attr_accessor :request_options
+        # @!attribute request_options
+        # Options to specify HTTP behaviour for this request.
+        #
+        #   @return [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
         # @param mod [Module]
         def self.included(mod)
@@ -28,14 +28,8 @@ module FinchAPI
             state = {can_retry: true}
             case (dumped = dump(params, state: state))
             in Hash
-              options = FinchAPI::Internal::Util.coerce_hash(dumped[:request_options])
-              request_options =
-                case [options, state.fetch(:can_retry)]
-                in [Hash | nil, false]
-                  {**options.to_h, max_retries: 0}
-                else
-                  options
-                end
+              options = FinchAPI::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
+              request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
               [dumped.except(:request_options), request_options]
             else
               [dumped, nil]

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

@@ -8,9 +8,9 @@ module FinchAPI
       # @example
       #   # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse`
       #   case document_retreive_response
-      #   when FinchAPI::Models::HRIS::W42020
+      #   when FinchAPI::HRIS::W42020
       #     puts(document_retreive_response.data)
-      #   when FinchAPI::Models::HRIS::W42005
+      #   when FinchAPI::HRIS::W42005
       #     puts(document_retreive_response.type)
       #   else
       #     puts(document_retreive_response)

data/lib/finch_api/internal/util.rb

@@ -128,6 +128,22 @@ module FinchAPI
             input.respond_to?(:to_h) ? input.to_h : input
           end
         end
+
+        # @api private
+        #
+        # @param input [Object]
+        #
+        # @raise [ArgumentError]
+        # @return [Hash{Object=>Object}, nil]
+        def coerce_hash!(input)
+          case coerce_hash(input)
+          in Hash | nil => coerced
+            coerced
+          else
+            message = "Expected a #{Hash} or #{FinchAPI::Internal::Type::BaseModel}, got #{data.inspect}"
+            raise ArgumentError.new(message)
+          end
+        end
       end
 
       class << self
@@ -454,7 +470,7 @@ module FinchAPI
       # @type [Regexp]
       JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
       # @type [Regexp]
-      JSONL_CONTENT = %r{^application/(?:x-)?jsonl}
+      JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
         # @api private
@@ -493,7 +509,7 @@ module FinchAPI
             y << val.to_s
           else
             y << "Content-Type: application/json\r\n\r\n"
-            y << JSON.fast_generate(val)
+            y << JSON.generate(val)
           end
           y << "\r\n"
         end
@@ -519,7 +535,7 @@ module FinchAPI
             filename = ERB::Util.url_encode(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(File.basename(val.to_path))
+            filename = ERB::Util.url_encode(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -570,9 +586,9 @@ module FinchAPI
           content_type = headers["content-type"]
           case [content_type, body]
           in [FinchAPI::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
-            [headers, JSON.fast_generate(body)]
+            [headers, JSON.generate(body)]
           in [FinchAPI::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(FinchAPI::Internal::Type::FileInput)
-            [headers, body.lazy.map { JSON.fast_generate(_1) }]
+            [headers, body.lazy.map { JSON.generate(_1) }]
           in [%r{^multipart/form-data}, Hash | FinchAPI::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}