mtgox 1.0.0 → 1.1.0

data/README.md

@@ -22,7 +22,7 @@ To ensure the code you're installing hasn't been tampered with, it's
 recommended that you verify the signature. To do this, you need to add my
 public key as a trusted certificate (you only need to do this once):
 
-    gem cert --add <(curl -Ls https://gist.github.com/sferik/4701180/raw/public_cert.pem)
+    gem cert --add <(curl -Ls https://raw.github.com/sferik/mtgox/master/certs/sferik.pem)
 
 Then, install the gem with the high security trust policy:
 
@@ -81,6 +81,9 @@ MtGox.cancel 1234567890
 
 # Withdraw 1 BTC from your account
 MtGox.withdraw! 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"
+
+# Switch to sending 'tonce' rather than 'nonce'
+MtGox.nonce_type = :tonce
 ```
 
 ## Contributing

data/lib/mtgox/client.rb

@@ -13,6 +13,7 @@ require 'mtgox/trade'
 require 'mtgox/value'
 require 'mtgox/lag'
 require 'mtgox/configuration'
+require 'mtgox/order_result'
 
 module MtGox
   class Client
@@ -291,6 +292,16 @@ module MtGox
       end
     end
 
+    # Fetch information about a particular transaction
+    #
+    # @authenticated true
+    # @param offer_type [String] 'bid' or 'ask'
+    # @param order_id [String] the order id
+    # @return [OrderResult]
+    def order_result(offer_type, order_id)
+      OrderResult.new(post('/api/1/generic/order/result', {type: offer_type, order: order_id}))
+    end
+
   private
 
     def parse_balance(info)

data/lib/mtgox/configuration.rb

@@ -8,9 +8,11 @@ module MtGox
       :commission,
       :key,
       :secret,
+      :nonce_type
     ]
 
     DEFAULT_COMMISSION = BigDecimal('0.0065').freeze
+    DEFAULT_NONCE_TYPE = :nonce
 
     attr_accessor *VALID_OPTIONS_KEYS
 
@@ -27,9 +29,13 @@ module MtGox
     # Reset all configuration options to defaults
     def reset
       self.commission = DEFAULT_COMMISSION
-      self.key   = nil
-      self.secret   = nil
+      self.key = nil
+      self.secret = nil
       self
     end
+
+    def nonce_type
+      @nonce_type || DEFAULT_NONCE_TYPE
+    end
   end
 end

data/lib/mtgox/order_result.rb

@@ -0,0 +1,49 @@
+module MtGox
+  class OrderResult
+    include Value
+
+    def initialize(json)
+      @json = json
+    end
+
+    def id
+      @json["order_id"]
+    end
+
+    def trades
+      @json["trades"].map{|t| Trade.new(coerce_trade(t)) }
+    end
+
+    def total_spent
+      to_decimal "total_spent", @json
+    end
+
+    def total_amount
+      to_decimal "total_amount", @json
+    end
+
+    def avg_cost
+      to_decimal "avg_cost", @json
+    end
+
+    private
+
+    def to_decimal(key, json)
+      data = json.fetch(key)
+      decimalify(data["value_int"], currency_lookup[data["currency"]])
+    end
+
+    def currency_lookup
+      { "USD" => :usd, "BTC" => :btc, "JPY" => :jpy }
+    end
+
+    def coerce_trade(hash)
+      {
+        "tid"    => hash["trade_id"],
+        "date"   => Time.parse(hash["date"] + " UTC"),
+        "amount" => to_decimal("amount", hash).to_s,
+        "price"  => to_decimal("price", hash).to_s
+      }
+    end
+  end
+end

data/lib/mtgox/request.rb

@@ -44,7 +44,7 @@ module MtGox
     end
 
     def add_nonce(options)
-      options.merge!({nonce: (Time.now.to_f * 1000000).to_i})
+      options.merge!({self.nonce_type => (Time.now.to_f * 1000000).to_i})
     end
   end
 end

data/lib/mtgox/version.rb

@@ -9,7 +9,7 @@ module MtGox
 
       # @return [Integer]
       def minor
-        0
+        1
       end
 
       # @return [Integer]

data/spec/fixtures/order_result.json

@@ -0,0 +1,60 @@
+{
+    "result":"success",
+    "return":
+      {
+        "order_id":"Zda8917a-63d3-4415-b827-758408013691",
+        "trades":[
+          {
+            "trade_id":"1375134017519310",
+            "primary":"Y",
+            "currency":"USD",
+            "type":"ask",
+            "properties":"limit",
+            "item":"BTC",
+            "amount":{
+              "value":"0.10000000",
+              "value_int":"10000000",
+              "display":"0.10000000 BTC",
+              "display_short":"0.10 BTC",
+              "currency":"BTC"
+            },
+            "price":{
+              "value":"100.83227",
+              "value_int":"10083227",
+              "display":"$100.83227",
+              "display_short":"$100.83",
+              "currency":"USD"
+            },
+            "spent":{
+              "value":"10.08323",
+              "value_int":"1008323",
+              "display":"$10.08323",
+              "display_short":"$10.08",
+              "currency":"USD"
+            },
+            "date":"2013-07-29 21:40:17"
+          }
+        ],
+        "total_amount":{
+          "value":"0.10000000",
+          "value_int":"10000000",
+          "display":"0.10000000 BTC",
+          "display_short":"0.10 BTC",
+          "currency":"BTC"
+        },
+        "total_spent":{
+          "value":"10.08323",
+          "value_int":"1008323",
+          "display":"$10.08323",
+          "display_short":"$10.08",
+          "currency":"USD"
+        },
+        "avg_cost":{
+          "value":"100.83230",
+          "value_int":"10083230",
+          "display":"$100.83230",
+          "display_short":"$100.83",
+          "currency":"USD"
+        }
+      }
+}

data/spec/helper.rb

@@ -49,7 +49,7 @@ module MtGox
   module Request
   private
     def add_nonce(options)
-      options.merge!({nonce: 1321745961249676})
+      options.merge!({self.nonce_type => 1321745961249676})
     end
   end
 end

data/spec/mtgox/client_spec.rb

@@ -358,4 +358,41 @@ describe MtGox::Client do
       }.to raise_error(MtGox::FilthyRichError)
     end
   end
+
+  describe "nonce_type" do
+    before do
+      stub_post('/api/1/generic/bitcoin/address').
+        to_return(body: fixture('address.json'))
+    end
+
+    it "uses nonce by default" do
+      address = @client.address
+      expect(a_post('/api/1/generic/bitcoin/address').with(nonce: 1321745961249676)).to have_been_made
+    end
+
+    it "is capable of using tonce" do
+      @client.nonce_type = :tonce
+      address = @client.address
+      expect(a_post('/api/1/generic/bitcoin/address').with(tonce: 1321745961249676)).to have_been_made
+    end
+  end
+
+  describe "#order_result" do
+    context "for a valid order id" do
+      let(:order_id) { "Zda8917a-63d3-4415-b827-758408013691" }
+      let(:body) { test_body({"type" => "bid", "order" => order_id}) }
+
+      before do
+        stub_post('/api/1/generic/order/result').
+          with(body: body, headers: test_headers(@client, body)).
+          to_return(body: fixture('order_result.json'))
+      end
+
+      it "returns an order result" do
+        order_result = @client.order_result("bid", order_id)
+        expect(a_post("/api/1/generic/order/result").with(body: body, headers: test_headers(@client, body))).to have_been_made
+        expect(order_result.id).to eq order_id
+      end
+    end
+  end
 end

data/spec/mtgox/order_result_spec.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+describe MtGox::OrderResult do
+  let(:json) { JSON.parse(File.read(fixture("order_result.json")))["return"] }
+  subject { described_class.new(json) }
+
+  describe '#total_spent' do
+    it "returns a decimal" do
+      expect(subject.total_spent).to eq BigDecimal.new('10.08323')
+    end
+  end
+
+  describe '#total_amount' do
+    it "returns a decimal" do
+      expect(subject.total_amount).to eq BigDecimal.new('0.10')
+    end
+  end
+
+  describe '#avg_cost' do
+    it "returns a decimal" do
+      expect(subject.avg_cost).to eq BigDecimal.new('100.83230')
+    end
+  end
+
+  describe "#trades" do
+    it "returns an array of Trade objects" do
+      trade = subject.trades.first
+      expect(trade.id).to eq 1375134017519310
+      expect(trade.date).to eq Time.parse('2013-07-29 21:40:17 UTC')
+      expect(trade.amount).to eq BigDecimal.new("0.10000000")
+      expect(trade.price).to eq BigDecimal.new("100.83227")
+    end
+  end
+end

data/spec/mtgox_spec.rb

@@ -17,6 +17,14 @@ describe MtGox do
       expect(MtGox.key).to eq "key"
       expect(MtGox.secret).to eq "secret"
     end
+
+    it "allows setting nonce type" do
+      expect(MtGox.nonce_type).to eq(:nonce)
+      MtGox.configure do |config|
+        config.nonce_type = :tonce
+      end
+      expect(MtGox.nonce_type).to eq(:tonce)
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mtgox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   U0xxV3ZRUnNCbHlwSGZoczZKSnVMbHlaUEdoVTNSL3YKU2YzbFZLcEJDV2dS
   cEdUdnk0NVhWcEIrNTl5MzNQSm1FdVExUFRFT1l2UXlhbzlVS01BQWFBTi83
   cVdRdGpsMApobHc9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
-date: 2013-05-12 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -127,6 +127,7 @@ files:
 - lib/mtgox/min_ask.rb
 - lib/mtgox/offer.rb
 - lib/mtgox/order.rb
+- lib/mtgox/order_result.rb
 - lib/mtgox/price_ticker.rb
 - lib/mtgox/request.rb
 - lib/mtgox/response/parse_json.rb
@@ -146,6 +147,7 @@ files:
 - spec/fixtures/info.json
 - spec/fixtures/lag.json
 - spec/fixtures/mysql_error
+- spec/fixtures/order_result.json
 - spec/fixtures/orders.json
 - spec/fixtures/sell.json
 - spec/fixtures/ticker.json
@@ -154,6 +156,7 @@ files:
 - spec/fixtures/withdraw.json
 - spec/helper.rb
 - spec/mtgox/client_spec.rb
+- spec/mtgox/order_result_spec.rb
 - spec/mtgox_spec.rb
 homepage: https://github.com/sferik/mtgox
 licenses: []
@@ -190,6 +193,7 @@ test_files:
 - spec/fixtures/info.json
 - spec/fixtures/lag.json
 - spec/fixtures/mysql_error
+- spec/fixtures/order_result.json
 - spec/fixtures/orders.json
 - spec/fixtures/sell.json
 - spec/fixtures/ticker.json
@@ -198,5 +202,6 @@ test_files:
 - spec/fixtures/withdraw.json
 - spec/helper.rb
 - spec/mtgox/client_spec.rb
+- spec/mtgox/order_result_spec.rb
 - spec/mtgox_spec.rb
 has_rdoc: