metronome-sdk 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2446e983c08f573e1756e7aeb0fd0cac0d67056f18c3c0464e2d0422f63aa2f2
-  data.tar.gz: 282cfc878a3a3d74b38184a1b473a9080e265fb0224ee7b3d2dce2ae5aa7caab
+  metadata.gz: '0915b00a0f26162aace25f837292b0a4397ebd7e62179d9b8b3605a322ecfa1d'
+  data.tar.gz: 8d0580f9ba5e72ca8eb0729c8664aff99b00bee910368df5a692e4b2fab6740b
 SHA512:
-  metadata.gz: a379c84d235c7957ca683790821b637b2eac2f86ca46c0bc31c6093b699974b89e3e1def7092aee0b692dda2acb1cc76109a9e588b37c1f4b248203e2090d659
-  data.tar.gz: 621e6552b720ac41ef0bff931ddfbdfa22c0eec89ca9a2c143c930ee631dcb67fe7c24c428bd7f521a704e734834aad81079ee7ac1e6261bcc035233d016cbcc
+  metadata.gz: 51ff71fc9926d302ef837596298dfa6eea80c52200b0861e51b4d6f399be2d276f04987ae40c0346eef2f3f5cdc18cce603b44bfb4c99fb123b20e5c3c7b5983
+  data.tar.gz: 6a93ca533bf883619baecd64f06f6b51811676a2f8872cb5205d5ac64b52136a3f27f392671eb7deae4784e7af780cec40df66d3fa1f9b53c6162087a3dc893f

data/CHANGELOG.md

@@ -1,5 +1,60 @@
 # Changelog
 
+## 2.0.0 (2025-10-16)
+
+Full Changelog: [v1.0.0...v2.0.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v1.0.0...v2.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** Remove customer_id from preview events payload
+* **api:** in getEditHistory endpoint, commit invoice schedule amount, unit price, and quantity are now optional values
+* **api:** Added optional archive_filter param to /notifications/offset/list endpoint
+
+### Features
+
+* Add empty handler for cancelPayment ([7e99149](https://github.com/Metronome-Industries/metronome-ruby/commit/7e99149c22a82550ec373c0727351c4b70c852eb))
+* Add payment APIs to the SDK ([616d0df](https://github.com/Metronome-Industries/metronome-ruby/commit/616d0df5ded63e16bb817733c839196ac9033074))
+* **api:** add billing_periods to Subscription ([fadf0b8](https://github.com/Metronome-Industries/metronome-ruby/commit/fadf0b8e5db369baefffa0a7e30602da594eff03))
+* **api:** add new payments/attempt v1 api endpoint ([da865e7](https://github.com/Metronome-Industries/metronome-ruby/commit/da865e7efa8e041a6e84f3482ec786fb9ae0bb91))
+* **api:** Added optional archive_filter param to /notifications/offset/list endpoint ([2fdc9f4](https://github.com/Metronome-Industries/metronome-ruby/commit/2fdc9f4e905b00e8bdfcfc7c364d08bb60b40c5f))
+* **api:** Remove customer_id from preview events payload ([20ca72d](https://github.com/Metronome-Industries/metronome-ruby/commit/20ca72d41c6793058ab236e67b29bc2e0d2b4143))
+* Bump graphql version and fix type errors ([13a12b1](https://github.com/Metronome-Industries/metronome-ruby/commit/13a12b145a0cf9889315ebf05bb147943632e520))
+* elia/orch 128 add external apis for payments ([91fb616](https://github.com/Metronome-Industries/metronome-ruby/commit/91fb6167790ec522698bdbdb22ccd370f1bddcc2))
+* expose response headers for both streams and errors ([9f0e87e](https://github.com/Metronome-Industries/metronome-ruby/commit/9f0e87e8df28a54ccc7a913d687205dee5ccf9cb))
+* feat(api):Allow clients retrieve archived config via `/notifications/get` ([466033c](https://github.com/Metronome-Industries/metronome-ruby/commit/466033c55325bd066a9a8c6669955bbec1328ce1))
+* internal: releasing x-mint ([d14a332](https://github.com/Metronome-Industries/metronome-ruby/commit/d14a33277f46d61ab13a26e22dd88f343583d9d6))
+* internal: Skip retrieve_pdf API SDK tests ([c079dc3](https://github.com/Metronome-Industries/metronome-ruby/commit/c079dc32fddf4862e271cf60fd0192cca3cb0ce1))
+* internal(docs): adding confluent endpoints ([79bb81b](https://github.com/Metronome-Industries/metronome-ruby/commit/79bb81b1b17ebd05349fac0279bc17b0a71f9245))
+* LAUNCH-516 add getSubscriptionSeatsScheduleHistory api ([bcc34f8](https://github.com/Metronome-Industries/metronome-ruby/commit/bcc34f8dd2fe1be818ecbd1dbf9108020a15f2f7))
+* rename getSubscriptionSeatsScheduleHistory to getSubscriptionSeatsHistory ([68ef0a3](https://github.com/Metronome-Industries/metronome-ruby/commit/68ef0a3ddd9771fa4d810d750f37483d24d2d3f0))
+* Return array of invoices instead of single invoice and handle multipl… ([129d95e](https://github.com/Metronome-Industries/metronome-ruby/commit/129d95ef9c26cd35adb9b493aa07f610f53c2a89))
+* Set up contract get and create with new AH info ([9a174d7](https://github.com/Metronome-Industries/metronome-ruby/commit/9a174d758368c63f563b26e840afa7385c7040cc))
+* update api docs ([e9ef5a1](https://github.com/Metronome-Industries/metronome-ruby/commit/e9ef5a1e3aa60612c73d0bb7f88fe95382e81549))
+
+
+### Bug Fixes
+
+* absolutely qualified uris should always override the default ([d2a34bf](https://github.com/Metronome-Industries/metronome-ruby/commit/d2a34bf32891e8e9938f939c53971cf8c824406b))
+* always send `filename=...` for multipart requests where a file is expected ([618065e](https://github.com/Metronome-Industries/metronome-ruby/commit/618065efd1dfc5f78842f26047c63f8f8214d922))
+* **api:** in getEditHistory endpoint, commit invoice schedule amount, unit price, and quantity are now optional values ([d2a37fb](https://github.com/Metronome-Industries/metronome-ruby/commit/d2a37fb61ca0bd828868a2b7d86ddd0d5a12f311))
+* coroutine leaks from connection pool ([f44d189](https://github.com/Metronome-Industries/metronome-ruby/commit/f44d18933e585e241d04277911be69eedbb72be8))
+* **internal:** use null byte as file separator in the fast formatting script ([dec574a](https://github.com/Metronome-Industries/metronome-ruby/commit/dec574a038c9a81c43efd52fadbe9ed4b41d9465))
+* LAUNCH-1130 remove min and max in api spec for better valiation error message ([1e2282c](https://github.com/Metronome-Industries/metronome-ruby/commit/1e2282cd8b3feab83f0b487e29509a7591d854b1))
+* shorten multipart boundary sep to less than RFC specificed max length ([b49e6f1](https://github.com/Metronome-Industries/metronome-ruby/commit/b49e6f16e1836ddb330d3bb22ed5cbe70ebe435d))
+* should not reuse buffers for `IO.copy_stream` interop ([c80da18](https://github.com/Metronome-Industries/metronome-ruby/commit/c80da18b2978ee09675a8031db122a04450fcd24))
+
+
+### Performance Improvements
+
+* faster code formatting ([1a84007](https://github.com/Metronome-Industries/metronome-ruby/commit/1a8400771228e75a50f7003f8864740da000f583))
+
+
+### Chores
+
+* allow fast-format to use bsd sed as well ([10fad42](https://github.com/Metronome-Industries/metronome-ruby/commit/10fad42d511c0a696c22b4f94b5c6c828b855980))
+* do not install brew dependencies in ./scripts/bootstrap by default ([92ff30c](https://github.com/Metronome-Industries/metronome-ruby/commit/92ff30cd9332917e0f465525ccf2ac809d8de48b))
+* ignore linter error for tests having large collections ([785a441](https://github.com/Metronome-Industries/metronome-ruby/commit/785a441f773283af8731625e50de3ea7d67bdc81))
+
 ## 1.0.0 (2025-09-15)
 
 Full Changelog: [v0.3.0...v1.0.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.3.0...v1.0.0)

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 "metronome-sdk", "~> 1.0.0"
+gem "metronome-sdk", "~> 2.0.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/metronome_sdk/errors.rb

@@ -40,6 +40,9 @@ module MetronomeSDK
       # @return [Integer, nil]
       attr_accessor :status
 
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
       # @return [Object, nil]
       attr_accessor :body
 
@@ -47,13 +50,15 @@ module MetronomeSDK
       #
       # @param url [URI::Generic]
       # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, 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)
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
         @url = url
         @status = status
+        @headers = headers
         @body = body
         @request = request
         @response = response
@@ -74,6 +79,7 @@ module MetronomeSDK
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -81,6 +87,7 @@ module MetronomeSDK
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -95,6 +102,7 @@ module MetronomeSDK
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -102,6 +110,7 @@ module MetronomeSDK
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,21 +125,24 @@ module MetronomeSDK
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @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
-        }
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
 
         case status
         in 400
@@ -162,15 +174,17 @@ module MetronomeSDK
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status:, body:, request:, response:, message: nil)
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
         message ||= {url: url.to_s, status: status, body: body}
         super(
           url: url,
           status: status,
+          headers: headers,
           body: body,
           request: request,
           response: response,

data/lib/metronome_sdk/file_part.rb

@@ -38,18 +38,21 @@ module MetronomeSDK
     def to_yaml(*a) = read.to_yaml(*a)
 
     # @param content [Pathname, StringIO, IO, String]
-    # @param filename [String, nil]
+    # @param filename [Pathname, String, nil]
     # @param content_type [String, nil]
     def initialize(content, filename: nil, content_type: nil)
-      @content = content
+      @content_type = content_type
       @filename =
-        case content
-        in Pathname
-          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        case [filename, (@content = content)]
+        in [String | Pathname, _]
+          ::File.basename(filename)
+        in [nil, Pathname]
+          content.basename.to_path
+        in [nil, IO]
+          content.to_path
         else
-          filename.nil? ? nil : ::File.basename(filename)
+          filename
         end
-      @content_type = content_type
     end
   end
 end

data/lib/metronome_sdk/internal/body_cursor_page.rb

@@ -60,7 +60,7 @@ module MetronomeSDK
       #
       # @param client [MetronomeSDK::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/metronome_sdk/internal/cursor_page.rb

@@ -60,7 +60,7 @@ module MetronomeSDK
       #
       # @param client [MetronomeSDK::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/metronome_sdk/internal/cursor_page_without_limit.rb

@@ -60,7 +60,7 @@ module MetronomeSDK
       #
       # @param client [MetronomeSDK::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

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

@@ -47,7 +47,7 @@ module MetronomeSDK
           # @api private
           #
           # @param status [Integer]
-          # @param headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param headers [Hash{String=>String}]
           #
           # @return [Boolean]
           def should_retry?(status, headers:)
@@ -85,7 +85,7 @@ module MetronomeSDK
           #
           # @param status [Integer]
           #
-          # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param response_headers [Hash{String=>String}]
           #
           # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
@@ -378,6 +378,7 @@ module MetronomeSDK
           rescue MetronomeSDK::Errors::APIConnectionError => e
             status = e
           end
+          headers = MetronomeSDK::Internal::Util.normalized_headers(response&.each_header&.to_h)
 
           case status
           in ..299
@@ -390,7 +391,7 @@ module MetronomeSDK
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
-            request = self.class.follow_redirect(request, status: status, response_headers: response)
+            request = self.class.follow_redirect(request, status: status, response_headers: headers)
             send_request(
               request,
               redirect_count: redirect_count + 1,
@@ -399,9 +400,9 @@ module MetronomeSDK
             )
           in MetronomeSDK::Errors::APIConnectionError if retry_count >= max_retries
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
-              MetronomeSDK::Internal::Util.decode_content(response, stream: stream, suppress_error: true)
+              MetronomeSDK::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure
               self.class.reap_connection!(status, stream: stream)
             end
@@ -409,6 +410,7 @@ module MetronomeSDK
             raise MetronomeSDK::Errors::APIStatusError.for(
               url: url,
               status: status,
+              headers: headers,
               body: decoded,
               request: nil,
               response: response
@@ -485,19 +487,21 @@ module MetronomeSDK
             send_retry_header: send_retry_header
           )
 
-          decoded = MetronomeSDK::Internal::Util.decode_content(response, stream: stream)
+          headers = MetronomeSDK::Internal::Util.normalized_headers(response.each_header.to_h)
+          decoded = MetronomeSDK::Internal::Util.decode_content(headers, stream: stream)
           case req
           in {stream: Class => st}
             st.new(
               model: model,
               url: url,
               status: status,
+              headers: headers,
               response: response,
               unwrap: unwrap,
               stream: decoded
             )
           in {page: Class => page}
-            page.new(client: self, req: req, headers: response, page_data: decoded)
+            page.new(client: self, req: req, headers: headers, page_data: decoded)
           else
             unwrapped = MetronomeSDK::Internal::Util.dig(decoded, unwrap)
             MetronomeSDK::Internal::Type::Converter.coerce(model, unwrapped)

data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb

@@ -134,9 +134,9 @@ module MetronomeSDK
 
           # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
-            with_pool(url, deadline: deadline) do |conn|
-              next if finished
+            next if finished
 
+            with_pool(url, deadline: deadline) do |conn|
               req, closing = self.class.build_request(request) do
                 self.class.calibrate_socket_timeout(conn, deadline)
               end
@@ -149,7 +149,7 @@ module MetronomeSDK
 
               self.class.calibrate_socket_timeout(conn, deadline)
               conn.request(req) do |rsp|
-                y << [conn, req, rsp]
+                y << [req, rsp]
                 break if finished
 
                 rsp.read_body do |bytes|
@@ -160,6 +160,8 @@ module MetronomeSDK
                 end
                 eof = true
               end
+            ensure
+              conn.finish if !eof && conn&.started?
             end
           rescue Timeout::Error
             raise MetronomeSDK::Errors::APITimeoutError.new(url: url, request: req)
@@ -168,16 +170,11 @@ module MetronomeSDK
           end
           # rubocop:enable Metrics/BlockLength
 
-          conn, _, response = enum.next
+          _, response = enum.next
           body = MetronomeSDK::Internal::Util.fused_enum(enum, external: true) do
             finished = true
-            tap do
-              enum.next
-            rescue StopIteration
-              nil
-            end
+            loop { enum.next }
           ensure
-            conn.finish if !eof && conn&.started?
             closing&.call
           end
           [Integer(response.code), response, body]

data/lib/metronome_sdk/internal/type/base_page.rb

@@ -39,7 +39,7 @@ module MetronomeSDK
         #
         # @param client [MetronomeSDK::Internal::Transport::BaseClient]
         # @param req [Hash{Symbol=>Object}]
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param page_data [Object]
         def initialize(client:, req:, headers:, page_data:)
           @client = client

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

@@ -15,6 +15,31 @@ module MetronomeSDK
       #
       # We can therefore convert string values to Symbols, but can't convert other
       # values safely.
+      #
+      # @example
+      #   # `payment_status` is a `MetronomeSDK::V1::PaymentStatus`
+      #   case payment_status
+      #   when MetronomeSDK::V1::PaymentStatus::PENDING
+      #     # ...
+      #   when MetronomeSDK::V1::PaymentStatus::REQUIRES_INTERVENTION
+      #     # ...
+      #   when MetronomeSDK::V1::PaymentStatus::PAID
+      #     # ...
+      #   else
+      #     puts(payment_status)
+      #   end
+      #
+      # @example
+      #   case payment_status
+      #   in :pending
+      #     # ...
+      #   in :requires_intervention
+      #     # ...
+      #   in :paid
+      #     # ...
+      #   else
+      #     puts(payment_status)
+      #   end
       module Enum
         include MetronomeSDK::Internal::Type::Converter
         include MetronomeSDK::Internal::Util::SorbetRuntimeSupport

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

@@ -82,17 +82,20 @@ module MetronomeSDK
           #
           # @return [Pathname, StringIO, IO, String, Object]
           def dump(value, state:)
-            # rubocop:disable Lint/DuplicateBranch
             case value
+            in StringIO | String
+              # https://datatracker.ietf.org/doc/html/rfc7578#section-4.2
+              # while not required, a filename is recommended, and in practice many servers do expect this
+              MetronomeSDK::FilePart.new(value, filename: "upload")
             in IO
               state[:can_retry] = false
+              value.to_path.nil? ? MetronomeSDK::FilePart.new(value, filename: "upload") : value
             in MetronomeSDK::FilePart if value.content.is_a?(IO)
               state[:can_retry] = false
+              value
             else
+              value
             end
-            # rubocop:enable Lint/DuplicateBranch
-
-            value
           end
 
           # @api private

data/lib/metronome_sdk/internal/util.rb

@@ -346,8 +346,9 @@ module MetronomeSDK
           base_path, base_query = lhs.fetch_values(:path, :query)
           slashed = base_path.end_with?("/") ? base_path : "#{base_path}/"
 
-          parsed_path, parsed_query = parse_uri(rhs.fetch(:path)).fetch_values(:path, :query)
-          override = URI::Generic.build(**rhs.slice(:scheme, :host, :port), path: parsed_path)
+          merged = {**parse_uri(rhs.fetch(:path)), **rhs.except(:path, :query)}
+          parsed_path, parsed_query = merged.fetch_values(:path, :query)
+          override = URI::Generic.build(**merged.slice(:scheme, :host, :port), path: parsed_path)
 
           joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override)
           query = deep_merge(
@@ -473,10 +474,9 @@ module MetronomeSDK
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
-            buf = String.new
             y.define_singleton_method(:write) do
-              self << buf.replace(_1)
-              buf.bytesize
+              self << _1.dup
+              _1.bytesize
             end
 
             blk.call(y)
@@ -566,7 +566,8 @@ module MetronomeSDK
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
-          boundary = SecureRandom.urlsafe_base64(60)
+          # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
+          boundary = SecureRandom.urlsafe_base64(46)
 
           closing = []
           strio = writable_enum do |y|
@@ -647,7 +648,7 @@ module MetronomeSDK
         #
         # Assumes each chunk in stream has `Encoding::BINARY`.
         #
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #