nis-ruby 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93f3eeb5532cbd0ab950c6813e000a5400f5014c
-  data.tar.gz: bf31058b27c37de8a80a53e152a0e3cc38fbdc84
+  metadata.gz: 59a90524a4fe746f16a6fafe9d971f266d0b61e4
+  data.tar.gz: 56759ab22da26c82ce149a160d0265e7ac49638c
 SHA512:
-  metadata.gz: 7c03543c6cfc51d0b46a4077a19cd44a97d87eee619f3ab95b42017a8f7e32911f5cc76a5047fba0e3d24ea11035916529491bd21f9b105a0866ed1c948ab9a9
-  data.tar.gz: 66b59428d40eab12063847cded5fac1ab1bcf27b2cb00f3da1417b9e5e334534267ec32ad8010d606605101fe538a8ff9214dc175a57a764c8be767e96bf26cc
+  metadata.gz: 1860f26e59c0bfe83b9f6aec5f904de94c65448dc7a8a286d92ab0506ad55a3f338985f9fb70a0465f945dbe4ceed7a85b55f9d87f6f60c1c6edaad3242eb4a8
+  data.tar.gz: a6d46edcbf71a03f5fe9d5221912d49184ec841f3fc04630d8db97649bb0da28320e08d02ef7d3855ab17302c4a17cb2d0d08958b46d960b7300ff66c05b7a43

data/README.md

@@ -9,15 +9,16 @@
 
 Ruby client library for the NEM Infrastructure Server(NIS) API.
 
-- [NEM \- Distributed Ledger Technology \(Blockchain\)](https://www.nem.io/)
-- [NEM NIS API Documentation](https://nemproject.github.io/)
-- [NEM Forum](https://forum.nem.io/)
-
 *The gem is under development. Incompatible changes can be made.*
 
-*Do a thorough test on testnet before you use this gem on production.*
+*Not recommended for production use because of lack of testing, needed more improvement.*
+
+For further development of nem with ruby, [feel free to send me your feedback!](#feedback-and-contact)
 
-- [NEM Testnet Faucet \- You can get Testnet XEM for development / testing.](http://test-nem-faucet.44uk.net/)
+* [NEM \- Distributed Ledger Technology \(Blockchain\)](https://www.nem.io/)
+* [NEM NIS API Documentation](https://nemproject.github.io/)
+* [NEM Forum](https://forum.nem.io/)
+* [NEM Testnet Faucet \- You can get Testnet XEM for development / testing.](http://test-nem-faucet.44uk.net/)
 
 ## Installation
 
@@ -42,6 +43,11 @@ More specific example codes are in **[examples/](examples/)** directory.
 ```ruby
 require 'rubygems'
 require 'nis'
+# turn on output request information
+Nis.logger.level = Logger::DEBUG
+
+A_PRIVATE_KEY = '__put_your_private_key__'
+
 nis = Nis.new
 
 nis.heartbeat
@@ -52,11 +58,12 @@ nis.status
 # => {code: 6, type: 4, message: "status"}
 # See https://nemproject.github.io/#status-request
 
-kp = Nis::Keypair.new(SENDER_PRIV_KEY)
+kp = Nis::Keypair.new(A_PRIVATE_KEY)
 tx = Nis::Transaction::Transfer.new(
   RECIPIENT_ADDRESS,
   1, # send 1xem
-  'Message'
+  'Message',
+  network: :testnet # :mainnet (default is :testnet)
 )
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 # Request to local node.
@@ -65,7 +72,8 @@ nis.transaction_prepare_announce(req)
 # => {innerTransactionHash: {}, code: 1, type: 1, message: "SUCCESS", transactionHash: {data: "9da41fd6c6886740ae6a15c869df0470015d78103e5b216971aa09fdbcce9cde"}}
 
 # Request to remote node.
-# nis = Nis.new(host: '104.128.226.60')
+# nis = Nis.new(host: '23.228.67.85')
+# req = Nis::Request::Announce.new(tx, kp)
 # nis.transaction_announce(req)
 ```
 
@@ -89,22 +97,6 @@ nis.request(:post, '/account/unlock',
 # See https://nemproject.github.io/#locking-and-unlocking-accounts
 ```
 
-## Commandline
-
-```bash
-$ nis status
-# => {"code":6,"type":4,"message":"status"}
-
-$ nis heartbeat
-# => {"code":1,"type":2,"message":"ok"}
-
-$ nis request get account/get --params=address:TALICELCD3XPH4FFI5STGGNSNSWPOTG5E4DS2TOS
-# => [AccountMetaDataPair structure]
-
-$ nis request get account/harvests --params=address:TALICELCD3XPH4FFI5STGGNSNSWPOTG5E4DS2TOS hash:81d52a7df4abba8bb1613bcc42b6b93cf3114524939035d88ae8e864cd2c34c8
-# => [Array <HervestInfo structure>]
-```
-
 ## Connection
 
 You can choose nodes from [NEM Node Rewards](https://supernodes.nem.io/).
@@ -113,32 +105,50 @@ You can choose nodes from [NEM Node Rewards](https://supernodes.nem.io/).
 
 ```ruby
 # Passing hostname
-Nis.new(host: '104.128.226.60')
+Nis.new(host: '23.228.67.85')
 
 # Passing url
-Nis.new(url: 'http://104.128.226.60:7890')
+Nis.new(url: 'http://23.228.67.85:7890')
 ```
 
 ### Environment Variable
 
 ```bash
-$ export NIS_URL=http://104.128.226.60:7890
-$ nis heartbeat # => {"code":1,"type":2,"message":"ok"}
+$ export NIS_URL=http://23.228.67.85:7890
 ```
 
 Environment variable used as default value.
 
-## For More Information
+## Logging
 
-* [Documentation for nis-ruby - rubydoc.info](http://www.rubydoc.info/gems/nis-ruby)
+```ruby
+# custom loggin output (default is STDOUT)
+Nis.logger = Logger.new('/path/to/nis-ruby.log')
+# custom log level
+Nis.logger.level = Logger::DEBUG
+
+# or configuration
+Nis.configure do |conf|
+  conf.logger = Logger.new('/path/to/nis-ruby.log')
+  conf.logger.level = Logger::DEBUG
+end
+```
 
-## Contact
+```
+D, [2017-09-26T08:03:54.752718 #78207] DEBUG -- : host:http://127.0.0.1:7890/   method:post     path:/transaction/prepare-announce      params:{:transaction=>{:type=>257, :network=>:testnet, :recipient=>"TA4TX6U5HG2MROAESH2JE5524T4ZOY2EQKQ6ELHF", :amount=>1000000, :message=>{:payload=>"476f6f64206c75636b21", :type=>1}, :fee=>100000, :timeStamp=>78793049, :deadline=>78796649, :version=>2550136833, :signer=>"be2ba9cb15a547110d511a4d43c0482fbb584d78781abac01fb053d18f4a0033"}, :privateKey=>"4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214"}
+```
 
-Feel free to ask me if you have any questions.
+## Feedback and Contact
+
+For further development of nem with ruby, feel free to send me your feedback!
 
 * [@44uk_i3 - Twitter](https://twitter.com/44uk_i3)
 * [44uk/nis-ruby - gitter](https://gitter.im/44uk/nis-ruby)
 
+## For More Information
+
+* [Documentation for nis-ruby - rubydoc.info](http://www.rubydoc.info/gems/nis-ruby)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nis-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/examples/account/generate.rb

@@ -0,0 +1,29 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
+
+keypair = nis.account_generate
+
+p keypair
+
+# Access properties.
+# Names are same API response.
+p keypair.address
+p keypair.privateKey
+p keypair.publicKey
+
+# Ruby style access.
+# Also can be access property by snakecase.
+p keypair.private_key
+p keypair.public_key
+
+# hash like access.
+# Also can be access property like hash.
+p keypair[:privateKey]
+p keypair[:private_key]
+
+# Address object
+# Properties wrapped by value object.
+p address = keypair.address
+p address.testnet?

data/examples/account/get.rb

@@ -0,0 +1,26 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+A_PUBLIC_KEY = 'cc63b4dcdec745417043c3fa0992ec3a1695461a26d90264744648abbd5caa0d'
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.account_get(address: A_ADDRESS)
+p nis.account_get_from_public_key(public_key: A_PUBLIC_KEY)
+
+p nis.account_get_forwarded(address: A_ADDRESS)
+p nis.account_get_forwarded_from_public_key(public_key: A_PUBLIC_KEY)
+
+# /account/get?address={address}
+#   -> account_get address: {address}
+# Passing parameters by keyword arguments.
+account_meta_pair = nis.account_get(address: keypair.address)
+account = account_meta_pair[:account]
+p account.balance
+
+# /account/get/from-public-key?public-key={key}
+#   -> account_get_public_key public_key: {key}
+account_meta_pair = nis.account_get_from_public_key(public_key: keypair.public_key)
+account = account_meta_pair.account
+p account.address

data/examples/account/harvests.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.account_harvests(address: A_ADDRESS)

data/examples/account/historical.rb

@@ -0,0 +1,13 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.account_historical_get(
+  address: A_ADDRESS,
+  start_height: 17592,
+  end_height: 17592,
+  increment: 1
+)

data/examples/account/importances.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.account_importances

data/examples/account/lock.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
+
+nis = Nis.new(host: '23.228.67.85')
+
+nis.account_lock(private_key: A_PRIVATE_KEY)

data/examples/account/mosaic.rb

@@ -0,0 +1,9 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.account_mosaic_definition_page(:address => A_ADDRESS)
+p nis.account_mosaic_owned(address: A_ADDRESS)

data/examples/account/namespace.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.account_namespace_page(:address => A_ADDRESS)

data/examples/account/status.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.account_status(address: A_ADDRESS)

data/examples/account/transfers.rb

@@ -0,0 +1,16 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+# mapped methods
+p nis.account_transfers_incoming(address: A_ADDRESS)
+p nis.account_transfers_outgoing(address: A_ADDRESS)
+p nis.account_transfers_all(address: A_ADDRESS)
+
+# another way
+p nis.account_transfers(:in,  address: A_ADDRESS)
+p nis.account_transfers(:out, address: A_ADDRESS)
+p nis.account_transfers(:all, address: A_ADDRESS)

data/examples/account/unconfirmed_transactions.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.account_unconfirmed_transactions(address: A_ADDRESS)

data/examples/account/unlock.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
+
+nis = Nis.new(host: '23.228.67.85')
+
+nis.account_unlock(private_key: A_PRIVATE_KEY)

data/examples/account/unlocked.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
+
+nis = Nis.new(host: '23.228.67.85')
+
+nis.account_unlock(private_key: A_PRIVATE_KEY)

data/examples/block/at_public.rb

@@ -0,0 +1,4 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+p nis.block_at_public(block_height: 890_761)

data/examples/block/get.rb

@@ -0,0 +1,4 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+p nis.block_get(block_hash: 'fb5e76bf137eb27451926d29fd2b308e672e5d9ec405d9cbcd47cc0f83492cd0')

data/examples/debug/connections.rb

@@ -0,0 +1,13 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
+
+# mapped methods
+p nis.debug_connections_incoming
+p nis.debug_connections_outgoing
+p nis.debug_connections_timers
+
+# another way
+p nis.debug_connections(:in)
+p nis.debug_connections(:out)

data/examples/debug/time_synchronization.rb

@@ -0,0 +1,6 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.debug_time_synchronization

data/examples/local/account_transfers.rb

@@ -0,0 +1,20 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new
+
+page = Nis::Struct::AccountPrivateKeyTransactionsPage.new(
+  value: '00b4a68d16dc505302e9631b860664ba43a8183f0903bc5782a2403b2f9eb3c8a1'
+)
+
+# mapped methods
+p nis.local_account_transfers_incoming(page: page)
+p nis.local_account_transfers_outgoing(page: page)
+p nis.local_account_transfers_all(page: page)
+
+# another way
+p nis.local_account_transfers(:in, page: page)
+p nis.local_account_transfers(:out, page: page)
+p nis.local_account_transfers(:all, page: page)

data/examples/local/chain_blocks_after.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new
+
+p nis.local_chain_blocks_after(block_height: 2_649)

data/examples/namespace/mosaic_definition.rb

@@ -0,0 +1,6 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.namespace_mosaic_definition_page(namespace: 'alice.misc')

data/examples/namespace/root.rb

@@ -0,0 +1,6 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.namespace_root_page

data/examples/nis.rb

@@ -1,23 +1,27 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
 
 # Create NIS instance.
 # By default, connect to local NIS.
 # You also can connect to remote.
-#   Nis.new(host: '50.3.87.123')
-nis = Nis.new
+nis = Nis.new(host: '23.228.67.85')
 
 # API path /heartbeat, /status are mapped into methods.
 # It returns Nis::Struct::NemRequestResult object.
-puts nis.heartbeat.inspect
-puts nis.status.inspect
+p nis.heartbeat.inspect
+p nis.status.inspect
 
 # Also call Nis#request method.
 # The method receive [HTTP Method], [API Path], [Parameters]
 # It returns hash which converted API JSON response.
 
 # Nis#request returns hash,
-puts nis.request :get, 'heartbeat'
-puts nis.request :get, 'status'
+p nis.request :get, 'heartbeat'
+p nis.request :get, 'status'
 
 # Nis#request! can raise Error when NIS returns error.
-puts nis.request! :get, 'account/get', address: 'INVALID_ADDRESS'
+p nis.request! :get, 'account/get', address: 'INVALID_ADDRESS'
+
+# only accept local node
+# nis = Nis.new
+# nis.shutdown