zold-ruby-sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5f77cfaa341fc53d966cdc048bfbb2f4a9ec4ca7c3bd5cc407413bd5460ffe2
-  data.tar.gz: 6fe60f88eae2fb341d128771a20721d63667b9e8907b0cd5acfd4444953f0f35
+  metadata.gz: ce7aea32407824fee9aaac411bc6ffaf1bbc34d4ab5c6b11d8cbf90c76b2af3b
+  data.tar.gz: 914288435490d8e465b10698890e95e45cfbd6f4a4ff6e604382fff67ba9e7ab
 SHA512:
-  metadata.gz: e706d2c9dc7c180ca92ccbaa60405055338075bc296acbd35ee706418d8c8b594ea6f262e0895c5a3e91a9b5ff9fd2ed9d88d900be7a40fb8430a1cf981990cf
-  data.tar.gz: 15f24cde6757b62815507deda97af55f12818f2cb66c8353c34c5ae72f81bbf5ad5a221d943d2d54fae243226fbb2af76f7ed8dfea9af59560177319ea308f57
+  metadata.gz: 39a715a9c6a203b6fcc7a6b80b58d70550940c287754dad1adbf6afe1ff142f8f793ddd9238d639073124c527fa682ec8733c1a3179c4eb9a1372deef3c4dca7
+  data.tar.gz: e71cf1f3c7a711eddc44b81a30d0ff2f06ba6844665d977dc825ed7297b571e6abd5e082cc25cce5288303b262ce9de0c33da6a24396c53f47fe11bcd3f96172

data/.rubocop.yml

@@ -6,6 +6,8 @@ Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Layout/EndOfLine:
   EnforcedStyle: lf
+Style/ClassAndModuleChildren:
+  Enabled: false
 Metrics/AbcSize:
   Max: 45
 Metrics/BlockLength:

data/.rultor.yml

@@ -3,10 +3,10 @@ assets:
 install: |-
   export GEM_HOME=~/.ruby
   export GEM_PATH=$GEM_HOME:$GEM_PATH
+  bundle install
 release:
   script: |-
-    bundle install
-    rake
+    bundle exec rake
     rm -rf *.gem
     sed -i "s/0\.0\.0/${tag}/g" zold-ruby-sdk.gemspec
     git add zold-ruby-sdk.gemspec
@@ -14,13 +14,10 @@ release:
     gem build zold-ruby-sdk.gemspec
     chmod 0600 ../rubygems.yml
     gem push *.gem --config-file ../rubygems.yml
-  commanders:
-  - yegor256
-architect:
-- yegor256
 merge:
-  commanders: []
   script: |-
-    bundle install
-    rake
-deploy: {}
+    bundle exec rake
+deploy:
+  script: |-
+    echo 'There is nothing to deploy'
+    exit -1

data/.travis.yml

@@ -1,20 +1,16 @@
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.3.3
-  - 2.4.5
+  - 2.6.0
 cache: bundler
 branches:
   only:
     - master
 install:
   - travis_retry bundle update
-  - gem install pdd
-  - sudo apt-get install cppcheck
+  - gem install pdd -v 0.20.5
 script:
   - pdd -f /dev/null
-  - cppcheck --enable=all --quiet --suppress=unusedFunction .
   - export RUBYOPT="-W0"
-  - rake --quiet
+  - bundle exec rake --quiet
 after_success:
   - "bash <(curl -s https://codecov.io/bash)"

data/README.md

@@ -11,19 +11,23 @@
 [![PDD status](http://www.0pdd.com/svg?name=zold-io/zold-ruby-sdk)](http://www.0pdd.com/p?name=zold-io/zold-ruby-sdk)
 [![Gem Version](https://badge.fury.io/rb/zold-ruby-sdk.svg)](http://badge.fury.io/rb/zold-ruby-sdk)
 [![Test Coverage](https://img.shields.io/codecov/c/github/zold-io/zold-ruby-sdk.svg)](https://codecov.io/github/zold-io/zold-ruby-sdk?branch=master)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/zold-io/zold-ruby-sdk/master/frames)
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/takes/blob/master/LICENSE.txt)
+[![Hits-of-Code](https://hitsofcode.com/github/zold-io/zold-score)](https://hitsofcode.com/view/github/zold-io/zold-ruby-sdk)
 
 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-ruby-sdk/blob/master/LICENSE.txt).
-
 This is a simple Ruby SDK for making payments, checking balances, and finding transactions in
 Zold wallets via [WTS](https://wts.zold.io) system.
 
+There are other languages too: [Java SDK](https://github.com/amihaiemil/zold-java-client).
+
 First, you install it:
 
-```
+```bash
 gem install zold-ruby-sdk
 ```
 
@@ -63,7 +67,7 @@ txns = wts.find(id: '123', details: /pizza/)
 
 That's it.
 
-# How to contribute
+## 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
@@ -72,7 +76,7 @@ your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2
 
 ```
 $ bundle update
-$ rake
+$ bundle exec rake
 ```
 
 If it's clean and you don't see any error messages, submit your pull request.

data/lib/zold/wts.rb

@@ -22,6 +22,7 @@
 
 require 'typhoeus'
 require 'cgi'
+require 'loog'
 require 'zold/age'
 require 'zold/amount'
 require 'zold/id'
@@ -32,168 +33,195 @@ require 'zold/txn'
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2018-2019 Yegor Bugayenko
 # License:: MIT
-module Zold
-  # WTS
-  class WTS
-    # Makes a new object of the class. The <tt>key</tt> you are supposed
-    # to obtain at this page: https://wts.zold.io/api. You will have to login
-    # and confirm your account first. Keep this key secret, to avoid
-    # information lost. However, even knowing the secret no payments can
-    # be sent without they keygap.
-    def initialize(key, log: STDOUT)
-      raise 'Key can\'t be nil' if key.nil?
-      @key = key
-      raise 'Log can\'t be nil' if log.nil?
-      @log = log
-    end
-
-    # Initiate PULL request. The server will pull your wallet form the network,
-    # and make it ready for future requests. Without this operation you won't
-    # be able to perform <tt>find()</tt> or <tt>balance()</tt> requests.
-    #
-    # The method returns the job ID, which you should wait for completion
-    # using the method <tt>wait()</tt>.
+class Zold::WTS
+  # Fake implementation.
+  class Fake
     def pull
-      start = Time.now
-      job = job_of(
-        clean(
-          Typhoeus::Request.get(
-            'https://wts.zold.io/pull',
-            headers: headers
-          )
-        )
-      )
-      debug("PULL job #{job} started in #{Zold::Age.new(start)}")
-      job
+      'job-id'
     end
 
-    # Get wallet balance.
     def balance
-      start = Time.now
-      http = clean(
-        Typhoeus::Request.get(
-          'https://wts.zold.io/balance',
-          headers: headers
-        )
-      )
-      balance = Zold::Amount.new(zents: http.body.to_i)
-      debug("Wallet balance #{balance} retrieved in #{Zold::Age.new(start)}")
-      balance
+      Zold::Amount.new(zld: 4.0)
     end
 
-    # Get wallet ID.
     def id
-      start = Time.now
-      http = clean(
-        Typhoeus::Request.get(
-          'https://wts.zold.io/id',
-          headers: headers
-        )
-      )
-      id = Zold::Id.new(http.body.to_s)
-      debug("Wallet ID #{id} retrieved in #{Zold::Age.new(start)}")
-      id
+      Zold::Id::ROOT
     end
 
-    # Initiate PAY request. The <tt>keygap</tt> is a string you get
-    # when you confirm the account. The <tt>bnf</tt> is the name of the
-    # GitHub account, the wallet ID or the invoice (up to you). The
-    # <tt>amount</tt> is the amount in ZLD, e.g. "19.99". The <tt>details</tt>
-    # is the text to add to the transaction.
-    #
-    # The method returns the job ID, which you should wait for completion
-    # using the method <tt>wait()</tt>.
-    def pay(keygap, bnf, amount, details)
-      start = Time.now
-      job = job_of(
-        clean(
-          Typhoeus::Request.post(
-            'https://wts.zold.io/do-pay',
-            headers: headers,
-            body: { keygap: keygap, bnf: bnf, amount: amount, details: details }
-          )
-        )
-      )
-      debug("PAY job #{job} started in #{Zold::Age.new(start)}")
-      job
+    def pay(_keygap, _bnf, _amount, _details)
+      'job-id'
+    end
+
+    def find(_query)
+      []
     end
 
-    # Find transactions by the criteria. All criterias are regular expressions
-    # and their summary result is concatenated by OR. For example, this request
-    # will return all transactions that have "pizza" in details OR which
-    # are coming from the root wallet:
-    #
-    #  find(details: /pizza/, bnf: '0000000000000000')
-    #
-    # The method returns an array of Zold::Txn objects.
-    def find(query)
-      start = Time.now
-      http = clean(
+    def wait(_job, time: 5 * 60)
+      raise 'Time must be positive' if time.negative?
+      'OK'
+    end
+  end
+
+  # Makes a new object of the class. The <tt>key</tt> you are supposed
+  # to obtain at this page: https://wts.zold.io/api. You will have to login
+  # and confirm your account first. Keep this key secret, to avoid
+  # information lost. However, even knowing the secret no payments can
+  # be sent without they keygap.
+  def initialize(key, log: Loog::NULL)
+    raise 'Key can\'t be nil' if key.nil?
+    @key = key
+    raise 'Log can\'t be nil' if log.nil?
+    @log = log
+  end
+
+  # Initiate PULL request. The server will pull your wallet form the network,
+  # and make it ready for future requests. Without this operation you won't
+  # be able to perform <tt>find()</tt> or <tt>balance()</tt> requests.
+  #
+  # The method returns the job ID, which you should wait for completion
+  # using the method <tt>wait()</tt>.
+  def pull
+    start = Time.now
+    job = job_of(
+      clean(
         Typhoeus::Request.get(
-          'https://wts.zold.io/find?' + query.map do |k, v|
-            "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
-          end.join('&'),
+          'https://wts.zold.io/pull',
           headers: headers
         )
       )
-      txns = http.body.split("\n").map { |t| Zold::Txn.parse(t) }
-      debug("#{txns.count} transactions found in #{Zold::Age.new(start)}")
-      txns
-    end
+    )
+    @log.debug("PULL job #{job} started in #{Zold::Age.new(start)}")
+    job
+  end
 
-    # Wait for the job to complete. If the job completes successfully, the
-    # method returns 'OK' in a few seconds (up to a few minutes). If the
-    # is some error, the exception will be raised.
-    def wait(job, time: 5 * 60)
-      start = Time.now
-      loop do
-        if Time.now - start > time
-          raise "Can't wait any longer for the job #{job} to complete"
-        end
-        http = Typhoeus::Request.get(
-          'https://wts.zold.io/job?id=' + job,
-          headers: headers
-        )
-        raise "Job #{job} not found on the server" if http.code == 404
-        raise "Unpredictable response code #{http.code}" unless http.code == 200
-        next if http.body == 'Running'
-        raise http.body unless http.body == 'OK'
-        debug("Job #{job} completed, in #{Zold::Age.new(start)}")
-        return http.body
-      end
-    end
+  # Get wallet balance.
+  def balance
+    start = Time.now
+    http = clean(
+      Typhoeus::Request.get(
+        'https://wts.zold.io/balance',
+        headers: headers
+      )
+    )
+    balance = Zold::Amount.new(zents: http.body.to_i)
+    @log.debug("The balance #{balance} retrieved in #{Zold::Age.new(start)}")
+    balance
+  end
 
-    private
+  # Get wallet ID.
+  def id
+    start = Time.now
+    http = clean(
+      Typhoeus::Request.get(
+        'https://wts.zold.io/id',
+        headers: headers
+      )
+    )
+    id = Zold::Id.new(http.body.to_s)
+    @log.debug("Wallet ID #{id} retrieved in #{Zold::Age.new(start)}")
+    id
+  end
 
-    def headers
-      {
-        'X-Zold-WTS': @key,
-        'User-Agent': 'zold-ruby-sdk'
-      }
-    end
+  # Initiate PAY request. The <tt>keygap</tt> is a string you get
+  # when you confirm the account. The <tt>bnf</tt> is the name of the
+  # GitHub account, the wallet ID or the invoice (up to you). The
+  # <tt>amount</tt> is the amount in ZLD, e.g. "19.99". The <tt>details</tt>
+  # is the text to add to the transaction.
+  #
+  # The method returns the job ID, which you should wait for completion
+  # using the method <tt>wait()</tt>.
+  def pay(keygap, bnf, amount, details)
+    start = Time.now
+    job = job_of(
+      clean(
+        Typhoeus::Request.post(
+          'https://wts.zold.io/do-pay',
+          headers: headers,
+          body: { keygap: keygap, bnf: bnf, amount: amount, details: details }
+        )
+      )
+    )
+    @log.debug("PAY job #{job} started in #{Zold::Age.new(start)}")
+    job
+  end
 
-    def job_of(http)
-      job = http.headers['X-Zold-Job']
-      raise 'Job ID is not returned, for some reason' if job.nil?
-      job
-    end
+  # Returns current USD rate of one ZLD.
+  def usd_rate
+    clean(Typhoeus::Request.get('https://wts.zold.io/usd_rate')).body.to_f
+  end
 
-    def clean(http)
-      error = http.headers['X-Zold-Error']
-      raise error unless error.nil?
-      unless http.code == 200 || http.code == 302
-        debug(http.body)
-        raise "Unexpected response code #{http.code}"
+  # Find transactions by the criteria. All criterias are regular expressions
+  # and their summary result is concatenated by OR. For example, this request
+  # will return all transactions that have "pizza" in details OR which
+  # are coming from the root wallet:
+  #
+  #  find(details: /pizza/, bnf: '0000000000000000')
+  #
+  # The method returns an array of Zold::Txn objects.
+  def find(query)
+    start = Time.now
+    http = clean(
+      Typhoeus::Request.get(
+        'https://wts.zold.io/find?' + query.map do |k, v|
+          "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+        end.join('&'),
+        headers: headers
+      )
+    )
+    txns = http.body.split("\n").map { |t| Zold::Txn.parse(t) }
+    @log.debug("#{txns.count} transactions found in #{Zold::Age.new(start)}")
+    txns
+  end
+
+  # Wait for the job to complete. If the job completes successfully, the
+  # method returns 'OK' in a few seconds (up to a few minutes). If the
+  # is some error, the exception will be raised.
+  def wait(job, time: 5 * 60)
+    start = Time.now
+    loop do
+      if Time.now - start > time
+        raise "Can't wait any longer for the job #{job} to complete"
       end
-      http
+      http = Typhoeus::Request.get(
+        'https://wts.zold.io/job?id=' + job,
+        headers: headers
+      )
+      raise "Job #{job} not found on the server" if http.code == 404
+      raise "Unpredictable response code #{http.code}" unless http.code == 200
+      if http.body == 'Running'
+        @log.debug("Job #{job} is still running, \
+#{Zold::Age.new(start)} already...")
+        sleep 1
+        next
+      end
+      raise http.body unless http.body == 'OK'
+      @log.debug("Job #{job} completed, in #{Zold::Age.new(start)}")
+      return http.body
     end
+  end
 
-    def debug(msg)
-      if @log.respond_to?(:debug)
-        @log.debug(msg)
-      elsif @log.respond_to?(:puts)
-        @log.puts(msg)
-      end
+  private
+
+  def headers
+    {
+      'X-Zold-WTS': @key,
+      'User-Agent': 'zold-ruby-sdk'
+    }
+  end
+
+  def job_of(http)
+    job = http.headers['X-Zold-Job']
+    raise 'Job ID is not returned, for some reason' if job.nil?
+    job
+  end
+
+  def clean(http)
+    error = http.headers['X-Zold-Error']
+    raise error unless error.nil?
+    unless http.code == 200 || http.code == 302
+      @log.debug(http.body)
+      raise "Unexpected response code #{http.code}"
     end
+    http
   end
 end

data/test/test__helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018-2019 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.
+
+STDOUT.sync = true
+
+require 'simplecov'
+SimpleCov.start
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+require 'minitest/autorun'

data/test/zold/test_wts.rb

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'loog'
 require 'minitest/autorun'
 require_relative '../../lib/zold/wts'
 
@@ -28,33 +29,42 @@ require_relative '../../lib/zold/wts'
 # Copyright:: Copyright (c) 2018-2019 Yegor Bugayenko
 # License:: MIT
 class TestWTS < Minitest::Test
-  KEY = '8HNxjYuEFp0....LYOWxsEaC3rQ=='
+  KEY = '0000000000000000-b416493aefae4ca487c4739050aaec15'
 
   def test_pulls
-    skip if KEY.length < 50
-    wts = Zold::WTS.new(KEY)
+    wts = Zold::WTS.new(KEY, log: Loog::VERBOSE)
     job = wts.pull
     wts.wait(job)
     assert(!job.nil?)
   end
 
   def test_finds_transactions
-    skip if KEY.length < 50
-    wts = Zold::WTS.new(KEY)
+    wts = Zold::WTS.new(KEY, log: Loog::VERBOSE)
     job = wts.pull
     wts.wait(job)
-    assert_equal(1, wts.find(details: /^for hosting$/).count)
+    assert_equal(0, wts.find(details: /^for hosting$/).count)
   end
 
   def test_retrieves_wallet_id
-    skip if KEY.length < 50
-    wts = Zold::WTS.new(KEY)
+    wts = Zold::WTS.new(KEY, log: Loog::VERBOSE)
     assert(!wts.id.nil?)
   end
 
   def test_retrieves_balance
-    skip if KEY.length < 50
-    wts = Zold::WTS.new(KEY)
+    wts = Zold::WTS.new(KEY, log: Loog::VERBOSE)
+    job = wts.pull
+    wts.wait(job)
+    assert(!wts.balance.nil?)
+  end
+
+  def test_retrieves_usd_rate
+    wts = Zold::WTS.new(KEY, log: Loog::VERBOSE)
+    rate = wts.usd_rate
+    assert(!rate.nil?)
+  end
+
+  def test_works_with_fake
+    wts = Zold::WTS::Fake.new
     job = wts.pull
     wts.wait(job)
     assert(!wts.balance.zero?)

data/zold-ruby-sdk.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.2'
   s.required_ruby_version = '>=2.5'
   s.name = 'zold-ruby-sdk'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.license = 'MIT'
   s.summary = 'Zold score'
   s.description = 'Ruby SDK for Zold online wallets management system (WTS)'
@@ -41,8 +41,9 @@ Gem::Specification.new do |s|
   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_runtime_dependency 'loog', '~>0.2'
   s.add_runtime_dependency 'typhoeus', '1.3.1'
-  s.add_runtime_dependency 'zold', '0.21.4'
+  s.add_runtime_dependency 'zold', '~>0.21'
   s.add_development_dependency 'codecov', '0.1.14'
   s.add_development_dependency 'minitest', '5.11.3'
   s.add_development_dependency 'minitest-hooks', '1.5.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: zold-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-09 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: loog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -28,16 +42,16 @@ dependencies:
   name: zold
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.4
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.4
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +185,7 @@ files:
 - README.md
 - Rakefile
 - lib/zold/wts.rb
+- test/test__helper.rb
 - test/zold/test_wts.rb
 - zold-ruby-sdk.gemspec
 homepage: http://github.com/zold-io/zold-ruby-sdk
@@ -198,4 +213,5 @@ signing_key:
 specification_version: 2
 summary: Zold score
 test_files:
+- test/test__helper.rb
 - test/zold/test_wts.rb