hello_sign 0.1.0 → 0.2.0

data/lib/hello_sign/client.rb

@@ -40,7 +40,6 @@ module HelloSign
         auth.call(faraday) if block_given?
         faraday.request :multipart
         faraday.request :url_encoded
-        faraday.response :logger
         faraday.response :multi_json, :symbolize_keys => true
         faraday.adapter Faraday.default_adapter
       end

data/lib/hello_sign/reusable_form_proxy.rb

@@ -0,0 +1,43 @@
+module HelloSign
+  class ReusableFormProxy
+    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 = {})
+      body = 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
+
+      client.post("/reusable_form/add_user/#{form_id}", :body => body)
+    end
+
+    def revoke_access(form_id, params = {})
+      body = 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
+
+      client.post("/reusable_form/remove_user/#{form_id}", :body => body)
+    end
+
+  end
+end

data/lib/hello_sign/version.rb

@@ -1,3 +1,3 @@
 module HelloSign
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/hello_sign.rb

@@ -2,6 +2,7 @@ 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'
 
 module HelloSign
   class << self
@@ -15,6 +16,10 @@ module HelloSign
       SignatureRequestProxy.new(client)
     end
 
+    def reusable_form
+      ReusableFormProxy.new(client)
+    end
+
     def client
       @client ||= Client.new(email, password)
     end
@@ -23,11 +28,5 @@ module HelloSign
       yield(self)
     end
 
-    private
-
-    def signature_request_proxy
-      SignatureRequestProxy.new(client)
-    end
-
   end
 end

data/spec/integration/reusable_form_spec.rb

@@ -0,0 +1,51 @@
+require 'integration/helper'
+
+describe HelloSign do
+  context "when getting a list of reusable forms" do
+    before do
+      stub_get_with_auth('/reusable_form/list?page=1')
+      HelloSign.reusable_form.list
+    end
+
+    it "fetches a list of reusable forms from the HelloSign API" do
+      expect(a_get_with_auth('/reusable_form/list?page=1')).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
+
+    it "fetches the reusable form information from the HelloSign API" do
+      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 => 'john@johnson.com')
+    end
+
+    it "sends a request to grant form access to the HelloSign API" do
+      expect(a_post_with_auth('/reusable_form/add_user/form_id')
+        .with(:body => {: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 => 'john@johnson.com')
+    end
+
+    it "sends a request to grant form access to the HelloSign API" do
+      expect(a_post_with_auth('/reusable_form/remove_user/form_id')
+        .with(:body => {:email_address => 'john@johnson.com'})
+      ).to have_been_made
+    end
+  end
+end

data/spec/unit/hello_sign_spec.rb

@@ -14,6 +14,12 @@ describe HelloSign do
     end
   end
 
+  describe "::reusable_form" do
+    it "returns a reusable form proxy" do
+      expect(HelloSign.reusable_form).to be_a HelloSign::ReusableFormProxy
+    end
+  end
+
   describe "::client" do
     context "when it has not previously been called" do
       it "returns a new client" do

data/spec/unit/reusable_form_proxy_spec.rb

@@ -0,0 +1,111 @@
+require 'helper'
+require 'hello_sign/reusable_form_proxy'
+
+describe HelloSign::ReusableFormProxy do
+  let(:client)       { double('client') }
+  let(:api_response) { double('API response') }
+  let(:form_id)      { 'form_id' }
+  subject(:rf_proxy) { HelloSign::ReusableFormProxy.new(client) }
+
+  describe "#client" do
+    it "returns the client" do
+      expect(rf_proxy.client).to be client
+    end
+  end
+
+  describe "#list" do
+    context "when called without options" do
+      before { client.should_receive(:get).with('/reusable_form/list', :params => {:page => 1}).and_return(api_response) }
+
+      it "fetches the first page of reusable forms and returns the result" do
+        expect(rf_proxy.list).to eq api_response
+      end
+    end
+
+    context "when called with a page number" do
+      before { client.should_receive(:get).with('/reusable_form/list', :params => {:page => 10}).and_return(api_response) }
+
+      it "fetches a list of reusable forms for the passed page number and returns the result" do
+        expect(rf_proxy.list(:page => 10)).to eq api_response
+      end
+    end
+  end
+
+  describe "#show" do
+    before { client.should_receive(:get).with('/reusable_form/form_id').and_return(api_response) }
+
+    it "fetches the reusable form details and returns the result" do
+      expect(rf_proxy.show(form_id)).to eq api_response
+    end
+  end
+
+  describe "#grant_access" do
+    let(:email)      { 'john@johnson.com' }
+    let(:account_id) { '15' }
+
+    before { client.stub(:post).and_return(api_response) }
+
+    context "when called with an email address" do
+      it "grants access to account tied to the email address" do
+        client.should_receive(:post).with('/reusable_form/add_user/form_id', :body => {:email_address => email})
+        rf_proxy.grant_access(form_id, :email => email)
+      end
+
+      it "returns the API response" do
+        expect(rf_proxy.grant_access(form_id, :email => email)).to eq api_response
+      end
+    end
+
+    context "when called with an account ID" do
+      it "grants access to account tied to the account ID" do
+        client.should_receive(:post).with('/reusable_form/add_user/form_id', :body => {:account_id => account_id})
+        rf_proxy.grant_access(form_id, :account_id => account_id)
+      end
+
+      it "returns the API response" do
+        expect(rf_proxy.grant_access(form_id, :account_id => account_id)).to eq api_response
+      end
+    end
+
+    context "when called without proper parameters" do
+      it "raises an argument error exception" do
+        expect { rf_proxy.grant_access(form_id) }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe "#revoke_access" do
+    let(:email)      { 'john@johnson.com' }
+    let(:account_id) { '15' }
+
+    before { client.stub(:post).and_return(api_response) }
+
+    context "when called with an email address" do
+      it "revokes access to account tied to the email address" do
+        client.should_receive(:post).with('/reusable_form/remove_user/form_id', :body => {:email_address => email})
+        rf_proxy.revoke_access(form_id, :email => email)
+      end
+
+      it "returns the API response" do
+        expect(rf_proxy.revoke_access(form_id, :email => email)).to eq api_response
+      end
+    end
+
+    context "when called with an account ID" do
+      it "revokes access to account tied to the account ID" do
+        client.should_receive(:post).with('/reusable_form/remove_user/form_id', :body => {:account_id => account_id})
+        rf_proxy.revoke_access(form_id, :account_id => account_id)
+      end
+
+      it "returns the API response" do
+        expect(rf_proxy.revoke_access(form_id, :account_id => account_id)).to eq api_response
+      end
+    end
+
+    context "when called without proper parameters" do
+      it "raises an argument error exception" do
+        expect { rf_proxy.revoke_access(form_id) }.to raise_error ArgumentError
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hello_sign
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -86,6 +86,7 @@ files:
 - lib/hello_sign/client.rb
 - lib/hello_sign/parameters/reusable_form_signature_request.rb
 - lib/hello_sign/parameters/signature_request.rb
+- lib/hello_sign/reusable_form_proxy.rb
 - lib/hello_sign/settings_proxy.rb
 - lib/hello_sign/signature_request_proxy.rb
 - lib/hello_sign/version.rb
@@ -97,12 +98,14 @@ files:
 - spec/integration/account_spec.rb
 - spec/integration/hello_sign_spec.rb
 - spec/integration/helper.rb
+- spec/integration/reusable_form_spec.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/parameters/reusable_form_signature_request_spec.rb
 - spec/unit/parameters/signature_request_spec.rb
+- spec/unit/reusable_form_proxy_spec.rb
 - spec/unit/settings_proxy_spec.rb
 - spec/unit/signature_request_proxy_spec.rb
 homepage: http://www.github.com/craiglittle/hello_sign
@@ -137,11 +140,13 @@ test_files:
 - spec/integration/account_spec.rb
 - spec/integration/hello_sign_spec.rb
 - spec/integration/helper.rb
+- spec/integration/reusable_form_spec.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/parameters/reusable_form_signature_request_spec.rb
 - spec/unit/parameters/signature_request_spec.rb
+- spec/unit/reusable_form_proxy_spec.rb
 - spec/unit/settings_proxy_spec.rb
 - spec/unit/signature_request_proxy_spec.rb