hello_sign 0.6.0 → 1.0.0

data/lib/hello_sign/client.rb

@@ -42,13 +42,13 @@ module HelloSign
     end
 
     def base_connection
-      Faraday.new(:url => API_ENDPOINT) do |connection|
+      Faraday.new(url: API_ENDPOINT) do |connection|
         yield connection
 
         connection.request  :multipart
         connection.request  :url_encoded
         connection.response :raise_error
-        connection.response :multi_json, :symbolize_keys => true
+        connection.response :multi_json, symbolize_keys: true
         connection.adapter  :net_http
       end
     end

data/lib/hello_sign/parameters/reusable_form_signature_request.rb

@@ -5,13 +5,13 @@ module HelloSign
 
       def formatted
         {
-          :reusable_form_id => reusable_form_id,
-          :title            => title,
-          :subject          => subject,
-          :message          => message,
-          :ccs              => ccs,
-          :signers          => signers,
-          :custom_fields    => custom_fields
+          reusable_form_id: reusable_form_id,
+          title:            title,
+          subject:          subject,
+          message:          message,
+          ccs:              ccs,
+          signers:          signers,
+          custom_fields:    custom_fields
         }
       end
 
@@ -21,14 +21,14 @@ module HelloSign
 
       def ccs
         @ccs.inject({}) do |parameter, cc|
-          parameter[cc[:role]] = {:email_address => cc[:email_address]}
+          parameter[cc[:role]] = {email_address: cc[:email_address]}
           parameter
         end
       end
 
       def signers
         @signers.inject({}) do |parameter, signer|
-          parameter[signer[:role]] = {:name => signer[:name], :email_address => signer[:email_address]}
+          parameter[signer[:role]] = {name: signer[:name], email_address: signer[:email_address]}
           parameter
         end
       end

data/lib/hello_sign/parameters/signature_request.rb

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

data/lib/hello_sign/parameters/unclaimed_draft.rb

@@ -1,25 +1,25 @@
-require 'faraday/upload_io'
+require 'hello_sign/upload_io'
 
 module HelloSign
   module Parameters
     class UnclaimedDraft
-      attr_writer :files
+      attr_writer :files, :upload_io_source
 
       def formatted
-        {:file => files}
+        {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])
+        @files.each_with_index.inject({}) do |parameter, (file_data, index)|
+          parameter[index] = upload_io_source.new(file_data).upload
           parameter
         end
       end
 
-      def upload_io
-        Faraday::UploadIO
+      def upload_io_source
+        @upload_io_source || HelloSign::UploadIO
       end
 
     end

data/lib/hello_sign/proxy/account.rb

@@ -11,7 +11,7 @@ module HelloSign
       end
 
       def create(params = {})
-        client.post('/account/create', :body => params, :auth_not_required => true)
+        client.post('/account/create', body: params, auth_not_required: true)
       end
 
       def settings

data/lib/hello_sign/proxy/reusable_form.rb

@@ -1,26 +1,27 @@
 module HelloSign
   module Proxy
     class ReusableForm
-      attr_reader :client
+      attr_reader :client, :form_id
 
-      def initialize(client)
-        @client = client
+      def initialize(client, form_id)
+        @client  = client
+        @form_id = form_id
       end
 
       def list(params = {})
-        client.get('/reusable_form/list', :params => params)
+        client.get('/reusable_form/list', params: params)
       end
 
-      def show(form_id)
+      def show
         client.get("/reusable_form/#{form_id}")
       end
 
-      def grant_access(form_id, params = {})
-        client.post("/reusable_form/add_user/#{form_id}", :body => params)
+      def grant_access(params = {})
+        client.post("/reusable_form/add_user/#{form_id}", body: params)
       end
 
-      def revoke_access(form_id, params = {})
-        client.post("/reusable_form/remove_user/#{form_id}", :body => params)
+      def revoke_access(params = {})
+        client.post("/reusable_form/remove_user/#{form_id}", body: params)
       end
 
     end

data/lib/hello_sign/proxy/settings.rb

@@ -14,7 +14,7 @@ module HelloSign
       end
 
       def update(params = {})
-        client.post('/account', :body => params)
+        client.post('/account', body: params)
       end
 
     end

data/lib/hello_sign/proxy/signature_request.rb

@@ -4,11 +4,12 @@ require 'hello_sign/parameters/reusable_form_signature_request'
 module HelloSign
   module Proxy
     class SignatureRequest
-      attr_reader :client
+      attr_reader :client, :request_id
       attr_writer :request_parameters, :reusable_form_request_parameters
 
-      def initialize(client)
+      def initialize(client, request_id)
         @client = client
+        @request_id = request_id
       end
 
       def deliver(params = {})
@@ -18,36 +19,36 @@ module HelloSign
 
           client.post(
             '/signature_request/send_with_reusable_form',
-            :body => reusable_form_request_parameters.formatted
+            body: reusable_form_request_parameters.formatted
           )
         else
           yield request_parameters
 
-          client.post('/signature_request/send', :body => request_parameters.formatted)
+          client.post('/signature_request/send', body: request_parameters.formatted)
         end
       end
 
-      def status(request_id)
+      def status
         client.get("/signature_request/#{request_id}")
       end
 
       def list(params = {})
-        params = {:page => 1}.merge(params)
+        params = {page: 1}.merge(params)
 
-        client.get('/signature_request/list', :params => params)
+        client.get('/signature_request/list', params: params)
       end
 
-      def remind(request_id, params = {})
-        params = {:email_address => params.delete(:email)}.merge(params)
+      def remind(params = {})
+        params = {email_address: params.delete(:email)}.merge(params)
 
-        client.post("/signature_request/remind/#{request_id}", :body => params)
+        client.post("/signature_request/remind/#{request_id}", body: params)
       end
 
-      def cancel(request_id)
+      def cancel
         client.post("/signature_request/cancel/#{request_id}")
       end
 
-      def final_copy(request_id)
+      def final_copy
         client.get("/signature_request/final_copy/#{request_id}")
       end
 

data/lib/hello_sign/proxy/team.rb

@@ -8,7 +8,7 @@ module HelloSign
       end
 
       def create(params = {})
-        client.post('/team/create', :body => params)
+        client.post('/team/create', body: params)
       end
 
       def show
@@ -16,7 +16,7 @@ module HelloSign
       end
 
       def update(params = {})
-        client.post('/team', :body => params)
+        client.post('/team', body: params)
       end
 
       def destroy
@@ -24,11 +24,11 @@ module HelloSign
       end
 
       def add_member(params = {})
-        client.post("/team/add_member", :body => params)
+        client.post("/team/add_member", body: params)
       end
 
       def remove_member(params = {})
-        client.post("/team/remove_member", :body => params)
+        client.post("/team/remove_member", body: params)
       end
 
     end

data/lib/hello_sign/proxy/unclaimed_draft.rb

@@ -14,7 +14,7 @@ module HelloSign
         yield draft_parameters
         client.post(
           '/unclaimed_draft/create',
-          :body => draft_parameters.formatted
+          body: draft_parameters.formatted
         )
       end
 

data/lib/hello_sign/proxy.rb

@@ -14,12 +14,12 @@ module HelloSign
       account_proxy_source.new(self)
     end
 
-    def signature_request
-      signature_request_proxy_source.new(self)
+    def signature_request(request_id = nil)
+      signature_request_proxy_source.new(self, request_id)
     end
 
-    def reusable_form
-      reusable_form_proxy_source.new(self)
+    def reusable_form(form_id = nil)
+      reusable_form_proxy_source.new(self, form_id)
     end
 
     def team

data/lib/hello_sign/upload_io.rb

@@ -0,0 +1,56 @@
+require 'faraday/upload_io'
+require 'hello_sign/error'
+
+module HelloSign
+  class UploadIO
+    MIME_TYPES = {
+      'doc'  => 'application/msword',
+      'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+      'gif'  => 'image/gif',
+      'jpg'  => 'image/jpeg',
+      'jpeg' => 'image/jpeg',
+      'pdf'  => 'application/pdf',
+      'png'  => 'image/png',
+      'ppsx' => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
+      'ppt'  => 'application/vnd.ms-powerpoint',
+      'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+      'tif'  => 'image/tiff',
+      'tiff' => 'image/tiff',
+      'txt'  => 'text/plain',
+      'xls'  => 'application/vnd.ms-excel',
+      'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+    }
+
+    attr_reader :filename, :io_object
+
+    def initialize(file_data)
+      @filename  = file_data[:filename]
+      @io_object = file_data[:io]
+      @mime_type = file_data[:mime]
+    end
+
+    def upload
+      file_converter_source.new(*parameters)
+    end
+
+    private
+
+    def parameters
+      begin
+        io_object ? [io_object, mime_type, filename] : [filename, mime_type]
+      end.compact
+    end
+
+    def mime_type
+      @mime_type or begin
+        extension = (filename || '').split('.').last
+        MIME_TYPES.fetch(extension) { 'text/plain' }
+      end
+    end
+
+    def file_converter_source
+      @file_converter_source || Faraday::UploadIO
+    end
+
+  end
+end

data/lib/hello_sign/version.rb

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

data/lib/hello_sign.rb

@@ -31,7 +31,7 @@ module HelloSign
       @client_source || HelloSign::Client
     end
 
-    Faraday.register_middleware :response, :raise_error => HelloSign::Middleware::RaiseError
+    Faraday.register_middleware :response, raise_error: HelloSign::Middleware::RaiseError
 
   end
 end

data/spec/helper.rb

@@ -8,9 +8,7 @@ RSpec.configure do |config|
 end
 
 class Module
-
   def _set_internal_collaborator(role, collaborator)
     instance_variable_set("@#{role.to_s}", collaborator)
   end
-
 end

data/spec/integration/account_spec.rb

@@ -5,10 +5,10 @@ describe HelloSign do
     before { stub_post('/account/create') }
 
     it "sends an account creation request to the HelloSign API" do
-      HelloSign.account.create(:email_address => 'david@bowman.com', :password => 'foobar')
+      HelloSign.account.create(email_address: 'david@bowman.com', password: 'foobar')
 
       expect(a_post('/account/create')
-        .with(:body => {:email_address => 'david@bowman.com', :password => 'foobar'}))
+        .with(body: {email_address: 'david@bowman.com', password: 'foobar'}))
         .to have_been_made
     end
   end
@@ -27,10 +27,10 @@ describe HelloSign do
     before { stub_post_with_auth('/account') }
 
     it "sends an update account request to the HelloSign API" do
-      HelloSign.account.settings.update(:callback_url => 'http://callmemaybe.com')
+      HelloSign.account.settings.update(callback_url: 'http://callmemaybe.com')
 
       expect(a_post_with_auth('/account')
-        .with(:body => {:callback_url => 'http://callmemaybe.com'}))
+        .with(body: {callback_url: 'http://callmemaybe.com'}))
         .to have_been_made
     end
   end

data/spec/integration/hello_sign_spec.rb

@@ -3,10 +3,10 @@ require 'json'
 
 describe HelloSign do
   context "when returning a response with a body" do
-    before { stub_get_with_auth('/json').to_return(:body => {:account_id => 1}.to_json) }
+    before { stub_get_with_auth('/json').to_return(body: {account_id: 1}.to_json) }
 
     it "parses the body into a hash with symbols as keys" do
-      expect(HelloSign.client.get('/json')).to eq({:account_id => 1})
+      expect(HelloSign.client.get('/json')).to eq({account_id: 1})
     end
   end
 

data/spec/integration/helper.rb

@@ -3,6 +3,11 @@ require 'hello_sign'
 require 'webmock/rspec'
 require 'json'
 
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
 HelloSign.configure do |hs|
   hs.email_address = 'david@bowman.com'
   hs.password      = 'foobar'
@@ -25,7 +30,7 @@ def stub_post_with_auth(path)
 end
 
 def stub_request_with_error(error)
-  stub_request(:any, /api\.hellosign\.com/).to_return(:body => {:error => {:error_name => error}})
+  stub_request(:any, /api\.hellosign\.com/).to_return(body: {error: {error_name: error}})
 end
 
 def a_get(path)

data/spec/integration/reusable_form_spec.rb

@@ -2,49 +2,45 @@ require 'integration/helper'
 
 describe HelloSign do
   context "when getting a list of reusable forms" do
-    before do
-      stub_get_with_auth('/reusable_form/list')
-      HelloSign.reusable_form.list
-    end
+    before { stub_get_with_auth('/reusable_form/list') }
 
     it "fetches a list of reusable forms from the HelloSign API" do
+      HelloSign.reusable_form.list
+
       expect(a_get_with_auth('/reusable_form/list')).to have_been_made
     end
   end
 
   context "when fetching information about a reusable form" do
-    before do
-      stub_get_with_auth('/reusable_form/form_id')
-      HelloSign.reusable_form.show('form_id')
-    end
+    before { stub_get_with_auth('/reusable_form/form_id') }
 
     it "fetches the reusable form information from the HelloSign API" do
+      HelloSign.reusable_form('form_id').show
+
       expect(a_get_with_auth('/reusable_form/form_id')).to have_been_made
     end
   end
 
-  context "when giving a user access to a reusable form" do
-    before do
-      stub_post_with_auth('/reusable_form/add_user/form_id')
-      HelloSign.reusable_form.grant_access('form_id', :email_address => 'john@johnson.com')
-    end
+  context "when granting user access to a reusable form" do
+    before { stub_post_with_auth('/reusable_form/add_user/form_id') }
 
     it "sends a request to grant form access to the HelloSign API" do
+      HelloSign.reusable_form('form_id').grant_access(email_address: 'john@johnson.com')
+
       expect(a_post_with_auth('/reusable_form/add_user/form_id')
-        .with(:email_address => 'john@johnson.com')
+        .with(email_address: 'john@johnson.com')
       ).to have_been_made
     end
   end
 
-  context "when taking away a user's access to a reusable form" do
-    before do
-      stub_post_with_auth('/reusable_form/remove_user/form_id')
-      HelloSign.reusable_form.revoke_access('form_id', :email_address => 'john@johnson.com')
-    end
+  context "when revoking user access to a reusable form" do
+    before { stub_post_with_auth('/reusable_form/remove_user/form_id') }
 
     it "sends a request to grant form access to the HelloSign API" do
+      HelloSign.reusable_form('form_id').revoke_access(email_address: 'john@johnson.com')
+
       expect(a_post_with_auth('/reusable_form/remove_user/form_id')
-        .with(:email_address => 'john@johnson.com')
+        .with(email_address: 'john@johnson.com')
       ).to have_been_made
     end
   end