nis-ruby 0.0.6.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d4e1ecc31936813e70872ae8b78baeb7d71586
-  data.tar.gz: dfff3b5f9f8823ba28249f0b7bdd16a07d8e0046
+  metadata.gz: 061a83269fcef596e746171c60d75f215c1ee99c
+  data.tar.gz: 943f352e756874a0622196046708e533c2b43a56
 SHA512:
-  metadata.gz: 240fe29c16e64b9ba77de96e6695faabeebcf740719668dbd3f5ec65f43557f86383d49e0a848ff7d547b29ee5543053fce360d97face0582e1da1b9fb6b59aa
-  data.tar.gz: 6a13e62bc27b7250b382e586fcdc53b4978bbe192102af759027485d6638472b69e3f41b143230cf0d0b6257f04e194afa620546dc9ff380362e227cf2f30de0
+  metadata.gz: 430fbd5bebbfd64f3edef98fca026873a7255b710e987af87dc77bd09597f8111aa3c04e15eb2ef6c0b5f7df91d4636cdff685c02f5d02030cfede35c5d53679
+  data.tar.gz: a32054344daeef7210c1c4dfbadf08629a2fb213d4f209e545ab36dec02bb56e3f308daeaa50f1bfaeabdd37bec75918ea223f5876db1ff4660e4e58aac46542

data/.rubocop.yml

@@ -0,0 +1,119 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  DisabledByDefault: true
+  Exclude:
+    - '**/vendor/**/*'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Style/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Style/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Style/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Style/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Style/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Style/IndentationConsistency:
+  Enabled: true
+
+# Two spaces, no tabs (for indentation).
+Style/IndentationWidth:
+  Enabled: true
+
+Style/SpaceAfterColon:
+  Enabled: true
+
+Style/SpaceAfterComma:
+  Enabled: true
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Style/SpaceAroundKeyword:
+  Enabled: true
+
+Style/SpaceAroundOperators:
+  Enabled: true
+
+Style/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Style/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Style/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Style/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Style/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/demo/request_account.rb

@@ -1,5 +1,5 @@
 require 'nis'
-_hr = '-' * 64
+hr = '-' * 64
 
 # create NIS instance
 nis = Nis.new
@@ -9,32 +9,32 @@ nis = Nis.new
 # Each endpoint mapped into method name.
 # It returns Nis::Struct object which mapped API response.
 keypair = nis.account_generate
-puts _hr
+puts hr
 
 # Access properties.
 # Names are same API response.
 puts keypair.address
 puts keypair.privateKey
 puts keypair.publicKey
-puts _hr
+puts hr
 
 # Ruby style access.
 # Also can be access property by snakecase.
 puts keypair.private_key
 puts keypair.public_key
-puts _hr
+puts hr
 
 # hash like access.
 # Also can be access property like hash.
 puts keypair[:privateKey]
 puts keypair[:private_key]
-puts _hr
+puts hr
 
 # Address object
 # Some property wrapped by value object.
 puts address = keypair.address
 puts address.testnet?
-puts _hr
+puts hr
 
 # /account/get?address={address}
 #   -> account_get address: {address}
@@ -42,11 +42,11 @@ puts _hr
 account_meta_pair = nis.account_get address: keypair.address
 account = account_meta_pair[:account]
 puts account.balance
-puts _hr
+puts hr
 
 # /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
 puts account.address
-puts _hr
+puts hr

data/demo/request_block.rb

@@ -0,0 +1,11 @@
+require 'nis'
+hr = '-' * 64
+
+# create NIS instance
+nis = Nis.new
+
+puts nis.block_at_public(block_height: 895492)
+puts hr
+
+puts nis.block_get(block_hash: '74998229fa8a6eebfce9bcc313c552528bf82caac6166ae05e65578b4fb1f2da')
+puts hr

data/demo/request_debug.rb

@@ -1,6 +1,6 @@
 require 'pp'
 require 'nis'
-_hr = '-' * 64
+hr = '-' * 64
 
 # create NIS instance
 nis = Nis.new
@@ -10,40 +10,33 @@ incoming = nis.debug_connections_incoming
 incoming[:outstanding].each do |ai|
   puts ai.to_hash
 end
-puts _hr
+puts hr
 
 incoming[:most_recent].each do |ai|
   puts ai.to_hash
 end
-puts _hr
-
-
+puts hr
 
 outgoing = nis.debug_connections_outgoing
 
 outgoing[:outstanding].each do |ai|
   puts ai.to_hash
 end
-puts _hr
+puts hr
 
 outgoing[:most_recent].each do |ai|
   puts ai.to_hash
 end
-puts _hr
-
-
+puts hr
 
 timers = nis.debug_connections_timers
 timers.each do |t|
   puts t.to_hash
 end
-puts _hr
-
-
+puts hr
 
 syncs = nis.debug_time_synchronization
 syncs.each do |sync|
   puts sync.to_hash
 end
-puts _hr
-
+puts hr

data/demo/request_local.rb

@@ -0,0 +1,20 @@
+require 'nis'
+hr = '-' * 64
+
+nis = Nis.new
+
+page = Nis::Struct::AccountPrivateKeyTransactionsPage.new(
+  value: '00b4a68d16dc505302e9631b860664ba43a8183f0903bc5782a2403b2f9eb3c8a1'
+)
+
+puts nis.local_account_transfers_incoming(page: page)
+puts hr
+
+puts nis.local_account_transfers_outgoing(page: page)
+puts hr
+
+puts nis.local_account_transfers_all(page: page)
+puts hr
+
+puts nis.local_chain_blocks_after(block_height: 2649)
+puts hr

data/demo/request_namespace.rb

@@ -0,0 +1,11 @@
+require 'nis'
+hr = '-' * 64
+
+# create NIS instance
+nis = Nis.new
+
+puts nis.namespace_mosaic_definition_page(namespace: 'alice.misc')
+puts hr
+
+puts nis.namespace_root_page
+puts hr

data/demo/request_nis.rb

@@ -21,4 +21,3 @@ puts nis.request :get, 'status'
 
 # Nis#request! can raise Error when NIS returns error.
 puts nis.request! :get, 'account/get', address: 'INVALID_ADDRESS'
-

data/demo/request_node.rb

@@ -0,0 +1,31 @@
+require 'nis'
+hr = '-' * 64
+
+# create NIS instance
+nis = Nis.new
+
+puts nis.node_info
+puts hr
+
+puts nis.node_extended_info
+puts hr
+
+puts nis.node_experiences
+puts hr
+
+puts nis.node_peerlist_all
+puts hr
+
+puts nis.node_peerlist_reachable
+puts hr
+
+puts nis.node_peerlist_active
+puts hr
+
+puts nis.node_active_peers_max_chain_height
+puts hr
+
+# bnr = Nis::Struct::BootNodeRequest.new(
+# )
+# puts nis.node_boot(boot_node_request: bnr)
+# puts hr

data/demo/request_transaction.rb

@@ -1,6 +1,5 @@
 require 'nis'
-require 'pry'
-_hr = '-' * 64
+hr = '-' * 64
 
 # Account A (Source)
 A_ADDRESS = 'TAH4MBR6MNLZKJAVW5ZJCMFAL7RS5U2YODUQKLCT'.freeze
@@ -36,14 +35,14 @@ rpa = Nis::Struct::RequestPrepareAnnounce.new(
 nis = Nis.new
 
 # check banalces before sending XEM.
-puts "Account A => balance: %d" %
+puts 'Account A => balance: %d' %
   (nis.account_get address: A_ADDRESS)[:account][:balance]
-puts "Account B => balance: %d" %
+puts 'Account B => balance: %d' %
   (nis.account_get address: B_ADDRESS)[:account][:balance]
-puts _hr
+puts hr
 
 # Send XEM request.
-# res = nis.transaction_prepare_announce(request_prepare_announce: rpa)
-# puts res.message
+res = nis.transaction_prepare_announce(request_prepare_announce: rpa)
+puts res.message
 
 # After several minutes, check to see Account B received XEM.

data/lib/nis/client.rb

@@ -31,7 +31,7 @@ class Nis::Client
   # @param [Hash] params API Parameters
   # @return [Hash] Hash converted API Response
   def request(method, path, params = {})
-    if params.is_a?(Hash) and !params.empty?
+    if params.is_a?(Hash) && !params.empty?
       params.reject! { |_, value| value.nil? }
     end
     res = connection.send(method, path, params)

data/lib/nis/endpoint/account/get.rb

@@ -1,6 +1,6 @@
 module Nis::Endpoint
   module Account::Get
-    # @option options [String] address
+    # @param [String] address
     # @return [Nis::Struct::AccountMetaDataPair]
     # @see http://bob.nem.ninja/docs/#requesting-the-account-data
     def account_get(address:)
@@ -11,7 +11,7 @@ module Nis::Endpoint
       end
     end
 
-    # @option options [String] public_key
+    # @param [String] public_key
     # @return [Nis::Struct::AccountMetaDataPair]
     # @see http://bob.nem.ninja/docs/#requesting-the-account-data
     def account_get_from_public_key(public_key:)
@@ -22,7 +22,7 @@ module Nis::Endpoint
       end
     end
 
-    # @option options [String] address
+    # @param [String] address
     # @return [Nis::Struct::AccountMetaDataPair]
     # @see http://bob.nem.ninja/docs/#requesting-the-original-account-data-for-a-delegate-account
     def account_get_forwarded(address:)
@@ -33,7 +33,7 @@ module Nis::Endpoint
       end
     end
 
-    # @option options [String] public_key
+    # @param [String] public_key
     # @return [Nis::Struct::AccountMetaDataPair] delegate account
     # @see http://bob.nem.ninja/docs/#requesting-the-original-account-data-for-a-delegate-account
     def account_get_forwarded_from_public_key(public_key:)

data/lib/nis/endpoint/account/harvests.rb

@@ -1,7 +1,7 @@
 module Nis::Endpoint
   module Account::Harvests
-    # @option options [String] address
-    # @option options [String] hash
+    # @param [String] address
+    # @param [String] hash
     # @return [Array <Nis::Struct::HarvestInfo>]
     # @see http://bob.nem.ninja/docs/#requesting-harvest-info-data-for-an-account
     def account_harvests(address:, hash: nil)
@@ -9,7 +9,7 @@ module Nis::Endpoint
         address: address,
         hash: hash
       ) do |res|
-        res[:data].map{|hvst| Nis::Struct::HarvestInfo.build(hvst) }
+        res[:data].map { |hvst| Nis::Struct::HarvestInfo.build(hvst) }
       end
     end
   end

data/lib/nis/endpoint/account/historical.rb

@@ -1,9 +1,9 @@
 module Nis::Endpoint
   module Account::Historical
-    # @option options [String] address
-    # @option options [Integer] start_height
-    # @option options [Integer] end_height
-    # @option options [Integer] increment
+    # @param [String] address
+    # @param [Integer] start_height
+    # @param [Integer] end_height
+    # @param [Integer] increment
     # @return [Array <Nis::Struct::AccountHistoricalDataViewModel>]
     # @see http://bob.nem.ninja/docs/#retrieving-historical-account-data
     def account_historical_get(address:, start_height:, end_height:, increment:)
@@ -13,7 +13,7 @@ module Nis::Endpoint
         endHeight: end_height,
         increment: increment
       ) do |res|
-        res[:data].map{|ahdvm| Nis::Struct::AccountHistoricalDataViewModel(ahdvm) }
+        res[:data].map { |ahdvm| Nis::Struct::AccountHistoricalDataViewModel(ahdvm) }
       end
     end
   end

data/lib/nis/endpoint/account/lock.rb

@@ -1,6 +1,6 @@
 module Nis::Endpoint
   module Account::Lock
-    # @option options [String] private_key
+    # @param private_key [String]
     # @return [nil]
     # @see http://bob.nem.ninja/docs/#locking-and-unlocking-accounts
     def account_lock(private_key:)

data/lib/nis/endpoint/account/mosaic.rb

@@ -1,8 +1,8 @@
 module Nis::Endpoint
   module Account::Mosaic
-    # @option options [String] address
-    # @option options [String] parent
-    # @option options [String] id
+    # @param [String] address
+    # @param [String] parent
+    # @param [String] id
     # @return [Array <Nis::Struct::MosaicDefinition>]
     # @see http://bob.nem.ninja/docs/##retrieving-mosaic-definitions-that-an-account-has-created
     def account_mosaic_definition_page(address:, parent: nil, id: nil)
@@ -15,7 +15,7 @@ module Nis::Endpoint
       end
     end
 
-    # @option options [String] address
+    # @param [String] address
     # @return [Array <Nis::Struct::AccountMetaDataPair>]
     # @see http://bob.nem.ninja/docs/#retrieving-mosaics-that-an-account-owns
     def account_mosaic_owned(address:)

data/lib/nis/endpoint/account/namespace.rb

@@ -1,9 +1,9 @@
 module Nis::Endpoint
   module Account::Namespace
-    # @option options [String] :address
-    # @option options [String] :parent
-    # @option options [String] :id
-    # @option options [Integer] :page_size
+    # @param [String] address
+    # @param [String] parent
+    # @param [String] id
+    # @param [Integer] page_size
     # @return [Array <Nis::Struct::Namespace>]
     # @see http://bob.nem.ninja/docs/#retrieving-namespaces-that-an-account-owns
     def account_namespace_page(address:, parent: nil, id: nil, page_size: nil)
@@ -13,7 +13,7 @@ module Nis::Endpoint
         id: id,
         pageSize: page_size
       ) do |res|
-        res[:data].map{|ns| Nis::Struct::Namespace.build(ns) }
+        res[:data].map { |ns| Nis::Struct::Namespace.build(ns) }
       end
     end
   end

data/lib/nis/endpoint/account/status.rb

@@ -1,6 +1,6 @@
 module Nis::Endpoint
   module Account::Status
-    # @option options [String] :address
+    # @param [String] address
     # @return [AccountMetaData]
     # @see http://bob.nem.ninja/docs/#requesting-the-account-status
     def account_status(address:)

data/lib/nis/endpoint/account/transfers.rb

@@ -1,8 +1,8 @@
 module Nis::Endpoint
   module Account::Transfers
-    # @option options [String] :address
-    # @option options [String] :hash
-    # @option options [String] :id
+    # @param [String] address
+    # @param [String] hash
+    # @param [String] id
     # @return [Array <Nis::Struct::TransactionMetaDataPair>]
     # @see http://bob.nem.ninja/docs/#requesting-transaction-data-for-an-account
     def account_transfers_incoming(address:, hash: nil, id: nil)
@@ -11,13 +11,13 @@ module Nis::Endpoint
         hash: hash,
         id: id
       ) do |res|
-        res[:data].map{|tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
+        res[:data].map { |tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
       end
     end
 
-    # @option options [String] :address
-    # @option options [String] :hash
-    # @option options [String] :id
+    # @param [String] address
+    # @param [String] hash
+    # @param [String] id
     # @return [Array <Nis::Struct::TransactionMetaDataPair>]
     # @see http://bob.nem.ninja/docs/#requesting-transaction-data-for-an-account
     def account_transfers_outgoing(address:, hash: nil, id: nil)
@@ -26,13 +26,13 @@ module Nis::Endpoint
         hash: hash,
         id: id
       ) do |res|
-        res[:data].map{|tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
+        res[:data].map { |tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
       end
     end
 
-    # @option options [String] :address
-    # @option options [String] :hash
-    # @option options [String] :id
+    # @param [String] address
+    # @param [String] hash
+    # @param [String] id
     # @return [Array <Nis::Struct::TransactionMetaDataPair>]
     # @see http://bob.nem.ninja/docs/#requesting-transaction-data-for-an-account
     def account_transfers_all(address:, hash: nil, id: nil)
@@ -41,7 +41,7 @@ module Nis::Endpoint
         hash: hash,
         id: id
       ) do |res|
-        res[:data].map{|tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
+        res[:data].map { |tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
       end
     end
   end

data/lib/nis/endpoint/account/unconfirmed_transactions.rb

@@ -1,11 +1,16 @@
 module Nis::Endpoint
   module Account::UnconfirmedTransactions
-    # @option options [String] address
+    # @param [String] address
     # @return [Array <Nis::Struct::UnconfirmedTransactionMetaDataPair>]
     # @see http://bob.nem.ninja/docs/#requesting-transaction-data-for-an-account
     def account_unconfirmed_transactions(address:)
       request!(:get, '/account/unconfirmedTransactions', address: address) do |res|
-        res[:data].map { |utmdp| Nis::Struct::UnconfirmedTransactionMetaDataPair.build(utmdp) }
+        res[:data].map do |utmdp|
+          Nis::Struct::UnconfirmedTransactionMetaDataPair.build(
+            meta: utmdp[:meta],
+            transaction: utmdp[:data]
+          )
+        end
       end
     end
   end

data/lib/nis/endpoint/account/unlock.rb

@@ -1,6 +1,6 @@
 module Nis::Endpoint
   module Account::Unlock
-    # @option options [String] private_key
+    # @param [String] private_key
     # @return [nil]
     # @see http://bob.nem.ninja/docs/#locking-and-unlocking-accounts
     def account_unlock(private_key:)

data/lib/nis/endpoint/block/at.rb

@@ -0,0 +1,10 @@
+module Nis::Endpoint
+  module Block::At
+    # @param [Integer] block_height
+    # @return [Nis::Struct::Block]
+    # @see http://bob.nem.ninja/docs/#getting-a-block-with-a-given-height
+    def block_at_public(block_height:)
+      Nis::Struct::Block.build request!(:post, '/block/at/public', height: block_height)
+    end
+  end
+end

data/lib/nis/endpoint/block/get.rb

@@ -0,0 +1,10 @@
+module Nis::Endpoint
+  module Block::Get
+    # @param [String] block_hash
+    # @return [Nis::Struct::Block]
+    # @see http://bob.nem.ninja/docs/#requesting-parts-of-the-block-chain
+    def block_get(block_hash:)
+      Nis::Struct::Block.build request!(:get, '/block/get', blockHash: block_hash)
+    end
+  end
+end

data/lib/nis/endpoint/block.rb

@@ -0,0 +1,4 @@
+module Nis::Endpoint
+  module Block
+  end
+end

data/lib/nis/endpoint/chain/height.rb

@@ -0,0 +1,11 @@
+module Nis::Endpoint
+  module Chain
+    module Height
+      # @return [Nis::Struct::BlockHeight]
+      # @see http://bob.nem.ninja/docs/#block-chain-height
+      def chain_height
+        Nis::Struct::BlockHeight.build request!(:get, '/chain/height')
+      end
+    end
+  end
+end

data/lib/nis/endpoint/chain/last_block.rb

@@ -0,0 +1,14 @@
+module Nis::Endpoint
+  module Chain
+    module LastBlock
+      # @return [Nis::Struct::Block]
+      # @see http://bob.nem.ninja/docs/#last-block-of-the-block-chain-score
+      def chain_last_block
+        request!(:get, '/chain/last-block') do |res|
+          res[:transactions] = res[:transactions].map { |t| Nis::Struct::Transaction.new(t) }
+          Nis::Struct::Block.build res
+        end
+      end
+    end
+  end
+end

data/lib/nis/endpoint/chain/score.rb

@@ -0,0 +1,11 @@
+module Nis::Endpoint
+  module Chain
+    module Score
+      # @return [Nis::Struct::BlockScore]
+      # @see http://bob.nem.ninja/docs/#block-chain-score
+      def chain_score
+        Nis::Struct::BlockScore.build request!(:get, '/chain/score')
+      end
+    end
+  end
+end