clicksign-webhooks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b563cd44ac9a368bbaf250193e2dbbff62dff5b4aee62c9587a13dfd3befb21e
+  data.tar.gz: adfb39017534f74aeac9244711274c662ff07273d85f496ec12c318cc82a5115
+SHA512:
+  metadata.gz: 4dc440d12165352c1656bf9a01e0716445c8240f66e3060334366087708c189599e8da9f257e1821c83bee7478e58302db38c5a8d3a82e7b5158dbb8cfede6b0
+  data.tar.gz: 0ad6fa752fbdd86c54b186e53852c80f13ff09aab9b937125f186396e03924e105e4ce720022b2bf0c9cd63bed819cde101baf96db263fdf0f481a917178b146

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Francisco Martins
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# Clicksign::Webhooks
+
+To fully understand Clicksign webhooks system, click [here](https://developers.clicksign.com/docs/introducao-a-webhooks)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clicksign-webhooks'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install clicksign-webhooks
+```
+
+## Usage
+
+First, mount this engine on your app.
+
+```ruby
+Rails.application.routes.draw do
+  ...
+  mount Clicksign::Webhooks::Engine => "/clicksign-webhooks"
+  ...
+end
+
+```
+
+Depending on your version of rails, use either `rails routes -g clicksign-webhooks` or `rake routes | grep clicksign-webhooks`, to see the path:
+
+```bash
+$ rake routes | grep clicksign-webhooks
+Routes for Clicksign::Webhooks::Engine:
+ event POST /event(.:format) clicksign/webhooks/events#create
+```
+
+Your rails app able to receive a `POST` at `/clicksign-webhooks/event`.
+
+Then create a initializer using a `Proc` to each possible event:
+
+```ruby
+Clicksign::Webhooks.configure do |config|
+  # You have to setup one Proc for each event
+
+  config.on_upload = ->(event) {
+    # Do something with sent event parameters
+  }
+
+  # ...
+end
+```
+
+The argument `event` is a `Hash`:
+
+```ruby
+  {
+     "event":{
+        "name":"add_signer",
+        "data":{
+           "user":{
+              "email":"...",
+              "name":"..."
+           },
+           "account":{
+              "key":"..."
+           },
+           "signers":[
+              {
+                 "key":"...",
+                 "email":"...",
+                 "created_at":"...",
+                 "sign_as":"witness",
+                 "auths":["email"],
+                 "phone_number":"...",
+                 "phone_number_hash":"..."
+              }
+           ]
+        },
+        "occurred_at":"..."
+     },
+     "document":{...},
+     "signers":[...],
+     "events":[{...}]
+  }
+```
+
+##### Available event callbacks:
+
+- on_upload
+- on_add_signer
+- on_remove_signer
+- on_sign
+- on_close
+- on_auto_close,
+- on_deadline
+- on_cancel
+- on_update_deadline
+- on_update_auto_close
+
+## Contributing
+
+Feel free to contribute. Pull requests are welcome.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Clicksign::Webhooks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/test_app/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/clicksign/webhooks/application_controller.rb

@@ -0,0 +1,6 @@
+module Clicksign
+  module Webhooks
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/controllers/clicksign/webhooks/events_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "clicksign/webhooks/application_controller"
+
+module Clicksign::Webhooks
+  class EventsController < ApplicationController
+    def create
+      Clicksign::Webhooks.send(callback).call(event_params)
+      head 200
+    rescue NoMethodError
+      Rails.logger.warn("Invalid configuration: #{callback}")
+      head 422
+    end
+
+    def event_params
+      params.require(:event).permit!
+    end
+
+    def callback
+      "on_#{event_params[:name]}"
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Clicksign::Webhooks::Engine.routes.draw do
+  resource :event, only: [:create]
+end

data/lib/clicksign/webhooks.rb

@@ -0,0 +1,18 @@
+require "clicksign/webhooks/engine"
+
+module Clicksign
+  module Webhooks
+    EVENTS = [
+      :upload, :add_signer, :remove_signer, :sign, :close, :auto_close,
+      :deadline, :cancel, :update_deadline, :update_auto_close
+    ].map { |event| "on_#{event}" }
+
+    class << self
+      attr_accessor *EVENTS
+
+      def configure
+        yield(self) if block_given?
+      end
+    end
+  end
+end

data/lib/clicksign/webhooks/engine.rb

@@ -0,0 +1,7 @@
+module Clicksign
+  module Webhooks
+    class Engine < ::Rails::Engine
+      isolate_namespace Clicksign::Webhooks
+    end
+  end
+end

data/lib/clicksign/webhooks/version.rb

@@ -0,0 +1,5 @@
+module Clicksign
+  module Webhooks
+    VERSION = '0.0.1'
+  end
+end

data/lib/tasks/clicksign/webhooks_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :clicksign_webhooks do
+#   # Task goes here
+# end

data/spec/requests/event_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe Clicksign::Webhooks::EventsController, type: :request do
+  let(:on_upload) do
+    Proc.new { |event| event }
+  end
+
+  before do
+    Clicksign::Webhooks.configure do |config|
+      config.on_upload = on_upload
+    end
+  end
+
+  it do
+    expect(on_upload).to receive(:call).once
+    post '/clicksign-webhooks/event', params: { event: { name: 'upload' } }
+    expect(response.code).to eq('200')
+  end
+
+  it do
+    expect(on_upload).to_not receive(:call)
+    post '/clicksign-webhooks/event', params: { event: { name: 'invalid' } }
+    expect(response.code).to eq('422')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.expand_path("../test_app/config/environment", __FILE__)
+
+require 'bundler/setup'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require 'rspec/rails'
+require 'clicksign/webhooks'
+
+Dir[
+  File.expand_path('../support/**/*.rb', __FILE__)
+].each { |f| require f }
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/test_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/test_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/test_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/test_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/test_app/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/test_app/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/test_app/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  begin
+    exec "yarnpkg", *ARGV
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/spec/test_app/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/spec/test_app/config/application.rb

@@ -0,0 +1,28 @@
+require_relative 'boot'
+
+# require "rails"
+# Pick the frameworks you want:
+# require "active_model/railtie"
+# require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_view/railtie"
+# require "action_cable/engine"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "clicksign/webhooks"
+
+module TestApp
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end