steem-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af48ecaba4ce86c2a21a91bd5299939408505ab7
+  data.tar.gz: e8dfa541ebb4000a6dbb6f05e318fdecda6a9f98
+SHA512:
+  metadata.gz: 5d57efdf7b7e1d64b7b513b6e44c68304603525e6bb09001df3494c7616f823d3adf90572e6b73ee474f79c78aa55530a1a73338f8b2af519e38f070d41835b8
+  data.tar.gz: 1056b940f606dd018b5cfcd1f134273b7e59e0587776d7841f2a6ef80aa3b1cbe3e562ddcfb31581c885205e608e816c78a510831a29cdc46c4308d59c6659c9

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/fixtures/vcr_cassettes/
+/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 Steemit, Inc. 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@steemit.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,73 @@
+PATH
+  remote: .
+  specs:
+    steem-ruby (0.1.0)
+      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.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    awesome_print (1.8.0)
+    bitcoin-ruby (0.0.18)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.3.0)
+    ffi (1.9.23)
+    hashdiff (0.3.7)
+    hashie (3.5.7)
+    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.0)
+    minitest (5.10.3)
+    minitest-line (0.6.4)
+      minitest (~> 5.0)
+    minitest-proveit (1.0.0)
+      minitest (> 5, < 7)
+    multi_json (1.13.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    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.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.8, >= 1.8.0)
+  bundler (~> 1.16, >= 1.16.1)
+  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 (~> 12.3, >= 12.3.0)
+  simplecov (~> 0.15, >= 0.15.1)
+  steem-ruby!
+  vcr (~> 4.0, >= 4.0.0)
+  webmock (~> 3.3, >= 3.3.0)
+  yard (~> 0.9, >= 0.9.12)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018 steem-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,77 @@
+# `steem-ruby`
+
+Steem-ruby the Ruby API for Steem blockchain.
+
+Full documentation: http://www.rubydoc.info/gems/steem-ruby
+
+## Getting Started
+
+The steem-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 steem-ruby
+```
+
+... then add in your code:
+
+```ruby
+require 'steem'
+```
+
+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 'steem-ruby', require: 'steem'
+```
+
+## Examples
+
+### Broadcast Vote
+
+```ruby
+params = {
+  voter: voter,
+  author: author,
+  permlink: permlink,
+  weight: weight
+}
+
+Steem::Broadcast.vote(wif: wif, params: params) do |result|
+  puts result
+end
+```
+
+### Get Accounts
+
+```ruby
+api = Steem::DatabaseApi.new
+
+api.find_accounts(accounts: ['steemit', 'alice']) do |result|
+  puts result.accounts
+end
+```
+
+### Reputation Formatter
+
+```ruby
+rep = Steem::Formatter.reputation(account.reputation)
+puts rep
+```
+
+## Contributions
+
+Patches are welcome! Contributors are listed in the `steem-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

data/Rakefile

@@ -0,0 +1,115 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard'
+require 'steem'
+
+Rake::TestTask.new(test: 'clean:vcr') do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.ruby_opts << if ENV['HELL_ENABLED']
+    '-W2'
+  else
+    '-W1'
+  end
+end
+
+namespace :test do
+  Rake::TestTask.new(static: 'clean:vcr') do |t|
+    t.description = <<-EOD
+      Run static tests, which are those that have static request/responses.
+      These are tests that are typically read-only and do not require heavy
+      matches on the json-rpc request body.  Often, the only difference between
+      one execution and another is the json-rpc-id.
+    EOD
+    t.libs << 'test'
+    t.libs << 'lib'
+    t.test_files = [
+      'test/steem/account_by_key_api_test.rb',
+      'test/steem/account_history_api_test.rb',
+      'test/steem/block_api_test.rb',
+      'test/steem/database_api_test.rb',
+      'test/steem/follow_api_test.rb',
+      'test/steem/jsonrpc_test.rb',
+      'test/steem/market_history_api_test.rb',
+      'test/steem/tags_api_test.rb',
+      'test/steem/witness_api_test.rb'
+    ]
+    t.ruby_opts << if ENV['HELL_ENABLED']
+      '-W2'
+    else
+      '-W1'
+    end
+  end
+  
+  Rake::TestTask.new(broadcast: 'clean:vcr') do |t|
+    t.description = <<-EOD
+      Run broadcast tests, which are those that only use network_broadcast_api
+      and/or database_api.verify_authority (pretend: true).
+    EOD
+    t.libs << 'test'
+    t.libs << 'lib'
+    t.test_files = [
+      'test/steem/broadcast_test.rb',
+      'test/steem/transaction_builder_test.rb'
+    ]
+    t.ruby_opts << if ENV['HELL_ENABLED']
+      '-W2'
+    else
+      '-W1'
+    end
+  end
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+task default: :test
+
+desc 'Ruby console with steem already required.'
+task :console do
+  exec 'irb -r steem -I ./lib'
+end
+
+namespace :clean do
+  desc 'Remove test/fixtures/vcr_cassettes/*.yml so they can be rebuilt fresh.'
+  task :vcr do |t|
+    cmd = 'echo Cleaned cassettes: $(rm -v test/fixtures/vcr_cassettes/*.yml | wc -l)'
+    system cmd
+  end
+end
+
+namespace :show do
+  desc 'Shows known API names.'
+  task :apis do
+    url = ENV['URL']
+    jsonrpc = Steem::Jsonrpc.new(url: url)
+    api_methods = jsonrpc.get_api_methods
+    puts api_methods.keys
+  end
+
+  desc 'Shows known method names for specified API.'
+  task :methods, [:api] do |t, args|
+    url = ENV['URL']
+    jsonrpc = Steem::Jsonrpc.new(url: url)
+    api_methods = jsonrpc.get_api_methods
+    api_methods[args[:api]].each do |method|
+      jsonrpc.get_signature(method: "#{args[:api]}.#{method}") do |signature|
+        print "#{method} "
+        params = signature.args.map do |k, v|
+          if v =~ /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T(2[0-3]|[01]\d):[0-5]\d:[0-5]\d/
+            "#{k}: Time"
+          elsif v.class == Hashie::Array
+            "#{k}: []"
+          elsif v.class == Hashie::Mash
+            "#{k}: {}"
+          else
+            "#{k}: #{v.class}"
+          end
+        end
+        puts params.join(', ')
+      end
+    end
+  end
+end

data/gource.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+gource ./ --user-image-dir images --hide usernames -s 0.5 -b 000000 \
+  -1280x720 --output-ppm-stream - |\
+  ffmpeg -y -r 28 -f image2pipe -vcodec ppm -i - -vcodec libx264 -preset slow \
+  -crf 28 -threads 0 output.mp4

data/lib/steem/api.rb

@@ -0,0 +1,190 @@
+module Steem
+  # This ruby API works with
+  # {https://github.com/steemit/steem/releases steemd-0.19.4} and other Appbase
+  # compatible upstreams.  To access different API namespaces, use the
+  # following:
+  #
+  #     api = Steem::Api.new
+  #     api.get_dynamic_global_properties
+  #
+  # The above example will make an instance that can access the
+  # {https://developers.steem.io/apidefinitions/condenser-api condenser_api}
+  # namespace.  Alternatively, you may also create a direct instances with its
+  # full name, if you prefer:
+  #
+  #     api = Steem::CondenserApi.new
+  #     api.get_dynamic_global_properties
+  #
+  # If you know the name of another API that is supported by the remote node,
+  # you can create an instance to that instead, for example:
+  #
+  #     api = Steem::MarketHistoryApi.new
+  #     api.get_volume
+  #
+  # All known API by namespace:
+  #
+  # * {AccountByKeyApi}
+  # * {AccountHistoryApi}
+  # * {BlockApi}
+  # * {DatabaseApi}
+  # * {FollowApi}
+  # * {Jsonrpc}
+  # * {MarketHistoryApi}
+  # * {NetworkBroadcastApi}
+  # * {TagsApi}
+  # * {WitnessApi}
+  #
+  # Also see: {https://developers.steem.io/apidefinitions.html Complete API Definitions}
+  class Api
+    attr_accessor :chain, :methods
+    
+    # Use this for debugging naive thread handler.
+    # DEFAULT_RPC_CLIENT = RPC::BaseClient
+    DEFAULT_RPC_CLIENT = RPC::ThreadSafeClient
+    
+    def self.api_name=(api_name)
+      @api_name = api_name.to_s.
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr('-', '_').downcase.to_sym
+    end
+    
+    def self.api_name
+      @api_name
+    end
+    
+    def self.api_class_name
+      @api_name.to_s.split('_').map(&:capitalize).join
+    end
+    
+    def self.jsonrpc=(jsonrpc)
+      @jsonrpc = jsonrpc
+    end
+    
+    def self.jsonrpc
+      @jsonrpc
+    end
+    
+    def initialize(options = {})
+      @chain = options[:chain] || :steem
+      @error_pipe = options[:error_pipe] || STDERR
+      @api_name = self.class.api_name ||= :condenser_api
+      @rpc_client = options[:rpc_client] || DEFAULT_RPC_CLIENT.new(options.merge(api_name: @api_name))
+      
+      if @api_name == :jsonrpc
+        Api::jsonrpc = self
+      else
+        # Note, we have to wait until initialize to check this because we don't
+        # have access to instance options until now.
+        
+        Api::jsonrpc = Jsonrpc.new(options)
+        @methods = Api::jsonrpc.get_api_methods
+        
+        unless !!@methods[@api_name]
+          raise UnknownApiError, "#{@api_name} (known APIs: #{@methods.keys.join(' ')})"
+        end
+        
+        @methods = @methods[@api_name]
+      end
+        
+      @try_count = 0
+    end
+    
+    def inspect
+      properties = %w(chain methods).map do |prop|
+        if !!(v = instance_variable_get("@#{prop}"))
+          case v
+          when Array then "@#{prop}=<#{v.size} #{v.size == 1 ? 'element' : 'elements'}>" 
+          else; "@#{prop}=#{v}" 
+          end
+        end
+      end.compact.join(', ')
+      
+      "#<#{self.class.api_class_name} [#{properties}]>"
+    end
+  private
+    def self.args_keys_to_s(rpc_method_name)
+      args = signature(rpc_method_name).args
+      args_keys = JSON[args.to_json]
+    end
+    
+    def self.signature(rpc_method_name)
+      @@signatures ||= {}
+      @@signatures[rpc_method_name] ||= jsonrpc.get_signature(method: rpc_method_name).result
+    end
+    
+    def self.raise_error_response(rpc_method_name, rpc_args, response)
+      raise UnknownError, "#{rpc_method_name}: #{response}" if response.error.nil?
+      
+      error = response.error
+      
+      if error.message == 'Invalid Request'
+        raise Steem::ArgumentError, "Unexpected arguments: #{rpc_args.inspect}.  Expected: #{rpc_method_name} (#{args_keys_to_s(rpc_method_name)})"
+      end
+      
+      BaseError.build_error(error, rpc_method_name)
+    end
+    
+    def respond_to_missing?(m, include_private = false)
+      methods.nil? ? false : methods.include?(m.to_sym)
+    end
+    
+    def method_missing(m, *args, &block)
+      super unless respond_to_missing?(m)
+      
+      rpc_method_name = "#{@api_name}.#{m}"
+      rpc_args = case @api_name
+      when :condenser_api then args
+      when :jsonrpc then args.first
+      else
+        expected_args = Api::signature(rpc_method_name).args || []
+        expected_args_key_string = if expected_args.size > 0
+          " (#{Api::args_keys_to_s(rpc_method_name)})"
+        end
+        expected_args_size = expected_args.size
+        
+        begin
+          args = args.first.to_h
+          args_size = args.size
+          
+          # Some argument are optional, but if the arguments passed are greater
+          # than the expected arguments size, we can warn.
+          if args_size > expected_args_size
+            error_pipe.puts "Warning #{rpc_method_name} expects arguments: #{expected_args_size}, got: #{args_size}"
+          end
+        rescue NoMethodError => e
+          error = Steem::ArgumentError.new("#{rpc_method_name} expects arguments: #{expected_args_size}", e)
+          raise error
+        rescue
+          raise Steem::ArgumentError, "#{rpc_method_name} expects arguments: #{expected_args_size}"
+        end
+        
+        args
+      end
+      
+      response = @rpc_client.rpc_post(@api_name, m, rpc_args)
+      
+      if defined?(response.error) && !!response.error
+        if !!response.error.message
+          Api::raise_error_response rpc_method_name, rpc_args, response
+        else
+          raise Steem::ArgumentError, response.error.inspect
+        end
+      end
+      
+      if !!block
+        case response
+        when Hashie::Mash then yield response.result, response.error, response.id
+        when Hashie::Array
+          response.each do |r|
+            r = Hashie::Mash.new(r)
+            yield r.result, r.error, r.id
+          end
+        else; yield response
+        end
+      else
+        return response
+      end
+    end
+  end
+end