mtgox 0.1.0 → 0.2.0

data/README.md

@@ -32,7 +32,7 @@ author, which you can do using the following script:
       config.pass = YOUR_MTGOX_PASSWORD
     end
 
-    MtGox.send 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"
+    MtGox.withdraw 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"
 
 Continuous Integration
 ----------------------
@@ -56,7 +56,7 @@ Usage Examples
     puts MtGox.trades
 
     # Certain methods require authentication
-    MtGox.configure do |config| [TODO]
+    MtGox.configure do |config|
       config.name = YOUR_MTGOX_USERNAME
       config.pass = YOUR_MTGOX_PASSWORD
     end
@@ -64,17 +64,17 @@ Usage Examples
     # Get your current balance
     puts MtGox.balance
 
-    # Place an order to buy 1 BTC for 20 USD (returns a list of your open orders)
-    puts MtGox.buy! 1.0, 20.0
+    # Place a limit order to buy one bitcoin for $0.011
+    MtGox.buy! 1.0, 0.011
 
-    # Place an order to sell 1 BTC for 20 USD (returns a list of your open orders)
-    puts MtGox.sell! 1.0, 20.0
+    # Place a limit order to sell one bitcoin for $100
+    MtGox.sell! 1.0, 100.0
 
     # Cancel order #1234567890
-    puts MtGox.cancel 1234567890
+    MtGox.cancel 1234567890
 
-    # Send 1 BTC to the author of this gem
-    puts MtGox.send 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L" [TODO]
+    # Withdraw 1 BTC from your account
+    MtGox.withdraw! 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"
 
 Contributing
 ------------

data/lib/mtgox.rb

@@ -6,22 +6,22 @@ module MtGox
     def configure
       yield self
     end
-  end
 
-  # Alias for MtGox::Client.new
-  #
-  # @return [MtGox::Client]
-  def self.new
-    MtGox::Client.new
-  end
+    # Alias for MtGox::Client.new
+    #
+    # @return [MtGox::Client]
+    def new
+      MtGox::Client.new
+    end
 
-  # Delegate to MtGox::Client
-  def self.method_missing(method, *args, &block)
-    return super unless new.respond_to?(method)
-    new.send(method, *args, &block)
-  end
+    # Delegate to MtGox::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
 
-  def self.respond_to?(method, include_private=false)
-    new.respond_to?(method, include_private) || super(method, include_private)
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
   end
 end

data/lib/mtgox/client.rb

@@ -21,6 +21,18 @@ module MtGox
       get('/code/data/ticker.php')['ticker']
     end
 
+    # Fetch both bids and asks in one call, for network efficiency
+    #
+    # @authenticated false
+    # @return [Hashie::Rash] a hash with keys :asks and :bids, which contain arrays as described in #asks and #bids.
+    # @example
+    #   offers = MtGox.offers
+    #   offers.asks[0, 3] #=> [[19.3898, 3.9], [19.4, 48.264], [19.409, 1]]
+    #   offers.bids[0, 3] #=> [[19.3898, 77.42], [19.3, 3.02], [19.29, 82.378]]
+    def offers
+      get('/code/data/getDepth.php')
+    end
+
     # Fetch open asks
     #
     # @authenticated false
@@ -28,7 +40,7 @@ module MtGox
     # @example
     #   MtGox.asks[0, 3] #=> [[19.3898, 3.9], [19.4, 48.264], [19.409, 1]]
     def asks
-      get('/code/data/getDepth.php')['asks']
+      offers['asks']
     end
 
     # Fetch open bids
@@ -38,19 +50,7 @@ module MtGox
     # @example
     #   MtGox.bids[0, 3] #=> [[19.3898, 77.42], [19.3, 3.02], [19.29, 82.378]]
     def bids
-      get('/code/data/getDepth.php')['bids']
-    end
-
-    # Fetch both bids and asks in one call, for network efficiency
-    #
-    # @authenticated false
-    # @return [Hashie::Rash] a hash with keys :asks and :bids, which contain arrays as described in #asks and #bids.
-    # @example
-    #   offers = MtGox.offers
-    #   offers.asks[0, 3] #=> [[19.3898, 3.9], [19.4, 48.264], [19.409, 1]]
-    #   offers.bids[0, 3] #=> [[19.3898, 77.42], [19.3, 3.02], [19.29, 82.378]]
-    def offers
-      get('/code/data/getDepth.php')
+      offers['bids']
     end
 
     # Fetch recent trades
@@ -75,6 +75,16 @@ module MtGox
       post('/code/getFunds.php', pass_params)
     end
 
+    # Fetch your open orders, both buys and sells, for network efficiency
+    #
+    # @authenticated true
+    # @return [<Hashie::Rash>] with keys `buy` and `sell`, which contain arrays as described in {MtGox::Client#buys} and {MtGox::Client#sells}
+    # @example
+    #   MtGox.orders[0, 3]  #=> [<#Hashie::Rash amount=0.73 dark="0" date="1307949196" oid="929284" price=2 status=:active type=2>, <#Hashie::Rash amount=0.36 dark="0" date="1307949201" oid="929288" price=4 status=:active type=2>, <#Hashie::Rash amount=0.24 dark="0" date="1307949212" oid="929292" price=6 status=:active type=2>]
+    def orders
+      post('/code/getOrders.php', pass_params)['orders']
+    end
+
     # Fetch your open buys
     #
     # @authenticated true
@@ -99,47 +109,34 @@ module MtGox
       end
     end
 
-    # Fetch your open orders, both buys and sells, for network efficiency
-    #
-    # @authenticated true
-    # @return [<Hashie::Rash>] with keys `buy` and `sell`, which contain arrays as described in {MtGox::Client#buys} and {MtGox::Client#sells}
-    # @example
-    #   MtGox.orders[0, 3]  #=> [<#Hashie::Rash amount=0.73 dark="0" date="1307949196" oid="929284" price=2 status=:active type=2>, <#Hashie::Rash amount=0.36 dark="0" date="1307949201" oid="929288" price=4 status=:active type=2>, <#Hashie::Rash amount=0.24 dark="0" date="1307949212" oid="929292" price=6 status=:active type=2>]
-    def orders
-      hash = post('/code/getOrders.php', pass_params)['orders']
-    end
-
-    # Place an order to buy
+    # Place a limit order to buy BTC
     #
-    # @todo Return something useful
     # @authenticated true
-    # @param quantity [Numeric] the number of bitcoins to purchase
+    # @param amount [Numeric] the number of bitcoins to purchase
     # @param price [Numeric] the bid price in US dollars
     # @return [Array<Hashie::Rash>]
     # @example
-    #   # Buy one BTC for $25
-    #   MtGox.buy! 1.0, 25.0
-    def buy!(quantity, price)
-      post('/code/buyBTC.php', pass_params.merge({:amount => quantity, :price => price}))
+    #   # Buy one bitcoin for $0.011
+    #   MtGox.buy! 1.0, 0.011
+    def buy!(amount, price)
+      post('/code/buyBTC.php', pass_params.merge({:amount => amount, :price => price}))
     end
 
-    # Place an order to sell
+    # Place a limit order to sell BTC
     #
-    # @todo Return something useful
     # @authenticated true
-    # @param quantity [Numeric] the number of bitcoins to sell
+    # @param amount [Numeric] the number of bitcoins to sell
     # @param price [Numeric] the ask price in US dollars
     # @return [Array<Hashie::Rash>]
     # @example
-    #   # Sell 0.7 BTC for $26
-    #   MtGox.sell! 0.7, 26.0
-    def sell!(quantity, price)
-      post('/code/sellBTC.php', pass_params.merge({:amount => quantity, :price => price}))
+    #   # Sell one bitcoin for $100
+    #   MtGox.sell! 1.0, 100.0
+    def sell!(amount, price)
+      post('/code/sellBTC.php', pass_params.merge({:amount => amount, :price => price}))
     end
 
     # Cancel an open order
     #
-    # @todo Return something useful
     # @authenticated true
     # @overload cancel(oid)
     #   @param oid [String] an order ID
@@ -157,12 +154,12 @@ module MtGox
     #     MtGox.cancel {"oid" => "1234567890", "type" => 2}
     def cancel(args)
       if args.is_a?(Hash)
-        order = args.select{|k, v| ['oid', 'type'].include?(k)}
+        order = args.delete_if{|k, v| !['oid', 'type'].include?(k.to_s)}
         post('/code/cancelOrder.php', pass_params.merge(order))
       else
         order = orders.select{|o| o['oid'] == args.to_s}.first
         if order
-          order.select!{|k, v| ['oid', 'type'].include?(k)}
+          order = order.delete_if{|k, v| !['oid', 'type'].include?(k.to_s)}
           post('/code/cancelOrder.php', pass_params.merge(order))
         else
           raise Faraday::Error::ResourceNotFound, {:status => 404, :headers => {}, :body => "Order not found."}
@@ -170,11 +167,23 @@ module MtGox
       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<Hashie::Rash>]
+    # @example
+    #   # Withdraw 1 BTC from your account
+    #   MtGox.withdraw! 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"
+    def withdraw!(amount, btca)
+      post('/code/withdraw.php', pass_params.merge({:group1 => "BTC", :amount => amount, :btca => btca}))
+    end
+
     private
 
     def pass_params
       {:name => MtGox.name, :pass => MtGox.pass}
     end
-
   end
 end

data/lib/mtgox/connection.rb

@@ -1,4 +1,5 @@
 require 'faraday_middleware'
+require 'mtgox/version'
 
 module MtGox
   module Connection
@@ -6,6 +7,10 @@ module MtGox
 
     def connection
       options = {
+        :headers  => {
+          :accept => 'application/json',
+          :user_agent => "mtgox gem #{MtGox::VERSION}",
+        },
         :ssl => {:verify => false},
         :url => 'https://mtgox.com',
       }

data/lib/mtgox/version.rb

@@ -1,3 +1,3 @@
 module MtGox
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/fixtures/error.json

@@ -0,0 +1 @@
+{"error":"Not logged in."}

data/spec/fixtures/withdraw.json

@@ -0,0 +1 @@
+{"usds":64.59,"btcs":9,"status":"Your funds are on their way..."}

data/spec/helper.rb

@@ -22,7 +22,6 @@ def stub_post(path)
   stub_request(:post, 'https://mtgox.com' + path)
 end
 
-
 def fixture_path
   File.expand_path('../fixtures', __FILE__)
 end

data/spec/mtgox/client_spec.rb

@@ -3,7 +3,10 @@ require 'helper'
 describe MtGox::Client do
   before do
     @client = MtGox::Client.new
-    MtGox.configure {|c| c.name="my_name"; c.pass="my_password"}
+    MtGox.configure do |config|
+      config.name = "my_name"
+      config.pass = "my_password"
+    end
   end
 
   describe '#ticker' do
@@ -54,7 +57,7 @@ describe MtGox::Client do
     end
 
     describe "#offers" do
-      it "should fetch both bids and asks, making only 1 network request" do
+      it "should fetch both bids and asks, with only one call" do
         offers = @client.offers
         a_get('/code/data/getDepth.php').should have_been_made.once
         offers.asks.last.should == [45, 593.28]
@@ -88,12 +91,15 @@ describe MtGox::Client do
   describe '#balance' do
     before do
       stub_post('/code/getFunds.php').
-        to_return(:status => 200, :body => fixture('funds.json'))
+        with(:body => {"name" => "my_name", "pass" => "my_password"}).
+        to_return(:status => 200, :body => fixture('balance.json'))
     end
 
     it "should fetch balance" do
       balance = @client.balance
-      a_post("/code/getFunds.php").should have_been_made
+      a_post("/code/getFunds.php").
+        with(:body => {"name" => "my_name", "pass" => "my_password"}).
+        should have_been_made
       balance.usds.should == 3.7
       balance.btcs.should == 22.0
     end
@@ -102,13 +108,16 @@ describe MtGox::Client do
   describe "order methods" do
     before :each do
       stub_post('/code/getOrders.php').
+        with(:body => {"name" => "my_name", "pass" => "my_password"}).
         to_return(:status => 200, :body => fixture('orders.json'))
     end
 
     describe "#buys" do
       it "should fetch orders" do
         buys = @client.buys
-        a_post("/code/getOrders.php").should have_been_made
+        a_post("/code/getOrders.php").
+          with(:body => {"name" => "my_name", "pass" => "my_password"}).
+          should have_been_made
         buys.last.price.should == 14
       end
     end
@@ -116,15 +125,28 @@ describe MtGox::Client do
     describe "#sells" do
       it "should fetch sells" do
         sells = @client.sells
-        a_post("/code/getOrders.php").should have_been_made
+        a_post("/code/getOrders.php").
+          with(:body => {"name" => "my_name", "pass" => "my_password"}).
+          should have_been_made
         sells.last.price.should == 29.3
       end
     end
+
+    describe "#orders" do
+      it "should fetch both buys and sells, with only one call" do
+        orders = @client.orders
+        a_post("/code/getOrders.php").
+          with(:body => {"name" => "my_name", "pass" => "my_password"}).
+          should have_been_made
+        orders.last.price.should == 29.3
+      end
+    end
   end
 
   describe "#buy!" do
     before do
       stub_post('/code/buyBTC.php').
+        with(:body => {"name" => "my_name", "pass" => "my_password", "amount" => "0.88", "price" => "0.89"}).
         to_return(:status => 200, :body => fixture('buy.json'))
     end
 
@@ -139,6 +161,7 @@ describe MtGox::Client do
   describe "#sell!" do
     before do
       stub_post('/code/sellBTC.php').
+        with(:body => {"name" => "my_name", "pass" => "my_password", "amount" => "0.88", "price" => "89.0"}).
         to_return(:status => 200, :body => fixture('sell.json'))
     end
 
@@ -153,15 +176,19 @@ describe MtGox::Client do
   describe "#cancel" do
     before do
       stub_post('/code/getOrders.php').
+        with(:body => {"name" => "my_name", "pass" => "my_password"}).
         to_return(:status => 200, :body => fixture('orders.json'))
       stub_post('/code/cancelOrder.php').
+        with(:body => {"name" => "my_name", "pass" => "my_password", "oid" => "929284", "type" => "2"}).
         to_return(:status => 200, :body => fixture('cancel.json'))
     end
 
     context "with a valid oid passed" do
       it "should cancel an order" do
         @client.cancel(929284)
-        a_post("/code/getOrders.php").should have_been_made.once
+        a_post("/code/getOrders.php").
+          with(:body => {"name" => "my_name", "pass" => "my_password"}).
+          should have_been_made.once
         a_post('/code/cancelOrder.php').
           with(:body => {"name" => "my_name", "pass" => "my_password", "oid" => "929284", "type" => "2"}).
           should have_been_made
@@ -186,4 +213,18 @@ describe MtGox::Client do
     end
   end
 
+  describe "#withdraw!" do
+    before do
+      stub_post('/code/withdraw.php').
+        with(:body => {"name" => "my_name", "pass" => "my_password", "group1" => "BTC", "amount" => "1.0", "btca" => "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"}).
+        to_return(:status => 200, :body => fixture('withdraw.json'))
+    end
+
+    it "should withdraw funds" do
+      @client.withdraw!(1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L")
+      a_post("/code/withdraw.php").
+        with(:body => {"name" => "my_name", "pass" => "my_password", "group1" => "BTC", "amount" => "1.0", "btca" => "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"}).
+        should have_been_made
+    end
+  end
 end

data/spec/mtgox_spec.rb

@@ -6,17 +6,17 @@ describe MtGox do
       MtGox.new.should be_a MtGox::Client
     end
   end
-  
+
   describe ".configure" do
     it "should set 'name' and 'pass'" do
-      MtGox.configure do |c|
-        c.name="username"
-        c.pass="password"
+      MtGox.configure do |config|
+        config.name = "username"
+        config.pass = "password"
       end
-      
+
       MtGox.name.should == "username"
       MtGox.pass.should == "password"
     end
   end
-  
+
 end

metadata

@@ -2,7 +2,7 @@
 name: mtgox
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Erik Michaels-Ober
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-18 00:00:00 -07:00
+date: 2011-06-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -170,14 +170,16 @@ files:
 - lib/mtgox/request.rb
 - lib/mtgox/version.rb
 - mtgox.gemspec
+- spec/fixtures/balance.json
 - spec/fixtures/buy.json
 - spec/fixtures/cancel.json
 - spec/fixtures/depth.json
-- spec/fixtures/funds.json
+- spec/fixtures/error.json
 - spec/fixtures/orders.json
 - spec/fixtures/sell.json
 - spec/fixtures/ticker.json
 - spec/fixtures/trades.json
+- spec/fixtures/withdraw.json
 - spec/helper.rb
 - spec/mtgox/client_spec.rb
 - spec/mtgox_spec.rb
@@ -210,14 +212,16 @@ signing_key:
 specification_version: 3
 summary: Ruby wrapper for the Mt. Gox Trade API
 test_files: 
+- spec/fixtures/balance.json
 - spec/fixtures/buy.json
 - spec/fixtures/cancel.json
 - spec/fixtures/depth.json
-- spec/fixtures/funds.json
+- spec/fixtures/error.json
 - spec/fixtures/orders.json
 - spec/fixtures/sell.json
 - spec/fixtures/ticker.json
 - spec/fixtures/trades.json
+- spec/fixtures/withdraw.json
 - spec/helper.rb
 - spec/mtgox/client_spec.rb
 - spec/mtgox_spec.rb