RubyGems - anvil-ruby - Versions diffs - 0.1.0 - Mend

anvil-ruby 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

checksums.yaml +7 -0
data/AGENTS.md +123 -0
data/API_COVERAGE.md +294 -0
data/CHANGELOG.md +34 -0
data/CLAUDE_README.md +98 -0
data/GITHUB_ACTIONS_QUICKREF.md +174 -0
data/Gemfile.lock +112 -0
data/Gemfile.minimal +9 -0
data/LICENSE +21 -0
data/PROJECT_CONTEXT.md +196 -0
data/README.md +445 -0
data/anvil-ruby.gemspec +66 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/create_signature_direct.rb +142 -0
data/create_signature_packet.rb +232 -0
data/debug_env.rb +28 -0
data/examples/create_signature.rb +194 -0
data/examples/fill_pdf.rb +89 -0
data/examples/generate_pdf.rb +347 -0
data/examples/verify_webhook.rb +281 -0
data/lib/anvil/client.rb +216 -0
data/lib/anvil/configuration.rb +87 -0
data/lib/anvil/env_loader.rb +30 -0
data/lib/anvil/errors.rb +95 -0
data/lib/anvil/rate_limiter.rb +66 -0
data/lib/anvil/resources/base.rb +100 -0
data/lib/anvil/resources/pdf.rb +171 -0
data/lib/anvil/resources/signature.rb +517 -0
data/lib/anvil/resources/webform.rb +154 -0
data/lib/anvil/resources/webhook.rb +201 -0
data/lib/anvil/resources/workflow.rb +169 -0
data/lib/anvil/response.rb +98 -0
data/lib/anvil/version.rb +5 -0
data/lib/anvil.rb +88 -0
data/quickstart_signature.rb +220 -0
data/test_api_connection.rb +143 -0
data/test_etch_signature.rb +230 -0
data/test_gem.rb +72 -0
data/test_signature.rb +281 -0
data/test_signature_with_template.rb +112 -0
metadata +247 -0

data/examples/generate_pdf.rb ADDED Viewed

@@ -0,0 +1,347 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# Add lib to the load path if running directly
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'anvil'
+require 'anvil/env_loader'
+# Load .env file if it exists
+Anvil::EnvLoader.load(File.expand_path('../.env', __dir__))
+# Example: Generate PDFs from HTML or Markdown
+#
+# This example shows how to generate PDFs from HTML/CSS or Markdown content
+# Configure Anvil (will use ANVIL_API_KEY from .env)
+Anvil.configure do |config|
+  config.api_key = ENV.fetch('ANVIL_API_KEY', nil)
+  config.environment = :development
+end
+# Example 1: Generate PDF from HTML
+def generate_html_invoice
+  puts "\n📄 Generating invoice from HTML..."
+  html = <<~HTML
+    <!DOCTYPE html>
+    <html>
+    <head>
+      <title>Invoice</title>
+    </head>
+    <body>
+      <div class="invoice-header">
+        <h1>INVOICE</h1>
+        <div class="invoice-number">#INV-2024-001</div>
+        <div class="invoice-date">Date: #{Date.today.strftime('%B %d, %Y')}</div>
+      </div>
+      <div class="company-info">
+        <h2>Acme Corporation</h2>
+        <p>123 Business Ave<br>San Francisco, CA 94102<br>Phone: (555) 123-4567</p>
+      </div>
+      <div class="bill-to">
+        <h3>Bill To:</h3>
+        <p>
+          John Doe<br>
+          XYZ Company<br>
+          456 Client Street<br>
+          New York, NY 10001
+        </p>
+      </div>
+      <table class="invoice-items">
+        <thead>
+          <tr>
+            <th>Description</th>
+            <th>Quantity</th>
+            <th>Unit Price</th>
+            <th>Total</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr>
+            <td>Consulting Services</td>
+            <td>40</td>
+            <td>$150.00</td>
+            <td>$6,000.00</td>
+          </tr>
+          <tr>
+            <td>Software License</td>
+            <td>1</td>
+            <td>$2,500.00</td>
+            <td>$2,500.00</td>
+          </tr>
+        </tbody>
+        <tfoot>
+          <tr>
+            <td colspan="3">Subtotal</td>
+            <td>$8,500.00</td>
+          </tr>
+          <tr>
+            <td colspan="3">Tax (10%)</td>
+            <td>$850.00</td>
+          </tr>
+          <tr class="total">
+            <td colspan="3"><strong>Total</strong></td>
+            <td><strong>$9,350.00</strong></td>
+          </tr>
+        </tfoot>
+      </table>
+      <div class="footer">
+        <p>Payment due within 30 days. Thank you for your business!</p>
+      </div>
+    </body>
+    </html>
+  HTML
+  css = <<~CSS
+    body {
+      font-family: 'Helvetica Neue', Arial, sans-serif;
+      color: #333;
+      line-height: 1.6;
+      padding: 20px;
+    }
+    .invoice-header {
+      border-bottom: 2px solid #007bff;
+      padding-bottom: 20px;
+      margin-bottom: 30px;
+    }
+    h1 {
+      color: #007bff;
+      margin: 0;
+      font-size: 36px;
+    }
+    .invoice-number {
+      font-size: 18px;
+      color: #666;
+      margin-top: 10px;
+    }
+    .invoice-date {
+      font-size: 14px;
+      color: #666;
+    }
+    .company-info, .bill-to {
+      margin-bottom: 30px;
+    }
+    h2 {
+      color: #333;
+      font-size: 24px;
+      margin-bottom: 10px;
+    }
+    h3 {
+      color: #555;
+      font-size: 18px;
+      margin-bottom: 10px;
+    }
+    table {
+      width: 100%;
+      border-collapse: collapse;
+      margin: 30px 0;
+    }
+    th {
+      background-color: #007bff;
+      color: white;
+      padding: 12px;
+      text-align: left;
+      font-weight: bold;
+    }
+    td {
+      padding: 12px;
+      border-bottom: 1px solid #ddd;
+    }
+    tfoot td {
+      font-weight: bold;
+      border-top: 2px solid #007bff;
+    }
+    .total td {
+      font-size: 18px;
+      color: #007bff;
+    }
+    .footer {
+      margin-top: 40px;
+      padding-top: 20px;
+      border-top: 1px solid #ddd;
+      text-align: center;
+      color: #666;
+      font-size: 14px;
+    }
+  CSS
+  pdf = Anvil::PDF.generate_from_html(
+    html: html,
+    css: css,
+    title: 'Invoice #INV-2024-001'
+  )
+  filename = "invoice_#{Time.now.to_i}.pdf"
+  pdf.save_as(filename)
+  puts '✅ Invoice PDF generated!'
+  puts "📄 Saved as: #{filename}"
+  puts "📏 Size: #{pdf.size_human}"
+end
+# Example 2: Generate PDF from Markdown
+def generate_markdown_report
+  puts "\n📄 Generating report from Markdown..."
+  markdown_content = [
+    {
+      heading: 'Annual Report 2024',
+      content: <<~MD
+        ## Executive Summary
+        This annual report provides a comprehensive overview of our company's performance
+        and achievements during the fiscal year 2024.
+        ### Key Highlights
+        - Revenue growth of **25%** year-over-year
+        - Expanded operations to **3 new markets**
+        - Launched **5 innovative products**
+        - Increased customer satisfaction to **95%**
+      MD
+    },
+    {
+      heading: 'Financial Performance',
+      content: <<~MD
+        ### Revenue Breakdown
+        | Quarter | Revenue    | Growth |
+        |---------|------------|--------|
+        | Q1 2024 | $2.5M     | +20%   |
+        | Q2 2024 | $2.8M     | +22%   |
+        | Q3 2024 | $3.2M     | +28%   |
+        | Q4 2024 | $3.5M     | +30%   |
+        | **Total** | **$12M** | **+25%** |
+        ### Operating Expenses
+        Our operating expenses remained well-controlled throughout the year:
+        - Personnel: $4.2M
+        - Marketing: $1.8M
+        - R&D: $2.1M
+        - Operations: $1.4M
+      MD
+    },
+    {
+      heading: 'Future Outlook',
+      content: <<~MD
+        ## Strategic Initiatives for 2025
+        1. **Digital Transformation**
+           - Implement AI-driven analytics
+           - Upgrade customer portal
+           - Automate key processes
+        2. **Market Expansion**
+           - Enter European markets
+           - Strengthen presence in Asia
+           - Launch e-commerce platform
+        3. **Product Innovation**
+           - Release next-gen product line
+           - Enhance mobile applications
+           - Develop SaaS offerings
+        ---
+        *This report was prepared by the Executive Team*
+        *Date: #{Date.today.strftime('%B %d, %Y')}*
+      MD
+    }
+  ]
+  pdf = Anvil::PDF.generate(
+    type: :markdown,
+    data: markdown_content,
+    title: 'Annual Report 2024',
+    page: {
+      margin_top: '2in',
+      margin_bottom: '1in',
+      margin_left: '1in',
+      margin_right: '1in'
+    }
+  )
+  filename = "report_#{Time.now.to_i}.pdf"
+  pdf.save_as(filename)
+  puts '✅ Report PDF generated!'
+  puts "📄 Saved as: #{filename}"
+  puts "📏 Size: #{pdf.size_human}"
+end
+# Example 3: Simple markdown generation
+def generate_simple_document
+  puts "\n📄 Generating simple document..."
+  pdf = Anvil::PDF.generate_from_markdown(
+    <<~MD
+      # Welcome to Anvil
+      This is a simple example of generating a PDF from markdown.
+      ## Features
+      - Easy to use API
+      - Multiple format support
+      - Fast generation
+      - Professional output
+      ## Code Example
+      ```ruby
+      pdf = Anvil::PDF.generate_from_markdown(content)
+      pdf.save_as('output.pdf')
+      ```
+      Thank you for using Anvil!
+    MD
+  )
+  filename = "simple_#{Time.now.to_i}.pdf"
+  pdf.save_as(filename)
+  puts '✅ Simple PDF generated!'
+  puts "📄 Saved as: #{filename}"
+end
+# Run examples
+begin
+  puts '=' * 50
+  puts 'Anvil PDF Generation Examples'
+  puts '=' * 50
+  generate_html_invoice
+  generate_markdown_report
+  generate_simple_document
+  puts "\n✅ All examples completed successfully!"
+rescue Anvil::AuthenticationError => e
+  puts "❌ Authentication failed: #{e.message}"
+  puts 'Please set your ANVIL_API_KEY environment variable'
+rescue Anvil::Error => e
+  puts "❌ Anvil error: #{e.message}"
+rescue StandardError => e
+  puts "❌ Unexpected error: #{e.message}"
+  puts e.backtrace.first(5)
+end

data/examples/verify_webhook.rb ADDED Viewed

@@ -0,0 +1,281 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'bundler/setup'
+require 'anvil'
+require 'webrick'
+require 'json'
+# Example: Webhook verification and handling
+#
+# This example shows how to:
+# 1. Set up a webhook endpoint
+# 2. Verify webhook authenticity
+# 3. Handle different webhook events
+# 4. Process webhook data
+# Configure Anvil with webhook token
+Anvil.configure do |config|
+  config.api_key = ENV.fetch('ANVIL_API_KEY', nil)
+  config.webhook_token = ENV['ANVIL_WEBHOOK_TOKEN'] || 'your_webhook_token_here'
+  config.environment = :development
+end
+# Example webhook handler class
+class WebhookHandler
+  def handle(webhook)
+    puts "\n📨 Received webhook:"
+    puts "   Action: #{webhook.action}"
+    puts "   Timestamp: #{webhook.timestamp}"
+    # Handle different webhook types
+    case webhook.action
+    when 'signerComplete'
+      handle_signer_complete(webhook)
+    when 'signerUpdateStatus'
+      handle_signer_status_update(webhook)
+    when 'etchPacketComplete'
+      handle_packet_complete(webhook)
+    when 'weldCreate'
+      handle_workflow_created(webhook)
+    when 'weldComplete'
+      handle_workflow_complete(webhook)
+    when 'forgeComplete'
+      handle_webform_complete(webhook)
+    when 'documentGroupCreate'
+      handle_document_group_created(webhook)
+    when 'webhookTest'
+      handle_test_webhook(webhook)
+    else
+      puts "   ⚠️  Unknown webhook action: #{webhook.action}"
+    end
+  end
+  private
+  def handle_signer_complete(webhook)
+    puts '✅ Signer completed!'
+    puts "   Signer: #{webhook.signer_name} (#{webhook.signer_email})"
+    puts "   Signer ID: #{webhook.signer_eid}"
+    puts "   Packet ID: #{webhook.packet_eid}"
+    # In a real app, you might:
+    # - Update database records
+    # - Send notification emails
+    # - Trigger next workflow step
+  end
+  def handle_signer_status_update(webhook)
+    puts '📊 Signer status updated'
+    puts "   Signer: #{webhook.signer_name}"
+    puts "   New status: #{webhook.signer_status}"
+    case webhook.signer_status
+    when 'viewed'
+      puts '   👀 Signer has viewed the document'
+    when 'signed'
+      puts '   ✍️  Signer has signed'
+    end
+  end
+  def handle_packet_complete(webhook)
+    puts '🎉 Signature packet complete!'
+    puts "   Packet ID: #{webhook.packet_eid}"
+    # All signatures collected - download final documents
+    # packet = Anvil::Signature.find(webhook.packet_eid)
+    # download_signed_documents(packet)
+  end
+  def handle_workflow_created(webhook)
+    puts '🔧 Workflow created'
+    puts "   Workflow ID: #{webhook.workflow_eid}"
+  end
+  def handle_workflow_complete(webhook)
+    puts '✅ Workflow complete!'
+    puts "   Workflow ID: #{webhook.workflow_eid}"
+  end
+  def handle_webform_complete(webhook)
+    puts '📝 Webform completed'
+    puts "   Webform ID: #{webhook.webform_eid}"
+  end
+  def handle_document_group_created(webhook)
+    puts '📄 Document group created'
+    data = webhook.data
+    puts "   Group ID: #{data[:documentGroupEid]}" if data[:documentGroupEid]
+  end
+  def handle_test_webhook(_webhook)
+    puts '🧪 Test webhook received!'
+    puts '   Your webhook endpoint is working correctly'
+  end
+end
+# Example: Simple webhook server for testing
+class WebhookServer
+  def initialize(port: 4567)
+    @port = port
+    @handler = WebhookHandler.new
+  end
+  def start
+    server = WEBrick::HTTPServer.new(Port: @port)
+    # Mount webhook endpoint
+    server.mount_proc '/webhooks/anvil' do |req, res|
+      # Parse the webhook
+      webhook = Anvil::Webhook.new(
+        payload: req.body,
+        token: req.query['token'] || req.header['x-anvil-token']
+      )
+      # Verify the webhook
+      if webhook.valid?
+        puts '✅ Webhook verified successfully'
+        # Handle encrypted data if present
+        if webhook.encrypted?
+          puts '🔐 Webhook data is encrypted'
+          # To decrypt, you need your RSA private key:
+          # decrypted_data = webhook.decrypt('/path/to/private_key.pem')
+        end
+        # Process the webhook
+        @handler.handle(webhook)
+        # Return success response
+        res.status = 204  # No Content
+      else
+        puts '❌ Invalid webhook token!'
+        res.status = 401  # Unauthorized
+        res.body = 'Invalid token'
+      end
+    rescue Anvil::WebhookError => e
+      puts "❌ Webhook error: #{e.message}"
+      res.status = 400
+      res.body = e.message
+    rescue StandardError => e
+      puts "❌ Unexpected error: #{e.message}"
+      res.status = 500
+      res.body = 'Internal server error'
+    end
+    # Test endpoint
+    server.mount_proc '/test' do |_req, res|
+      res.body = 'Webhook server is running!'
+    end
+    puts "🚀 Webhook server running on http://localhost:#{@port}"
+    puts "📍 Webhook endpoint: http://localhost:#{@port}/webhooks/anvil"
+    puts '   Configure this URL in your Anvil account settings'
+    puts "\nPress Ctrl+C to stop the server"
+    trap('INT') { server.shutdown }
+    server.start
+  end
+end
+# Example: Rails controller for webhooks
+def rails_controller_example
+  puts <<~RUBY
+    # app/controllers/anvil_webhooks_controller.rb
+    class AnvilWebhooksController < ApplicationController
+      skip_before_action :verify_authenticity_token
+      def create
+        webhook = Anvil::Webhook.new(
+          payload: request.body.read,
+          token: params[:token]
+        )
+        if webhook.valid?
+          process_webhook(webhook)
+          head :no_content
+        else
+          Rails.logger.error "Invalid Anvil webhook token"
+          head :unauthorized
+        end
+      rescue Anvil::WebhookError => e
+        Rails.logger.error "Webhook error: \#{e.message}"
+        head :bad_request
+      end
+      private
+      def process_webhook(webhook)
+        # Process webhook based on action
+        case webhook.action
+        when 'signerComplete'
+          SignerCompleteJob.perform_later(webhook.data)
+        when 'etchPacketComplete'
+          PacketCompleteJob.perform_later(webhook.data)
+        # ... handle other webhook types
+        end
+      end
+    end
+    # config/routes.rb
+    post 'webhooks/anvil', to: 'anvil_webhooks#create'
+  RUBY
+end
+# Example: Create a test webhook
+def create_test_webhook
+  puts "\n🧪 Creating test webhook..."
+  webhook = Anvil::Webhook.create_test(
+    action: 'signerComplete',
+    data: {
+      signerEid: 'test_signer_123',
+      packetEid: 'test_packet_456',
+      signerName: 'Test User',
+      signerEmail: 'test@example.com'
+    }
+  )
+  puts 'Test webhook created:'
+  puts "   Action: #{webhook.action}"
+  puts "   Valid: #{webhook.valid?}"
+  webhook
+end
+# Run the example
+if __FILE__ == $PROGRAM_NAME
+  puts '=' * 50
+  puts 'Anvil Webhook Verification Example'
+  puts '=' * 50
+  choice = ARGV[0]
+  case choice
+  when 'server'
+    # Start webhook server
+    server = WebhookServer.new(port: 4567)
+    server.start
+  when 'test'
+    # Create and verify a test webhook
+    webhook = create_test_webhook
+    handler = WebhookHandler.new
+    handler.handle(webhook)
+  when 'rails'
+    # Show Rails controller example
+    puts "\n📱 Rails Controller Example:"
+    puts '=' * 40
+    rails_controller_example
+  else
+    puts "\nUsage:"
+    puts "  ruby #{__FILE__} server  # Start webhook test server"
+    puts "  ruby #{__FILE__} test    # Create and handle test webhook"
+    puts "  ruby #{__FILE__} rails   # Show Rails controller example"
+    puts "\nEnvironment variables:"
+    puts '  ANVIL_API_KEY      - Your Anvil API key'
+    puts '  ANVIL_WEBHOOK_TOKEN - Your webhook verification token'
+  end
+end