boldsign 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a4d128418d45a484979b044ce83a9e868ef1a142145962ec0580b0f34f4e20
-  data.tar.gz: 4ee136cc02d3020b4beb1e70d614929de07f0f64e7965d8e0742a3e74cb0b893
+  metadata.gz: 9fc2965681164f6e721c5d7a18b9370d1ddfd7570916cde257078b29d3be34d5
+  data.tar.gz: 9210a75137622829403d8b6ae47dfa1f51e3f71462313b12ef076e6b240391a9
 SHA512:
-  metadata.gz: 486cb527ac17cef2ddcf9505a5a2bfe59b3736ee75d9e9b8778344c16a8b6c0e5795d17f5fa7d739fb87f6dc70e1e353fea13929e4303ab8abf1c08adf66e792
-  data.tar.gz: 79edff344004bd59f868a44b6812c1c16bfa922823d0a16eaf28be54f970714b75c16d19be411e6ea175d37b4de8e7ab7bcc30b75da592ade64c49a7afbd9a12
+  metadata.gz: 00ab26917b2ad3ab3af835ec58842b1fa75ba19d61254447466a5eee7b5db388f9c5800ec7807806fd737526772516f43277520ba1005d18539a8e54356f0ee8
+  data.tar.gz: '038338c9aca83500340f85e0d6d2e6247466701739ff3606ae8bf59905f930541514e9e3130ac5296b9ee658085993c601126d84ee5e6527451b4ba1d75df1ab'

data/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] — 2026-05-22
+
+### Changed
+- Request bodies (JSON and multipart) now have their Hash keys recursively
+  converted to PascalCase before being sent to BoldSign. Callers can pass
+  idiomatic snake_case (or camelCase) Ruby symbols/strings and the gem will
+  emit the casing the API expects. Already-PascalCase keys pass through
+  unchanged. Non-Hash/Array values (including IO objects and
+  `Faraday::Multipart::FilePart` instances) are not touched.
+
+### Added
+- `Boldsign::CaseConvert` module with `pascalize` / `pascalize_key` helpers
+  for callers that need to PascalCase keys outside of the HTTP path.
+
+## [0.2.0] — 2026-05-22
+
+### Added
+- `Boldsign::Resources::Document#send_document` now supports multipart file
+  uploads via a `files:` keyword. Pass an array of `{io:, filename:,
+  content_type:}` hashes (or `Faraday::Multipart::FilePart` instances) to
+  send PDFs (or other supported file types) for signature. When `files:` is
+  omitted the request is sent as JSON, preserving the prior behavior.
+
 ## [0.1.0] — 2026-05-22
 
 ### Added

data/lib/boldsign/case_convert.rb

@@ -0,0 +1,43 @@
+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.
+  module CaseConvert
+    module_function
+
+    # Recursively PascalCase every Hash key reachable from `obj`.
+    # @param obj [Object]
+    # @return [Object] new object with the same shape and PascalCase keys
+    def pascalize(obj)
+      case obj
+      when Hash
+        obj.each_with_object({}) { |(k, v), acc| acc[pascalize_key(k)] = pascalize(v) }
+      when Array
+        obj.map { |v| pascalize(v) }
+      else
+        obj
+      end
+    end
+
+    # @param key [String, Symbol]
+    # @return [String] PascalCase string
+    def pascalize_key(key)
+      str = key.to_s
+      return str if str.empty?
+
+      if str.include?("_")
+        str.split("_").map { |part| capitalize_word(part) }.join
+      else
+        capitalize_word(str)
+      end
+    end
+
+    def capitalize_word(str)
+      return str if str.empty?
+
+      str[0].upcase + 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(body)
+            req.body = body.is_a?(String) ? body : JSON.generate(CaseConvert.pascalize(body))
           end
         end
       end

data/lib/boldsign/resources/document.rb

@@ -4,11 +4,17 @@ module Boldsign
     # sending, listing, downloading, editing, reminding, authenticating, tagging,
     # and embedded signing flows.
     #
-    # @example Send a document
+    # @example Send a document (JSON body)
+    #   client.documents.send_document(
+    #     title: "NDA",
+    #     signers: [{ name: "Jane", emailAddress: "jane@example.com", signerOrder: 1 }]
+    #   )
+    #
+    # @example Send a document with file uploads (multipart)
     #   client.documents.send_document(
     #     title: "NDA",
     #     signers: [{ name: "Jane", emailAddress: "jane@example.com", signerOrder: 1 }],
-    #     files: [...]
+    #     files: [{ io: StringIO.new(pdf_bytes), filename: "nda.pdf", content_type: "application/pdf" }]
     #   )
     #
     # @see https://developers.boldsign.com/documents
@@ -18,7 +24,25 @@ module Boldsign
       def behalf_list(**params); @client.get("/v1/document/behalfList", params); end
       def properties(document_id); @client.get("/v1/document/properties", documentId: document_id); end
 
-      def send_document(body);  @client.post("/v1/document/send", body: body); end
+      # Send a document for signature.
+      #
+      # Pass `files:` to upload one or more PDFs (or other supported file types)
+      # via multipart/form-data. Without `files:`, the request is sent as JSON
+      # and BoldSign must already know the file content (e.g. via Base64 in the
+      # body or by referencing an existing template).
+      #
+      # @param files [Array<Hash>, nil] When present, each hash must include
+      #   `:io` and `:filename` and may include `:content_type`. The request
+      #   switches to multipart/form-data and remaining kwargs are serialized
+      #   to multipart string parts (non-scalar values become JSON strings).
+      # @param body [Hash] Top-level BoldSign send-document fields
+      #   (`title:`, `signers:`, `disableEmails:`, `metadata:`, etc.).
+      def send_document(files: nil, **body)
+        return @client.post("/v1/document/send", body: body) if files.nil?
+
+        @client.post("/v1/document/send", body: multipart_send_body(body, files), multipart: true)
+      end
+
       def draft_send(body);     @client.post("/v1/document/draftSend", body: body); end
       def edit(document_id, body); @client.put("/v1/document/edit", body: body, params: { documentId: document_id }); end
       def cancel_editing(document_id); @client.post("/v1/document/cancelEditing", params: { documentId: document_id }); end
@@ -46,6 +70,40 @@ module Boldsign
       def add_authentication(document_id, body);    @client.patch("/v1/document/addAuthentication", body: body, params: { documentId: document_id }); end
 
       def prefill_fields(document_id, body); @client.patch("/v1/document/prefillFields", body: body, params: { documentId: document_id }); end
+
+      private
+
+      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
+        end
+        parts["Files"] = Array(files).map { |f| file_part(f) }
+        parts
+      end
+
+      def file_part(file)
+        return file if file.is_a?(Faraday::Multipart::FilePart)
+
+        unless file.is_a?(Hash)
+          raise ArgumentError, "files entries must be Hash with :io and :filename, or Faraday::Multipart::FilePart"
+        end
+
+        io       = file[:io] || file["io"] or raise ArgumentError, "file part missing :io"
+        filename = file[:filename] || file["filename"] or raise ArgumentError, "file part missing :filename"
+        type     = file[:content_type] || file["content_type"] || "application/octet-stream"
+        Faraday::Multipart::FilePart.new(io, type, filename)
+      end
+
+      def scalar?(value)
+        value.is_a?(String) || value.is_a?(Numeric) || value == true || value == false
+      end
     end
   end
 end

data/lib/boldsign/version.rb

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

data/lib/boldsign.rb

@@ -4,6 +4,7 @@ require "json"
 
 require_relative "boldsign/version"
 require_relative "boldsign/error"
+require_relative "boldsign/case_convert"
 require_relative "boldsign/client"
 require_relative "boldsign/resource"
 require_relative "boldsign/resources/brand"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boldsign
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - James Klein
@@ -92,6 +92,7 @@ files:
 - README.md
 - boldsign.gemspec
 - lib/boldsign.rb
+- lib/boldsign/case_convert.rb
 - lib/boldsign/client.rb
 - lib/boldsign/error.rb
 - lib/boldsign/resource.rb