click_sign_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a911fde98f9fd770c0e7fbbdd6246ab881304f3b
+  data.tar.gz: 7da7d625ccf76ffc543821e941f860ab677fb020
+SHA512:
+  metadata.gz: cd278a56f472c2e0dd7f0144e34953c20f94faef164b9babfaab2684b569cb95a133913453fb04825b1862227b0093e99ab360e4a64d870cf4f78b35b9935f6d
+  data.tar.gz: 650015c9df26a4a2e4b789f84c982f41d25fe3f16745b9d8816c6e89bc3ce0ba2706fae7758b836d6b4666ea65046cd1e583b439064aa602cab393652b4bcd22

data/README.md

@@ -0,0 +1 @@
+# click-sign-rails

data/lib/configuration.rb

@@ -0,0 +1,20 @@
+module ClickSign
+	class Configuration
+		@base_env = "CLICK_SIGN"
+		@url_env = "#{@base_env}_URL"
+		@sandbox_url_env = "#{@base_env}_SANDBOX_URL"
+		@api_version_env = "#{@base_env}_API_VERSION"
+		@access_token_env = "#{@base_env}_ACCESS_TOKEN"
+
+		@access_token = ENV[@access_token_env]
+		@url = ENV[@url_env] || 'https://app.clicksign.com'
+		@sandbox_url = ENV[@sandbox_url_env] || 'https://sandbox.clicksign.com'
+		@api_version = ENV[@api_version_env] || 'v1'
+
+		@sandbox = false
+
+		class << self 
+			attr_accessor :base_env, :url_env, :sandbox_url_env, :api_version_env, :access_token_env, :access_token, :url, :sandbox_url, :api_version, :sandbox
+		end
+	end
+end

data/lib/constants.rb

@@ -0,0 +1,55 @@
+module ClickSign
+	class Constants
+		class Auth
+			SMS = 'sms'
+			EMAIL = 'email'
+			WHATSAPP = 'whatsapp'
+			API = 'api'
+		end
+
+		class Delivery
+			EMAIL = 'email'
+			NONE = 'none'
+		end
+
+		class Locale
+			PT_BR = 'pt-BR'
+			EN_US = 'en-US'
+		end
+
+		class RemindInterval
+			ONE = '1'
+			TWO = '2'
+			THREE = '3'
+			SEVEN = '7'
+			FOURTEEN = '14'
+		end
+
+		class SignAs
+			SIGN = 'sign'
+			APPROVE = 'approve'
+			PARTY = 'party'
+			WITNESS = 'witness'
+			INTERVENING = 'intervening'
+			RECEIPT = 'receipt'
+			ENDORSER = 'endorser'
+			ENDORSEE = 'endorsee'
+			ADMINISTRATOR = 'administrator'
+			GUARANTOR = 'guarantor'
+			TRANSFEROR = 'transferor'
+			TRANSFEREE = 'transferee'
+			CONTRACTEE = 'contractee'
+			CONTRACTOR = 'contractor'
+			JOINT_DEBTOR = 'joint_debtor'
+			ISSUER = 'issuer'
+			MANAGER = 'manager'
+			BUYER = 'buyer'
+			SELLER = 'seller'
+			ATTORNEY = 'attorney'
+			LEGAL_REPRESENTATIVE = 'legal_representative'
+			CO_RESPONSIBLE = 'co_responsible'
+			VALIDATOR = 'validator'
+			RATIFY = 'ratify'
+		end
+	end
+end

data/lib/document.rb

@@ -0,0 +1,153 @@
+module ClickSign
+	class Document
+		require "base64"
+
+		attr_reader :key, :path, :filename, :uploaded_at, :updated_at, :finished_at, :deadline_at, :status, :auto_close, :locale, :metadata, :sequence_enabled, :signable_group, :remind_interval, :raw_data, :original_file_url
+
+		def initialize(args)
+			@raw_data = args
+			@key = args['key'] if args['key'].present?
+			@path = args['path'] if args['path'].present?
+			@filename = args['filename'] if args['filename'].present?
+			@uploaded_at = args['uploaded_at'] if args['uploaded_at'].present?
+			@updated_at = args['updated_at'] if args['updated_at'].present?
+			@finished_at = args['finished_at'] if args['finished_at'].present?
+			@deadline_at = args['deadline_at'] if args['deadline_at'].present?
+			@status = args['status'] if args['status'].present?
+			@auto_close = args['auto_close'] if args['auto_close'].present?
+			@locale = args['locale'] if args['locale'].present?
+			@metadata = args['metadata'] if args['metadata'].present?
+			@sequence_enabled = args['sequence_enabled'] if args['sequence_enabled'].present?
+			@signable_group = args['signable_group'] if args['signable_group'].present?
+			@remind_interval = args['remind_interval'] if args['remind_interval'].present?
+			@original_file_url = args['downloads']['original_file_url'] if args['downloads'].present?
+		end
+
+		# <CLASS METHODS>
+		def self.create(**args)
+			payload = build_payload(args)
+			response = ClickSign::Service.post(
+			 	url: 'documents',
+			 	payload: payload
+		 	)
+      if response.created?
+      	return ClickSign::Document.new(response.body['document'])
+      end
+		end
+
+		def self.find document_key: nil
+			response = ClickSign::Service.get(
+				url: ['documents', document_key]
+			)
+			if response.success?
+				return ClickSign::Document.new(response.body['document'])
+			end
+		end
+
+		def self.configure(**args)
+			document_key = args.delete(:document_key)
+			payload = build_payload args 
+			response = ClickSign::Service.patch(
+				url: ['documents', document_key],
+				payload: payload
+      )
+      if response.success?
+      	return ClickSign::Document.new(response.body['document'])
+      end
+		end
+
+		def self.finish! document_key: nil
+			response = ClickSign::Service.patch(
+				url: ['documents', document_key, 'finish'],
+      )
+      if response.success?
+      	return ClickSign::Document.new(response.body['document'])
+      end
+		end
+
+		def self.cancel! document_key: nil
+			response = ClickSign::Service.patch(
+				url: ['documents', document_key, 'cancel'],
+      )
+      if response.success?
+      	return ClickSign::Document.new(response.body['document'])
+      end
+		end
+
+		def self.duplicate! document_key: nil
+			response = ClickSign::Service.post(
+				url: ['documents', document_key, 'duplicate'],
+      )
+      if response.created?
+      	return ClickSign::Document.new(response.body['document'])
+      end
+		end
+
+		def self.delete! document_key: nil 
+			response = ClickSign::Service.delete(
+				url: ['documents', document_key],
+      )
+      if response.success?
+      	true
+      else
+      	false
+      end
+		end
+
+		def self.build_payload(**args)
+			payload = {}
+
+			if args[:file].present?
+				data_type = File.extname(args[:file]).gsub('.','')
+				payload['content_base64'] = "data:application/#{data_type};base64,#{Base64.encode64(args[:file].read)}"
+			end 
+
+			payload['path'] = "/#{args[:name]}" if args[:name].present?
+			payload['deadline_at'] = args[:deadline_at] if args[:deadline_at].present?
+			payload['auto_close'] = args[:auto_close] if args[:auto_close].present?
+			payload['locale'] = args[:locale] if args[:locale].present?
+			payload['sequence_enabled'] = args[:sequence_enabled] if args[:sequence_enabled].present?
+			payload['remind_interval'] = args[:remind_interval] if args[:remind_interval].present?
+
+			{document: payload}
+		end
+		# </CLASS METHODS>
+
+		# <INSTANCE METHODS>
+		def add_signer signer_key: nil, sign_as: nil, group: nil
+			ClickSign::List.create document_key: self.key, signer_key: signer_key, sign_as: sign_as, group: nil
+		end
+
+		def remove_signer list_key: nil
+			ClickSign::List.delete list_key: list_key
+		end
+
+		def edit deadline_at: nil, auto_close: nil, locale: nil, sequence_enabled: nil, remind_interval: nil
+			ClickSign::Document.configure( 
+      	document_key: self.key, 
+      	deadline_at: deadline_at, 
+      	auto_close: auto_close, 
+      	locale: locale, 
+      	sequence_enabled: sequence_enabled, 
+      	remind_interval: remind_interval
+    	).attributes
+		end
+		
+		def finish!
+			ClickSign::Document.finish! document_key: self.key
+		end
+
+		def cancel!
+			ClickSign::Document.cancel! document_key: self.key
+		end
+
+		def duplicate!
+			ClickSign::Document.duplicate! document_key: self.key
+		end
+
+		def delete!
+			ClickSign::Document.delete! document_key: self.key
+		end
+		# </INSTANCE METHODS>
+	end
+end

data/lib/list.rb

@@ -0,0 +1,58 @@
+module ClickSign
+	class List
+
+		attr_reader :key, :request_signature_key, :document_key, :signer_key, :sign_as, :created_at, :updated_at, :url, :group, :raw_data
+
+		def initialize(args)
+			@raw_data = args
+			@key = args['key'] if args['key'].present?
+			@request_signature_key = args['request_signature_key'] if args['request_signature_key'].present?
+			@document_key = args['document_key'] if args['document_key'].present?
+			@signer_key = args['signer_key'] if args['signer_key'].present?
+			@sign_as = args['sign_as'] if args['sign_as'].present?
+			@created_at = args['created_at'] if args['created_at'].present?
+			@updated_at = args['updated_at'] if args['updated_at'].present?
+			@url = args['url'] if args['url'].present?
+			@group = args['group'] if args['group'].present?
+		end
+
+		# <CLASS METHODS>
+		def self.create(**args)
+			payload = build_payload(args)
+			response = ClickSign::Service.post(
+				url: 'lists',
+				payload: payload
+	   	)
+	   	if response.created?
+	   		new_signer = ClickSign::List.new(response.body['list'])
+	   	end
+		end
+
+		def self.delete! list_key: nil
+			response = ClickSign::Service.delete(
+				url: ['lists', list_key]
+      )
+      if response.success?
+      	ap 'removido'
+      end
+		end
+
+		def self.build_payload(**args)
+			payload = {}
+			payload['document_key'] = args['document_key'] if args['document_key'].present?
+			payload['signer_key'] = args['signer_key'] if args['signer_key'].present?
+			payload['sign_as'] = args['sign_as'] if args['sign_as'].present?
+			payload['group'] = args['group'] if args['group'].present?
+
+			{ list: payload }
+		end
+		# </CLASS METHODS>
+
+		# <INSTANCE METHODS>
+		def delete!
+			ClickSign::List.delete! self.key
+		end
+		# </INSTANCE METHODS>
+
+	end
+end

data/lib/service.rb

@@ -0,0 +1,119 @@
+module ClickSign
+	require 'rest-client'
+	class Service
+
+		class Response
+			attr_reader :status, :body
+
+			def initialize(**args)
+				@status_code = args[:status_code]
+				@body = JSON.parse(args[:body]) if args[:body].present?
+			end
+
+			def created?
+				@status_code == 201
+			end
+
+			def success?
+				@status_code == 200
+			end
+
+			def error?
+				false
+			end
+		end
+
+		class ErrorResponse < ClickSign::Service::Response
+			attr_reader :errors
+
+			def initialize(**args)
+				super 
+				@errors = @body['errors'] if @body.present?
+			end
+
+			def bad_request?
+				@status_code == 400
+			end
+
+			def unauthorized?
+				@status_code == 401
+			end
+
+			def forbiden?
+				@status_code == 403
+			end
+
+			def not_found?
+				@status_code == 404
+			end
+
+			def unprocessable_entity?
+				@status_code == 422
+			end
+
+			def server_error?
+				@status_code == 500
+			end
+
+			def error?
+				true
+			end
+		end
+
+		# <CLASS METHODS>
+		def self.accept_header
+			{ Accept: 'application/json' }
+		end
+
+		def self.content_type
+			{ 'Content-Type': 'application/json'}
+		end
+
+		def self.api_url(*path)
+			url = [ClickSign::Configuration.sandbox ? ClickSign::Configuration.sandbox_url : ClickSign::Configuration.url]
+			url += ['api']
+			url += [ClickSign::Configuration.api_version]
+			url += path
+			url.join("/") + "?access_token=#{ClickSign::Configuration.access_token}"
+		end
+
+		def self.get url: nil, payload: nil
+			request method: :get, url: url, payload: payload
+		end
+
+		def self.post url: nil, payload: nil
+			request method: :post, url: url, payload: payload
+		end
+
+		def self.patch url: nil, payload: nil
+			request method: :patch, url: url, payload: payload
+		end
+
+		def self.delete url: nil, payload: nil
+			request method: :delete, url: url, payload: payload
+		end
+
+		def self.request method: nil, url: nil, payload: nil
+			begin
+				response = RestClient::Request.execute(
+					method: method,
+					url: api_url(url),
+					payload: payload,
+					headers: accept_header,
+					content_type: content_type
+	      )
+	      ClickSign::Service::Response.new(status_code: response.code, body: response.body)
+	     rescue RestClient::ExceptionWithResponse => _e
+	     	ClickSign::Servive::ErrorResponse.new(status_code: _e.response.code, body: _e.response.body)
+	     rescue RestClient::ServerBrokeConnection => _e
+	     	ap _e
+	     rescue RestClient::SSLCertificateNotVerified => _e 
+	     	ap _e
+	     end
+		end
+		# </CLASS METHODS>
+
+		# <INSTANCE METHODS>
+		# </INSTANCE METHODS>
+	end
+end

data/lib/signer.rb

@@ -0,0 +1,163 @@
+module ClickSign
+	class Signer
+
+		attr_reader :key, :email, :auths, :name, :documentation, :birthday, :phone_number, :has_documentation, :created_at, :updated_at, :raw_data
+
+		def initialize(args)
+			@raw_data = args
+			@key = clean_key(args['key']) if args['key'].present?
+			@email = clean_email(args['email']) if args['email'].present?
+			@auths = clean_auths(args['auths']) if args['auths'].present?
+			@name = clean_name(args['name']) if args['name'].present?
+			@documentation = clean_documentation(args['documentation']) if args['documentation'].present?
+			@birthday = clean_birthday(args['birthday']) if args['birthday'].present?
+			@phone_number = clean_phone_number(args['phone_number']) if args['phone_number'].present?
+			@has_documentation = clean_has_documentation(args['has_documentation']) if args['has_documentation'].present?
+			@created_at = clean_created_at(args['created_at']) if args['created_at'].present?
+			@updated_at = clean_updated_at(args['updated_at']) if args['updated_at'].present?
+		end
+
+		# <CLASS METHODS>
+		def self.build_payload(**args)
+			payload = {}
+
+			payload['email'] = parse_email(args['email']) if args['email'].present?
+	    payload['phone_number'] = parse_phone_number(args['phone_number']) if args['phone_number'].present?
+	    payload['name'] = parse_name(args['name']) if args['name'].present?
+	    payload['documentation'] = parse_documentation(args['documentation']) if args['documentation'].present?
+	    payload['birthday'] = parse_birthday(args['birthday']) if args['birthday'].present?
+	    payload['has_documentation'] = args['has_documentation'].present? ? parse_has_documentation(args['has_documentation']) : default_has_documentation 
+	    payload['auths'] = args['auths'].present? ? parse_auths(args['auths']) : default_auths
+	    payload['delivery'] = args['delivery'].present? ? parse_delivery(args['delivery']) : default_delivery
+
+	    {signer: payload}
+		end
+
+		def self.default_delivery
+			ClickSign::Constants::Delivery::EMAIL
+		end
+
+		def self.default_has_documentation
+			true
+		end
+
+		def self.default_auths
+			['email']
+		end
+
+		def self.create(**args)
+			payload = build_payload(args)
+			response = ClickSign::Service.post(
+				url: 'signers',
+				payload: payload
+	   	)
+	   	if response.created?
+	   		new_signer = ClickSign::Signer.new(response.body['signer'])
+	   	end
+		end
+
+		def self.find(signer_key: nil)
+			response = ClickSign::Service.get(
+				url: ['signers', signer_key]
+      )
+      if response.success?
+      	signer = ClickSign::Signer.new(response.body['signer'])
+      end
+    end
+		# </CLASS METHODS>
+
+		# <INSTANCE METHODS>
+    def add_to_document document_key: nil, sign_as: nil, group: nil
+    	ClickSign::List.create document_key: document_key, signer_key: self.key, sign_as: sign_as, group: group
+    end
+
+    def remove_from_document list_key: nil
+    	ClickSign::List.delete list_key: list_key
+    end
+
+    private
+		def clean_key value
+			value
+		end
+
+		def clean_email value
+			value
+		end
+
+		def clean_auths value
+			value
+		end
+
+		def clean_name value
+			value
+		end
+
+		def clean_documentation value
+			value
+		end
+
+		def clean_birthday value
+			value
+		end
+
+		def clean_phone_number value
+			value
+		end
+
+		def clean_has_documentation value
+			value
+		end
+
+		def clean_created_at value
+			value
+		end
+
+		def clean_updated_at value
+			value
+		end
+
+		def parse_key value
+			value
+		end
+
+		def parse_email value
+			value
+		end
+
+		def parse_auths value
+			value
+		end
+
+		def parse_name value
+			value
+		end
+
+		def parse_documentation value
+			value
+		end
+
+		def parse_birthday value
+			value
+		end
+
+		def parse_phone_number value
+			value
+		end
+
+		def parse_has_documentation value
+			value
+		end
+
+		def parse_created_at value
+			value
+		end
+
+		def parse_updated_at value
+			value
+		end
+
+
+		# </INSTANCE METHODS>
+
+	end
+end

data/lib/webhooks/routes.rb

@@ -0,0 +1,14 @@
+module ClickSign
+	module Webhooks
+		module Routes
+		end
+	end
+end
+
+module ActionDispatch::Routing
+	class Mapper
+		def click_sign_for 
+			get 'test_click_sign', controller: :proposals, action: :teste
+		end
+	end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: click_sign_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thiago Soares de Melo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: 
+email: thiago.soaresm19@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/configuration.rb
+- lib/constants.rb
+- lib/document.rb
+- lib/list.rb
+- lib/service.rb
+- lib/signer.rb
+- lib/webhooks/routes.rb
+homepage: https://github.com/teago19/click-sign-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: ClickSign WebHook and Api interface for rails
+test_files: []