clicksign 0.0.2 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e5a45ed31afb3385da42cb5e4cc1bcc08306489
-  data.tar.gz: 3622beb4ba84350a62e562b843bb5142ca9b3d87
+  metadata.gz: 92022f1569b2ad33a843cd4a225ca978e9bef14e
+  data.tar.gz: 2267d095b9e83ad083d58cbdf2681bff1a220fd5
 SHA512:
-  metadata.gz: 2f94fd93549e112231817013942737c5e7afde123178d7ac2b82609c5f9d7665dee2939a39d3b3644930939c1fb53e23c5c921fb280ff25e4f1e57eb77f62a0c
-  data.tar.gz: d70377367e9be154ed99da4f02db9011f96ad31e9cfbe964e2066d8e555073c675390f109cc125616a82ed6d6a80b8f0aaa6d0d177fc162b4e7f0f79f466d35b
+  metadata.gz: c2e0a45714e53c245cadcd9fbe4f29820ce309202db50760a8e34e5fdcc2834430036f4c26a43d42a8774ee72416fd8429ce39b5e8f5ff21d10e7d9ac08f704b
+  data.tar.gz: 1a38c26a2e400a8809a595623cf8f7d197a0be5dd270e9f0b7dfa07946caa1898aa00ef5e54fb5ce36f74c607a2a086c10edaf8a6bba419471f99a7fb31b1e80

data/README.md

@@ -1,4 +1,131 @@
-clicksign-ruby
-==============
+# Clicksign Ruby Client
 
-Clicksign Ruby client
+Official gem to comunicate with the **[Clicksign REST API](http://clicksign.github.io/rest-api/)**.
+
+## Installation
+
+With Bundler:
+
+```
+gem 'clicksign'
+```
+
+Manual installation via RubyGems:
+
+```shell
+gem install clicksign
+```
+
+## Usage
+
+### Setting up the client
+
+You must provide a valid `token` in order to use the library. As an option, you can also set a different `endpoint`.
+
+The required `token` is provided by the Clicksign support team.
+
+```ruby
+require 'clicksign'
+
+Clicksign.configure do |config|
+  config.token = ENV['CLICKSIGN_TOKEN']
+  config.endpoint = 'https://api.clicksign-demo.com' # Default: 'api.clicksign.com'
+end
+```
+
+### Retrieving a list of documents
+
+You'll be able to make requests to the Clicksign API right after the initial setup. The first step would be to retrieve a list of documents that you've previously uploaded to your account.
+
+```ruby
+documents = Clicksign::Document.all
+```
+
+### Uploading a document
+
+To upload a new document to Clicksign you can use the following snippet:
+
+```ruby
+document = Clicksign::Document.create(File.new('example.pdf'))
+```
+
+You can also upload a new document and at the same time set up a signature list
+as follow:
+
+```ruby
+document = Clicksign::Document.create(File.new('example.pdf'), signers: [{ act: 'sign', email: 'john.doe@example.com' }], message: 'Please sign it', skip_email: true)
+```
+
+It is important to notice that the additional parameters to `create` method is
+the same as the ones in the section [Creating a signature list](#user-content-creating-a-signature-list)
+
+
+### Retrieving a document
+
+```ruby
+found = Clicksign::Document.find(document_key)
+```
+
+### Creating a signature list
+
+The method `Clicksign::Document.create_list` accepts **3 arguments**, the latter being optional.
+
+The first argument is `document_key`, which represents the document's unique identification.
+
+The second argument is `signers`, an array of hashes with the e-mails of the signers and their actions (`act`). The available options for `act` are described in our [documentation](http://clicksign.github.io/rest-api/#criacao-de-lista-de-assinatura).
+
+The third and optional parameter is `skip_email`, a boolean that says whether the API should send e-mails to the signers or not.
+
+Example:
+
+```ruby
+document_key = KEY
+signers = [{ email: 'john.doe@example.com', act: 'sign' }]
+result = Clicksign::Document.create_list(document, signers, true)
+```
+
+### Hooks
+
+You can perform three different actions with hooks: **retrieve** all, **create** a new one or **delete** an existing hook.
+
+Listing all hooks that belong to a document:
+
+```ruby
+Clicksign::Hook.all(document_key)
+```
+
+Creating a new hook for a specific document:
+
+```ruby
+Clicksign::Hook.create(document_key, 'http://example.com')
+```
+
+Destroying an existing hook:
+
+```ruby
+Clicksign::Hook.delete(document_key, hook_id)
+```
+
+### Batches
+
+Batches are you used to group documents in a package and perform batch signatures via the [Clicksign Widget](https://github.com/clicksign/widget).
+
+You can perform three different actions with batches: **retrieve** all, **create** a new one or **delete** an existing batch.
+
+Listing all batches:
+
+```ruby
+Clicksign::Batch.all
+```
+
+Creating a new batch for a group of documents:
+
+```ruby
+Clicksign::Batch.create([key1, key2, key3])
+```
+
+Destroying an existing batch:
+
+```ruby
+Clicksign::Batch.delete(batch_key)
+```

data/lib/clicksign/document.rb

@@ -12,10 +12,13 @@ module Clicksign
         {}
     end
 
-    def self.create(file)
+    def self.create(file, params = {})
+      signers = params.delete(:signers)
+      params['signers[]'] = [signers].flatten(1) if signers
+
       request :post,
         api_url('documents'),
-        { "document[archive][original]" => file },
+        { "document[archive][original]" => file }.merge(params),
         {}
     end
 

data/lib/clicksign/version.rb

@@ -1,3 +1,3 @@
 module Clicksign
-  VERSION = '0.0.2'
+  VERSION = '0.1.2'
 end

data/spec/clicksign_spec.rb

@@ -28,4 +28,29 @@ describe Clicksign::Document do
       expect(record['document']['status']).to eq 'completed'
     end
   end
+
+  describe '.create' do
+    it 'sends document and list params' do
+      file = File.new('spec/fixtures/all_documents.json')
+      signers = { act: 'sign', email: 'john.doe@example.com' }
+      message = 'Sign it please.'
+      skip_email = false
+
+      expect(RestClient).to receive(:post)
+      .with(
+        "http://example.com/v1/documents?access_token=my_token",
+        {
+        'document[archive][original]' => file,
+        message: message,
+        skip_email: skip_email,
+        'signers[]'  => [signers],
+      }, { accept: 'json' }).and_return({})
+
+      Clicksign::Document.create(file, {
+        signers: signers,
+        message: message,
+        skip_email: skip_email
+      })
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.2
 platform: ruby
 authors:
 - Clicksign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -121,3 +121,4 @@ test_files:
 - spec/fixtures/all_documents.json
 - spec/fixtures/document.xml
 - spec/spec_helper.rb
+has_rdoc: