hello_sign 0.3.0 → 0.4.0

data/lib/hello_sign.rb

@@ -1,37 +1,31 @@
-require 'hello_sign/version'
 require 'hello_sign/client'
-require 'hello_sign/account_proxy'
-require 'hello_sign/signature_request_proxy'
-require 'hello_sign/reusable_form_proxy'
-require 'hello_sign/team_proxy'
+require 'hello_sign/version'
+
+require 'forwardable'
 
 module HelloSign
   class << self
-    attr_accessor :email, :password
-
-    def account
-      AccountProxy.new(client)
-    end
-
-    def signature_request
-      SignatureRequestProxy.new(client)
-    end
+    extend Forwardable
 
-    def reusable_form
-      ReusableFormProxy.new(client)
-    end
+    attr_accessor :email, :password
 
-    def team
-      TeamProxy.new(client)
-    end
+    delegate [:account, :signature_request, :reusable_form, :team,
+      :unclaimed_draft] => :client
 
     def client
-      @client ||= Client.new(email, password)
+      @client = Client.new(email, password) unless credentials_match?
+      @client
     end
 
     def configure
       yield(self)
     end
 
+    private
+
+    def credentials_match?
+      @client && [@client.email, @client.password].hash == [email, password].hash
+    end
+
   end
 end

data/lib/hello_sign/client.rb

@@ -1,8 +1,12 @@
+require 'hello_sign/proxy'
+
 require 'faraday'
 require 'faraday_middleware-multi_json'
 
 module HelloSign
   class Client
+    include HelloSign::Proxy
+
     API_ENDPOINT = 'https://api.hellosign.com'
     API_VERSION  = '/v3'
 

data/lib/hello_sign/parameters/unclaimed_draft.rb

@@ -0,0 +1,27 @@
+require 'faraday/upload_io'
+
+module HelloSign
+  module Parameters
+    class UnclaimedDraft
+      attr_writer :files
+
+      def files
+        @files.each_with_index.inject({}) do |parameter, (file, index)|
+          parameter[index] = upload_io.new(file[:io], file[:mime], file[:name])
+          parameter
+        end
+      end
+
+      def formatted
+        {:file => files}
+      end
+
+      private
+
+      def upload_io
+        Faraday::UploadIO
+      end
+
+    end
+  end
+end

data/lib/hello_sign/proxy.rb

@@ -0,0 +1,56 @@
+require 'hello_sign/proxy/account'
+require 'hello_sign/proxy/signature_request'
+require 'hello_sign/proxy/reusable_form'
+require 'hello_sign/proxy/team'
+require 'hello_sign/proxy/unclaimed_draft'
+
+module HelloSign
+  module Proxy
+    attr_writer :account_proxy_source, :signature_request_proxy_source,
+      :reusable_form_proxy_source, :team_proxy_source,
+      :unclaimed_draft_proxy_source
+
+    def account
+      account_proxy_source.new(self)
+    end
+
+    def signature_request
+      signature_request_proxy_source.new(self)
+    end
+
+    def reusable_form
+      reusable_form_proxy_source.new(self)
+    end
+
+    def team
+      team_proxy_source.new(self)
+    end
+
+    def unclaimed_draft
+      unclaimed_draft_proxy_source.new(self)
+    end
+
+    private
+
+    def account_proxy_source
+      @account_proxy_source || HelloSign::Proxy::Account
+    end
+
+    def signature_request_proxy_source
+      @signature_request_proxy_source || HelloSign::Proxy::SignatureRequest
+    end
+
+    def reusable_form_proxy_source
+      @reusable_form_proxy_source || HelloSign::Proxy::ReusableForm
+    end
+
+    def team_proxy_source
+      @team_proxy_source || HelloSign::Proxy::Team
+    end
+
+    def unclaimed_draft_proxy_source
+      @unclaimed_draft_proxy_source || HelloSign::Proxy::UnclaimedDraft
+    end
+
+  end
+end

data/lib/hello_sign/proxy/account.rb

@@ -0,0 +1,35 @@
+require 'hello_sign/proxy/settings'
+
+module HelloSign
+  module Proxy
+    class Account
+      attr_reader :client
+      attr_writer :settings_proxy_source
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(credentials)
+        email    = credentials.fetch(:email)
+        password = credentials.fetch(:password)
+
+        client.post('/account/create',
+          :body => {:email_address => email, :password => password},
+          :auth_not_required => true
+        )
+      end
+
+      def settings
+        settings_proxy_source.new(client)
+      end
+
+      private
+
+      def settings_proxy_source
+        @settings_proxy_source || HelloSign::Proxy::Settings
+      end
+
+    end
+  end
+end

data/lib/hello_sign/proxy/reusable_form.rb

@@ -0,0 +1,41 @@
+module HelloSign
+  module Proxy
+    class ReusableForm
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list(params = {})
+        params = {:page => 1}.merge(params)
+        client.get('/reusable_form/list', :params => params)
+      end
+
+      def show(form_id)
+        client.get("/reusable_form/#{form_id}")
+      end
+
+      def grant_access(form_id, params = {})
+        client.post("/reusable_form/add_user/#{form_id}", :body => body(params))
+      end
+
+      def revoke_access(form_id, params = {})
+        client.post("/reusable_form/remove_user/#{form_id}", :body => body(params))
+      end
+
+      private
+
+      def body(params)
+        if email = params[:email]
+          {:email_address => email}
+        elsif account_id = params[:account_id]
+          {:account_id => account_id}
+        else
+          raise ArgumentError, 'An email address or account ID must be provided.'
+        end
+      end
+
+    end
+  end
+end

data/lib/hello_sign/proxy/settings.rb

@@ -0,0 +1,22 @@
+require 'hello_sign/client'
+
+module HelloSign
+  module Proxy
+    class Settings
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def show
+        client.get('/account')
+      end
+
+      def update(attributes)
+        client.post('/account', :body => attributes)
+      end
+
+    end
+  end
+end

data/lib/hello_sign/proxy/signature_request.rb

@@ -0,0 +1,72 @@
+require 'hello_sign/parameters/signature_request'
+require 'hello_sign/parameters/reusable_form_signature_request'
+
+module HelloSign
+  module Proxy
+    class SignatureRequest
+      attr_reader :client
+      attr_writer :request_parameters, :reusable_form_request_parameters
+
+      def initialize(client)
+        @client = client
+      end
+
+      def deliver(params = {})
+        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
+          )
+        else
+          yield request_parameters
+
+          client.post(
+            '/signature_request/send',
+            :body => request_parameters.formatted
+          )
+        end
+      end
+
+      def status(request_id)
+        client.get("/signature_request/#{request_id}")
+      end
+
+      def list(params = {})
+        params = {:page => 1}.merge(params)
+
+        client.get('/signature_request/list', :params => params)
+      end
+
+      def remind(request_id, params = {})
+        email = params.fetch(:email) { raise ArgumentError, 'An email address must be provided.' }
+
+        client.post(
+          "/signature_request/remind/#{request_id}",
+          :body => {:email_address => email}
+        )
+      end
+
+      def cancel(request_id)
+        client.post("/signature_request/cancel/#{request_id}")
+      end
+
+      def final_copy(request_id)
+        client.get("/signature_request/final_copy/#{request_id}")
+      end
+
+      private
+
+      def request_parameters
+        @request_parameters ||= Parameters::SignatureRequest.new
+      end
+
+      def reusable_form_request_parameters
+        @reusable_form_request_parameters ||= Parameters::ReusableFormSignatureRequest.new
+      end
+
+    end
+  end
+end

data/lib/hello_sign/proxy/team.rb

@@ -0,0 +1,49 @@
+module HelloSign
+  module Proxy
+    class Team
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(params)
+        name = params.fetch(:name)
+        client.post('/team/create', :body => {:name => name})
+      end
+
+      def show
+        client.get('/team')
+      end
+
+      def update(attributes)
+        client.post('/team', :body => attributes)
+      end
+
+      def destroy
+        client.post('/team/destroy')
+      end
+
+      def add_member(params)
+        client.post("/team/add_member", :body => body_by_identifier(params))
+      end
+
+      def remove_member(params)
+        client.post("/team/remove_member", :body => body_by_identifier(params))
+      end
+
+      private
+
+      def body_by_identifier(params)
+        if email = params[:email]
+          {:email_address => email}
+        elsif account_id = params[:account_id]
+          {:account_id => account_id}
+        else
+          raise ArgumentError, 'An email address or account ID must be provided.'
+        end
+      end
+
+    end
+  end
+end

data/lib/hello_sign/proxy/unclaimed_draft.rb

@@ -0,0 +1,29 @@
+require 'hello_sign/parameters/unclaimed_draft'
+
+module HelloSign
+  module Proxy
+    class UnclaimedDraft
+      attr_reader :client
+      attr_writer :draft_parameters
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create
+        yield draft_parameters
+        client.post(
+          '/unclaimed_draft/create',
+          :body => draft_parameters.formatted
+        )
+      end
+
+      private
+
+      def draft_parameters
+        @draft_parameters ||= Parameters::UnclaimedDraft.new
+      end
+
+    end
+  end
+end

data/lib/hello_sign/version.rb

@@ -1,3 +1,3 @@
 module HelloSign
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/integration/account_spec.rb

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

data/spec/integration/signature_request_spec.rb

@@ -8,7 +8,7 @@ describe HelloSign do
 
       before do
         stub_post_with_auth('/signature_request/send')
-        HelloSign.signature_request.send do |request|
+        HelloSign.signature_request.deliver do |request|
           request.title   = 'Lease'
           request.subject = 'Sign this'
           request.message = 'You must sign this.'
@@ -34,7 +34,7 @@ describe HelloSign do
     context "when using a reusable form" do
       before do
         stub_post_with_auth('/signature_request/send_with_reusable_form')
-        HelloSign.signature_request.send(:form => 'form_id') do |request|
+        HelloSign.signature_request.deliver(:form => 'form_id') do |request|
           request.title         = 'Lease'
           request.subject       = 'Sign this'
           request.message       = 'You must sign this.'

data/spec/integration/unclaimed_draft_spec.rb

@@ -0,0 +1,23 @@
+require 'integration/helper'
+
+describe HelloSign do
+  context "creating an unclaimed draft" do
+    let(:text_io)  { File.new('spec/fixtures/test.txt') }
+    let(:image_io) { File.new('spec/fixtures/test.jpg') }
+
+    before { stub_post_with_auth('/unclaimed_draft/create') }
+
+    example do
+      HelloSign.unclaimed_draft.create do |draft|
+        draft.files = [
+          {:name => 'test.txt', :io => text_io,  :mime => 'text/plain'},
+          {:name => 'test.jpg', :io => image_io, :mime => 'image/jpeg'}
+        ]
+      end
+
+      expect(a_post_with_auth('/unclaimed_draft/create')
+        .with(:headers => {'Content-Type' => /multipart\/form-data/}, :body => /This is a test upload file\./)
+      ).to have_been_made
+    end
+  end
+end