RecordsKeeperRubyLib 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d54ade47103d4e10a794850a9538281345fe4f52d981b04532b5db24fcf60b8c
-  data.tar.gz: c25fd4bde17d3ea3a99606a55537d72629f5d6c60b0d622d5413fd76892b87fb
+SHA1:
+  metadata.gz: 571e0c582fc30457e34d795b4385fe83c1b8eccd
+  data.tar.gz: d8d1f0bd30c6253cd0a70a01b269c81c7fc32849
 SHA512:
-  metadata.gz: e0f0c1920a06c1527e0706a86df22ffd8abffb3015955468b20c8274e8f0ab6fff878d99c563c1e0815d094da40eb23c7507276cbf33473ef8542c46b21ddb4b
-  data.tar.gz: 3f3ce0846ca1bdbe26b81808e68a66859c84130a130da945776e3248cb4a2a6fb9a92a91b53b589594453ce5451a78fa7961d428dd87d8fc21b1bcd14797130b
+  metadata.gz: fab0c3a26255de3d54da08c2db6dc61c5d55932d54381b71f473e56575aac84740629dffb8d37f5c764433b91472cce818b2fa34d8e54dc71d1b6dded6c83eb2
+  data.tar.gz: 7230b6bf6e6d39d300dec2bac8bb714f2e7d57967bd2e24ceb4e74bd530c54c0e1ab9f1ceb109d7c35dbe8e29ee8fd676113a87dee46b957eb656f30a5c89da8

data/.gitignore

@@ -9,4 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
-config.yaml
+

data/Gemfile.lock

@@ -37,7 +37,9 @@ GEM
       power_assert
 
 PLATFORMS
+  ruby
   x64-mingw32
+  x86_64-linux
 
 DEPENDENCIES
   RecordsKeeperRubyLib!
@@ -51,4 +53,4 @@ DEPENDENCIES
   test-unit (= 3.2.8)
 
 BUNDLED WITH
-   1.16.2
+   1.16.3

data/README.md

@@ -1 +1,92 @@
-# RecordsKeeperRubyLib
+ 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/config.yaml

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

data/docs/address_doc.rb

@@ -0,0 +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.
+#  		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

data/docs/asset_doc.rb

@@ -0,0 +1,54 @@
+# = Assets Class Usage
+# This is a 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.
+# ---------
+# == 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 Assets
+# Assets class is used to call assets related functions like create assets and list assets functions which are used on the RecordsKeeeper Blockchain.
+# === 1. createAsset 
+# This function is used to create or issue an asset.
+#	txid = createAsset address, asset_name, asset_qty        # Function call
+#
+#	puts txid                  # prints tx id of the issued asset
+# === 2. retrieveAssets
+# This function is used to list all assets, no of assets, issued quantity and issued transaction id of all the assets on RecordsKeeper Blockchain.
+#	retrievedinfo = JSON.parse retrieveAssets       # Function call
+#
+#	puts retrievedinfo['asset_name']       # prints all the addresses of the wallet
+#	puts retrievedinfo['asset_count']      # prints the address count
+#	puts retrievedinfo['issue_qty']        # prints assets issued quantity
+#	puts retrievedinfo['issue_id']         # prints assets issued transaction id
+# === 3. sendAsset 
+# This function is used to send an asset.
+#	txid = sendAsset address, asset_name, asset_qty        # Function call
+#
+#	puts txid                  # prints tx id of the sent asset
+class Assets
+end

data/docs/block_doc.rb

@@ -0,0 +1,63 @@
+# = Block 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 Block
+# Block class is used to call block related functions like blockinfo which is used to retrieve block details
+# like block's hash value, size, nonce, transaction ids, transaction count, miner address, previous block hash,
+# next block hash, merkleroot, blocktime and difficulty of the block for which you have made the query.
+# === 1. blockinfo block_height
+# * You have to pass the block height as an argument in the blockinfo function call (Block height: Height of the block of which you want to collect information.)
+# * It will return transaction ids, transaction count, nonce, size, hash value, previous block's hash value, next block hash value, merkle root, difficulty, blocktime and miner address of the block.
+#	information = JSON.parse blockinfo block_height							# Function call
+#
+# 	puts information['tx_count']      # prints transaction count of the block
+# 	puts information['tx']            # prints transaction ids of the block
+# 	puts information['size']          # prints size of the block
+# 	puts information['blockHash']     # prints hash value of the block
+# 	puts information['nonce']         # prints nonce of the block
+# 	puts information['miner']         # prints miner's address of the block
+# 	puts information['nextblock']     # prints next block's hash
+# 	puts information['prevblock']     # prints previous block's hash
+# 	puts information['merkleroot']    # prints merkle root of the block
+# 	puts information['blocktime']     # prints time at which block is mined
+# 	puts information['difficulty']    # prints difficulty of the block
+# === 2. retrieveBlocks block_range
+# * You have to pass the block's height as the argument to the retrieveBlocks function call (Block range: Range of the block of which you want to collect information)
+# * It will return blockhash, miner address, blocktime and transaction count of the blocks.
+#	information = JSON.parse retrieveBlocks block_range						# Function call
+#
+#	puts information['block_hash']    # prints hash of the blocks
+# 	puts information['miner_add']     # prints miner of the blocks
+# 	puts information['block_time']    # prints block time of the blocks
+# 	puts information['txcount']       # prints transaction count of the blocks
+class Block
+end

data/docs/blockchain_doc.rb

@@ -0,0 +1,77 @@
+# = Blockchain Class Usage
+# This is a library to work with Blockchains in RecordsKeeper.
+# You can retrieve information about the chain and node, list all the permissions and the pending transactions and check your node's balance.
+# ---------
+# == 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 Blockchain
+# Blockchain class is used to call blockchain related functions to retrieve information about the chain and node, list all the permissions and the pending transactions and check your node's balance.
+# === 1. getChainInfo
+# This function retrieves information about the chain.
+#	getChainInfo						
+#	chainInfo = JSON.parse getChainInfo			 # Function call	   
+#      
+#	puts chainInfo['chain_protocol']			# prints chain-protocol
+#	puts chainInfo['chain_description']			# prints chain-description
+#	puts chainInfo['root_stream']				# prints root-stream-name
+#	puts chainInfo['max_blocksize']				# prints maximum-block-size
+#	puts chainInfo['default_networkport']		# prints default-network-port
+#	puts chainInfo['default_rpcport']			# prints default-rpc-port
+#	puts chainInfo['mining_diversity']			# prints mining-diversity
+#	puts chainInfo['chain_name']				# prints chain-name
+# === 2. getNodeInfo
+# This function retrieves information related to your node.
+# 	getNodeInfo
+#	nodeInfo = JSON.parse getNodeInfo			# Function call
+#	
+# 	puts nodeInfo['node_balance']			# prints balance
+#	puts nodeInfo['synced_blocks']			# prints synced-blocks
+#	puts nodeInfo['node_address']			# prints nodeaddress
+#	puts nodeInfo['difficulty']				# prints difficulty
+# === 3. permissions
+# This function lists all the permissions.
+# 	permissions
+#	listpermissions = permissions			# Function call
+#	
+# 	puts listpermissions				# Prints the list of permissions.
+# === 4. getpendingTransactions
+# This function retrieves information related to your node.
+# 	getpendingTransactions
+#	pentransac = JSON.parse getpendingTransactions				# Function call
+#	
+# 	puts pentransac['tx_count']				# prints transaction count
+#	puts pentransac['tx']					# prints the pending transactions
+# === 5. checkNodeBalance
+# This function retrieves information related to your node.
+# 	checkNodeBalance
+#	nodeBal = checkNodeBalance			# Function call
+#	
+# 	puts nodeBal				# Prints node's balance amount.
+class Blockchain
+end

data/docs/permissions_doc.rb

@@ -0,0 +1,54 @@
+# = Permissions Class Usage
+# This is a 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.
+# ---------
+# == 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 Permissions
+# Permissions class is used to call permissions related functions like grant and revoke permissions for an address functions which are used on the RecordsKeeeper Blockchain.
+# === 1. grantPermission address, permissions
+# This function is used to grant permissions like connect, send, receive, create, issue, mine, activate, admin to an address on RecordsKeeper Blockchain.
+#
+# You have to pass these two arguments to the grantPermission function call:
+# * Permissions: list of comma-seperated permissions passed as a string
+# * Address: to which you have to grant permission
+#	result = grantPermission address, permissions
+#
+#	puts txid                  # prints response of the grant permision transaction
+# === 2. revokePermission address, permissions
+# This function is used to revoke permissions like connect, send, receive, create, issue, mine, activate, admin to an address on RecordsKeeper Blockchain.
+#	
+# You have to pass these two arguments to the grantPermission function call:
+# * Permissions: list of comma-seperated permissions passed as a string
+# * Address: to which you have to grant permission
+#	result = revokePermission address, permissions
+#
+#	puts result                # prints response of the revoke permision transaction
+class Permissions
+end