rippler 0.0.3 → 0.0.4

data/README.md

@@ -8,15 +8,37 @@ You need to have Ruby 1.9 (http://www.ruby-lang.org/en/downloads/) installed. On
 
     $ gem install rippler
 
+Alternatively, you can install from source at Github:
+
+    $ git clone https://github.com/arvicco/rippler.git
+    $ cd rippler
+    $ bundle install
+
 ## Usage
 
-Rippler supports Ripple API commands (https://ripple.com/wiki/RPC_API). All parameters after command should be given in JSON format, such as:
+Rippler supports Ripple API commands (https://ripple.com/wiki/RPC_API). All parameters after command should be given in commandline JSON format, such as:
+
+    $ rippler account_info account:rwLYfeQHfucz8wD6tFPY9Ms6ovmMBCCpMd
+
+    $ rippler account_tx account:rwLYfeQHfucz8wD6tFPY9Ms6ovmMBCCpMd ledger:319841
+
+    $ rippler account_tx account:evoorhees ledger_min:0 ledger_max:400000
+
+Ripple server replies are returned as JSON and printed to stdout. If you want to do some post-processing of the results, get source from Github and modify bin/rippler script.
+
+Rippler also provides additional commands print out human-readable output:
+
+    $ rippler history account:molecular
+
+This one prints account history in a human-readable format.
+
+    $ rippler monitor streams:[ledger,transactions]
 
-    $ rippler account_info ident:rpvfJ4mR6QQAeogpXEKnuyGBx8mYCSnYZi
+This one monitors Ripple transactions in real-time similar to #ripple-watch. Ctrl-C to stop it.
 
-    $ rippler account_tx account:rpvfJ4mR6QQAeogpXEKnuyGBx8mYCSnYZi ledger:319841
+## Contacts database
 
-    $ rippler account_tx account:rpH3zuMch2GrrYX724xGWwbMGwiQ5RbSAU ledger_min:300000 ledger_max:319000
+Contacts database is in lib/rippler/contacts.rb, mostly auto-scraped from Bitcointalk. It may be a bit inaccurate, you can modify/extend it as you see fit.
 
 ## Contributing
 

data/lib/rippler.rb

@@ -1,11 +1,19 @@
 require 'eventmachine'
 require 'faye/websocket'
 require "json"
+require 'ostruct'
+
 require "rippler/version"
-require 'rippler/transaction'
 require 'rippler/contacts'
+require 'rippler/utils'
+require 'rippler/money'
+require 'rippler/account'
+require 'rippler/ledger'
+require 'rippler/transaction'
 
 module Rippler
+  extend Rippler::Utils
+
   RIPPLE_URI = 'wss://s1.ripple.com:51233'
   MY_ACCT = Rippler::Contacts["arvicco"]
 
@@ -14,20 +22,29 @@ module Rippler
     command_line = args.empty? ? ['account_info'] : args.dup
 
     command = command_line.shift
-    params = Hash[*command_line.map {|p| p.split(':')}.flatten]
+    params = command_line.map {|p| p.split(':')}.flatten. #         get json pairs
+      map {|p| p =~ /\[.*\]/ ? p.gsub(/\[|\]/,'').split(',') : p} # get arrays
+    params = Hash[*params]
+    params['account'] = Account(params['account']).address if params['account']
+
     # p command, params
 
-    if Rippler.respond_to? command # pre-defined Rippler method
-      Rippler.send command, params
+    if respond_to? command # pre-defined Rippler method
+      send command, params
     else # Arbitrary API command
-      Rippler.request params.merge(command: command)
+      request params.merge('command' => command)
     end
   end
 
-  # Make a single JSON request to Ripple over Websockets, return Ripple reply
-  def self.request params
+  # Send a single JSON request to Ripple over Websockets, return a single Ripple reply.
+  def self.request params, &block
     reply = ''
+    em_request false, params, &(block || lambda {|message| reply = message})
+    reply
+  end
 
+  # Send JSON request to Ripple, yields all json-parsed Ripple messages to a given block.
+  def self.em_request streaming=false, params, &block
     EM.run {
       ws = Faye::WebSocket::Client.new(RIPPLE_URI)
 
@@ -38,12 +55,16 @@ module Rippler
 
       ws.onmessage = lambda do |event|
         # p [:message]
-        reply = JSON.parse(event.data)
-        ws.close
+        message = JSON.parse(event.data)
+        check_error message
+        yield message
+        ws.close unless streaming
       end
 
       ws.onerror = lambda do |event|
         # p [:error, event]
+        pp event["error"]
+        raise "Websocket error"
       end
 
       ws.onclose = lambda do |event|
@@ -52,23 +73,50 @@ module Rippler
         EM.stop
       end
     }
-    reply
   end
 
-  # These are user-defined methods that post-process Ripple replies
-  def self.my_info params
-    request( {command: "account_info", ident: MY_ACCT}.merge(params) )
+  def self.check_error message
+    if message["error"]
+      pp message
+      raise "Ripple error message"
+    end
+  end
+
+  # Subscribe needs a streaming wrapper
+  def self.subscribe params, &block
+    em_request( true, {'command' => "subscribe", 'id' => 0, 'streams' => ['ledger']}.
+                merge(params), &(block || lambda {|message| pp message}))
+  end
+
+  ### These are user-defined methods that post-process Ripple replies
+
+  # Subscibe to event streams, print events out nicely formatted
+  def self.monitor params
+    subscribe(params) do |message|
+      case message['type']
+      when "response"
+        puts "#{Ledger.new(message['result'])} starting..."
+      when "ledgerClosed"
+        ledger = Ledger.new(message)
+        puts "#{ledger} active" if ledger.txn_count > 0
+      when "transaction"
+        pp Transaction.new(message)
+      else
+        pp message
+      end
+    end
   end
 
+  # Retrieve account transactions history, print out nicely formatted transactions
   def self.history params
-    reply = request( {command: "account_tx",
-                      account: MY_ACCT,
-                      ledger_min: 310000,
-                      ledger_max: 329794,
-                      resume: 0,
-                      sort_asc: 1
+    reply = request( {'command' => "account_tx",
+                      'account' => MY_ACCT,
+                      'ledger_min' => 0, # 280000, # 312000,
+                      'ledger_max' => 500000, #329794,
+                      'resume' => 0,
+                      'sort_asc' => 1
                       }.merge(params) ) #(optional)
     txs = reply["result"]["transactions"]
-    txs.reverse.map {|t| Transaction.new(t).to_s}.push("Size: #{txs.size}")
+    txs.reverse.map {|t| Transaction.new(t).to_s}.push("Total transactions: #{txs.size}")
   end
 end

data/lib/rippler/account.rb

@@ -0,0 +1,17 @@
+module Rippler
+  class Account
+    include Rippler::Utils
+
+    attr_accessor :name, :address
+
+    # String: "evoorhees" or "rpfxDFsjDNtzSBCALKuWoWMkpRp4vxvgrG"
+    def initialize name_or_address
+      @address = Rippler::Contacts[name_or_address] || name_or_address
+      @name = Rippler::Addresses[@address]
+    end
+
+    def to_s
+      @name || @address
+    end
+  end
+end

data/lib/rippler/contacts.rb

@@ -1,9 +1,9 @@
 module Rippler
   Contacts = Hash[ *%W[
     OpenCoin            rJR7gjNe3DpJ7kpB4CHBxjDKfwVMpTKPpj
-    address_one         rrrrrrrrrrrrrrrrrrrrBZbvji
+    OpenCoin-1          r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV
+    ADDRESS_ONE         rrrrrrrrrrrrrrrrrrrrBZbvji
 
-    weex_btc            rpvfJ4mR6QQAeogpXEKnuyGBx8mYCSnYZi
     bitstamp            rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B
     bitstamp_hotwallet  rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1
     weex_btc            rpvfJ4mR6QQAeogpXEKnuyGBx8mYCSnYZi
@@ -11,6 +11,22 @@ module Rippler
     weex_cad            r47RkFi1Ew3LvCNKT6ufw3ZCyj5AJiLHi9
     weex_usd            r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X
 
+    X.Veirou            rhq5LEZSWHWY6H3raiC2KGe8TVeirou4BS
+    X.Reya              rEyAJhMMi5WNzgdkY67vN7ivfiQnh3itXY
+    X.Founder.1         rfbKLd1VLB3o6fpkhCJexckArjoMmBm2wG
+    X.9billions         rstKSeB2Qx7zrwSkyc7X9Xm5nYTJqtL3iM
+    X.77millions        rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY
+    X.10millions        rHrSTVSjMsZKeZMenkpeLgHGvY5svPkRvR
+    X.001               rKdtD8YQXCJAnXoXQfmn645FybiaFWVghs
+    X.002               ramJoEsBUHc299vFuMvn8NgLrF3Qrt3XV4
+
+    TTBit               rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E
+    BankOfZed           ra88Lr8fyo9cUTuyjVFMTrvTSBU93erjyh
+    AlanFromZed         rhR5j5LXsujSuwG2bcn1P39utdTA79ceaW
+    BobFromZed          r4ixnhDRE5VktpgtFkw5L8v1bNGsFusQJS
+    ChrisFromZed        rPA9PquwamoriknybdishCdWp6N1m2iEF8
+    SecondBankOfZed     rnqQ7YEStMBBqn6qBP4AYsyGhy1RKfUeRR
+
     molecular           rpH3zuMch2GrrYX724xGWwbMGwiQ5RbSAU
     Ente                rNEtVs4kNeESF5HbWCDZMYcWwKZ5iKwUEr
     herzmeister         rUdPvX9YN1NwyniwiJeSW6y3YKZL84gsB6
@@ -46,10 +62,67 @@ module Rippler
     supert              rh7eAu9SrFsE2fVfc1PJTs1WYDHGAUde6V
     Evan                rfpS692WVbsSXyv6R48K8A2LHCqdvYaS2w
     BBQKorv             rrhAmxxwxEchP2iJdGh7nrwwAK4u3BzaLC
-    TTBit               rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E
     Mjbmonetarymetals   rNTXjBWitdKUxr6o1zyi4FsjQ8UeP3JCKd
     khal                rpUjkUUcbteWbXrPt4aXAMwzotSPzQJHQt
     Trading             rNPHozULzm5nKavgXxbq8tcwAcxyhZpTBw
+    Schleicher          rGGxDC8VZ7zHmVKt6XK6sc7fUziNtvohWC
+    ripper234           rhQ7mQ1JJKygoxh7SoCaKNZB4GufdCRiH3
+    alexkravets         rKQLJpoBagwGiE7LVcY8YfDfE6EUREJjeq
+    comboy              rLHMoLsuLhg1Q741bHNjv7jhMqr6karoG7
+    djbaniel            rNnLFDCRrAtuESodmwamAasMBZqCmkqQH9
+    wyodude             rwJBiKfYKRFX59GykztmGdedUvmV64LpaK
+    misterbigg          rwLYfeQHfucz8wD6tFPY9Ms6ovmMBCCpMd
+    endlesscustoms      rN6DeCG5VvmfqjBywwoE24oXQsHzRDUfzh
+    avegetable          r9MZGmnGc1qo64ZQbxijVFCdcNt741nkYE
+    runlinux            rsAMwJ4BjuEwb5dkd84XW9WM5KvauxcGAU
+    nomnomnom           rp3qwd4zb8Ywq8rFrxLgijvyYKMa68FbxW
+    nealmcb             r3NQyByq6KfvnD1PXu3jwGzdsVGn1HEJNq
+    TTBit               rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E
+    plummonkey          r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH
+    magnebit            rQrUJLNcjnaZJjqMjaiPHxGa7eipzyf7b
+    mpfrank             rnfLDQaxN7isxzWZuc6BM8jeiCb2WSGpdG
+    Bitcoining          raW4tvsndX8fkunTqpHWsT8L5BErB5KEJd
+    Pteppic             rwBYyfufTzk77zUSKEu4MvixfarC35av1J
+    Lohoris             rDBfeSsYGwDiXWdTARYHsxUtvzAXgARFMu
+    MatthewNWright      rwTbS9jC9a1Yu57j7ZUwEY5oQTo86o6VXR
+    wormbog             rLveNTH6EA3tY4BzpdvgkukJ3oTxWk2UHM
+    GoWest              rszHYGgWBTCwCUQCUjCPwmx6zLinbqXZvT
+    VitalikButerin      rJ2gXg1xcYW6756fBj393Dd9ZekJP45odZ
+    ElectricMucus       rpJwZ8dcJLVydewhhfQEgMCQxFyMorH9rG
+    RRTaylor-Almanza    rE4StrJNLHahqBjpVdz5pj2Zgqtvk1fwuu
+    hazek               rsQP8f9fLtd58hwjEArJz2evtrKULnCNif
+    FlipPro             rNSnpURu2o7mD9JPjaLsdUw2HEMx5xHzd
+    JoelKatz            rHzWtXTBrArrGoLDixQAgcSD2dBisM19fF
+    evoorhees           rpfxDFsjDNtzSBCALKuWoWMkpRp4vxvgrG
+    SunnyKing           rKMSa2tRir1kcKW6qrfRBc2fRZLCzVsxxX
+    dacoinminster       rKj9ngzutnjmuiSJTTkUm3NBBt83v2uc4r
+    jimbobway           rEMqTpu21XNk62QjTgVXKDig5HUpNnHvij
+    nanotube            rBJwwXADHqbwsp6yhrqoyt2nmFx9FB83Th
+    snapsunny           rNuFYAu1aUYbATH3qCs27BjPc5dDHVgY1z
+    tbcoin              rsvAk3NoSSZwCTv9epzrKtFkAkHLVwEBmw
+    Bimmerhead          rJzAwqVF3fuKvxRegZMfrFSQQrXJA9Dpms
+    MonsterTent         r3vaUaLbUgJdg61wuSiX4byD9ofkbPnKVa
+    rta                 rBxi9xHEmvSJHAxrJ21sQNprs9xuENgs1Z
+    fimp                rGnSAso57ca5hBtSYuXzT5rjCEFQ1RWAec
+    intel-core-i7       rsmbvYkXWQ9LH3JHoHPg9rmYhQGi5M7ue4
+    btc24               r96WyAeNMykJKpdMi54V5WCqQEqfqhs6oA
+    jl2012              rnKhmoH1BFrh7CfDnJ21XW6arPySDXUPFZ
+    Prattler            rnmB7GYEB9Xz2qBmiU8L6qdpCzd9FdvvJQ
+    commonancestor      rGguLh5qc15WLntiB7zPfE2XCBdB7HZLdi
+    sneef               rGQCcCAG2fFmPY7X9zDZEhCnMp5JgAeziS
+    zulzedd             rJYHWjtcZaHfDTL7P8Dh5zkk1JdZsxiYef
+    Snowfire            rpVbjBotUFCoi9xPu3BqYXZhTLpgZbQpoZ
+    Otoh                rKWYoFVMsKjZZhCZMFSagYmasqGZFYkpYu
+    Deafboy             rUAScykwHVqU2d4rb4twHbpDa7C81p4MSA
+    speeder             rNzJ6ikJKXAxAaTPMZCcXr2sFkmg9a2GM9
+    nelisky             rLDDq8ZGhCaVBP8MyYTifhCJzgWPQBjwpt
+    mrmx                rKishCqMiQG6zhFHPjrFhXztLDjZteNmGP
+    drewdtom            rsZvcvACPWoTN2Eazzb5radzQX18s3DuK8
+    MadSweeney          r4pqusLQxgFNQQNByJMcTvQcYG9v1GpBum
+    Digigami            rHCSeQNZZz7FWbxvLjB2RzF1CrBeUcDj7J
+    jking               rMpB2AsrDTdbynCB48hg8MwHLD4wtXJfRJ
+    justusranvier       rnZoz4R1o6GupernFX6bey34uj4g45scLZ
+
 
     arvicco             rnZoUopPFXRSVGdeDkgbqdft8SbXfJxKYh
     paysafecardbitcoin  rN4kvobWCZVSzgLmo27B4kMjakAL31pMSr
@@ -109,7 +182,20 @@ module Rippler
     tosku               rBs43YZMn5QsYY9jZYcG4C3egEebUfGWh3
     BitcoinG            r3CxMDQFX1Atq1vQN5sqVsjm3rawGSwd32
     Gzarcov             rEg8hTqY7jhSkeFirfE5Fm7BF72WaaCnrB
-
+    milly6              rQaxmmRMasgt1edq8pfJKCfbkEiSp5FqXJ
+    crazyearner         rBcrMMTUKAQJd5tMEsy1zyTGRiy79gY9K3
+    elelegzet           rBKnNboJeGxTwQM1agrXp28WcVWKtPPQah
+    Myrddindc           rp2ewp8uH4zi35T2oWkfpETT3rQ4qBBZzt
+    Ivica               ra6FCgRD4Ye4PNcTRhmiXaSzpJKo1PQEzh
+    DrG                 rQrnuAtfePuz2fsSDTakuDZn594fi9x7dP
+    DrG-1               rJEZjBv27ZHCPAoDtTBJb9r82VnUdkRd77
+    UnitClick           rLKojeESeKi9mdBuPLkiQhCxs4wh8iKy2W
+    saddambitcoin       rMSEYpzcRtkiA5kkxYEWZtvLr8u3jnn385
+    helloworld111       rwGAnUvzT5yrDz6dXxm6MWVhpV9abm39W3
+    dykast              rQfwn3GVHVEfTpjqU2Y3BoMGAGHrw43XnT
+    BurbolGii           rDYwnqGbUazEuMfebQwLprCQQXWbYgXTMa
+    BC12345             rNy61KXKUYPMFf5fMV6ojo3u98dc5WhiVu
+    Eegnylot  rPKwrbDS6GC61QF1NuyTCohK926ns2vEG3
   ]]
 
   Addresses = Contacts.invert

data/lib/rippler/ledger.rb

@@ -0,0 +1,11 @@
+module Rippler
+  # Represents a single LedgerClose event
+  class Ledger < OpenStruct
+    include Rippler::Utils
+
+    def to_s
+      "#{Time(self.ledger_time).strftime("%Y-%m-%d %H:%M:%S")} " +
+        "Ledger ##{self.ledger_index}, txn: #{self.txn_count}"
+    end
+  end
+end

data/lib/rippler/money.rb

@@ -0,0 +1,45 @@
+module Rippler
+  class Money
+    include Rippler::Utils
+
+    attr_accessor :value, :currency, :issuer
+
+    # Money comes in in 3 formats:
+    # Hash:  {'value' => xx, 'currency' => 'XXX', 'issuer' => 'ZZZZZZZ'}
+    # String: 'value/currency(/issuer)'
+    # Int in a String: XRP amount in drops (x1,000,000)
+    def initialize data
+      case data
+      when Hash
+        @value = data['value'].to_f
+        @currency = data['currency']
+        @issuer = data['issuer']
+      when String
+        @value, @currency, @issuer = *data.split('/')
+        if @currency
+          @value = @value.to_f
+        else
+          @value = @value.to_i/1000000.0
+          @currency = "XRP"
+        end
+      when Int
+        @value = data.to_i/1000000.0
+        @currency = "XRP"
+      end
+
+      @value = @value.to_i if @value.to_i == @value
+    end
+
+    def to_s
+      if @issuer
+        "#{@value}/#{@currency}/#{Account(@issuer)}"
+      else
+        "#{@value}/#{@currency}"
+      end
+    end
+
+    def to_hash
+      {'value' => @value.to_s, 'currency' => @currency, 'issuer' => @issuer}
+    end
+  end
+end

data/lib/rippler/transaction.rb

@@ -1,37 +1,31 @@
-
 module Rippler
+  # Represents a single Ripple transaction
   class Transaction
-    def initialize data # data hash
-      @data = data
-    end
-
-    def name account
-      Rippler::Addresses[account] || account
-    end
-
-    def amount money
-      if money.is_a? Hash
-         "#{money['value']}/#{money['currency']}/#{name(money['issuer'])}"
-      else
-        "#{money.to_i/1000000.0}/XRP"
-      end
+    include Rippler::Utils
 
+    def initialize data # data Hash
+      @data = data
     end
 
     def to_s
-      tx = @data["tx"]
-      case tx["TransactionType"]
-      when "Payment"
-        "PAY #{amount(tx['Amount'])} #{name(tx['Account'])} > #{name(tx['Destination'])}"
-      when "OfferCancel"
-        "CAN #{name(tx['Account'])} ##{tx['Sequence']}"
-      when "OfferCreate"
-        "OFR #{name(tx['Account'])} ##{tx['Sequence']} offers " +
-          "#{amount(tx['TakerGets'])} for #{amount(tx['TakerPays'])}"
-      when "TrustSet"
-        "TRS #{amount(tx['LimitAmount'])} #{name(tx['Account'])}"
+      tx = @data['tx'] || @data['transaction']
+      if tx
+        "#{Time(tx['date']).strftime("%Y-%m-%d %H:%M:%S")} " +
+        case tx["TransactionType"]
+        when "Payment"
+          "PAY #{Money(tx['Amount'])} #{Account(tx['Account'])} > #{Account(tx['Destination'])}"
+        when "OfferCancel"
+          "CAN #{Account(tx['Account'])} ##{tx['Sequence']}"
+        when "OfferCreate"
+          "OFR #{Account(tx['Account'])} ##{tx['Sequence']} offers " +
+            "#{Money(tx['TakerGets'])} for #{Money(tx['TakerPays'])}"
+        when "TrustSet"
+          "TRS #{Money(tx['LimitAmount'])} #{Account(tx['Account'])}"
+        else
+          tx
+        end
       else
-        tx
+        @data
       end
     end
   end

data/lib/rippler/utils.rb

@@ -0,0 +1,19 @@
+module Rippler
+
+  # Utility methods to be included
+  module Utils
+    RIPPLE_TIME_OFFSET = 946684800 # Time.utc(2000,1,1,0,0,0).to_i
+
+    def Time(ripple_seconds)
+      Time.at(RIPPLE_TIME_OFFSET + ripple_seconds.to_i)
+    end
+
+    def Money(data)
+      Rippler::Money.new(data)
+    end
+
+    def Account(data)
+      Rippler::Account.new(data)
+    end
+  end
+end

data/lib/rippler/version.rb

@@ -1,3 +1,3 @@
 module Rippler
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rippler
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -43,8 +43,12 @@ files:
 - Rakefile
 - bin/rippler
 - lib/rippler.rb
+- lib/rippler/account.rb
 - lib/rippler/contacts.rb
+- lib/rippler/ledger.rb
+- lib/rippler/money.rb
 - lib/rippler/transaction.rb
+- lib/rippler/utils.rb
 - lib/rippler/version.rb
 - rippler.gemspec
 homepage: ''