zold-score 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ad77bc5ced6810f6d1e26f8032844499b395b3df3ad4cf385e2c07803e7c98f
+  data.tar.gz: f5e373d1aa2886380bd3e524b5fc3d504a12dba36892099f1d414ed6962e4229
+SHA512:
+  metadata.gz: 2927a86ebcd00fd33d404cfd6fad6a4a18cc2a9de0cfbea8b45f57a18c6b3b8c75c1fbcde32dbe37d6ad4fd7ca0f40f35657e8d709acd909336caa4ff23a99e1
+  data.tar.gz: 2a9194e4d45ef64ea965434ec2a6cc43879add8d4c939a963bdfb04ed05e780ad7d84f0b42083458413baae0c622854b793552691ad03727f54b476a6e1e2e33

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.gitattributes

@@ -0,0 +1,9 @@
+# Check out all text files in UNIX format, with LF as end of line
+# Don't change this file. If you have any ideas about it, please
+# submit a separate issue about it and we'll discuss.
+
+* text=auto eol=lf
+*.rb ident
+*.xml ident
+*.png binary
+*.pdf binary

data/.gitignore

@@ -0,0 +1,7 @@
+coverage/
+.idea/
+*.gem
+.bundle/
+.DS_Store
+rdoc/
+Gemfile.lock

data/.pdd

@@ -0,0 +1,7 @@
+--source=.
+--verbose
+--exclude target/**/*
+--exclude coverage/**/*
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3.3
+
+Metrics/LineLength:
+  Max: 120
+Metrics/AbcSize:
+  Max: 25
+Metrics/MethodLength:
+  Max: 25
+Metrics/ClassLength:
+  Max: 150
+Metrics/ParameterLists:
+  Max: 7
+Layout/AlignParameters:
+  Enabled: false

data/.rultor.yml

@@ -0,0 +1,26 @@
+assets:
+  rubygems.yml: zerocracy/home#assets/rubygems.yml
+install: |-
+  export GEM_HOME=~/.ruby
+  export GEM_PATH=$GEM_HOME:$GEM_PATH
+release:
+  script: |-
+    bundle install
+    rake
+    rm -rf *.gem
+    sed -i "s/0\.0\.0/${tag}/g" zold-score.gemspec
+    git add zold-score.gemspec
+    git commit -m "Version set to ${tag}"
+    gem build zold-score.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+  commanders:
+  - yegor256
+architect:
+- yegor256
+merge:
+  commanders: []
+  script: |-
+    bundle install
+    rake
+deploy: {}

data/.simplecov

@@ -0,0 +1,40 @@
+# encoding: utf-8
+#
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+if Gem.win_platform? then
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter
+  ]
+  SimpleCov.start do
+    add_filter "/test/"
+    add_filter "/features/"
+  end
+else
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+    [SimpleCov::Formatter::HTMLFormatter]
+  )
+  SimpleCov.start do
+    add_filter "/test/"
+    add_filter "/features/"
+#    minimum_coverage 30
+  end
+end

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.3.3
+cache: bundler
+branches:
+  only:
+    - master
+install:
+  - travis_retry bundle update
+  - gem install pdd
+script:
+  - pdd -f /dev/null
+  - export RUBYOPT="-W0"
+  - rake --quiet
+after_success:
+  - "bash <(curl -s https://codecov.io/bash)"

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# 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.
+
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2018 Yegor Bugayenko
+
+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,36 @@
+<img src="http://www.zold.io/logo.svg" width="92px" height="92px"/>
+
+[![Donate via Zerocracy](https://www.0crat.com/contrib-badge/CAZPZR9FS.svg)](https://www.0crat.com/contrib/CAZPZR9FS)
+
+[![EO principles respected here](http://www.elegantobjects.org/badge.svg)](http://www.elegantobjects.org)
+[![Managed by Zerocracy](https://www.0crat.com/badge/CAZPZR9FS.svg)](https://www.0crat.com/p/CAZPZR9FS)
+[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/zold)](http://www.rultor.com/p/yegor256/zold)
+[![We recommend RubyMine](http://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
+
+[![Build Status](https://travis-ci.org/zold-io/zold-score.svg)](https://travis-ci.org/zold-io/zold-score)
+[![Build status](https://ci.appveyor.com/api/projects/status/f4ct91inx6nfb5eg?svg=true)](https://ci.appveyor.com/project/yegor256/zold-score)
+[![PDD status](http://www.0pdd.com/svg?name=zold-io/zold-score)](http://www.0pdd.com/p?name=zold-io/zold-score)
+[![Gem Version](https://badge.fury.io/rb/zold-score.svg)](http://badge.fury.io/rb/zold-score)
+[![Test Coverage](https://img.shields.io/codecov/c/github/zold-io/zold-score.svg)](https://codecov.io/github/zold-io/zold-score?branch=master)
+
+Here is the [White Paper](https://papers.zold.io/wp.pdf).
+
+Join our [Telegram group](https://t.me/zold_io) to discuss it all live.
+
+The license is [MIT](https://github.com/zold-io/zold-score/blob/master/LICENSE.txt).
+
+This small Ruby Gem calculates the score for Zold nodes.
+
+# How to contribute
+
+Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure you build is green before you contribute
+your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```
+$ bundle update
+$ rake
+```
+
+If it's clean and you don't see any error messages, submit your pull request.

data/Rakefile

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# 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.
+
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+require 'rake/clean'
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+task default: %i[clean test rubocop copyright]
+
+require 'rake/testtask'
+desc 'Run all unit tests'
+Rake::TestTask.new(:test) do |test|
+  ENV['TEST_QUIET_LOG'] = 'true' if ARGV.include?('--quiet')
+  Rake::Cleaner.cleanup_files(['coverage'])
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.warning = false
+end
+
+require 'rdoc/task'
+desc 'Build RDoc documentation'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on all directories'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end
+
+task :copyright do
+  sh "grep -q -r '#{Date.today.strftime('%Y')}' \
+    --include '*.rb' \
+    --include '*.txt' \
+    --include 'Rakefile' \
+    ."
+end

data/appveyor.yml

@@ -0,0 +1,38 @@
+version: '{build}'
+skip_tags: true
+clone_depth: 10
+branches:
+  only:
+    - master
+  except:
+    - gh-pages
+os: Windows Server 2012
+environment:
+  matrix:
+    - ruby_version: "23-x64"
+    - ruby_version: "24-x64"
+    - ruby_version: "25-x64"
+install:
+  - ps: |
+      $Env:PATH = "C:\Ruby${Env:ruby_version}\bin;${Env:PATH}"
+      if ($Env:ruby_version -match "^23" ) {
+        # RubyInstaller; download OpenSSL headers from OpenKnapsack Project
+        $Env:openssl_dir = "C:\Ruby${Env:ruby_version}"
+        appveyor DownloadFile http://dl.bintray.com/oneclick/OpenKnapsack/x64/openssl-1.0.2j-x64-windows.tar.lzma
+        7z e openssl-1.0.2j-x64-windows.tar.lzma
+        7z x -y -oC:\Ruby${Env:ruby_version} openssl-1.0.2j-x64-windows.tar
+      } else {
+        # RubyInstaller2; openssl package seems to be installed already
+        $Env:openssl_dir = "C:\msys64\mingw64"
+      }
+  - bundle config --local path vendor/bundle
+  - bundle config build.openssl --with-openssl-dir=%openssl_dir%
+  - ruby -v
+  - bundle -v
+build_script:
+  - bundle update
+  - bundle install
+test_script:
+  - bundle exec rake --quiet
+cache:
+  - vendor/bundle

data/lib/zold/score.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'openssl'
+require 'time'
+
+# Zold score.
+#
+# To calculate a score you first have to create a zero score and then
+# call its <tt>next()</tt> method:
+#
+#  first = Score.new(host: 'example.org', invoice: 'PREFIX@0000000000000000')
+#  second = first.next
+#
+# More information about the algorithm you can find in the
+# {White Paper}[https://papers.zold.io/wp.pdf].
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+module Zold
+  # Score
+  class Score
+    # Default strength for the entire system, in production mode.
+    STRENGTH = 6
+
+    attr_reader :time, :host, :port, :invoice, :suffixes, :strength, :created
+
+    def initialize(time: Time.now, host:, port: 4096, invoice:, suffixes: [],
+      strength: Score::STRENGTH, created: Time.now)
+      @time = time
+      @host = host
+      @port = port
+      @invoice = invoice
+      @suffixes = suffixes
+      @strength = strength
+      @created = created
+    end
+
+    # The default no-value score.
+    ZERO = Score.new(time: Time.now, host: 'localhost', invoice: 'NOPREFIX@ffffffffffffffff')
+
+    # Parses it back from the JSON.
+    def self.parse_json(json)
+      raise "Time in JSON is broken: #{json}" unless json['time'] =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$/
+      raise "Host is wrong: #{json}" unless json['host'] =~ /^[0-9a-z\.\-]+$/
+      raise "Port is wrong: #{json}" unless json['port'].is_a?(Integer)
+      raise "Invoice is wrong: #{json}" unless json['invoice'] =~ /^[a-zA-Z0-9]{8,32}@[a-f0-9]{16}$/
+      raise "Suffixes not array: #{json}" unless json['suffixes'].is_a?(Array)
+      Score.new(
+        time: Time.parse(json['time']), host: json['host'],
+        port: json['port'], invoice: json['invoice'], suffixes: json['suffixes'],
+        strength: json['strength']
+      )
+    end
+
+    # Parses it back from the text generated by <tt>to_s</tt>.
+    def self.parse(text)
+      re = Regexp.new(
+        '^' + [
+          '([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]+)',
+          ' (?<invoice>[a-zA-Z0-9]{8,32}@[a-f0-9]{16})',
+          '(?<suffixes>( [a-zA-Z0-9]+)*)'
+        ].join + '$'
+      )
+      m = re.match(text.strip)
+      raise "Invalid score '#{text}', doesn't match: #{re}" if m.nil?
+      Score.new(
+        time: Time.parse(m[:time]), host: m[:host],
+        port: m[:port].to_i, invoice: m[:invoice],
+        suffixes: m[:suffixes].split(' '),
+        strength: m[:strength].to_i
+      )
+    end
+
+    # Parses it back from the text generated by <tt>to_text</tt>.
+    def self.parse_text(text)
+      parts = text.split(' ', 7)
+      Score.new(
+        time: Time.at(parts[1].hex),
+        host: parts[2],
+        port: parts[3].hex,
+        invoice: "#{parts[4]}@#{parts[5]}",
+        suffixes: parts[6] ? parts[6].split(' ') : [],
+        strength: parts[0].to_i
+      )
+    end
+
+    # Returns its crypto hash. Read the White Paper for more information.
+    def hash
+      raise 'Score has zero value, there is no hash' if @suffixes.empty?
+      @suffixes.reduce(prefix) do |pfx, suffix|
+        OpenSSL::Digest::SHA256.new("#{pfx} #{suffix}").hexdigest
+      end
+    end
+
+    # A simple mnemo of the score.
+    def to_mnemo
+      "#{value}:#{@time.strftime('%H%M')}"
+    end
+
+    # Converts it to a text, which is console friendly. You can parse it back
+    # using <tt>parse_text()</tt>.
+    def to_text
+      pfx, bnf = @invoice.split('@')
+      [
+        @strength,
+        @time.to_i.to_s(16),
+        @host,
+        @port.to_s(16),
+        pfx,
+        bnf,
+        @suffixes.join(' ')
+      ].join(' ')
+    end
+
+    # Converts it to a string. You can parse it back
+    # using <tt>parse()</tt>.
+    def to_s
+      [
+        "#{value}/#{@strength}:",
+        @time.utc.iso8601,
+        @host,
+        @port,
+        @invoice,
+        @suffixes.join(' ')
+      ].join(' ').strip
+    end
+
+    # Converts the score to a hash, which can be used for JSON presentation
+    # of the score.
+    def to_h
+      {
+        value: value,
+        host: @host,
+        port: @port,
+        invoice: @invoice,
+        time: @time.utc.iso8601,
+        suffixes: @suffixes,
+        strength: @strength,
+        hash: value.zero? ? nil : hash,
+        expired: expired?,
+        valid: valid?,
+        age: (age / 60).round,
+        created: @created.utc.iso8601
+      }
+    end
+
+    # Returns a new score, which is a copy of the current one, but the amount
+    # of hash suffixes is reduced to the <tt>max</tt> provided.
+    def reduced(max = 4)
+      raise "Max can't be negative: #{max}" if max.negative?
+      Score.new(
+        time: @time, host: @host, port: @port, invoice: @invoice,
+        suffixes: @suffixes[0..[max, suffixes.count].min - 1],
+        strength: @strength
+      )
+    end
+
+    # Calculates and returns the next score after the current one. This
+    # operation may take some time, from a few milliseconds to hours, depending
+    # on the CPU power and the <tt>strength</tt> of the current score.
+    def next
+      raise 'This score is not valid' unless valid?
+      idx = 0
+      loop do
+        suffix = idx.to_s(16)
+        score = Score.new(
+          time: @time, host: @host, port: @port,
+          invoice: @invoice, suffixes: @suffixes + [suffix],
+          strength: @strength
+        )
+        return score if score.valid?
+        if score.expired?
+          return Score.new(
+            time: Time.now, host: @host, port: @port, invoice: @invoice,
+            suffixes: [], strength: @strength
+          )
+        end
+        idx += 1
+      end
+    end
+
+    # The age of the score in seconds.
+    def age
+      Time.now - @time
+    end
+
+    # Returns TRUE if the age of the score is over 24 hours.
+    def expired?(hours = 24)
+      age > hours * 60 * 60
+    end
+
+    # The prefix for the hash calculating algorithm. See the White Paper
+    # for more details.
+    def prefix
+      "#{@time.utc.iso8601} #{@host} #{@port} #{@invoice}"
+    end
+
+    # Returns TRUE if the score is valid: all its suffixes correctly consistute
+    # the hash, according to the algorithm explained in the White Paper.
+    def valid?
+      @suffixes.empty? || hash.end_with?('0' * @strength)
+    end
+
+    # Returns the value of the score, from zero and up. The value is basically
+    # the amount of hash suffixes inside the score.
+    def value
+      @suffixes.length
+    end
+
+    # Returns TRUE if the value of the score is zero.
+    def zero?
+      @suffixes.empty?
+    end
+  end
+end

data/test/zold/test_score.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'minitest/autorun'
+require 'tmpdir'
+require 'time'
+require_relative '../../lib/zold/score'
+
+# Score test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class TestScore < Minitest::Test
+  def test_reduces_itself
+    score = Zold::Score.new(
+      time: Time.parse('2017-07-19T21:24:51Z'),
+      host: 'localhost', port: 443, invoice: 'NOPREFIX@ffffffffffffffff',
+      suffixes: %w[A B C D E F G]
+    ).reduced(2)
+    assert_equal(2, score.value)
+    assert_equal(64, score.hash.length)
+  end
+
+  def test_drops_to_zero_when_expired
+    score = Zold::Score.new(
+      time: Time.now - 24 * 60 * 60,
+      host: 'some-host', port: 9999, invoice: 'NOPREFIX@ffffffffffffffff',
+      strength: 50
+    ).next
+    assert(score.valid?)
+    assert(!score.expired?)
+    assert_equal(0, score.value)
+  end
+
+  def test_validates_wrong_score
+    score = Zold::Score.new(
+      time: Time.parse('2017-07-19T21:24:51Z'),
+      host: 'localhost', port: 443, invoice: 'NOPREFIX@ffffffffffffffff',
+      suffixes: %w[xxx yyy zzz]
+    )
+    assert_equal(3, score.value)
+    assert(!score.valid?)
+  end
+
+  def test_prints_mnemo
+    score = Zold::Score.new(
+      time: Time.parse('2017-07-19T22:32:51Z'),
+      host: 'localhost', port: 443, invoice: 'NOPREFIX@ffffffffffffffff'
+    )
+    assert_equal('0:2232', score.to_mnemo)
+  end
+
+  def test_prints_and_parses
+    time = Time.now
+    score = Zold::Score.parse(
+      Zold::Score.new(
+        time: time, host: 'localhost', port: 999, invoice: 'NOPREFIX@ffffffffffffffff',
+        strength: 1
+      ).next.next.to_s
+    )
+    assert_equal(2, score.value)
+    assert_equal(score.time.to_s, time.to_s)
+    assert_equal('localhost', score.host)
+    assert_equal(999, score.port)
+  end
+
+  def test_prints_and_parses_text
+    time = Time.now
+    score = Zold::Score.parse_text(
+      Zold::Score.new(
+        time: time, host: 'a.example.com', port: 999, invoice: 'NOPREFIX@ffffffffffffffff',
+        strength: 1
+      ).next.next.next.to_text
+    )
+    assert_equal(3, score.value)
+    assert_equal(score.time.utc.to_s, time.utc.to_s)
+    assert_equal('a.example.com', score.host)
+    assert_equal(999, score.port)
+  end
+
+  def test_prints_and_parses_text_zero_score
+    time = Time.now
+    score = Zold::Score.parse_text(
+      Zold::Score.new(
+        time: time, host: '192.168.0.1', port: 1, invoice: 'NOPREFIX@ffffffffffffffff', suffixes: []
+      ).to_text
+    )
+    assert_equal(0, score.value)
+    assert(!score.expired?)
+  end
+
+  def test_prints_and_parses_zero_score
+    time = Time.now
+    score = Zold::Score.parse(
+      Zold::Score.new(
+        time: time, host: '192.168.0.1', port: 1, invoice: 'NOPREFIX@ffffffffffffffff', suffixes: []
+      ).to_s
+    )
+    assert_equal(0, score.value)
+    assert(!score.expired?)
+  end
+
+  def test_finds_next_score
+    score = Zold::Score.new(
+      time: Time.now, host: 'localhost', port: 443,
+      invoice: 'NOPREFIX@ffffffffffffffff', strength: 2
+    ).next.next.next
+    assert_equal(3, score.value)
+    assert(score.valid?)
+    assert(!score.expired?)
+  end
+
+  def test_dont_expire_correctly
+    score = Zold::Score.new(
+      time: Time.now - 10 * 60 * 60, host: 'localhost', port: 443,
+      invoice: 'NOPREFIX@ffffffffffffffff', strength: 2
+    ).next.next.next
+    assert(!score.expired?)
+  end
+
+  def test_correct_number_of_zeroes
+    score = Zold::Score.new(
+      time: Time.now, host: 'localhost', port: 443,
+      invoice: 'NOPREFIX@ffffffffffffffff', strength: 3
+    ).next
+    assert(score.hash.end_with?('000'))
+  end
+
+  def test_generates_hash_correctly
+    score = Zold::Score.new(
+      time: Time.parse('2018-06-27T06:22:41Z'), host: 'b2.zold.io', port: 4096,
+      invoice: 'THdonv1E@abcdabcdabcdabcd', suffixes: ['3a934b']
+    )
+    assert_equal('c9c72efbf6beeea13408c5e720ec42aec017c11c3db335e05595c03755000000', score.hash)
+    score = Zold::Score.new(
+      time: Time.parse('2018-06-27T06:22:41Z'), host: 'b2.zold.io', port: 4096,
+      invoice: 'THdonv1E@abcdabcdabcdabcd', suffixes: %w[3a934b 1421217]
+    )
+    assert_equal('e04ab4e69f86aa17be1316a52148e7bc3187c6d3df581d885a862d8850000000', score.hash)
+  end
+end

data/zold-score.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# 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.
+
+require 'English'
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '2.2'
+  s.required_ruby_version = '>=2.3'
+  s.name = 'zold-score'
+  s.version = '0.1.0'
+  s.license = 'MIT'
+  s.summary = 'Zold score'
+  s.description = 'Score calculating Ruby Gem for Zold'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'http://github.com/zold-io/zold-score'
+  s.files = `git ls-files`.split($RS)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|features)/})
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
+  s.add_development_dependency 'codecov', '~>0'
+  s.add_development_dependency 'minitest', '~>5'
+  s.add_development_dependency 'rdoc', '~>4'
+  s.add_development_dependency 'rspec-rails', '~>3'
+  s.add_development_dependency 'rubocop', '0.58.1'
+  s.add_development_dependency 'rubocop-rspec', '~>1'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: zold-score
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yegor Bugayenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Score calculating Ruby Gem for Zold
+email: yegor256@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".0pdd.yml"
+- ".gitattributes"
+- ".gitignore"
+- ".pdd"
+- ".rubocop.yml"
+- ".rultor.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appveyor.yml
+- lib/zold/score.rb
+- test/zold/test_score.rb
+- zold-score.gemspec
+homepage: http://github.com/zold-io/zold-score
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 2
+summary: Zold score
+test_files:
+- test/zold/test_score.rb