mtgox 0.4.1 → 0.5.0

data/lib/faraday/response/raise_mtgox_error.rb

@@ -9,4 +9,3 @@ module Faraday
     end
   end
 end
-

data/lib/mtgox/ask.rb

@@ -0,0 +1,11 @@
+require 'mtgox/offer'
+
+module MtGox
+  class Ask < Offer
+
+    def eprice
+      price / (1 - commission)
+    end
+
+  end
+end

data/lib/mtgox/bid.rb

@@ -0,0 +1,11 @@
+require 'mtgox/offer'
+
+module MtGox
+  class Bid < Offer
+
+    def eprice
+      price * (1 - commission)
+    end
+
+  end
+end

data/lib/mtgox/client.rb

@@ -1,7 +1,9 @@
-require 'hashie'
 require 'faraday/error'
-require 'rash'
+require 'mtgox/ask'
+require 'mtgox/bid'
 require 'mtgox/connection'
+require 'mtgox/max_bid'
+require 'mtgox/min_ask'
 require 'mtgox/request'
 
 module MtGox
@@ -27,21 +29,25 @@ module MtGox
     # @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]]
+    #   offers.asks[0, 3]
+    #   offers.bids[0, 3]
     def offers
       offers = get('/code/data/getDepth.php')
-      offers['asks'] = offers['asks'].sort_by{|a| a[0]}
-      offers['bids'] = offers['bids'].sort_by{|b| b[0]}.reverse
+      offers['asks'] = offers['asks'].sort_by{|ask| ask[0].to_f}.map do |ask|
+        Ask.new({:price => ask[0].to_f, :amount => ask[1].to_f})
+      end
+      offers['bids'] = offers['bids'].sort_by{|bid| bid[0].to_f}.reverse.map do |bid|
+        Bid.new({:price => bid[0].to_f, :amount => bid[1].to_f})
+      end
       offers
     end
 
     # Fetch open asks
     #
     # @authenticated false
-    # @return [Array<Array<Numeric>>] in the form `[price, quantity]`, sorted in price ascending order
+    # @return [Array<Ask>] in the form `[price, amount]`, sorted in price ascending order
     # @example
-    #   MtGox.asks[0, 3] #=> [[19.3898, 3.9], [19.4, 48.264], [19.409, 1]]
+    #   MtGox.asks[0, 3]
     def asks
       offers['asks']
     end
@@ -49,13 +55,39 @@ module MtGox
     # Fetch open bids
     #
     # @authenticated false
-    # @return [Array<Array<Numeric>>] in the form `[price, quantity]`, sorted in price descending order
+    # @return [Array<Bid>] in the form `[price, amount]`, sorted in price descending order
     # @example
-    #   MtGox.bids[0, 3] #=> [[19.3898, 77.42], [19.3, 3.02], [19.29, 82.378]]
+    #   MtGox.bids[0, 3]
     def bids
       offers['bids']
     end
 
+    # Fetch the lowest priced ask
+    #
+    # @authenticated false
+    # @return [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 [MinBin]
+    # @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

data/lib/mtgox/connection.rb

@@ -1,4 +1,8 @@
 require 'faraday'
+require 'faraday/request/url_encoded'
+require 'faraday/response/raise_error'
+require 'faraday/response/rashify'
+require 'faraday/response/parse_json'
 require 'faraday/response/raise_mtgox_error'
 require 'faraday_middleware'
 require 'mtgox/version'

data/lib/mtgox/max_bid.rb

@@ -0,0 +1,32 @@
+require 'mtgox/bid'
+require 'singleton'
+
+module MtGox
+  class MaxBid < Bid
+    include Singleton
+    attr_accessor :previous_price
+
+    def price=(price)
+      @previous_price = @price
+      @price = price
+    end
+
+    def up?
+      price > previous_price.to_f
+    end
+
+    def down?
+      price < previous_price.to_f
+    end
+
+    def changed?
+      price != previous_price.to_f
+    end
+
+    def unchanged?
+      !changed?
+    end
+    alias :unch? :unchanged?
+
+  end
+end

data/lib/mtgox/min_ask.rb

@@ -0,0 +1,32 @@
+require 'mtgox/ask'
+require 'singleton'
+
+module MtGox
+  class MinAsk < Ask
+    include Singleton
+    attr_accessor :previous_price
+
+    def price=(price)
+      @previous_price = @price
+      @price = price
+    end
+
+    def up?
+      price > previous_price.to_f
+    end
+
+    def down?
+      price < previous_price.to_f
+    end
+
+    def changed?
+      price != previous_price.to_f
+    end
+
+    def unchanged?
+      !changed?
+    end
+    alias :unch? :unchanged?
+
+  end
+end

data/lib/mtgox/offer.rb

@@ -0,0 +1,12 @@
+module MtGox
+  class Offer
+    attr_accessor :amount, :price
+
+    def initialize(attributes={})
+      attributes.each_pair do |key, value|
+        self.send(:"#{key}=", value) if self.respond_to?(:"#{key}=")
+      end
+    end
+
+  end
+end

data/lib/mtgox/version.rb

@@ -1,3 +1,3 @@
 module MtGox
-  VERSION = "0.4.1".freeze unless defined? ::MtGox::VERSION
+  VERSION = "0.5.0".freeze unless defined? ::MtGox::VERSION
 end

data/spec/mtgox/client_spec.rb

@@ -32,12 +32,13 @@ describe MtGox::Client do
       it "should fetch open asks" do
         asks = @client.asks
         a_get('/code/data/getDepth.php').should have_been_made
-        asks.last.should == [23.75, 50]
+        asks.last.price.should == 23.75
+        asks.last.amount.should == 50
       end
 
       it "should be sorted in price-ascending order" do
         asks = @client.asks
-        asks.sort_by {|x| x[0]}.should == asks
+        asks.sort_by{|ask| ask.price}.should == asks
       end
 
     end
@@ -46,22 +47,42 @@ describe MtGox::Client do
       it "should fetch open bids" do
         bids = @client.bids
         a_get('/code/data/getDepth.php').should have_been_made
-        bids.last.should == [14.62101, 5]
+        bids.last.price.should == 14.62101
+        bids.last.amount.should == 5
       end
 
       it "should be sorted in price-descending order" do
         bids = @client.bids
-        bids.sort_by {|x| x[0]}.reverse.should == bids
+        bids.sort_by{|bid| bid.price}.reverse.should == bids
       end
-
     end
 
     describe "#offers" 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 == [23.75, 50]
-        offers.bids.last.should == [14.62101, 5]
+        offers.asks.last.price.should == 23.75
+        offers.asks.last.amount.should == 50
+        offers.bids.last.price.should == 14.62101
+        offers.bids.last.amount.should == 5
+      end
+    end
+
+    describe '#min_ask' do
+      it "should fetch the lowest priced ask" do
+        min_ask = @client.min_ask
+        a_get('/code/data/getDepth.php').should have_been_made.once
+        min_ask.price.should == 17.00009
+        min_ask.amount.should == 36.22894353
+      end
+    end
+
+    describe '#max_bid' do
+      it "should fetch the highest priced bid" do
+        max_bid = @client.max_bid
+        a_get('/code/data/getDepth.php').should have_been_made.once
+        max_bid.price.should == 17.0
+        max_bid.amount.should == 82.53875035
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mtgox
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-09 00:00:00.000000000 -07:00
+date: 2011-07-11 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70166558648200 !ruby/object:Gem::Requirement
+  requirement: &70296472632860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '4.5'
   type: :development
   prerelease: false
-  version_requirements: *70166558648200
+  version_requirements: *70296472632860
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70166558647540 !ruby/object:Gem::Requirement
+  requirement: &70296476464400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *70166558647540
+  version_requirements: *70296476464400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70166558645320 !ruby/object:Gem::Requirement
+  requirement: &70296476463020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70166558645320
+  version_requirements: *70296476463020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70166558644460 !ruby/object:Gem::Requirement
+  requirement: &70296476461680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70166558644460
+  version_requirements: *70296476461680
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70166558643500 !ruby/object:Gem::Requirement
+  requirement: &70296476460820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70166558643500
+  version_requirements: *70296476460820
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70166558642920 !ruby/object:Gem::Requirement
+  requirement: &70296476459800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70166558642920
+  version_requirements: *70296476459800
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70166558642300 !ruby/object:Gem::Requirement
+  requirement: &70296476458840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70166558642300
+  version_requirements: *70296476458840
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70166558641240 !ruby/object:Gem::Requirement
+  requirement: &70296476458200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,10 +99,10 @@ dependencies:
         version: 0.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *70166558641240
+  version_requirements: *70296476458200
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70166558639820 !ruby/object:Gem::Requirement
+  requirement: &70296476457560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +110,10 @@ dependencies:
         version: 0.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *70166558639820
+  version_requirements: *70296476457560
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70166558638900 !ruby/object:Gem::Requirement
+  requirement: &70296476482740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +121,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70166558638900
+  version_requirements: *70296476482740
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70166558637700 !ruby/object:Gem::Requirement
+  requirement: &70296476481880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +132,10 @@ dependencies:
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *70166558637700
+  version_requirements: *70296476481880
 - !ruby/object:Gem::Dependency
   name: rash
-  requirement: &70166558630760 !ruby/object:Gem::Requirement
+  requirement: &70296476481100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -143,7 +143,7 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70166558630760
+  version_requirements: *70296476481100
 description: Ruby wrapper for the Mt. Gox Trade API. Mt. Gox allows you to trade US
   Dollars (USD) for Bitcoins (BTC) or Bitcoins for US Dollars.
 email: sferik@gmail.com
@@ -163,10 +163,15 @@ files:
 - Rakefile
 - lib/faraday/response/raise_mtgox_error.rb
 - lib/mtgox.rb
+- lib/mtgox/ask.rb
+- lib/mtgox/bid.rb
 - lib/mtgox/client.rb
 - lib/mtgox/configuration.rb
 - lib/mtgox/connection.rb
 - lib/mtgox/error.rb
+- lib/mtgox/max_bid.rb
+- lib/mtgox/min_ask.rb
+- lib/mtgox/offer.rb
 - lib/mtgox/request.rb
 - lib/mtgox/version.rb
 - mtgox.gemspec