hello_sign 1.1.0 → 1.1.1

data/lib/hello_sign.rb

@@ -1,7 +1,7 @@
 require 'hello_sign/middleware/raise_error'
+require 'hello_sign/middleware/parse_json'
 require 'hello_sign/client'
 require 'hello_sign/version'
-
 require 'forwardable'
 
 module HelloSign
@@ -10,10 +10,19 @@ 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 = HelloSign::Client.new(email_address, password) unless credentials_match?
+      unless credentials_match?
+        @client = HelloSign::Client.new(email_address, password)
+      end
+
       @client
     end
 
@@ -24,10 +33,25 @@ module HelloSign
     private
 
     def credentials_match?
-      @client && [@client.email_address, @client.password].hash == [email_address, password].hash
+      @client && client_credentials.hash == provided_credentials.hash
+    end
+
+    def client_credentials
+      [@client.email_address, @client.password]
+    end
+
+    def provided_credentials
+      [email_address, password]
     end
 
-    Faraday.register_middleware :response, raise_error: HelloSign::Middleware::RaiseError
+    Faraday.register_middleware(
+      :response,
+      raise_error: HelloSign::Middleware::RaiseError
+    )
+    Faraday.register_middleware(
+      :response,
+      json: HelloSign::Middleware::ParseJson
+    )
 
   end
 end

data/lib/hello_sign/client.rb

@@ -1,57 +1,32 @@
 require 'hello_sign/proxy'
-
-require 'faraday'
-require 'faraday_middleware-multi_json'
+require 'hello_sign/connection'
+require 'forwardable'
 
 module HelloSign
   class Client
-    include HelloSign::Proxy
+    extend Forwardable
 
-    API_ENDPOINT = 'https://api.hellosign.com'
-    API_VERSION  = '/v3'
+    include HelloSign::Proxy
 
     attr_reader :email_address, :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 }
+    def initialize(email_or_hash, password = nil)
+      if email_or_hash.is_a?(Hash)
+        @email_address = email_or_hash.fetch(:email_address) { raise ArgumentError }
+        @password      = email_or_hash.fetch(:password) { raise ArgumentError }
       else
-        @email_address = email_address_or_hash
+        @email_address = email_or_hash
         @password      = password
       end
     end
 
-    def get(path, options = {})
-      request(:get, path, options)
-    end
-
-    def post(path, options = {})
-      request(:post, path, options)
-    end
+    delegate [:get, :post] => :connection
 
     private
 
-    def request(method, path, options)
-      base_connection do |connection|
-        connection.request :basic_auth, email_address, password unless options[:auth_not_required]
-      end.send(method) do |request|
-        request.url  "#{API_VERSION}#{path}", options[:params]
-        request.body = options[:body]
-      end.body
-    end
-
-    def base_connection
-      options = {url: API_ENDPOINT, headers: {user_agent: "hello_sign gem v#{HelloSign::VERSION}"}}
-
-      Faraday.new(options) do |connection|
-        yield connection
-
-        connection.request  :multipart
-        connection.request  :url_encoded
-        connection.response :raise_error
-        connection.response :multi_json, symbolize_keys: true
-        connection.adapter  :net_http
+    def connection
+      HelloSign::Connection.new do |connection|
+        connection.request :basic_auth, email_address, password
       end
     end
 

data/lib/hello_sign/connection.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+
+module HelloSign
+  class Connection
+    API_ENDPOINT = 'https://api.hellosign.com'
+    API_VERSION  = '3'
+
+    attr_reader :auth_configuration
+
+    def initialize(&auth_configuration)
+      @auth_configuration = auth_configuration
+    end
+
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    private
+
+    def request(method, path, options)
+      base_connection do |connection|
+        auth_configuration.call(connection) unless options[:auth_not_required]
+      end.send(method) do |request|
+        request.url  "/v#{API_VERSION}#{path}", options[:params]
+        request.body = options[:body]
+      end.body
+    end
+
+    def base_connection
+      Faraday.new(connection_options) do |connection|
+        yield connection
+
+        connection.request  :multipart
+        connection.request  :url_encoded
+        connection.response :raise_error
+        connection.response :json
+        connection.adapter  :net_http
+      end
+    end
+
+    def connection_options
+      {
+        url:     API_ENDPOINT,
+        headers: {user_agent: "hello_sign gem v#{HelloSign::VERSION}"}
+      }
+    end
+
+  end
+end

data/lib/hello_sign/error.rb

@@ -16,14 +16,18 @@ module HelloSign
       "[Status code: #{status_code}] #{message}"
     end
 
-    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
+    [
+      :BadRequest,
+      :Unauthorized,
+      :Forbidden,
+      :NotFound,
+      :Unknown,
+      :TeamInviteFailed,
+      :InvalidRecipient,
+      :ConvertFailed,
+      :SignatureRequestCancelFailed
+    ].each do |error_name|
+      const_set(error_name, Class.new(HelloSign::Error))
+    end
   end
 end

data/lib/hello_sign/middleware/parse_json.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+require 'json'
+
+module HelloSign
+  module Middleware
+    class ParseJson < Faraday::Response::Middleware
+
+      def on_complete(env)
+        body = env[:body] or return
+
+        env[:body] = ::JSON.parse(body, symbolize_names: true) if json?(env)
+      end
+
+      private
+
+      def json?(env)
+        env[:response_headers]['Content-Type'] == 'application/json'
+      end
+
+    end
+  end
+end

data/lib/hello_sign/middleware/raise_error.rb

@@ -9,6 +9,8 @@ module HelloSign
       def on_complete(env)
         body = env[:body] or return
 
+        return unless body.is_a?(Hash)
+
         error = body[:error] and begin
           exception = begin
             case error[:error_name]

data/lib/hello_sign/parameters/reusable_form_signature_request.rb

@@ -1,7 +1,8 @@
 module HelloSign
   module Parameters
     class ReusableFormSignatureRequest
-      attr_writer :reusable_form_id, :title, :subject, :message, :ccs, :signers, :custom_fields
+      attr_writer :reusable_form_id, :title, :subject, :message, :ccs, :signers,
+        :custom_fields
 
       def formatted
         {
@@ -9,9 +10,9 @@ module HelloSign
           title:            title,
           subject:          subject,
           message:          message,
-          ccs:              ccs,
-          signers:          signers,
-          custom_fields:    custom_fields
+          ccs:              formatted_ccs,
+          signers:          formatted_signers,
+          custom_fields:    formatted_custom_fields
         }
       end
 
@@ -19,27 +20,39 @@ module HelloSign
 
       attr_reader :reusable_form_id, :title, :subject, :message
 
-      def ccs
-        @ccs.inject({}) do |parameter, cc|
+      def formatted_ccs
+        ccs.each_with_object({}) do |cc, parameter|
           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
+      def formatted_signers
+        signers.each_with_object({}) do |signer, parameter|
+          parameter[signer[:role]] = {
+            name: signer[:name],
+            email_address: signer[:email_address]
+          }
         end
       end
 
-      def custom_fields
-        @custom_fields.inject({}) do |parameter, custom_field|
+      def formatted_custom_fields
+        custom_fields.each_with_object({}) do |custom_field, parameter|
           parameter[custom_field[:name]] = custom_field[:value]
-          parameter
         end
       end
 
+      def ccs
+        @ccs || {}
+      end
+
+      def signers
+        @signers || {}
+      end
+
+      def custom_fields
+        @custom_fields || {}
+      end
+
     end
   end
 end

data/lib/hello_sign/parameters/signature_request.rb

@@ -3,37 +3,45 @@ require 'hello_sign/file'
 module HelloSign
   module Parameters
     class SignatureRequest
-      attr_accessor :title, :subject, :message, :ccs
-      attr_writer :signers, :files
+      attr_writer :title, :subject, :message, :ccs, :signers, :files
 
-      def signers
-        (@signers || {}).each_with_index.inject({}) do |parameter, (signer, index)|
-          signer = {
+      def formatted
+        {
+          title:              title,
+          subject:            subject,
+          message:            message,
+          cc_email_addresses: ccs,
+          signers:            formatted_signers,
+          file:               formatted_files
+        }
+      end
+
+      private
+
+      attr_reader :title, :subject, :message, :ccs
+
+      def formatted_signers
+        signers.each_with_index.each_with_object({}) do |(signer, i), parameter|
+          parameter[i] = {
             name:          signer[:name],
             email_address: signer[:email_address],
-            order:         index
+            order:         i
           }
-          parameter[index] = signer
-          parameter
         end
       end
 
-      def files
-        (@files || {}).each_with_index.inject({}) do |parameter, (file_data, index)|
-          parameter[index + 1] = HelloSign::File.new(file_data).attachment
-          parameter
+      def formatted_files
+        files.each_with_index.each_with_object({}) do |(file, i), parameter|
+          parameter[i + 1] = HelloSign::File.new(file).attachment
         end
       end
 
-      def formatted
-        {
-          title:              title,
-          subject:            subject,
-          message:            message,
-          cc_email_addresses: ccs,
-          signers:            signers,
-          file:               files
-        }
+      def signers
+        @signers || {}
+      end
+
+      def files
+        @files || {}
       end
 
     end

data/lib/hello_sign/parameters/unclaimed_draft.rb

@@ -6,18 +6,21 @@ module HelloSign
       attr_writer :files
 
       def formatted
-        {file: files}
+        {file: formatted_files}
       end
 
       private
 
-      def files
-        @files.each_with_index.inject({}) do |parameter, (file_data, index)|
-          parameter[index] = HelloSign::File.new(file_data).attachment
-          parameter
+      def formatted_files
+        files.each_with_index.each_with_object({}) do |(file, i), parameter|
+          parameter[i] = HelloSign::File.new(file).attachment
         end
       end
 
+      def files
+        @files || {}
+      end
+
     end
   end
 end

data/lib/hello_sign/proxy/signature_request.rb

@@ -7,23 +7,15 @@ module HelloSign
       attr_reader :client, :request_id
 
       def initialize(client, request_id)
-        @client = client
+        @client     = client
         @request_id = request_id
       end
 
-      def deliver(params = {})
+      def deliver(params = {}, &block)
         if form_id = params[:form]
-          reusable_form_request_parameters.reusable_form_id = form_id
-          yield reusable_form_request_parameters
-
-          client.post(
-            '/signature_request/send_with_reusable_form',
-            body: reusable_form_request_parameters.formatted
-          )
+          deliver_request_with_form(form_id, &block)
         else
-          yield request_parameters
-
-          client.post('/signature_request/send', body: request_parameters.formatted)
+          deliver_request(&block)
         end
       end
 
@@ -32,15 +24,15 @@ module HelloSign
       end
 
       def list(params = {})
-        params = {page: 1}.merge(params)
+        client.get('/signature_request/list', params: {page: 1}.merge(params))
 
-        client.get('/signature_request/list', params: params)
       end
 
       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: {email_address: params.delete(:email)}.merge(params)
+        )
       end
 
       def cancel
@@ -53,12 +45,32 @@ module HelloSign
 
       private
 
+      def deliver_request
+        yield request_parameters
+
+        client.post(
+          '/signature_request/send',
+          body: request_parameters.formatted
+        )
+      end
+
+      def deliver_request_with_form(form_id)
+        reusable_form_request_parameters.reusable_form_id = form_id
+        yield reusable_form_request_parameters
+
+        client.post(
+          '/signature_request/send_with_reusable_form',
+          body: reusable_form_request_parameters.formatted
+        )
+      end
+
       def request_parameters
         @request_parameters ||= Parameters::SignatureRequest.new
       end
 
       def reusable_form_request_parameters
-        @reusable_form_request_parameters ||= Parameters::ReusableFormSignatureRequest.new
+        @reusable_form_request_parameters ||=
+          Parameters::ReusableFormSignatureRequest.new
       end
 
     end