voilkruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ec2630b0bab4658e1097d2f15b408359140dee32c142c0859e4a5a3f36772ad
+  data.tar.gz: fbfca6cd909b3b5da392570bbc0dccd56d3ce95d339b5875034b759c2ca3a81f
+SHA512:
+  metadata.gz: e94feb0dc13d4c9e405ddfabde9fc30cadd7fe0e7ad4f911b49db06ea6e63d7ade6bb3d6e3426c7d9b53f1d6e065142a1c5d85c8307883b05770f92efc74f9c1
+  data.tar.gz: 86afd13aadc3cbc397ab4fb6066fd72f6a6bc0d91444e81174bc91d7d242c562363143ee2fdab66c620fb4ae7950586dcb8e7ddcc72d9359f95487d521a34723

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    voilkruby (0.0.1)
+      awesome_print (~> 1.7, >= 1.7.0)
+      bitcoin-ruby (~> 0.0, >= 0.0.11)
+      ffi (~> 1.9, >= 1.9.18)
+      hashie (~> 3.5, >= 3.5.5)
+      json (~> 2.0, >= 2.0.2)
+      logging (~> 2.2, >= 2.2.0)
+      net-http-persistent (>= 2.5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    awesome_print (1.8.0)
+    bitcoin-ruby (0.0.18)
+    coderay (1.1.2)
+    connection_pool (2.2.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.3.1)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    hashie (3.6.0)
+    json (2.1.0)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    minitest-line (0.6.5)
+      minitest (~> 5.0)
+    minitest-proveit (1.0.0)
+      minitest (> 5, < 7)
+    multi_json (1.13.1)
+    net-http-persistent (3.0.0)
+      connection_pool (~> 2.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (12.3.1)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    vcr (4.0.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15, >= 1.15.4)
+  minitest (~> 5.10, >= 5.10.3)
+  minitest-line (~> 0.6.3)
+  minitest-proveit (~> 1.0, >= 1.0.0)
+  pry (~> 0.11, >= 0.11.3)
+  voilkruby!
+  rake (~> 12.1, >= 12.1.0)
+  simplecov (~> 0.16.1)
+  vcr (~> 4.0, >= 4.0.0)
+  webmock (~> 3.1, >= 3.1.0)
+  yard (~> 0.9.9)
+
+BUNDLED WITH
+   1.16.5

data/LICENSE

@@ -0,0 +1,41 @@
+CC0 1.0 Universal (CC0 1.0)
+Public Domain Dedication
+https://creativecommons.org/publicdomain/zero/1.0/
+
+This is a human-readable summary of the Legal Code:
+https://creativecommons.org/publicdomain/zero/1.0/legalcode
+
+Disclaimer
+
+The Commons Deed is not a legal instrument. It is simply a handy reference for
+understanding the CC0 Legal Code, a human-readable expression of some of its key
+terms. Think of it as the user-friendly interface to the CC0 Legal Code beneath.
+This Deed itself has no legal value, and its contents do not appear in CC0.
+Creative Commons is not a law firm and does not provide legal services.
+Distributing, displaying, or linking to this Commons Deed does not create an
+attorney-client relationship.
+
+Creative Commons has not verified the copyright status of any work to which CC0
+has been applied. CC makes no warranties about any work or its copyright status
+in any jurisdiction, and disclaims all liability for all uses of any work.
+
+No Copyright
+
+The person who associated a work with this deed has dedicated the work to the
+public domain by waiving all of his or her rights to the work worldwide under
+copyright law, including all related and neighboring rights, to the extent
+allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission. See Other Information below.
+
+Other Information
+
+* In no way are the patent or trademark rights of any person affected by CC0,
+  nor are the rights that other persons may have in the work or in how the work
+  is used, such as publicity or privacy rights.
+* Unless expressly stated otherwise, the person who associated a work with this
+  deed makes no warranties about the work, and disclaims liability for all uses
+  of the work, to the fullest extent permitted by applicable law.
+* When using or citing the work, you should not imply endorsement by the author
+  or the affirmer.

data/README.md

@@ -0,0 +1,519 @@
+[![Build Status](https://travis-ci.org/voilk/voilkruby.svg?branch=master)](https://travis-ci.org/voilk/voilkruby)
+[![Code Climate](https://codeclimate.com/github/voilk/voilkruby/badges/gpa.svg)](https://codeclimate.com/github/voilk/voilkruby)
+[![Test Coverage](https://codeclimate.com/github/voilk/voilkruby/badges/coverage.svg)](https://codeclimate.com/github/voilk/voilkruby)
+[![Inline docs](http://inch-ci.org/github/voilk/voilkruby.svg?branch=master&style=shields)](http://inch-ci.org/github/voilk/voilkruby)
+
+[voilkruby](https://github.com/voilknetwork/voilkruby)
+========
+
+#### VOILK Ruby API Client
+
+VoilkRuby is an API Client for interaction with the VOILK network using Ruby.
+
+#### Changes in v0.0.2
+
+* Gem updates
+* **AppBase Support**
+  * Defaulting to `condenser_api.*` in `VoilkRuby::Api` (see below)
+  * Handle/recover from new `AppBase` errors.
+* `VoilkRuby::Stream` now detects if it's stalled and takes action if it has to wait too long for a new block.
+  1. Exponential back-off for stalls so that the node doesn't get slammed.
+  2. Short delays (3 times block production) only result in a warning.
+  3. Long delays (6 times block production) may try to switch to an alternate node.
+* Fixed internal logging bug that would open too many files.
+
+**Appbase is now supported.**
+
+If you were already using `VoilkRuby::Api` then there is nothing to change.  But if you made use of other API classes, like `VoilkRuby::FollowApi`, then the method signatures have changed.
+
+**Pre-AppBase:**
+
+```ruby
+api = VoilkRuby::FollowApi.new
+
+api.get_followers('bilalhaider', 0, 'blog', 10)
+```
+
+**New Signature:**
+
+```ruby
+api = VoilkRuby::FollowApi.new
+
+api.get_followers(account: 'bilalhaider', start: 0, type: 'blog', limit: 10)
+```
+
+*-- or --*
+
+**Switch to Condenser API:**
+
+The other strategy for using this version of VoilkRuby is to just switch away from classes like `VoilkRuby::FollowApi` over to `VoilkRuby::Api` (also known as `VoilkRuby::CondenserApi`) instead.  Then you don't have to update individual method calls.
+
+```ruby
+api = VoilkRuby::Api.new
+
+api.get_followers('bilalhaider', 0, 'blog', 10)
+```
+
+
+#### Changes in v0.0.2
+
+* 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/voilkruby).
+* Added/expanded more api namespaces: `::BlockApi`, `::CondenserApi`, `::TagApi`
+* Addressed an issue with logging on certain Windows configurations.
+* Added low-level support for persistence and retrying API requests.
+* Now using exponential back-off for retries.
+* Detecting presence of `transaction_ids` (if enabled by the node).
+* Default for `Hashie` warnings now go to `/dev/null`, where they belong.
+* Added stray methods/operations.
+* Improved support for datatypes and handlers.
+  * UTF-8 handled more smoothly.
+  * Simplified operation construction.
+* Improved keep-alive defaults.
+  * Better streaming reliability.
+
+---
+
+Also see: [Documentation](http://www.rubydoc.info/gems/voilkruby)
+
+---
+
+### Quick Start
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'voilkruby'
+```
+
+Then:
+
+```bash
+$ bundle install
+```
+
+If you don't have `bundler`, see the next section.
+    
+### Prerequisites
+
+`minimum ruby version: 2.2`
+
+#### Linux
+
+```bash
+$ sudo apt-get install ruby-full git openssl libssl1.0.0 libssl-dev
+$ gem install bundler
+```
+
+#### macOS
+
+```
+$ gem install bundler
+```
+
+### Usage
+
+```ruby
+require 'voilkruby'
+
+api = VoilkRuby::Api.new
+api.get_dynamic_global_properties do |properties|
+  properties.virtual_supply
+end
+=> "271342874.337 VOILK"
+```
+
+... or ...
+
+```ruby
+require 'voilkruby'
+
+api = VoilkRuby::Api.new
+response = api.get_dynamic_global_properties
+response.result.virtual_supply
+=> "271342874.337 VOILK"
+```
+
+#### Follower API
+
+```ruby
+api = VoilkRuby::FollowApi.new
+api.get_followers(account: 'bilalhaider', start: 0, type: 'blog', limit: 100) do |followers|
+  followers.map(&:follower)
+end
+```
+
+#### Streaming
+
+Here's an example of how to use a streaming instance to listen for votes:
+
+```ruby
+require 'voilkruby'
+
+stream = VoilkRuby::Stream.new
+
+stream.operations(:vote) do |op|
+  print "#{op.voter} voted for #{op.author}"
+  puts " (weight: #{op.weight / 100.0}%)"
+end
+```
+
+The output would look like this and continue until interrupted.
+
+```
+richman voted for krnel (weight: 100.0%)
+rainchen voted for rainchen (weight: 100.0%)
+richman voted for exploretraveler (weight: 100.0%)
+jlufer voted for michaelstobiersk (weight: 100.0%)
+jlufer voted for michaelstobiersk (weight: 100.0%)
+patelincho voted for borishaifa (weight: 100.0%)
+richman voted for vetvso (weight: 100.0%)
+jlufer voted for michaelstobiersk (weight: 100.0%)
+richman voted for orcish (weight: 100.0%)
+demotruk voted for skeptic (weight: -100.0%)
+photorealistic voted for oecp85 (weight: 100.0%)
+meesterboom voted for rubenalexander (weight: 100.0%)
+thecurator voted for robyneggs (weight: 40.0%)
+richman voted for originate (weight: 100.0%)
+helikopterben voted for etcmike (weight: 100.0%)
+.
+.
+.
+```
+
+You can also just stream all operations like this:
+
+```ruby
+stream.operations do |op|
+  puts op.to_json
+end
+```
+
+Example of the output:
+
+```json
+{
+   "vote":{
+      "voter":"abudar",
+      "author":"rangkangandroid",
+      "permlink":"the-kalinga-tattoo-maker",
+      "weight":10000
+   }
+}
+{
+   "vote":{
+      "voter":"shenburen",
+      "author":"masteryoda",
+      "permlink":"daily-payouts-leaderboards-september-16",
+      "weight":10000
+   }
+}
+{
+   "vote":{
+      "voter":"stiletto",
+      "author":"fyrstikken",
+      "permlink":"everybody-hating-me",
+      "weight":2500
+   }
+}
+{
+   "comment":{
+      "parent_author":"mariandavp",
+      "parent_permlink":"re-onceuponatime-re-mariandavp-the-bridge-original-artwork-by-mariandavp-20160906t182016608z",
+      "author":"onceuponatime",
+      "permlink":"re-mariandavp-re-onceuponatime-re-mariandavp-the-bridge-original-artwork-by-mariandavp-20160917t054726763z",
+      "title":"",
+      "body":"https://www.voilkimg.com/images/2016/09/17/oldcomputerpics551cb14c.jpg",
+      "json_metadata":"{\"tags\":[\"art\"],\"image\":[\"https://www.voilkimg.com/images/2016/09/17/oldcomputerpics551cb14c.jpg\"]}"
+   }
+}
+{
+   "vote":{
+      "voter":"abudar",
+      "author":"rangkangandroid",
+      "permlink":"the-journey-north-through-the-eyes-of-kalinga-tradition",
+      "weight":10000
+   }
+}
+{
+   "limit_order_cancel":{
+      "owner":"fnait",
+      "orderid":2755220300
+   }
+}
+.
+.
+.
+```
+
+You can also stream virtual operations:
+
+```ruby
+stream.operations(:producer_reward) do |op|
+  puts "#{op.producer} got a reward: #{op.coining_shares}"
+end
+```
+
+Example of the output:
+
+```
+anyx got a reward: 390.974648 COINS
+gtg got a reward: 390.974647 COINS
+someguy123 got a reward: 390.974646 COINS
+jesta got a reward: 390.974646 COINS
+blocktrades got a reward: 390.974645 COINS
+timcliff got a reward: 390.974644 COINS
+bhuz got a reward: 1961.046504 COINS
+.
+.
+.
+```
+
+Transactions are supported:
+
+```ruby
+stream.transactions do |tx, trx_id|
+  puts "[#{trx_id}] #{tx.to_json}"
+end
+```
+
+Example of the output:
+
+```json
+{
+   "ref_block_num":59860,
+   "ref_block_prefix":2619183808,
+   "expiration":"2016-09-17T06:03:21",
+   "operations":[
+      [
+         "custom_json",
+         {
+            "required_auths":[
+
+            ],
+            "required_posting_auths":[
+               "acidpanda"
+            ],
+            "id":"follow",
+            "json":"[\"follow\",{\"follower\":\"acidpanda\",\"following\":\"gavvet\",\"what\":[\"blog\"]}]"
+         }
+      ]
+   ],
+   "extensions":[],
+   "signatures":[
+      "2048d7e32cc843adea0e11aa617dc9cdc773d0e9a0a0d0cd58d67a9fcd8fa2d2305d1bb611ac219fbd3b6a77ab60071df94fe193aae33591ee669cc7404d4e4ec4"
+   ]
+}
+.
+.
+.
+```
+
+Even whole blocks:
+
+```ruby
+stream.blocks do |bk, num|
+  puts "[#{num}] #{bk.to_json}"
+end
+```
+
+Example of the output:
+
+```json
+{
+   "previous":"004cea0d46a4b91cffe7bb71763ad2ab854c6efd",
+   "timestamp":"2016-09-17T06:05:51",
+   "witness":"boatymcboatface",
+   "transaction_merkle_root":"0000000000000000000000000000000000000000",
+   "extensions":[],
+   "witness_signature":"2034b0d7398ed1c0d7511ac76c6dedaf227e609dc2676d13f926ddd1e9df7fa9cb254af122a4a82dc619a1091c87293cbd9e2db1b51404fdc8fb62f8e5f37b4625",
+   "transactions":[]
+}
+.
+.
+.
+```
+
+#### Transaction Signing
+
+VoilkRuby supports transaction signing, so you can use it to vote:
+
+```ruby
+tx = VoilkRuby::Transaction.new(wif: 'Your Wif Here')
+vote = {
+  type: :vote,
+  voter: 'bilalhaider',
+  author: 'bilalhaider',
+  permlink: 'introduction',
+  weight: 10000
+}
+
+tx.operations << vote
+tx.process(true)
+```
+
+You can also post/comment:
+
+```ruby
+tx = VoilkRuby::Transaction.new(wif: 'Your Wif Here')
+comment = {
+  type: :comment,
+  parent_permlink: 'test',
+  author: 'your-account',
+  permlink: 'something-unique',
+  title: 'VoilkRuby Can Post Comments!',
+  body: 'Yep, this post was created by VoilkRuby in `ruby`.',
+  json_metadata: '',
+  parent_author: ''
+}
+
+tx.operations << comment
+tx.process(true)
+```
+
+Transfers:
+
+```ruby
+tx = VoilkRuby::Transaction.new(wif: 'Your Wif Here')
+transfer = {
+  type: :transfer,
+  from: 'voilk',
+  to: 'bilalhaider',
+  amount: '100000.000 VSD',
+  memo: 'Wow, inertia!  VoilkRuby is great!'
+}
+
+tx.operations << transfer
+tx.process(true)
+```
+
+There's a complete list of operations known to VoilkRuby in [`broadcast_operations.json`](https://github.com/voilknetwork/voilkruby/blob/master/lib/voilkruby/broadcast_operations.json).
+
+## Failover
+
+VoilkRuby 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 = {
+  url: 'https://api.voilk.com',
+  failover_urls: [
+    'https://api2.voilk.com',
+    'https://api3.voilk.com'
+  ]
+}
+
+api = VoilkRuby::Api.new(options)
+```
+
+In a nutshell, the way this works is VoilkRuby 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.
+
+VoilkRuby 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, VoilkRuby 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 = VoilkRuby::Transaction.new(wif: wif, recover_transactions_on_error: false)
+```
+
+## Debugging
+
+To enable debugging, set environment `LOG=DEBUG` before launching your app.  E.g.:
+
+```bash
+$ LOG=DEBUG irb -rvoilkruby
+```
+
+This will enable debugging for the `irb` session.
+
+## Troubleshooting
+
+## Problem: My log is full of `Unable to perform request ... retrying ...` messages.
+
+```
+W, [2017-10-10T11:38:30.035318 #6743]  WARN -- : database_api.get_dynamic_global_properties :: Unable to perform request: too many connection resets (due to Net::ReadTimeout - Net::ReadTimeout) after 0 requests on 26665356, last used 1507660710.035165 seconds ago :: cause: Net::ReadTimeout, retrying ...
+```
+
+This is caused by network interruptions.  If these messages happen once in a while, they can be ignored.  VoilkRuby will retry the request and move on.  If there are more frequent warnings, this will trigger the failover logic and pick a new node, if one has been configured (which is true by default).  See the Failover section above.
+
+## Problem: My log is full of `Invalid block sequence` messages.
+
+```
+W, [2017-10-10T13:53:24.327177 #6938]  WARN -- : Invalid block sequence at height: 16217674
+```
+
+This is a similar situation to `Unable to perform request ... retrying ...`.  VoilkRuby::Stream will retry and failover if needed.  It is happening because the node has responded with a block out of order and ::Stream is ignoring this block, then retrying.
+
+## Problem: What does the `Stream behind` error mean?
+
+```
+W, [2017-10-09T17:15:59.164484 #6231]  WARN -- : Stream behind by 6118 blocks (about 305.9 minutes).
+```
+
+## Solution:
+
+This is an error produced by `::Stream` when it notices that the current block is falling too far behind the head block.  One solution is to just restart the stream and see if it happens again.  If you see a message like this occasionally, but otherwise the stream seems to keep up, it probably was able to recover on its own.
+
+There can be several root causes. Resources like memory and CPU might be taxed.  The network connection might be too slow for what you're doing.  Remember, you're downloading each and every block, not just the operations you want.
+
+If you have excluded system resources as the root cause, then you should take a look at your code.  If you're doing anything that takes longer than 3 seconds per block, `::Stream` can fall behind.  When this happens, `::Stream` will try to catch up without displaying a warning.  But once you fall 400 blocks behind (~20 minutes), you'll start to get the warning messages.
+
+Verify your code is not doing too much between blocks.
+
+## Problem: I'm getting an endless loop: `#<OpenSSL::SSL::SSLError: SSL_connect SYSCALL returned=5 errno=0 state=error: certificate verify failed>`
+
+## Solution:
+
+You're probably creating too many threads or you don't have enough resources for what you're doing.  One option for you is to avoid persistent HTTP by passing `persist: false`.
+
+Doing this will impact performance because each API call will be a separate socket call.  All of the constructors accept `persist: false`., e.g.:
+
+```ruby
+api = VoilkRuby::Api.new(persist: false)
+```
+
+... or ...
+
+```ruby
+stream = VoilkRuby::Stream.new(persist: false)
+```
+
+... or ...
+
+```ruby
+tx = VoilkRuby::Transaction.new(options.merge(persist: false, wif: wif))
+```
+
+
+## Tests
+
+* Clone the client repository into a directory of your choice:
+  * `git clone https://github.com/voilknetwork/voilkruby.git`
+* Navigate into the new folder
+  * `cd voilkruby`
+* Basic tests can be invoked as follows:
+  * `rake`
+* To run tests with parallelization and local code coverage:
+  * `HELL_ENABLED=true rake`
+* To run a stream test on the live VOILK blockchain with debug logging enabled:
+  * `LOG=DEBUG rake test_live_stream`
+
+---
+
+
+See my previous Ruby How To posts in: [#voilkruby](https://voilk.com/created/voilkruby) [#ruby](https://voilk.com/created/ruby)
+
+## Special Thanks to
+
+If you're using VoilkRuby, You should know that it was forked from "Radiator" which was created by Anthony Martin
+  
+## License
+
+We don't believe in licensing.. 
+Use it however you want.