hello_sign 0.2.0 → 0.3.0

data/lib/hello_sign.rb

@@ -3,6 +3,7 @@ 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'
 
 module HelloSign
   class << self
@@ -20,6 +21,10 @@ module HelloSign
       ReusableFormProxy.new(client)
     end
 
+    def team
+      TeamProxy.new(client)
+    end
+
     def client
       @client ||= Client.new(email, password)
     end

data/lib/hello_sign/account_proxy.rb

@@ -15,7 +15,7 @@ module HelloSign
 
       client.post('/account/create',
         :body => {:email_address => email, :password => password},
-        :unauthenticated => true
+        :auth_not_required => true
       )
     end
 

data/lib/hello_sign/client.rb

@@ -7,7 +7,6 @@ module HelloSign
     API_VERSION  = '/v3'
 
     attr_reader :email, :password
-    attr_writer :connection
 
     def initialize(email, password)
       @email    = email
@@ -25,29 +24,22 @@ module HelloSign
     private
 
     def request(method, path, options)
-      connection = options[:unauthenticated] ? unauth_connection : auth_connection
-      request = connection.send(method) do |request|
-        request.path   = "#{API_VERSION}#{path}"
-        request.params = options[:params] if options[:params]
-        request.body   = options[:body]
-      end
-
-      request.body
+      base_connection do |connection|
+        connection.request :basic_auth, email, 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 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 :multi_json, :symbolize_keys => true
-        faraday.adapter Faraday.default_adapter
-      end
-    end
+    def base_connection
+      Faraday.new(:url => API_ENDPOINT) do |connection|
+        yield connection
 
-    def auth_connection
-      unauth_connection do |faraday|
-        faraday.request :basic_auth, email, password
+        connection.request  :multipart
+        connection.request  :url_encoded
+        connection.response :multi_json, :symbolize_keys => true
+        connection.adapter  :net_http
       end
     end
 

data/lib/hello_sign/team_proxy.rb

@@ -0,0 +1,47 @@
+module HelloSign
+  class TeamProxy
+    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

data/lib/hello_sign/version.rb

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

data/spec/integration/hello_sign_spec.rb

@@ -1,11 +1,30 @@
 require 'integration/helper'
+require 'json'
 
 describe HelloSign do
   context "when returning a response with a body" do
-    before { stub_get('/json').to_return(:body => {:account_id => 1}.to_json) }
+    before { stub_get_with_auth('/json').to_return(:body => {:account_id => 1}.to_json) }
 
-    it "renders it as JSON" do
-      expect(HelloSign.client.get('/json', :unauthenticated => true)).to eq({:account_id => 1})
+    it "parses the body into a hash with symbols as keys" do
+      expect(HelloSign.client.get('/json')).to eq({:account_id => 1})
+    end
+  end
+
+  describe "#get" do
+    before { stub_get_with_auth('/resource') }
+
+    example do
+      HelloSign.client.get('/resource')
+      expect(a_get_with_auth('/resource')).to have_been_made
+    end
+  end
+
+  describe "#post" do
+    before { stub_post_with_auth('/resource') }
+
+    example do
+      HelloSign.client.post('/resource')
+      expect(a_post_with_auth('/resource')).to have_been_made
     end
   end
 end

data/spec/integration/reusable_form_spec.rb

@@ -31,7 +31,7 @@ describe HelloSign do
 
     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'})
+        .with(:email_address => 'john@johnson.com')
       ).to have_been_made
     end
   end
@@ -44,7 +44,7 @@ describe HelloSign do
 
     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'})
+        .with(:email_address => 'john@johnson.com')
       ).to have_been_made
     end
   end

data/spec/integration/team_spec.rb

@@ -0,0 +1,73 @@
+require 'integration/helper'
+
+describe HelloSign do
+  context "creating a team" do
+    before { stub_post_with_auth('/team/create') }
+
+    example do
+      HelloSign.team.create(:name => 'The Browncoats')
+
+      expect(a_post_with_auth('/team/create')
+        .with(:body => {:name => 'The Browncoats'}))
+        .to have_been_made
+    end
+  end
+
+  context "fetching team information" do
+    before { stub_get_with_auth('/team') }
+
+    example do
+      HelloSign.team.show
+
+      expect(a_get_with_auth('/team'))
+        .to have_been_made
+    end
+  end
+
+  context "updating team information" do
+    before { stub_post_with_auth('/team') }
+
+    example do
+      HelloSign.team.update(:name => 'The Bluecoats')
+
+      expect(a_post_with_auth('/team')
+        .with(:name => 'The Bluecoats'))
+        .to have_been_made
+    end
+  end
+
+  context "destroying a team" do
+    before { stub_post_with_auth('/team/destroy') }
+
+    example do
+      HelloSign.team.destroy
+
+      expect(a_post_with_auth('/team/destroy'))
+        .to have_been_made
+    end
+  end
+
+  context "adding a member to a team" do
+    before { stub_post_with_auth('/team/add_member') }
+
+    example do
+      HelloSign.team.add_member(:email => 'bob@smith.com')
+
+      expect(a_post_with_auth('/team/add_member')
+        .with(:email => 'bob@smith.com'))
+        .to have_been_made
+    end
+  end
+
+  context "removing a member from a team" do
+    before { stub_post_with_auth('/team/remove_member') }
+
+    example do
+      HelloSign.team.remove_member(:email => 'bob@smith.com')
+
+      expect(a_post_with_auth('/team/remove_member')
+        .with(:email => 'bob@smith.com'))
+        .to have_been_made
+    end
+  end
+end

data/spec/unit/account_proxy_spec.rb

@@ -22,7 +22,7 @@ describe HelloSign::AccountProxy do
           .with(
             '/account/create',
             :body => {:email_address => 'david@bowman.com', :password => 'space'},
-            :unauthenticated => true
+            :auth_not_required => true
           )
         account_proxy.create(:email => 'david@bowman.com', :password => 'space')
       end

data/spec/unit/client_spec.rb

@@ -6,8 +6,6 @@ describe HelloSign::Client do
   let(:connection) { double('connection') }
   subject(:client) { HelloSign::Client.new('david@bowman.com', 'space') }
 
-  before { client.connection = connection }
-
   describe "#email" do
     it "returns the email address" do
       expect(client.email).to eq 'david@bowman.com'
@@ -19,20 +17,4 @@ describe HelloSign::Client do
       expect(client.password).to eq 'space'
     end
   end
-
-  describe "#get" do
-    before { subject.should_receive(:request).with(:get, 'path', {:options => {}}) }
-
-    it "makes a GET request" do
-      subject.get('path', :options => {})
-    end
-  end
-
-  describe "#post" do
-    before { subject.should_receive(:request).with(:post, 'path', {:options => {}}) }
-
-    it "makes a POST request" do
-      subject.post('path', :options => {})
-    end
-  end
 end

data/spec/unit/hello_sign_spec.rb

@@ -20,6 +20,12 @@ describe HelloSign do
     end
   end
 
+  describe "::team" do
+    it "returns a team proxy" do
+      expect(HelloSign.team).to be_a HelloSign::TeamProxy
+    end
+  end
+
   describe "::client" do
     context "when it has not previously been called" do
       it "returns a new client" do

data/spec/unit/team_proxy_spec.rb

@@ -0,0 +1,141 @@
+require 'helper'
+require 'hello_sign/team_proxy'
+
+describe HelloSign::TeamProxy do
+  let(:client)         { double('client') }
+  let(:api_response)   { double('API response') }
+  subject(:team_proxy) { HelloSign::TeamProxy.new(client) }
+
+  before do
+    client.stub(:get).and_return(api_response)
+    client.stub(:post).and_return(api_response)
+  end
+
+  describe "#client" do
+    it "returns the client" do
+      expect(team_proxy.client).to be client
+    end
+  end
+
+  describe "#create" do
+    let(:name) { 'The Browncoats' }
+
+    context "when called with the proper parameters" do
+      it "sends a team creation request" do
+        client.should_receive(:post).with('/team/create', :body => {:name => name})
+        team_proxy.create(:name => name)
+      end
+
+      it "returns the API response" do
+        expect(team_proxy.create(:name => name)).to eq api_response
+      end
+    end
+
+    context "when called without the proper parameters" do
+      it "raises an exception" do
+        expect { team_proxy.create }.to raise_error
+      end
+    end
+  end
+
+  describe "#show" do
+    it "fetches the team information" do
+      client.should_receive(:get).with('/team')
+      team_proxy.show
+    end
+
+    it "returns the API response" do
+      expect(team_proxy.show).to eq api_response
+    end
+  end
+
+  describe "#update" do
+    let(:new_name) { 'The Bluecoats' }
+
+    it "sends a team update request" do
+      client.should_receive(:post).with('/team', :body => {:name => new_name})
+      team_proxy.update(:name => new_name)
+    end
+
+    it "returns the API response" do
+      expect(team_proxy.update(:name => new_name)).to eq api_response
+    end
+  end
+
+  describe "#destroy" do
+    it "sends a team destroy request" do
+      client.should_receive(:post).with('/team/destroy')
+      team_proxy.destroy
+    end
+
+    it "returns the API response" do
+      expect(team_proxy.destroy).to eq api_response
+    end
+  end
+
+  describe "#add_member" do
+    let(:email)      { 'john@johnson.com' }
+    let(:account_id) { '15' }
+
+    context "when called with an email address" do
+      it "adds the user with the email address to the team" do
+        client.should_receive(:post).with('/team/add_member', :body => {:email_address => email})
+        team_proxy.add_member(:email => email)
+      end
+
+      it "returns the API response" do
+        expect(team_proxy.add_member(:email => email)).to eq api_response
+      end
+    end
+
+    context "when called with an account ID" do
+      it "adds the user with the account ID to the team" do
+        client.should_receive(:post).with('/team/add_member', :body => {:account_id => account_id})
+        team_proxy.add_member(:account_id => account_id)
+      end
+
+      it "returns the API response" do
+        expect(team_proxy.add_member(: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 { team_proxy.add_member }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe "#remove_member" do
+    let(:email)      { 'john@johnson.com' }
+    let(:account_id) { '15' }
+
+    context "when called with an email address" do
+      it "removes the user with the email address from the team" do
+        client.should_receive(:post).with('/team/remove_member', :body => {:email_address => email})
+        team_proxy.remove_member(:email => email)
+      end
+
+      it "returns the API response" do
+        expect(team_proxy.remove_member(:email => email)).to eq api_response
+      end
+    end
+
+    context "when called with an account ID" do
+      it "removes the user with the account ID from the team" do
+        client.should_receive(:post).with('/team/remove_member', :body => {:account_id => account_id})
+        team_proxy.remove_member(:account_id => account_id)
+      end
+
+      it "returns the API response" do
+        expect(team_proxy.remove_member(: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 { team_proxy.remove_member }.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.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -89,6 +89,7 @@ files:
 - lib/hello_sign/reusable_form_proxy.rb
 - lib/hello_sign/settings_proxy.rb
 - lib/hello_sign/signature_request_proxy.rb
+- lib/hello_sign/team_proxy.rb
 - lib/hello_sign/version.rb
 - lib/hello_sign.rb
 - spec/fixtures/test.jpg
@@ -100,6 +101,7 @@ files:
 - spec/integration/helper.rb
 - spec/integration/reusable_form_spec.rb
 - spec/integration/signature_request_spec.rb
+- spec/integration/team_spec.rb
 - spec/unit/account_proxy_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/hello_sign_spec.rb
@@ -108,6 +110,7 @@ files:
 - spec/unit/reusable_form_proxy_spec.rb
 - spec/unit/settings_proxy_spec.rb
 - spec/unit/signature_request_proxy_spec.rb
+- spec/unit/team_proxy_spec.rb
 homepage: http://www.github.com/craiglittle/hello_sign
 licenses: []
 post_install_message: 
@@ -142,6 +145,7 @@ test_files:
 - spec/integration/helper.rb
 - spec/integration/reusable_form_spec.rb
 - spec/integration/signature_request_spec.rb
+- spec/integration/team_spec.rb
 - spec/unit/account_proxy_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/hello_sign_spec.rb
@@ -150,3 +154,4 @@ test_files:
 - spec/unit/reusable_form_proxy_spec.rb
 - spec/unit/settings_proxy_spec.rb
 - spec/unit/signature_request_proxy_spec.rb
+- spec/unit/team_proxy_spec.rb