hello_sign 0.3.0 → 0.4.0

data/spec/shared_examples/proxy.rb

@@ -0,0 +1,49 @@
+shared_examples_for 'a proxy' do
+  let(:proxy_source) { double('proxy source') }
+  let(:proxy)        { double('proxy') }
+
+  describe "#account" do
+    before { client.account_proxy_source = proxy_source }
+
+    it "returns an account proxy" do
+      proxy_source.should_receive(:new).with(client).and_return(proxy)
+      expect(client.account).to eq proxy
+    end
+  end
+
+  describe "#signature_request" do
+    before { client.signature_request_proxy_source = proxy_source }
+
+    it "returns an signature request proxy" do
+      proxy_source.should_receive(:new).with(client).and_return(proxy)
+      expect(client.signature_request).to eq proxy
+    end
+  end
+
+  describe "#reusable_form" do
+    before { client.reusable_form_proxy_source = proxy_source }
+
+    it "returns an reusable form proxy" do
+      proxy_source.should_receive(:new).with(client).and_return(proxy)
+      expect(client.reusable_form).to eq proxy
+    end
+  end
+
+  describe "#team" do
+    before { client.team_proxy_source = proxy_source }
+
+    it "returns an team proxy" do
+      proxy_source.should_receive(:new).with(client).and_return(proxy)
+      expect(client.team).to eq proxy
+    end
+  end
+
+  describe "#unclaimed_draft" do
+    before { client.unclaimed_draft_proxy_source = proxy_source }
+
+    it "returns an unclaimed draft proxy" do
+      proxy_source.should_receive(:new).with(client).and_return(proxy)
+      expect(client.unclaimed_draft).to eq proxy
+    end
+  end
+end

data/spec/unit/client_spec.rb

@@ -1,20 +1,14 @@
 require 'helper'
-require 'json'
 require 'hello_sign/client'
+require 'shared_examples/proxy'
 
 describe HelloSign::Client do
-  let(:connection) { double('connection') }
-  subject(:client) { HelloSign::Client.new('david@bowman.com', 'space') }
+  subject(:hs_client) { HelloSign::Client.new('david@bowman.com', 'space') }
 
-  describe "#email" do
-    it "returns the email address" do
-      expect(client.email).to eq 'david@bowman.com'
-    end
-  end
+  its(:email)    { should eq 'david@bowman.com' }
+  its(:password) { should eq 'space' }
 
-  describe "#password" do
-    it "returns the password" do
-      expect(client.password).to eq 'space'
-    end
+  it_behaves_like 'a proxy' do
+    let(:client) { hs_client }
   end
 end

data/spec/unit/hello_sign_spec.rb

@@ -2,29 +2,13 @@ require 'helper'
 require 'hello_sign'
 
 describe HelloSign do
-  describe "::account" do
-    it "returns an account proxy" do
-      expect(HelloSign.account).to be_a HelloSign::AccountProxy
-    end
-  end
-
-  describe "::signature_request" do
-    it "returns a signature request proxy" do
-      expect(HelloSign.signature_request).to be_a HelloSign::SignatureRequestProxy
-    end
-  end
-
-  describe "::reusable_form" do
-    it "returns a reusable form proxy" do
-      expect(HelloSign.reusable_form).to be_a HelloSign::ReusableFormProxy
-    end
+  before do
+    HelloSign.email    = 'hal@jupiter.com'
+    HelloSign.password = 'human_domination'
   end
 
-  describe "::team" do
-    it "returns a team proxy" do
-      expect(HelloSign.team).to be_a HelloSign::TeamProxy
-    end
-  end
+  its(:email)    { should eq 'hal@jupiter.com' }
+  its(:password) { should eq 'human_domination' }
 
   describe "::client" do
     context "when it has not previously been called" do
@@ -34,9 +18,23 @@ describe HelloSign do
     end
 
     context "when it has previously been called" do
+      before { @client = HelloSign.client }
+
       it "returns the same client" do
-        client = HelloSign.client
-        expect(HelloSign.client).to be client
+        expect(HelloSign.client).to be @client
+      end
+
+      context "and the email and password changes" do
+        before do
+          HelloSign.email    = 'bob@earth.com'
+          HelloSign.password = 'being_human'
+        end
+
+        it "creates a new client with the new credentials" do
+          expect(HelloSign.client).to_not be @client
+          expect(HelloSign.client.email).to eq 'bob@earth.com'
+          expect(HelloSign.client.password).to eq 'being_human'
+        end
       end
     end
   end
@@ -48,20 +46,4 @@ describe HelloSign do
       end
     end
   end
-
-  describe "::email" do
-    it "sets and returns the email address" do
-      HelloSign.email = 'hal@jupiter.com'
-
-      expect(HelloSign.email).to eq 'hal@jupiter.com'
-    end
-  end
-
-  describe "::password" do
-    it "sets and returns the password" do
-      HelloSign.password = 'human_domination'
-
-      expect(HelloSign.password).to eq 'human_domination'
-    end
-  end
 end

data/spec/unit/parameters/unclaimed_draft_spec.rb

@@ -0,0 +1,25 @@
+require 'helper'
+require 'hello_sign/parameters/unclaimed_draft'
+
+describe HelloSign::Parameters::UnclaimedDraft do
+  describe "#formatted" do
+    let(:draft_parameters) { HelloSign::Parameters::UnclaimedDraft.new }
+    let(:text_file)        { double('text file') }
+    let(:image_file)       { double('image file') }
+    let(:expected)         { {:file => {0 => text_file, 1 => image_file}} }
+
+    before do
+      Faraday::UploadIO.should_receive(:new).with('text file IO object', 'text/plain', 'test.txt').and_return(text_file)
+      Faraday::UploadIO.should_receive(:new).with('image file IO object', 'image/jpeg', 'test.jpg').and_return(image_file)
+
+      draft_parameters.files = [
+        {:name => 'test.txt', :io => 'text file IO object',  :mime => 'text/plain'},
+        {:name => 'test.jpg', :io => 'image file IO object', :mime => 'image/jpeg'}
+      ]
+    end
+
+    it "returns formatted parameters" do
+      expect(draft_parameters.formatted).to eq expected
+    end
+  end
+end

data/spec/unit/{account_proxy_spec.rb → proxy/account_spec.rb}

@@ -1,15 +1,11 @@
 require 'helper'
-require 'hello_sign/account_proxy'
+require 'hello_sign/proxy/account'
 
-describe HelloSign::AccountProxy do
+describe HelloSign::Proxy::Account do
   let(:client)            { double('client') }
-  subject(:account_proxy) { HelloSign::AccountProxy.new(client) }
+  subject(:account_proxy) { HelloSign::Proxy::Account.new(client) }
 
-  describe "#client" do
-    it "returns the client" do
-      expect(account_proxy.client).to be client
-    end
-  end
+  its(:client) { should eq client }
 
   describe "#create" do
     context "when passed the proper parameters" do

data/spec/unit/{reusable_form_proxy_spec.rb → proxy/reusable_form_spec.rb}

@@ -1,11 +1,11 @@
 require 'helper'
-require 'hello_sign/reusable_form_proxy'
+require 'hello_sign/proxy/reusable_form'
 
-describe HelloSign::ReusableFormProxy do
+describe HelloSign::Proxy::ReusableForm do
   let(:client)       { double('client') }
   let(:api_response) { double('API response') }
   let(:form_id)      { 'form_id' }
-  subject(:rf_proxy) { HelloSign::ReusableFormProxy.new(client) }
+  subject(:rf_proxy) { HelloSign::Proxy::ReusableForm.new(client) }
 
   describe "#client" do
     it "returns the client" do

data/spec/unit/{settings_proxy_spec.rb → proxy/settings_spec.rb}

@@ -1,9 +1,9 @@
 require 'helper'
-require 'hello_sign/settings_proxy'
+require 'hello_sign/proxy/settings'
 
-describe HelloSign::SettingsProxy do
+describe HelloSign::Proxy::Settings do
   let(:client)       { double('client') }
-  subject(:settings) { HelloSign::SettingsProxy.new(client) }
+  subject(:settings) { HelloSign::Proxy::Settings.new(client) }
 
   describe "#client" do
     it "returns the client" do

data/spec/unit/proxy/signature_request_spec.rb

@@ -0,0 +1,149 @@
+require 'helper'
+require 'hello_sign/proxy/signature_request'
+
+describe HelloSign::Proxy::SignatureRequest do
+  let(:client)       { double('client') }
+  let(:request_id)   { 'request_id' }
+  let(:api_response) { double('API response') }
+  subject(:sr_proxy) { HelloSign::Proxy::SignatureRequest.new(client) }
+
+  its(:client) { should eq client }
+
+  describe "#deliver" do
+    let(:formatted_request_body) { double('formatted request body') }
+    let(:request_parameters)     { double('request parameters') }
+
+    before do
+      request_parameters.stub(:foo=)
+      request_parameters.stub(:formatted).and_return(formatted_request_body)
+      sr_proxy.request_parameters = request_parameters
+
+      client.stub(:post).and_return(api_response)
+    end
+
+    it "yields the request parameters to the block" do
+      request_parameters.should_receive(:foo=).with('bar')
+      sr_proxy.deliver { |params| params.foo = 'bar' }
+    end
+
+    it "sends a signature request" do
+      client.should_receive(:post)
+        .with('/signature_request/send', :body => formatted_request_body)
+      sr_proxy.deliver { |params| params.foo = 'bar' }
+    end
+
+    it "returns the response" do
+      expect(sr_proxy.deliver {}).to eq api_response
+    end
+
+    context "when a reusable form is specified" do
+      before do
+        request_parameters.stub(:reusable_form_id=)
+        sr_proxy.reusable_form_request_parameters = request_parameters
+      end
+
+      it "sets the reusable form ID in the request parameters" do
+        request_parameters.should_receive(:reusable_form_id=).with('form_id')
+        sr_proxy.deliver(:form => 'form_id') {}
+      end
+
+      it "sends a reusable form signature request" do
+        client.should_receive(:post)
+          .with('/signature_request/send_with_reusable_form', :body => formatted_request_body)
+        sr_proxy.deliver(:form => 'form_id') {}
+      end
+
+      it "returns the response" do
+        expect(sr_proxy.deliver(:form => 'form_id') {}).to eq api_response
+      end
+    end
+  end
+
+  describe "#status" do
+    it "fetches the signature request status" do
+      client.should_receive(:get)
+        .with('/signature_request/request_id')
+      sr_proxy.status(request_id)
+    end
+
+    it "returns the response" do
+      client.stub(:get).and_return(api_response)
+      expect(sr_proxy.status(request_id)).to eq api_response
+    end
+  end
+
+  describe "#list" do
+    context "when called without a page number" do
+      it "fetches the first page of signature requests" do
+        client.should_receive(:get)
+          .with('/signature_request/list', :params => {:page => 1})
+        sr_proxy.list
+      end
+
+      it "returns the response" do
+        client.stub(:get).and_return(api_response)
+        expect(sr_proxy.list).to eq api_response
+      end
+    end
+
+    context "when called with a page number" do
+      it "fetches a list of signature requests from the specified page" do
+        client.should_receive(:get)
+          .with('/signature_request/list', :params => {:page => 10})
+        sr_proxy.list(:page => 10)
+      end
+
+      it "returns the response" do
+        client.stub(:get).and_return(api_response)
+        expect(sr_proxy.list(:page => 10)).to eq api_response
+      end
+    end
+  end
+
+  describe "#remind" do
+    let(:email) { 'john@johnson.com' }
+
+    it "sends a signature request reminder" do
+      client.should_receive(:post)
+        .with('/signature_request/remind/request_id', :body => {:email_address => email})
+      sr_proxy.remind(request_id, :email => email)
+    end
+
+    it "returns the response" do
+      client.stub(:post).and_return(api_response)
+      expect(sr_proxy.remind(request_id, :email => email)).to eq api_response
+    end
+
+    context "when called without an email address" do
+      it "raises an exception" do
+        expect { sr_proxy.remind(request_id) }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe "#cancel" do
+    it "cancels a signature request" do
+      client.should_receive(:post)
+        .with('/signature_request/cancel/request_id')
+      sr_proxy.cancel(request_id)
+    end
+
+    it "returns the response" do
+      client.stub(:post).and_return(api_response)
+      expect(sr_proxy.cancel(request_id)).to eq api_response
+    end
+  end
+
+  describe "#final_copy" do
+    it "fetches a final copy of the signature request" do
+      client.should_receive(:get)
+        .with('/signature_request/final_copy/request_id')
+      sr_proxy.final_copy(request_id)
+    end
+
+    it "returns the response" do
+      client.stub(:get).and_return(api_response)
+      expect(sr_proxy.final_copy(request_id)).to eq api_response
+    end
+  end
+end

data/spec/unit/{team_proxy_spec.rb → proxy/team_spec.rb}

@@ -1,10 +1,10 @@
 require 'helper'
-require 'hello_sign/team_proxy'
+require 'hello_sign/proxy/team'
 
-describe HelloSign::TeamProxy do
+describe HelloSign::Proxy::Team do
   let(:client)         { double('client') }
   let(:api_response)   { double('API response') }
-  subject(:team_proxy) { HelloSign::TeamProxy.new(client) }
+  subject(:team_proxy) { HelloSign::Proxy::Team.new(client) }
 
   before do
     client.stub(:get).and_return(api_response)

data/spec/unit/proxy/unclaimed_draft_spec.rb

@@ -0,0 +1,32 @@
+require 'helper'
+require 'hello_sign/proxy/unclaimed_draft'
+
+describe HelloSign::Proxy::UnclaimedDraft do
+  let(:client)       { double('client') }
+  let(:api_response) { double('API response') }
+  subject(:ud_proxy) { HelloSign::Proxy::UnclaimedDraft.new(client) }
+
+  describe "#client" do
+    it "returns the client" do
+      expect(ud_proxy.client).to be client
+    end
+  end
+
+  describe "#create" do
+    let(:formatted_request_body) { double('formatted request body') }
+    let(:draft_parameters)     { double('draft parameters') }
+
+    before do
+      ud_proxy.draft_parameters = draft_parameters
+      draft_parameters.stub(:formatted).and_return(formatted_request_body)
+      draft_parameters.should_receive(:foo=).with('bar')
+      client.should_receive(:post)
+        .with('/unclaimed_draft/create', :body => formatted_request_body)
+        .and_return(api_response)
+    end
+
+    it "sends a unclaimed draft creation request and returns the result" do
+      expect(ud_proxy.create { |params| params.foo = 'bar' }).to eq api_response
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hello_sign
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-30 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -82,14 +82,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/hello_sign/account_proxy.rb
 - lib/hello_sign/client.rb
 - lib/hello_sign/parameters/reusable_form_signature_request.rb
 - lib/hello_sign/parameters/signature_request.rb
-- lib/hello_sign/reusable_form_proxy.rb
-- lib/hello_sign/settings_proxy.rb
-- lib/hello_sign/signature_request_proxy.rb
-- lib/hello_sign/team_proxy.rb
+- lib/hello_sign/parameters/unclaimed_draft.rb
+- lib/hello_sign/proxy/account.rb
+- lib/hello_sign/proxy/reusable_form.rb
+- lib/hello_sign/proxy/settings.rb
+- lib/hello_sign/proxy/signature_request.rb
+- lib/hello_sign/proxy/team.rb
+- lib/hello_sign/proxy/unclaimed_draft.rb
+- lib/hello_sign/proxy.rb
 - lib/hello_sign/version.rb
 - lib/hello_sign.rb
 - spec/fixtures/test.jpg
@@ -102,15 +105,19 @@ files:
 - spec/integration/reusable_form_spec.rb
 - spec/integration/signature_request_spec.rb
 - spec/integration/team_spec.rb
-- spec/unit/account_proxy_spec.rb
+- spec/integration/unclaimed_draft_spec.rb
+- spec/shared_examples/proxy.rb
 - spec/unit/client_spec.rb
 - spec/unit/hello_sign_spec.rb
 - spec/unit/parameters/reusable_form_signature_request_spec.rb
 - spec/unit/parameters/signature_request_spec.rb
-- spec/unit/reusable_form_proxy_spec.rb
-- spec/unit/settings_proxy_spec.rb
-- spec/unit/signature_request_proxy_spec.rb
-- spec/unit/team_proxy_spec.rb
+- spec/unit/parameters/unclaimed_draft_spec.rb
+- spec/unit/proxy/account_spec.rb
+- spec/unit/proxy/reusable_form_spec.rb
+- spec/unit/proxy/settings_spec.rb
+- spec/unit/proxy/signature_request_spec.rb
+- spec/unit/proxy/team_spec.rb
+- spec/unit/proxy/unclaimed_draft_spec.rb
 homepage: http://www.github.com/craiglittle/hello_sign
 licenses: []
 post_install_message: 
@@ -131,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to the HelloSign API.
@@ -146,12 +153,16 @@ test_files:
 - spec/integration/reusable_form_spec.rb
 - spec/integration/signature_request_spec.rb
 - spec/integration/team_spec.rb
-- spec/unit/account_proxy_spec.rb
+- spec/integration/unclaimed_draft_spec.rb
+- spec/shared_examples/proxy.rb
 - spec/unit/client_spec.rb
 - spec/unit/hello_sign_spec.rb
 - spec/unit/parameters/reusable_form_signature_request_spec.rb
 - spec/unit/parameters/signature_request_spec.rb
-- spec/unit/reusable_form_proxy_spec.rb
-- spec/unit/settings_proxy_spec.rb
-- spec/unit/signature_request_proxy_spec.rb
-- spec/unit/team_proxy_spec.rb
+- spec/unit/parameters/unclaimed_draft_spec.rb
+- spec/unit/proxy/account_spec.rb
+- spec/unit/proxy/reusable_form_spec.rb
+- spec/unit/proxy/settings_spec.rb
+- spec/unit/proxy/signature_request_spec.rb
+- spec/unit/proxy/team_spec.rb
+- spec/unit/proxy/unclaimed_draft_spec.rb