steem-mechanize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2752cbbde70dad7ede8aa1e11b8562f5f1c3cfc8
+  data.tar.gz: 827e2f15f4c373f2a1a7e62890c136afc8e96d4e
+SHA512:
+  metadata.gz: f8c6393b5863f8a171271ba49b205bb8620a0529b94fc399e97afd5e571c1251361a53ac7429ccdd2cd2a4623f30efd07ea4094cbf0eaf838360a30cf9860b3a
+  data.tar.gz: 37c3053013ac22c03c46401d9ae2e19a3a2f1060d8cfa930c7798d7fd505f68cc0614324fe04052d96ef00c5ee413915d4bfaa3194281e5bd0e3002d2fb2bd6b

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    steem-mechanize (0.0.1)
+      mechanize (~> 2.7, >= 2.7.5)
+      steem-ruby (~> 0.9, >= 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bitcoin-ruby (0.0.18)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.9.23)
+    hashie (3.5.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    mechanize (2.7.5)
+      domain_name (~> 0.5, >= 0.5.1)
+      http-cookie (~> 1.0)
+      mime-types (>= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 2.5, >= 2.5.2)
+      nokogiri (~> 1.6)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (>= 0.0.9, < 0.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    multi_json (1.13.1)
+    net-http-digest_auth (1.4.1)
+    net-http-persistent (2.9.4)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    ntlm-http (0.1.1)
+    rake (12.3.1)
+    steem-ruby (0.9.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)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    webrobots (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16, >= 1.16.1)
+  rake (~> 12.3, >= 12.3.0)
+  steem-mechanize!
+
+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,71 @@
+[![Gem Version](https://badge.fury.io/rb/steem-mechanize.svg)](https://badge.fury.io/rb/steem-mechanize)
+
+# `steem-mechanize`
+
+Steem Mechanize is an extension to [`steem-ruby`](https://github.com/steemit/steem-ruby) that replaces its `Net::HTTP` client with a [mechanize](https://github.com/sparklemotion/mechanize).
+
+## Feature
+
+There one only feature provided by this gem: Persistent HTTP
+
+All other functionality is identical to `steem-ruby`.  This gem achieves HTTP persistence by instantiating a Mechanize Agent as a singleton and using this agent for all requests.
+
+This is like having one dedicated browser performing all POST requests for json-rpc.  For certain applications, this can represent a signifiant performance boost over what `Net::HTTP` can offer.
+
+This gem also serves to demonstrate how easy it is to replace the default client used for performing `json-rpc` requests by `steem-ruby`.  The entire feature can be reviewed here:
+
+[`lib/steem/mechanize/rpc/mechanize_client.rb`](lib/steem/mechanize/rpc/mechanize_client.rb)
+
+## Getting Started
+
+The `steem-mechanize` 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-mechanize
+```
+
+... then add in your code:
+
+```ruby
+require 'steem-mechanize'
+```
+
+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-mechanize'
+```
+
+Once installed, use it just like [`steem-ruby`](https://github.com/steemit/steem-ruby).
+
+### Tests
+
+* Clone the client repository into a directory of your choice:
+  * `git clone https://github.com/steemit/steem-mechanize.git`
+* Navigate into the new folder
+  * `cd steem-mechanize`
+* To run `threads` tests (which quickly verifies thread safety):
+  * `bundle exec rake test:threads`
+
+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`
+
+## Contributions
+
+Patches are welcome! Contributors are listed in the `steem-mechanize.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,119 @@
+require 'bundler/gem_tasks'
+require 'steem-mechanize'
+
+task default: 'test:threads'
+
+desc 'Ruby console with steem-mechanize already required.'
+task :console do
+  exec 'irb -r steem-mechanize -I ./lib'
+end
+
+namespace :test do
+  desc 'Tests the mechanized API using multiple threads.'
+  task :threads do
+    next if !!ENV['TEST']
+    
+    threads = []
+    api = Steem::Api.new(url: ENV['TEST_NODE'])
+    database_api = Steem::DatabaseApi.new(url: ENV['TEST_NODE'])
+    witnesses = {}
+    keys = %i(created url total_missed props running_version
+      hardfork_version_vote hardfork_time_vote)
+    
+    if defined? Thread.report_on_exception
+      Thread.report_on_exception = true
+    end
+    
+    database_api.get_active_witnesses do |result|
+      print "Found #{result.witnesses.size} witnesses ..."
+      
+      result.witnesses.each do |witness_name|
+        threads << Thread.new do
+          api.get_witness_by_account(witness_name) do |witness|
+            witnesses[witness.owner] = witness.map do |k, v|
+              [k, v] if keys.include? k.to_sym
+            end.compact.to_h
+            
+            sbd_exchange_rate = witness[:sbd_exchange_rate]
+            base = sbd_exchange_rate[:base].to_f
+            
+            if (quote = sbd_exchange_rate[:quote].to_f) > 0
+              rate = (base / quote).round(3)
+              witnesses[witness.owner][:sbd_exchange_rate] = rate
+            else
+              witnesses[witness.owner][:sbd_exchange_rate] = nil
+            end
+            
+            last_sbd_exchange_update = witness[:last_sbd_exchange_update]
+            last_sbd_exchange_update = Time.parse(last_sbd_exchange_update + 'Z')
+            last_sbd_exchange_elapsed = '%.2f hours ago' % ((Time.now.utc - last_sbd_exchange_update) / 60)
+            witnesses[witness.owner][:last_sbd_exchange_elapsed] = last_sbd_exchange_elapsed
+          end
+        end
+      end
+    end
+    
+    threads.each do |thread|
+      print '.'
+      thread.join
+    end
+    
+    puts ' done!'
+    
+    if threads.size != witnesses.size
+      puts "Bug: expected #{threads.size} witnesses, only found #{witnesses.size}."
+    else
+      puts JSON.pretty_generate witnesses rescue puts witnesses
+    end
+  end
+end  
+
+namespace :stream do
+  desc 'Test the ability to stream a block range.'
+  task :block_range do
+    block_api = Steem::BlockApi.new(url: ENV['TEST_NODE'])
+    api = Steem::Api.new(url: ENV['TEST_NODE'])
+    last_block_num = nil
+    first_block_num = nil
+    last_timestamp = nil
+    
+    loop do
+      api.get_dynamic_global_properties do |properties|
+        current_block_num = properties.last_irreversible_block_num
+        # First pass replays latest a random number of blocks to test chunking.
+        first_block_num ||= current_block_num - (rand * 200).to_i
+        
+        if current_block_num >= first_block_num
+          range = first_block_num..current_block_num
+          puts "Got block range: #{range.size}"
+          block_api.get_blocks(block_range: range) do |block, block_num|
+            if block.nil?
+              puts "Bug: Got nil block for block_num: #{block_num}"
+              exit
+            end
+            
+            current_timestamp = Time.parse(block.timestamp + 'Z')
+            
+            if !!last_timestamp && block_num != last_block_num + 1
+              puts "Bug: Last block number was #{last_block_num} then jumped to: #{block_num}"
+              exit
+            end
+            
+            if !!last_timestamp && current_timestamp < last_timestamp
+              puts "Bug: Went back in time.  Last timestamp was #{last_timestamp}, then jumped back to #{current_timestamp}"
+              exit
+            end
+            
+            puts "\t#{block_num} Timestamp: #{current_timestamp}, witness: #{block.witness}"
+            last_block_num = block_num
+            last_timestamp = current_timestamp
+          end
+          
+          first_block_num = range.max + 1
+        end
+        
+        sleep 3
+      end
+    end
+  end
+end

data/lib/steem-mechanize.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require 'steem'
+require 'mechanize'
+
+require 'steem/mechanize/version'
+require 'steem/mechanize/rpc/mechanize_client'
+
+# Here, we will monkeypatch steem-ruby to use Mechanize.
+module Steem
+  class Api
+    def self.default_rpc_client_class
+      Steem::Mechanize::RPC::MechanizeClient
+    end
+  end
+end

data/lib/steem/mechanize/rpc/mechanize_client.rb

@@ -0,0 +1,29 @@
+module Steem
+  module Mechanize
+    module RPC
+      class MechanizeClient < Steem::RPC::HttpClient
+        POST_HEADERS = Steem::RPC::HttpClient::POST_HEADERS.merge(
+          'User-Agent' => Steem::Mechanize::AGENT_ID
+        )
+        
+        def self.agent
+          @agent ||= ::Mechanize.new(Steem::Mechanize::AGENT_ID).tap do |agent|
+            agent.user_agent = Steem::Mechanize::AGENT_ID
+            agent.max_history = 0
+            agent.default_encoding = 'UTF-8'
+          end
+        end
+        
+        def http_request(request)
+          catch :request_with_entity do; begin
+            self.class.agent.request_with_entity :post, url, request.body, POST_HEADERS
+          rescue Net::HTTP::Persistent::Error => e
+            @error_pipe.puts "Warning, retrying after agent reset due to: #{e}"
+            @agent = nil
+            throw :request_with_entity
+          end; end
+        end
+      end
+    end
+  end
+end

data/lib/steem/mechanize/version.rb

@@ -0,0 +1,6 @@
+module Steem
+  module Mechanize
+    VERSION = '0.0.1'
+    AGENT_ID = "steem-mechanize/#{VERSION}"
+  end
+end

data/steem-mechanize.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steem/mechanize/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'steem-mechanize'
+  spec.version = Steem::Mechanize::VERSION
+  spec.authors = ['Anthony Martin']
+  spec.email = ['anthony@steem.com']
+
+  spec.summary = %q{Steem Mechanize Client}
+  spec.description = %q{Mechanized ruby client for accessing the Steem blockchain.}
+  spec.homepage = 'https://github.com/steem/steem-mechanize'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.1'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.0'
+  
+  spec.add_dependency 'steem-ruby', '~> 0.9', '>= 0.9.0'
+  spec.add_dependency 'mechanize', '~> 2.7', '>= 2.7.5'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: steem-mechanize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anthony Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: steem-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+description: Mechanized ruby client for accessing the Steem blockchain.
+email:
+- anthony@steem.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/steem-mechanize.rb
+- lib/steem/mechanize/rpc/mechanize_client.rb
+- lib/steem/mechanize/version.rb
+- steem-mechanize.gemspec
+homepage: https://github.com/steem/steem-mechanize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Steem Mechanize Client
+test_files: []