RecordsKeeperRubyLib 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8d8fd3853ae02d7f3ec7ee1c453837ab9d149a5f06bb063bfc2e80de90149c1c
-  data.tar.gz: 4d899180eb9ccd3e6f4ffc5ffeacb85fdb858e302ed10da9cf95f64e53a6bd98
+SHA1:
+  metadata.gz: d324ac6751d6dca6221d87cc8ba6def45563226e
+  data.tar.gz: 9b6277d16371801e4f1be36795b47085d782fdaf
 SHA512:
-  metadata.gz: 0fc4ab5b4f29de5102f1625d4fd7a37efbf4db20fc664743a1c530bed066388d62d7ac3897cee5405fa1626a8d2b3daa71a8d000b1088b9164c32c0f2b1736bb
-  data.tar.gz: a518c458f9bdd1246fd42f781b1f57987818a85364ab6019b80a4dfbdd177c39a2ec89d7213dc18faf629a896522909b86b3e10c08b6231572b3a83ab1bf25dc
+  metadata.gz: cec03224ca43aec072128a23dce1812a24ea2611ae87c74367f60cca388aa7d80a8bc436b26be0e2e72654aeb9544990e5de32ef260e2d9a019ca1453912186c
+  data.tar.gz: 3e631c9d26741cb4be3f49e3d0a89f0b2bab081f42827b3bb8ca561017789e18405f56a8886da590ce803ea92eecd248b350369e77fc9d324cb63dbd23666be7

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
-config.yaml
+
 # rspec failure tracking
 .rspec_status
+

data/CODE_OF_CONDUCT.md

@@ -64,11 +64,3 @@ Further details of specific enforcement policies may be posted separately.
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -7,6 +7,5 @@ gem "hex_string", " 1.0.1"
 gem "binary_parser", " 1.3.0"
 gem "json", " 2.1.0"
 gem "test-unit", "3.2.8"
-gem "rspec-rails", "3.7.2"
 
 gemspec

data/Gemfile.lock

@@ -1,71 +1,24 @@
 PATH
   remote: .
   specs:
-    RecordsKeeperRubyLib (0.1.0)
+    RecordsKeeperRubyLib (0.3.0)
       binary_parser (~> 1.3.0)
       hex_string (~> 1.0.1)
       httparty (~> 0.16.2)
       json (~> 2.1.0)
-      rspec-rails (~> 3.7.2)
       test-unit (~> 3.2.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.0)
-      actionview (= 5.2.0)
-      activesupport (= 5.2.0)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0)
-      activesupport (= 5.2.0)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     binary_parser (1.3.0)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    crass (1.0.4)
     diff-lcs (1.3)
-    erubi (1.7.1)
     hex_string (1.0.1)
     httparty (0.16.2)
       multi_xml (>= 0.5.2)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
     json (2.1.0)
-    loofah (2.2.2)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
     multi_xml (0.6.0)
-    nokogiri (1.8.2-x64-mingw32)
-      mini_portile2 (~> 2.3.0)
     power_assert (1.1.1)
-    rack (2.0.5)
-    rack-test (1.0.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.0)
-      actionpack (= 5.2.0)
-      activesupport (= 5.2.0)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -79,24 +32,14 @@ GEM
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
-    rspec-rails (3.7.2)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-      rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
     test-unit (3.2.8)
       power_assert
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
 
 PLATFORMS
+  ruby
   x64-mingw32
+  x86_64-linux
 
 DEPENDENCIES
   RecordsKeeperRubyLib!
@@ -107,8 +50,7 @@ DEPENDENCIES
   json (= 2.1.0)
   rake (~> 10.0)
   rspec (~> 3.0)
-  rspec-rails (= 3.7.2)
   test-unit (= 3.2.8)
 
 BUNDLED WITH
-   1.16.2
+   1.16.3

data/LICENSE.txt

@@ -4,5 +4,5 @@ License: GNU General Public License version 3, see COPYING
 Portions copyright (c) 2014-2017 Coin Sciences Ltd
 Portions copyright (c) 2009-2016 The Bitcoin Core developers
 Portions copyright many others - see individual files
-
-              
+
+              

data/README.md

@@ -1 +1,92 @@
-# RecordsKeeper-SDK-Ruby
+ RecordsKeeper-Ruby-SDK
+ =========================
+
+It is an infrastructure to build RecordsKeeper blockchain-based applications, products and is used to work around applications that are built on top of this blockchain platform.
+
+**Note:** If you're looking for the RecordsKeeper Ruby Library please see: [RecordsKeeper Ruby Library](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk)
+
+
+## Getting Started
+
+Before you begin you need to setup Ruby Development Environment.  
+
+
+Import these ruby libraries first to get started with the library classes and functions.
+
+
+```bash
+require 'rubygems'
+require 'httparty'
+require 'json'
+require 'binary_parser'
+require 'yaml'
+require 'hex_string'
+```
+
+
+Creating Connection
+-------------------
+
+Entry point for accessing Address class resources.
+
+Make Config file to import config parameters.
+   
+Import chain url and chain name from config file:
+
+* URL: Url to connect to the chain ([RPC Host]:[RPC Port])
+* Chain-name: chain name
+
+```bash
+
+    url = network['url']
+    chain-name = network['chain']
+
+``` 
+
+Node Authentication
+-------------------
+
+Import user name and password values from config file to authenticate the node:
+
+* User name: The rpc user is used to call the APIs.
+* Password: The rpc password is used to authenticate the APIs.
+
+```bash
+    
+    user = network['rkuser']
+    password = network['passwd']
+
+``` 
+
+## Libraries
+
+- [Address](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/blob/master/lib/RecordsKeeperRubyLib/address.rb) Library to work with RecordsKeeper addresses. You can generate new address, check all addresses, check address validity, check address permissions, check address balance by using Address class. You just have to pass parameters to invoke the pre-defined functions.
+
+- [Assets](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/blob/master/lib/RecordsKeeperRubyLib/assets.rb) Library to work with RecordsKeeper assets. You can create new assets and list all assets by using Assets class. You just have to pass parameters to invoke the pre-defined functions.
+
+- [Block](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/blob/master/lib/RecordsKeeperRubyLib/block.rb) Library to work with RecordsKeeper block informaion. You can collect block information by using block class. You just have to pass parameters to invoke the pre-defined functions.
+
+- [Blockchain](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/blob/master/lib/RecordsKeeperRubyLib/blockchain.rb) Library to work with RecordsKeeper block informaion. You can collect block information by using block class. You just have to pass parameters to invoke the pre-defined functions.
+
+- [Permissions](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/blob/master/lib/RecordsKeeperRubyLib/permissions.rb) Library to work with RecordsKeeper permissions. You can grant and revoke permissions like connect, send, receive, create, issue, mine, activate, admin by using Assets class. You just have to pass parameters to invoke the pre-defined functions.
+
+- [Stream](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/blob/master/lib/RecordsKeeperRubyLib/stream.rb) Library to work with RecordsKeeper streams. You can publish, retrieve and verify stream data by using stream class. You just have to pass parameters to invoke the pre-defined functions.
+
+- [Transaction](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/blob/master/lib/RecordsKeeperRubyLib/transaction.rb) Library to work with RecordsKeeper transactions. You can send transaction, create raw transaction, sign raw transaction, send raw transaction, send signed transaction, retrieve transaction information and calculate transaction's fees by using transaction class. You just have to pass parameters to invoke the pre-defined functions.
+
+- [Wallet](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/blob/master/lib/RecordsKeeperRubyLib/wallet.rb) Library to work with RecordsKeeper wallet functionalities. You can create wallet, dump wallet into a file, backup wallet into a file, import wallet from a file, lock wallet, unlock wallet, change wallet's password, retrieve private key, retrieve wallet's information, sign and verify message by using wallet class. You just have to pass parameters to invoke the pre-defined functions.
+
+
+## Unit Tests
+
+Under recordskeeper_ruby_ spec/test using test data from config.yaml file.
+- Command to run a all the tests: 
+[rake spec]
+- Command to a specific test file:
+[rspec spec/test_name.rb]
+
+
+## Documentation
+
+The complete documentation is here: [RecordsKeeper Ruby Library Documentation](https://github.com/RecordsKeeper/recordskeeper-ruby-sdk/tree/master/docs).
+

data/{RecordsKeeperRuby.gemspec → RecordsKeeperRubyLib.gemspec}

@@ -1,16 +1,16 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "RecordsKeeperRuby/version"
+require "RecordsKeeperRubyLib/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "RecordsKeeperRubyLib"
-  spec.version       = RecordsKeeperRuby::VERSION
+  spec.version       = RecordsKeeperRubyLib::VERSION
   spec.authors       = ["Yusra Qureshi"]
   spec.email         = ["yusraq10"]
 
-  spec.summary       = %q{Recordskeeper-SDK-Ruby}
-  spec.description   = %q{This is a Recordskeeper library in Ruby.}
+  spec.summary       = %q{RecordsKeeper-SDK-Ruby}
+  spec.description   = %q{This is ruby library for RecordsKeeper.}
   spec.homepage      = "https://github.com/RecordsKeeper"
   spec.license       = "MIT"
 
@@ -29,6 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "binary_parser", "~> 1.3.0"
   spec.add_dependency "json", "~> 2.1.0"
   spec.add_dependency "test-unit", "~>3.2.8"
-  spec.add_dependency "rspec-rails", "~> 3.7.2"
 
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "RecordsKeeperRuby"
+require "RecordsKeeperRubyLib"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/config.yaml

@@ -0,0 +1,8 @@
+# config.yaml
+
+url: testurl
+rkuser: rkuser
+passwd: rkpwd
+chain: test-chain
+port: testport
+

data/docs/{addressdoc.rb → address_doc.rb}

@@ -1,116 +1,105 @@
-# = Address Class Usage
-# This is a library to work with RecordsKeeper block information.
-# You can generate new address, check all addresses, check address validity, check address permissions, check address balance by using Address class. You just have to pass parameters to invoke the pre-defined functions.
-# ---------
-# == Libraries
-# Require these ruby libraries first to get started with the functionality.
-#  require 'rubygems'
-#  require 'httparty'
-#  require 'json'
-#  require 'binary_parser'
-#  require 'yaml'
-# -----------------
-# == Create Connection
-# Entry point for accessing Address class resources.
-# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
-# * Chain-name: chain name
-#  cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file
-# * Set a *network* value to change the network-type
-#  network = cfg['testnet']                    # Network variable to store the network that you want to access
-# **NOTE:* Default network is *Test-net*, you can change it to mainnet or testnet
-# Check the network type for url and chain name:
-#  if @network==cfg['testnet']
-#      @url = cfg['testnet']['url']
-#      @chain = cfg['testnet']['chain']
-#  else
-#      @url = cfg['mainnet']['url']
-#      @chain = cfg['mainnet']['chain']
-#  end
-# -------------------
-# == Node Authentication
-# Import values from config file.
-# * User name: The rpc user is used to call the APIs.
-# * Password: The rpc password is used to authenticate the APIs.
-# * Check the network type for username and password:
-#  if @network==cfg['testnet']
-#       @user = cfg['testnet']['rkuser']
-#       @password = cfg['testnet']['passwd']
-#  else
-#       @user = cfg['mainnet']['rkuser']
-#       @password = cfg['mainnet']['passwd']
-#  end
-# Now we have node authentication credentials.
-# ------------
-# = class Address
-# Address class is used to call address related functions like generate new address, list all addresses and no of addresses on the node’s wallet, check if given address is valid or not, check if given address has mining permission or not and check a particular address balance on the node functions which are used on the RecordsKeeeper Blockchain.
-# === 1. getAddress
-# This function generates a new address on the node wallet.
-#	getAddress
-#	newAddress = getAddress			 # Function call
-#
-#	puts newAddress                  # prints a new address
-# === 2. getMultisigAddress nrequired, key
-# This function generates a new multisignature address.
-#
-# You have to pass these two arguments to the getMultisigAddress function call:
-# * nrequired: To pass the no of signatures that are a must to sign a transaction.
-# * key: To pass any number of comma-separated public addresses that are to be used with this multisig address as a single variable.
-#	getMultisigAddress nrequired, key
-#	newAddress = getMultisigAddress nrequired, key          # Function call
-#
-#	puts newAddress                           # prints a new address
-# === 3. getMultisigWalletAddress nrequired, key
-# This function generates a new multisignature address on the node's wallet.
-#
-# You have to pass these two arguments to the getMultisigWalletAddress function call:
-# * nrequired: This variable is required to pass the number of signatures that are a must to sign a transaction.
-# * key: This variable is required to pass a string of comma-separated public addresses that are to be used with this multisig address as a single variable.
-#	getMultisigWalletAddress nrequired, key
-# 	newAddress = getMultisigWalletAddress nrequired, key   		# Function call
-#
-# 	puts newAddress                           #prints a new address
-# === 4. retrieveAddresses
-# To list all the addresses and number of addresses on the node's wallet
-# 	retrieveAddresses
-# 	allAddresses, address_count = retrieveAddresses      		# Function call
-#
-# 	puts allAddresses       # prints all the addresses of the wallet
-# 	puts address_count      # prints the address count
-# === 5. checkifValid address
-# To check validity of the address
-#
-# You have to pass address as argument to the checkifValid function call:
-# * Address: To check its validity.
-#	checkifValid
-#	addressC = checkifValid address                # Function call
-#
-# 	puts addressC      # prints validity
-# === 6. checkifMineAllowed address
-# To check if given address has mining permission or not
-#
-# You have to pass address as argument to the checkifMineAllowed function call:
-# * Address: To check the permission status
-# 	checkifMineAllowed address
-#	permissionCheck = checkifMineAllowed address   # Function call
-#
-#	puts permissionCheck      # prints permission status of the given address
-# === 7. checkBalance address
-# To check address balance on a particular node
-#
-# You have to pass address as argument to the checkifMineAllowed function call:
-# * Address: To check the balance
-#	checkBalance address
-#	address_balance = checkBalance address    # Function call
-#
-#	puts address_balance    # prints balance of the address
-# === 8. importAddress public_address
-# To import a non-wallet address on RecordsKeeeper Blockchain
-#
-# You have to pass address as argument to the importAddress function call:
-# * Address: A non-wallet address to import on a particular node
-#	importAddress public_address
-#	response = importAddress public_address     # Function call
-#
-#	puts response    # prints response
-class Address
-end
+# = Address Class Usage
+# This is a library to work with RecordsKeeper block information.
+# You can generate new address, check all addresses, check address validity, check address permissions, check address balance by using Address class. You just have to pass parameters to invoke the pre-defined functions.
+# ---------
+# == Libraries
+# Require these ruby libraries first to get started with the functionality.
+#  require 'rubygems'
+#  require 'httparty'
+#  require 'json'
+#  require 'binary_parser'
+#  require 'yaml'
+# -----------------
+# == Create Connection
+# Entry point for accessing Address class resources.
+# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
+# * Chain-name: chain name
+# 	 	cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file 
+# * Set a *network* value.
+#  		network = cfg['network']                    # Network variable to store the network that you want to access
+# * Set url and chain name:
+#      @url = cfg['network']['url']
+#      @chain = cfg['network']['chain']
+# -------------------
+# == Node Authentication
+# Import values from config file.
+# * User name: The rpc user is used to call the APIs.
+# * Password: The rpc password is used to authenticate the APIs.
+# * Set the rpc username and password:
+#       @user = cfg['network']['rkuser']
+#       @password = cfg['network']['passwd']
+# Now we have node authentication credentials.
+# ------------
+# = class Address
+# Address class is used to call address related functions like generate new address, list all addresses and no of addresses on the node’s wallet, check if given address is valid or not, check if given address has mining permission or not and check a particular address balance on the node functions which are used on the RecordsKeeeper Blockchain.
+# === 1. getAddress
+# This function generates a new address on the node wallet.
+#	getAddress						
+#	newAddress = getAddress			 # Function call	   
+#      
+#	puts newAddress                  # prints a new address
+# === 2. getMultisigAddress nrequired, key
+# This function generates a new multisignature address.
+#
+# You have to pass these two arguments to the getMultisigAddress function call:
+# * nrequired: To pass the no of signatures that are a must to sign a transaction.
+# * key: To pass any number of comma-separated public addresses that are to be used with this multisig address as a single variable.
+#	getMultisigAddress nrequired, key
+#	newAddress = getMultisigAddress nrequired, key          # Function call
+#
+#	puts newAddress                           # prints a new address
+# === 3. getMultisigWalletAddress nrequired, key
+# This function generates a new multisignature address on the node's wallet.
+#
+# You have to pass these two arguments to the getMultisigWalletAddress function call:
+# * nrequired: This variable is required to pass the number of signatures that are a must to sign a transaction.
+# * key: This variable is required to pass a string of comma-separated public addresses that are to be used with this multisig address as a single variable.
+#	getMultisigWalletAddress nrequired, key
+# 	newAddress = getMultisigWalletAddress nrequired, key   		# Function call
+#
+# 	puts newAddress                           #prints a new address
+# === 4. retrieveAddresses
+# To list all the addresses and number of addresses on the node's wallet
+# 	retrieveAddresses
+# 	retrievedinfo = JSON.parse retrieveAddresses      		# Function call
+#
+# 	puts retrievedinfo['address']       # prints all the addresses of the wallet
+#	puts retrievedinfo['address_count']	# prints the count of addresses in the wallet
+# === 5. checkifValid address
+# To check validity of the address
+#
+# You have to pass address as argument to the checkifValid function call:
+# * Address: To check its validity.
+#	checkifValid
+#	addressC = checkifValid address                # Function call
+#
+# 	puts addressC      # prints validity
+# === 6. checkifMineAllowed address
+# To check if given address has mining permission or not
+#
+# You have to pass address as argument to the checkifMineAllowed function call:
+# * Address: To check the permission status
+# 	checkifMineAllowed address
+#	permissionCheck = checkifMineAllowed address   # Function call
+#
+#	puts permissionCheck      # prints permission status of the given address
+# === 7. checkBalance address
+# To check address balance on a particular node
+#
+# You have to pass address as argument to the checkifMineAllowed function call:
+# * Address: To check the balance
+#	checkBalance address
+#	address_balance = checkBalance address    # Function call
+#
+#	puts address_balance    # prints balance of the address
+# === 8. importAddress public_address
+# To import a non-wallet address on RecordsKeeeper Blockchain
+#
+# You have to pass address as argument to the importAddress function call:
+# * Address: A non-wallet address to import on a particular node
+#	importAddress public_address
+#	response = importAddress public_address     # Function call
+#
+#	puts response    # prints response
+class Address
+end