bullion_vault 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    bullion_vault (0.1.0)
+      faraday_middleware (~> 0.3.2)
+      hashie (~> 1.0.0)
+      multi_xml (~> 0.2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.4)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    faraday (0.5.7)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (< 2, >= 1.1.0)
+    faraday_middleware (0.3.2)
+      faraday (~> 0.5.4)
+    hashie (1.0.0)
+    multi_xml (0.2.1)
+    multipart-post (1.1.0)
+    rack (1.2.2)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bullion_vault!
+  rake (~> 0.8.7)
+  rspec (~> 2.5.0)
+  webmock (~> 1.6.2)

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010-2011 William T Nelson, John Nunemaker, Wynn
+Netherland, Erik Michaels-Ober, Steve Richert
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.mkd

@@ -0,0 +1,51 @@
+BullionVault Ruby Gem
+====================
+A Ruby wrapper for the BullionVault XML API
+
+Installation
+------------
+    gem install bullion_vault
+
+Usage Examples
+--------------
+    require 'rubygems'
+    require 'bullion_vault'
+    require 'pp'
+
+    # Get current market data
+    pp BullionVault.view_market
+
+    # Certain methods require authentication. To get BullionVault credentials,
+    # sign up at https://live.bullionvault.com/secure/registration.do
+
+    BullionVault \
+      .configure {|c| c.user_login, c.user_password = USERNAME, PASSWORD } \
+      .authenticate
+     => true
+
+    # Check your account
+    pp BullionVault.view_balance
+
+    # You only need a valid session id to be authenticated
+    BullionVault.cookie
+     => "JSESSIONID=1D034E46B78C47C17005478B6537CABD; Path=/secure; Secure,
+    logintest=\"Thu Mar 31 09:17:26 UTC 2011\"; Version=1; Max-Age=60000;
+    Expires=Fri, 01-Apr-2011 01:57:26 GMT"
+    cookie = 'JSESSIONID=1D034E46B78C47C17005478B6537CABD'
+    BullionVault.cookie = cookie
+    BullionVault.view_balance
+
+    # Use two accounts at once
+    BullionVault.reset
+    c0 = BullionVault::Client.new(:user_login => 'sara_birton')
+    c1 = BullionVault::Client.new(:user_login => 'bonepoppy')
+
+Documentation
+-------------
+* [BullionVault XML API](http://www.bullionvault.com/help/?xml_api.html)
+* [BullionVault Robots FAQs](http://www.bullionvault.com/help/index.do?content=FAQs/FAQs_bots.html)
+
+Copyright
+---------
+Copyright (c) 2010-2011 William T Nelson, John Nunemaker, Wynn Netherland,
+Erik Michaels-Ober, Steve Richert. See [MIT-LICENSE](https://github.com/wtn/bullion_vault/blob/master/MIT-LICENSE) for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/bullion_vault.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bullion_vault/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('rspec', '~> 2.5.0')
+  s.add_development_dependency('webmock', '~> 1.6.2')
+  s.add_development_dependency('rake', '~> 0.8.7')
+  s.add_runtime_dependency('faraday_middleware', '~> 0.3.2')
+  s.add_runtime_dependency('multi_xml', '~> 0.2.1')
+  s.add_runtime_dependency('hashie', '~> 1.0.0')
+
+  s.name = 'bullion_vault'
+  s.version = BullionVault::VERSION.dup
+  s.summary = %q{A Ruby wrapper for the BullionVault XML API}
+  s.description = %q{A Ruby wrapper for the BullionVault XML API}
+  s.homepage = 'https://github.com/wtn/bullion_vault'
+  s.authors = ['William T Nelson']
+  s.email = ['wtn@notational.net']
+  s.post_install_message = nil
+  s.rubyforge_project = nil
+  s.platform = Gem::Platform::RUBY
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to?(:required_rubygems_version=)
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+end

data/lib/bullion_vault.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../bullion_vault/error', __FILE__)
+require File.expand_path('../bullion_vault/configuration', __FILE__)
+require File.expand_path('../bullion_vault/api', __FILE__)
+require File.expand_path('../bullion_vault/client', __FILE__)
+require File.expand_path('../bullion_vault/connection', __FILE__)
+require File.expand_path('../bullion_vault/request', __FILE__)
+
+module BullionVault
+  extend Configuration
+
+  def self.client(options={})
+    BullionVault::Client.new(options)
+  end
+
+  def self.method_missing(method, *args, &block)
+    return super if ! client.respond_to?(method)
+    client.public_send(method, *args, &block)
+  end
+
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+end

data/lib/bullion_vault/api.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../authentication', __FILE__)
+
+module BullionVault
+  class API
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = BullionVault.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        public_send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+    include Authentication
+  end
+end

data/lib/bullion_vault/authentication.rb

@@ -0,0 +1,9 @@
+module BullionVault
+  module Authentication
+    private
+
+    def login_credentials
+      { :j_username => user_login, :j_password => user_password }
+    end
+  end
+end

data/lib/bullion_vault/client.rb

@@ -0,0 +1,11 @@
+module BullionVault
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each {|f| require f }
+
+    alias :api_endpoint :endpoint
+
+    include BullionVault::Client::Login
+    include BullionVault::Client::ViewMarket
+    include BullionVault::Client::ViewBalance
+  end
+end

data/lib/bullion_vault/client/login.rb

@@ -0,0 +1,26 @@
+module BullionVault
+  class Client
+    module Login
+      HTML_LOGIN_PATH = 'secure/login.do'.freeze
+      XML_LOGIN_PATH = 'secure/j_security_check'.freeze
+
+      def authenticate(raw=false)
+        reset_cookie
+        login(raw)
+      end
+
+      private
+
+      def login(raw=false)
+        resp = post(XML_LOGIN_PATH, login_credentials, true)
+        raw and return resp
+        resp.status == 302 and resp.headers['location'] == 'https://live.bullionvault.com/secure/main_frame.do'
+      end
+
+      def reset_cookie
+        self.cookie = nil
+        self.cookie = get(HTML_LOGIN_PATH, {}, true).headers['set-cookie']
+      end
+    end
+  end
+end

data/lib/bullion_vault/client/view_balance.rb

@@ -0,0 +1,11 @@
+module BullionVault
+  class Client
+    module ViewBalance
+      BALANCE_PATH = 'secure/view_balance_xml.do'.freeze
+
+      def view_balance(options={}, raw=false)
+        get BALANCE_PATH, options, raw
+      end
+    end
+  end
+end

data/lib/bullion_vault/client/view_market.rb

@@ -0,0 +1,11 @@
+module BullionVault
+  class Client
+    module ViewMarket
+      MARKET_PATH = 'view_market_xml.do'.freeze
+
+      def view_market(options={}, raw=false)
+        get MARKET_PATH, options, raw
+      end
+    end
+  end
+end

data/lib/bullion_vault/configuration.rb

@@ -0,0 +1,66 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module BullionVault
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :user_login,
+      :user_password,
+      :endpoint,
+      :format,
+      :proxy,
+      :cookie,
+      :user_agent
+    ].freeze
+
+    VALID_FORMATS = [:xml].freeze
+
+    # The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    DEFAULT_USER_LOGIN = nil
+    DEFAULT_USER_PASSWORD = nil
+    DEFAULT_ENDPOINT = 'https://live.bullionvault.com/'.freeze
+    DEFAULT_FORMAT = 'xml'.freeze
+    DEFAULT_PROXY = nil
+    DEFAULT_COOKIE = nil
+    DEFAULT_USER_AGENT = "BullionVault Ruby Gem #{BullionVault::VERSION}".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # Create a hash of options and their values
+    def options
+      Hash[VALID_OPTIONS_KEYS.map {|key| [key, public_send(key)] }]
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.user_login         = DEFAULT_USER_LOGIN
+      self.user_password      = DEFAULT_USER_PASSWORD
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.proxy              = DEFAULT_PROXY
+      self.cookie             = DEFAULT_COOKIE
+      self.user_agent         = DEFAULT_USER_AGENT
+      self
+    end
+
+    def authenticate
+      client = Client.new
+      client.authenticate ? (BullionVault.cookie = client.cookie and true) : false
+    end
+  end
+end

data/lib/bullion_vault/connection.rb

@@ -0,0 +1,33 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each {|f| require f}
+
+module BullionVault
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {'User-Agent' => user_agent},
+        :proxy => proxy,
+        :ssl => {:verify => false},
+        :url => api_endpoint,
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        cookie and connection.use Faraday::Request::CookieAuth, cookie
+        connection.adapter(adapter)
+        connection.use Faraday::Response::RaiseHttp5xx
+        parse_xml?(raw).tap do |parse_xml|
+          connection.use Faraday::Response::ParseXml if parse_xml
+          connection.use Faraday::Response::RaiseHttp4xx
+          cookie and connection.use Faraday::Response::RaiseInvalidCookie
+          connection.use Faraday::Response::Mashify if parse_xml
+        end
+      end
+    end
+
+    def parse_xml?(raw)
+      ! raw and format.to_s.downcase == 'xml'
+    end
+  end
+end

data/lib/bullion_vault/error.rb

@@ -0,0 +1,29 @@
+module BullionVault
+  class Error < StandardError; end
+
+  class BullionVault::InvalidCookie < Error; end
+
+  # 400
+  class BadRequest < Error; end
+
+  # 401
+  class Unauthorized < Error; end
+
+  # 403
+  class Forbidden < Error; end
+
+  # 404
+  class NotFound < Error; end
+
+  # 406
+  class NotAcceptable < Error; end
+
+  # 500
+  class InternalServerError < Error; end
+
+  # 502
+  class BadGateway < Error; end
+
+  # 503
+  class ServiceUnavailable < Error; end
+end

data/lib/bullion_vault/request.rb

@@ -0,0 +1,34 @@
+module BullionVault
+  module Request
+    def get(path, options={}, raw=false)
+      request(:get, path, options, raw)
+    end
+
+    def post(path, options={}, raw=false)
+      request(:post, path, options, raw)
+    end
+
+    def put(path, options={}, raw=false)
+      request(:put, path, options, raw)
+    end
+
+    def delete(path, options={}, raw=false)
+      request(:delete, path, options, raw)
+    end
+
+    private
+
+    def request(method, path, options, raw=false)
+      response = connection(raw).public_send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+      raw ? response : response.body
+    end
+  end
+end