RecordsKeeperRubyLib 0.1.0 → 0.1.1

data/lib/config.yaml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RecordsKeeperRubyLib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yusra Qureshi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,21 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.8
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.7.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.7.2
-description: This is a Recordskeeper library in Ruby.
+description: This is ruby library for RecordsKeeper.
 email:
 - yusraq10
 executables: []
@@ -152,30 +138,30 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- RecordsKeeperRuby.gemspec
+- RecordsKeeperRubyLib.gemspec
 - bin/console
 - bin/setup
-- docs/addressdoc.rb
-- docs/assetsdoc.rb
-- docs/blockchaindoc.rb
-- docs/blockdoc.rb
-- docs/permissionsdoc.rb
-- docs/streamdoc.rb
-- docs/transactiondoc.rb
-- docs/walletdoc.rb
-- lib/RecordsKeeperRuby.rb
-- lib/RecordsKeeperRuby/address.rb
-- lib/RecordsKeeperRuby/assets.rb
-- lib/RecordsKeeperRuby/block.rb
-- lib/RecordsKeeperRuby/blockchain.rb
-- lib/RecordsKeeperRuby/permissions.rb
-- lib/RecordsKeeperRuby/sample_config.yaml
-- lib/RecordsKeeperRuby/stream.rb
-- lib/RecordsKeeperRuby/transaction.rb
-- lib/RecordsKeeperRuby/version.rb
-- lib/RecordsKeeperRuby/wallet.rb
-- lib/sample_config.yaml
-- sample_config.yaml
+- config.yaml
+- docs/address_doc.rb
+- docs/asset_doc.rb
+- docs/block_doc.rb
+- docs/blockchain_doc.rb
+- docs/permissions_doc.rb
+- docs/stream_doc.rb
+- docs/transaction_doc.rb
+- docs/wallet_doc.rb
+- lib/RecordsKeeperRubyLib.rb
+- lib/RecordsKeeperRubyLib/address.rb
+- lib/RecordsKeeperRubyLib/assets.rb
+- lib/RecordsKeeperRubyLib/block.rb
+- lib/RecordsKeeperRubyLib/blockchain.rb
+- lib/RecordsKeeperRubyLib/config.yaml
+- lib/RecordsKeeperRubyLib/permissions.rb
+- lib/RecordsKeeperRubyLib/stream.rb
+- lib/RecordsKeeperRubyLib/transaction.rb
+- lib/RecordsKeeperRubyLib/version.rb
+- lib/RecordsKeeperRubyLib/wallet.rb
+- lib/config.yaml
 homepage: https://github.com/RecordsKeeper
 licenses:
 - MIT
@@ -196,8 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
-summary: Recordskeeper-SDK-Ruby
+summary: RecordsKeeper-SDK-Ruby
 test_files: []

data/docs/blockchaindoc.rb

@@ -1,77 +0,0 @@
-# = Blockchain Class Usage
-# This is a library to work with Blockchain in RecordsKeeper Blockchain.
-# 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 Blockchain class resources.
-# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
-# * Chain-name: Name of the chain
-#  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* ( i.e., you can set it to either testnet or mainnet).
-# 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 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 = getChainInfo			 # Function call
-#
-#	puts chainInfo               # Prints chain_protocol, chain_description, root_stream, max_blocksize, default_networkport, default_rpcport, mining_diversity and chain_name.
-# === 2. getNodeInfo
-# This function retrieves information related to your node.
-# 	getNodeInfo
-#	nodeInfo = getNodeInfo			# Function call
-#
-# 	puts nodeInfo				# Prints node_balance, synced_blocks, node_address and 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 = getpendingTransactions				# Function call
-#
-# 	puts pentransac				# Prints transaction_count and the 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/blockdoc.rb

@@ -1,76 +0,0 @@
-# = 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 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 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.
-#	blockinfo block_height							# Function call
-#	tx_count, tx, miner, size, nonce, blockHash, prevblock, nextblock, merkleroot, blocktime, difficulty = blockinfo block_height
-#
-# 	puts tx_count      # prints transaction count of the block
-# 	puts tx            # prints transaction ids of the block
-# 	puts size          # prints size of the block
-# 	puts blockHash     # prints hash value of the block
-# 	puts nonce         # prints nonce of the block
-# 	puts miner         # prints miner's address of the block
-# 	puts nextblock     # prints next block's hash
-# 	puts prevblock     # prints previous block's hash
-# 	puts merkleroot    # prints merkle root of the block
-# 	puts blocktime     # prints time at which block is mined
-# 	puts 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.
-#	retrieveBlocks block_range						# Function call
-#	block_hash, miner_add, block_time, txcount = retrieveBlocks block_range
-#
-#	puts block_hash    # prints hash of the blocks
-# 	puts miner_add     # prints miner of the blocks
-# 	puts block_time    # prints block time of the blocks
-# 	puts txcount       # prints transaction count of the blocks
-class Block
-end

data/lib/RecordsKeeperRuby.rb

@@ -1,9 +0,0 @@
-  require "RecordsKeeperRuby/version"
-  require_relative ('RecordsKeeperRuby/address')
-  require_relative ('RecordsKeeperRuby/assets')
-  require_relative ('RecordsKeeperRuby/block')
-  require_relative ('RecordsKeeperRuby/blockchain')
-  require_relative ('RecordsKeeperRuby/permissions')
-  require_relative ('RecordsKeeperRuby/stream')
-  require_relative ('RecordsKeeperRuby/transaction')
-  require_relative ('RecordsKeeperRuby/wallet')

data/lib/RecordsKeeperRuby/sample_config.yaml

@@ -1,60 +0,0 @@
-# config.yaml
-testnet:
-    url: testurl
-    rkuser: rkuser
-    passwd: rkpwd
-    chain: test-chain
-    port: testport
-    stream: streamname
-    testdata: test_data
-    amount: test_amount
-    dumptxid: test_txid
-    privatekey: test_privkey
-    validaddress: valid_address
-    invalidaddress: invalid_address
-    miningaddress: mining_address
-    nonminingaddress: nonmining_address
-    multisigaddress: multisig_address
-    wrongimportaddress: wrongimport_address
-    mainaddress: main_address
-    permissionaddress: permission_address
-    dumptxhex: dump_txhex
-    dumpsignedtxhex: dump_signedtxhex
-    samplegetmultisigaddress: sample_multisigaddress
-    samplemerkleroot: sample_merkleroot
-    sampleblockhash: sample_blockhash
-    sampledata: sample_data
-    sampletransac: sample_transaction_id
-    transactionid: transaction_id
-    sampletxid: sample_txid
-
-
-
-mainnet:
-    url: mainurl
-    rkuser: rkuser
-    passwd: rkpwd
-    chain: main-chain
-    port: mainport
-    stream: streamname
-    testdata: main_data
-    amount: main_amount
-    dumptxid: main_txid
-    privatekey: main_privkey
-    validaddress: valid_address
-    invalidaddress: invalid_address
-    miningaddress: mining_address
-    nonminingaddress: nonmining_address
-    multisigaddress: multisig_address
-    wrongimportaddress: wrongimport_address
-    mainaddress: main_address
-    permissionaddress: permission_address
-    dumptxhex: dump_txhex
-    dumpsignedtxhex: dump_signedtxhex
-    samplegetmultisigaddress: sample_multisigaddress
-    samplemerkleroot: sample_merkleroot
-    sampleblockhash: sample_blockhash
-    sampledata: sample_data
-    sampletransac: sample_transaction_id
-    transactionid: transaction_id
-    sampletxid: sample_txid

data/lib/RecordsKeeperRuby/stream.rb

@@ -1,169 +0,0 @@
-# 	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.
-
-require 'rubygems'
-require 'httparty'
-require 'json'
-require 'binary_parser'
-require 'yaml'
-require 'hex_string'
-
-module RecordsKeeperRuby
-
-	class Stream
-
-		# Entry point for accessing Block class resources.
-		# Import values from config file.
-		cfg = YAML::load(File.open('config.yaml','r'))
-		@network = cfg['testnet']								# Network variable to store the networrk that you want to access
-		if @network==cfg['testnet']
-			@url = cfg['testnet']['url']
-			@user = cfg['testnet']['rkuser']
-			@password = cfg['testnet']['passwd']
-			@chain = cfg['testnet']['chain']
-		else
-			@url = cfg['mainnet']['url']
-			@user = cfg['mainnet']['rkuser']
-			@password = cfg['mainnet']['passwd']
-			@chain = cfg['mainnet']['chain']
-		end
-
-		def self.variable
-			net = @network
-			return net
-		end
-
-	  # Function to publish data into the stream
-		def self.publish address, stream, key, data
-	    datahex1 = data.to_hex_string
-	    datahex = datahex1.delete(' ')
-	    auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"publishfrom","params":[address, stream, key, datahex],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			txid = out[0]['result']
-			return txid;
-	  end
-
-	  # Function to retrieve data against transaction id from the stream
-		def self.retrieve stream, txid
-	    auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getstreamitem","params":[stream, txid],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			data = out[0]['result']['data']
-	    raw_data = data.to_byte_string
-			return raw_data;
-	  end
-
-	  # Function to retrieve data against a particular publisher address
-		def self.retrieveWithAddress stream, address, count
-	    auth = {:username => @user, :password => @password}
-	    options = {
-	      :headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-	      :basic_auth => auth,
-	      :body => [ {"method":"liststreampublisheritems","params":[stream, address, false, count],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-	    }
-	    response = HTTParty.get(@url, options)
-	    out = response.parsed_response
-			key = []
-	    raw_data = []
-	    txid = []
-			i = 0
-			begin
-				key.push(out[0]['result'][i]['key'])           	  #returns key value of the published data
-	      data = out[0]['result'][i]['data']                #returns hex data
-	      raw_data.push(data.to_byte_string)    						#returns raw data
-	      txid.push(out[0]['result'][i]['txid'])            #returns tx id
-			end until i <count
-	    return key, raw_data, txid;
-	  end
-
-	  # Function to retrieve data against a particular key value
-		def self.retrieveWithKey stream, key, count
-	    auth = {:username => @user, :password => @password}
-	    options = {
-	      :headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-	      :basic_auth => auth,
-	      :body => [ {"method":"liststreamkeyitems","params":[stream, key, false, count],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-	    }
-	    response = HTTParty.get(@url, options)
-	    out = response.parsed_response
-			publisher = []
-	    raw_data = []
-	    txid = []
-			i = 0
-			begin
-				publisher.push(out[0]['result'][i]['publishers'][0])    	#returns publisher's address of published data
-	      data = out[0]['result'][i]['data']                        #returns published hex data
-	      raw_data.push(data.to_byte_string)           						  #returns data published
-	      txid.push(out[0]['result'][i]['txid'])                    #returns transaction id of published data
-			end until i <count
-	    return publisher, raw_data, txid;
-	  end
-
-	  # Function to verify data on RecordsKeeper Blockchain
-		def self.verifyData stream, data, count
-	    auth = {:username => @user, :password => @password}
-	    options = {
-	      :headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-	      :basic_auth => auth,
-	      :body => [ {"method":"liststreamitems","params":[stream,false ,count],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-	    }
-	    response = HTTParty.get(@url, options)
-	    out = response.parsed_response
-			raw_data = []
-			i = 0
-			begin
-				result_data = out[0]['result'][i]['data']						       # returns hex data
-			end until i <count
-	    if result_data.unicode_normalized?
-				raw_data.push(result_data.to_byte_string)	                 # returns raw data
-			else
-	      raw_data.push("No data found")
-	    end
-	    if raw_data.include?data
-			  result = "Data is successfully verified."
-			else
-				result = "Data not found."
-	    end
-			return result;
-	  end
-
-		# Function to list stream items on RecordsKeeper Blockchain
-		def self.retrieveItems stream, count
-	    auth = {:username => @user, :password => @password}
-	    options = {
-	      :headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-	      :basic_auth => auth,
-	      :body => [ {"method":"liststreamitems","params":[stream, false ,count],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-	    }
-	    response = HTTParty.get(@url, options)
-	    out = response.parsed_response
-	    address =[]
-			key_value = []
-			raw_data = []
-			txid = []
-			i = 0
-			begin
-				address.push(out[0]['result'][i]['publishers'])		        # returns publisher address
-				key_value.push(out[0]['result'][i]['key'])			          # returns key value of data
-				data = out[0]['result'][i]['data']					              # returns hex data
-	      raw_data.push(data.to_byte_string)                     	  # returns raw data
-				txid.push(out[0]['result'][i]['txid'])				            # returns tx id
-			end until i <count
-			return address, key_value, raw_data, txid;
-	  end
-	end
-
-end