hellosign-ruby-sdk 3.0.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,36 @@
+  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 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", :password => "secret"}
+      @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 information about a created account" do
+      expect(@account.email_address).to eql("test@example.com")
+    end
+  end
+end

data/spec/hello_sign/api/embedded_spec.rb

@@ -0,0 +1,19 @@
+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 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,28 @@
+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 'oauth_token'
+    end
+
+    it "should get the correct resource" do
+      expect(a_post_oauth("/oauth/token")).to have_been_made
+    end
+  end
+end

data/spec/hello_sign/api/signature_request_spec.rb

@@ -0,0 +1,126 @@
+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 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 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
+  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 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 "#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 "#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
+  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
+  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
+  end
+end

data/spec/hello_sign/api/team_spec.rb

@@ -0,0 +1,94 @@
+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 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 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 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 "#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 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 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,67 @@
+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 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 "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
+  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 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 a Template" do
+      expect(@template).to be_an HelloSign::Resource::Template
+    end
+  end
+end

data/spec/hello_sign/api/unclaimed_draft_spec.rb

@@ -0,0 +1,35 @@
+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 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 a UnclaimedDraft" do
+        expect(@unclaimed_draft).to be_an HelloSign::Resource::UnclaimedDraft
+      end
+    end
+  end
+end

data/spec/hello_sign/client_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe HelloSign::Client do
+  describe "#initialize" do
+    context "with default values" do
+      subject(:client){HelloSign::Client.new}
+      HelloSign::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        it "should set #{key}" do
+          expect(client.send(key)).to eql(HelloSign.send(key))
+        end
+      end
+    end
+
+    context "with custom values" do
+      let(:custom_client){
+        {
+          :email_address => "email_address",
+          :password => "password",
+          :api_key => "api_key",
+          :user_agent => "user_agent",
+          :end_point => "end_point",
+          :oauth_end_point => "oauth_end_point",
+          :api_version => "api_version",
+          :client_id => "client_id",
+          :client_secret => "client_secret",
+          :auth_token => "auth_token",
+          :log_level => 5,
+          :logging => false
+        }
+      }
+      subject(:client){ HelloSign::Client.new custom_client}
+      HelloSign::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        it "should set #{key}" do
+          expect(client.send(key)).to eql(custom_client[key])
+        end
+      end
+    end
+  end
+
+  describe "#request" do
+    context "when response status >= 400" do
+      HelloSign::Client::ERRORS.keys.each do |key|
+        it "raise #{HelloSign::Client::ERRORS[key].to_s} when response status #{key}" do
+
+          # raise when post
+          stub_post("/account/create", 'error', key)
+          expect {
+            HelloSign.create_account :email_address => "test@example.com", :password => "password"
+          }.to raise_error(HelloSign::Client::ERRORS[key])
+
+          # raise when get
+          stub_get("/account", 'error', key)
+          expect {
+            HelloSign.get_account
+          }.to raise_error(HelloSign::Client::ERRORS[key])
+        end
+      end
+    end
+  end
+
+  describe "prepare" do
+    context "signers" do
+      describe "is an array" do
+        before do
+          stub_post("/signature_request/send", 'signature_request')
+        end
+
+        it "work correctly" do
+          expect(lambda{HelloSign.send_signature_request(
+            :files_url => ["http://hellosign.com/test.pdf"],
+            :signers => ["sss"]
+          )}).not_to raise_error
+        end
+      end
+
+      describe "is an Hash" do
+        before do
+          stub_post("/signature_request/send", 'signature_request')
+        end
+
+        it "work correctly" do
+          expect(lambda{HelloSign.send_signature_request(
+            :files_url => ["http://hellosign.com/test.pdf"],
+            :signers => [{
+              :email_address => 'jack@example.com',
+              :name => 'Jack',
+              :order => 0
+            },{
+              :email_address => 'jill@example.com',
+              :name => 'Jill',
+              :order => 1
+            }]
+          )}).not_to raise_error
+        end
+      end
+    end
+
+    context "ccs" do
+      describe "is an array" do
+        before do
+          stub_post("/signature_request/send_with_template", 'signature_request')
+        end
+
+        it "work correctly" do
+          expect(lambda{HelloSign.send_signature_request_with_template(
+            :ccs => ["sss"]
+          )}).not_to raise_error
+        end
+      end
+
+      describe "is an Hash" do
+        before do
+          stub_post("/signature_request/send_with_template", 'signature_request')
+        end
+
+        it "work correctly" do
+          expect(lambda{HelloSign.send_signature_request_with_template(
+            :ccs => [{
+              :email_address => 'jack@example.com',
+              :name => 'Jack',
+              :role => 'Manager'
+            },{
+              :email_address => 'jill@example.com',
+              :name => 'Jill',
+              :role => "Client"
+            }]
+          )}).not_to raise_error
+        end
+      end
+    end
+  end
+end