xrbp 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d140a426f073971891c8e8e81f5313112c661703cebaee32719f6b04d6ca86b0
-  data.tar.gz: 394f8602052b068b2816ddfa4e06621e7537311b26a9d8248c8eaeb44514e510
+  metadata.gz: a89c7310e04f3827f8252e3b4954036e6c75a703a21bb91e0a5c57e80817c495
+  data.tar.gz: 060e83ec60961220e4f62665a4464a7b7f9da11d96895828a814e7c218025b69
 SHA512:
-  metadata.gz: b47922beac1ce4613e1bc4b8953bcdf9368d9fdecdef26b6c489f08ad00db2ce2be9780fa9e3fdcdf3f9b31f5912dd4c54c352e8833c002cef6e5c0c30edbafd
-  data.tar.gz: '0833467cf31a91d158f78b9b480faaddb4447fc7bd4eeb693b21e93ac91ad9e7fdd7ede68e432d7b4755da81ac6fd46f08abaf97e27e27536eee22a34b0af503'
+  metadata.gz: 1cf32ec6375e44970df3612fce1eeede573d1d9501a83927de70643d207027b9e448b3a330522a2264a9b002b1e472d2334f02daadf6bf74814ab0a79c72bee5
+  data.tar.gz: 384f666fbfc87b752ef432aa2cbebc9b4819e92f1d627698e37e396083776e7a4aa5bb0846b0749cd1d892289cac1dc9386e205854505e6738028439ddfc596a

data/README.md

@@ -1,7 +1,105 @@
-XRBP - Ruby XRP Library
-Copyright (C) 2019 Dev Null Productions
-MIT License
+### XRBP - Ruby XRP Library
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/devnullprod/xrbp/master/logo.png" />
+</p>
+
+
+XRBP is a rubygem which provides a fault-tolerant interface to the [XRP](https://en.wikipedia.org/wiki/XRP) ledger.
+
+With XRP you can connect to one or more [rippled](https://github.com/ripple/rippled) servers and use them to transparently read and write data to/from the XRP Ledger:
+
+```ruby
+require 'xrbp'
+
+ws = XRBP::WebSocket::Connection.new "wss://s1.ripple.com:443"
+ws.add_plugin :autoconnect, :command_dispatcher
+
+ws.cmd XRBP::WebSocket::Cmds::ServerInfo.new
+```
+
+XRBP provides fully-object-oriented mechanisms to interact with the ledger:
+
+```ruby
+ws.on :ledger do |l|
+  puts "Ledger received: "
+  puts l
+end
+
+XRBP::Model::Ledger.subscribe(:connection => ws)
+```
+
+#### Supported Features:
+
+Other data types besides ledgers may be syncronized:
+
+```ruby
+puts XRBP::Model::Account.new("rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B").info
+```
+
+Also data from other sources, such as the [Ripple DataV2 API](https://developers.ripple.com/data-api.html)
+
+```ruby
+connection = XRBP::WebClient::Connection.new
+XRBP::Model::Validator.all(:connection => connection)
+                      .each do |v|
+  puts v
+end
+```
+
+XRPB allows easy access to the following data:
+
+- XRP ledgers, transactions, account, and objects
+- Network nodes, validators, gateways
+- Markets with quotes
+- & more (see *examples/* for more use cases)
 
----
+#### Multiple Connections
+
+XRBP facilitates fault-tolerant applications by providing customizable strategies which to leverage multiple rippled servers in communications.
+
+```ruby
+ws = XRBP::WebSocket::RoundRobin.new "wss://s1.ripple.com:443",
+                                     "wss://s2.ripple.com:443"
+
+ws.add_plugin :command_dispatcher
+ws.connect
+
+puts ws.cmd(XRBP::WebSocket::Cmds::ServerInfo.new)
+puts ws.cmd(XRBP::WebSocket::Cmds::ServerInfo.new)
+```
+
+In this case the first **ServerInfo** command will be sent to *s1.ripple.com* while the second will be sent to *s2.ripple.com*.
+
+The following demonstrates prioritized connections:
+
+```ruby
+ws = XRBP::WebSocket::Prioritized.new "wss://s1.ripple.com:443",
+                                      "wss://s2.ripple.com:443"
+
+ws.add_plugin :command_dispatcher, :result_parser
+ws.parse_results { |res|
+  res["result"]["ledger"]
+}
+ws.connect
+
+puts ws.cmd(XRBP::WebSocket::Cmds::Ledger.new(28327070))
+```
+
+*s1.ripple.com* will be queried for the specified ledger. If not present *s2.ripple.com* will be queried.
+
+#### Installation / Documentation
+
+XRPB may be installed with the following command:
+
+```ruby
+$ gem install xrbp
+```
+
+Documentation is available [online](https://www.rubydoc.info/gems/xrbp)
+
+#### License
+
+Copyright (C) 2019 Dev Null Productions
 
-XRPB is a rubygem which facilitates reading and writing data to/from the XRP ledger.
+Made available under the MIT License

data/examples/accounts.rb

@@ -0,0 +1,13 @@
+$: << File.expand_path('../../lib', __FILE__)
+require 'xrbp'
+
+connection = XRBP::WebClient::Connection.new
+connection.on :account do |acct|
+  puts acct
+end
+
+Signal.trap("INT") {
+  connection.force_quit!
+}
+
+XRBP::Model::Account.all(:connection => connection)

data/examples/autoconnect_timeout.rb

@@ -3,6 +3,10 @@ require 'xrbp'
 
 ws = XRBP::WebSocket::Connection.new "wss://s1.ripple.com:443"
 
+ws.on :connecting do
+  puts "Connecting"
+end
+
 ws.on :open do
   puts "Opened"
 end
@@ -17,4 +21,4 @@ end
 
 ws.add_plugin :autoconnect, :connection_timeout
 ws.connection_timeout = 3
-sleep(60)
+sleep(20)

data/examples/autorety.rb

@@ -0,0 +1,7 @@
+$: << File.expand_path('../../lib', __FILE__)
+require 'xrbp'
+
+connection = XRBP::WebClient::Connection.new
+connection.add_plugin :autoretry
+connection.url = "https://devnull.network"
+puts connection.perform

data/examples/crawl_nodes.rb

@@ -0,0 +1,32 @@
+$: << File.expand_path('../../lib', __FILE__)
+require 'xrbp'
+
+connection = XRBP::WebClient::Connection.new
+connection.timeout = 3
+
+Signal.trap("INT") {
+  connection.force_quit!
+}
+
+connection.on :precrawl do |node|
+  puts "Crawling: #{node.url}"
+end
+
+connection.on :crawlerr do |node|
+  puts "Could not Crawl: #{node.url}"
+end
+
+connection.on :postcrawl do |node|
+  puts "Done Crawling: #{node.url}"
+end
+
+connection.on :peers do |node, peers|
+  puts "#{node.url}: #{peers.size} peers"
+end
+
+connection.on :peer do |node, peer|
+  puts " #{peer.url}"
+end
+
+XRBP::Model::Node.crawl("wss://s1.ripple.com:51235",
+                        :connection => connection)

data/examples/dsl/account.rb

@@ -0,0 +1,16 @@
+$: << File.expand_path('../../../lib', __FILE__)
+require 'xrbp'
+
+include XRBP::DSL
+
+# override endpoints
+#def websocket_endpoints
+#  ["wss://s1.ripple.com:443", "wss://s2.ripple.com:443"]
+#end
+
+# override websocket
+#def websocket
+#  @websocket ||= WebSocket::Prioritized.new *websocket_endpoints
+#end
+
+puts account_info("rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq")

data/examples/dsl/ledger.rb

@@ -0,0 +1,7 @@
+$: << File.expand_path('../../../lib', __FILE__)
+require 'xrbp'
+
+include XRBP::DSL
+
+puts ledger
+puts ledger(45918932)

data/examples/dsl/ledger_subscribe.rb

@@ -0,0 +1,18 @@
+$: << File.expand_path('../../../lib', __FILE__)
+require 'xrbp'
+
+include XRBP::DSL
+
+Signal.trap("INT") {
+  Thread.new {
+    websocket.force_quit!
+    websocket.close!
+  }
+}
+
+websocket_msg do |c, msg|
+  puts msg
+end
+
+subscribe_to_ledgers
+websocket_wait

data/examples/dsl/validators.rb

@@ -0,0 +1,8 @@
+$: << File.expand_path('../../../lib', __FILE__)
+require 'xrbp'
+
+include XRBP::DSL
+
+validators.each { |v|
+  puts v["validation_public_key"] + ": " + v["domain"].to_s
+}

data/examples/gateways.rb

@@ -0,0 +1,8 @@
+$: << File.expand_path('../../lib', __FILE__)
+require 'xrbp'
+
+connection = XRBP::WebClient::Connection.new
+XRBP::Model::Gateway.all(:connection => connection)
+                    .each do |gw|
+  puts "#{gw[:id]} #{gw[:names].join(",")} (#{gw[:currencies].join(",")})"
+end

data/examples/latest_account.rb

@@ -0,0 +1,4 @@
+$: << File.expand_path('../../lib', __FILE__)
+require 'xrbp'
+
+puts XRBP::Model::Account.latest(:connection => XRBP::WebClient::Connection.new)

data/examples/ledger_multi_subscribe.rb

@@ -7,7 +7,7 @@ ws.add_plugin :command_dispatcher
 ws.connect
 
 l = 0
-ws.on :message do |msg|
+ws.on :message do |connection,msg|
   msg = JSON.parse(msg.data)
   next unless msg["ledger_index"] && msg["ledger_index"] > l
           l = msg["ledger_index"]

data/examples/ledger_subscribe.rb

@@ -6,8 +6,8 @@ ws.add_plugin :command_dispatcher
 ws.connect
 
 i = 0
-ws.on :message do |msg|
-  puts msg
+ws.on :ledger do |ledger|
+  puts ledger
 
   i += 1
   ws.close! if i > 5

data/examples/market.rb

@@ -0,0 +1,13 @@
+$: << File.expand_path('../../lib', __FILE__)
+require 'xrbp'
+
+connection = XRBP::WebClient::Connection.new
+markets = XRBP::Model::Market.all(:connection => connection)
+markets.each do |market|
+  puts market.inspect
+end
+
+connection = XRBP::WebClient::Connection.new
+puts XRBP::Model::Market.new(:connection => connection,
+                             :route => markets.sample[:route] + "/ohlc?periods=60")
+                        .quotes

data/examples/username.rb

@@ -0,0 +1,12 @@
+$: << File.expand_path('../../lib', __FILE__)
+require 'xrbp'
+
+connection = XRBP::WebClient::Connection.new
+puts XRBP::Model::Account.new(:id => "rJe12wEAmGtRw44bo3jQqQUMTVFSLPewCS",
+                              :connection => connection)
+                         .username
+
+puts XRBP::Model::Account.new(:id => "rfexLLNpC6dqyLagjV439EyvfqdYNHsWSH",
+                              :connection => connection)
+                         .username
+

data/examples/validator.rb

@@ -0,0 +1,8 @@
+$: << File.expand_path('../../lib', __FILE__)
+require 'xrbp'
+
+connection = XRBP::WebClient::Connection.new
+XRBP::Model::Validator.all(:connection => connection)
+                      .each do |v|
+  puts v
+end

data/lib/xrbp.rb

@@ -1,5 +1,9 @@
 require 'event_emitter'
 
+require 'xrbp/common'
+require 'xrbp/terminatable'
+require 'xrbp/plugins'
 require 'xrbp/websocket'
+require 'xrbp/webclient'
 require 'xrbp/model'
-require 'xrbp/network'
+require 'xrbp/dsl'

data/lib/xrbp/common.rb

@@ -0,0 +1,10 @@
+require 'time'
+
+module XRBP
+  # Genesis Ledger:
+  # https://wiki.ripple.com/Genesis_ledger
+  #
+  # Created on 2013-01-01
+  # https://data.ripple.com/v2/ledgers/32570
+  GENESIS_TIME = DateTime.new(2013, 1, 1, 0, 0, 0)
+end # module XRBP

data/lib/xrbp/core_ext.rb

@@ -0,0 +1,24 @@
+# Extend Hash class w/ some methods pulled from activesupport
+# @private
+class Hash
+  def except(*keys)
+    dup.except!(*keys)
+  end
+
+  def except!(*keys)
+    keys.each { |key| delete(key) }
+    self
+  end
+end
+
+# @private
+class Queue
+  # Return next queue item or nil
+  def pop_or_nil
+    begin
+      pop(true)
+    rescue
+      nil
+    end
+  end
+end

data/lib/xrbp/dsl.rb

@@ -0,0 +1,25 @@
+module XRBP
+  # The DSL namespace can be *included* in client logic to provide
+  # an easy-to-use mechanism to read and write XRP data.
+  #
+  # @example Retrieve ledger, subscribe to updates
+  #   include XRBP::DSL
+  #
+  #   puts "Genesis ledger: "
+  #   puts ledger(32570)
+  #
+  #   websocket_msg do |msg|
+  #     puts "Ledger received:"
+  #     puts msg
+  #   end
+  #
+  #   subscribe_to_ledgers
+  module DSL
+  end # module DSL
+end # module XRBP
+
+require_relative './dsl/websocket'
+require_relative './dsl/webclient'
+require_relative './dsl/accounts'
+require_relative './dsl/ledgers'
+require_relative './dsl/validators'

data/lib/xrbp/dsl/accounts.rb

@@ -0,0 +1,13 @@
+module XRBP
+  module DSL
+    # Return info for the specified account id
+    #
+    # @param id [String] account id to query
+    # @return [Hash, nil] the account info or nil otherwise
+    def account_info(id)
+      websocket.add_plugin :autoconnect unless websocket.plugin?(:autoconnect)
+      websocket.add_plugin :command_dispatcher unless websocket.plugin?(:command_dispatcher)
+      websocket.cmd(WebSocket::Cmds::AccountInfo.new(id))
+    end
+  end # module DSL
+end # module XRBP

data/lib/xrbp/dsl/ledgers.rb

@@ -0,0 +1,23 @@
+module XRBP
+  module DSL
+    # Return ledger object for the specified id
+    #
+    # @param id [Integer] id of the ledger to query
+    # @return [Hash, nil] the ledger object retrieved or nil otherwise
+    def ledger(id=nil)
+      websocket.add_plugin :autoconnect unless websocket.plugin?(:autoconnect)
+      websocket.add_plugin :command_dispatcher unless websocket.plugin?(:command_dispatcher)
+      websocket.cmd(WebSocket::Cmds::Ledger.new(id))
+    end
+
+    # Subscribed to the ledger stream.
+    #
+    # After calling this, :ledger events will be emitted via the
+    # websocket connection object.
+    def subscribe_to_ledgers
+      websocket.add_plugin :autoconnect unless websocket.plugin?(:autoconnect)
+      websocket.add_plugin :command_dispatcher unless websocket.plugin?(:command_dispatcher)
+      websocket.cmd(WebSocket::Cmds::Subscribe.new(:streams => ["ledger"]))
+    end
+  end # module DSL
+end # module XRBP