crypto_ticker 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 281ca2a5ea59ae06a17409cdbbd40858f9880093
-  data.tar.gz: 58e90d3eda746d158c436c7aff9950ba8e1732d0
+  metadata.gz: dad7e958ea367a57323e38355211c4d97a339a5a
+  data.tar.gz: 325d56318673557d4d897f1be24f38caaf883cb3
 SHA512:
-  metadata.gz: e45195fbcc743a5e1d4cea02e6b183b57d3e03d40c9de19235f63c1b5b6375be9585f19f77b28b04cf6d1a80538869ad4593273914c32be51ae5ff6f5573602e
-  data.tar.gz: 7019ffb86b702820610bdc534d821692ba03450d3efc77700ee716bd3bca200f3a65f9b7e5a89604330dade3f3a2ca72164f1f2abc87a7d2dbff6c69a545c999
+  metadata.gz: 2881c6068641101bdd60c3a62811250686c464b8674e33749d3ab6d1bbe3071d0a3c7949bc1c5fc670712eae0673d80cbe0007a925e65303b43037051a2c72dd
+  data.tar.gz: 11c1ecc13d93e0418919630c5597c00cd55b54488aecf537294a4b61a4193a4777c0c41491991f57df0cc65f64bc8bc26e9684dba9576c56720c3a5e9bf7e89a

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.0.3 (2013-04-21)
+
+Bugfixes:
+
+  -  fix MtGox ticker url
+
+Features:
+
+  - return data values in appropriate format for BTCe.info (BigDecimal, Fixnum, String, etc)
+  - added CryptoTicker::get_class_for() method
+

data/README.md

@@ -32,7 +32,7 @@ Usage
     url  = CryptoTicker::MtGox.ticker('BTC/USD')
     json = agent.get( url ).body 
 
-    mtgox_data_hash = CryptoCurrency::MtGox.info( json )
+    mtgox_data_hash = CryptoTicker::MtGox.info( json )
     pp mtgox_data_hash
 
 Contributing

data/lib/crypto_ticker.rb

@@ -21,17 +21,6 @@ module CryptoTicker
     end
   end
 
-  def self.makepair(base, quote='')
-    if base =~ /([a-z]{3})\/([a-z]{3})/i
-      base, quote = $1, $2
-    end
-    # assume user entered either a fxpair array or a fxpair string
-    # TODO: error-checking on input
-    pair = FXPair.new("#{base.upcase}/#{quote.upcase}")
-    pair
-  end
-
-
   ##
   # MtGox BTC/USD ticker and retrieval method
   #
@@ -42,53 +31,59 @@ module CryptoTicker
   class MtGox
     @@valid_pairs = %w[ BTC/USD LTC/USD NMC/USD ]
 
-    # return a ticker URL for a given crypto FX pair
-    def self.ticker(base, quote='')
-      pair = CryptoTicker::makepair(base, quote)
-      if @@valid_pairs.include?( pair )
-        "http://data.mtgox.com/api/2/" + pair.split('/').join('') +
-          "/money/ticker_fast"
+    class << self
+
+      # return a ticker URL for a given crypto FX pair
+      def ticker(base, quote='')
+        pair = CryptoTicker::makepair(base, quote)
+        if @@valid_pairs.include?( pair )
+          "http://data.mtgox.com/api/2/" + pair.split('/').join('') +
+            "/money/ticker"
+        end
       end
-    end
 
-    def self.trades(base, quote='')
-      pair = CryptoTicker::makepair(base, quote)
-      if @@valid_pairs.include?( pair )
-        "http://data.mtgox.com/api/2/" + pair.split('/').join('') +
-          "/money/trades/fetch"
+      def trades(base, quote='')
+        pair = CryptoTicker::makepair(base, quote)
+        if @@valid_pairs.include?( pair )
+          "http://data.mtgox.com/api/2/" + pair.split('/').join('') +
+            "/money/trades/fetch"
+        end
       end
-    end
 
-    def self.depth(base, quote='')
-      pair = CryptoTicker::makepair(base, quote)
-      if @@valid_pairs.include?( pair )
-        "http://data.mtgox.com/api/2/" + pair.split('/').join('') +
-          "/money/depth/fetch"
+      def depth(base, quote='')
+        pair = CryptoTicker::makepair(base, quote)
+        if @@valid_pairs.include?( pair )
+          "http://data.mtgox.com/api/2/" + pair.split('/').join('') +
+            "/money/depth/fetch"
+        end
       end
-    end
 
-    # Accepts JSON retrieved from the MtGox ticker URL, returns last trade
-    # amount (denominated in counter currency) as a BigDecimal.
-    # eg: BTC/USD ticker will return amount in USD
-    def self.last(json)
-      hash = JSON.parse(json)
-      if hash['result'] === 'success'
-        hash['data']['last']['value'].to_d
+      # Accepts JSON retrieved from the MtGox ticker URL, returns last trade
+      # amount (denominated in counter currency) as a BigDecimal.
+      # eg: BTC/USD ticker will return amount in USD
+      def last(json)
+        hash = JSON.parse(json)
+        if hash['result'] === 'success'
+          hash['data']['last']['value'].to_d
+        end
       end
-    end
 
-    def self.info(json)
-      hash = JSON.parse(json)
-      info = {}
-      if hash['result'] === 'success'
-        hash['data'].each do |k,v|
-          if v.class.to_s.eql?( 'Hash' )
-            info[k.to_sym] = v['value'].to_d
+      def info(json)
+        hash = JSON.parse(json)
+        info = {}
+        if hash['result'] === 'success'
+          hash['data'].each do |k,v|
+            if v.class.to_s.eql?( 'Hash' )
+              info[k.to_sym] = v['value'].to_d
+            end
           end
         end
+
+        # return either nil or the hash w/data
+        info.empty? ? nil : info
       end
-      info
     end
+
   end
 
 
@@ -99,35 +94,78 @@ module CryptoTicker
     @@valid_pairs = %w[ BTC/USD BTC/RUR BTC/EUR LTC/BTC LTC/USD LTC/RUR NMC/BTC
                         USD/RUR EUR/USD NVC/BTC TRC/BTC PPC/BTC RUC/BTC ]
 
-    def self.ticker(base, quote='')
-      pair = CryptoTicker::makepair(base, quote)
-      if @@valid_pairs.include?( pair )
-        "https://btc-e.com/api/2/#{pair.to_sym}/ticker"
+    @@ret_types = {
+        'date'           => :integer,
+        'price'          => :bigdecimal,
+        'amount'         => :bigdecimal,
+        'tid'            => :integer,
+        'item'           => :string,
+        'trade_type'     => :string,
+        'price_currency' => :string,
+        'high'           => :bigdecimal,
+        'low'            => :bigdecimal,
+        'sell'           => :bigdecimal,
+        'buy'            => :bigdecimal,
+        'last'           => :bigdecimal,
+        'vol_cur'        => :bigdecimal,
+        'vol'            => :bigdecimal,
+        'avg'            => :bigdecimal,
+        'server_time'    => :integer,
+    }
+
+    @@ret_fcns = {
+        :integer    => 'to_i',
+        :bigdecimal => 'to_d',
+        :string     => 'to_s',
+    }
+
+    class << self
+
+      def ticker(base, quote='')
+        pair = CryptoTicker::makepair(base, quote)
+        if @@valid_pairs.include?( pair )
+          "https://btc-e.com/api/2/#{pair.to_sym}/ticker"
+        end
       end
-    end
 
-    def self.trades(base, quote='')
-      pair = CryptoTicker::makepair(base, quote)
-      if @@valid_pairs.include?( pair )
-        "https://btc-e.com/api/2/#{pair.to_sym}/trades"
+      def trades(base, quote='')
+        pair = CryptoTicker::makepair(base, quote)
+        if @@valid_pairs.include?( pair )
+          "https://btc-e.com/api/2/#{pair.to_sym}/trades"
+        end
       end
-    end
 
-    def self.depth(base, quote='')
-      pair = CryptoTicker::makepair(base, quote)
-      if @@valid_pairs.include?( pair )
-        "https://btc-e.com/api/2/#{pair.to_sym}/depth"
+      def depth(base, quote='')
+        pair = CryptoTicker::makepair(base, quote)
+        if @@valid_pairs.include?( pair )
+          "https://btc-e.com/api/2/#{pair.to_sym}/depth"
+        end
+      end
+
+      # Accepts JSON retrieved from the appropriate BTC-e ticker URL, returns
+      # last trade amount (denominated in counter currency) as a float.
+      # eg: BTC/USD ticker will return amount in USD
+      #     NMC/BTC ticker will return amount in BTC
+      def last(json)
+        hash = JSON.parse(json)
+        hash['ticker']['last'].to_d
       end
-    end
 
-    # Accepts JSON retrieved from the appropriate BTC-e ticker URL, returns
-    # last trade amount (denominated in counter currency) as a float.
-    # eg: BTC/USD ticker will return amount in USD
-    #     NMC/BTC ticker will return amount in BTC
-    def self.last(json)
-      hash = JSON.parse(json)
-      hash['ticker']['last'].to_d
+
+      def info(json)
+        hash = JSON.parse(json)
+        info = {}
+        # TODO: recursively process Arrays, Hashes, Strings, Fixnums...
+        if hash.has_key?('ticker')
+          hash['ticker'].keys.each do |key|
+            val  = hash['ticker'][key]
+            info[key.to_sym] = val.send(@@ret_fcns[@@ret_types[key]])
+          end
+        end
+        info
+      end
     end
+
   end
 
 
@@ -135,55 +173,107 @@ module CryptoTicker
   # Vircurex ticker API and retrieval method
   class Vircurex
 
-    # accept [base, quote] args for consistency with other classes, but ignore
-    # them
-    def self.ticker(base='', quote='')
-      # this one gets everything...
-      'https://vircurex.com/api/get_info_for_currency.json'
-    end
+    class << self
+      # accept [base, quote] args for consistency with other classes, but ignore
+      # them
+      def ticker(base='', quote='')
+        # this one gets everything...
+        'https://vircurex.com/api/get_info_for_currency.json'
+      end
 
-    # Accepts JSON retrieved from the Vircurex ticker URL, as well as a
-    # currency pair (specified as 2 arguments, a base currency and a quote
-    # currency). Returns last trade amount in quote currency.
-    def self.getpair(json, base, quote)
-      hash = JSON.parse(json)
+      # Accepts JSON retrieved from the Vircurex ticker URL, as well as a
+      # currency pair (specified as 2 arguments, a base currency and a quote
+      # currency). Returns last trade amount in quote currency.
+      def getpair(json, base, quote)
+        hash = JSON.parse(json)
 
-      # upcase currency pair inputs
-      base.upcase!
-      quote.upcase!
+        # upcase currency pair inputs
+        base.upcase!
+        quote.upcase!
+
+        # default value (may change this to just throw an exception)
+        last = 0.0
+
+        # if currency pair exists, return value of last trade
+        if hash.has_key?(base) && hash[base].has_key?( quote ) &&
+           hash[base][quote].has_key?('last_trade')
+            last = hash[base][quote]['last_trade'].to_d
+        end
 
-      # default value (may change this to just throw an exception)
-      last = 0.0
+        last
+      end
+
+      # Accepts JSON retrieved from the Vircurex ticker URL, as well as a
+      # currency pair (specified as 2 arguments, a base currency and a quote
+      # currency). Returns last trade amount in quote currency.
+      def pair_info(json, base, quote)
+        hash = JSON.parse(json)
+
+        # upcase currency pair inputs
+        base.upcase!
+        quote.upcase!
+
+        # default value (may change this to just throw an exception)
+        info = {}
+
+        # if currency pair exists, return value of last trade
+        if hash.has_key?(base) && hash[base].has_key?( quote )
+           info = hash[base][quote]
+        end
 
-      # if currency pair exists, return value of last trade
-      if hash.has_key?(base) && hash[base].has_key?( quote ) &&
-         hash[base][quote].has_key?('last_trade')
-          last = hash[base][quote]['last_trade'].to_d
+        info
       end
 
-      last
     end
+
   end
 
 
   class Bitstamp
     # this exchange only has BTC/USD
-    def self.ticker(base='BTC', quote='USD')
-      'https://www.bitstamp.net/api/ticker/'
-    end
+    class << self
+      def ticker(base='BTC', quote='USD')
+        'https://www.bitstamp.net/api/ticker/'
+      end
 
-    def self.info(json)
-      info = {}
-      JSON.parse(json).each do |k,v|
-        info[k.to_sym] = v.to_d
+      def info(json)
+        info = {}
+        JSON.parse(json).each do |k,v|
+          info[k.to_sym] = v.to_d
+        end
+        info
       end
-      info
+
+      def last(json)
+        self.info(json)[:last]
+      end
+
     end
 
-    def self.last(json)
-      self.info(json)[:last]
+  end
+
+  class << self
+    @@h = {
+      'btce'     => CryptoTicker::BTCe,
+      'mtgox'    => CryptoTicker::MtGox,
+      'vircurex' => CryptoTicker::Vircurex,
+      'bitstamp' => CryptoTicker::Bitstamp,
+    }
+    def get_class_for(exchange_name)
+      @@h[ exchange_name.gsub('-', '').downcase ]
+    end
+
+    def makepair(base, quote='')
+      if base =~ /([a-z]{3})\/([a-z]{3})/i
+        base, quote = $1, $2
+      end
+      # assume user entered either a fxpair array or a fxpair string
+      # TODO: error-checking on input
+      pair = FXPair.new("#{base.upcase}/#{quote.upcase}")
+      pair
     end
 
   end
+
 end
 

data/lib/crypto_ticker/version.rb

@@ -1,3 +1,3 @@
 module CryptoTicker
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/test/test_crypto_ticker.rb

@@ -1,5 +1,7 @@
 require 'minitest_helper'
 require 'uri'
+require 'json'
+require 'pp'
 
 class TestCryptoTicker < MiniTest::Unit::TestCase
   def test_that_it_has_a_version_number
@@ -54,5 +56,42 @@ class TestCryptoTicker < MiniTest::Unit::TestCase
     assert CryptoTicker::Bitstamp.ticker =~ URI::regexp
   end
 
+  def test_btce_parser
+    data = '{"ticker":{"high":99,"low":81,"avg":90,"vol":1857509.30091,"vol_cur":20229.18878,"last":84.5,"buy":84.873,"sell":84.01,"server_time":1366060728}}'
+    info = CryptoTicker::BTCe.info(data)
+
+    assert info.has_key?( :high )
+    assert info.has_key?( :low  )
+    assert info.has_key?( :last )
+
+    assert_equal BigDecimal, info.fetch(:high).class
+    assert_equal BigDecimal, info.fetch(:low ).class
+    assert_equal BigDecimal, info.fetch(:last).class
+  end
+
+  def test_get_class_for
+    klass = CryptoTicker::get_class_for('BTC-e')
+    assert_equal CryptoTicker::BTCe, klass
+
+    klass = CryptoTicker::get_class_for('BTCe')
+    assert_equal CryptoTicker::BTCe, klass
+
+    klass = CryptoTicker::get_class_for('btc-e')
+    assert_equal CryptoTicker::BTCe, klass
+
+    klass = CryptoTicker::get_class_for('MtGox')
+    assert_equal CryptoTicker::MtGox, klass
+
+    klass = CryptoTicker::get_class_for('mtgox')
+    assert_equal CryptoTicker::MtGox, klass
+
+    klass = CryptoTicker::get_class_for('Vircurex')
+    assert_equal CryptoTicker::Vircurex, klass
+
+    klass = CryptoTicker::get_class_for('vircurex')
+    assert_equal CryptoTicker::Vircurex, klass
+  end
+
 end
 
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crypto_ticker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Nathan Marley
@@ -30,7 +30,7 @@ cert_chain:
   p2W7hfexY6Z0vvNPnKZi47PDm0TlB0AbqGorUQFkwwrll4XglFRJGiLooFXN08sC
   6eRTq9IlmYPfHWtlTQo3d1rgg2Bx0ukp9+SbN81z+I7IbqE+
   -----END CERTIFICATE-----
-date: 2013-04-12 00:00:00.000000000 Z
+date: 2013-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md