hellosign-api 1.0.0

data/spec/fixtures/bulk_send_job.json

@@ -0,0 +1,88 @@
+{
+    "bulk_send_job": {
+        "bulk_send_job_id": "af299494bdcad318b4856aa34aa263dbdaaee9ab",
+        "total": 3,
+        "is_creator": true,
+        "created_at": 1536784104
+    },
+    "list_info": {
+        "page": 1,
+        "num_pages": 1,
+        "num_results": 2,
+        "page_size": 20
+    },
+    "signature_requests": [
+        {
+            "signature_request_id": "76cdec91655d6b26e403e8c10c1def40c26510ok",
+            "test_mode": true,
+            "title": "Please sign",
+            "original_title": "Please sign",
+            "subject": "This requires your signature",
+            "message": null,
+            "metadata": {},
+            "is_complete": false,
+            "is_declined": false,
+            "has_error": false,
+            "custom_fields": [],
+            "response_data": [],
+            "signing_url": "https://app.hellosign.com/sign/76cdec91655d6b26e403e8c10c1def40c26510ok",
+            "signing_redirect_url": null,
+            "final_copy_uri": "/v3/signature_request/final_copy/76cdec91655d6b26e403e8c10c1def40c26510ok",
+            "files_url": "https://api.hellosign.com/v3/signature_request/files/76cdec91655d6b26e403e8c10c1def40c26510ok",
+            "details_url": "https://app.hellosign.com/home/manage?guid=76cdec91655d6b26e403e8c10c1def40c26510ok",
+            "requester_email_address": "requester@example.com",
+            "signatures": [
+                {
+                    "signature_id": "1ccd835c064c4d7936012840924c0528",
+                    "has_pin": false,
+                    "signer_email_address": "bulksend1@example.com",
+                    "signer_name": "George Signer",
+                    "order": null,
+                    "status_code": "signed",
+                    "signed_at": 1542665401,
+                    "last_viewed_at": 1542665391,
+                    "last_reminded_at": null,
+                    "error": null
+                }
+            ],
+            "cc_email_addresses": [],
+            "bulk_send_job_id": "af299494bdcad318b4856aa34aa263dbdaaee9ab"
+        },
+        {
+            "signature_request_id": "b2c5c3dfc5ac596e02b7c615b59314b7948abc88",
+            "test_mode": true,
+            "title": "Please sign",
+            "original_title": "Please sign",
+            "subject": "This requires your signature",
+            "message": null,
+            "metadata": {},
+            "is_complete": false,
+            "is_declined": false,
+            "has_error": false,
+            "custom_fields": [],
+            "response_data": [],
+            "signing_url": "https://app.hellosign.com/sign/b2c5c3dfc5ac596e02b7c615b59314b7948abc88",
+            "signing_redirect_url": null,
+            "final_copy_uri": "/v3/signature_request/final_copy/b2c5c3dfc5ac596e02b7c615b59314b7948abc88",
+            "files_url": "https://api.hellosign.com/v3/signature_request/files/b2c5c3dfc5ac596e02b7c615b59314b7948abc88",
+            "details_url": "https://app.hellosign.com/home/manage?guid=b2c5c3dfc5ac596e02b7c615b59314b7948abc88",
+            "requester_email_address": "requester@example.com",
+            "signatures": [
+                {
+                    "signature_id": "2ad95d666374efcfb2bf299855591738",
+                    "has_pin": false,
+                    "signer_email_address": "bulksend2@example.com",
+                    "signer_name": "Mary Signer",
+                    "order": null,
+                    "status_code": "awaiting_signature",
+                    "signed_at": null,
+                    "last_viewed_at": null,
+                    "last_reminded_at": null,
+                    "error": null
+                }
+            ],
+            "cc_email_addresses": [],
+            "bulk_send_job_id": "af299494bdcad318b4856aa34aa263dbdaaee9ab"
+        }
+    ]
+}

data/spec/fixtures/bulk_send_jobs.json

@@ -0,0 +1,22 @@
+{
+    "list_info": {
+        "page": 1,
+        "num_pages": 1,
+        "num_results": 2,
+        "page_size": 20
+    },
+    "bulk_send_jobs": [
+        {
+            "bulk_send_job_id": "af299494bdcad318b4856aa34aa263dbdaaee9ab",
+            "total": 2,
+            "is_creator": true,
+            "created_at": 1542664362
+        },
+        {
+            "bulk_send_job_id": "d74f731b24b00fe6a61083bcff11d0aepl5bf927",
+            "total": 3,
+            "is_creator": true,
+            "created_at": 1542655564
+        }
+    ]
+}

data/spec/fixtures/embedded.json

@@ -0,0 +1,6 @@
+{
+    "embedded": {
+        "sign_url": "https://api.hellosign.com/editor/embeddedSign?signature_id=50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b&token=b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
+        "expires_at": 1396469502
+    }
+}

data/spec/fixtures/error.json

@@ -0,0 +1,6 @@
+{
+    "error": {
+        "error_msg": "Error Message",
+        "error_name": "Error Name"
+    }
+}

data/spec/fixtures/headers.json

@@ -0,0 +1,18 @@
+{
+	"date": "Wed, 28 Feb 2018 21:17:07 GMT",
+	"content-type": "application/json",
+	"content-length": "529",
+	"connection": "close",
+	"set-cookie": "AWSALB=DQqaS5np0cXpMMcb1IanILXEmtw8XOZBceauEE76KNzGzua1fJXaht/7XAaqSTiIQMBIzcTTeq2IJ0/jRmt8iWjVVwlY5JWmgyUV8r3vJaSBjcZ4fMbPNhS8SPmH; Expires=Wed, 07 Mar 2018 21:17:04 GMT; Path=/",
+	"server": "Apache",
+	"strict-transport-security": "max-age=15768000",
+	"x-ratelimit-limit": "2000",
+	"x-ratelimit-limit-remaining": "1998",
+	"x-ratelimit-reset": "1519852625",
+	"access-control-allow-origin": "*",
+	"access-control-allow-headers": "Authorization, Origin, X-Requested-With, Content-Type, Accept",
+	"access-control-allow-methods": "GET, POST, OPTIONS",
+	"user-agent": "HelloSign API",
+	"vary": "Accept-Encoding",
+	"p3p": "CP='NOP3PPOLICY'"
+}

data/spec/fixtures/signature_request.json

@@ -0,0 +1,45 @@
+{
+    "signature_request": {
+        "signature_request_id": "1",
+        "title": "title",
+        "original_title": "original_title",
+        "subject": "subject",
+        "message": "message",
+        "test_mode": false,
+        "is_complete": true,
+        "has_error": false,
+        "custom_fields": [],
+        "response_data": [{
+            "name": "name",
+            "value": "value",
+            "type": "signature",
+            "api_id": "api_id",
+            "signature_id": "signature_id"
+        }],
+        "signing_url": "https://example.com/signing_url",
+        "signing_redirect_url": "https://example.com/signing_redirect_url",
+        "final_copy_uri": "/v3/final_copy_url",
+        "files_url": "https://example.com/file_url",
+        "details_url": "https://example.com/details_url",
+        "requester_email_address": "requester_email_address@example.com",
+        "signatures": [{
+            "signature_id": "signature_id",
+            "has_pin": false,
+            "signer_email_address": "signer_email_address@example.com",
+            "signer_name": "signer_name",
+            "order": 1,
+            "status_code": "signed",
+            "signed_at": 1393389891,
+            "last_viewed_at": 1393389853,
+            "last_reminded_at": 1393389852
+        }],
+        "cc_email_addresses": []
+    },
+
+    "warnings": [
+      {
+        "warning_msg": "No data provided for custom field checkbox, will default to false.",
+        "warning_name": "parameter_missing"
+        }
+      ]
+}

data/spec/fixtures/signature_requests.json

@@ -0,0 +1,44 @@
+{
+    "list_info": {
+        "page": 1,
+        "num_pages": 1,
+        "num_results": 1,
+        "page_size": 20
+    },
+    "signature_requests": [{
+        "signature_request_id": "1",
+        "title": "title",
+        "original_title": "original_title",
+        "subject": "subject",
+        "message": "message",
+        "test_mode": false,
+        "is_complete": true,
+        "has_error": false,
+        "custom_fields": [],
+        "response_data": [{
+            "name": "name",
+            "value": "value",
+            "type": "signature",
+            "api_id": "api_id",
+            "signature_id": "signature_id"
+        }],
+        "signing_url": "https://example.com/signing_url",
+        "signing_redirect_url": "https://example.com/signing_redirect_url",
+        "final_copy_uri": "/v3/final_copy_url",
+        "files_url": "https://example.com/file_url",
+        "details_url": "https://example.com/details_url",
+        "requester_email_address": "requester_email_address@example.com",
+        "signatures": [{
+            "signature_id": "signature_id",
+            "has_pin": false,
+            "signer_email_address": "signer_email_address@example.com",
+            "signer_name": "signer_name",
+            "order": 1,
+            "status_code": "signed",
+            "signed_at": 1393389891,
+            "last_viewed_at": 1393389853,
+            "last_reminded_at": 1393389852
+        }],
+        "cc_email_addresses": []
+    }]
+}

data/spec/fixtures/team.json

@@ -0,0 +1,15 @@
+{
+    "team": {
+        "name": "Team HelloSign",
+        "accounts": [{
+            "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
+            "email_address": "me@example.com",
+            "role_code": "a"
+        }, {
+            "account_id": "d3d3d7b98d80b67d07740df7cdfd1f49fa8e2b82",
+            "email_address": "teammate@example.com",
+            "role_code": "m"
+        }],
+        "invited_accounts": []
+    }
+}

data/spec/fixtures/template.json

@@ -0,0 +1,53 @@
+{
+    "template": {
+        "template_id": "a364138e0d8ae6393aa425a8ec64715580f3748b",
+        "title": "bitcoin",
+        "message": "Hello, bitcoin pdf here",
+        "is_creator": true,
+        "can_edit": true,
+        "signer_roles": [{
+            "name": "Client",
+            "order": null
+        }],
+        "cc_roles": [],
+        "documents": [{
+            "index": "0",
+            "name": "bitcoin.pdf",
+            "custom_fields": [],
+            "form_fields": [{
+                "name": "",
+                "type": "signature",
+                "signer": "1",
+                "x": 501,
+                "y": 7498,
+                "width": 120,
+                "height": 30,
+                "required": true,
+                "api_id": "a1ca72_9"
+            }]
+        }],
+        "custom_fields": [],
+        "named_form_fields": [{
+            "name": "",
+            "type": "signature",
+            "signer": "1",
+            "x": 501,
+            "y": 7498,
+            "width": 120,
+            "height": 30,
+            "required": true,
+            "api_id": "a1ca72_9"
+        }],
+        "accounts": [{
+            "account_id": "a82bbf8a2fb928f239e2bd59df50e23b82b3eedd",
+            "email_address": "testuser@example.com",
+            "is_paid_hs": false,
+            "is_paid_hf": false,
+            "quotas": {
+                "templates_left": 0,
+                "documents_left": 3,
+                "api_signature_requests_left": 0
+            }
+        }]
+    }
+}

data/spec/fixtures/templates.json

@@ -0,0 +1,59 @@
+{
+    "list_info": {
+        "page": 1,
+        "num_pages": 1,
+        "num_results": 1,
+        "page_size": 20
+    },
+    "templates": [{
+        "template_id": "a364138e0d8ae6393aa425a8ec64715580f3748b",
+        "title": "bitcoin",
+        "message": "Hello, bitcoin pdf here",
+        "is_creator": true,
+        "can_edit": true,
+        "signer_roles": [{
+            "name": "Client",
+            "order": null
+        }],
+        "cc_roles": [],
+        "documents": [{
+            "index": "0",
+            "name": "bitcoin.pdf",
+            "custom_fields": [],
+            "form_fields": [{
+                "name": "",
+                "type": "signature",
+                "signer": "1",
+                "x": 501,
+                "y": 7498,
+                "width": 120,
+                "height": 30,
+                "required": true,
+                "api_id": "a1ca72_9"
+            }]
+        }],
+        "custom_fields": [],
+        "named_form_fields": [{
+            "name": "",
+            "type": "signature",
+            "signer": "1",
+            "x": 501,
+            "y": 7498,
+            "width": 120,
+            "height": 30,
+            "required": true,
+            "api_id": "a1ca72_9"
+        }],
+        "accounts": [{
+            "account_id": "a82bbf8a2fb928f239e2bd59df50e23b82b3eedd",
+            "email_address": "testuser@example.com",
+            "is_paid_hs": false,
+            "is_paid_hf": false,
+            "quotas": {
+                "templates_left": 0,
+                "documents_left": 3,
+                "api_signature_requests_left": 0
+            }
+        }]
+    }]
+}

data/spec/fixtures/token.json

@@ -0,0 +1,14 @@
+{
+    "account": {
+        "account_id": "b4680b45053c7601ca1eee3b126eca6b2b0a0219",
+        "email_address": "jill@example.com",
+        "callback_url": null,
+        "role_code": null
+    },
+    "oauth_data": {
+        "access_token": "NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc=",
+        "token_type": "Bearer",
+        "refresh_token": "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3",
+        "expires_in": 86400
+    }
+}

data/spec/fixtures/unclaimed_draft.json

@@ -0,0 +1,6 @@
+{
+    "unclaimed_draft": {
+        "claim_url": "https:\/\/www.hellosign.com\/send\/resendDocs?root_snapshot_guids[]=7f967b7d06e154394eab693febedf61e8ebe49eb&snapshot_access_guids[]=fb848631&root_snapshot_guids[]=7aedaf31e12edf9f2672a0b2ddf028aca670e101&snapshot_access_guids[]=f398ef87",
+        "signing_redirect_url": null
+    }
+}

data/spec/hello_sign/api/account_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe HelloSign::Api::Account do
+  describe '#get_account' do
+    before do
+      stub_get('/account', 'account')
+      @account = HelloSign.get_account
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/account')).to have_been_made
+    end
+
+    it 'should have response headers' do
+      expect(@account.headers).to_not be_nil
+    end
+
+    it 'should return current user account' do
+      expect(@account).to be_an HelloSign::Resource::Account
+    end
+  end
+
+  describe '#create_account' do
+    before do
+      stub_post('/account/create', 'account')
+      @body = { email_address: 'test@example.com' }
+      @account = HelloSign.create_account @body
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/account/create')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@account.headers).to_not be_nil
+    end
+
+    it 'should return information about a created account' do
+      expect(@account.email_address).to eql('test@example.com')
+    end
+  end
+end

data/spec/hello_sign/api/api_app_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe HelloSign::Api::ApiApp do
+
+  describe '#get_api_app' do
+    before do
+      stub_get('/api_app/5e365c014bea2e9a05a9d0834f3e7ca4', 'api_app')
+      @api_app = HelloSign.get_api_app :client_id => '5e365c014bea2e9a05a9d0834f3e7ca4'
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/api_app/5e365c014bea2e9a05a9d0834f3e7ca4')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@api_app.headers).to_not be_nil
+    end
+
+    it 'should return current user account' do
+      expect(@api_app).to be_an HelloSign::Resource::ApiApp
+    end
+  end
+
+  describe '#list_api_apps' do
+    before do
+      stub_get('/api_app/list', 'api_apps')
+      @api_apps = HelloSign.get_api_apps({})
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/api_app/list')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@api_apps.headers).to_not be_nil
+    end
+
+    it 'should return a Resource Array' do
+      expect(@api_apps).to be_an HelloSign::Resource::ResourceArray
+    end
+
+    it 'each of Array is an ApiApp' do
+      expect(@api_apps[0]).to be_an HelloSign::Resource::ApiApp
+    end
+  end
+
+  describe '#create_api_app' do
+    before do
+      stub_post('/api_app', 'api_app')
+      @api_app = HelloSign.create_api_app(
+        :name => 'Herbert App',
+        :domain => 'herbert.com',
+        :white_labeling_options => {"primary_button_color":"#00b3e6","primary_button_text_color":"#ffffff"}
+      )
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/api_app')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@api_app.headers).to_not be_nil
+    end
+
+    it 'should return an ApiApp' do
+      expect(@api_app).to be_an HelloSign::Resource::ApiApp
+    end
+  end
+
+  describe '#update_api_app' do
+    before do
+      stub_post('/api_app/5e365c014bea2e9a05a9d0834f3e7ca4', 'api_app')
+      @api_app = HelloSign.update_api_app(
+        :client_id => '5e365c014bea2e9a05a9d0834f3e7ca4',
+        :name => 'Herbert App',
+        :domain => 'herbert.com'
+      )
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/api_app/5e365c014bea2e9a05a9d0834f3e7ca4')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@api_app.headers).to_not be_nil
+    end
+
+    it 'should return an ApiApp' do
+      expect(@api_app).to be_an HelloSign::Resource::ApiApp
+    end
+  end
+
+  describe '#delete_api_app' do
+    before do
+      stub_delete('/api_app/1', 'api_app')
+      @api_app = HelloSign.delete_api_app(:client_id => '1')
+    end
+
+    it 'should get the correct resource' do
+      expect(a_delete('/api_app/1')).to have_been_made
+    end
+  end
+
+end

data/spec/hello_sign/api/bulk_send_job_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe HelloSign::Api::BulkSendJob do
+  describe '#get_bulk_send_job' do
+    before do
+      stub_get('/bulk_send_job/1', 'bulk_send_job')
+      @bulk_send = HelloSign.get_bulk_send_job :bulk_send_job_id => 1
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/bulk_send_job/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@bulk_send.headers).to_not be_nil
+    end
+
+    it 'should return a Bulk Send Job' do
+      expect(@bulk_send).to be_an HelloSign::Resource::BulkSendJob
+    end
+  end
+
+  describe '#get_bulk_send_jobs' do
+    before do
+      stub_get('/bulk_send_job/list', 'bulk_send_jobs')
+      @bulk_send_jobs = HelloSign.get_bulk_send_jobs({})
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/bulk_send_job/list')).to have_been_made
+    end
+
+    it 'returns reponse headers' do
+      expect(@bulk_send_jobs.headers).to_not be_nil
+    end
+
+    it 'should return a ResourceArray' do
+      expect(@bulk_send_jobs).to be_an HelloSign::Resource::ResourceArray
+    end
+
+    it 'each of Array is a BulkSendJob' do
+      expect(@bulk_send_jobs[0]).to be_an HelloSign::Resource::BulkSendJob
+    end
+
+    it 'should return list_info as a BaseResource in results' do
+      expect(@bulk_send_jobs[0].list_info).to be_an HelloSign::Resource::BaseResource
+    end
+
+    it 'should return page numbers as an integer' do
+      expect(@bulk_send_jobs[0].list_info.page).to be_an Integer
+    end
+  end
+end

data/spec/hello_sign/api/embedded_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe HelloSign::Api::Embedded do
+  describe '#get_embedded_sign_url' do
+    let(:signature_id) { '50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b' }
+    before do
+      stub_get("/embedded/sign_url/#{signature_id}", 'embedded')
+      @embedded = HelloSign.get_embedded_sign_url :signature_id => signature_id
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get("/embedded/sign_url/#{signature_id}")).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@embedded.headers).to_not be_nil
+    end
+
+    it 'should return a UnclaimedDraft' do
+      expect(@embedded).to be_an HelloSign::Resource::Embedded
+    end
+  end
+end

data/spec/hello_sign/api/oauth_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe HelloSign::Api::Account do
+  describe '#get_oauth_token' do
+    context 'when successful request' do
+      before do
+        stub_post_oauth('/oauth/token', 'token')
+        @oauth_info = HelloSign.get_oauth_token :state => 'state', :code => 'code'
+      end
+
+      it 'should get the correct resource' do
+        expect(a_post_oauth('/oauth/token')).to have_been_made
+      end
+    end
+  end
+
+  describe '#refresh_oauth_token' do
+    before do
+      stub_post_oauth('/oauth/token', 'token')
+      @oauth_info = HelloSign.refresh_oauth_token refresh_token: 'oauth_token'
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post_oauth('/oauth/token')).to have_been_made
+    end
+  end
+end