zold 0.10.12 → 0.10.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1231985c6293cf6bd772a545a6a384f697e365c8
-  data.tar.gz: 1a07fc356b7424aa715389bfbd71bbbb2f58ad43
+  metadata.gz: e6232c5057d899ff2c3600af61ca53b872a01c79
+  data.tar.gz: 5ad79a8d968e3e03fa70c3955bfe813c1c493bec
 SHA512:
-  metadata.gz: da488d1c4d6948209c0cf22d903dd039950e24c184be3362fdeb641edc458ba843eafb7fbfbf439d92db69d600fea84bfd13e7ec49234436c980b266475803d4
-  data.tar.gz: 4bc5b94357ee8a02beaa41526d5b9a468d8ee857bd0a1287902a41efd1880eb2c0b4f6b934d354b297e4a2c340f19f7ffedfc0ffacc995f4d39915e31087a6cb
+  metadata.gz: '01845774b4f1783571f47097513d006cbb670da6e0ca040df72039092cdafabd2e588bc470932eb8ee4bb84f423d52f4eabaa5a9c0ab353937d7ccde37e89e48'
+  data.tar.gz: 20cca37c6f77efdc6a150e73d574db3c92da458311197c639cc493c7b6f2297f956b90aeada211e44143ee2e7cc7d8ec16e62b870f910888e91406fd4708a1ff

data/INSTALL.md

@@ -0,0 +1,54 @@
+<img src="http://www.zold.io/logo.svg" width="92px" height="92px"/>
+
+This is how you install `zold` Ruby gem on different platform.
+
+We are very interested in your contribution to this document.
+If and when you experience any problems, make changes here via a pull request.
+
+Basically, you need to
+install [Ruby 2.3+](https://www.ruby-lang.org/en/documentation/installation/),
+[Rubygems](https://rubygems.org/pages/download), and
+then the [gem](https://rubygems.org/gems/zold).
+
+## Ubuntu 16.04
+
+```bash
+$ sudo apt-get update -y
+$ sudo apt-get install -y ruby-dev rubygems zlib1g-dev libssl-dev
+$ gem install zold
+```
+
+## OSX
+
+With homebrew:
+
+```
+$ brew install rbenv ruby-build
+$ rbenv install 2.5.1
+$ rbenv global 2.5.1
+$ ruby -v
+$ gem install zold
+```
+
+Without homebrew:
+
+... no idea ...
+
+## Windows
+
+... please contribute ...
+
+## CentOS
+
+... please contribute ...
+
+## Amazon Linux (AWS EC2 default image)
+
+```
+sudo yum install zlib-devel gcc gcc-c++ ruby-devel rubygems ruby
+gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+curl -sSL https://get.rvm.io | bash -s stable
+source $HOME/.rvm/scripts/rvm
+rvm install 2.5.1
+gem install zold
+```

data/README.md

@@ -27,12 +27,8 @@ The license is [MIT](https://github.com/yegor256/zold/blob/master/LICENSE.txt).
 
 First, install [Ruby 2.3+](https://www.ruby-lang.org/en/documentation/installation/),
 [Rubygems](https://rubygems.org/pages/download), and
-the [gem](https://rubygems.org/gems/zold):
-
-```bash
-$ sudo apt-get install ruby-dev rubygems zlib1g-dev libssl-dev
-$ gem install zold
-```
+the [gem](https://rubygems.org/gems/zold).
+Here is [how](https://github.com/yegor256/zold/blob/master/INSTALL.md).
 
 To make sure it's installed, try:
 
@@ -98,7 +94,9 @@ and your own public IP address instead of `4.4.4.4`):
 $ zold node --trace --verbose --invoice=5f96e731e48ae21f --host=4.4.4.4
 ```
 
-Then, open the page `4.4.4.4:4096` in your browser.
+Then, open the page `4.4.4.4:4096` in your browser
+(you may need to open the inbound port at your
+[IP firewall](https://www.howtogeek.com/177621/the-beginners-guide-to-iptables-the-linux-firewall/)).
 If you see a simple JSON document, everything is fine.
 Next, hit <kbd>Ctrl</kbd>+<kbd>c</kbd> and run this line, in order
 to start the node and make sure it will be online even when you log off

data/lib/zold/commands/calculate.rb

@@ -63,6 +63,8 @@ Available options:"
       calculate(opts)
     end
 
+    private
+
     def calculate(opts)
       start = Time.now
       mstart = Time.now

data/lib/zold/commands/create.rb

@@ -55,6 +55,8 @@ Available options:"
       create(mine.empty? ? Id.new : Id.new(mine[0]), opts)
     end
 
+    private
+
     def create(id, opts)
       wallet = @wallets.find(id)
       key = Zold::Key.new(file: opts['public-key'])

data/lib/zold/commands/diff.rb

@@ -59,6 +59,8 @@ Available options:"
       stdout
     end
 
+    private
+
     def diff(wallet, cps, _)
       raise 'There are no remote copies, try FETCH first' if cps.all.empty?
       cps = cps.all.sort_by { |c| c[:score] }.reverse

data/lib/zold/commands/fetch.rb

@@ -62,6 +62,8 @@ Available options:"
       end
     end
 
+    private
+
     def fetch(id, cps, opts)
       total = 0
       @remotes.iterate(@log) do |r|

data/lib/zold/commands/invoice.rb

@@ -54,6 +54,8 @@ Available options:"
       invoice(wallet, opts)
     end
 
+    private
+
     def invoice(wallet, opts)
       invoice = "#{Prefixes.new(wallet).create(opts[:length])}@#{wallet.id}"
       @log.info(invoice)

data/lib/zold/commands/merge.rb

@@ -59,6 +59,8 @@ Available options:"
       modified
     end
 
+    private
+
     def merge(wallet, cps, _)
       raise 'There are no remote copies, try FETCH first' if cps.all.empty?
       cps = cps.all.sort_by { |c| c[:score] }.reverse

data/lib/zold/commands/node.rb

@@ -62,6 +62,9 @@ module Zold
         o.bool '--standalone',
           'Never communicate with other nodes (mostly for testing)',
           default: false
+        o.bool '--ignore-score-weakness',
+          'Ignore score weakness of incoming requests and register those nodes anyway',
+          default: false
         o.bool '--never-reboot',
           'Don\'t reboot when a new version shows up in the network',
           default: false
@@ -87,6 +90,7 @@ module Zold
       else
         remotes = Remotes.new(File.join(opts[:home], 'zold-remotes'))
       end
+      Front.set(:ignore_score_weakness, opts['ignore-score-weakness'])
       wallets = Wallets.new(File.join(opts[:home], 'zold-wallets'))
       Front.set(:wallets, wallets)
       Front.set(:remotes, remotes)
@@ -124,7 +128,7 @@ module Zold
           end
         end
       end
-      @log.debug('Starting up the web front...')
+      @log.debug("Starting up the web front at http://#{opts[:host]}:#{opts[:port]}...")
       begin
         Front.run!
       ensure

data/lib/zold/commands/pay.rb

@@ -79,6 +79,8 @@ Available options:"
       pay(from, invoice, amount, details, opts)
     end
 
+    private
+
     def pay(from, invoice, amount, details, opts)
       unless opts.force?
         raise 'The amount can\'t be zero' if amount.zero?

data/lib/zold/commands/propagate.rb

@@ -54,6 +54,8 @@ Available options:"
       modified
     end
 
+    private
+
     # Returns list of Wallet IDs which were affected
     def propagate(wallet, _)
       me = wallet.id

data/lib/zold/commands/push.rb

@@ -58,6 +58,8 @@ Available options:"
       end
     end
 
+    private
+
     def push(wallet, opts)
       total = 0
       @remotes.iterate(@log) do |r|

data/lib/zold/commands/remote.rb

@@ -62,6 +62,9 @@ Available options:"
         o.bool '--ignore-score-weakness',
           'Don\'t complain when their score is too weak',
           default: false
+        o.bool '--force',
+          'Add/remove if if this operation is not possible',
+          default: false
         o.bool '--reboot',
           'Exit if any node reports version higher than we have',
           default: false
@@ -77,9 +80,9 @@ Available options:"
       when 'reset'
         reset
       when 'add'
-        add(mine[1], mine[2] ? mine[2].to_i : Remotes::PORT)
+        add(mine[1], mine[2] ? mine[2].to_i : Remotes::PORT, opts)
       when 'remove'
-        remove(mine[1], mine[2] ? mine[2].to_i : Remotes::PORT)
+        remove(mine[1], mine[2] ? mine[2].to_i : Remotes::PORT, opts)
       when 'update'
         update(opts)
         update(opts, false)
@@ -88,6 +91,8 @@ Available options:"
       end
     end
 
+    private
+
     def show
       @remotes.all.each do |r|
         score = Rainbow("/#{r[:score]}").color(r[:score] > 0 ? :green : :red)
@@ -105,15 +110,25 @@ Available options:"
       @log.debug('Remote nodes set back to default')
     end
 
-    def add(host, port)
-      @remotes.add(host, port)
-      @log.info("#{host}:#{port} added to the list")
+    def add(host, port, opts)
+      if @remotes.exists?(host, port)
+        raise "#{host}:#{port} already exists in the list" unless opts['force']
+        @log.info("#{host}:#{port} already exists in the list")
+      else
+        @remotes.add(host, port)
+        @log.info("#{host}:#{port} added to the list")
+      end
       @log.info("There are #{@remotes.all.count} remote nodes in the list")
     end
 
-    def remove(host, port)
-      @remotes.remove(host, port)
-      @log.info("#{host}:#{port} removed from the list")
+    def remove(host, port, opts)
+      if @remotes.exists?(host, port)
+        @remotes.remove(host, port)
+        @log.info("#{host}:#{port} removed from the list")
+      else
+        raise "#{host}:#{port} is not in the list" unless opts['force']
+        @log.info("#{host}:#{port} is not in the list")
+      end
       @log.info("There are #{@remotes.all.count} remote nodes in the list")
     end
 
@@ -135,7 +150,7 @@ Available options:"
         end
         if deep
           json['all'].each do |s|
-            add(s['host'], s['port']) unless @remotes.exists?(s['host'], s['port'])
+            add(s['host'], s['port'], opts) unless @remotes.exists?(s['host'], s['port'])
           end
         end
         capacity << { host: score.host, port: score.port, count: json['all'].count }

data/lib/zold/commands/show.rb

@@ -57,6 +57,8 @@ Available options:"
       end
     end
 
+    private
+
     def show(wallet, _)
       balance = wallet.balance
       wallet.txns.each do |t|

data/lib/zold/commands/taxes.rb

@@ -82,6 +82,8 @@ Available options:"
       end
     end
 
+    private
+
     def pay(wallet, _)
       raise 'The wallet is absent' unless wallet.exists?
       tax = Tax.new(wallet)
@@ -113,8 +115,6 @@ Available options:"
       raise 'Not implemented yet'
     end
 
-    private
-
     def top_scores
       best = []
       @remotes.iterate(@log) do |r|

data/lib/zold/http.rb

@@ -98,7 +98,7 @@ module Zold
         'Connection': 'close'
       }
       headers[Http::VERSION_HEADER] = VERSION
-      headers[Http::SCORE_HEADER] = @score.reduced(4).to_s if @score.valid? && @score.value >= 3 && !score.expired?
+      headers[Http::SCORE_HEADER] = @score.reduced(4).to_text if @score.valid? && !@score.expired?
       headers
     end
   end

data/lib/zold/node/front.rb

@@ -45,6 +45,7 @@ module Zold
       set :lock, false
       set :show_exceptions, false
       set :server, 'webrick'
+      set :ignore_score_weakness, false # to be injected at node.rb
       set :reboot, false # to be injected at node.rb
       set :home, nil? # to be injected at node.rb
       set :logging, true # to be injected at node.rb
@@ -58,11 +59,18 @@ module Zold
     end
 
     before do
-      return unless request.env[Http::SCORE_HEADER]
-      return unless settings.remotes.empty?
-      s = Score.parse(request.env[Http::SCORE_HEADER])
+      header = request.env["HTTP-#{Http::SCORE_HEADER}".upcase.tr('-', '_')]
+      return unless header
+      return if settings.remotes.all.empty?
+      s = Score.parse_text(header)
       error(400, 'The score is invalid') unless s.valid?
-      settings.remotes.add(s.host, s.port) if s.value > 3
+      error(400, 'The score is weak') if s.strength < Score::STRENGTH && !settings.ignore_score_weakness
+      if s.value > 3
+        require_relative '../commands/remote'
+        Remote.new(remotes: settings.remotes, log: settings.log).run(
+          ['remote', 'add', s.host, s.port.to_s, '--force']
+        )
+      end
     end
 
     after do
@@ -70,6 +78,7 @@ module Zold
       headers['Connection'] = 'close'
       headers['X-Zold-Version'] = VERSION
       headers['Access-Control-Allow-Origin'] = '*'
+      headers[Http::SCORE_HEADER] = score.reduced(16).to_s
     end
 
     get '/robots.txt' do

data/lib/zold/score.rb

@@ -64,10 +64,10 @@ module Zold
       )
     end
 
-    def self.parse(text, strength: STRENGTH)
+    def self.parse(text)
       m = Regexp.new(
         '^' + [
-          '([0-9]+:)',
+          '([0-9]+)/(?<strength>[0-9]+):',
           '(?<time>[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)',
           '(?<host>[0-9a-z\.\-]+)',
           '(?<port>[0-9]+)',
@@ -80,19 +80,19 @@ module Zold
         Time.parse(m[:time]), m[:host],
         m[:port].to_i, m[:invoice],
         m[:suffixes].split(' '),
-        strength: strength
+        strength: m[:strength].to_i
       )
     end
 
-    def self.parse_text(text, strength: STRENGTH)
-      parts = text.split(' ', 6)
+    def self.parse_text(text)
+      parts = text.split(' ', 7)
       Score.new(
-        Time.at(parts[0].hex),
-        parts[1],
-        parts[2].hex,
-        "#{parts[3]}@#{parts[4]}",
-        parts[5].split(' '),
-        strength: strength
+        Time.at(parts[1].hex),
+        parts[2],
+        parts[3].hex,
+        "#{parts[4]}@#{parts[5]}",
+        parts[6] ? parts[6].split(' ') : [],
+        strength: parts[0].to_i
       )
     end
 
@@ -106,6 +106,7 @@ module Zold
     def to_text
       pfx, bnf = @invoice.split('@')
       [
+        @strength,
         @time.to_i.to_s(16),
         @host,
         @port.to_s(16),
@@ -117,7 +118,7 @@ module Zold
 
     def to_s
       [
-        "#{value}:",
+        "#{value}/#{@strength}:",
         @time.utc.iso8601,
         @host,
         @port,
@@ -140,10 +141,9 @@ module Zold
     end
 
     def reduced(max = 4)
-      raise "The length of the score is #{@suffixes.count}, can't reduce to #{max}" if max > @suffixes.count
       Score.new(
         @time, @host, @port, @invoice,
-        @suffixes[0..max - 1], strength: @strength
+        @suffixes[0..[max, @suffixes.count].min - 1], strength: @strength
       )
     end
 

data/lib/zold/version.rb

@@ -23,5 +23,5 @@
 # Copyright:: Copyright (c) 2018 Yegor Bugayenko
 # License:: MIT
 module Zold
-  VERSION = '0.10.12'.freeze
+  VERSION = '0.10.13'.freeze
 end

data/test/node/fake_node.rb

@@ -33,7 +33,7 @@ class FakeNode
     @log = log
   end
 
-  def run
+  def run(args = ['--standalone'])
     WebMock.allow_net_connect!
     Dir.mktmpdir 'test' do |dir|
       server = TCPServer.new('127.0.0.1', 0)
@@ -46,14 +46,13 @@ class FakeNode
           require_relative '../../lib/zold/commands/node'
           Zold::Node.new(log: @log).run(
             [
-              '--standalone',
-              '--invoice', 'NOPREFIX@ffffffffffffffff',
               '--port', port.to_s,
               '--host=locahost',
               '--bind-port', port.to_s,
               '--threads=1',
-              '--home', home
-            ]
+              '--home', home,
+              '--invoice=NOPREFIX@ffffffffffffffff'
+            ] + args
           )
         end
       end

data/test/node/test_front.rb

@@ -19,18 +19,15 @@
 # SOFTWARE.
 
 require 'minitest/autorun'
-require 'tmpdir'
-require_relative '../../lib/zold/key'
-require_relative '../../lib/zold/id'
-require_relative '../../lib/zold/log'
-require_relative '../../lib/zold/amount'
-require_relative '../../lib/zold/wallet'
-require_relative '../../lib/zold/http'
+require 'json'
+require_relative '../test__helper'
 require_relative 'fake_node'
+require_relative '../../lib/zold/http'
+require_relative '../../lib/zold/score'
 
 class FrontTest < Minitest::Test
   def test_renders_public_pages
-    FakeNode.new.run do |port|
+    FakeNode.new(log: $log).run(['--ignore-score-weakness']) do |port|
       {
         '200' => [
           '/robots.txt',
@@ -52,6 +49,14 @@ class FrontTest < Minitest::Test
           )
         end
       end
+      score = Zold::Score.new(
+        Time.now, 'localhost', 999,
+        'NOPREFIX@ffffffffffffffff',
+        strength: 1
+      ).next.next.next.next
+      Zold::Http.new(URI("http://localhost:#{port}/"), score).get
+      json = JSON.parse(Zold::Http.new(URI("http://localhost:#{port}/remotes"), score).get.body)
+      assert(json['all'].find { |r| r['host'] == 'localhost' })
     end
   end
 end

data/test/test__helper.rb

@@ -35,3 +35,6 @@ $log = Zold::Log::Verbose.new
 
 require 'minitest/autorun'
 require_relative '../lib/zold'
+
+gem 'openssl'
+require 'openssl'

data/test/test_score.rb

@@ -52,10 +52,10 @@ class TestScore < Minitest::Test
     score = Zold::Score.parse(
       Zold::Score.new(
         time, 'localhost', 999, 'NOPREFIX@ffffffffffffffff',
-        %w[FIRST SECOND THIRD]
-      ).to_s
+        strength: 1
+      ).next.next.to_s
     )
-    assert_equal(3, score.value)
+    assert_equal(2, score.value)
     assert_equal(score.time.to_s, time.to_s)
     assert_equal('localhost', score.host)
     assert_equal(999, score.port)
@@ -66,11 +66,11 @@ class TestScore < Minitest::Test
     score = Zold::Score.parse_text(
       Zold::Score.new(
         time, 'a.example.com', 999, 'NOPREFIX@ffffffffffffffff',
-        %w[FIRST SECOND THIRD]
-      ).to_text
+        strength: 1
+      ).next.next.next.to_text
     )
     assert_equal(3, score.value)
-    assert_equal(score.time.to_s, time.to_s)
+    assert_equal(score.time.utc.to_s, time.utc.to_s)
     assert_equal('a.example.com', score.host)
     assert_equal(999, score.port)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zold
 version: !ruby/object:Gem::Version
-  version: 0.10.12
+  version: 0.10.13
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -268,6 +268,7 @@ files:
 - ".simplecov"
 - ".travis.yml"
 - Gemfile
+- INSTALL.md
 - LICENSE.txt
 - Procfile
 - README.md