hello_sign 1.0.1 → 1.1.0

data/lib/hello_sign/error.rb

@@ -1,5 +1,21 @@
 module HelloSign
   class Error < StandardError
+    attr_reader :message, :status_code
+
+    def initialize(message = nil, status_code = nil)
+      @message, @status_code = message, status_code
+    end
+
+    def to_s
+      status_code ? message_with_status_code : message
+    end
+
+    private
+
+    def message_with_status_code
+      "[Status code: #{status_code}] #{message}"
+    end
+
     class BadRequest                   < HelloSign::Error; end
     class Unauthorized                 < HelloSign::Error; end
     class Forbidden                    < HelloSign::Error; end

data/lib/hello_sign/middleware/raise_error.rb

@@ -9,18 +9,36 @@ module HelloSign
       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
+        error = body[:error] and begin
+          exception = begin
+            case error[:error_name]
+            when 'bad_request'
+              HelloSign::Error::BadRequest
+            when 'unauthorized'
+              HelloSign::Error::Unauthorized
+            when 'forbidden'
+              HelloSign::Error::Forbidden
+            when 'not_found'
+              HelloSign::Error::NotFound
+            when 'unknown'
+              HelloSign::Error::Unknown
+            when 'team_invite_failed'
+              HelloSign::Error::TeamInviteFailed
+            when 'invalid_recipient'
+              HelloSign::Error::InvalidRecipient
+            when 'convert_failed'
+              HelloSign::Error::ConvertFailed
+            when 'signature_request_cancel_failed'
+              HelloSign::Error::SignatureRequestCancelFailed
+            else
+              HelloSign::Error
+            end
           end
+
+          message     = error[:error_msg]
+          status_code = env[:response][:status]
+
+          raise exception.new(message, status_code)
         end
       end
 

data/lib/hello_sign/version.rb

@@ -1,3 +1,3 @@
 module HelloSign
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/unit/error_spec.rb

@@ -12,4 +12,13 @@ describe HelloSign::Error do
   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 }
+
+  describe "#to_s" do
+    let(:error)    { HelloSign::Error.new('This is why an error was received.', 401) }
+    let(:expected) { '[Status code: 401] This is why an error was received.' }
+
+    it "displays a helpful message" do
+      expect(error.to_s).to eq expected
+    end
+  end
 end

data/spec/unit/middleware/raise_error_spec.rb

@@ -2,26 +2,47 @@ 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
+  let(:middleware) { HelloSign::Middleware::RaiseError.new(->(env) { Faraday::Response.new(env) }) }
+
+  def self.it_raises_the_proper_exception(error, exception)
+    specify { expect { call_with_error(error) }.to raise_error exception }
+  end
+
+  {
+    'unauthorized'                    => HelloSign::Error::Unauthorized,
+    'forbidden'                       => HelloSign::Error::Forbidden,
+    'not_found'                       => HelloSign::Error::NotFound,
+    'unknown'                         => HelloSign::Error::Unknown,
+    'team_invite_failed'              => HelloSign::Error::TeamInviteFailed,
+    'invalid_recipient'               => HelloSign::Error::InvalidRecipient,
+    'convert_failed'                  => HelloSign::Error::ConvertFailed,
+    'signature_request_cancel_failed' => HelloSign::Error::SignatureRequestCancelFailed,
+    'unidentified_error'              => HelloSign::Error
+  }.each { |error_pair| it_raises_the_proper_exception(*error_pair) }
+
+  it "does not blow up if there is not a body" do
     expect { middleware.call({}) }.to_not raise_error
   end
 
+  context "when raising an exception" do
+    let(:expected_message) { "[Status code: 418] I'm a teapot." }
+
+    it "returns the proper message" do
+      begin
+        call_with_error('bad_request', message: "I'm a teapot.", status_code: 418)
+      rescue HelloSign::Error::BadRequest => e
+        expect("#{e}").to match /#{Regexp.escape(expected_message)}/
+      end
+    end
+  end
+
   private
 
-  def call_with_error(error)
-    env = {body: {error: {error_name: error}}}
+  def call_with_error(error, options = {})
+    env = {
+      body:     {error: {error_name: error, error_msg: options[:message]}},
+      response: {status: options[:status_code]}
+    }
     middleware.call(env)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hello_sign
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -179,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to the HelloSign API