hellosign-ruby-sdk 3.5.4 → 3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1804c9f642f169ef4a3d44abb6946ef81f484d2c
-  data.tar.gz: a1eb0baecdcf75ecc0636634821278854da45720
+  metadata.gz: 624c50c86c5c3f142cbc0b183003431a912fba33
+  data.tar.gz: d20286ae7e98f4b8472bee8e1809d9bc7a3ccdf1
 SHA512:
-  metadata.gz: 680e7442f10598103fa16f631fb3f8c7081e2564f765150c3947eeb6f68d2a5e81b4b9ec07590d395eef43603b10b16b773624501640301f0d5ea618367b3566
-  data.tar.gz: adf4bff05fa09bdc31db9fd0827a1cf1eeb55a17f95d28f06d23118385f1a42368291a0ff20937fc2e02cb0ea314bea7f904f3e02dce865960cfdf011db7c445
+  metadata.gz: 26b234abfba696397fe1a4a30f524eba5e432fcd00d9fa4d2791c0a513bacf0d0fb4d1a215bba7be9119413e900d68bc89a9a72bf8a8f4d475ce2a16c2673ce7
+  data.tar.gz: 3c22e1f575ef110955ccd0a5b70d67f32435db2aafef8c553cdb6425dc4d76bbd498d673e7f92ac533507008a82f42a9fed9f3dc7d19087feb5629ce31dcca0b

data/README.md

@@ -29,7 +29,7 @@ HelloSign.configure do |config|
 end
 ```
 
-##Usage
+## Usage
 When you have configured your app like above, you can start using it:
 
 ```ruby
@@ -55,7 +55,7 @@ When using request endpoints that send files, such as a signature request, you c
 2. A Ruby File Object (File.open, then assign to a variable)
 3. A Rails ActionDispatch::Http::UploadedFile
 
-##Testing
+## Testing
 
 Testing relies on built in hard-coded fixtures. You can run the tests without affecting your actual account data. To do so
 from the root of your project run <code>rake spec</code>.

data/lib/hello_sign/api/unclaimed_draft.rb

@@ -147,7 +147,7 @@ module HelloSign
       def create_embedded_unclaimed_draft(opts)
         opts[:client_id] ||= self.client_id
         prepare_files opts
-        if opts[:type] == 'request_signature'
+        if opts[:type] == 'request_signature' || opts[:type] == 'send_document'
           prepare_signers opts
         end
 
@@ -205,6 +205,7 @@ module HelloSign
       def create_embedded_unclaimed_draft_with_template(opts)
         opts[:client_id] ||= self.client_id
         prepare_signers opts
+        prepare_custom_fields opts
         prepare_ccs opts
         prepare_templates opts
         prepare_files opts

data/lib/hello_sign/client.rb

@@ -177,7 +177,11 @@ module HelloSign
     def validate(response)
       if response.status >= 400
         error_class = ERRORS[response.status] || HelloSign::Error::UnknownError
-        raise error_class.new error_message(response)
+        error = error_class.new
+        error.response_status = response.status
+        error.response_body = response.body
+        error.request_uri = response.to_hash[:url].to_s
+        raise error
       end
     end
 
@@ -193,12 +197,6 @@ module HelloSign
       end
     end
 
-    def error_message(response)
-      "Server responded with code #{response.status}\n" \
-      "Request URI: #{response.to_hash[:url].to_s}\n"\
-      "Message: #{response.body}"
-    end
-
     def MIMEfromName(name)
       parts = name.split('.')
       #default to pdf if no extension

data/lib/hello_sign/error.rb

@@ -25,7 +25,22 @@
 module HelloSign
   module Error
     # Custom error class for rescuing from all HelloSign errors.
-    class Error < StandardError; end
+    class Error < StandardError;
+      attr_accessor :request_uri
+      attr_accessor :response_body
+      attr_accessor :response_status
+
+      def initialize(message = nil)
+        super(message || human_readable_message)
+      end
+
+      private
+      def human_readable_message
+        "Server responded with code #{response_status}\n" \
+          "Request URI: #{request_uri}\n"\
+          "Message: #{response_body}"
+      end
+    end
 
     # Raise when attributes are missing.
     class MissingAttributes < Error; end

data/lib/hello_sign/version.rb

@@ -23,5 +23,5 @@
 #
 
 module HelloSign
-  VERSION = '3.5.4'
+  VERSION = '3.6'
 end

data/spec/fixtures/unclaimed_draft.json

@@ -3,4 +3,4 @@
         "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/unclaimed_draft_spec.rb

@@ -50,4 +50,68 @@ describe HelloSign::Api::UnclaimedDraft do
       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 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 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 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 a UnclaimedDraft' do
+        expect(@unclaimed_draft).to be_an HelloSign::Resource::UnclaimedDraft
+      end
+    end
+  end
 end

data/spec/hello_sign/client_spec.rb

@@ -72,6 +72,40 @@ describe HelloSign::Client do
         expect { get_request(504) }.to raise_error(HelloSign::Error::UnknownError)
       end
     end
+
+    describe 'error keys are set' do
+      let(:error) do
+        begin
+          get_request(400)
+        rescue => e
+          e
+        else
+          # Defense exception:
+          raise 'Expected stub to throw exception'
+        end
+      end
+
+      describe 'message' do
+        subject  { error.message }
+        # Following test proves backwards compatibility
+        it { is_expected.to match(/Server responded.*/) }
+      end
+
+      describe 'response_body' do
+        subject { error.response_body }
+        it { is_expected.to eql(load_fixture('error').read) }
+      end
+
+      describe 'response_status' do
+        subject { error.response_status }
+        it { is_expected.to eql(400) }
+      end
+
+      describe 'request_uri' do
+        subject { error.request_uri }
+        it { is_expected.to eql('https://api.hellosign.com/v3/account') }
+      end
+    end
   end
 
   describe 'prepare' do

data/spec/hello_sign/error_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe HelloSign::Error do
+  # another test to prove backwards compatibility
+  describe 'custom error message' do
+    subject { HelloSign::Error::Error.new('Foo').message }
+    it { is_expected.to eql('Foo') }
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hellosign-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: '3.6'
 platform: ruby
 authors:
 - HelloSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,6 +125,7 @@ files:
 - Rakefile
 - hellosign-ruby-sdk.gemspec
 - lib/hello_sign.rb
+- lib/hello_sign/.error.rb.swp
 - lib/hello_sign/api.rb
 - lib/hello_sign/api/account.rb
 - lib/hello_sign/api/api_app.rb
@@ -165,6 +166,7 @@ files:
 - spec/fixtures/templates.json
 - spec/fixtures/token.json
 - spec/fixtures/unclaimed_draft.json
+- spec/hello_sign/.error_spec.rb.swp
 - spec/hello_sign/api/account_spec.rb
 - spec/hello_sign/api/api_app_spec.rb
 - spec/hello_sign/api/embedded_spec.rb
@@ -174,6 +176,7 @@ files:
 - spec/hello_sign/api/template_spec.rb
 - spec/hello_sign/api/unclaimed_draft_spec.rb
 - spec/hello_sign/client_spec.rb
+- spec/hello_sign/error_spec.rb
 - spec/hello_sign/resource/base_resource_spec.rb
 - spec/hello_sign_spec.rb
 - spec/scenarios/uploads_spec.rb
@@ -218,6 +221,7 @@ test_files:
 - spec/fixtures/templates.json
 - spec/fixtures/token.json
 - spec/fixtures/unclaimed_draft.json
+- spec/hello_sign/.error_spec.rb.swp
 - spec/hello_sign/api/account_spec.rb
 - spec/hello_sign/api/api_app_spec.rb
 - spec/hello_sign/api/embedded_spec.rb
@@ -227,6 +231,7 @@ test_files:
 - spec/hello_sign/api/template_spec.rb
 - spec/hello_sign/api/unclaimed_draft_spec.rb
 - spec/hello_sign/client_spec.rb
+- spec/hello_sign/error_spec.rb
 - spec/hello_sign/resource/base_resource_spec.rb
 - spec/hello_sign_spec.rb
 - spec/scenarios/uploads_spec.rb