clicksign 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d4b389f3944bfe890206fb86408085f30d74d19
+  data.tar.gz: 2734e686519f5264fc46da61a5c975628ae73ddc
+SHA512:
+  metadata.gz: 13e62ccded57a9c168b2f615eb58db11f82f1dc4e6c1b6cb0aa68eb5318962567abd424b2134bcfc706c84c139a3fc3d1ae67493d786fdf9a62ecdffa378b78d
+  data.tar.gz: a25670e4dfad04176f528112d1f83188ef4c4c4aa1c13cfa41609cfd76a82f1a684aaf609b0385c06d37c648080303e0c2d8c2edb33b6e569733e47072eb7c46

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+tmp/

data/.rspec

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    clicksign (0.0.1)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    mime-types (2.4.1)
+    netrc (0.7.7)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  clicksign!
+  rake
+  rspec (~> 3.0)

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,4 @@
+clicksign-ruby
+==============
+
+Clicksign Ruby client

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"
+  spec.version       = Clicksign::VERSION
+  spec.authors       = ["Clicksign"]
+  spec.email         = ["suporte@clicksign.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 = '>= 1.9.3'
+
+  spec.add_dependency "rest-client"
+
+  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,17 @@
+require 'clicksign'
+
+Clicksign.configure do |config|
+  config.token = ENV['CLICKSIGN_TOKEN']
+end
+
+# Create a document
+doc = Clicksign::Document.create(File.new('/deal.pdf'))
+
+# Get Key identification
+doc_key = doc['document']['key']
+
+# Create a new signature list
+result = Clicksign::Document.create_list(doc_key, { email: 'john.doe@example.com', act: 'sign' })
+
+# Print document details with signatures and list
+puts result

data/lib/clicksign.rb

@@ -0,0 +1,21 @@
+require 'rest_client'
+require 'json/ext'
+
+require 'clicksign/version'
+require 'clicksign/base'
+require 'clicksign/document'
+require 'clicksign/batch'
+require 'clicksign/hook'
+
+module Clicksign
+  class << self
+    attr_accessor :endpoint, :token, :api_version
+  end
+
+  def self.configure(&block)
+    self.endpoint    = 'https://api.clicksign.com'
+    self.api_version = 'v1'
+
+    yield self
+  end
+end

data/lib/clicksign/base.rb

@@ -0,0 +1,22 @@
+module Clicksign
+  class Base
+    def self.accept_header
+      { accept: 'json' }
+    end
+
+    def self.request(method, *params)
+      params.last.merge! accept_header
+      parse RestClient.public_send(method, *params)
+    end
+
+    def self.api_url(*path)
+      ([Clicksign.endpoint, Clicksign.api_version] + path).join("/") +
+        "?access_token=#{Clicksign.token}"
+    end
+
+    def self.parse(response)
+      response = {} if response.empty?
+      JSON[response]
+    end
+  end
+end

data/lib/clicksign/batch.rb

@@ -0,0 +1,24 @@
+module Clicksign
+  class Batch < Base
+    def self.all
+      request :get,
+        api_url('batches'),
+        {}
+    end
+
+    def self.create(keys)
+      raise ArgumentError, "keys need to be an array" unless keys.is_a? Array
+
+      request :post,
+        api_url('batches'),
+        { keys: keys },
+        {}
+    end
+
+    def self.delete(id)
+      request :delete,
+        api_url('batches', id),
+        {}
+    end
+  end
+end

data/lib/clicksign/document.rb

@@ -0,0 +1,29 @@
+module Clicksign
+  class Document < Base
+    def self.all
+      request :get,
+        api_url('documents'),
+        {}
+    end
+
+    def self.find(key)
+      request :get,
+        api_url('documents', key),
+        {}
+    end
+
+    def self.create(file)
+      request :post,
+        api_url('documents'),
+        { "document[archive][original]" => file },
+        {}
+    end
+
+    def self.create_list(key, signers, skip_email = true)
+      request :post,
+        api_url('documents', key, 'list'),
+        { signers: Array.wrap(signers), skip_email: skip_email }.to_json,
+        content_type: "json"
+    end
+  end
+end

data/lib/clicksign/hook.rb

@@ -0,0 +1,22 @@
+module Clicksign
+  class Hook < Base
+    def self.all(key)
+      request :get,
+        api_url('documents', key, 'hooks'),
+        {}
+    end
+
+    def self.create(key, url)
+      request :post,
+        api_url('documents', key, 'hooks'),
+        { url: url }.to_json,
+        { content_type: "json" }
+    end
+
+    def self.delete(key, id)
+      request :delete,
+        api_url('documents', key, 'hooks', id),
+        {}
+    end
+  end
+end

data/lib/clicksign/version.rb

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

data/spec/clicksign_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Clicksign do
+  describe '.configure' do
+    before do
+      Clicksign.configure do |config|
+        config.endpoint = 'http://example.com'
+        config.token    = 'my_token'
+      end
+    end
+
+    it 'set config values' do
+      expect(Clicksign.endpoint).to eq "http://example.com"
+      expect(Clicksign.token).to eq 'my_token'
+    end
+  end
+end
+
+describe Clicksign::Document do
+  describe '.all' do
+    it 'returns a hash with documents' do
+      expect(RestClient).to receive(:get)
+        .with("http://example.com/v1/documents?access_token=my_token", {accept: 'json'})
+        .and_return(File.read('spec/fixtures/all_documents.json'))
+
+      records = Clicksign::Document.all
+      record  = records.first
+      expect(record['document']['status']).to eq 'completed'
+    end
+  end
+end

data/spec/fixtures/all_documents.json

@@ -0,0 +1,67 @@
+[
+  {
+    "document": {
+      "key": "1123-4567-89ab-cdef",
+      "original_name": "document-2.pdf",
+      "status": "completed",
+      "archive_id": 2,
+      "created_at": "2014-06-18T09:55:16.873-03:00",
+      "updated_at": "2014-06-18T10:02:03.056-03:00",
+      "user_key":"A0BF-848B-0A42-916C",
+      "list": {
+        "locked":null,
+        "started_at":null,
+        "created_at":"2014-06-18T09:57:14.434-03:00",
+        "updated_at":"2014-06-18T09:57:14.434-03:00",
+        "user_key":"A0BF-848B-0A42-916C",
+        "signatures": []
+      }
+    }
+  },
+  {
+    "document": {
+      "key": "0123-4567-89ab-cdef",
+      "original_name": "document-1.pdf",
+      "status": "completed",
+      "archive_id": 1,
+      "created_at": "2014-06-18T09:55:16.873-03:00",
+      "updated_at": "2014-06-18T10:02:03.056-03:00",
+      "user_key":"A0BF-848B-0A42-916C",
+      "list": {
+        "locked":null,
+        "started_at":"2014-06-18T09:58:46.450-03:00",
+        "created_at":"2014-06-18T09:57:14.434-03:00",
+        "updated_at":"2014-06-18T09:58:46.452-03:00",
+        "user_key":"A0BF-848B-0A42-916C",
+        "signatures": [
+          {
+            "display_name":"John Doe",
+            "title":null,
+            "company_name":null,
+            "key":"A0BF-848B-0A42-916C",
+            "act":"receipt",
+            "decision":"agreed",
+            "address":"201.81.113.174",
+            "email":"john.doe@example.com",
+            "signed_at":"2014-06-18T09:59:58.713-03:00",
+            "created_at":"2014-06-18T09:57:24.191-03:00",
+            "updated_at":"2014-06-18T09:59:58.836-03:00"
+          },
+          {
+            "display_name":"Jane Doe",
+            "title":null,
+            "company_name":null,
+            "key":"A0BF-848B-0A42-916C",
+            "act":"intervening",
+            "decision":"agreed",
+            "address":"201.81.113.174",
+            "email":"jane.doe@example.com",
+            "signed_at":"2014-06-18T10:01:18.327-03:00",
+            "created_at":"2014-06-18T09:57:31.114-03:00",
+            "updated_at":"2014-06-18T10:01:18.389-03:00"
+          }
+        ]
+      }
+    }
+  }
+]

data/spec/fixtures/document.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <key>B3E5-C645-3259-EDEC</key>
+  <original_name>document.pdf</original_name>
+  <status>editing</status>
+  <created_at>2014-10-07 15:38:43 -0300</created_at>
+  <updated_at>2014-10-07 15:38:43 -0300</updated_at>
+  <user_key>4139-026A-D7FF-5466</user_key>
+  <list>
+    <started_at/>
+    <created_at>2014-10-07 15:38:43 -0300</created_at>
+    <updated_at>2014-10-07 15:38:43 -0300</updated_at>
+  </list>
+</document>

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: clicksign
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Clicksign
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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:
+- suporte@clicksign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- clicksign.gemspec
+- examples/simple_api.rb
+- lib/clicksign.rb
+- lib/clicksign/base.rb
+- lib/clicksign/batch.rb
+- lib/clicksign/document.rb
+- lib/clicksign/hook.rb
+- lib/clicksign/version.rb
+- spec/clicksign_spec.rb
+- spec/fixtures/all_documents.json
+- spec/fixtures/document.xml
+- 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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby library to interact with Clicksign
+test_files:
+- spec/clicksign_spec.rb
+- spec/fixtures/all_documents.json
+- spec/fixtures/document.xml
+- spec/spec_helper.rb