cin7_core_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c48f34c3de3d21ac9674e0bb133a3b9a16158ae0eb5087fcaafdf8e8543f794
-  data.tar.gz: e452799a7aa9ebf7b988d7146df5f01cc0f23c8be9c8213cda495dff6549653d
+  metadata.gz: 237cda18aeb79904a6fed79dc9deaa53240aff6d45f659d0163f14188af06126
+  data.tar.gz: 3ba7316e959ec28916abb55e3036e0550d68ce626be3c0ac08fc80eda8a8bfb8
 SHA512:
-  metadata.gz: 0acaa3e83cfd47241d741a4fee553505f558ef091ae971e1f1a8753de40e510b89b03ea17bfc1d2aba60932261d1eddbfbbb20f8deb3d962b566261844bfca99
-  data.tar.gz: fbd694cb6d780b6c718540e02ab0ee6f923f2c33b93ffc65243ff6293453c438dc15b20903e3f8027fa1a3aaa4770931fa9995481ae7b623ef9ff22c9b7d8093
+  metadata.gz: caff2995e25a658cd0aaf75513389850a0347a8aa4fc0f38ee3b99015a2e02a9bccd758edecedb4187f06fbd2360bb25ae6ce944a10b1a7fc6fc454f1c02910c
+  data.tar.gz: 932d8ea1d610710377946799c1224e099b3e4d6b5cf6b99d5ac32b01e28d7a07cb7bdd563291246430126f01e07f295dd8a1d70d235708ea8a8ed2f527d0b563

data/CHANGELOG.md

@@ -1,8 +1,11 @@
 # Changelog
 
-## [Unreleased]
+## [0.2.1] - 2026-10-02
 
-### 0.2.0 (release preparation)
+- Keep decompression failures and malformed UTF-8 responses, including invalid decoded JSON strings, inside the sanitized error contract, preserving uncertain-write recovery without retries.
+- Preserve callback identity when another webhook subscription has credentials matching this subscription's URL components; continue filtering secrets throughout free text.
+
+## [0.2.0] - 2026-09-29
 
 - Add explicit sale update/undo, order, invoice, payment, sale manual-journal, standalone journal, tax-rule and webhook operations while preserving existing read methods.
 - Send JSON payloads without rounding amounts or FX rates; distinguish parent sale IDs, document task IDs, payment IDs and webhook IDs.

data/README.md

@@ -9,7 +9,7 @@ Version `0.2.0` adds explicit payment, order, invoice, journal, and webhook oper
 Add the gem to your Gemfile:
 
 ```ruby
-gem "cin7_core_api", github: "PostCo/cin7_core_api", ref: "<reviewed-full-commit-sha>"
+gem "cin7_core_api", "0.2.1"
 ```
 
 Then run:
@@ -20,7 +20,7 @@ bundle install
 
 Ruby 3.3 or newer is required.
 
-The `0.2.0` source is prepared for review; this README does not assert that it has been published. Pin a reviewed source commit until a release is available.
+Version `0.2.1` adds response-decoding safety and callback-identity fixes. Published `0.2.0` remains unchanged. Check RubyGems for publication availability; to evaluate a reviewed source before publication, pin its full commit SHA from this repository.
 
 ## Authentication
 
@@ -253,7 +253,23 @@ mise exec -- bundle exec standardrb --cache false $(git ls-files '*.rb' '*.gemsp
 mise exec -- bundle exec rake build
 ```
 
-Stage intended new source/spec files before using the tracked-file lint command. CI tests Ruby 3.3 and 3.4. Specs use Faraday's test adapter and do not verify live accounting behavior. Inspect the built gem's file list before release: the gemspec packages only `lib/**/*.rb`, README, changelog and license. Preserve untracked research files. Publication and push require a separate release decision; RubyGems MFA remains required.
+Stage intended new source/spec files before using the tracked-file lint command. CI tests Ruby 3.3 and 3.4. Specs use Faraday's test adapter and do not verify live accounting behavior. Inspect the built gem's file list before release: the gemspec packages only `lib/**/*.rb`, README, changelog and license. Preserve untracked research files.
+
+## Releasing
+
+Publishing a GitHub release triggers `.github/workflows/release.yml`. It requires the tagged commit to be part of `main`, verifies the tag matches `v<VERSION>`, runs tests and lint, builds the gem, and publishes that exact version to RubyGems. Draft releases and ordinary branch pushes do not publish gems.
+
+One-time setup: in the `cin7_core_api` gem's RubyGems **Trusted publishers** settings, register repository owner `PostCo`, repository `cin7_core_api`, workflow filename `release.yml`, and environment `release`. Use the same `release` environment in GitHub. [RubyGems Trusted Publishing](https://guides.rubygems.org/trusted-publishing/) uses GitHub OIDC, so no long-lived API key or interactive MFA code is needed in CI. Signing in locally does not configure this trust relationship.
+
+For each new version:
+
+1. Update `lib/cin7_core_api/version.rb` and `CHANGELOG.md`, review the PR, and merge it into `main`.
+2. Create and publish a GitHub release at that merged commit, with a tag such as `v0.2.1` matching the gem version.
+3. Check the **Publish gem** workflow and verify the version is available on RubyGems before updating application dependencies.
+
+The manually published `0.2.0` already exists. Do not republish it; this workflow is for subsequent versions. A failed attempt to publish an existing version does not replace that version. If a workflow is rerun after a partial success, check RubyGems first.
+
+The manual fallback is `bundle exec rake release` from a clean, merged checkout. Tests and Standard run before Bundler's tag/push/publish steps. The main-branch ancestry guard belongs to the GitHub workflow; the manual command does not enforce it. Manual publishing still uses your RubyGems credentials and applicable MFA.
 
 ## CIN7 references
 

data/lib/cin7_core_api/connection.rb

@@ -2,6 +2,7 @@
 
 require "faraday"
 require "json"
+require "zlib"
 
 module Cin7CoreAPI
   class Connection
@@ -61,12 +62,10 @@ module Cin7CoreAPI
       context = {request_method: method, request_path: redactor.filter(path.split("?").first)}
       write = method != :get
 
-      raw_response = @http.run_request(method, path, body, nil) do |request|
-        request.params.update(params)
-      end
+      raw_response = dispatch(method, path, body, params, context, write: write)
       parsed_body, valid_json = parse_body(raw_response.body)
       values = {"headers" => normalized_headers(raw_response.headers), "body" => parsed_body}
-      sanitized = redactor.with_sensitive_values(values).filter(values)
+      sanitized = redactor.with_sensitive_values(values).filter(values, callback_redactor: redactor)
       response = Response.new(status: raw_response.status, headers: sanitized.fetch("headers"), body: sanitized.fetch("body"))
 
       raise_for_status!(response, context, write: write)
@@ -75,7 +74,13 @@ module Cin7CoreAPI
       end
 
       response
-    rescue Faraday::Error => error
+    end
+
+    def dispatch(method, path, body, params, context, write:)
+      @http.run_request(method, path, body, nil) do |request|
+        request.params.update(params)
+      end
+    rescue Faraday::Error, Zlib::Error => error
       # Faraday exceptions can retain the entire authenticated request in their cause.
       raise TransportError.new("CIN7 Core transport failed (#{error.class})", ambiguous: write, **context), cause: nil
     end
@@ -87,11 +92,32 @@ module Cin7CoreAPI
     def parse_body(body)
       return [nil, true] if body.nil? || body.empty?
 
-      [JSON.parse(body), true]
+      # JSON is UTF-8 even when the adapter labels its bytes as binary. Reject
+      # malformed success bodies, but keep rejection details safe to redact.
+      body = body.dup.force_encoding(Encoding::UTF_8)
+      return [body.scrub, false] unless body.valid_encoding?
+
+      parsed = JSON.parse(body)
+      # Some JSON parsers accept lone low-surrogate escapes and produce invalid
+      # strings. Do not expose or regex-filter partially decoded credentials.
+      valid_utf8?(parsed) ? [parsed, true] : [Redactor::FILTERED, false]
     rescue JSON::ParserError
       [body, false]
     end
 
+    def valid_utf8?(value)
+      case value
+      when Hash
+        value.all? { |key, entry| valid_utf8?(key) && valid_utf8?(entry) }
+      when Array
+        value.all? { |entry| valid_utf8?(entry) }
+      when String
+        value.valid_encoding?
+      else
+        true
+      end
+    end
+
     def raise_for_status!(response, context, write:)
       return if response.success?
 

data/lib/cin7_core_api/redactor.rb

@@ -18,7 +18,7 @@ module Cin7CoreAPI
       self.class.new(@secrets + sensitive_values(value))
     end
 
-    def filter(value)
+    def filter(value, callback_redactor: self)
       case value
       when Hash
         value.each_with_object({}) do |(key, entry), result|
@@ -26,16 +26,18 @@ module Cin7CoreAPI
           result[key.to_s] = if sensitive_key?(key) || external_headers?(key)
             FILTERED
           elsif callback_url?(key) && entry.is_a?(String)
-            filter_url(entry)
+            # Another subscription's credentials may equal this callback's
+            # integration ID or host label. Scope URL filtering to this record.
+            callback_redactor.with_sensitive_values(value).filter_url(entry)
           elsif structured_identifier?(key, entry)
             # Short header values must not corrupt identifiers or schema enums.
             @secrets.include?(entry) ? FILTERED : entry.dup
           else
-            filter(entry)
+            filter(entry, callback_redactor: callback_redactor)
           end
         end
       when Array
-        value.map { |entry| filter(entry) }
+        value.map { |entry| filter(entry, callback_redactor: callback_redactor) }
       when String
         filter_string(value)
       else
@@ -126,6 +128,8 @@ module Cin7CoreAPI
       []
     end
 
+    protected
+
     def filter_url(value)
       return FILTERED if @secrets.include?(value)
 
@@ -145,6 +149,8 @@ module Cin7CoreAPI
       FILTERED
     end
 
+    private
+
     def filter_authority(authority, host)
       _, separator, host_port = authority.rpartition("@")
       filtered_host = filter_url_component(host)

data/lib/cin7_core_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cin7CoreAPI
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cin7_core_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - PostCo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-29 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday