trades 0.2.1 → 1.0

data/bin/trades

@@ -1,9 +1,54 @@
 #!/usr/bin/env ruby
-
-require 'trades'
+# encoding: utf-8
 
 begin
-  Trades.new ARGV
-rescue SystemExit, Interrupt
-  puts "\nQuitting..."
+  require 'bundler/setup'
+  require 'colored'
+  require 'optparse'
+  require 'socket'
+  require 'trades'
+  
+  options = TradeOptions.parse(ARGV)
+  
+  # Connect to Bitcoincharts.com
+  puts "Connecting to bitcoincharts.com..."
+  if socket = TCPSocket.open("bitcoincharts.com", 27007)
+    puts "Connected.\n".green
+    puts "Market          | Time     | Currency  | Price     | Volume"
+    
+    options.logger.info "Trades has been started.\n" if options.log
+  end
+  
+  last_price = {}
+  
+  while data = socket.gets do
+    trade = Trade.new data
+    
+    # Check if the trade should be displayed
+    if options.filter == :markets && options.markets.length > 0
+      next unless options.markets.include? trade.market
+    end
+    if options.filter == :currencies && options.currencies.length > 0
+      next unless options.currencies.include? trade.currency
+    end
+    
+    # Compare price of this trade with last trade
+    unless last_price[trade.market].nil?
+      price = trade.price # we need to save an uncolored copy later
+      trade.price.green if price > last_price[trade.market]
+      trade.price.red if price < last_price[trade.market]
+      last_price[trade.market] = price
+    end
+      
+    puts trade
+    options.logger.info trade if options.log
+  end
+rescue Interrupt  
+  puts " Disconnecting..."
+  
+  options.logger.info "\nTrades has been closed.\n\n" if options.log
+rescue OptionParser::ParseError => error
+  puts "Something went wrong".red + "\n#{error}\n\nType 'trades -h' for help"
+rescue => error
+  puts "Disconnected: #{error}"
 end

data/lib/trades.rb

@@ -1,54 +1,2 @@
-require 'rubygems'
-require 'socket'
-require 'json'
-require 'colored'
-
-class Trades
-  def initialize(args = [])
-    begin
-      puts "Connecting to bitcoincharts.com..."
-      @socket      = TCPSocket.open("bitcoincharts.com", 27007)
-      @markets     = []
-      @last_prices = {}
-
-      # Convert the market names to lowercase
-      # (CHANGE THIS TO CASE INSENSITIVE REGEX)
-      args.each do |x| @markets.push(x.downcase) end
-      args.clear # no need to keep them in memory
-
-      #     thUSD          | 2011-06-27 23:00:55 | USD      | 17.05    | 0.5       |
-      puts "Exchange       | Date and time       | Currency | Price    | Volume    |"
-      
-      self.loop
-    rescue
-      puts "Error: #{$!}"
-    end
-  end
-  
-  def loop
-    while data = @socket.gets do
-      if data.length > 0 then 
-        j = JSON.parse(data.strip.tr("\x00", '')) # Delete all \x00 weirdness
-    
-        if @markets.empty? or @markets.include?(j['symbol'].downcase) then
-          line  = j['symbol'].ljust(15) + "| " # market
-          line += Time.at(j['timestamp']).strftime("%Y-%m-%d %H:%M:%S") + " | "
-          line += j['currency'].ljust(9) + "| " # currency
-          
-          # Price: display higher price in green / lower price in red
-          current_price = j['price'].round(2)
-          last_price    = @last_prices[j['symbol']].to_f # Its nil on startup
-          @last_prices[j['symbol']] = current_price # store for next comparison
-          
-          price = current_price.to_s.ljust(9)
-          price = price.green if current_price > last_price unless last_price.zero?
-          price = price.red if current_price < last_price
-          
-          line += price + "| " + j['volume'].round(2).to_s.ljust(9) + " |"
-    
-          puts line
-        end
-      end
-    end
-  end
-end
+require 'trades/trade'
+require 'trades/options'

data/lib/trades/options.rb

@@ -0,0 +1,97 @@
+require 'ostruct'
+require 'logger'
+
+class TradeOptions
+  # Define markets, market aliases and currencies
+  MARKETS    = %w[mtgoxUSD thUSD mtgoxEUR virwoxSLL mtgoxGBP intrsngGBP 
+    virtexCAD btceUSD cbxUSD btcexUSD btcdeEUR wbxAUD mtgoxRUB bitmarketEUR 
+    mtgoxPLN thEUR mtgoxCAD intrsngUSD mtgoxAUD intrsngEUR btcnCNY thAUD 
+    bitstampUSD mtgoxHKD intsngPLN bitmarketUSD bitnzNZD thLRUSD thINR rockSSL 
+    mtgoxSGD b2cUSD aqoinEUR mtgoxSEK ruxumUSD thCLP mrcdBRL mtgoxCNY mtgoxCHF 
+    mtgoxDKK bitfloorUSD ruxumJPY bitmarketAUD mtgoxJPY ruxumZAR bitmarketPLN 
+    ruxumSEK ruxumRUB rockEUR mtgoxNZD rockUSD ruxumCHF bbmBRL globalPLN 
+    globalGBP bitmarketRUB ruxumHUF mtgoxTHB ruxumAUD ruxumEUR globalEUR 
+    bitmarketGBP ruxumGBP ruxumPLN ruxumSGD ruxumTHB ruxumUAH globalUSD]
+  ALIASES    = {"mtgox" => "mtgoxUSD", "th" => "thUSD", "tradehill" => "thUSD"}
+  CURRENCIES = {
+    "usd" => "USD", "dollar" => "USD", "us" => "USD",
+    "eur" => "EUR", "euro" => "EUR", "euros" => "EUR",
+    "gbp" => "GBP", "pound" => "GBP",
+    "ssl" => "SSL", "secondlife" => "SSL",
+    "cny" => "CNY", 
+    "cad" => "CAD", "canadian" => "CAD",
+    "aud" => "AUD", "australian" => "AUD", "aus" => "AUD",
+    "rub" => "RUB", "russian" => "RUB", "rubble" => "RUB",
+    "pln" => "PLN", "polish" => "PLN",
+    "hkd" => "HKD", "hongkong" => "HKD",
+    "nzd" => "NZD", "newzealand" => "NZD", "nz" => "NZD",
+    "sgd" => "SGD",
+    "sek" => "SEK",
+    "clp" => "CLP",
+    "brl" => "BRL",
+    "chf" => "CHF",
+    "dkk" => "DKK",
+    "jpy" => "JPY", "yen" => "JPY", "japan" => "JPY",
+    "zar" => "ZAR",
+    "huf" => "HUF",
+    "thb" => "THB",
+    "uah" => "UAH"
+  }
+
+  def self.parse(args)
+    # Default options
+    options            = OpenStruct.new
+    options.filter     = :markets
+    options.markets    = []
+    options.currencies = []
+
+    opts = OptionParser.new do |opts|
+    	opts.banner = "Usage: trades [options]\n\n"
+
+      opts.separator "Options:"
+
+      # Filter on market
+      opts.on("-m", "--market MARKET", MARKETS, ALIASES, 
+        "Filter on MARKET") do |m|
+        options.markets << m # << because of multiple currencies
+      end
+
+      # Filter on currency
+      opts.on("-c", "--currency CURRENCY", CURRENCIES.values.uniq, CURRENCIES, 
+    	  "Filter on CURRENCY") do |c|
+    	  options.filter = :currencies # default is :markets
+    	  options.currencies << c # << because of multiple currencies
+      end
+
+    	# Logging
+    	opts.on("-l", "--log [FILENAME]", "Log the results to FILENAME") do |file|
+    		file = "/var/log/trades.log" if file.nil?
+    		options.log    = true
+    		options.logger = Logger.new File.new(file, 'a+')
+    		options.logger.formatter = proc { |s, d, p, m| "#{m}\n" }
+    	end
+
+      # Help
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts "#{opts}\n\nMore info: https://github.com/britishtea/Trades"
+        exit
+      end
+      
+      # List of markets
+      opts.on_tail("--markets", "Show a list of all markets") do
+        puts "Markets: #{MARKETS.join ', '}\n\nAliases:"
+        ALIASES.each { |x,y| puts "#{x} for #{y}" }
+        exit
+      end
+      
+      # List of currencies
+      opts.on_tail("--currencies", "Show a list of all currencies") do
+        puts "Currencies: #{CURRENCIES.values.uniq.join ', '}"
+        exit
+      end
+    end
+
+    opts.parse!(args)
+    options
+  end
+end 

data/lib/trades/trade.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+class Trade
+  attr_reader :id
+  attr_reader :market
+  attr_reader :timestamp
+  attr_reader :currency
+  attr_reader :volume
+  
+  attr_accessor :price
+  
+  def initialize(data)
+    parsed      = JSON.parse data.strip.tr("\x00", '')
+    @id         = parsed['id']
+    @market     = parsed['symbol']
+    @timestamp  = parsed['timestamp']
+    @currency   = parsed['symbol'][-3, 3]
+    @price      = parsed['price']
+    @volume     = parsed['volume']
+  end
+  
+  def timestamp(show_date = false)
+    format = show_date ? "%Y-%m-%d %H:%M:%S" : "%H:%M:%S"
+    Time.at(@timestamp).strftime(format)
+  end
+  
+  def price(decimals = 4)
+    @price.round(decimals)
+  end
+  
+  def to_s
+    "#{@market.ljust(15)} | #{timestamp()} | #{@currency.ljust(9)} | " +
+    "#{price().to_s.ljust(9)} | #{@volume.to_s}"
+  end
+end

data/tests/trade.rb

@@ -0,0 +1,37 @@
+require 'bundler/setup'
+require 'colored'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'trades/trade'
+
+describe Trade do
+  before do
+    json = '{"volume": 1.26934, "timestamp": 1321111130, 
+    "price": 2.998, "symbol": "btceUSD", "id": 15366282}'
+    @trade = Trade.new(json)
+  end
+  
+  it "should have attributes of the appropriate type" do
+    @trade.id.must_be_kind_of Integer
+    @trade.market.must_be_kind_of String
+    @trade.timestamp.must_be_kind_of String
+    @trade.currency.must_be_kind_of String
+    @trade.currency.length.must_be :==, 3
+    @trade.price.must_be_kind_of Float
+    @trade.volume.must_be_kind_of Float
+  end
+  
+  it "should have timestamps in the correct formats" do
+    @trade.timestamp(true).must_be :==, "2011-11-12 16:18:50"
+    @trade.timestamp(false).must_be :==, "16:18:50"
+  end
+  
+  it "should have an option to specify decimals for the price attribute" do
+    @trade.price(2).must_be :==, 3.00
+  end
+  
+  it "should output a nicely formatted string" do
+    regex = /(.{15}) \| ((\d{4}-\d{2}-\d{2} )?\d{2}:\d{2}:\d{2}) \| ([a-zA-z ]{9}) \| ([0-9 \.]{9}) \| ([0-9 \.]+)/i
+    @trade.to_s.must_match regex
+  end
+end

metadata

@@ -1,78 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: trades
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: '1.0'
   prerelease: 
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Waxjar
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-04 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2011-11-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2156540440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.5.3
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2156540440
+- !ruby/object:Gem::Dependency
   name: colored
+  requirement: &2156539960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2156539960
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2156562520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.2"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
   type: :runtime
-  version_requirements: *id002
-description: Displays the trades that Bitcoincharts monitors nicely
+  prerelease: false
+  version_requirements: *2156562520
+description: Displays the trading data that Bitcoincharts monitors nicely
 email: 
-executables: 
+executables:
 - trades
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/trades.rb
+- lib/trades/options.rb
+- lib/trades/trade.rb
+- tests/trade.rb
 - bin/trades
-has_rdoc: true
-homepage: 
+homepage: https://github.com/britishtea/Trades
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-requirements: []
-
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Ruby version 1.9.2 or higher
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Nice trading data
-test_files: []
-
+summary: Bitcoin trading data on the command line
+test_files:
+- tests/trade.rb