radiator 0.3.0dev6 → 0.3.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8803f44d2a11ce39405501770a010b630293b59d
-  data.tar.gz: 0a6b77288fe61ba6f3f0fb876c3e2fb87ae62043
+  metadata.gz: adccc7e93bc7d0aa80013b5155564e5e1cad6f9e
+  data.tar.gz: 3d2e9bbd91be99f07546fb7943c4c85223f2a1ce
 SHA512:
-  metadata.gz: 8f425356209ba6b4fffc261b01959bce1d10130b5fec58ba76b126409bda7e6fa55065c09212acab5a65208a02974ae6a7d8d11e4f740554e6e7ce59780d155c
-  data.tar.gz: e547e2ec25f5b756748becabb856bdfb72e64ccb04389ca868b21a4c65dd322bcef90d97562ccca237f8c6fa37fe08755cfac18843d3af0fbdcfa9607f813c37
+  metadata.gz: 9fd6c239cde0594f9bbb29a855fde1ca28a1f9bf5e18329daf506654ee4f563320e86818552ceba6bde33a468ef2270872dc257fe8d45ca9ad1ea267c8bf1718
+  data.tar.gz: 6e21d95073a1085c55e9a895815af694f62e982f0d2d70087d65383df3c6dcc7571741d4b662ab1ec2329176e03792e30fbc575636614ee92a5b35d7ed6973ef

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    radiator (0.3.0dev6)
+    radiator (0.3.0rc1)
       bitcoin-ruby (= 0.0.11)
       ffi (= 1.9.18)
       hashie (~> 3.5, >= 3.5.5)
@@ -16,8 +16,8 @@ GEM
       public_suffix (>= 2.0.2, < 4.0)
     awesome_print (1.8.0)
     bitcoin-ruby (0.0.11)
-    codeclimate-test-reporter (0.5.2)
-      simplecov (>= 0.7.1, < 1.0.0)
+    codeclimate-test-reporter (1.0.5)
+      simplecov
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
@@ -27,7 +27,7 @@ GEM
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     ffi (1.9.18)
-    hashdiff (0.3.6)
+    hashdiff (0.3.7)
     hashie (3.5.6)
     json (2.1.0)
     little-plugger (1.1.4)
@@ -44,7 +44,7 @@ GEM
     pry (0.11.1)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (2.0.5)
+    public_suffix (3.0.0)
     rake (12.1.0)
     safe_yaml (1.0.4)
     simplecov (0.15.1)
@@ -55,7 +55,7 @@ GEM
     typhoeus (1.3.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)
-    webmock (2.1.0)
+    webmock (3.1.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -67,7 +67,7 @@ PLATFORMS
 DEPENDENCIES
   awesome_print (~> 1.7, >= 1.7.0)
   bundler (~> 1.15, >= 1.15.4)
-  codeclimate-test-reporter (~> 0.5.2)
+  codeclimate-test-reporter (~> 1.0, >= 1.0.5)
   faraday (~> 0.9.2)
   minitest (~> 5.9, >= 5.9.0)
   minitest-line (~> 0.6.3)
@@ -77,7 +77,7 @@ DEPENDENCIES
   simplecov (~> 0.15.1)
   typhoeus (~> 1.0, >= 1.0.2)
   vcr (~> 3.0, >= 3.0.3)
-  webmock (~> 2.1, >= 2.1.0)
+  webmock (~> 3.1, >= 3.1.0)
   yard (~> 0.9.9)
 
 BUNDLED WITH

data/README.md

@@ -10,6 +10,16 @@
 
 Radiator is an API Client for interaction with the STEEM network using Ruby.
 
+#### Changes in v0.3.0
+
+* Gem updates
+* Added failover subroutines (see Failover section, below).
+* Added method closures support (aka passing a block to yield).
+* You can now stream virtual operations (see Streaming section, below).
+* Added more [documentation](http://www.rubydoc.info/gems/radiator).
+* Added/expanded more api namespaces: `::BlockApi`, `::CondenserApi`, `::TagApi`
+* Addressed an issue with logging on certain Windows configurations.
+
 #### Fixes in v0.2.3
 
 * Gem updates
@@ -72,6 +82,18 @@ $ gem install bundler
 ```ruby
 require 'radiator'
 
+api = Radiator::Api.new
+api.get_dynamic_global_properties do |properties|
+  properties.virtual_supply
+end
+=> "135377049.603 STEEM"
+```
+
+... or ...
+
+```ruby
+require 'radiator'
+
 api = Radiator::Api.new
 response = api.get_dynamic_global_properties
 response.result.virtual_supply
@@ -82,8 +104,9 @@ response.result.virtual_supply
 
 ```ruby
 api = Radiator::FollowApi.new
-response = api.get_followers('inertia', 0, 'blog', 100)
-response.result.map(&:follower)
+api.get_followers('inertia', 0, 'blog', 100) do |followers|
+  followers.map(&:follower)
+end
 => ["a11at",
  "abarefootpoet",
  "abit",
@@ -104,6 +127,8 @@ response.result.map(&:follower)
  "steemzine"]
 ```
 
+#### Streaming
+
 Here's an example of how to use a streaming instance to listen for votes:
 
 ```ruby
@@ -140,8 +165,6 @@ helikopterben voted for etcmike (weight: 100.0%)
 .
 ```
 
-#### Streaming
-
 You can also just stream all operations like this:
 
 ```ruby
@@ -207,6 +230,29 @@ Example of the output:
 .
 ```
 
+You can also stream virtual operations:
+
+```ruby
+stream.operations(:producer_reward) do |op|
+  puts "#{op.producer} got a reward: #{op.vesting_shares}"
+end
+```
+
+Example of the output:
+
+```
+anyx got a reward: 390.974648 VESTS
+gtg got a reward: 390.974647 VESTS
+someguy123 got a reward: 390.974646 VESTS
+jesta got a reward: 390.974646 VESTS
+blocktrades got a reward: 390.974645 VESTS
+timcliff got a reward: 390.974644 VESTS
+bhuz got a reward: 1961.046504 VESTS
+.
+.
+.
+```
+
 Transactions are supported:
 
 ```ruby
@@ -345,6 +391,36 @@ tx.process(true)
 
 There's a complete list of operations known to Radiator in [`broadcast_operations.json`](https://github.com/inertia186/radiator/blob/master/lib/radiator/broadcast_operations.json).
 
+## Failover
+
+Radiator supports failover for situations where a node has, for example, become unresponsive.  When creating a new instance of `::Api`, `::Stream`, and `::Transaction`, you may provide a list of alternative nodes, or leave them out to use the default list.  For example:
+
+```ruby
+options = {
+  ur: 'https://steemd.steemit.com',
+  failover_urls: [
+    'https://steemd.steemitstage.com',
+    'https://gtg.steem.house:8090'
+  ]
+}
+
+api = Radiator::Api.new(options)
+```
+
+In a nutshell, the way this works is Radiator will try a node and proceed until it encounters an error, then retry the request.  If it encounters a second error within 5 minutes, it will abandon the node and try a random one from `failover_urls`.
+
+It'll keep doing this until it runs out of failovers, then it will reset the configuration and go back to the original node.
+
+Radiator uses an exponential back-off subroutine to avoid slamming nodes when they act up.
+
+There's an additional behavior in `::Stream`.  When a node responds with a block out of sequence, it will use the failover logic above.  Although this is not a network layer failure, it is a bad result that may indicate a problem on the node, so a new node is picked.
+
+There is another rare scenario involving `::Transaction` broadcasts that's handled by the failover logic: When a node responds with a network error *after* a signed transaction is accepted, Radiator will do a look-up to find the accepted signature in order to avoid triggering a `dupe_check` error from the blockchain.  This subroutine might take up to five minutes to execute in the worst possible situation.  To disable this behavior, use the `recover_transactions_on_error` and set it to `false`, e.g.:
+
+```ruby
+tx = Radiator::Transaction.new(wif: wif, recover_transactions_on_error: false)
+```
+
 ## Tests
 
 * Clone the client repository into a directory of your choice:

data/lib/radiator/api.rb

@@ -138,9 +138,9 @@ module Radiator
       'https://steemd-int.steemit.com',
       'https://steemd.steemitstage.com',
       'https://gtg.steem.house:8090',
-      "https://seed.bitcoiner.me",
-      "https://steemd.minnowsupportproject.org",
-      "https://steemd.privex.io",
+      'https://seed.bitcoiner.me',
+      'https://steemd.minnowsupportproject.org',
+      'https://steemd.privex.io',
       'https://rpc.steemliberator.com'
     ]
     

data/lib/radiator/stream.rb

@@ -92,7 +92,7 @@ module Radiator
     # ... or multiple virtual operation types;
     #
     #   stream = Radiator::Stream.new
-    #   stream.operations([:produer_reward, :author_reward]) do |vop|
+    #   stream.operations([:producer_reward, :author_reward]) do |vop|
     #     puts vop
     #   end
     #
@@ -105,6 +105,7 @@ module Radiator
     #
     # Expected virtual operation types:
     #
+    #   producer_reward
     #   author_reward
     #   curation_reward
     #   fill_convert_request

data/lib/radiator/version.rb

@@ -1,3 +1,3 @@
 module Radiator
-  VERSION = '0.3.0dev6'
+  VERSION = '0.3.0rc1'
 end

data/radiator.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.1', '>= 12.1.0'
   spec.add_development_dependency 'minitest', '~> 5.9', '>= 5.9.0'
   spec.add_development_dependency 'minitest-line', '~> 0.6.3'
-  spec.add_development_dependency 'webmock', '~> 2.1', '>= 2.1.0'
+  spec.add_development_dependency 'webmock', '~> 3.1', '>= 3.1.0'
   spec.add_development_dependency 'simplecov', '~> 0.15.1'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.5.2'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0', '>= 1.0.5'
   spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
   spec.add_development_dependency 'faraday', '~> 0.9.2'
   spec.add_development_dependency 'typhoeus', '~> 1.0', '>= 1.0.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: radiator
 version: !ruby/object:Gem::Version
-  version: 0.3.0dev6
+  version: 0.3.0rc1
 platform: ruby
 authors:
 - Anthony Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,20 +90,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -124,14 +124,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement