clicksign-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8951f7e1a735d417e2c3b1222c30d294ad1b5d7828dd58c0edc816b5f0eabce9
-  data.tar.gz: 0713e52399d0df6a4a3220a150c9becf036ae651842a6e6564563c082aa7cffb
+  metadata.gz: 2777702010e8d1b6f61ea61f8071ee606402eab0e59b564ec69ae44a45b6a01f
+  data.tar.gz: dda577cc3c773b0cea505f5e6b5b34386a83c9bd50aba0b21b6365f4b2243b10
 SHA512:
-  metadata.gz: 2fbca1cbd757be3603bfc71af4fac36133fd41c2556e6f7175c3cbfca654a9a5654a655b82df919f48115cde2d60899299be24b79c8d8906c349a6d1a6ba681f
-  data.tar.gz: db8bb93dd9e9a0221bea7ef5c2a6f1543a95fcd3d054813d33c1562fa9d4a784c9c1006c22817d2c0485a34f9558ca6bd33fdad5517cf6c4a6926b298ce0a613
+  metadata.gz: d8e9b189731f2a2f1be1cdd1b5866ba3bc12fa06446e889aab435a224a648274beaa70353d38a686ebe6f4e9bebb006f15a8fea1347138638b6e18e4ea516e9d
+  data.tar.gz: aefd81b8384d2ec24910eca65f38ebdc38dc42de5e9ef284a36811f723766ca6a9e1ddffb8a8589de76a6a57e4d880c6c5e343cf466d6c23381401f8b071ffc2

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 .env
+.byebug_history

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/.travis.yml

@@ -3,5 +3,13 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.4.4
+  - 2.5.3
 before_install: gem install bundler -v 1.16.6
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clicksign-api (0.0.1)
+    clicksign-api (0.0.2)
       faraday
 
 GEM
@@ -15,7 +15,7 @@ GEM
     diff-lcs (1.3)
     docile (1.3.1)
     dotenv (2.5.0)
-    faraday (0.12.2)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     hashdiff (0.3.7)
     json (2.1.0)
@@ -62,4 +62,4 @@ DEPENDENCIES
   webmock (~> 3.0)
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -1,8 +1,9 @@
 # Clicksign::Api
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clicksign/api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/clicksign-api.svg)](https://badge.fury.io/rb/clicksign-api)
+[![Build Status](https://travis-ci.org/NexoosBR/clicksign-api.svg?branch=master)](https://travis-ci.org/NexoosBR/clicksign-api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7e4c11dd4129d37ee34c/maintainability)](https://codeclimate.com/github/NexoosBR/clicksign-api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7e4c11dd4129d37ee34c/test_coverage)](https://codeclimate.com/github/NexoosBR/clicksign-api/test_coverage)
 
 ## Installation
 
@@ -20,9 +21,67 @@ Or install it yourself as:
 
     $ gem install clicksign-api
 
-## Usage
+## Setup:
+
+By default, all requests use Clicksign's SANDBOX.
+
+```ruby
+Clicksign::API.configure do |config|
+  config.access_token = ENV['CLICKSIGN_ACCESS_TOKEN']
+end
+```
+
+To use PRODUCTION environment, you have to setup:
+
+```ruby
+Clicksign::API.configure do |config|
+  config.access_token = ENV['CLICKSIGN_ACCESS_TOKEN']
+  config.production = true
+end
+```
+
+## Usage:
+
+To see all available parameters, please, check the [API docs](https://developers.clicksign.com/docs/informacoes-gerais).
+
+#### Create documents
+
+```ruby
+response = Clicksign::API::Document.create(path: '/path/to/file.pdf', file: file)
+=> #<Faraday::Response ...>
+
+response.success?
+=> true # false
+
+JSON.parse(response.body)
+=> {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
+```
+
+#### View documents
+
+```ruby
+response = Clicksign::API::Document.find('DOCUMENT_KEY')
+=> #<Faraday::Response ...>
+
+response.success?
+=> true # false
 
-TODO: Write usage instructions here
+JSON.parse(response.body)
+=> {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
+```
+
+#### Add signers
+
+```ruby
+response = Clicksign::API::Signer.create('DOCUMENT_KEY', signer)
+=> #<Faraday::Response ...>
+
+response.success?
+=> true # false
+
+JSON.parse(response.body)
+=> {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
+```
 
 ## Development
 

data/lib/clicksign/api.rb

@@ -11,6 +11,8 @@ end
 
 require "clicksign/api/requests"
 require "clicksign/api/document"
+require "clicksign/api/signer"
+require "clicksign/api/notifier"
 
 
 module Clicksign

data/lib/clicksign/api/document.rb

@@ -3,31 +3,29 @@ module Clicksign
     class Document
       extend Requests
 
-      class << self
-        def create(path:, file:, signers: nil, deadline_at: nil, auto_close: nil, locale: nil)
-          content_base64 = Base64.encode64(File.read(file))
-
-          body = { document: {
-            path: path,
-            content_base64: "data:application/pdf;base64,#{content_base64}"
-          } }
+      REQUEST_PATH = '/api/v1/documents/'
+      ATTRIBUTES = [:path, :deadline_at, :auto_close, :locale, :signers]
 
-          body.merge!(deadline_at: deadline_at) unless deadline_at.nil?
-          body.merge!(auto_close: auto_close) unless auto_close.nil?
-          body.merge!(locale: locale) unless locale.nil?
-          body.merge!(signers: signers) unless signers.nil?
-
-          request_path = '/api/v1/documents'
+      class << self
+        def create(params = {})
+          post(REQUEST_PATH, body(params))
+        end
 
-          response = post(request_path, body)
+        def find(key)
+          get(REQUEST_PATH + key)
+        end
 
-          json = JSON.parse(response.body, symbolize_names: true)
+        def body(params)
+          document = ATTRIBUTES.each.with_object({}) do |attribute, hash|
+            hash[attribute] = params[attribute] if params.has_key?(attribute)
+          end
 
-          if response.success?
-            json[:document]
-          else
-            json[:errors]
+          if params.has_key?(:file)
+            content_base64 = Base64.encode64(File.read(params[:file]))
+            document[:content_base64] = "data:application/pdf;base64,#{content_base64}"
           end
+
+          body = { document: document }
         end
       end
     end

data/lib/clicksign/api/notifier.rb

@@ -0,0 +1,31 @@
+module Clicksign
+  module API
+    class Notifier
+      extend Requests
+
+      REQUEST_PATH = '/api/v1/signers/:key/notify'
+      ATTRIBUTES = [:message]
+
+      class << self
+        def notify(document_key, params = {})
+          post(
+            path_for(document_key),
+            body(params)
+          )
+        end
+
+        def path_for(document_key)
+          REQUEST_PATH.dup.tap do |path|
+            path[':key'] = document_key
+          end
+        end
+
+        def body(params)
+          ATTRIBUTES.each.with_object({}) do |attribute, hash|
+            hash[attribute] = params[attribute] if params.has_key?(attribute)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clicksign/api/requests.rb

@@ -9,6 +9,13 @@ module Clicksign
         end
       end
 
+      def get(request_path)
+        conn.get do |req|
+          req.url request_path, { access_token: Clicksign::API.access_token }
+          req.headers['Content-Type'] = 'application/json'
+        end
+      end
+
       def conn
         @conn ||= Faraday.new(url: Clicksign::API.url)
       end

data/lib/clicksign/api/signer.rb

@@ -0,0 +1,38 @@
+module Clicksign
+  module API
+    class Signer
+      extend Requests
+
+      REQUEST_PATH = '/api/v1/documents/:key/signers/'
+      ATTRIBUTES = [
+        :email, :sign_as, :auths, :name, :documentation, :birthday,
+        :has_documentation, :phone_number, :send_email, :message, :url
+      ]
+
+      class << self
+        def create(document_key, *params)
+          post(
+            path_for(document_key),
+            body(params)
+          )
+        end
+
+        def path_for(document_key)
+          REQUEST_PATH.dup.tap do |path|
+            path[':key'] = document_key
+          end
+        end
+
+        def body(params)
+          signers = params.map do |signer_params|
+            ATTRIBUTES.each.with_object({}) do |key, hash|
+              hash[key] = signer_params[key] if signer_params.has_key?(key)
+            end
+          end
+
+          body = { signers: signers }
+        end
+      end
+    end
+  end
+end

data/lib/clicksign/api/version.rb

@@ -1,5 +1,5 @@
 module Clicksign
   module Api
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Francisco Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,7 +143,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".env.example"
 - ".gitignore"
 - ".rspec"
@@ -159,7 +158,9 @@ files:
 - clicksign-api.gemspec
 - lib/clicksign/api.rb
 - lib/clicksign/api/document.rb
+- lib/clicksign/api/notifier.rb
 - lib/clicksign/api/requests.rb
+- lib/clicksign/api/signer.rb
 - lib/clicksign/api/version.rb
 homepage: https://github.com/NexoosBR/clicksign-api
 licenses: []
@@ -180,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Clicksign API ruby interface

data/.byebug_history

@@ -1,162 +0,0 @@
-exit
-json[:errors]
-response.status
-response.success?
-response.status
-raise json[:errors].join(', ')
-json[:errors].join(', ')
-json
-json[:errors].json(', ')
-json
-response
-OpenStruct.new(json[:errors])
-OpenStruct
-OpenScruct.new json[:errors]
-json[:errors]
-json
-document = OpenStruct.new(json[:errors])
-json
-exit
-response.success?
-response.success
-json
-d.key
-d = OpenStruct.new(json[:document])
-json = JSON.parse(response.body, symbolize_names: true)
-JSON.parse(response.body, symbolize_names: true)
-response.body
-response
-exit
-response
-exit
-response
-exit
-response
-exit
-response
-exit
-response
-exit
-response
-exit
-nil.nil?
-nil.present?
-hash
-hash.merge!(foo: 'bar')
-hash
-hash.merge(foo: 'bar')
-hash = {}
-body
-body.merge(deadline_at: deadline_at) if deadline_at
-exit
-response
-respone
-exit
-          end
-            req.body = body.to_json
-            req.headers['Content-Type'] = 'application/json'
-            req.url request_path
-conn.post do |req|
-          end
-            req.body = body.to_json
-            req.headers['Content-Type'] = 'application/json'
-            req.url url
-conn.post do |req|
-body.to_json
-          end
-            req.body = body
-            req.headers['Content-Type'] = 'application/json'
-            req.url url
-conn.post do |req|
-          end
-            request.body = body
-            request.headers['Content-Type'] = 'application/json'
-            request.url url
-conn.post do |request|
-url
-exit
-          end
-            request.body = body
-            request.headers['Content-Type'] = 'application/json'
-            request.url url
-conn.post do |request|
-          end
-            request.body = body
-            request.headers['Content-Type'] = 'application/json'
-            request.url url
-conn.post do |request|
-conn
-          end
-            request.body = body
-            headers['Content-Type'] = 'application/json'
-            request.url url
-conn.post do |request|
-          end
-            request.body = body
-            headers['Content-Type'] = 'application/json'
-            request.url url
-conn.post do |request|
-          end
-            request.body = body
-            headers['Content-Type'] = 'application/json'
-            request.url "/api/v1/documents?access_token=#{Clicksign::API.access_token}"
-conn.post do |request|
-body
-exit
-body
-exit
-          }
-            locale: 'pt-BR',
-            auto_close: true,
-            deadline_at: '24/10/2018',
-            content_base64: content_base64,
-            path: '/teste',
-            }body = {
-              locale: 'pt-BR',
-              auto_close: true,
-              deadline_at: '24/10/2018',
-              content_base64: content_base64,
-              path: '/teste',
-body = {
-1
-          end
-            }
-              locale: 'pt-BR',
-              auto_close: true,
-              deadline_at: '24/10/2018',
-              content_base64: content_base64,
-              path: '/teste',
-            request.body = {
-            headers['Content-Type'] = 'application/json'
-            request.url "/api/v1/documents?access_token=#{Clicksign::API.access_token}"
-conn.post do |request|
-Clicksign::API.access_token
-exit
-Clicksign::API.access_token
-exit
-Clicksign::API.access_token
-conn
-encoded_file
-exit
-Base64.decode64 encoded_file
-Base64.decode64encoded_file
-encoded_file
-exit
-Clicksign::API.url
-conn ||= Faraday.new(url: Clicksign::API.url)
-conn
-      end
-        @conn ||= Faraday.new(url: Clicksign::API.url)
-def conn
-conn
-Base64.decode64(encoded)
-encoded = Base64.encode64 File.read(file)conn
-Base64.encode64 File.read(file)
-File.exist? file
-Base64.encode64 File.open(file)
-Base64.encode64 File.open(path)
-Base64.encode64 file.open
-Base64.encode64 file
-require 'base64'
-block
-file