clicksign_ruby 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30813ecb47b7a24e1e4c1ababeee56fb2fcecb969f556671458e4a54e9e06724
+  data.tar.gz: 3ae5ce33b7069e04f12bf88cfcb7d0bbb840db23726102c86d33f6160551c88f
+SHA512:
+  metadata.gz: 3ce8d9abd48c71f809d7681ff1c8fb8a5398e6f5cca3437aa70f8c78ea02731815daf0c001b3a0f6f826d7740c2a1a537ae4fa3e506aa4f9b7d4283913f2cb24
+  data.tar.gz: e7b3ce4ee3ecea33adcfe2bb687c2ded600769df4fc61068b7e6f994ab835cac9cb37081d5a22ebade042400190d140f8745def49542bcd80383e6a8bae42755

data/.gitignore

@@ -0,0 +1,4 @@
+.ruby-version
+*.gem
+Gemfile.lock
+tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Clicksign
+
+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,73 @@
+# Clicksign Ruby Client
+
+Fork of deprecated clicksign gem in Ruby.
+Works on documentation version 2.0: Envelope
+
+## Installation
+
+With Bundler:
+
+```
+gem 'clicksign', github: 'davi-canuto/clicksign-ruby', branch: 'main'
+```
+
+## Usage
+
+### Setting up the client
+
+You must provide a valid `token` in order to use the library.
+
+The required `token` is provided by the Clicksign support team.
+
+```ruby
+require 'clicksign'
+
+Clicksign.configure do |config|
+  config.token = ENV['CLICKSIGN_TOKEN']
+  config.environment = 'production'
+end
+```
+
+### Create a envelope
+
+You'll be able to make requests to the Clicksign API right after the initial setup. The first step would be createa a envelope that will contain the rest of the documents, signers and e.t.c.
+
+For knowledge the permit parameters, visit [here](https://developers.clicksign.com/docs/criar-envelope)
+```ruby
+envelope = Clicksign::Envelope.create({
+  name: ''
+})
+```
+
+This request will return a id, save this key for later use
+```ruby
+@envelope_id = envelope["data"]["id"]
+```
+
+### Adding document
+
+To upload a new document into Clicksign envelope you can use the following snippet:
+
+```ruby
+document = Clicksign::Document.new(@envelope_id).add({
+  filename: '',
+  base64_content: "data:#{}\;base64,#{}"
+})
+```
+
+### Adding signers
+
+To add a new signer into Clicksign envelope you can use the following snippet:
+
+For knowledge the permit parameters, visit [here](https://developers.clicksign.com/docs/adicionar-novo-signat%C3%A1rio-no-envelope)
+```ruby
+signer = Clicksign::Signer.new(@envelope_id).add({})
+```
+
+### Webhooks
+
+To works with webhooks i'm also recomendely to use a [nexoos gem](https://github.com/NexoosBR/clicksign-webhooks)
+Provided me with everything I needed.
+
+This gem also created for a necessit implement integration with clicksign, and i`ve found the [deprecated documentation](https://github.com/clicksign/clicksign-ruby), forked it and works to my specifications.
+## CONTRIBUTE

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'clicksign'
+  ARGV.clear
+  IRB.start
+end
+
+task :default => :spec
+task :test => :spec

data/clicksign.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'clicksign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clicksign_ruby'
+  spec.version       = Clicksign::VERSION
+  spec.authors       = ['davi-canuto']
+  spec.email         = ['davicanutogregorio@gmail.com']
+  spec.description   = %q{Ruby library to interact with Clicksign}
+  spec.summary       = %q{Ruby library to interact with Clicksign}
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_dependency 'rest-client', '>= 1.8'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

data/examples/simple_api.rb

@@ -0,0 +1,29 @@
+require 'clicksign'
+
+Clicksign.configure do |config|
+  config.token = ENV['CLICKSIGN_TOKEN']
+  config.environment = :sandbox
+end
+
+# Create a envelope
+envelope = Clicksign::Envelope.create({ name: 'test envelope' })
+
+# Get Key identification
+envelope_id = envelope['data']['id']
+
+# Add a new document to signature
+document = Clicksign::Document.new(envelope_id).create(
+  { 
+    filename: 'samplename.jpg', 
+    base64_content: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJwAAACACAYAAAD+rACtAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAFeSURBVHhe7dIxAQAgDMCwgX/NwIOGXslTA13n3DsQ2b+QMBwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcMRmnltlQT6RDW/pgAAAABJRU5ErkJggg==", 
+  }
+)
+
+# Add a new signer to signature
+signer = Clicksign::Signer.new(envelope_id).create(
+  { 
+    name: 'segundin',
+    email: 'mudin@mail.com',
+    birthdate: '1990-01-01'
+  }
+)

data/lib/clicksign/base.rb

@@ -0,0 +1,39 @@
+module Clicksign
+  class Base
+    def self.headers
+      {
+        accept: 'application/vnd.api+json',
+        content_type: 'application/vnd.api+json',
+        authorization: Clicksign.token
+      }
+    end
+
+    def self.request(method, *params)
+      params.last.merge!(headers)
+      parse RestClient.public_send(method, *params)
+    end
+
+    def self.api_url(*path)
+      ([Clicksign.endpoint] + path).join("/")
+    end
+
+    def self.parse(response)
+      response = {} if response.empty?
+      JSON[response]
+    end
+
+    def self.build_data(params, model_name, id='')
+      data = {
+        data: {
+          attributes: params,
+          type: model_name
+        }
+      }
+      unless id.empty?
+        data[:data][:id] = id
+      end
+
+      data.to_json
+    end
+  end
+end

data/lib/clicksign/document.rb

@@ -0,0 +1,20 @@
+module Clicksign
+  class Document < Base
+    def self.model_name
+      'documents'
+    end
+
+    attr_accessor :envelope_key
+
+    def initialize(envelope_key)
+      @envelope_key = envelope_key
+    end
+
+    def add params={}
+      Base.request :post,
+        Base.api_url('envelopes', @envelope_key, Document.model_name),
+        Base.build_data(params, Document.model_name),
+        {}
+    end
+  end
+end

data/lib/clicksign/envelope.rb

@@ -0,0 +1,37 @@
+module Clicksign
+  class Envelope < Base
+    def self.model_name
+      'envelopes'
+    end
+
+    def self.create params={}
+      request :post,
+        api_url(model_name),
+        build_data(params, model_name),
+        {}
+    end
+
+    def self.find key
+      request :get,
+        api_url(model_name, key),
+        {}
+    end
+
+    def self.update params={}, key
+      unless params[:data]&[:id]
+        raise 'must_send_envelope_id_inside_body'
+      end
+
+      request :patch,
+        api_url(model_name, key),
+        build_data(params, model_name, key ),
+        {}
+    end
+
+    def self.remove key
+      request :delete,
+        api_url(model_name, key),
+        {}
+    end
+  end
+end

data/lib/clicksign/signer.rb

@@ -0,0 +1,20 @@
+module Clicksign
+  class Signer < Base
+    def self.model_name
+      'signers'
+    end
+
+    attr_accessor :envelope_key
+
+    def initialize(envelope_key)
+      @envelope_key = envelope_key
+    end
+
+    def add params={}
+      Base.request :post,
+        Base.api_url('envelopes', @envelope_key, Signer.model_name),
+        Base.build_data(params, Signer.model_name),
+        {}
+    end
+  end
+end

data/lib/clicksign/version.rb

@@ -0,0 +1,3 @@
+module Clicksign
+  VERSION = '1.0'
+end

data/lib/clicksign.rb

@@ -0,0 +1,29 @@
+require 'rest-client'
+require 'json/ext'
+
+require 'clicksign/version'
+require 'clicksign/base'
+require 'clicksign/envelope'
+require 'clicksign/document'
+require 'clicksign/signer'
+
+module Clicksign
+  class << self
+    attr_accessor :endpoint, :token, :api_version, :environment, :host
+  end
+
+  def self.configure(&block)
+    self.api_version = 'v3'
+    self.environment = :sandbox
+
+    if self.environment.to_sym == :production
+      self.host = "https://app.clicksign.com"
+    else
+      self.host = "https://sandbox.clicksign.com"
+    end
+
+    self.endpoint = self.host + "/api/#{self.api_version}"
+
+    yield self
+  end
+end

data/spec/clicksign_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Clicksign do
+  describe '.configure' do
+    before do
+      Clicksign.configure do |config|
+        config.token       = 'my_token'
+        config.environment = :sandbox
+      end
+    end
+
+    it 'set config values' do
+      expect(Clicksign.environment).to eq :sandbox
+      expect(Clicksign.endpoint).to eq "https://sandbox.clicksign.com/api/v3"
+      expect(Clicksign.token).to eq 'my_token'
+    end
+  end
+end
+
+describe Clicksign::Envelope do
+  describe '.create' do
+    it 'create envelope with only required parameters' do
+      # was supposed to have tests xD
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.push File.expand_path("../../lib", __FILE__)
+require 'clicksign'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: clicksign_ruby
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- davi-canuto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby library to interact with Clicksign
+email:
+- davicanutogregorio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- clicksign.gemspec
+- examples/simple_api.rb
+- lib/clicksign.rb
+- lib/clicksign/base.rb
+- lib/clicksign/document.rb
+- lib/clicksign/envelope.rb
+- lib/clicksign/signer.rb
+- lib/clicksign/version.rb
+- spec/clicksign_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Ruby library to interact with Clicksign
+test_files:
+- spec/clicksign_spec.rb
+- spec/spec_helper.rb