hello_sign 0.0.2 → 0.0.3

data/lib/hello_sign.rb

@@ -7,7 +7,7 @@ module HelloSign
     attr_accessor :email, :password
 
     def account
-      AccountProxy.new
+      AccountProxy.new(client)
     end
 
     def client

data/lib/hello_sign/account_proxy.rb

@@ -1,7 +1,12 @@
-require 'hello_sign/account'
+require 'hello_sign/settings'
 
 module HelloSign
   class AccountProxy
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
 
     def create(credentials)
       email    = credentials.fetch(:email)
@@ -9,17 +14,23 @@ module HelloSign
 
       create_account(email, password)
 
-      Account.new(email, password)
+      true
     end
 
-    private
+    def settings
+      settings = client.get('/account')
 
-    def create_account(email, password)
-      client.post('/v3/account/create', {:email_address => email, :password => password})
+      Settings.new(settings, client)
     end
 
-    def client
-      HelloSign.client
+    private
+
+    def create_account(email, password)
+      client.post(
+        '/account/create',
+        :body => {:email_address => email, :password => password},
+        :unauthenticated => true
+      )
     end
 
   end

data/lib/hello_sign/client.rb

@@ -1,26 +1,54 @@
 require 'faraday'
+require 'faraday_middleware-multi_json'
 
 module HelloSign
   class Client
+    API_ENDPOINT = 'https://api.hellosign.com'
+    API_VERSION  = '/v3'
+
     attr_reader :email, :password
+    attr_writer :connection
 
     def initialize(email, password)
       @email    = email
       @password = password
     end
 
-    def post(path, body)
-      connection.post(path, body)
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
     end
 
     private
 
-    def connection
-      @connection ||= Faraday.new(:url => 'https://api.hellosign.com') do |faraday|
-        faraday.request  :url_encoded
+    def request(method, path, options)
+      connection = options[:unauthenticated] ? unauth_connection : auth_connection
+      request = connection.send(method) do |request|
+        request.path = "#{API_VERSION}#{path}"
+        request.body = options[:body]
+      end
+
+      request.body
+    end
+
+    def unauth_connection(&auth)
+      Faraday.new(:url => API_ENDPOINT) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :logger
+        faraday.response :multi_json, :symbolize_keys => true
+        auth.call(faraday) if block_given?
         faraday.adapter Faraday.default_adapter
       end
     end
 
+    def auth_connection
+      unauth_connection do |faraday|
+        faraday.request :basic_auth, email, password
+      end
+    end
+
   end
 end

data/lib/hello_sign/settings.rb

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

data/lib/hello_sign/version.rb

@@ -1,3 +1,3 @@
 module HelloSign
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/helper.rb

@@ -1,5 +1,3 @@
-require 'hello_sign'
-
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
@@ -7,5 +5,4 @@ RSpec.configure do |config|
 
   config.color_enabled = true
   config.tty           = true
-  config.formatter     = :documentation
 end

data/spec/integration/account_spec.rb

@@ -3,14 +3,39 @@ require 'integration/helper'
 describe HelloSign do
   context "when creating an account" do
     before do
-      stub_request(:post, 'https://api.hellosign.com/v3/account/create')
+      stub_post('/account/create')
       HelloSign.account.create(:email => 'david@bowman.com', :password => 'foobar')
     end
 
     it "sends an account creation request to the HelloSign API" do
-      expect(a_request(:post, 'https://api.hellosign.com/v3/account/create')
+      expect(a_post('/account/create')
         .with(:body => {:email_address => 'david@bowman.com', :password => 'foobar'}))
         .to have_been_made
     end
   end
+
+  context "when accessing an account's settings" do
+    before do
+      stub_get_with_auth('/account')
+      @settings = HelloSign.account.settings
+    end
+
+    it "fetches the account's settings from the HelloSign API" do
+      expect(a_get_with_auth('/account')).to have_been_made
+    end
+  end
+
+  context "when updating an account's settings" do
+    before do
+      stub_get_with_auth('/account')
+      stub_post_with_auth('/account')
+      HelloSign.account.settings.update(:callback_url => 'http://callmemaybe.com')
+    end
+
+    it "sends an update account request to the HelloSign API" do
+      expect(a_post_with_auth('/account')
+        .with(:body => {:callback_url => 'http://callmemaybe.com'}))
+        .to have_been_made
+    end
+  end
 end

data/spec/integration/hello_sign_spec.rb

@@ -0,0 +1,11 @@
+require 'integration/helper'
+
+describe HelloSign do
+  context "when returning a response with a body" do
+    before { stub_get('/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})
+    end
+  end
+end

data/spec/integration/helper.rb

@@ -1,2 +1,41 @@
 require 'helper'
+require 'hello_sign'
 require 'webmock/rspec'
+require 'json'
+
+HelloSign.configure do |hs|
+  hs.email    = 'david@bowman.com'
+  hs.password = 'foobar'
+end
+
+def stub_get(path)
+  stub_request(:get, "https://api.hellosign.com/v3#{path}")
+end
+
+def stub_post(path)
+  stub_request(:post, "https://api.hellosign.com/v3#{path}")
+end
+
+def stub_get_with_auth(path)
+  stub_request(:get, "https://david@bowman.com:foobar@api.hellosign.com/v3#{path}")
+end
+
+def stub_post_with_auth(path)
+  stub_request(:post, "https://david@bowman.com:foobar@api.hellosign.com/v3#{path}")
+end
+
+def a_get(path)
+  a_request(:get, "https://api.hellosign.com/v3#{path}")
+end
+
+def a_post(path)
+  a_request(:post, "https://api.hellosign.com/v3#{path}")
+end
+
+def a_get_with_auth(path)
+  a_request(:get, "https://david@bowman.com:foobar@api.hellosign.com/v3#{path}")
+end
+
+def a_post_with_auth(path)
+  a_request(:post, "https://david@bowman.com:foobar@api.hellosign.com/v3#{path}")
+end

data/spec/unit/account_proxy_spec.rb

@@ -0,0 +1,59 @@
+require 'helper'
+require 'hello_sign/account_proxy'
+
+describe HelloSign::AccountProxy do
+  let(:client)            { double('client') }
+  subject(:account_proxy) { HelloSign::AccountProxy.new(client) }
+
+  describe "#client" do
+    it "returns the client" do
+      expect(account_proxy.client).to be client
+    end
+  end
+
+  describe "#create" do
+    context "when passed the proper parameters" do
+      before { client.stub(:post) }
+
+      it "sends an account creation request" do
+        client.should_receive(:post)
+          .with(
+            '/account/create',
+            :body => {:email_address => 'david@bowman.com', :password => 'space'},
+            :unauthenticated => true
+          )
+        account_proxy.create(:email => 'david@bowman.com', :password => 'space')
+      end
+
+      it "returns true" do
+        expect(account_proxy.create(:email => 'david@bowman.com', :password => 'space')). to be true
+      end
+    end
+
+    context "when not passed the proper parameters" do
+      it "raises an exception" do
+        expect { account_proxy.create(:email => 'david@bowman.com') }.to raise_error
+      end
+    end
+  end
+
+  describe "#settings" do
+    let(:settings) { double('settings') }
+
+    before { client.stub(:get).and_return(settings) }
+
+    it "sends a request to fetch the account's settings" do
+      client.should_receive(:get).with('/account')
+      account_proxy.settings
+    end
+
+    it "creates an account object" do
+      HelloSign::Settings.should_receive(:new).with(settings, client)
+      account_proxy.settings
+    end
+
+    it "returns an account object" do
+      expect(account_proxy.settings).to be_a HelloSign::Settings
+    end
+  end
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,38 @@
+require 'helper'
+require 'json'
+require 'hello_sign/client'
+
+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'
+    end
+  end
+
+  describe "#password" do
+    it "returns the password" 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

@@ -1,4 +1,5 @@
 require 'helper'
+require 'hello_sign'
 
 describe HelloSign do
   describe "::account" do
@@ -6,4 +7,43 @@ describe HelloSign do
       expect(HelloSign.account).to be_a HelloSign::AccountProxy
     end
   end
+
+  describe "::client" do
+    context "when it has not previously been called" do
+      it "returns a new client" do
+        expect(HelloSign.client).to be_a HelloSign::Client
+      end
+    end
+
+    context "when it has previously been called" do
+      it "returns the same client" do
+        client = HelloSign.client
+        expect(HelloSign.client).to be client
+      end
+    end
+  end
+
+  describe "::configure" do
+    it "yields itself to the block" do
+      HelloSign.configure do |hs|
+        expect(hs).to be HelloSign
+      end
+    end
+  end
+
+  describe "::email" do
+    it "sets and returns the email address" do
+      HelloSign.email = 'hal@jupiter.com'
+
+      expect(HelloSign.email).to eq 'hal@jupiter.com'
+    end
+  end
+
+  describe "::password" do
+    it "sets and returns the password" do
+      HelloSign.password = 'human_domination'
+
+      expect(HelloSign.password).to eq 'human_domination'
+    end
+  end
 end

data/spec/unit/settings_spec.rb

@@ -0,0 +1,36 @@
+require 'helper'
+require 'hello_sign/settings'
+
+describe HelloSign::Settings do
+  let(:attributes)   { double('attributes') }
+  let(:client)       { double('client') }
+  subject(:settings) { HelloSign::Settings.new(attributes, client) }
+
+  describe "#attributes" do
+    it "returns the attributes" do
+      expect(settings.attributes).to eq attributes
+    end
+  end
+
+  describe "#client" do
+    it "returns the client" do
+      expect(settings.client).to eq client
+    end
+  end
+
+  describe "#update" do
+    let(:callback_url) { 'http://www.callmemaybe.com' }
+
+    before { client.stub(:post) }
+
+    it "sends a request to update the account's settings" do
+      client.should_receive(:post)
+        .with('/account', :body => {:callback_url => callback_url})
+      settings.update(:callback_url => callback_url)
+    end
+
+    it "returns true" do
+      expect(settings.update(:callback_url => callback_url)).to be true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hello_sign
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware-multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,16 +82,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/hello_sign/account.rb
 - lib/hello_sign/account_proxy.rb
 - lib/hello_sign/client.rb
+- lib/hello_sign/settings.rb
 - lib/hello_sign/version.rb
 - lib/hello_sign.rb
 - spec/helper.rb
 - spec/integration/account_spec.rb
+- spec/integration/hello_sign_spec.rb
 - spec/integration/helper.rb
-- spec/unit/account_spec.rb
+- spec/unit/account_proxy_spec.rb
+- spec/unit/client_spec.rb
 - spec/unit/hello_sign_spec.rb
+- spec/unit/settings_spec.rb
 homepage: http://www.github.com/craiglittle/hello_sign
 licenses: []
 post_install_message: 
@@ -103,6 +122,9 @@ summary: A Ruby interface to the HelloSign API.
 test_files:
 - spec/helper.rb
 - spec/integration/account_spec.rb
+- spec/integration/hello_sign_spec.rb
 - spec/integration/helper.rb
-- spec/unit/account_spec.rb
+- spec/unit/account_proxy_spec.rb
+- spec/unit/client_spec.rb
 - spec/unit/hello_sign_spec.rb
+- spec/unit/settings_spec.rb

data/lib/hello_sign/account.rb

@@ -1,13 +0,0 @@
-require 'hello_sign/client'
-
-module HelloSign
-  class Account
-    attr_reader :email, :password
-
-    def initialize(email, password)
-      @email    = email
-      @password = password
-    end
-
-  end
-end

data/spec/unit/account_spec.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-describe HelloSign::Account do
-  describe "#create" do
-    
-  end
-end