hello_sign 0.0.3 → 0.0.4

data/lib/hello_sign/client.rb

@@ -36,10 +36,11 @@ module HelloSign
 
     def unauth_connection(&auth)
       Faraday.new(:url => API_ENDPOINT) do |faraday|
+        auth.call(faraday) if block_given?
+        faraday.request :multipart
         faraday.request :url_encoded
         faraday.response :logger
         faraday.response :multi_json, :symbolize_keys => true
-        auth.call(faraday) if block_given?
         faraday.adapter Faraday.default_adapter
       end
     end

data/lib/hello_sign/signature_request_parameters.rb

@@ -0,0 +1,45 @@
+require 'faraday/upload_io'
+
+module HelloSign
+  class SignatureRequestParameters
+    attr_accessor :title, :subject, :message, :ccs
+    attr_writer :signers, :files
+
+    def signers
+      @signers.each_with_index.inject({}) do |parameter, (signer, index)|
+        signer = {
+          :name          => signer[:name],
+          :email_address => signer[:email],
+          :order         => index
+        }
+        parameter[index] = signer
+        parameter
+      end
+    end
+
+    def files
+      @files.each_with_index.inject({}) do |parameter, (file, index)|
+        parameter[index + 1] = upload_io.new(file[:io], file[:mime], file[:name])
+        parameter
+      end
+    end
+
+    def formatted
+      {
+        :title              => title,
+        :subject            => subject,
+        :message            => message,
+        :cc_email_addresses => ccs,
+        :signers            => signers,
+        :file               => files
+      }
+    end
+
+    private
+
+    def upload_io
+      Faraday::UploadIO
+    end
+
+  end
+end

data/lib/hello_sign/signature_request_proxy.rb

@@ -0,0 +1,17 @@
+require 'hello_sign/signature_request_parameters'
+
+module HelloSign
+  class SignatureRequestProxy
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create(raw_parameters)
+      raw_parameters.call(request_parameters = SignatureRequestParameters.new)
+      client.post('/signature_request/send', :body => request_parameters.formatted)
+    end
+
+  end
+end

data/lib/hello_sign/version.rb

@@ -1,3 +1,3 @@
 module HelloSign
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/hello_sign.rb

@@ -1,6 +1,7 @@
 require 'hello_sign/version'
 require 'hello_sign/client'
 require 'hello_sign/account_proxy'
+require 'hello_sign/signature_request_proxy'
 
 module HelloSign
   class << self
@@ -10,6 +11,10 @@ module HelloSign
       AccountProxy.new(client)
     end
 
+    def signature_request(&parameters)
+      SignatureRequestProxy.new(client).create(parameters)
+    end
+
     def client
       @client ||= Client.new(email, password)
     end

data/spec/fixtures/test.txt

@@ -0,0 +1 @@
+This is a test upload file.

data/spec/integration/account_spec.rb

@@ -1,5 +1,6 @@
 require 'integration/helper'
 
+
 describe HelloSign do
   context "when creating an account" do
     before do

data/spec/integration/signature_request_spec.rb

@@ -0,0 +1,32 @@
+require 'integration/helper'
+
+describe HelloSign do
+  context "when sending a signature request" do
+    let(:text_file_io)  { File.new('spec/fixtures/test.txt') }
+    let(:image_io)      { File.new('spec/fixtures/test.jpg') }
+
+    before do
+      stub_post_with_auth('/signature_request/send')
+      request = HelloSign.signature_request do |request|
+        request.title   = 'Lease'
+        request.subject = 'Sign this'
+        request.message = 'You must sign this.'
+        request.ccs     = ['lawyer@lawfirm.com', 'spouse@family.com']
+        request.signers = [
+          {:name => 'Jack', :email => 'jack@hill.com'},
+          {:name => 'Jill', :email => 'jill@hill.com'}
+        ]
+        request.files   = [
+          {:name => 'test.txt', :io => text_file_io, :mime => 'text/plain'},
+          {:name => 'test.jpg', :io => image_io,     :mime => 'image/jpeg'}
+        ]
+      end
+    end
+
+    it "sends a signature request to the HelloSign API" do
+      expect(a_post_with_auth('/signature_request/send')
+        .with(:headers => {'Content-Type' => /multipart\/form-data/}, :body => /This is a test upload file\./)
+      ).to have_been_made
+    end
+  end
+end

data/spec/unit/hello_sign_spec.rb

@@ -8,6 +8,19 @@ describe HelloSign do
     end
   end
 
+  describe "::signature_request" do
+    let(:sr_proxy) { double('signature_request_proxy') }
+
+    before do
+      HelloSign::SignatureRequestProxy.stub(:new).and_return(sr_proxy)
+      sr_proxy.should_receive(:create).and_return(@request_result = stub)
+    end
+
+    it "calls #create on the signature request proxy and returns the result" do
+      expect(HelloSign.signature_request).to eq @request_result
+    end
+  end
+
   describe "::client" do
     context "when it has not previously been called" do
       it "returns a new client" do

data/spec/unit/signature_request_parameters_spec.rb

@@ -0,0 +1,42 @@
+require 'helper'
+require 'hello_sign/signature_request_parameters'
+
+describe HelloSign::SignatureRequestParameters do
+  describe "#formatted" do
+    before do
+      Faraday::UploadIO.should_receive(:new).with('text file IO object', 'text/plain', 'test.txt').and_return(text_file = stub)
+      Faraday::UploadIO.should_receive(:new).with('image file IO object', 'image/jpeg', 'test.jpg').and_return(image_file = stub)
+
+      @request_parameters = HelloSign::SignatureRequestParameters.new
+
+      @request_parameters.title   = 'Lease'
+      @request_parameters.subject = 'Sign this'
+      @request_parameters.message = 'You must sign this.'
+      @request_parameters.ccs     = ['lawyer@lawfirm.com', 'spouse@family.com']
+      @request_parameters.signers = [
+        {:name => 'Jack', :email => 'jack@hill.com'},
+        {:name => 'Jill', :email => 'jill@hill.com'}
+      ]
+      @request_parameters.files   = [
+        {:name => 'test.txt', :io => 'text file IO object', :mime => 'text/plain'},
+        {:name => 'test.jpg', :io => 'image file IO object', :mime => 'image/jpeg'}
+      ]
+
+      @expected = {
+        :title => 'Lease',
+        :subject =>'Sign this',
+        :message =>'You must sign this.',
+        :cc_email_addresses => ['lawyer@lawfirm.com', 'spouse@family.com'],
+        :signers => {
+          0 => {:name => 'Jack', :email_address => 'jack@hill.com', :order => 0}, 
+          1 => {:name => 'Jill', :email_address => 'jill@hill.com', :order => 1}
+        },
+        :file => {1 => text_file, 2 => image_file}
+      }
+    end
+
+    it "returns formatted parameters" do
+      expect(@request_parameters.formatted).to eq @expected
+    end
+  end
+end

data/spec/unit/signature_request_proxy_spec.rb

@@ -0,0 +1,32 @@
+require 'helper'
+require 'hello_sign/signature_request_proxy'
+
+describe HelloSign::SignatureRequestProxy do
+  let(:client)       { double('client') }
+  subject(:sr_proxy) { HelloSign::SignatureRequestProxy.new(client) }
+
+  describe "#client" do
+    it "returns the client" do
+      expect(sr_proxy.client).to be client
+    end
+  end
+
+  describe "#create" do
+    let(:formatted_request_body) { stub }
+    let(:create_response)        { stub }
+    let(:raw_parameters)         { Proc.new { |params| params.foo = 'bar' } }
+
+    before do
+      HelloSign::SignatureRequestParameters.stub(:new).and_return(request_parameters = mock)
+      request_parameters.stub(:formatted).and_return(formatted_request_body)
+      request_parameters.should_receive(:foo=).with('bar')
+      client.should_receive(:post)
+        .with('/signature_request/send', :body => formatted_request_body)
+        .and_return(create_response)
+    end
+
+    it "sends a signature request creation request and returns the result" do
+      expect(sr_proxy.create(raw_parameters)).to eq create_response
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hello_sign
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-20 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -85,16 +85,24 @@ files:
 - lib/hello_sign/account_proxy.rb
 - lib/hello_sign/client.rb
 - lib/hello_sign/settings.rb
+- lib/hello_sign/signature_request_parameters.rb
+- lib/hello_sign/signature_request_proxy.rb
 - lib/hello_sign/version.rb
 - lib/hello_sign.rb
+- spec/fixtures/test.jpg
+- spec/fixtures/test.pdf
+- spec/fixtures/test.txt
 - spec/helper.rb
 - spec/integration/account_spec.rb
 - spec/integration/hello_sign_spec.rb
 - spec/integration/helper.rb
+- spec/integration/signature_request_spec.rb
 - spec/unit/account_proxy_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/hello_sign_spec.rb
 - spec/unit/settings_spec.rb
+- spec/unit/signature_request_parameters_spec.rb
+- spec/unit/signature_request_proxy_spec.rb
 homepage: http://www.github.com/craiglittle/hello_sign
 licenses: []
 post_install_message: 
@@ -120,11 +128,17 @@ signing_key:
 specification_version: 3
 summary: A Ruby interface to the HelloSign API.
 test_files:
+- spec/fixtures/test.jpg
+- spec/fixtures/test.pdf
+- spec/fixtures/test.txt
 - spec/helper.rb
 - spec/integration/account_spec.rb
 - spec/integration/hello_sign_spec.rb
 - spec/integration/helper.rb
+- spec/integration/signature_request_spec.rb
 - spec/unit/account_proxy_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/hello_sign_spec.rb
 - spec/unit/settings_spec.rb
+- spec/unit/signature_request_parameters_spec.rb
+- spec/unit/signature_request_proxy_spec.rb