hellosign-ruby-sdk 3.7.5 → 3.7.6

data/lib/hello_sign/resource/resource_array.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,25 +19,23 @@
 # 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.
-#
 
 module HelloSign
   module Resource
-    #
     # Stores an array of HelloSign BaseResource with paging information
     #
     # @author [hellosign]
-    #
+
     class ResourceArray < Array
       attr_reader :page, :num_pages, :num_results, :page_size, :warnings, :headers, :list_info, :data
+
+      # Creates a new ResourceArray from a hash
       #
-      # create a new ResourceArray from a hash
-      #
-      # @param  hash [Hash] Data of the array.
-      # @param  key [String] Key of the hash, point to where resource array data is.
-      # @param  resource_class [Class] a ResourceClass object inherited from BaseResource. Uses the created array item from hash[key].
+      # @param hash [Hash] Data of the array.
+      # @param key [String] Key of the hash, point to where resource array data is.
+      # @param resource_class [Class] a ResourceClass object inherited from BaseResource. Uses the created array item from hash[key].
       #
-      # @return [type] [description]
+      # @return [HelloSign::Resource::ResourceArray] a ResourceArray
       def initialize(hash, key, resource_class)
         @headers = hash[:headers]
         @data = hash[:body]

data/lib/hello_sign/resource/signature_request.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,24 +19,22 @@
 # 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.
-#
 
 module HelloSign
   module Resource
-    #
-    # Contains information regarding documents that need to be signed.
-    # Take a look at our API Documentation for sending Signature Requests (https://app.hellosign.com/api/reference#SignatureRequest)
+    # Contains information about a SignatureRequest.
+    # Take a look at our API Documentation for Signature Requests (https://app.hellosign.com/api/reference#SignatureRequest)
     # for more information about this.
     #
     # @author [hellosign]
-    #
+
     class SignatureRequest < BaseResource
-      #
-      # create a new SignatureRequest from a hash. If a key is defined then account data with be the value of hash[key], otherwise the hash itself.
+
+      # Creates a new SignatureRequest from a hash. If a key is defined then account data with be the value of hash[key], otherwise the hash itself.
       # @param  hash [Hash] SignatureRequest's data
       # @param  key [String] (signature_request) Key of the hash, point to where SignatureRequest data is. If nil, then the hash itself.
       #
-      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest resource
+      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       def initialize(hash, key='signature_request')
         super
       end

data/lib/hello_sign/resource/team.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,24 +19,22 @@
 # 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.
-#
 
 module HelloSign
   module Resource
-    #
     # Contains information about a Team and its members.
     # Take a look at our API Documentation on the Team Resource (https://app.hellosign.com/api/reference#Team)
     # for more information about this.
     #
     # @author [hellosign]
-    #
+
     class Team < BaseResource
-      #
+
       # Creates a new Team from a hash. If a key is defined then team data with be the value of hash[key], otherwise the hash itself.
       # @param  hash [Hash] Team's data
       # @param  key [String] (team) Key of the hash, point to where Team data is. If nil, then the hash itself.
       #
-      # @return [HelloSign::Resource:Team] a Team resource
+      # @return [HelloSign::Resource::Team] a Team
       def initialize(hash, key='team')
         super
       end

data/lib/hello_sign/resource/template.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,24 +19,22 @@
 # 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.
-#
 
 module HelloSign
   module Resource
-    #
-    # Contains information about the templates you and your team have created
+    # Contains information about Templates.
     # Take a look at our API Documentation for Templates (https://app.hellosign.com/api/reference#Template)
     # for more information about this.
     #
     # @author [hellosign]
-    #
+
     class Template < BaseResource
-      #
-      # Creates a new Template from a hash. If a key is defined then template data will be the value of hash[key], otherwise the hash itself.
+
+      # Creates a new Template from a hash. If a key is defined then Template data will be the value of hash[key], otherwise the hash itself.
       # @param  hash [Hash] Template's data
       # @param  key [String] (template) Key of the hash, point to where Template data is. If nil, then the hash itself.
       #
-      # @return [HelloSign::Resource:Team] a Template resource
+      # @return [HelloSign::Resource::Template] a Template
       def initialize(hash, key='template')
         super
       end

data/lib/hello_sign/resource/template_draft.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,24 +19,22 @@
 # 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.
-#
 
 module HelloSign
   module Resource
-    #
-    # A group of documents that a user can take ownership of by going to the claim_url.
+    # Contains information about a TemplateDraft.
     # Take a look at our API Documentation for Templates (https://app.hellosign.com/api/reference#Template)
     # for more information about this.
     #
     # @author [hellosign]
-    #
+
     class TemplateDraft < BaseResource
-      #
+
       # Creates a new TemplateDraft from a hash. If a key is defined then TemplateDraft data will be the value of hash[key], otherwise the hash itself.
       # @param  hash [Hash] TemplateDraft's data
       # @param  key [String] (template_draft) Key of the hash, point to where TemplateDraft data is. If nil, then the hash itself.
       #
-      # @return [HelloSign::Resource:Team] a Team resource
+      # @return [HelloSign::Resource::TemplateDraft] a TemplateDraft
       def initialize(hash, key='template')
         super
       end

data/lib/hello_sign/resource/unclaimed_draft.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,26 +19,22 @@
 # 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.
-#
 
 module HelloSign
   module Resource
-
-    #
-    # A group of documents that a user can take ownership of by going to the claim_url.
-    # Take a look at our API documentation for creating UnclaimedDrafts (https://app.hellosign.com/api/reference#UnclaimedDraft)
+    # Contains information about an UnclaimedDraft.
+    # Take a look at our API documentation for the UnclaimedDraft resource (https://app.hellosign.com/api/reference#UnclaimedDraft)
     # for more information about this.
     #
     # @author [hellosign]
-    #
+
     class UnclaimedDraft < BaseResource
 
-      #
-      # create a new UnclaimedDraft from a hash. If a key is defined then UnclaimedDraft data with be the value of hash[key], otherwise the hash itself.
+      # Creates a new UnclaimedDraft from a hash. If a key is defined then UnclaimedDraft data with be the value of hash[key], otherwise the hash itself.
       # @param  hash [Hash] UnclaimedDraft's data
       # @param  key [String] (unclaimed_draft) Key of the hash, point to where UnclaimedDraft data is. If nil, then the hash itself.
       #
-      # @return [HelloSign::Resource:Team] an UnclaimedDraft resource
+      # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft
       def initialize(hash, key='unclaimed_draft')
         super
       end

data/lib/hello_sign/version.rb

@@ -1,4 +1,3 @@
-#
 # The MIT License (MIT)
 #
 # Copyright (C) 2014 hellosign.com
@@ -20,8 +19,7 @@
 # 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.
-#
 
 module HelloSign
-  VERSION = '3.7.5'
+  VERSION = '3.7.6'
 end

data/spec/fixtures/api_app.json

@@ -1,16 +1,16 @@
 {
 
   "api_app": {
-          "client_id" : "5e365c014bea2e9a05a9d0834f3e7ca4",
-         "created_at" : 1438030211,
-               "name" : "Hodor",
-             "domain" : "hodor.com",
-       "callback_url" : null,
-      "owner_account" : {
-             "account_id" : "626e28a7781d6d12bd830220488a45e9ef3378ab",
-          "email_address" : "hello@example.com"
+          "client_id": "5e365c014bea2e9a05a9d0834f3e7ca4",
+         "created_at": 1438030211,
+               "name": "Hodor",
+             "domain": "hodor.com",
+       "callback_url": null,
+      "owner_account": {
+             "account_id": "626e28a7781d6d12bd830220488a45e9ef3378ab",
+          "email_address": "hello@example.com"
       },
-        "is_approved" : false,
-              "oauth" : null
+        "is_approved": false,
+              "oauth": null
   }
 }

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/hello_sign/api/account_spec.rb

@@ -23,7 +23,7 @@ describe HelloSign::Api::Account do
   describe '#create_account' do
     before do
       stub_post('/account/create', 'account')
-      @body = { :email_address => 'test@example.com' }
+      @body = { email_address: 'test@example.com' }
       @account = HelloSign.create_account @body
     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_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 
-#
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # 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
@@ -22,7 +21,6 @@ require 'spec_helper'
 # 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.
-#
 
 describe HelloSign do
   after { HelloSign.reset }