RecordsKeeperRubyLib 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d324ac6751d6dca6221d87cc8ba6def45563226e
-  data.tar.gz: 9b6277d16371801e4f1be36795b47085d782fdaf
+SHA256:
+  metadata.gz: 111feaaa57157ea2426943932aeb13e49488838f9854f041b487482462f73470
+  data.tar.gz: 566e3a1fda8d5566c502e881b328e77e0e068ee01090424f85651f44d3ad4d7a
 SHA512:
-  metadata.gz: cec03224ca43aec072128a23dce1812a24ea2611ae87c74367f60cca388aa7d80a8bc436b26be0e2e72654aeb9544990e5de32ef260e2d9a019ca1453912186c
-  data.tar.gz: 3e631c9d26741cb4be3f49e3d0a89f0b2bab081f42827b3bb8ca561017789e18405f56a8886da590ce803ea92eecd248b350369e77fc9d324cb63dbd23666be7
+  metadata.gz: bb61b66e17ff9abdedf79d6d0471b01b9c5b07b4f49f8cb15b3c9581d6872b8ee778988cea2f0f080d43ecd20fa935521fb2c62c3616d896931084d2ba24eb6c
+  data.tar.gz: 9271bc6cf4291d1664fbaa02f151585121e145589677cb79e7f7787a9f732d919f395f79b34c260dcf6be02ef2d42eb95e413ad79cf8dcfcfa1650b16b8cc485

data/.gitignore

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    RecordsKeeperRubyLib (0.3.0)
+    RecordsKeeperRubyLib (0.2.0)
       binary_parser (~> 1.3.0)
       hex_string (~> 1.0.1)
       httparty (~> 0.16.2)
@@ -37,9 +37,7 @@ GEM
       power_assert
 
 PLATFORMS
-  ruby
   x64-mingw32
-  x86_64-linux
 
 DEPENDENCIES
   RecordsKeeperRubyLib!
@@ -53,4 +51,4 @@ DEPENDENCIES
   test-unit (= 3.2.8)
 
 BUNDLED WITH
-   1.16.3
+   1.16.2

data/README.md

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

data/lib/RecordsKeeperRubyLib/address.rb

@@ -1,198 +1,186 @@
-# Library to work with RecordsKeeper address class.
-# 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.
-
-# import rubygems, httparty, json, binary_parser, objspace and yaml
-require 'rubygems'
-require 'httparty'
-require 'json'
-require 'binary_parser'
-require 'yaml'
-
-# Address class to access Address related functions
-module RecordsKeeperRubyLib
-	class Address
-		if File.exist?('config.yaml')
-			# Import values from configuration file.
-			cfg = YAML::load(File.open('config.yaml','r'))
-			
-			@url = cfg['url']
-			@user = cfg['rkuser']
-			@password = cfg['passwd']
-			@chain = cfg['chain']
-		
-		else
-			#Import using ENV variables
-			
-			@url = ENV['url']
-    		@user = ENV['rkuser']
-    		@password = ENV['passwd']
-    		@chain = ENV['chain']	
-		end
-
-
-		# Function to generate new address on the node's wallet
-		def self.getAddress
-
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getnewaddress","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			address = out[0]['result']
-			return address
-		end
-
-		# Function to generate a new multisignature address
-		def self.getMultisigAddress nrequired, key		#getMultisigAddress() function definition
-
-			key_list = key.split(",")
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"createmultisig","params":[nrequired, key_list],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			address = out[0]['result']
-			if address.nil?
-				res = out[0]['error']['message']
-			else
-				res = out[0]['result']['address']
-			end
-			return res;																							#returns new multisig address
-		end
-
-		# Function to generate a new multisignature address on the node's wallet
-		def self.getMultisigWalletAddress nrequired, key
-			key_list = key.split(",")
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"addmultisigaddress","params":[nrequired, key_list],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			address = out[0]['result']
-			if address.nil?
-				res = out[0]['error']['message']
-			else
-				res = out[0]['result']
-			end
-			return res;																										# Returns new multisig address
-		end
-
-		# Function to list all addresses and no of addresses on the node's wallet
-		def self.retrieveAddresses
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getaddresses","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			address = out[0]['result']
-			address_count = address.length
-			address =[]
-			for i in 0..address_count
-				address.push(out[0]['result'][i])
-			end
-			retrieved = { :address => address,:address_count => address_count}
-			retrievedinfo = JSON.generate retrieved
-			return retrievedinfo
-	  end
-
-		# Function to check if given address is valid or not
-		def self.checkifValid address
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"validateaddress","params":[address],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			validity = out[0]['result']['isvalid']
-	 		if validity
-	 			addressCheck = "Address is valid" 											# Prints that address is valid
-	 		else
-	 			addressCheck= "Address is invalid"											# Prints that address is invalid
-			end
-	 		return addressCheck;																			# Return the address check status
-		end
-
-		# Function to check if given address has mining permission or not
-		def self.checkifMineAllowed address
-			auth = {:username => @user, :password => @password}
-	 		options = {
-	 			:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-	 			:basic_auth => auth,
-	 			:body => [ {"method":"validateaddress","params":[address],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-	 		}
-	 		response = HTTParty.get(@url, options)
-	 		out = response.parsed_response
-
-			check = out[0]['result']['isvalid']
-
-			if check
-				permission = out[0]['result']['ismine']
-				if permission
-					permissionCheck = "Address has mining permission"										# Prints that address has mining permission
-			 	else
-				 	permissionCheck = "Address has not given mining permission"					# Prints that address hasn't been given mining permission
-				end
-			else
-				permissionCheck = "Invalid address";
-			end
-			return permissionCheck;																								# Returns the permission status
-		end
-
-		# Function to check node address balance on RecordsKeeper Blockchain
-		def self.checkBalance address
-			auth = {:username => @user, :password => @password}
-	 		options = {
-	 			:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-	 			:basic_auth => auth,
-	 			:body => [ {"method":"getaddressbalances","params":[address],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-	 		}
-	 		response = HTTParty.get(@url, options)
-	 		out = response.parsed_response
-	 		check = out[0]['result']
-	 		if check
-				balance = out[0]['result'][0]['qty']
-			else
-				balance = out[0]['error']['message']
-			end
-	 		return balance;																						# Returns balance of a particular node address
-		end
-
-		# Function to import address on RecordsKeeper Blockchain
-		def self.importAddress public_address
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"importaddress","params":[public_address, " ", false],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			result = out[0]['result']
-			error = out[0]['error']
-			if result.nil? && error.nil?
-				resp = "Address successfully imported"												 # Prints that address has been succesfully imported
-			elsif result.nil? && error!= nil
-				resp = out[0]['error']['message']
-			else
-				resp = 0
-			end
-			return resp;
-		end
-
-	end
-end
+# Library to work with RecordsKeeper address class.
+# 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.
+
+# import rubygems, httparty, json, binary_parser, objspace and yaml
+require 'rubygems'
+require 'httparty'
+require 'json'
+require 'binary_parser'
+require 'yaml'
+
+# Address class to access address related functions
+module RecordsKeeperRubyLib
+	class Address
+		# Import values from configuration file.
+		cfg = YAML::load(File.open('config.yaml','r'))
+		@network = cfg['network']
+		@url = cfg['network']['url']
+		@user = cfg['network']['rkuser']
+		@password = cfg['network']['passwd']
+		@chain = cfg['network']['chain']
+
+		def self.variable
+			net = @network
+			return net
+		end
+
+
+		# Function to generate new address on the node's wallet
+		def self.getAddress
+
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"getnewaddress","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			address = out[0]['result']
+			return address
+		end
+
+		# Function to generate a new multisignature address
+		def self.getMultisigAddress nrequired, key		#getMultisigAddress() function definition
+
+			key_list = key.split(",")
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"createmultisig","params":[nrequired, key_list],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			address = out[0]['result']
+			if address.nil?
+				res = out[0]['error']['message']
+			else
+				res = out[0]['result']['address']
+			end
+			return res;																							#returns new multisig address
+		end
+
+		# Function to generate a new multisignature address on the node's wallet
+		def self.getMultisigWalletAddress nrequired, key
+			key_list = key.split(",")
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"addmultisigaddress","params":[nrequired, key_list],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			address = out[0]['result']
+			if address.nil?
+				res = out[0]['error']['message']
+			else
+				res = out[0]['result']
+			end
+			return res;																										# Returns new multisig address
+		end
+
+		# Function to list all addresses and no of addresses on the node's wallet
+		def self.retrieveAddresses
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"getaddresses","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			address = out[0]['result']
+			address_count = address.length
+			address =[]
+			for i in 0..address_count
+				address.push(out[0]['result'][i])
+			end
+			retrieved = { :address => address,:address_count => address_count}
+			retrievedinfo = JSON.generate retrieved
+			return retrievedinfo
+	  end
+
+		# Function to check if given address is valid or not
+		def self.checkifValid address
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"validateaddress","params":[address],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			validity = out[0]['result']['isvalid']
+	 		if validity
+	 			addressCheck = "Address is valid" 											# Prints that address is valid
+	 		else
+	 			addressCheck= "Address is invalid"											# Prints that address is invalid
+			end
+	 		return addressCheck;																			# Return the address check status
+		end
+
+		# Function to check if given address has mining permission or not
+		def self.checkifMineAllowed address
+			auth = {:username => @user, :password => @password}
+	 		options = {
+	 			:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+	 			:basic_auth => auth,
+	 			:body => [ {"method":"validateaddress","params":[address],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+	 		}
+	 		response = HTTParty.get(@url, options)
+	 		out = response.parsed_response
+			check = out[0]['result']['isvalid']
+			if check
+				permission = out[0]['result']['ismine']
+				if permission
+					permissionCheck = "Address has mining permission"										# Prints that address has mining permission
+			 	else
+				 	permissionCheck = "Address has not given mining permission"					# Prints that address hasn't been given mining permission
+				end
+			else
+				permissionCheck = "Invalid address";
+			end
+			return permissionCheck;																								# Returns the permission status
+		end
+
+		# Function to check node address balance on RecordsKeeper Blockchain
+		def self.checkBalance address
+			auth = {:username => @user, :password => @password}
+	 		options = {
+	 			:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+	 			:basic_auth => auth,
+	 			:body => [ {"method":"getaddressbalances","params":[address],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+	 		}
+	 		response = HTTParty.get(@url, options)
+	 		out = response.parsed_response
+			balance = out[0]['result'][0]['qty']
+	 		return balance;																						# Returns balance of a particular node address
+		end
+
+		# Function to import address on RecordsKeeper Blockchain
+		def self.importAddress public_address
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"importaddress","params":[public_address, " ", false],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			result = out[0]['result']
+			error = out[0]['error']
+			if result.nil? && error.nil?
+				resp = "Address successfully imported"												 # Prints that address has been succesfully imported
+			elsif result.nil? && error!= nil
+				resp = out[0]['error']['message']
+			else
+				resp = 0
+			end
+			return resp;
+		end
+
+	end
+end