zold 0.14.8 → 0.14.9

data/lib/zold/score.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -21,6 +23,7 @@
 require 'openssl'
 require 'time'
 require_relative 'remotes'
+require_relative 'type'
 
 # The score.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -28,29 +31,24 @@ require_relative 'remotes'
 # License:: MIT
 module Zold
   # Score
-  class Score
+  class Score < Dry::Struct
     # Default strength for the entire system, in production mode.
     STRENGTH = 6
 
-    attr_reader :time, :host, :port, :invoice, :strength
-    # time: UTC ISO 8601 string
-    def initialize(time, host, port, invoice, suffixes = [], strength: STRENGTH)
-      raise "Invalid host name: #{host}" unless host =~ /^[a-z0-9\.-]+$/
-      raise 'Time must be of type Time' unless time.is_a?(Time)
-      raise 'Port must be of type Integer' unless port.is_a?(Integer)
-      raise "Invalid TCP port: #{port}" if port <= 0 || port > 65_535
-      raise "Invoice '#{invoice}' has wrong format" unless invoice =~ /^[a-zA-Z0-9]{8,32}@[a-f0-9]{16}$/
-      @time = time
-      @host = host
-      @port = port
-      @invoice = invoice
-      @suffixes = suffixes
-      @strength = strength
-      @created = Time.now
-    end
+    attribute :time, Types::Strict::Time
+    attribute :host, Types::Strict::String.constrained(
+      format: /^[a-z0-9\.-]+$/
+    )
+    attribute :port, Types::Strict::Integer.constrained(gteq: 0, lt: 65_535)
+    attribute :invoice, Types::Strict::String.constrained(
+      format: /^[a-zA-Z0-9]{8,32}@[a-f0-9]{16}$/
+    )
+    attribute :suffixes, Types::Strict::Array.optional.default([])
+    attribute :strength, Types::Strict::Integer.optional.default(STRENGTH)
+    attribute :created, Types::Strict::Time.optional.default(Time.now)
 
     # The default no-value score.
-    ZERO = Score.new(Time.now, 'localhost', 80, 'NOPREFIX@ffffffffffffffff')
+    ZERO = Score.new(time: Time.now, host: 'localhost', port: 80, invoice: 'NOPREFIX@ffffffffffffffff')
 
     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$/
@@ -59,8 +57,8 @@ module Zold
       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.parse(json['time']), json['host'],
-        json['port'], json['invoice'], json['suffixes'],
+        time: Time.parse(json['time']), host: json['host'],
+        port: json['port'], invoice: json['invoice'], suffixes: json['suffixes'],
         strength: json['strength']
       )
     end
@@ -79,9 +77,9 @@ module Zold
       m = re.match(text.strip)
       raise "Invalid score '#{text}', doesn't match: #{re}" if m.nil?
       Score.new(
-        Time.parse(m[:time]), m[:host],
-        m[:port].to_i, m[:invoice],
-        m[:suffixes].split(' '),
+        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
@@ -89,71 +87,71 @@ module Zold
     def self.parse_text(text)
       parts = text.split(' ', 7)
       Score.new(
-        Time.at(parts[1].hex),
-        parts[2],
-        parts[3].hex,
-        "#{parts[4]}@#{parts[5]}",
-        parts[6] ? parts[6].split(' ') : [],
+        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
 
     def hash
-      raise 'Score has zero value, there is no hash' if @suffixes.empty?
-      @suffixes.reduce(prefix) do |pfx, suffix|
+      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
 
     def to_mnemo
-      "#{value}:#{@time.strftime('%H%M')}"
+      "#{value}:#{time.strftime('%H%M')}"
     end
 
     def to_text
-      pfx, bnf = @invoice.split('@')
+      pfx, bnf = invoice.split('@')
       [
-        @strength,
-        @time.to_i.to_s(16),
-        @host,
-        @port.to_s(16),
+        strength,
+        time.to_i.to_s(16),
+        host,
+        port.to_s(16),
         pfx,
         bnf,
-        @suffixes.join(' ')
+        suffixes.join(' ')
       ].join(' ')
     end
 
     def to_s
       [
-        "#{value}/#{@strength}:",
-        @time.utc.iso8601,
-        @host,
-        @port,
-        @invoice,
-        @suffixes.join(' ')
+        "#{value}/#{strength}:",
+        time.utc.iso8601,
+        host,
+        port,
+        invoice,
+        suffixes.join(' ')
       ].join(' ')
     end
 
     def to_h
       {
         value: value,
-        host: @host,
-        port: @port,
-        invoice: @invoice,
-        time: @time.utc.iso8601,
-        suffixes: @suffixes,
-        strength: @strength,
+        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
+        created: created.utc.iso8601
       }
     end
 
     def reduced(max = 4)
       Score.new(
-        @time, @host, @port, @invoice,
-        @suffixes[0..[max, @suffixes.count].min - 1], strength: @strength
+        time: time, host: host, port: port, invoice: invoice,
+        suffixes: suffixes[0..[max, suffixes.count].min - 1], strength: strength, created: nil
       )
     end
 
@@ -163,17 +161,22 @@ module Zold
       loop do
         suffix = idx.to_s(16)
         score = Score.new(
-          @time, @host, @port, @invoice, @suffixes + [suffix],
-          strength: @strength
+          time: time, host: host, port: port, invoice: invoice, suffixes: suffixes + [suffix],
+          strength: strength
         )
         return score if score.valid?
-        return Score.new(Time.now, @host, @port, @invoice, [], strength: @strength) if score.expired?
+        if score.expired?
+          return Score.new(
+            time: Time.now, host: host, port: port, invoice: invoice,
+            suffixes: [], strength: strength
+          )
+        end
         idx += 1
       end
     end
 
     def age
-      Time.now - @time
+      Time.now - time
     end
 
     def expired?(hours = 24)
@@ -181,15 +184,15 @@ module Zold
     end
 
     def prefix
-      "#{@time.utc.iso8601} #{@host} #{@port} #{@invoice}"
+      "#{time.utc.iso8601} #{host} #{port} #{invoice}"
     end
 
     def valid?
-      @suffixes.empty? || hash.end_with?('0' * @strength)
+      suffixes.empty? || hash.end_with?('0' * strength)
     end
 
     def value
-      @suffixes.length
+      suffixes.length
     end
 
     def zero?

data/lib/zold/signature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/zold/tax.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -49,7 +51,7 @@ module Zold
     DAYS_INCREMENT = 32
 
     # Text prefix for taxes details
-    PREFIX = 'TAXES'.freeze
+    PREFIX = 'TAXES'
 
     def initialize(wallet)
       @wallet = wallet

data/lib/zold/txn.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -33,10 +35,10 @@ module Zold
   # A single transaction
   class Txn
     # Regular expression for details
-    RE_DETAILS = '[a-zA-Z0-9 @\!\?\*_\-\.:,\']+'.freeze
+    RE_DETAILS = '[a-zA-Z0-9 @\!\?\*_\-\.:,\']+'
 
     # Regular expression for prefix
-    RE_PREFIX = '[a-zA-Z0-9]+'.freeze
+    RE_PREFIX = '[a-zA-Z0-9]+'
 
     attr_reader :id, :date, :amount, :prefix, :bnf, :details, :sign
     attr_writer :sign, :amount, :bnf

data/lib/zold/type.rb

@@ -0,0 +1,36 @@
+# 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.
+
+# @todo #98:30m/DEV Right now only Score and Http classes have been refactored for using
+#  dry-types, even tough the issue has been boosted refactoring the whole project
+#  is very cumbersome. Please refer to Score and Http class on how to perform all
+#  the changes for the project to adopt dry-types
+require 'dry-types'
+require 'dry-struct'
+
+# HTTP page.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+module Types
+  include Dry::Types.module
+end

data/lib/zold/upgrades.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,10 +31,6 @@ module Zold
       @log = log
     end
 
-    # @todo #285:30min Write the upgrade manager tests that ensure:
-    #  - Nothing breaks without the version file.
-    #  - The upgrade scripts run when there is a version file and there are pending upgrade scripts.
-    #  - Make sure *only* the correct upgrade scripts run.
     def run
       Dir.glob("#{@directory}/*.rb").select { |f| f =~ /^(\d+)\.rb$/ }.sort.each do |script|
         @version.apply(script)

data/lib/zold/verbose_thread.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/zold/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -23,6 +25,6 @@
 # Copyright:: Copyright (c) 2018 Yegor Bugayenko
 # License:: MIT
 module Zold
-  VERSION  = '0.14.8'.freeze
-  PROTOCOL = 2
+  VERSION  = '0.14.9'
+  PROTOCOL = 1
 end

data/lib/zold/version_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/zold/wallet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -43,10 +45,10 @@ module Zold
   class Wallet
     # The name of the main production network. All other networks
     # must have different names.
-    MAIN_NETWORK = 'zold'.freeze
+    MAIN_NETWORK = 'zold'
 
     # The extension of the wallet files
-    EXTENSION = '.z'.freeze
+    EXTENSION = '.z'
 
     def initialize(file)
       @file = file

data/lib/zold/wallets.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2018 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/test/commands/routines/test_bonuses.rb

@@ -0,0 +1,76 @@
+# 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 'webmock/minitest'
+require_relative '../../test__helper'
+require_relative '../../fake_home'
+require_relative '../../node/fake_node'
+require_relative '../../../lib/zold/node/farm.rb'
+require_relative '../../../lib/zold/commands/push'
+require_relative '../../../lib/zold/commands/pay'
+require_relative '../../../lib/zold/commands/routines/bonuses.rb'
+
+# Bonuses test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class TestBonuses < Minitest::Test
+  def test_pays_bonuses
+    FakeHome.new.run do |home|
+      FakeNode.new(log: test_log).run(['--ignore-score-weakness']) do |port|
+        bank = home.create_wallet
+        Zold::Pay.new(wallets: home.wallets, remotes: home.remotes, log: test_log).run(
+          ['pay', home.create_wallet.id.to_s, bank.id.to_s, '100', '--force', '--private-key=id_rsa']
+        )
+        assert_equal(Zold::Amount.new(zld: 100.0), bank.balance)
+        opts = {
+          'ignore-score-weakness' => true,
+          'routine-immediately' => true,
+          'private-key' => 'id_rsa',
+          'bonus-wallet' => bank.id.to_s,
+          'bonus-amount' => 1,
+          'bonus-time' => 0
+        }
+        score = Zold::Score.new(
+          time: Time.now, host: 'fake-node.local', port: 999, invoice: 'NOPREFIX@ffffffffffffffff', strength: 1
+        )
+        16.times { score = score.next }
+        remotes = home.remotes
+        remotes.add('localhost', port)
+        remotes.add(score.host, score.port)
+        stub_request(:get, "http://#{score.host}:#{score.port}/").to_return(
+          status: 200,
+          body: {
+            version: Zold::VERSION,
+            score: score.to_h
+          }.to_json
+        )
+        Zold::Routines::Bonuses.new(
+          opts, home.wallets, remotes, home.copies(bank).root,
+          Zold::Farm::Empty.new, log: test_log
+        ).exec
+        assert_equal(Zold::Amount.new(zld: 99.0), bank.balance)
+      end
+    end
+  end
+end