mt_gox 0.7.3

data/.gitignore

@@ -0,0 +1,46 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp
+
+## Idea
+.idea
+.rakeTasks
+*.iml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.9.3

data/.yardopts

@@ -0,0 +1,4 @@
+--tag authenticated:"Requires Authentication"
+--markup markdown
+-
+LICENSE.md

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Erik Michaels-Ober
+
+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.md

@@ -0,0 +1,63 @@
+# Ruby wrapper for the Mt. Gox Trade API.
+
+
+## <a name="fork"></a>This Fork
+This is a fork of https://github.com/sferik/mtgox. This fork features a rework of the
+original business domain entities into new Models, with an intent to make these Models
+ActiveModel-compliant in future.
+
+## <a name="installation"></a>Installation
+    gem install mt_gox
+
+## <a name="alias"></a>Alias
+After installing the gem, you can get the current price for 1 BTC in USD by
+typing `btc` in your bash shell simply by setting the following alias:
+
+    alias btc='ruby -r rubygems -r mtgox -e "puts MtGox.ticker.sell"'
+
+## <a name="examples"></a>Usage Examples
+    require 'rubygems'
+    require 'mtgox'
+
+    # Fetch the latest price for 1 BTC in USD
+    puts MtGox.ticker.sell
+
+    # Fetch open asks
+    puts MtGox.asks
+
+    # Fetch open bids
+    puts MtGox.bids
+
+    # Fetch the last 48 hours worth of trades (takes a minute)
+    puts MtGox.trades
+
+    # Certain methods require authentication
+    MtGox.configure do |config|
+      config.key = YOUR_MTGOX_KEY
+      config.secret = YOUR_MTGOX_SECRET
+    end
+
+    # Fetch your current balance
+    puts MtGox.balance
+
+    # Place a limit order to buy one bitcoin for $0.011
+    MtGox.buy! 1.0, 0.011
+
+    # Place a limit order to sell one bitcoin for $100
+    MtGox.sell! 1.0, 100.0
+
+    # Cancel order #1234567890
+    MtGox.cancel 1234567890
+
+    # Withdraw 1 BTC from your account
+    MtGox.withdraw! 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"
+
+[issues]: https://github.com/arvicco/mtgox/issues
+
+## <a name="copyright"></a>Copyright
+Copyright (c) 2011 Erik Michaels-Ober.
+Copyright (c) 2012 Arvicco (extensions).
+
+See [LICENSE][] for details.
+
+[license]: https://github.com/sferik/mtgox/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,38 @@
+begin
+  require 'rake'
+rescue LoadError
+  require 'rubygems'
+  gem 'rake', '~> 0.8.3.1'
+  require 'rake'
+end
+
+require 'pathname'
+
+BASE_PATH = Pathname.new(__FILE__).dirname
+LIB_PATH = BASE_PATH + 'lib'
+PKG_PATH = BASE_PATH + 'pkg'
+DOC_PATH = BASE_PATH + 'rdoc'
+
+$LOAD_PATH.unshift LIB_PATH.to_s
+require 'mtgox/version'
+
+NAME = 'mt_gox'
+CLASS_NAME = MtGox
+
+# Load rakefile tasks
+Dir['tasks/*.rake'].sort.each { |file| load file }
+
+
+# Project-specific tasks
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = [
+        '--tag', 'authenticated:Requires Authentication',
+        '--markup', 'markdown',
+    ]
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.7.3

data/lib/faraday/response/raise_mtgox_error.rb

@@ -0,0 +1,11 @@
+require 'faraday'
+
+module Faraday
+  class Response::RaiseMtGoxError < Response::Middleware
+    def on_complete(env)
+      if 200 == env[:status] && 'MySQL error, please retry later' == env[:body]
+        raise MtGox::MysqlError, "MySQL error, please retry later"
+      end
+    end
+  end
+end

data/lib/mtgox/ask.rb

@@ -0,0 +1,16 @@
+require 'mtgox/offer'
+
+module MtGox
+  class Ask < Offer
+
+    def initialize(price=nil, amount=nil)
+      self.price = price.to_f
+      self.amount = amount.to_f
+    end
+
+    def eprice
+      price / (1 - MtGox.commission)
+    end
+
+  end
+end

data/lib/mtgox/balance.rb

@@ -0,0 +1,10 @@
+module MtGox
+  class Balance
+    attr_accessor :currency, :amount
+
+    def initialize(currency=nil, amount=nil)
+      self.currency = currency.to_s.upcase
+      self.amount = amount.to_f
+    end
+  end
+end

data/lib/mtgox/bid.rb

@@ -0,0 +1,16 @@
+require 'mtgox/offer'
+
+module MtGox
+  class Bid < Offer
+
+    def initialize(price=nil, amount=nil)
+      self.price = price.to_f
+      self.amount = amount.to_f
+    end
+
+    def eprice
+      price * (1 - MtGox.commission)
+    end
+
+  end
+end

data/lib/mtgox/buy.rb

@@ -0,0 +1,6 @@
+require 'mtgox/order'
+
+module MtGox
+  class Buy < Order
+  end
+end

data/lib/mtgox/client.rb

@@ -0,0 +1,263 @@
+require 'faraday/error'
+require 'mtgox/ask'
+require 'mtgox/balance'
+require 'mtgox/bid'
+require 'mtgox/buy'
+require 'mtgox/connection'
+require 'mtgox/max_bid'
+require 'mtgox/min_ask'
+require 'mtgox/request'
+require 'mtgox/sell'
+require 'mtgox/ticker'
+require 'mtgox/trade'
+
+module MtGox
+  class Client
+    include MtGox::Connection
+    include MtGox::Request
+
+    ORDER_TYPES = {:sell => 1, :buy => 2}
+
+    # Fetch a deposit address
+    # @authenticated true
+    # @return [String]
+    # @example
+    #   MtGox.address
+    def address
+      post('/api/0/btcAddress.php')['addr']
+    end
+
+
+    # Fetch the latest ticker data
+    #
+    # @authenticated false
+    # @return [MtGox::Ticker]
+    # @example
+    #   MtGox.ticker
+    def ticker
+      ticker = get('/api/0/data/ticker.php')['ticker']
+      Ticker.instance.buy    = ticker['buy'].to_f
+      Ticker.instance.high   = ticker['high'].to_f
+      Ticker.instance.price  = ticker['last'].to_f
+      Ticker.instance.low    = ticker['low'].to_f
+      Ticker.instance.sell   = ticker['sell'].to_f
+      Ticker.instance.volume = ticker['vol'].to_f
+      Ticker.instance.vwap   = ticker['vwap'].to_f
+      Ticker.instance
+    end
+
+    # Fetch both bids and asks in one call, for network efficiency
+    #
+    # @authenticated false
+    # @return [Hash] with keys :asks and :asks, which contain arrays as described in {MtGox::Client#asks} and {MtGox::Clients#bids}
+    # @example
+    #   MtGox.offers
+    def offers
+      offers = get('/api/0/data/getDepth.php')
+      asks = offers['asks'].sort_by do |ask|
+        ask[0].to_f
+      end.map! do |ask|
+        Ask.new(*ask)
+      end
+      bids = offers['bids'].sort_by do |bid|
+        -bid[0].to_f
+      end.map! do |bid|
+        Bid.new(*bid)
+      end
+      {:asks => asks, :bids => bids}
+    end
+
+    # Fetch open asks
+    #
+    # @authenticated false
+    # @return [Array<MtGox::Ask>] an array of open asks, sorted in price ascending order
+    # @example
+    #   MtGox.asks
+    def asks
+      offers[:asks]
+    end
+
+    # Fetch open bids
+    #
+    # @authenticated false
+    # @return [Array<MtGox::Bid>] an array of open bids, sorted in price descending order
+    # @example
+    #   MtGox.bids
+    def bids
+      offers[:bids]
+    end
+
+    # Fetch the lowest priced ask
+    #
+    # @authenticated false
+    # @return [MtGox::MinAsk]
+    # @example
+    #   MtGox.min_ask
+    def min_ask
+      min_ask = asks.first
+      MinAsk.instance.price = min_ask.price
+      MinAsk.instance.amount = min_ask.amount
+      MinAsk.instance
+    end
+
+    # Fetch the highest priced bid
+    #
+    # @authenticated false
+    # @return [MtGox::MinBid]
+    # @example
+    #   MtGox.max_bid
+    def max_bid
+      max_bid = bids.first
+      MaxBid.instance.price = max_bid.price
+      MaxBid.instance.amount = max_bid.amount
+      MaxBid.instance
+    end
+
+    # Fetch recent trades
+    #
+    # @authenticated false
+    # @return [Array<MtGox::Trade>] an array of trades, sorted in chronological order
+    # @example
+    #   MtGox.trades
+    def trades
+      get('/api/0/data/getTrades.php').sort_by{|trade| trade['date']}.map do |trade|
+        Trade.new(trade)
+      end
+    end
+
+    # Fetch your current balance
+    #
+    # @authenticated true
+    # @return [Array<MtGox::Balance>]
+    # @example
+    #   MtGox.balance
+    def balance
+      parse_balance(post('/api/0/getFunds.php', {}))
+    end
+
+    # Fetch your open orders, both buys and sells, for network efficiency
+    #
+    # @authenticated true
+    # @return [Hash] with keys :buys and :sells, which contain arrays as described in {MtGox::Client#buys} and {MtGox::Clients#sells}
+    # @example
+    #   MtGox.orders
+    def orders
+      parse_orders(post('/api/0/getOrders.php', {})['orders'])
+    end
+
+    # Fetch your open buys
+    #
+    # @authenticated true
+    # @return [Array<MtGox::Buy>] an array of your open bids, sorted by date
+    # @example
+    #   MtGox.buys
+    def buys
+      orders[:buys]
+    end
+
+    # Fetch your open sells
+    #
+    # @authenticated true
+    # @return [Array<MtGox::Sell>] an array of your open asks, sorted by date
+    # @example
+    #   MtGox.sells
+    def sells
+      orders[:sells]
+    end
+
+    # Place a limit order to buy BTC
+    #
+    # @authenticated true
+    # @param amount [Numeric] the number of bitcoins to purchase
+    # @param price [Numeric] the bid price in US dollars
+    # @return [Hash] with keys :buys and :sells, which contain arrays as described in {MtGox::Client#buys} and {MtGox::Clients#sells}
+    # @example
+    #   # Buy one bitcoin for $0.011
+    #   MtGox.buy! 1.0, 0.011
+    def buy!(amount, price)
+      parse_orders(post('/api/0/buyBTC.php', {:amount => amount, :price => price})['orders'])
+    end
+
+    # Place a limit order to sell BTC
+    #
+    # @authenticated true
+    # @param amount [Numeric] the number of bitcoins to sell
+    # @param price [Numeric] the ask price in US dollars
+    # @return [Hash] with keys :buys and :sells, which contain arrays as described in {MtGox::Client#buys} and {MtGox::Clients#sells}
+    # @example
+    #   # Sell one bitcoin for $100
+    #   MtGox.sell! 1.0, 100.0
+    def sell!(amount, price)
+      parse_orders(post('/api/0/sellBTC.php', {:amount => amount, :price => price})['orders'])
+    end
+
+    # Cancel an open order
+    #
+    # @authenticated true
+    # @overload cancel(oid)
+    #   @param oid [String] an order ID
+    #   @return [Hash] with keys :buys and :sells, which contain arrays as described in {MtGox::Client#buys} and {MtGox::Clients#sells}
+    #   @example
+    #     my_order = MtGox.orders.first
+    #     MtGox.cancel my_order.oid
+    #     MtGox.cancel 1234567890
+    # @overload cancel(order)
+    #   @param order [Hash] a hash-like object, with keys `oid` - the order ID of the transaction to cancel and `type` - the type of order to cancel (`1` for sell or `2` for buy)
+    #   @return [Hash] with keys :buys and :sells, which contain arrays as described in {MtGox::Client#buys} and {MtGox::Clients#sells}
+    #   @example
+    #     my_order = MtGox.orders.first
+    #     MtGox.cancel my_order
+    #     MtGox.cancel {'oid' => '1234567890', 'type' => 2}
+    def cancel(args)
+      if args.is_a?(Hash)
+        order = args.delete_if{|k, v| !['oid', 'type'].include?(k.to_s)}
+        parse_orders(post('/api/0/cancelOrder.php', order)['orders'])
+      else
+        orders = post('/api/0/getOrders.php', {})['orders']
+        order = orders.find{|order| order['oid'] == args.to_s}
+        if order
+          order = order.delete_if{|k, v| !['oid', 'type'].include?(k.to_s)}
+          parse_orders(post('/api/0/cancelOrder.php', order)['orders'])
+        else
+          raise Faraday::Error::ResourceNotFound, {:status => 404, :headers => {}, :body => 'Order not found.'}
+        end
+      end
+    end
+
+    # Transfer bitcoins from your Mt. Gox account into another account
+    #
+    # @authenticated true
+    # @param amount [Numeric] the number of bitcoins to withdraw
+    # @param btca [String] the bitcoin address to send to
+    # @return [Array<MtGox::Balance>]
+    # @example
+    #   # Withdraw 1 BTC from your account
+    #   MtGox.withdraw! 1.0, '1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L'
+    def withdraw!(amount, btca)
+      parse_balance(post('/api/0/withdraw.php', {:group1 => 'BTC', :amount => amount, :btca => btca}))
+    end
+
+    private
+
+    def parse_balance(balance)
+      balances = []
+      balances << Balance.new('BTC', balance['btcs'])
+      balances << Balance.new('USD', balance['usds'])
+      balances
+    end
+
+    def parse_orders(orders)
+      buys = []
+      sells = []
+      orders.sort_by{|order| order['date']}.each do |order|
+        case order['type']
+        when ORDER_TYPES[:sell]
+          sells << Sell.new(order)
+        when ORDER_TYPES[:buy]
+          buys << Buy.new(order)
+        end
+      end
+      {:buys => buys, :sells => sells}
+    end
+  end
+end

data/lib/mtgox/configuration.rb

@@ -0,0 +1,41 @@
+require 'mtgox/version'
+
+module MtGox
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {MtGox::Client}
+    VALID_OPTIONS_KEYS = [
+      :commission,
+      :key,
+      :secret,
+    ]
+
+    DEFAULT_COMMISSION = 0.0065.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
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.commission = DEFAULT_COMMISSION
+      self.key   = nil
+      self.secret   = nil
+      self
+    end
+  end
+end

data/lib/mtgox/connection.rb

@@ -0,0 +1,32 @@
+require 'faraday'
+require 'faraday/request/url_encoded'
+require 'faraday/response/raise_error'
+require 'faraday/response/parse_json'
+require 'faraday/response/raise_mtgox_error'
+require 'faraday_middleware'
+require 'mtgox/version'
+
+module MtGox
+  module Connection
+    private
+
+    def connection
+      options = {
+        :headers  => {
+          :accept => 'application/json',
+          :user_agent => "mt_gox gem #{MtGox::VERSION}",
+        },
+        :ssl => {:verify => false},
+        :url => 'https://mtgox.com',
+      }
+
+      Faraday.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use Faraday::Response::RaiseError
+        connection.use Faraday::Response::ParseJson
+        connection.use Faraday::Response::RaiseMtGoxError
+        connection.adapter(Faraday.default_adapter)
+      end
+    end
+  end
+end

data/lib/mtgox/error.rb

@@ -0,0 +1,7 @@
+module MtGox
+  # Custom error class for rescuing from all MtGox errors
+  class Error < StandardError; end
+
+  class MysqlError < Error; end
+end
+

data/lib/mtgox/max_bid.rb

@@ -0,0 +1,10 @@
+require 'mtgox/bid'
+require 'mtgox/price_ticker'
+require 'singleton'
+
+module MtGox
+  class MaxBid < Bid
+    include Singleton
+    include PriceTicker
+  end
+end

data/lib/mtgox/min_ask.rb

@@ -0,0 +1,10 @@
+require 'mtgox/ask'
+require 'mtgox/price_ticker'
+require 'singleton'
+
+module MtGox
+  class MinAsk < Ask
+    include Singleton
+    include PriceTicker
+  end
+end

data/lib/mtgox/offer.rb

@@ -0,0 +1,5 @@
+module MtGox
+  class Offer
+    attr_accessor :amount, :price
+  end
+end

data/lib/mtgox/order.rb

@@ -0,0 +1,14 @@
+require 'mtgox/offer'
+
+module MtGox
+  class Order < Offer
+    attr_accessor :id, :date
+
+    def initialize(order={})
+      self.id     = order['oid']
+      self.date   = Time.at(order['date'].to_i)
+      self.amount = order['amount'].to_f
+      self.price  = order['price'].to_f
+    end
+  end
+end

data/lib/mtgox/price_ticker.rb

@@ -0,0 +1,27 @@
+module MtGox
+  module PriceTicker
+    attr_reader :previous_price, :price
+
+    def price=(price)
+      @previous_price = @price
+      @price = price
+    end
+
+    def up?
+      price.to_f > previous_price.to_f
+    end
+
+    def down?
+      price.to_f < previous_price.to_f
+    end
+
+    def changed?
+      price.to_f != previous_price.to_f
+    end
+
+    def unchanged?
+      !changed?
+    end
+    alias :unch? :unchanged?
+  end
+end