signingflow 0.1.0

data/lib/signingflow/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Signingflow
+  VERSION = "0.1.0"
+  SOURCE = "signingflow-ruby/#{VERSION}"
+end

data/lib/signingflow/webhook.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "json"
+require "openssl"
+
+module Signingflow
+  module Webhook
+    Result = Data.define(:payload, :body_sha256)
+
+    module_function
+
+    def construct_event(payload, signature, secret, previous_secret: nil, previous_signature: nil)
+      body = raw_bytes(payload)
+      raise SignatureVerificationError, "Webhook secret is required." if secret.to_s.empty?
+
+      current = !signature.to_s.empty? && safe_equal?(signature, mac(secret, body))
+      previous = !previous_secret.to_s.empty? && !previous_signature.to_s.empty? &&
+                 safe_equal?(previous_signature, mac(previous_secret, body))
+      raise SignatureVerificationError, "Webhook signature did not match." unless current || previous
+
+      parsed = JSON.parse(body)
+      Result.new(payload: parsed, body_sha256: OpenSSL::Digest::SHA256.hexdigest(body))
+    rescue JSON::ParserError
+      raise InvalidRequestError, "The webhook body is not JSON."
+    end
+
+    def raw_bytes(payload)
+      return payload.b if payload.is_a?(String)
+      raise SignatureVerificationError, "Pass the raw request body."
+    end
+
+    def mac(secret, body)
+      OpenSSL::HMAC.hexdigest("SHA256", secret.to_s, body)
+    end
+
+    def safe_equal?(left, right)
+      a = left.to_s.downcase.b
+      b = right.to_s.downcase.b
+      if a.bytesize != b.bytesize
+        OpenSSL.fixed_length_secure_compare(a, a)
+        return false
+      end
+      OpenSSL.fixed_length_secure_compare(a, b)
+    end
+  end
+end

data/lib/signingflow.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "signingflow/version"
+require_relative "signingflow/errors"
+require_relative "signingflow/allowlist"
+require_relative "signingflow/config"
+require_relative "signingflow/redact"
+require_relative "signingflow/status"
+require_relative "signingflow/path"
+require_relative "signingflow/jail"
+require_relative "signingflow/object"
+require_relative "signingflow/requestor"
+require_relative "signingflow/webhook"
+require_relative "signingflow/resources"
+require_relative "signingflow/client"
+
+module Signingflow
+  def self.construct_event(payload, signature, secret, previous_secret: nil, previous_signature: nil)
+    Webhook.construct_event(payload, signature, secret, previous_secret: previous_secret, previous_signature: previous_signature)
+  end
+
+  def self.signing_secret_of(body)
+    Resources.signing_secret_of(body)
+  end
+end

data/resources/allowlist.json

@@ -0,0 +1,110 @@
+{
+  "catalog": "mcp",
+  "operations": [
+    {
+      "operationId": "StorageService_BatchAddStorage",
+      "http": "POST",
+      "path": "/v1/storages:batchAddStorage",
+      "idempotent": true,
+      "capability": "storage:write"
+    },
+    {
+      "operationId": "StorageService_BatchAcknowledgeUpload",
+      "http": "POST",
+      "path": "/v1/storages:batchAcknowledgeUpload",
+      "idempotent": true,
+      "capability": "storage:write"
+    },
+    {
+      "operationId": "EnvelopeService_AddEnvelope",
+      "http": "POST",
+      "path": "/v1/envelopes:addEnvelope",
+      "idempotent": true,
+      "capability": "envelope:write"
+    },
+    {
+      "operationId": "EnvelopeService_ViewEnvelope",
+      "http": "GET",
+      "path": "/v1/{name_1}:view",
+      "idempotent": false,
+      "capability": "envelope:read"
+    },
+    {
+      "operationId": "EnvelopeService_UpdateEnvelope",
+      "http": "PATCH",
+      "path": "/v1/{envelope.name}",
+      "idempotent": false,
+      "capability": "envelope:write"
+    },
+    {
+      "operationId": "EnvelopeService_SendEnvelope",
+      "http": "POST",
+      "path": "/v1/{name}:send",
+      "idempotent": true,
+      "capability": "envelope:send"
+    },
+    {
+      "operationId": "EnvelopeService_ListEnvelopes",
+      "http": "GET",
+      "path": "/v1/{parent}",
+      "idempotent": false,
+      "capability": "envelope:read"
+    },
+    {
+      "operationId": "EnvelopeService_RemindEnvelopeSigners",
+      "http": "POST",
+      "path": "/v1/{name}:remind",
+      "idempotent": false,
+      "capability": "envelope:send"
+    },
+    {
+      "operationId": "EnvelopeService_DownloadEnvelope",
+      "http": "GET",
+      "path": "/v1/{name}:download",
+      "idempotent": false,
+      "capability": "envelope:read"
+    },
+    {
+      "operationId": "TemplateService_UseTemplate",
+      "http": "POST",
+      "path": "/v1/{name}:use",
+      "idempotent": true,
+      "capability": "template:write"
+    },
+    {
+      "operationId": "WebhookUrlService_AddWebhookUrl",
+      "http": "POST",
+      "path": "/v1/webhookUrls:add",
+      "idempotent": true,
+      "capability": "webhook:write"
+    },
+    {
+      "operationId": "WebhookUrlService_ViewWebhookUrl",
+      "http": "GET",
+      "path": "/v1/{name}:view",
+      "idempotent": false,
+      "capability": "webhook:read"
+    },
+    {
+      "operationId": "WebhookUrlService_TestWebhookUrl",
+      "http": "POST",
+      "path": "/v1/{name}:test",
+      "idempotent": false,
+      "capability": "webhook:write"
+    },
+    {
+      "operationId": "WebhookService_ListWebhooks",
+      "http": "GET",
+      "path": "/v1/{parent}",
+      "idempotent": false,
+      "capability": "webhook:read"
+    },
+    {
+      "operationId": "WebhookService_ViewWebhook",
+      "http": "GET",
+      "path": "/v1/{name}:view",
+      "idempotent": false,
+      "capability": "webhook:read"
+    }
+  ]
+}

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: signingflow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Signingflow
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+description: Send a document, read envelope status, and verify webhook signatures
+  with the Signingflow API.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/signingflow.rb
+- lib/signingflow/allowlist.rb
+- lib/signingflow/client.rb
+- lib/signingflow/config.rb
+- lib/signingflow/errors.rb
+- lib/signingflow/jail.rb
+- lib/signingflow/object.rb
+- lib/signingflow/path.rb
+- lib/signingflow/redact.rb
+- lib/signingflow/requestor.rb
+- lib/signingflow/resources.rb
+- lib/signingflow/status.rb
+- lib/signingflow/version.rb
+- lib/signingflow/webhook.rb
+- resources/allowlist.json
+homepage: https://github.com/Signingflow/signingflow-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Signingflow/signingflow-ruby
+  source_code_uri: https://github.com/Signingflow/signingflow-ruby
+  changelog_uri: https://github.com/Signingflow/signingflow-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Official Ruby SDK for the Signingflow API.
+test_files: []