hive-ruby 1.0.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f12eb926857666814b1ddd99302952102c91299bba3d2efc9ffb75888f72c520
+  data.tar.gz: e1103584e3aec71e89f336c3a044d54ad8f3f8bd0056fdf6d1cf694ce3c4f816
+SHA512:
+  metadata.gz: 16e20294bf841fa651c9a236c499f659dbf10b136876e31acead394e4362f68583fcb846a86cd19cfdd7505c46dda22d13c05f008f290e1b92c4b7b36b2589dc
+  data.tar.gz: 4c3104a416ce1010e6e4543bb9830aad3a884e7af34d8083d59f8b57d4043cdb3454a37eefe3927aeee516f9eda9c12109495deb7ec0252fd5d454d50b9d7222

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/fixtures/vcr_cassettes/*.yml
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# gource output
+output.mp4

data/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+
+# Contributing
+
+Everyone is welcome to contribute code to Galactica Actual projects. We have a Code of Conduct;
+we ask that you please follow it in all your interactions with our team and your fellow
+contributors.
+
+Please note that this contributing guide only applies to our development presence.
+
+## How to contribute
+
+1. File an issue describing the problem you would like to
+   solve or the feature you would like to add. It saves unnecessary work on your part, 
+   in case there's a nontechnical reason we can't accept a particular change.
+   Please note that we can and will _automatically close all pull requests that do not refer to
+   an issue_.
+2. Learn the conventions of the project you are submitting code to, even implicit ones,
+   and follow them. In case you have a question about a project's conventions, please
+   ask on the issue you filed. This includes writing tests, formatting code, and documentation.
+3. File a pull request against your Github issue and fill out the pull request template.
+   Remember, you are agreeing to license your code and any intellectual property associated
+   with your code under the same terms as the repository you are contributing to.
+4. If one of our teammates asks you to make changes, please make them. Our rule is that all
+   requests for changes in code review are resolved in favor of the reviewer. Our teammates
+   follow this rule too!
+
+## Code of Conduct
+
+Again, please note that this Code of Conduct _only applies to our development presence_.
+
+### Our Pledge
+
+We welcome your membership in our project and community under the rules that we have set below. 
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers will work to make your participation in
+our project and community as fulfilling as possible.
+
+### Our Rules
+
+All members of our project and community must:
+
+1.  Show empathy toward other project and community members
+2.  Use welcoming and inclusive language
+3.  Respect differing viewpoints and experiences
+4.  Gracefully accept constructive criticism
+
+All members of our project and community must not:
+
+1.  Harm our project and community, or advocate harm to our project and community
+2.  Insult or make derogatory comments about others
+3.  Interact with others after they have withdrawn permission to do so
+
+### Our Responsibilities
+
+We will use any and all lawful means at our disposal to enforce our rules. This includes
+but is not limited to:
+
+1.  Rejecting contributions
+2.  Removing comments, commits, code, wiki edits, and issues
+3.  Banning abusers
+ 
+We will clarify standards of acceptable behavior and we will take appropriate
+and fair corrective action in response to any instances of unacceptable behavior.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting us at github.abuse@martin-studio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. We
+maintain strict confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/gg

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    hive-ruby (1.0.0.pre.1)
+      base58 (~> 0.2, >= 0.2.3)
+      bindata (~> 2.4, >= 2.4.4)
+      bitcoin-ruby (~> 0.0, >= 0.0.18)
+      ffi (~> 1.9, >= 1.9.23)
+      hashie (~> 3.5, >= 3.5.7)
+      json (~> 2.1, >= 2.1.0)
+      logging (~> 2.2, >= 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    awesome_print (1.8.0)
+    base58 (0.2.3)
+    bindata (2.4.7)
+    bitcoin-ruby (0.0.20)
+      eventmachine
+      ffi
+      scrypt
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.3.2)
+    eventmachine (1.2.7)
+    ffi (1.12.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    hashie (3.6.0)
+    io-console (0.5.6)
+    irb (1.2.4)
+      reline (>= 0.0.1)
+    json (2.3.0)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    method_source (1.0.0)
+    minitest (5.14.0)
+    minitest-line (0.6.5)
+      minitest (~> 5.0)
+    minitest-proveit (1.0.0)
+      minitest (> 5, < 7)
+    multi_json (1.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.4)
+    rake (13.0.1)
+    reline (0.1.4)
+      io-console (~> 0.5)
+    safe_yaml (1.0.5)
+    scrypt (3.0.7)
+      ffi-compiler (>= 1.0, < 2.0)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    vcr (5.1.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.8, >= 1.8.0)
+  bundler (~> 1.16, >= 1.16.1)
+  hive-ruby!
+  irb (~> 1.2, >= 1.2.3)
+  minitest (~> 5.10, >= 5.10.3)
+  minitest-line (~> 0.6, >= 0.6.4)
+  minitest-proveit (~> 1.0, >= 1.0.0)
+  pry (~> 0.11, >= 0.11.3)
+  rake (~> 13.0.1, >= 12.3.0)
+  simplecov (~> 0.15, >= 0.15.1)
+  vcr (~> 5.1, >= 4.0.0)
+  webmock (~> 3.3, >= 3.3.0)
+  yard (~> 0.9, >= 0.9.12)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 hive-ruby
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,248 @@
+[![Gem Version](https://badge.fury.io/rb/hive-ruby.svg)](https://badge.fury.io/rb/hive-ruby)
+<!-- [![Inline docs](http://inch-ci.org/github/GalacticaActual/hive-ruby.svg?branch=master&style=shields)](http://inch-ci.org/github/GalacticaActual/hive-ruby) -->
+
+# `hive-ruby`
+
+Hive-ruby the Ruby API for Hive blockchain.
+
+<!-- Full documentation: http://www.rubydoc.info/gems/hive-ruby -->
+
+## `radiator` vs. `hive-ruby`
+
+The `hive-ruby` gem was written from the ground up by `@inertia`, who is also the author of [`radiator`](https://github.com/inertia186/radiator).
+
+> "I intend to continue work on `radiator` indefinitely. But in `radiator-0.5`, I intend to refactor `radiator` so that is uses `hive-ruby` as its core. This means that some features of `radiator` like Serialization will become redundant. I think it's still useful for radiator to do its own serialization because it reduces the number of API requests." - @inertia
+
+`radiator` | `hive-ruby`
+---------- | ------------
+Has internal failover logic | Can have failover delegated externally
+Passes `error` responses to the caller | Handles `error` responses and raises exceptions
+Supports tx signing, does its own serialization | Also supports tx signing, but delegates serialization to `database_api.get_transaction_hex`, then deserializes to verify
+All apis and methods are hardcoded | Asks `jsonrpc` what apis and methods are available from the node
+(`radiator-0.4.x`) Only supports AppBase but relies on `condenser_api` | Only supports AppBase but does not rely on `condenser_api` **(WIP)**
+Small list of helper methods for select ops (in addition to build your own transaction) | Complete implementation of helper methods for every op (in addition to build your own transaction)
+Does not (yet) support `json-rpc-batch` requests | Supports `json-rpc-batch` requests
+
+## Getting Started
+
+The hive-ruby gem is compatible with Ruby 2.2.5 or later.
+
+### Install the gem for your project
+
+*(Assuming that [Ruby is installed](https://www.ruby-lang.org/en/downloads/) on your computer, as well as [RubyGems](http://rubygems.org/pages/download))*
+
+To install the gem on your computer, run in shell:
+
+```bash
+gem install hive-ruby
+```
+
+... then add in your code:
+
+```ruby
+require 'hive'
+```
+
+To add the gem as a dependency to your project with [Bundler](http://bundler.io/), you can add this line in your Gemfile:
+
+```ruby
+gem 'hive-ruby', require: 'hive'
+```
+
+## Examples
+
+### Broadcast Vote
+
+```ruby
+params = {
+  voter: voter,
+  author: author,
+  permlink: permlink,
+  weight: weight
+}
+
+Hive::Broadcast.vote(wif: wif, params: params) do |result|
+  puts result
+end
+```
+
+<!-- *See: [Broadcast](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast)* -->
+
+### Streaming
+
+The value passed to the block is an object, with the keys: `:type` and `:value`.
+
+```ruby
+stream = Hive::Stream.new
+
+stream.operations do |op|
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+To start a stream from a specific block number, pass it as an argument:
+
+```ruby
+stream = Hive::Stream.new
+
+stream.operations(at_block_num: 9001) do |op|
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+You can also grab the related transaction id and block number for each operation:
+
+```ruby
+stream = Hive::Stream.new
+
+stream.operations do |op, trx_id, block_num|
+  puts "#{block_num} :: #{trx_id}"
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+To stream only certain operations:
+
+```ruby
+stream = Hive::Stream.new
+
+stream.operations(types: :vote_operation) do |op|
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+Or pass an array of certain operations:
+
+```ruby
+stream = Hive::Stream.new
+
+stream.operations(types: [:comment_operation, :vote_operation]) do |op|
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+Or (optionally) just pass the operation(s) you want as the only arguments.  This is semantic sugar for when you want specific types and take all of the defaults.
+
+```ruby
+stream = Hive::Stream.new
+
+stream.operations(:vote_operation) do |op|
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+To also include virtual operations:
+
+```ruby
+stream = Hive::Stream.new
+
+stream.operations(include_virtual: true) do |op|
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+### Multisig
+
+You can use multisignature to broadcast an operation.
+
+```ruby
+params = {
+  voter: voter,
+  author: author,
+  permlink: permlink,
+  weight: weight
+}
+
+Hive::Broadcast.vote(wif: [wif1, wif2], params: params) do |result|
+  puts result
+end
+```
+
+In addition to signing with multiple `wif` private keys, it is possible to also export a partially signed transaction to have signing completed by someone else.
+
+```ruby
+builder = Hive::TransactionBuilder.new(wif: wif1)
+
+builder.put(vote: {
+  voter: voter,
+  author: author,
+  permlink: permlink,
+  weight: weight
+})
+
+trx = builder.sign.to_json
+
+File.open('trx.json', 'w') do |f|
+  f.write(trx)
+end
+```
+
+Then send the contents of `trx.json` to the other signing party so they can privately sign and broadcast the transaction.
+
+```ruby
+trx = open('trx.json').read
+builder = Hive::TransactionBuilder.new(wif: wif2, trx: trx)
+api = Hive::CondenserApi.new
+trx = builder.transaction
+api.broadcast_transaction_synchronous(trx)
+```
+
+### Get Accounts
+
+```ruby
+api = Hive::DatabaseApi.new
+
+api.find_accounts(accounts: ['hiveio', 'alice']) do |result|
+  puts result.accounts
+end
+```
+
+<!-- *See: [Api](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)* -->
+
+### Reputation Formatter
+
+```ruby
+rep = Hive::Formatter.reputation(account.reputation)
+puts rep
+```
+
+### Tests
+
+* Clone the client repository into a directory of your choice:
+  * `git clone https://gitlab.syncad.com/hive/hive-ruby.git`
+* Navigate into the new folder
+  * `cd hive-ruby`
+* All tests can be invoked as follows:
+  * `bundle exec rake test`
+* To run `static` tests:
+  * `bundle exec rake test:static`
+* To run `broadcast` tests (broadcast is simulated, only `verify` is actually used):
+  * `bundle exec rake test:broadcast`
+* To run `threads` tests (which quickly verifies thread safety):
+  * `bundle exec rake test:threads`
+* To run `testnet` tests (which does actual broadcasts)
+  * `TEST_NODE=https://testnet-api.openhive.network bundle exec rake test:testnet`
+
+You can also run other tests that are not part of the above `test` execution:
+
+* To run `block_range`, which streams blocks (using `json-rpc-batch`)
+  * `bundle exec rake stream:block_range`
+
+
+If you want to point to any node for tests, instead of letting the test suite pick the default, set the environment variable to `TEST_NODE`, e.g.:
+
+```bash
+$ TEST_NODE=https://testnet-api.openhive.network bundle exec rake test
+```
+
+## Contributions
+
+Patches are welcome! Contributors are listed in the `hive-ruby.gemspec` file. Please run the tests (`rake test`) before opening a pull request and make sure that you are passing all of them. If you would like to contribute, but don't know what to work on, check the issues list.
+
+## Issues
+
+When you find issues, please report them!
+
+## License
+
+MIT