crypto_ticker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 281ca2a5ea59ae06a17409cdbbd40858f9880093
+  data.tar.gz: 58e90d3eda746d158c436c7aff9950ba8e1732d0
+SHA512:
+  metadata.gz: e45195fbcc743a5e1d4cea02e6b183b57d3e03d40c9de19235f63c1b5b6375be9585f19f77b28b04cf6d1a80538869ad4593273914c32be51ae5ff6f5573602e
+  data.tar.gz: 7019ffb86b702820610bdc534d821692ba03450d3efc77700ee716bd3bca200f3a65f9b7e5a89604330dade3f3a2ca72164f1f2abc87a7d2dbff6c69a545c999

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crypto_ticker.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nathan Marley
+
+MIT License
+
+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,54 @@
+
+CryptoTicker
+============
+
+Collection of public data API urls for various online crypto-currency
+exchanges, e.g. MtGox, BTC-e, etc.
+
+I tried to follow the UNIX philosophy of "write programs which do one thing and
+do it well", so this module doesn't include a user-agent module. It only
+provides public data API URL's in one convenient location, and optionally,
+parses the data returned from those URLs. You'll have to use this in
+conjunction with 'mechanize' or 'net/http' or some other such module to
+actually do anything (see [example](#example)).
+
+Installation
+------------
+
+    gem install crypto_ticker
+
+Usage
+-----
+
+### Example
+
+    require 'crypto_ticker'
+    require 'mechanize'
+    require 'pp'
+
+    agent = Mechanize.new
+
+    # get MtGox BTC/USD ticker URL:
+    url  = CryptoTicker::MtGox.ticker('BTC/USD')
+    json = agent.get( url ).body 
+
+    mtgox_data_hash = CryptoCurrency::MtGox.info( json )
+    pp mtgox_data_hash
+
+Contributing
+------------
+
+1. Fork it (Github repo: [homepage][homepage])
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[homepage]: https://github.com/nmarley/crypto_ticker
+
+
+License
+-------
+Released under the MIT License.  See the [LICENSE][] file for further details.
+
+[license]: LICENSE.md

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib" << "test"
+end
+
+task :default => :test

data/crypto_ticker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require 'crypto_ticker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crypto_ticker"
+  spec.version       = CryptoTicker::VERSION
+  spec.authors       = ["Nathan Marley"]
+  spec.email         = ["nmarley@blackcarrot.be"]
+  spec.description   = %q{Collection of public data API urls for various online
+                          crypto-currency exchanges, e.g. MtGox, BTC-e, etc.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/nmarley/crypto_ticker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/crypto_ticker/version.rb

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

data/lib/crypto_ticker.rb

@@ -0,0 +1,189 @@
+
+require 'crypto_ticker/version'
+require 'json'
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+##
+# This module bundles crypto-currency exchange public data API sources. (e.g.
+# Bitcoin exchange rate, Litecoin, etc.)
+
+module CryptoTicker
+
+  class FXPair < String
+    def to_sym
+      self.downcase.split('/').join('_').to_sym
+    end
+  end
+  class Symbol
+    def to_fxpair
+      FXPair.new( self.to_s.split('_').join('/').upcase )
+    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
+  #
+  # note: The official MtGox API documentation is very sparse, and some methods
+  # are published but undocumented. The 'ticker' method should work, others may
+  # lag or return large amounts of data.
+
+  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"
+      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"
+      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"
+      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
+      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
+          end
+        end
+      end
+      info
+    end
+  end
+
+
+  ##
+  # BTC-e tickers for various crypto-currencies and retrieval methods
+
+  class BTCe
+    @@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"
+      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"
+      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"
+      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
+    end
+  end
+
+
+  ##
+  # 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
+
+    # 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)
+
+      # 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
+
+      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
+
+    def self.info(json)
+      info = {}
+      JSON.parse(json).each do |k,v|
+        info[k.to_sym] = v.to_d
+      end
+      info
+    end
+
+    def self.last(json)
+      self.info(json)[:last]
+    end
+
+  end
+end
+

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'crypto_ticker'
+
+require 'minitest/autorun'

data/test/test_crypto_ticker.rb

@@ -0,0 +1,58 @@
+require 'minitest_helper'
+require 'uri'
+
+class TestCryptoTicker < MiniTest::Unit::TestCase
+  def test_that_it_has_a_version_number
+    refute_nil ::CryptoTicker::VERSION
+  end
+
+  def test_urls
+    # BTC-e
+    # BTC/USD
+    assert CryptoTicker::BTCe.ticker('BTC/USD')   =~ URI::regexp
+    assert CryptoTicker::BTCe.ticker('BTC','USD') =~ URI::regexp
+    assert CryptoTicker::BTCe.ticker('btc','usd') =~ URI::regexp
+    assert CryptoTicker::BTCe.ticker('bTC','UsD') =~ URI::regexp
+
+    # LTC/USD
+    assert CryptoTicker::BTCe.ticker('ltc', 'usd') =~ URI::regexp
+
+    # LTC/BTC
+    assert CryptoTicker::BTCe.ticker('ltc', 'btc') =~ URI::regexp
+
+    # other
+    assert CryptoTicker::BTCe.ticker('NMC/BTC') =~ URI::regexp
+    assert CryptoTicker::BTCe.ticker('NVC/BTC') =~ URI::regexp
+    assert CryptoTicker::BTCe.ticker('PPC/BTC') =~ URI::regexp
+    assert CryptoTicker::BTCe.ticker('RUC/BTC') =~ URI::regexp
+
+    # invalid
+    assert_nil CryptoTicker::BTCe.ticker('USD/BTC')
+    assert_nil CryptoTicker::BTCe.ticker('usd', 'btc')
+
+    # invalid - order is important
+    assert_nil CryptoTicker::BTCe.ticker('btc', 'ltc')
+
+    # invalid
+    assert_nil CryptoTicker::BTCe.ticker('xyz', 'abc')
+
+    # trades
+    assert CryptoTicker::BTCe.trades('BTC/USD') =~ URI::regexp
+
+    # depth
+    assert CryptoTicker::BTCe.depth('BTC/USD') =~ URI::regexp
+
+    # MtGox
+    assert CryptoTicker::MtGox.ticker('BTC/USD') =~ URI::regexp
+    assert CryptoTicker::MtGox.trades('BTC/USD') =~ URI::regexp
+    assert CryptoTicker::MtGox.depth('BTC/USD')  =~ URI::regexp
+
+    # Vircurex
+    assert CryptoTicker::Vircurex.ticker =~ URI::regexp
+
+    # Bitstamp
+    assert CryptoTicker::Bitstamp.ticker =~ URI::regexp
+  end
+
+end
+

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: crypto_ticker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Marley
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDgDCCAmigAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRAwDgYDVQQDDAdubWFy
+  bGV5MRswGQYKCZImiZPyLGQBGRYLYmxhY2tjYXJyb3QxEjAQBgoJkiaJk/IsZAEZ
+  FgJiZTAeFw0xMzA0MTIwMDE4MTlaFw0xNDA0MTIwMDE4MTlaMEMxEDAOBgNVBAMM
+  B25tYXJsZXkxGzAZBgoJkiaJk/IsZAEZFgtibGFja2NhcnJvdDESMBAGCgmSJomT
+  8ixkARkWAmJlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuQ0VQJNd
+  T5GC2teIXNmj78duQubODm/eQz+vWEMgRxtmINLL57QNgEgiZ59Enb2whyy1cAJr
+  Z0azyyXJwnVYbYJZ5VjPmUXkoNfthhHgHih4oGSnC8Ub4lEF6LUHwmHH6coQmz/k
+  bCUmJGE+karsVI3YE3Nkgq/cw2wOKq04R8vyf6kWW9n6DEbObTXW56vjEGtsi6tS
+  rVHz4qEa3CJ6XTowJo59mL+ddHaaoveOhfo0iVk71Om2jI5R6ffCMzgmS0yMGBOT
+  jSmdZfblBvg0rKBVyF963VrObAQJl1sb45tcZx//dmmt1wuYk0+moZJPReQnAYHj
+  QuIp6Olls1SjXwIDAQABo38wfTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+  HQ4EFgQU7o6LAzq+Ik/b86ejLDip10QFPUIwIQYDVR0RBBowGIEWbm1hcmxleUBi
+  bGFja2NhcnJvdC5iZTAhBgNVHRIEGjAYgRZubWFybGV5QGJsYWNrY2Fycm90LmJl
+  MA0GCSqGSIb3DQEBBQUAA4IBAQBG3mXb97FLZJWMTHacwdAGHQvWapr0wm1o+wcK
+  /c/j8urpE5XR7GY8vvE/udZUESUH9wGqj2rZAtAKu75NpAkHJNNlVI62NDcEU9Uc
+  rWeJGSfYm9j6F9l8Uq5SRP5vzoLarS7eIc85U3lnLysCnWE0h9a+XB8ciixieZk9
+  uhWqQz/wL33i+0F12jzvkaekeWzRyYyfyB4Ra9is8st2Hsu6xp7o9DWWZKHjF/xc
+  p2W7hfexY6Z0vvNPnKZi47PDm0TlB0AbqGorUQFkwwrll4XglFRJGiLooFXN08sC
+  6eRTq9IlmYPfHWtlTQo3d1rgg2Bx0ukp9+SbN81z+I7IbqE+
+  -----END CERTIFICATE-----
+date: 2013-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Collection of public data API urls for various online
+                            crypto-currency exchanges, e.g. MtGox, BTC-e, etc.
+email:
+- nmarley@blackcarrot.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- crypto_ticker.gemspec
+- lib/crypto_ticker.rb
+- lib/crypto_ticker/version.rb
+- test/minitest_helper.rb
+- test/test_crypto_ticker.rb
+homepage: https://github.com/nmarley/crypto_ticker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Collection of public data API urls for various online crypto-currency exchanges,
+  e.g. MtGox, BTC-e, etc.
+test_files:
+- test/minitest_helper.rb
+- test/test_crypto_ticker.rb
+has_rdoc: