boldsign 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fc2965681164f6e721c5d7a18b9370d1ddfd7570916cde257078b29d3be34d5
-  data.tar.gz: 9210a75137622829403d8b6ae47dfa1f51e3f71462313b12ef076e6b240391a9
+  metadata.gz: cbe0865fb65380ebdee0b2a2ccca3804a3cac90639d93778cc7350ca202294d4
+  data.tar.gz: 93dc1c1e373d29ea4bf07af0622da0662fd5d6d0b044e317ce6e69ceb442743b
 SHA512:
-  metadata.gz: 00ab26917b2ad3ab3af835ec58842b1fa75ba19d61254447466a5eee7b5db388f9c5800ec7807806fd737526772516f43277520ba1005d18539a8e54356f0ee8
-  data.tar.gz: '038338c9aca83500340f85e0d6d2e6247466701739ff3606ae8bf59905f930541514e9e3130ac5296b9ee658085993c601126d84ee5e6527451b4ba1d75df1ab'
+  metadata.gz: 27eb15a5d89fe793cbae44f5e67ebb6b1c52eb71313e2ef677e57b004384f40e552dcebd53525c86c7ddb14d30f3fb278fe9e955aeadb39b5a2d573eb309704a
+  data.tar.gz: 6d11a55a16fb6f553e5136dde756baa972ebed48e0b6a5ebeac50cc3abf27b3d0ca2d2bc47103fe42ea2c3933c3a4a2c9f2d8704ed7ebd546d60c7cee69ca953

data/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] — 2026-05-22
+
+### Changed
+- Request body hash keys are now recursively converted to **camelCase** (not
+  PascalCase). This matches the casing used by the BoldSign OpenAPI/Swagger
+  schema for all request body DTOs, including nested objects like
+  `DocumentSigner` and `FormField`. Callers pass idiomatic snake_case (or
+  camelCase / PascalCase) Ruby keys and the gem emits the casing BoldSign
+  validates against. **Breaking** for callers that relied on the 0.3.0
+  PascalCase output.
+- Multipart file uploads are still keyed `Files` (capital F) for the
+  document send endpoint; only request body field names are camelCased.
+- Multipart `send_document`: single-element arrays for both `signers:` and
+  `files:` are now unwrapped before encoding. BoldSign's POST
+  `/v1/document/send` rejects `signers=[{...}]` (JSON-array string) and
+  `Files[]=…` (Faraday's automatic array-bracket form). The gem now emits
+  `signers={...}` (single JSON object) and `Files=<file>` (single FilePart)
+  for the one-signer/one-file case. Multi-signer / multi-file uploads are
+  not yet supported via this helper and raise `NotImplementedError`.
+
+### Removed
+- `Boldsign::CaseConvert.pascalize` / `.pascalize_key`. Replaced by
+  `.camelize` / `.camelize_key`.
+
 ## [0.3.0] — 2026-05-22
 
 ### Changed

data/lib/boldsign/case_convert.rb

@@ -1,36 +1,39 @@
 module Boldsign
-  # Converts arbitrary Ruby hash keys (snake_case or camelCase, Symbol or
-  # String) to PascalCase string keys recursively, matching the casing the
-  # BoldSign REST API expects in request bodies. Non-Hash and non-Array values
-  # — including binary IO objects, FilePart instances, scalars, dates, etc. —
-  # pass through untouched.
+  # Converts arbitrary Ruby hash keys (snake_case, camelCase, or PascalCase;
+  # Symbol or String) to camelCase string keys recursively, matching the
+  # casing the BoldSign REST API expects in request bodies. Non-Hash and
+  # non-Array values — including binary IO objects, FilePart instances,
+  # scalars, dates, etc. — pass through untouched.
   module CaseConvert
     module_function
 
-    # Recursively PascalCase every Hash key reachable from `obj`.
+    # Recursively camelCase every Hash key reachable from `obj`.
     # @param obj [Object]
-    # @return [Object] new object with the same shape and PascalCase keys
-    def pascalize(obj)
+    # @return [Object] new object with the same shape and camelCase keys
+    def camelize(obj)
       case obj
       when Hash
-        obj.each_with_object({}) { |(k, v), acc| acc[pascalize_key(k)] = pascalize(v) }
+        obj.each_with_object({}) { |(k, v), acc| acc[camelize_key(k)] = camelize(v) }
       when Array
-        obj.map { |v| pascalize(v) }
+        obj.map { |v| camelize(v) }
       else
         obj
       end
     end
 
     # @param key [String, Symbol]
-    # @return [String] PascalCase string
-    def pascalize_key(key)
+    # @return [String] camelCase string
+    def camelize_key(key)
       str = key.to_s
       return str if str.empty?
 
       if str.include?("_")
-        str.split("_").map { |part| capitalize_word(part) }.join
+        parts = str.split("_").reject(&:empty?)
+        return str if parts.empty?
+
+        ([parts.first.downcase] + parts.drop(1).map { |part| capitalize_word(part) }).join
       else
-        capitalize_word(str)
+        lowercase_first(str)
       end
     end
 
@@ -39,5 +42,11 @@ module Boldsign
 
       str[0].upcase + str[1..]
     end
+
+    def lowercase_first(str)
+      return str if str.empty?
+
+      str[0].downcase + str[1..]
+    end
   end
 end

data/lib/boldsign/client.rb

@@ -125,7 +125,7 @@ module Boldsign
             req.body = body
           else
             req.headers["Content-Type"] = "application/json"
-            req.body = body.is_a?(String) ? body : JSON.generate(CaseConvert.pascalize(body))
+            req.body = body.is_a?(String) ? body : JSON.generate(CaseConvert.camelize(body))
           end
         end
       end

data/lib/boldsign/resources/document.rb

@@ -73,21 +73,36 @@ module Boldsign
 
       private
 
+      # BoldSign's POST /v1/document/send multipart endpoint is fussy about
+      # repeated/array-valued parts. Single signers must be sent as one
+      # multipart part whose value is the signer JSON OBJECT (not a JSON array
+      # containing one object). Files must be sent as a single FilePart value
+      # for one upload; Faraday's automatic `Files[]` bracketing breaks the
+      # request. For the single-signer, single-file flow (the common case) we
+      # unwrap one-element arrays here. Multi-signer / multi-file is not yet
+      # supported via this helper and will raise.
       def multipart_send_body(body, files)
         parts = body.each_with_object({}) do |(key, value), acc|
           next if value.nil?
 
-          pascal_key = Boldsign::CaseConvert.pascalize_key(key)
-          acc[pascal_key] = if scalar?(value)
-                              value.to_s
-                            else
-                              JSON.generate(Boldsign::CaseConvert.pascalize(value))
-                            end
+          camel_key = Boldsign::CaseConvert.camelize_key(key)
+          acc[camel_key] = encode_multipart_value(value)
         end
-        parts["Files"] = Array(files).map { |f| file_part(f) }
+        files_array = Array(files)
+        raise NotImplementedError, "multi-file uploads are not supported yet" if files_array.size > 1
+
+        parts["Files"] = file_part(files_array.first)
         parts
       end
 
+      def encode_multipart_value(value)
+        return value.to_s if scalar?(value)
+        return JSON.generate(Boldsign::CaseConvert.camelize(value)) unless value.is_a?(Array)
+        raise NotImplementedError, "multi-element arrays are not supported in multipart bodies yet" if value.size > 1
+
+        JSON.generate(Boldsign::CaseConvert.camelize(value.first))
+      end
+
       def file_part(file)
         return file if file.is_a?(Faraday::Multipart::FilePart)
 

data/lib/boldsign/version.rb

@@ -1,3 +1,3 @@
 module Boldsign
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boldsign
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Klein