hello_sign 0.5.0 → 0.6.0

data/lib/hello_sign/client.rb

@@ -12,9 +12,14 @@ module HelloSign
 
     attr_reader :email_address, :password
 
-    def initialize(email_address, password)
-      @email_address = email_address
-      @password      = password
+    def initialize(email_address_or_hash, password = nil)
+      if email_address_or_hash.is_a? Hash
+        @email_address = email_address_or_hash.fetch(:email_address) { raise ArgumentError }
+        @password      = email_address_or_hash.fetch(:password) { raise ArgumentError }
+      else
+        @email_address = email_address_or_hash
+        @password      = password
+      end
     end
 
     def get(path, options = {})
@@ -42,6 +47,7 @@ module HelloSign
 
         connection.request  :multipart
         connection.request  :url_encoded
+        connection.response :raise_error
         connection.response :multi_json, :symbolize_keys => true
         connection.adapter  :net_http
       end

data/lib/hello_sign/error.rb

@@ -0,0 +1,13 @@
+module HelloSign
+  class Error < StandardError
+    class BadRequest                   < HelloSign::Error; end
+    class Unauthorized                 < HelloSign::Error; end
+    class Forbidden                    < HelloSign::Error; end
+    class NotFound                     < HelloSign::Error; end
+    class Unknown                      < HelloSign::Error; end
+    class TeamInviteFailed             < HelloSign::Error; end
+    class InvalidRecipient             < HelloSign::Error; end
+    class ConvertFailed                < HelloSign::Error; end
+    class SignatureRequestCancelFailed < HelloSign::Error; end
+  end
+end

data/lib/hello_sign/middleware/raise_error.rb

@@ -0,0 +1,29 @@
+require 'hello_sign/error'
+
+require 'faraday'
+
+module HelloSign
+  module Middleware
+    class RaiseError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        body = env[:body] or return
+
+        if error = body[:error]
+          case error[:error_name]
+          when 'bad_request'                     then raise HelloSign::Error::BadRequest
+          when 'unauthorized'                    then raise HelloSign::Error::Unauthorized
+          when 'forbidden'                       then raise HelloSign::Error::Forbidden
+          when 'not_found'                       then raise HelloSign::Error::NotFound
+          when 'unknown'                         then raise HelloSign::Error::Unknown
+          when 'team_invite_failed'              then raise HelloSign::Error::TeamInviteFailed
+          when 'invalid_recipient'               then raise HelloSign::Error::InvalidRecipient
+          when 'convert_failed'                  then raise HelloSign::Error::ConvertFailed
+          when 'signature_request_cancel_failed' then raise HelloSign::Error::SignatureRequestCancelFailed
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/hello_sign/parameters/reusable_form_signature_request.rb

@@ -1,8 +1,23 @@
 module HelloSign
   module Parameters
     class ReusableFormSignatureRequest
-      attr_accessor :reusable_form_id, :title, :subject, :message
-      attr_writer :ccs, :signers, :custom_fields
+      attr_writer :reusable_form_id, :title, :subject, :message, :ccs, :signers, :custom_fields
+
+      def formatted
+        {
+          :reusable_form_id => reusable_form_id,
+          :title            => title,
+          :subject          => subject,
+          :message          => message,
+          :ccs              => ccs,
+          :signers          => signers,
+          :custom_fields    => custom_fields
+        }
+      end
+
+      private
+
+      attr_reader :reusable_form_id, :title, :subject, :message
 
       def ccs
         @ccs.inject({}) do |parameter, cc|
@@ -25,17 +40,6 @@ module HelloSign
         end
       end
 
-      def formatted
-        {
-          :reusable_form_id => reusable_form_id,
-          :title            => title,
-          :subject          => subject,
-          :message          => message,
-          :ccs              => ccs,
-          :signers          => signers,
-          :custom_fields    => custom_fields
-        }
-      end
     end
   end
 end

data/lib/hello_sign/parameters/unclaimed_draft.rb

@@ -5,6 +5,12 @@ module HelloSign
     class UnclaimedDraft
       attr_writer :files
 
+      def formatted
+        {:file => files}
+      end
+
+      private
+
       def files
         @files.each_with_index.inject({}) do |parameter, (file, index)|
           parameter[index] = upload_io.new(file[:io], file[:mime], file[:name])
@@ -12,12 +18,6 @@ module HelloSign
         end
       end
 
-      def formatted
-        {:file => files}
-      end
-
-      private
-
       def upload_io
         Faraday::UploadIO
       end

data/lib/hello_sign/version.rb

@@ -1,3 +1,3 @@
 module HelloSign
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/hello_sign.rb

@@ -1,3 +1,4 @@
+require 'hello_sign/middleware/raise_error'
 require 'hello_sign/client'
 require 'hello_sign/version'
 
@@ -9,16 +10,15 @@ module HelloSign
 
     attr_accessor :email_address, :password
 
-    delegate [:account, :signature_request, :reusable_form, :team,
-      :unclaimed_draft] => :client
+    delegate [:account, :signature_request, :reusable_form, :team, :unclaimed_draft] => :client
 
     def client
-      @client = Client.new(email_address, password) unless credentials_match?
+      @client = client_source.new(email_address, password) unless credentials_match?
       @client
     end
 
     def configure
-      yield(self)
+      yield self
     end
 
     private
@@ -27,5 +27,11 @@ module HelloSign
       @client && [@client.email_address, @client.password].hash == [email_address, password].hash
     end
 
+    def client_source
+      @client_source || HelloSign::Client
+    end
+
+    Faraday.register_middleware :response, :raise_error => HelloSign::Middleware::RaiseError
+
   end
 end

data/spec/helper.rb

@@ -6,3 +6,11 @@ RSpec.configure do |config|
   config.color_enabled = true
   config.tty           = true
 end
+
+class Module
+
+  def _set_internal_collaborator(role, collaborator)
+    instance_variable_set("@#{role.to_s}", collaborator)
+  end
+
+end

data/spec/integration/error_spec.rb

@@ -0,0 +1,50 @@
+require 'integration/helper'
+
+describe HelloSign do
+  let(:any_call) { HelloSign.team.show }
+
+  specify do
+    stub_request_with_error('bad_request')
+    expect { any_call }.to raise_error HelloSign::Error::BadRequest
+  end
+
+  specify do
+    stub_request_with_error('unauthorized')
+    expect { any_call }.to raise_error HelloSign::Error::Unauthorized
+  end
+
+  specify do
+    stub_request_with_error('forbidden')
+    expect { any_call }.to raise_error HelloSign::Error::Forbidden
+  end
+
+  specify do
+    stub_request_with_error('not_found')
+    expect { any_call }.to raise_error HelloSign::Error::NotFound
+  end
+
+  specify do
+    stub_request_with_error('unknown')
+    expect { any_call }.to raise_error HelloSign::Error::Unknown
+  end
+
+  specify do
+    stub_request_with_error('team_invite_failed')
+    expect { any_call }.to raise_error HelloSign::Error::TeamInviteFailed
+  end
+
+  specify do
+    stub_request_with_error('invalid_recipient')
+    expect { any_call }.to raise_error HelloSign::Error::InvalidRecipient
+  end
+
+  specify do
+    stub_request_with_error('convert_failed')
+    expect { any_call }.to raise_error HelloSign::Error::ConvertFailed
+  end
+
+  specify do
+    stub_request_with_error('signature_request_cancel_failed')
+    expect { any_call }.to raise_error HelloSign::Error::SignatureRequestCancelFailed
+  end
+end

data/spec/integration/helper.rb

@@ -24,6 +24,10 @@ def stub_post_with_auth(path)
   stub_request(:post, "https://david@bowman.com:foobar@api.hellosign.com/v3#{path}")
 end
 
+def stub_request_with_error(error)
+  stub_request(:any, /api\.hellosign\.com/).to_return(:body => {:error => {:error_name => error}})
+end
+
 def a_get(path)
   a_request(:get, "https://api.hellosign.com/v3#{path}")
 end

data/spec/unit/client_spec.rb

@@ -3,12 +3,59 @@ require 'hello_sign/client'
 require 'shared_examples/proxy'
 
 describe HelloSign::Client do
-  subject(:hs_client) { HelloSign::Client.new('david@bowman.com', 'space') }
+  let(:email_address) { double('email_address') }
+  let(:password)      { double('password') }
+  subject(:hs_client) { HelloSign::Client.new(email_address, password) }
 
-  its(:email_address) { should eq 'david@bowman.com' }
-  its(:password)      { should eq 'space' }
+  its(:email_address) { should eq email_address }
+  its(:password)      { should eq password }
 
   it_behaves_like 'a proxy' do
     let(:client) { hs_client }
   end
+
+  describe "request methods" do
+    let(:path)     { double('path') }
+    let(:options)  { double('options') }
+    let(:response) { double('response') }
+
+    before { hs_client.stub(:request).and_return(response) }
+
+    describe "#get" do
+      it "sends a request" do
+        hs_client.should_receive(:request).with(:get, path, options)
+        hs_client.get(path, options)
+      end
+
+      it "returns the response" do
+        expect(hs_client.get(path, options)).to eq response
+      end
+    end
+
+    describe "#post" do
+      it "sends a request" do
+        hs_client.should_receive(:request).with(:post, path, options)
+        hs_client.post(path, options)
+      end
+
+      it "returns the response" do
+        expect(hs_client.post(path, options)).to eq response
+      end
+    end
+  end
+
+  context "when a hash is passed to the constructor" do
+    subject(:hs_client) { HelloSign::Client.new(:email_address => email_address, :password => password) }
+
+    its(:email_address) { should eq email_address }
+    its(:password)      { should eq password }
+
+    it "raises an exception if an email address is not provided" do
+      expect { HelloSign::Client.new(:password => 'space') }.to raise_error ArgumentError
+    end
+
+    it "raises an exception if a password is not provided" do
+      expect { HelloSign::Client.new(:email_address => 'david@bowman.com') }.to raise_error ArgumentError
+    end
+  end
 end

data/spec/unit/error_spec.rb

@@ -0,0 +1,15 @@
+require 'helper'
+require 'hello_sign/error'
+
+describe HelloSign::Error do
+  specify { expect { raise HelloSign::Error }.to raise_error StandardError }
+  specify { expect { raise HelloSign::Error::BadRequest }.to raise_error HelloSign::Error }
+  specify { expect { raise HelloSign::Error::Unauthorized }.to raise_error HelloSign::Error }
+  specify { expect { raise HelloSign::Error::Forbidden }.to raise_error HelloSign::Error }
+  specify { expect { raise HelloSign::Error::NotFound }.to raise_error HelloSign::Error }
+  specify { expect { raise HelloSign::Error::Unknown }.to raise_error HelloSign::Error }
+  specify { expect { raise HelloSign::Error::TeamInviteFailed }.to raise_error HelloSign::Error }
+  specify { expect { raise HelloSign::Error::InvalidRecipient }.to raise_error HelloSign::Error }
+  specify { expect { raise HelloSign::Error::ConvertFailed }.to raise_error HelloSign::Error }
+  specify { expect { raise HelloSign::Error::SignatureRequestCancelFailed }.to raise_error HelloSign::Error }
+end

data/spec/unit/hello_sign_spec.rb

@@ -2,43 +2,95 @@ require 'helper'
 require 'hello_sign'
 
 describe HelloSign do
+  let(:email_address) { double('email address') }
+  let(:password)      { double('password') }
+
   before do
-    HelloSign.email_address = 'hal@jupiter.com'
-    HelloSign.password      = 'human_domination'
+    HelloSign.email_address = email_address
+    HelloSign.password      = password
   end
 
-  its(:email_address) { should eq 'hal@jupiter.com' }
-  its(:password)      { should eq 'human_domination' }
+  its(:email_address) { should eq email_address }
+  its(:password)      { should eq password }
 
   describe "::client" do
-    context "when it has not previously been called" do
-      it "returns a new client" do
-        expect(HelloSign.client).to be_a HelloSign::Client
-      end
+    let(:client_source) { double('client_source') }
+    let(:client)        { double('client') }
+
+    before do
+      HelloSign._set_internal_collaborator(:client_source, client_source)
+      client_source.stub(:new).and_return(client)
+    end
+
+    after { HelloSign.instance_variable_set(:@client, nil) }
+
+    its(:client) { should be client }
+
+    it "passes the credentials when creating the client" do
+      client_source.should_receive(:new).with(email_address, password)
+      HelloSign.client
     end
 
     context "when it has previously been called" do
-      before { @client = HelloSign.client }
+      let(:new_client) { double('new client') }
 
-      it "returns the same client" do
-        expect(HelloSign.client).to be @client
+      before do
+        client_source.stub(:new).and_return(client, new_client)
+        client.stub(:email_address).and_return(email_address)
+        client.stub(:password).and_return(password)
+        HelloSign.client
       end
 
-      context "and the email and password changes" do
+      its(:client) { should be client }
+
+      context "and the credentials change" do
         before do
           HelloSign.email_address = '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_address).to eq 'bob@earth.com'
-          expect(HelloSign.client.password).to eq 'being_human'
-        end
+        its(:client) { should be new_client }
       end
     end
   end
 
+  context "when calling delegated methods" do
+    let(:client_source) { double('client_source') }
+    let(:client)        { double('client') }
+
+    before do
+      HelloSign._set_internal_collaborator(:client_source, client_source)
+      client_source.stub(:new).and_return(client)
+    end
+
+    after { HelloSign.instance_variable_set(:@client, nil) }
+
+    it "delegates ::account to the client" do
+      client.should_receive(:account)
+      HelloSign.account
+    end
+
+    it "delegates ::signature_request to the client" do
+      client.should_receive(:signature_request)
+      HelloSign.signature_request
+    end
+
+    it "delegates ::reusable_form to the client" do
+      client.should_receive(:reusable_form)
+      HelloSign.reusable_form
+    end
+
+    it "delegates ::team to the client" do
+      client.should_receive(:team)
+      HelloSign.team
+    end
+
+    it "delegates ::unclaimed_draft to the client" do
+      client.should_receive(:unclaimed_draft)
+      HelloSign.unclaimed_draft
+    end
+  end
+
   describe "::configure" do
     it "yields itself to the block" do
       HelloSign.configure do |hs|

data/spec/unit/middleware/raise_error_spec.rb

@@ -0,0 +1,28 @@
+require 'helper'
+require 'hello_sign/middleware/raise_error'
+
+describe HelloSign::Middleware::RaiseError do
+  let(:middleware) { HelloSign::Middleware::RaiseError.new(lambda { |env| Faraday::Response.new(env) }) }
+
+  specify { expect { call_with_error('bad_request') }.to raise_error HelloSign::Error::BadRequest }
+  specify { expect { call_with_error('unauthorized') }.to raise_error HelloSign::Error::Unauthorized }
+  specify { expect { call_with_error('forbidden') }.to raise_error HelloSign::Error::Forbidden }
+  specify { expect { call_with_error('not_found') }.to raise_error HelloSign::Error::NotFound }
+  specify { expect { call_with_error('unknown') }.to raise_error HelloSign::Error::Unknown }
+  specify { expect { call_with_error('team_invite_failed') }.to raise_error HelloSign::Error::TeamInviteFailed }
+  specify { expect { call_with_error('invalid_recipient') }.to raise_error HelloSign::Error::InvalidRecipient }
+  specify { expect { call_with_error('convert_failed') }.to raise_error HelloSign::Error::ConvertFailed }
+  specify { expect { call_with_error('signature_request_cancel_failed') }.to raise_error HelloSign::Error::SignatureRequestCancelFailed }
+
+  it 'does not blow up if there is not a body' do
+    expect { middleware.call({}) }.to_not raise_error
+  end
+
+  private
+
+  def call_with_error(error)
+    env = {:body => {:error => {:error_name => error}}}
+    middleware.call(env)
+  end
+
+end

data/spec/unit/parameters/reusable_form_signature_request_spec.rb

@@ -4,26 +4,6 @@ require 'hello_sign/parameters/reusable_form_signature_request'
 describe HelloSign::Parameters::ReusableFormSignatureRequest do
   describe "#formatted" do
     let(:request_parameters) { HelloSign::Parameters::ReusableFormSignatureRequest.new }
-    let(:expected) do
-      {
-        :reusable_form_id => 'form_id',
-        :title            => 'Lease',
-        :subject          => 'Sign this',
-        :message          => 'You must sign this.',
-        :ccs              => {
-          'lawyer'     => {:email_address => 'lawyer@lawfirm.com'},
-          'accountant' => {:email_address => 'accountant@llc.com'}
-        },
-        :signers          => {
-          'consultant' => {:name => 'Jack', :email_address => 'jack@hill.com'}, 
-          'client'     => {:name => 'Jill', :email_address => 'jill@hill.com'}
-        },
-        :custom_fields    => {
-          'cost' => '$20,000',
-          'time' => 'two weeks'
-        }
-      }
-    end
 
     before do
       request_parameters.reusable_form_id = 'form_id'
@@ -45,6 +25,25 @@ describe HelloSign::Parameters::ReusableFormSignatureRequest do
     end
 
     it "returns formatted parameters" do
+      expected = {
+        :reusable_form_id => 'form_id',
+        :title            => 'Lease',
+        :subject          => 'Sign this',
+        :message          => 'You must sign this.',
+        :ccs              => {
+          'lawyer'     => {:email_address => 'lawyer@lawfirm.com'},
+          'accountant' => {:email_address => 'accountant@llc.com'}
+        },
+        :signers          => {
+          'consultant' => {:name => 'Jack', :email_address => 'jack@hill.com'}, 
+          'client'     => {:name => 'Jill', :email_address => 'jill@hill.com'}
+        },
+        :custom_fields    => {
+          'cost' => '$20,000',
+          'time' => 'two weeks'
+        }
+      }
+
       expect(request_parameters.formatted).to eq expected
     end
   end

data/spec/unit/parameters/unclaimed_draft_spec.rb

@@ -1,17 +1,21 @@
 require 'helper'
 require 'hello_sign/parameters/unclaimed_draft'
 
+require 'stringio'
+
 describe HelloSign::Parameters::UnclaimedDraft do
+  let(:draft_parameters) { HelloSign::Parameters::UnclaimedDraft.new }
+
+  it "interfaces with Faraday::UploadIO properly" do
+    draft_parameters.files = [{:name => 'test.txt', :io => StringIO.new('foobar'),  :mime => 'text/plain'}]
+    expect(draft_parameters.formatted).to be_a Hash
+  end
+
   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'}
@@ -19,7 +23,8 @@ describe HelloSign::Parameters::UnclaimedDraft do
     end
 
     it "returns formatted parameters" do
-      expect(draft_parameters.formatted).to eq expected
+      Faraday::UploadIO.stub(:new).and_return(text_file, image_file)
+      expect(draft_parameters.formatted).to eq({:file => {0 => text_file, 1 => image_file}})
     end
   end
 end

data/spec/unit/proxy/unclaimed_draft_spec.rb

@@ -6,15 +6,11 @@ describe HelloSign::Proxy::UnclaimedDraft do
   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
+  its(:client) { should eq client }
 
   describe "#create" do
     let(:formatted_request_body) { double('formatted request body') }
-    let(:draft_parameters)     { double('draft parameters') }
+    let(:draft_parameters)       { double('draft parameters') }
 
     before do
       ud_proxy.draft_parameters = draft_parameters

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hello_sign
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 description: A Ruby interface to the HelloSign API.
 email:
 - craiglttl@gmail.com
@@ -99,6 +115,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/hello_sign/client.rb
+- lib/hello_sign/error.rb
+- lib/hello_sign/middleware/raise_error.rb
 - lib/hello_sign/parameters/reusable_form_signature_request.rb
 - lib/hello_sign/parameters/signature_request.rb
 - lib/hello_sign/parameters/unclaimed_draft.rb
@@ -116,6 +134,7 @@ files:
 - spec/fixtures/test.txt
 - spec/helper.rb
 - spec/integration/account_spec.rb
+- spec/integration/error_spec.rb
 - spec/integration/hello_sign_spec.rb
 - spec/integration/helper.rb
 - spec/integration/reusable_form_spec.rb
@@ -124,7 +143,9 @@ files:
 - spec/integration/unclaimed_draft_spec.rb
 - spec/shared_examples/proxy.rb
 - spec/unit/client_spec.rb
+- spec/unit/error_spec.rb
 - spec/unit/hello_sign_spec.rb
+- spec/unit/middleware/raise_error_spec.rb
 - spec/unit/parameters/reusable_form_signature_request_spec.rb
 - spec/unit/parameters/signature_request_spec.rb
 - spec/unit/parameters/unclaimed_draft_spec.rb
@@ -146,21 +167,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3035616681847644249
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3035616681847644249
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to the HelloSign API.
@@ -170,6 +185,7 @@ test_files:
 - spec/fixtures/test.txt
 - spec/helper.rb
 - spec/integration/account_spec.rb
+- spec/integration/error_spec.rb
 - spec/integration/hello_sign_spec.rb
 - spec/integration/helper.rb
 - spec/integration/reusable_form_spec.rb
@@ -178,7 +194,9 @@ test_files:
 - spec/integration/unclaimed_draft_spec.rb
 - spec/shared_examples/proxy.rb
 - spec/unit/client_spec.rb
+- spec/unit/error_spec.rb
 - spec/unit/hello_sign_spec.rb
+- spec/unit/middleware/raise_error_spec.rb
 - spec/unit/parameters/reusable_form_signature_request_spec.rb
 - spec/unit/parameters/signature_request_spec.rb
 - spec/unit/parameters/unclaimed_draft_spec.rb