ruby-client 1.1.5 → 1.2.3

data/spec/client_spec.rb

@@ -0,0 +1,304 @@
+=begin
+  Copyright 2020 Nimiq community.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "ruby-client"
+
+describe "Nimiq", type: :request do
+
+  # Initialize
+  before(:all) do
+    options = {
+      #   host: "https://rpc.nimiq.observer/",
+      #   port: 433,
+
+      host: "localhost",
+      port: 8005,
+      user: "user",
+      pass: "pass",
+    # dev: true,
+    }
+    @main_addr = "NQ70 46LN 1SKC KGFN VV8U G92N XC4X 9VFB SBVJ" # Node address
+    @seco_addr = "NQ27 B9ED 98G5 3VH7 FY8D BFP0 XNF4 BD8L TN4B" # Some address
+    @signed_transaction = "000000.......1A84FA23" # get this by running Makes @signed_transaction
+    @nimiq = Nimiq::Client.new(options)
+  end
+
+  # Test suite for client
+  describe "RPC Client" do
+
+    # Test suite for client version
+    it "Must have a version." do
+      expect(::Nimiq::VERSION).not_to eq(nil)
+    end
+
+    # Test suite for client connection
+    it "Must be able to connect to the Nimiq node." do
+      expect(@nimiq.ping).to eq(200)
+    end
+
+    # Test suite for client to send raw requests
+    it "Must be able to send raw requests." do
+      expect(@nimiq.request("consensus")).to be_a_kind_of(String)
+    end
+  end
+
+  # Test suite for API
+  describe "Api" do
+
+    # Test suite for client to retrieve the addresses owned by client.
+    it "Must be able to retrieve addresses owned by client." do
+      expect(@nimiq.accounts()).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve height of most recent block.
+    it "Must be able to retrieve height of most recent block." do
+      expect(@nimiq.block_number()).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve the consensus status.
+    it "Must be able to retrieve the consensus status." do
+      expect(@nimiq.consensus()).to be_a_kind_of(String)
+    end
+
+    # Test suite for client to override a constant value.
+    it "Must be able to override a constant value." do
+      constant_value = 10
+      expect(@nimiq.constant("BaseConsensus.MAX_ATTEMPTS_TO_FETCH", constant_value)).to eq(constant_value)
+    end
+
+    # Test suite for client to retrieve a constant value.
+    it "Must be able to retrieve a constant value." do
+      expect(@nimiq.constant("BaseConsensus.MAX_ATTEMPTS_TO_FETCH")).to eq(10)
+    end
+
+    # Test suite for client to create a new account.
+    it "Must be able to create a new account." do
+      expect(@nimiq.create_account()).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve information related to an account.
+    it "Must be able to retrieve information related to an account." do
+      expect(@nimiq.get_account(@seco_addr)).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve balance of account.
+    it "Must be able to retrieve balance of account." do
+      expect(@nimiq.get_balance(@main_addr)).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to retrieve block by hash.
+    it "Must be able to retrieve block by hash." do
+      expect(@nimiq.get_block_by_hash("14c91f6d6f3a0b62271e546bb09461231ab7e4d1ddc2c3e1b93de52d48a1da87", false)).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve block by hash, full transactions included.
+    it "Must be able to retrieve block by hash, full transactions included." do
+      expect(@nimiq.get_block_by_hash("14c91f6d6f3a0b62271e546bb09461231ab7e4d1ddc2c3e1b93de52d48a1da87", true)).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve block by number.
+    it "Must be able to retrieve block by number." do
+      expect(@nimiq.get_block_by_number(76415, false)).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve block by number, full transactions included.
+    it "Must be able to retrieve block by number, full transactions included." do
+      expect(@nimiq.get_block_by_number(76415, true)).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve block template.
+    it "Must be able to retrieve block template." do
+      expect(@nimiq.get_block_template()).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve the number of transactions in a block by block hash.
+    it "Must be able to retrieve the number of transactions in a block by block hash." do
+      expect(@nimiq.get_block_transaction_count_by_hash("dfe7d166f2c86bd10fa4b1f29cd06c13228f893167ce9826137c85758645572f")).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to retrieve the number of transactions in a block by block number.
+    it "Must be able to retrieve the number of transactions in a block by block number." do
+      expect(@nimiq.get_block_transaction_count_by_number(76415)).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to retrieve information about a transaction by block hash and transaction index position.
+    it "Must be able to retrieve information about a transaction by block hash and transaction index position." do
+      expect(@nimiq.get_transaction_by_block_hash_and_index("dfe7d166f2c86bd10fa4b1f29cd06c13228f893167ce9826137c85758645572f", 20)).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve information about a transaction by block number and transaction index position.
+    it "Must be able to retrieve information about a transaction by block number and transaction index position." do
+      expect(@nimiq.get_transaction_by_block_number_and_index(76415, 20)).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve the information about a transaction requested by transaction hash.
+    it "Must be able to retrieve the information about a transaction requested by transaction hash." do
+      expect(@nimiq.get_transaction_by_hash("465a63b73aa0b9b54b777be9a585ea00b367a17898ad520e1f22cb2c986ff554")).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve the receipt of a transaction by transaction hash.
+    it "Must be able to retrieve the receipt of a transaction by transaction hash." do
+      expect(@nimiq.get_transaction_receipt("465a63b73aa0b9b54b777be9a585ea00b367a17898ad520e1f22cb2c986ff554")).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve the latest transactions successfully performed by or for an address.
+    it "Must be able to retrieve the latest transactions successfully performed by or for an address." do
+      expect(@nimiq.get_transactions_by_address("NQ699A4AMB83HXDQ4J46BH5R4JFFQMA9C3GN", 100)).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve instructions to mine the next block.
+    it "Must be able to retrieve instructions to mine the next block." do
+      expect(@nimiq.get_work()).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve the number of hashes per second that the node is mining with.
+    it "Must be able to retrieve the number of hashes per second that the node is mining with." do
+      expect(@nimiq.hashrate()).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to set the log level of the node.
+    it "Must be able to set the log level of the node." do
+      expect(@nimiq.log("BaseConsensus", "debug")).to be(true).or be(false)
+    end
+
+    # Test suite for client to retrieve information on the current mempool situation.
+    it "Must be able to retrieve information on the current mempool situation." do
+      expect(@nimiq.mempool()).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve transactions that are currently in the mempool.
+    it "Must be able to retrieve transactions that are currently in the mempool." do
+      expect(@nimiq.mempool_content()).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve miner address.
+    it "Must be able to retrieve miner address." do
+      expect(@nimiq.miner_address()).to be_a_kind_of(String)
+    end
+
+    # Test suite for client to set the number of CPU threads for the miner.
+    it "Must be able to set the number of CPU threads for the miner." do
+      expect(@nimiq.miner_threads(2)).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to retrieve the number of CPU threads for the miner.
+    it "Must be able to retrieve the number of CPU threads for the miner." do
+      expect(@nimiq.miner_threads()).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to set the minimum fee per byte.
+    it "Must be able to set the minimum fee per byte." do
+      expect(@nimiq.min_fee_per_byte(1)).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to retrieve the minimum fee per byte.
+    it "Must be able to retrieve the minimum fee per byte." do
+      expect(@nimiq.min_fee_per_byte()).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to retrieve if client is actively mining new blocks.
+    it "Must be able to retrieve if client is actively mining new blocks." do
+      expect(@nimiq.mining()).to be(true).or be(false)
+    end
+
+    # Test suite for client to retrieve the number of peers currently connected to the client.
+    it "Must be able to retrieve the number of peers currently connected to the client." do
+      expect(@nimiq.peer_count()).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to retrieve the list of peers known to the client.
+    it "Must be able to retrieve the list of peers known to the client." do
+      expect(@nimiq.peer_list()).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve the state of the peer.
+    it "Must be able to retrieve the state of the peer." do
+      expect(@nimiq.peer_state("wss://seed-1.nimiq.com:8443/dfd55fe967d6c0ca707d3a73ec31e4ac")).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to set the mining pool.
+    it "Must be able to set the mining pool." do
+      expect(@nimiq.pool("eu.nimpool.io:8444")).to be_a_kind_of(String).or be(nil)
+    end
+
+    # Test suite for client to retrieve the mining pool.
+    it "Must be able to retrieve the mining pool." do
+      expect(@nimiq.pool()).to be_a_kind_of(String).or be(nil)
+    end
+
+    # Test suite for client to retrieve the confirmed mining pool balance.
+    it "Must be able to retrieve the confirmed mining pool balance." do
+      expect(@nimiq.pool_confirmed_balance()).to be_a_kind_of(Integer)
+    end
+
+    # Test suite for client to retrieve the connection state to mining pool.
+    it "Must be able to retrieve the connection state to mining pool." do
+      expect(@nimiq.pool_connection_state()).to be_a_kind_of(Integer)
+    end
+
+    # Makes @signed_transaction
+    # Test suite for client to create a transaction without sending it.
+    it "Must be able to create a transaction without sending it." do
+      transaction = {
+        "from": @main_addr,
+        "to": @seco_addr,
+        "value": 100,
+        "fee": 0,
+      }
+      @signed_transaction = @nimiq.create_raw_transaction(transaction)
+      expect(@signed_transaction).to be_a_kind_of(Object)
+    end
+
+    # NEW
+    # Test suite for client to retrieve a transaction information.
+    it "Must be able to retrieve a transaction information." do
+      #   expect(@nimiq.get_raw_transaction_info(@signed_transaction)).to be_a_kind_of(Object)
+      expect(@nimiq.get_raw_transaction_info("009de5aeefe9fa3b4017cbf460e863831808d121b614ae034337a69cdabbeeb4185a5cd4a2051f6277fd0d5bee0f59e45b514dd88b000000000000006400000000000000000007f8642afa9861e3dd9c708318aba517f0d40882af99579841cc78afd395927de3913b88c87990659a6c55b2ee28c073559520fe685c051f2daa7cc63ffb9caa9ac9e20f")).to be_a_kind_of(Object)
+    end
+
+    # Test suite for client to retrieve an object with data about the sync status.
+    it "Must be able to retrieve an object with data about the sync status." do
+      expect(@nimiq.syncing()[:startingBlock]).to be > 0
+    end
+
+    # # Must have at least some NIM to be able to send it to another address
+    # # Test suite for client to send a signed message call transaction or a contract creation, if the data field contains code.
+    # it "Must be able to send a signed message call transaction or a contract creation, if the data field contains code." do
+    #   expect(@nimiq.send_raw_transaction(@signed_transaction)).to be_a_kind_of(Object)
+    # end
+
+    # # Must have at least some NIM to be able to send it to another address
+    # # Test suite for client to create new message call transaction or a contract creation, if the data field contains code.
+    # it "Must be able to create new message call transaction or a contract creation, if the data field contains code." do
+    #   transaction = {
+    #     "from": @main_addr,
+    #     "to": @seco_addr,
+    #     "value": 100,
+    #     "fee": 0,
+    #   }
+    #   expect(@nimiq.send_transaction(transaction)).to be_a_kind_of(Object)
+    # end
+
+    # # Must have a valid generated block for the blockchain to accept, returns nothing if block is valid
+    # # Test suite for client to submit a block to the node.
+    # it "Must be able to submit a block to the node." do
+    #   block = "14c91f6d6f3a0b62271e546bb09461231ab7e4d1ddc2c3e1b93de52d48a1da87"
+    #   expect(@nimiq.submit_block(block)).to be("")
+    # end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.3
 platform: ruby
 authors:
 - jxdv
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -24,37 +24,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
-description: 
+description: Ruby implementation of the Nimiq RPC client specification.
 email:
 - root@localhost
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.md
-- Rakefile
 - bin/console
 - bin/setup
 - lib/api.rb
 - lib/nimiq/version.rb
-- lib/rpcclient.rb
+- lib/rpc.rb
 - lib/ruby-client.rb
-- main.rb
-- ruby-client-1.0.0.gem
-- ruby-client-1.0.1.gem
-- ruby-client-1.0.2.gem
-- ruby-client-1.0.3.gem
-- ruby-client-1.0.4.gem
-- ruby-client-1.0.5.gem
-- ruby-client-1.1.1.gem
-- ruby-client-1.1.2.gem
-- ruby-client-1.1.3.gem
-- ruby-client-1.1.4.gem
-- ruby-client.gemspec
-- rubyclient-1.0.0.gem
+- lib/types.rb
+- spec/client_spec.rb
 homepage: https://github.com/jxdv/ruby-client
 licenses:
 - Apache-2.0
@@ -80,5 +64,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Ruby implementation of the Nimiq RPC client specifications.
+summary: Ruby implementation of the Nimiq RPC client specification.
 test_files: []

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem "minitest", "~> 5.0"
-gem "rspec-rails", "~> 3.5"

data/Gemfile.lock

@@ -1,92 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ruby-client (1.0.2)
-      oj (~> 2.15)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.6)
-    crass (1.0.6)
-    diff-lcs (1.4.4)
-    erubi (1.9.0)
-    i18n (1.8.4)
-      concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    nokogiri (1.10.10-x64-mingw32)
-      mini_portile2 (~> 2.4.0)
-    oj (2.18.5)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rake (13.0.1)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (3.9.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
-
-PLATFORMS
-  x64-mingw32
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  rspec-rails (~> 3.5)
-  ruby-client!
-
-BUNDLED WITH
-   2.1.4