bullion_vault 0.1.0

data/lib/bullion_vault/version.rb

@@ -0,0 +1,3 @@
+module BullionVault
+  VERSION = '0.1.0'.freeze if ! defined?(::BullionVault::VERSION)
+end

data/lib/faraday/cookie_auth.rb

@@ -0,0 +1,14 @@
+require 'faraday'
+
+module Faraday
+  class Request::CookieAuth < Faraday::Middleware
+    def call(env)
+      env[:request_headers]['Cookie'] = @cookie
+      @app.call(env)
+    end
+
+    def initialize(app, cookie)
+      @app, @cookie = app, cookie
+    end
+  end
+end

data/lib/faraday/raise_http_4xx.rb

@@ -0,0 +1,48 @@
+require 'faraday'
+
+module Faraday
+  class Response::RaiseHttp4xx < Response::Middleware
+    def self.register_on_complete(env)
+      env[:response].on_complete do |response|
+        case response[:status].to_i
+          when 400
+            raise BullionVault::BadRequest, error_message(response)
+          when 401
+            raise BullionVault::Unauthorized, error_message(response)
+          when 403
+            raise BullionVault::Forbidden, error_message(response)
+          when 404
+            raise BullionVault::NotFound, error_message(response)
+          when 406
+            raise BullionVault::NotAcceptable, error_message(response)
+        end
+      end
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+
+    private
+
+    def self.error_message(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def self.error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        ": #{body['error']}"
+      elsif body['errors']
+        first = body['errors'].to_a.first
+        if first.kind_of? Hash
+          ": #{first['message'].chomp}"
+        else
+          ": #{first.chomp}"
+        end
+      end
+    end
+  end
+end

data/lib/faraday/raise_http_5xx.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+
+module Faraday
+  class Response::RaiseHttp5xx < Response::Middleware
+    def self.register_on_complete(env)
+      env[:response].on_complete do |response|
+        case response[:status].to_i
+        when 500
+          raise BullionVault::InternalServerError, error_message(response, 'Something is technically wrong.')
+        when 502
+          raise BullionVault::BadGateway, error_message(response, 'BullionVault is down or being upgraded.')
+        when 503
+          raise BullionVault::ServiceUnavailable, error_message(response, '(__-){ BullionVault is over capacity.')
+        end
+      end
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+
+    private
+
+    def self.error_message(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')} Check http://goldnews.bullionvault.com/ for updates on the status of the BullionVault service."
+    end
+  end
+end

data/lib/faraday/raise_invalid_cookie.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+
+module Faraday
+  class Response::RaiseInvalidCookie < Response::Middleware
+    def self.register_on_complete(env)
+      env[:response].on_complete do |response|
+        if response[:response_headers]['set-cookie']
+          raise BullionVault::InvalidCookie, error_message(response)
+        end
+      end
+    end
+
+    private
+
+    def self.error_message(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def self.error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        ": #{body['error']}"
+      elsif body['errors']
+        first = body['errors'].to_a.first
+        if first.kind_of? Hash
+          ": #{first['message'].chomp}"
+        else
+          ": #{first.chomp}"
+        end
+      end
+    end
+  end
+end

data/spec/bullion_vault/api_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe BullionVault::API do
+  before(:each) do
+    @keys = BullionVault::Configuration::VALID_OPTIONS_KEYS
+  end
+
+  context 'with module configuration' do
+
+    before do
+      BullionVault.configure do |config|
+        @keys.each do |key|
+          config.public_send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      BullionVault.reset
+    end
+
+    it 'inherits module configuration' do
+      api = BullionVault::API.new
+      @keys.each do |key|
+        api.public_send(key).should == key
+      end
+    end
+
+    context 'with class configuration' do
+
+      before do
+        @configuration = {
+          :user_login => 'login',
+          :user_password => 'secret',
+          :adapter => :typhoeus,
+          :endpoint => 'http://example.com/',
+          :format => :xml,
+          :proxy => 'http://user:passwd@proxy.example.com:8080',
+          :cookie => 'COOKIE_DATA',
+          :user_agent => 'Custom User Agent',
+        }
+      end
+
+      context 'during initialization'
+
+        it 'overrides module configuration' do
+          api = BullionVault::API.new(@configuration)
+          @keys.each do |key|
+            api.public_send(key).should == @configuration[key]
+          end
+        end
+
+      context 'after initilization' do
+
+        it 'overrides module configuration after initialization' do
+          api = BullionVault::API.new
+          @configuration.each do |key, value|
+            api.public_send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.public_send(key).should == @configuration[key]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/bullion_vault/client/login_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe BullionVault::Client::Login do
+  describe '#reset_cookie' do
+    before(:each) do
+      @client = BullionVault::Client.new(:user_login => 'user', :user_password => 'pass')
+    end
+
+    it 'resets the cookie with a new value from the server' do
+      stub_request(:get, 'https://live.bullionvault.com/secure/login.do')
+        .to_return(:status => 200, :headers => {'set-cookie' => 'monster'})
+
+      @client.send(:reset_cookie).should eq 'monster'
+      @client.cookie.should eq 'monster'
+    end
+  end
+
+  describe '#login' do
+    before(:each) do
+      @client = BullionVault::Client.new(
+        :user_login => 'user',
+        :user_password => 'pass',
+        :cookie => 'monster',
+      )
+    end
+
+    it 'posts the login credentials' do
+      stub_request(:post, 'https://live.bullionvault.com/secure/j_security_check')
+        .with(:body => 'j_username=user&j_password=pass', :headers => {'Cookie' => 'monster'})
+        .to_return(:status => 302, :headers => {'location' => 'https://live.bullionvault.com/secure/main_frame.do'})
+
+      @client.send(:login).should be_true
+    end
+
+    it 'fails when the server redirects to an unexpected URL' do
+      stub_request(:post, 'https://live.bullionvault.com/secure/j_security_check')
+        .with(:body => 'j_username=user&j_password=pass', :headers => {'Cookie' => 'monster'})
+        .to_return(:status => 302, :headers => {'location' => 'https://live.bullionvault.com/secure/surprise.do'})
+
+      @client.send(:login).should be_false
+    end
+
+    it 'fails when the server returns a response other than 302' do
+      stub_request(:post, 'https://live.bullionvault.com/secure/j_security_check')
+        .with(:body => 'j_username=user&j_password=pass', :headers => {'Cookie' => 'monster'})
+        .to_return(:status => 200, :headers => {'location' => 'https://live.bullionvault.com/secure/surprise.do'})
+
+      @client.send(:login).should be_false
+    end
+  end
+end

data/spec/bullion_vault/client/view_balance_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe BullionVault::Client::ViewBalance do
+  before(:each) do
+    @client = BullionVault::Client.new(:cookie => 'monster')
+  end
+
+  describe '#view_market' do
+    it 'gets market offers' do
+      stub_request(:get, 'https://live.bullionvault.com/view_market_xml.do')
+        .with(:headers => {'Cookie' => 'monster'})
+        .to_return(:status => 200, :body => fixture('view_balance.xml'))
+
+      @client.view_market.should eq yaml_fixture('view_balance.yaml')
+    end
+  end
+end

data/spec/bullion_vault/client/view_market_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe BullionVault::Client::ViewMarket do
+  before(:each) do
+    @client = BullionVault::Client.new
+  end
+
+  describe '#view_market' do
+    it 'gets market offers' do
+      stub_request(:get, 'https://live.bullionvault.com/view_market_xml.do')
+        .to_return(:status => 200, :body => fixture('view_market.xml'))
+
+      @client.view_market.should eq yaml_fixture('view_market.yaml')
+    end
+  end
+end

data/spec/bullion_vault/client_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe BullionVault::Client do
+  before(:each) do
+    @client = BullionVault::Client.new
+  end
+
+  it 'connects to the endpoint configuration' do
+    endpoint = URI.parse(@client.api_endpoint).to_s
+    connection = @client.send(:connection).build_url(nil).to_s
+    connection.should == endpoint
+  end
+end

data/spec/bullion_vault_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'spec_helper'
+
+describe BullionVault do
+  after do
+    BullionVault.reset
+  end
+
+  context 'when delegating to a client' do
+    before do
+      stub_request(:get, 'https://live.bullionvault.com/view_market_xml.do')
+        .to_return(:body => fixture('view_market.xml'))
+    end
+
+    it 'gets the correct resource' do
+      BullionVault.view_market
+      a_request(:get, 'https://live.bullionvault.com/view_market_xml.do')
+        .should have_been_made
+    end
+
+    it 'returns the same results as a client' do
+      BullionVault.view_market.should == BullionVault::Client.new.view_market
+    end
+  end
+
+  describe '.client' do
+    it 'is a BullionVault::Client' do
+      BullionVault.client.should be_a BullionVault::Client
+    end
+  end
+
+  OPTIONS_KEYS = %w{adapter user_login user_password endpoint format proxy cookie user_agent}
+
+  describe 'VALID_OPTIONS_KEYS' do
+    it 'matches the list in the spec' do
+      OPTIONS_KEYS.map(&:to_sym).should eq BullionVault::Configuration::VALID_OPTIONS_KEYS
+    end
+  end
+
+  OPTIONS_KEYS.each do |key|
+    describe ".#{key}" do
+      it "returns the default #{key}" do
+        BullionVault.public_send(key).should eq BullionVault::Configuration.const_get("default_#{key}".upcase)
+      end
+    end
+
+    describe ".#{key}=" do
+      it "sets the #{key}" do
+        BullionVault.public_send("#{key}=", 'test_value')
+        BullionVault.public_send(key).should eq 'test_value'
+      end
+    end
+  end
+
+  describe '.configure' do
+    BullionVault::Configuration::VALID_OPTIONS_KEYS.each do |key|
+      it "sets the #{key}" do
+        BullionVault.configure do |config|
+          config.public_send("#{key}=", key)
+          BullionVault.public_send(key).should == key
+        end
+      end
+    end
+  end
+end

data/spec/faraday/cookie_auth_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Faraday::Request::CookieAuth do
+  before(:each) do
+    @client = BullionVault::Client.new(:cookie => 'monster')
+  end
+
+  it 'sets the cookie in requests' do
+    stub_request(:get, 'https://live.bullionvault.com/secure/login.do')
+      .with(:headers => {'Cookie' => 'monster'})
+      .to_return(:status => 200)
+    @client.get('secure/login.do', {}, true).should be_success
+  end
+end

data/spec/faraday/response_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Faraday::Response do
+  before do
+    @client = BullionVault::Client.new
+  end
+
+  context 'when the cookie is set' do
+    it 'raises InvalidCookieError' do
+      stub_request(:get, 'https://live.bullionvault.com/action.do')
+        .to_return(:status => 200, :headers => {'set-cookie' => 'monster'})
+
+      @client.cookie = 'illegitimate_value'
+      proc { @client.get('action.do') }.should raise_error(BullionVault::InvalidCookie)
+    end
+  end
+
+  {
+    400 => BullionVault::BadRequest,
+    401 => BullionVault::Unauthorized,
+    403 => BullionVault::Forbidden,
+    404 => BullionVault::NotFound,
+    406 => BullionVault::NotAcceptable,
+    500 => BullionVault::InternalServerError,
+    502 => BullionVault::BadGateway,
+    503 => BullionVault::ServiceUnavailable,
+  }.each do |status, exception|
+    context "when HTTP status is #{status}" do
+
+      before do 
+        stub_request(:get, 'https://live.bullionvault.com/error_inducing_action.do')
+          .to_return(:status => status)
+      end
+
+      it "raises #{exception.name} error" do
+        proc { @client.get('error_inducing_action.do') }.should raise_error(exception)
+      end
+    end
+  end
+end

data/spec/fixtures/view_balance.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<envelope>
+	<message type="CLIENT_BALANCE_A" version="0.2">
+		<clientBalance>
+			<clientPositions>
+				<clientPosition
+						securityId="USD"
+						available="101"
+						total="101"
+						classNarrative="CURRENCY"
+						totalValuation="101"
+						valuationCurrency="USD"
+					/>
+				<clientPosition
+						securityId="GBP"
+						available="1"
+						total="1"
+						classNarrative="CURRENCY"
+						totalValuation="1.61"
+						valuationCurrency="USD"
+					/>
+				<clientPosition
+						securityId="EUR"
+						available="1"
+						total="1"
+						classNarrative="CURRENCY"
+						totalValuation="1.43"
+						valuationCurrency="USD"
+					/>
+				<clientPosition
+						securityId="AUXZU"
+						available="0.001"
+						total="0.001"
+						classNarrative="GOLD"
+						totalValuation="45.95"
+						valuationCurrency="USD"
+					/>
+				</clientPositions>
+		</clientBalance>
+	</message>
+</envelope>