hellosign-api 1.0.0

data/spec/hello_sign/api/signature_request_spec.rb

@@ -0,0 +1,268 @@
+require 'spec_helper'
+
+describe HelloSign::Api::SignatureRequest do
+  describe '#get_signature_request' do
+    before do
+      stub_get('/signature_request/1', 'signature_request')
+      @signature_request = HelloSign.get_signature_request :signature_request_id => 1
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/signature_request/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_request.headers).to_not be_nil
+    end
+
+    it 'should return a SignatureRequest' do
+      expect(@signature_request).to be_an HelloSign::Resource::SignatureRequest
+    end
+  end
+
+  describe '#get_signature_requests' do
+    before do
+      stub_get('/signature_request/list', 'signature_requests')
+      @signature_requests = HelloSign.get_signature_requests({})
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/signature_request/list')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_requests.headers).to_not be_nil
+    end
+
+    it 'should return a SignatureRequestArray' do
+      expect(@signature_requests).to be_an HelloSign::Resource::ResourceArray
+    end
+
+    it 'each of Array is an SignatureRequest' do
+      expect(@signature_requests[0]).to be_an HelloSign::Resource::SignatureRequest
+    end
+
+    it 'should return list_info as a BaseResource in results' do
+      expect(@signature_requests[0].list_info).to be_an HelloSign::Resource::BaseResource
+    end
+
+    it 'should return page numbers as an integer' do
+      expect(@signature_requests[0].list_info.page).to be_an Integer
+    end
+  end
+
+  describe '#send_signature_request' do
+    before do
+      stub_post('/signature_request/send', 'signature_request')
+      @signature_request = HelloSign.send_signature_request(
+        :files_url => ['http://hellosign.com/test.pdf'],
+        :signers => ['sss']
+      )
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/send')).to have_been_made
+    end
+
+    it 'should return a SignatureRequest' do
+      expect(@signature_request).to be_an HelloSign::Resource::SignatureRequest
+    end
+  end
+
+  describe '#remind_signature_request' do
+    before do
+      stub_post('/signature_request/remind/1', 'signature_request')
+      @signature_request = HelloSign.remind_signature_request(:signature_request_id => 1)
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/remind/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_request.headers).to_not be_nil
+    end
+
+    it 'should return response warnings' do
+      expect(@signature_request.warnings).to_not be_nil
+    end
+
+    it 'should return a SignatureRequest' do
+      expect(@signature_request).to be_an HelloSign::Resource::SignatureRequest
+    end
+  end
+
+  describe '#cancel_signature_request' do
+    before do
+      stub_post('/signature_request/cancel/1', 'signature_request')
+      @signature_request = HelloSign.cancel_signature_request(:signature_request_id => 1)
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/cancel/1')).to have_been_made
+    end
+  end
+
+  describe '#remove_signature_request' do
+    before do
+      stub_post('/signature_request/remove/1', 'signature_request')
+      @signature_request = HelloSign.remove_signature_request(:signature_request_id => 1)
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/remove/1')).to have_been_made
+    end
+  end
+
+  describe '#signature_request_files' do
+    before do
+      stub_get('/signature_request/files/1', 'file')
+      @files = HelloSign.signature_request_files(:signature_request_id => 1)
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/signature_request/files/1')).to have_been_made
+    end
+  end
+
+  describe '#signature_request_files with options' do
+    describe ':get_url' do
+      before do
+        stub_get('/signature_request/files/1?get_url=true', 'file')
+        @files = HelloSign.signature_request_files(:signature_request_id => 1, :get_url => true)
+      end
+
+      it 'should get the correct resource' do
+        expect(a_get('/signature_request/files/1?get_url=true')).to have_been_made
+      end
+    end
+
+    describe ':file_type' do
+      before do
+        stub_get('/signature_request/files/1?file_type=pdf', 'file')
+        @files = HelloSign.signature_request_files(:signature_request_id => 1, :file_type => 'pdf')
+      end
+
+      it 'should get the correct resource' do
+        expect(a_get('/signature_request/files/1?file_type=pdf')).to have_been_made
+      end
+    end
+
+    describe ':file_type and :get_url' do
+      before do
+        stub_get('/signature_request/files/1?file_type=pdf&get_url=true', 'file')
+        @files = HelloSign.signature_request_files(:signature_request_id => 1, :file_type => 'pdf', :get_url => true)
+      end
+
+      it 'should get the correct resource' do
+        expect(a_get('/signature_request/files/1?file_type=pdf&get_url=true')).to have_been_made
+      end
+    end
+  end
+
+  describe '#send_signature_request_with_template' do
+    before do
+      stub_post('/signature_request/send_with_template', 'signature_request')
+      @signature_request = HelloSign.send_signature_request_with_template({})
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/send_with_template')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_request.headers).to_not be_nil
+    end
+  end
+
+  describe '#create_embedded_signature_request' do
+    before do
+      stub_post('/signature_request/create_embedded', 'signature_request')
+      @signature_request = HelloSign.create_embedded_signature_request({})
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/create_embedded')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_request.headers).to_not be_nil
+    end
+  end
+
+  describe '#create_embedded_signature_request_with_template' do
+    before do
+      stub_post('/signature_request/create_embedded_with_template', 'signature_request')
+      @signature_request = HelloSign.create_embedded_signature_request_with_template({})
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/create_embedded_with_template')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_request.headers).to_not be_nil
+    end
+  end
+
+  describe '#release_on_hold_signature_request' do
+    before do
+      stub_post('/signature_request/release_hold/1', 'signature_request')
+      @signature_request = HelloSign.release_on_hold_signature_request(:signature_request_id => 1)
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/release_hold/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_request.headers).to_not be_nil
+    end
+
+    it 'should return a SignatureRequest' do
+      expect(@signature_request).to be_an HelloSign::Resource::SignatureRequest
+    end
+  end
+
+  describe '#update_signature_request' do
+    before do
+      stub_post('/signature_request/update/1', 'signature_request')
+      @signature_request = HelloSign.update_signature_request(
+        :signature_request_id => '1',
+        :signature_id => 'signature_id',
+        :email_address => 'updated_signer_email_address@example.com'
+        )
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/update/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_request.headers).to_not be_nil
+    end
+
+    it 'should return a Signature Request' do
+      expect(@signature_request).to be_a HelloSign::Resource::SignatureRequest
+    end
+  end
+
+  describe '#release_hold_signature_request' do
+    before do
+      stub_post('/signature_request/release_hold/1', 'signature_request')
+      @signature_request = HelloSign.release_hold_signature_request(:signature_request_id => 1)
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/release_hold/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@signature_request.headers).to_not be_nil
+    end
+
+    it 'should return a SignatureRequest' do
+      expect(@signature_request).to be_an HelloSign::Resource::SignatureRequest
+    end
+  end
+end

data/spec/hello_sign/api/team_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe HelloSign::Api::Team do
+  describe '#get_team' do
+    before do
+      stub_get('/team', 'team')
+      @team = HelloSign.get_team
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/team')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@team.headers).to_not be_nil
+    end
+
+    it 'should return user\'s team' do
+      expect(@team).to be_an HelloSign::Resource::Team
+    end
+  end
+
+  describe '#create_team' do
+    before do
+      stub_post('/team/create', 'team')
+      @team = HelloSign.create_team :name => 'Team HelloSign'
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/team/create')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@team.headers).to_not be_nil
+    end
+
+    it 'should return information about a created team' do
+      expect(@team.name).to eql('Team HelloSign')
+    end
+  end
+
+  describe '#update_team' do
+    before do
+      stub_post('/team', 'team')
+      @team = HelloSign.update_team :name => 'Team HelloSign'
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/team')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@team.headers).to_not be_nil
+    end
+
+    it 'should return information about a updated team' do
+      expect(@team.name).to eql('Team HelloSign')
+    end
+  end
+
+  describe '#destroy_team' do
+    before do
+      stub_post('/team/destroy', 'team')
+      @team = HelloSign.destroy_team
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/team/destroy')).to have_been_made
+    end
+  end
+
+  describe '#add_member_to_team' do
+    before do
+      stub_post('/team/add_member', 'team')
+      @team = HelloSign.add_member_to_team :email_address => 'george@example.com'
+    end
+
+    it 'should return response headers' do
+      expect(@team.headers).to_not be_nil
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/team/add_member')).to have_been_made
+    end
+  end
+
+  describe '#remove_member_from_team' do
+    before do
+      stub_post('/team/remove_member', 'team')
+      @team = HelloSign.remove_member_from_team :email_address => 'george@example.com'
+    end
+
+    it 'should return response headers' do
+      expect(@team.headers).to_not be_nil
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/team/remove_member')).to have_been_made
+    end
+  end
+end

data/spec/hello_sign/api/template_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+describe HelloSign::Api::Template do
+  describe '#get_template' do
+    before do
+      stub_get('/template/1', 'template')
+      @template = HelloSign.get_template :template_id => 1
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/template/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@template.headers).to_not be_nil
+    end
+
+    it 'should return a Template' do
+      expect(@template).to be_an HelloSign::Resource::Template
+    end
+  end
+
+  describe '#get_templates' do
+    before do
+      stub_get('/template/list', 'templates')
+      @template = HelloSign.get_templates({})
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/template/list')).to have_been_made
+    end
+
+    it 'returns reponse headers' do
+      expect(@template.headers).to_not be_nil
+    end
+
+    it 'should return a ResourceArray' do
+      expect(@template).to be_an HelloSign::Resource::ResourceArray
+    end
+
+    it 'each of Array is an Template' do
+      expect(@template[0]).to be_an HelloSign::Resource::Template
+    end
+
+    it 'should return list_info as a BaseResource in results' do
+      expect(@template[0].list_info).to be_an HelloSign::Resource::BaseResource
+    end
+
+    it 'should return page numbers as an integer' do
+      expect(@template[0].list_info.page).to be_an Integer
+    end
+  end
+
+  describe '#add_user_to_template' do
+    before do
+      stub_post('/template/add_user/1', 'template')
+      @template = HelloSign.add_user_to_template :template_id => 1
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/template/add_user/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@template.headers).to_not be_nil
+    end
+
+    it 'should return a Template' do
+      expect(@template).to be_an HelloSign::Resource::Template
+    end
+  end
+
+  describe '#remove_user_from_template' do
+    before do
+      stub_post('/template/remove_user/1', 'template')
+      @template = HelloSign.remove_user_from_template :template_id => 1
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/template/remove_user/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@template.headers).to_not be_nil
+    end
+
+    it 'should return a Template' do
+      expect(@template).to be_an HelloSign::Resource::Template
+    end
+  end
+
+  describe '#get_template_files' do
+    before do
+      stub_get('/template/files/1', 'file')
+      @files = HelloSign.get_template_files :template_id => 1
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/template/files/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@files[:headers]).to_not be_nil
+    end
+  end
+
+  describe '#get_template_files with options' do
+    describe ':get_url' do
+      before do
+        stub_get('/template/files/1?get_url=true', 'file')
+        @files = HelloSign.get_template_files :template_id => 1, :get_url => true
+      end
+
+      it 'should get the correct resource' do
+        expect(a_get('/template/files/1?get_url=true')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@files[:headers]).to_not be_nil
+      end
+    end
+
+    describe ':file_type' do
+      before do
+        stub_get('/template/files/1?file_type=pdf', 'file')
+        @files = HelloSign.get_template_files :template_id => 1, :file_type => 'pdf'
+      end
+
+      it 'should get the correct resource' do
+        expect(a_get('/template/files/1?file_type=pdf')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@files[:headers]).to_not be_nil
+      end
+    end
+
+    describe ':file_type and :get_url' do
+      before do
+        stub_get('/template/files/1?file_type=pdf&get_url=true', 'file')
+        @files = HelloSign.get_template_files :template_id => 1, :file_type => 'pdf', :get_url => true
+      end
+
+      it 'should get the correct resource' do
+        expect(a_get('/template/files/1?file_type=pdf&get_url=true')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@files[:headers]).to_not be_nil
+      end
+    end
+  end
+
+  describe '#update_template_files' do
+    before do
+      stub_post('/template/update_files/1', 'template')
+      @template = HelloSign.update_template_files :template_id => 1, :file_url => 'http://hellosign.com/test.pdf'
+    end
+
+    it 'should return a Template' do
+      expect(@template).to be_an HelloSign::Resource::Template
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/template/update_files/1')).to have_been_made
+    end
+
+    it 'should return response headers' do
+      expect(@template.headers).to_not be_nil
+    end
+  end
+end

data/spec/hello_sign/api/unclaimed_draft_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+describe HelloSign::Api::UnclaimedDraft do
+  describe '#create_unclaimed_draft' do
+    context 'send_document' do
+      before do
+        stub_post('/unclaimed_draft/create', 'unclaimed_draft')
+        @unclaimed_draft = HelloSign.create_unclaimed_draft({ :type => 'send_document' })
+      end
+
+      it 'should get the correct resource' do
+        expect(a_post('/unclaimed_draft/create')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@unclaimed_draft.headers).to_not be_nil
+      end
+
+      it 'should return a UnclaimedDraft' do
+        expect(@unclaimed_draft).to be_an HelloSign::Resource::UnclaimedDraft
+      end
+    end
+
+    context 'request_signature' do
+      before do
+        stub_post('/unclaimed_draft/create', 'unclaimed_draft')
+        @unclaimed_draft = HelloSign.create_unclaimed_draft({ :type => 'request_signature' })
+      end
+
+      it 'should get the correct resource' do
+        expect(a_post('/unclaimed_draft/create')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@unclaimed_draft.headers).to_not be_nil
+      end
+
+      it 'should return a UnclaimedDraft' do
+        expect(@unclaimed_draft).to be_an HelloSign::Resource::UnclaimedDraft
+      end
+    end
+
+    context 'edit_and_resend' do
+      before do
+        stub_post('/unclaimed_draft/edit_and_resend/1', 'unclaimed_draft')
+        @unclaimed_draft = HelloSign.edit_and_resend_unclaimed_draft(
+          :signature_request_id => '1',
+          :client_id => '5e365c014bea2e9a05a9d0834f3e7ca4'
+        )
+      end
+
+      it 'should get the correct resource' do
+        expect(a_post('/unclaimed_draft/edit_and_resend/1')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@unclaimed_draft.headers).to_not be_nil
+      end
+
+      it 'should return an UnclaimedDraft response' do
+        expect(@unclaimed_draft).to be_a HelloSign::Resource::UnclaimedDraft
+      end
+    end
+  end
+
+  describe '#create_embedded_unclaimed_draft' do
+    context 'send_document' do
+      before do
+        stub_post('/unclaimed_draft/create_embedded', 'unclaimed_draft')
+        @unclaimed_draft = HelloSign.create_embedded_unclaimed_draft({ :type => 'send_document' })
+      end
+
+      it 'should get the correct resource' do
+        expect(a_post('/unclaimed_draft/create_embedded')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@unclaimed_draft.headers).to_not be_nil
+      end
+
+      it 'should return a UnclaimedDraft' do
+        expect(@unclaimed_draft).to be_an HelloSign::Resource::UnclaimedDraft
+      end
+    end
+
+    context 'request_signature' do
+      before do
+        stub_post('/unclaimed_draft/create_embedded', 'unclaimed_draft')
+        @unclaimed_draft = HelloSign.create_embedded_unclaimed_draft({ :type => 'request_signature' })
+      end
+
+      it 'should get the correct resource' do
+        expect(a_post('/unclaimed_draft/create_embedded')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@unclaimed_draft.headers).to_not be_nil
+      end
+
+      it 'should return a UnclaimedDraft' do
+        expect(@unclaimed_draft).to be_an HelloSign::Resource::UnclaimedDraft
+      end
+    end
+  end
+
+  describe '#create_embedded_unclaimed_draft_with_template' do
+    context 'send_document' do
+      before do
+        stub_post('/unclaimed_draft/create_embedded_with_template', 'unclaimed_draft')
+        @unclaimed_draft = HelloSign.create_embedded_unclaimed_draft_with_template({})
+      end
+
+      it 'should get the correct resource' do
+        expect(a_post('/unclaimed_draft/create_embedded_with_template')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@unclaimed_draft.headers).to_not be_nil
+      end
+
+      it 'should return a UnclaimedDraft' do
+        expect(@unclaimed_draft).to be_an HelloSign::Resource::UnclaimedDraft
+      end
+    end
+
+    context 'request_signature' do
+      before do
+        stub_post('/unclaimed_draft/create_embedded_with_template', 'unclaimed_draft')
+        @unclaimed_draft = HelloSign.create_embedded_unclaimed_draft_with_template({})
+      end
+
+      it 'should get the correct resource' do
+        expect(a_post('/unclaimed_draft/create_embedded_with_template')).to have_been_made
+      end
+
+      it 'should return response headers' do
+        expect(@unclaimed_draft.headers).to_not be_nil
+      end
+
+      it 'should return a UnclaimedDraft' do
+        expect(@unclaimed_draft).to be_an HelloSign::Resource::UnclaimedDraft
+      end
+    end
+  end
+end