nis-ruby 0.0.6.1 → 0.0.7

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

@@ -0,0 +1,34 @@
+module Nis::Endpoint
+  module Local
+    module Account
+      module Transfers
+        # @param [Nis::Struct::AccountPrivateKeyTransactionsPage] page
+        # @return [Array <Nis::Struct::TransactionMetaDataPair>]
+        # @see http://bob.nem.ninja/docs/#transaction-data-with-decoded-messages
+        def local_account_transfers_incoming(page:)
+          request!(:post, '/local/account/transfers/incoming', page) do |res|
+            res[:data].map { |tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
+          end
+        end
+
+        # @param [Nis::Struct::AccountPrivateKeyTransactionsPage] page
+        # @return [Array <Nis::Struct::TransactionMetaDataPair>]
+        # @see http://bob.nem.ninja/docs/#transaction-data-with-decoded-messages
+        def local_account_transfers_outgoing(page:)
+          request!(:post, '/local/account/transfers/outgoing', page) do |res|
+            res[:data].map { |tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
+          end
+        end
+
+        # @param [Nis::Struct::AccountPrivateKeyTransactionsPage] page
+        # @return [Array <Nis::Struct::TransactionMetaDataPair>]
+        # @see http://bob.nem.ninja/docs/#transaction-data-with-decoded-messages
+        def local_account_transfers_all(page:)
+          request!(:post, '/local/account/transfers/all', page) do |res|
+            res[:data].map { |tmdp| Nis::Struct::TransactionMetaDataPair.build(tmdp) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Nis::Endpoint
+  module Local
+    module Chain
+      # @param [String] block_height
+      # @return [Array <Nis::Struct::Block>]
+      # @see http://bob.nem.ninja/docs/#getting-part-of-a-chain
+      def local_chain_blocks_after(block_height:)
+        request!(:post, '/local/chain/blocks-after',
+          height: block_height
+        ) do |res|
+          res[:data].map { |ebvm| Nis::Struct::ExplorerBlockViewModel.build(ebvm) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Nis::Endpoint
+  module Namespace::Mosaic
+    # @return [Array <Nis::Struct::MosaicDefinitionMetaDataPair>]
+    # @see http://bob.nem.ninja/docs/#retrieving-mosaic-definitions
+    def namespace_mosaic_definition_page(namespace:, id: nil, page_size: nil)
+      request!(:get, '/namespace/mosaic/definition/page',
+        namespace: namespace,
+        id: id,
+        pageSize: page_size
+      ) do |res|
+        res[:data].map { |mdmdp| Nis::Struct::MosaicDefinitionMetaDataPair.build(mdmdp) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Nis::Endpoint
+  module Namespace::Root
+    # @return [Array <Nis::Struct::NamespaceMetaDataPair>]
+    # @see http://bob.nem.ninja/docs/#retrieving-root-namespaces
+    def namespace_root_page(id: nil, page_size: nil)
+      request!(:get, '/namespace/root/page',
+        id: id,
+        pageSize: page_size
+      ) do |res|
+        res[:data].map { |nsmdp| Nis::Struct::NamespaceMetaDataPair.build(nsmdp) }
+      end
+    end
+  end
+end

data/lib/nis/endpoint/namespace.rb

@@ -0,0 +1,10 @@
+module Nis::Endpoint
+  module Namespace
+    # @param [String] namespace
+    # @return [Nis::Struct::Namespace]
+    # @see http://bob.nem.ninja/docs/#retrieving-a-specific-namespace
+    def namespace(namespace:)
+      Nis::Struct::Namespace.build request!(:get, '/namespace', namespace: namespace)
+    end
+  end
+end

data/lib/nis/endpoint/node/active_peers.rb

@@ -0,0 +1,11 @@
+module Nis::Endpoint
+  module Node::ActivePeers
+    # @return [Nis::Struct::NodeInfo]
+    # @see http://bob.nem.ninja/docs/#maximum-chain-height-in-the-active-neighborhood
+    def node_active_peers_max_chain_height
+      request!(:get, '/node/active-peers/max-chain-height') do |res|
+        Nis::Struct::BlockHeight.build res
+      end
+    end
+  end
+end

data/lib/nis/endpoint/node/boot.rb

@@ -0,0 +1,10 @@
+module Nis::Endpoint
+  module Node::Boot
+    # @param boot_node_request [Nis::Struct::BootNodeRequest]
+    # @return [nil]
+    # @see http://bob.nem.ninja/docs/#booting-the-local-node
+    def node_boot(boot_node_request:)
+      request!(:post, '/node/boot', boot_node_request: boot_node_request)
+    end
+  end
+end

data/lib/nis/endpoint/node/experiences.rb

@@ -0,0 +1,9 @@
+module Nis::Endpoint
+  module Node::Experiences
+    # @return [Nis::Struct::ExtendedNodeExperiencePair]
+    # @see http://bob.nem.ninja/docs/#requesting-node-experiences
+    def node_experiences
+      Nis::Struct::ExtendedNodeExperiencePair.build request!(:get, '/node/experiences')
+    end
+  end
+end

data/lib/nis/endpoint/node/extended_info.rb

@@ -0,0 +1,9 @@
+module Nis::Endpoint
+  module Node::ExtendedInfo
+    # @return [Nis::Struct::NodeInfo]
+    # @see http://bob.nem.ninja/docs/#extended-node-information
+    def node_extended_info
+      Nis::Struct::NisNodeInfo.build request!(:get, '/node/extended-info')
+    end
+  end
+end

data/lib/nis/endpoint/node/info.rb

@@ -0,0 +1,9 @@
+module Nis::Endpoint
+  module Node::Info
+    # @return [Nis::Struct::NodeInfo]
+    # @see http://bob.nem.ninja/docs/#basic-node-information
+    def node_info
+      Nis::Struct::NodeInfo.build request!(:get, '/node/info')
+    end
+  end
+end

data/lib/nis/endpoint/node/peer_list.rb

@@ -0,0 +1,25 @@
+module Nis::Endpoint
+  module Node::PeerList
+    # @return [Nis::Struct::NodeCollection]
+    # @see http://bob.nem.ninja/docs/#complete-neighborhood
+    def node_peerlist_all
+      Nis::Struct::NodeCollection.build request!(:get, '/node/peer-list/all')
+    end
+
+    # @return [Array <Nis::Struct::NodeInfo>]
+    # @see http://bob.nem.ninja/docs/#reachable-neighborhood
+    def node_peerlist_reachable
+      request!(:get, '/node/peer-list/reachable') do |res|
+        res[:data].map { |n| Nis::Struct::NodeInfo.build(n) }
+      end
+    end
+
+    # @return [Array <Nis::Struct::NodeInfo>]
+    # @see http://bob.nem.ninja/docs/#active-neighborhood
+    def node_peerlist_active
+      request!(:get, '/node/peer-list/active') do |res|
+        res[:data].map { |n| Nis::Struct::NodeInfo.build(n) }
+      end
+    end
+  end
+end

data/lib/nis/endpoint/node.rb

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

data/lib/nis/endpoint/transaction/announce.rb

@@ -1,6 +1,6 @@
 module Nis::Endpoint
   module Transaction::Announce
-    # @option options [Nis::Struct::RequestAnnounce]
+    # @param [Nis::Struct::RequestAnnounce] request_announce
     # @return [Nis::Struct::NodeInfo]
     # @see http://bob.nem.ninja/docs/#sending-the-data-to-NIS
     def transaction_announce(request_announce:)

data/lib/nis/endpoint/transaction/prepareAnnounce.rb

@@ -1,6 +1,6 @@
 module Nis::Endpoint
   module Transaction::PrepareAnnounce
-    # @option options [Nis::Struct::RequestPrepareAnnounce]
+    # @param [Nis::Struct::RequestPrepareAnnounce] request_prepare_announce
     # @return [Nis::Struct::NodeInfo]
     # @see http://bob.nem.ninja/docs/#initiating-a-transaction
     def transaction_prepare_announce(request_prepare_announce:)

data/lib/nis/error.rb

@@ -1,5 +1,6 @@
 class Nis
   class Error < StandardError; end
+  class NotFoundError < Error; end
   class BadRequestError < Error; end
   class InternalServerError < Error; end
 end

data/lib/nis/struct/account_meta_data.rb

@@ -1,7 +1,7 @@
 class Nis::Struct
   # @attr [String] status
   # @attr [String] remoteStatus
-  # @attr [Array <Nis::Struct::AccountInfo>] cosignatory_of
+  # @attr [Array <Nis::Struct::AccountInfo>] cosignatoryOf
   # @attr [Array <Nis::Struct::AccountInfo>] cosignatories
   # @see http://bob.nem.ninja/docs/#accountMetaData
   class AccountMetaData

data/lib/nis/struct/account_meta_data_pair.rb

@@ -1,15 +1,15 @@
 class Nis::Struct
-  # @attr [AccountInfo] address
+  # @attr [AccountInfo] account
   # @attr [AccountMetaData] meta
   # @see http://bob.nem.ninja/docs/#accountMetaDataPair
   class AccountMetaDataPair
     include Nis::Util::Assignable
     attr_accessor :account, :meta
 
-    def self.build(account:, meta:)
+    def self.build(meta:, account:)
       new(
-        account: AccountInfo.build(account),
-        meta: AccountMetaData.build(meta)
+        meta: AccountMetaData.build(meta),
+        account: AccountInfo.build(account)
       )
     end
   end

data/lib/nis/struct/account_private_key_transactions_page.rb

@@ -0,0 +1,14 @@
+class Nis::Struct
+  # @attr [String] value
+  # @attr [String] hash
+  # @attr [Integer] id
+  # @see http://bob.nem.ninja/docs/#accountPrivateKeyTransactionsPage
+  class AccountPrivateKeyTransactionsPage
+    include Nis::Util::Assignable
+    attr_accessor :value, :hash, :id
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/application_meta_data.rb

@@ -0,0 +1,21 @@
+class Nis::Struct
+  # @attr [Integer] currentTime
+  # @attr [String] application
+  # @attr [Integer] startTime
+  # @attr [String] version
+  # @attr [String] signer
+  # @see http://bob.nem.ninja/docs/#applicationMetaData
+  class ApplicationMetaData
+    include Nis::Util::Assignable
+    attr_accessor :currentTime, :application, :startTime, :version, :signer
+
+    alias :current_time :currentTime
+    alias :current_time= :currentTime=
+    alias :start_time :startTime
+    alias :start_time= :startTime=
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/block.rb

@@ -0,0 +1,24 @@
+class Nis::Struct
+  # @attr [Integer] timeStamp
+  # @attr [String] signature
+  # @attr [String] prevBlockHash
+  # @attr [Integer] type
+  # @attr [Array <Nis::Struct::transaction>] transactions
+  # @attr [Integer] version
+  # @attr [String] signer
+  # @attr [Integer] height
+  # @see http://bob.nem.ninja/docs/#block
+  class Block
+    include Nis::Util::Assignable
+    attr_accessor :timeStamp, :signature, :prevBlockHash, :type, :transactions, :version, :signer, :height
+
+    alias :timestamp :timeStamp
+    alias :timestamp= :timeStamp=
+    alias :prev_block_hash :prevBlockHash
+    alias :prev_block_hash= :prevBlockHash=
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/block_height.rb

@@ -0,0 +1,22 @@
+class Nis::Struct
+  # @attr [Integer] height
+  # @see http://bob.nem.ninja/docs/#blockHeight
+  class BlockHeight
+    include Nis::Util::Assignable
+    attr_accessor :height
+
+    def self.build(attrs)
+      new(attrs)
+    end
+
+    # @return [Integer]
+    def to_i
+      @height
+    end
+
+    # @return [String]
+    def to_s
+      @height.to_s
+    end
+  end
+end

data/lib/nis/struct/block_score.rb

@@ -0,0 +1,17 @@
+class Nis::Struct
+  # @attr [String] score
+  # @see http://bob.nem.ninja/docs/#blockChainScore
+  class BlockScore
+    include Nis::Util::Assignable
+    attr_accessor :score
+
+    def self.build(attrs)
+      new(attrs)
+    end
+
+    # @return [String]
+    def to_s
+      @score
+    end
+  end
+end

data/lib/nis/struct/boot_node_request.rb

@@ -0,0 +1,23 @@
+class Nis::Struct
+  # @attr [String] metaData
+  # @attr [String] application
+  # @attr [String] endpoint
+  # @attr [String] protocol
+  # @attr [String] port
+  # @attr [String] host
+  # @attr [String] identity
+  # @attr [String] private_key
+  # @attr [String] name
+  # @see http://bob.nem.ninja/docs/#bootNodeRequest
+  class BootNodeRequest
+    include Nis::Util::Assignable
+    attr_accessor :metaData, :application, :endpoint, :protocol, :port, :host, :identity, :private_key, :name
+
+    alias metadata metaData
+    alias metadata= metaData=
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/error.rb

@@ -0,0 +1,18 @@
+class Nis::Struct
+  # @attr [Integer] timeStamp
+  # @attr [String] error
+  # @attr [String] message
+  # @attr [Integer] status
+  # @see http://bob.nem.ninja/docs/#error-object
+  class Error
+    include Nis::Util::Assignable
+    attr_accessor :timeStamp, :error, :message, :status
+
+    alias :timestamp :timeStamp
+    alias :timestamp= :timeStamp=
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/explorer_block_view_model.rb

@@ -0,0 +1,17 @@
+class Nis::Struct
+  # @attr [Array <Nis::Struct::ExplorerTransferViewModel>] txes
+  # @attr [Nis::Struct::Block] block
+  # @attr [String] hash
+  # @attr [String] difficulty
+  # @see http://bob.nem.ninja/docs/#explorerBlockViewModel
+  class ExplorerBlockViewModel
+    include Nis::Util::Assignable
+    attr_accessor :txes, :block, :hash, :difficulty
+
+    def self.build(attrs)
+      attrs[:txes] = attrs[:txes].map { |tx| ExplorerTransferViewModel.build(tx) }
+      attrs[:block] = Block.build(attrs[:block])
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/explorer_transfer_view_model.rb

@@ -0,0 +1,18 @@
+class Nis::Struct
+  # @attr [Nis::Struct::Transaction] tx
+  # @attr [String] hash
+  # @attr [String] innerHash
+  # @see http://bob.nem.ninja/docs/#explorerTransferViewModel
+  class ExplorerTransferViewModel
+    include Nis::Util::Assignable
+    attr_accessor :tx, :hash, :innerHash
+
+    alias inner_hash innerHash
+    alias inner_hash= innerHash=
+
+    def self.build(attrs)
+      attrs[:tx] = Transaction.build(attrs[:tx])
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/explorer_view_model_transaction.rb

@@ -0,0 +1,16 @@
+class Nis::Struct
+  # @attr [Array <Nis::Struct::Transaction>] txes
+  # @attr [String] block
+  # @attr [String] hash
+  # @see http://bob.nem.ninja/docs/#explorerViewModelTransaction
+  class ExplorerViewModelTransaction
+    include Nis::Util::Assignable
+    attr_accessor :txes, :block, :hash
+
+    def self.build(attrs)
+      attrs[:txes] = attrs[:txes].map { |tx| Transaction.build(tx) }
+      attrs[:block] = Block.build(attrs[:block])
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/extended_node_experience_pair.rb

@@ -0,0 +1,14 @@
+class Nis::Struct
+  # @attr [Nis::Struct::NodeInfo] node
+  # @attr [Integer] syncs
+  # @attr [Nis::Struct::NodeExperience] experience
+  # @see http://bob.nem.ninja/docs/#extendedNodeExperiencePair
+  class ExtendedNodeExperiencePair
+    include Nis::Util::Assignable
+    attr_accessor :node, :syncs, :experiences
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/harvest_info.rb

@@ -1,8 +1,8 @@
 class Nis::Struct
-  # @attr [Integer] timestamp
+  # @attr [Integer] timeStamp
   # @attr [String] id
   # @attr [Integer] difficulty
-  # @attr [Integer] total_fee
+  # @attr [Integer] totalFee
   # @attr [Integer] height
   # @see http://bob.nem.ninja/docs/#harvestInfo
   class HarvestInfo

data/lib/nis/struct/mosaic_definition.rb

@@ -10,7 +10,9 @@ class Nis::Struct
     attr_accessor :creator, :id, :description, :properties, :levy
 
     def self.build(attrs)
+      attrs[:id] = MosaicId.build(attrs[:id])
       attrs[:properties] = attrs[:properties].map { |p| MosaicProperties.build(p) }
+      attrs[:levy] = MosaicLevy.build(attrs[:levy]) if attrs[:levy]
       new(attrs)
     end
   end

data/lib/nis/struct/mosaic_definition_meta_data.rb

@@ -0,0 +1,12 @@
+class Nis::Struct
+  # @attr [Integer] id
+  # @see http://bob.nem.ninja/docs/#mosaicDefinitionMetaData
+  class MosaicDefinitionMetaData
+    include Nis::Util::Assignable
+    attr_accessor :id
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/mosaic_definition_meta_data_pair.rb

@@ -0,0 +1,16 @@
+class Nis::Struct
+  # @attr [Nis::Struct::MosaicMetaData] meta
+  # @attr [Nis::Struct::Mosaic] mosaic
+  # @see http://bob.nem.ninja/docs/#mosaicDefinitionMetaDataPair
+  class MosaicDefinitionMetaDataPair
+    include Nis::Util::Assignable
+    attr_accessor :meta, :mosaic
+
+    def self.build(attrs)
+      new(
+        meta:   MosaicDefinitionMetaData.build(attrs[:meta]),
+        mosaic: MosaicDefinition.build(attrs[:mosaic])
+      )
+    end
+  end
+end

data/lib/nis/struct/mosaic_levy.rb

@@ -0,0 +1,18 @@
+class Nis::Struct
+  # @attr [Integer] type
+  # @attr [String] recipient
+  # @attr [Nis::Struct::MosaicId] mosaicId
+  # @attr [Integer] fee
+  # @see http://bob.nem.ninja/docs/#mosaicLevy
+  class MosaicLevy
+    include Nis::Util::Assignable
+    attr_accessor :type, :recipient, :mosaicId, :fee
+
+    alias :mosaid_id :mosaicId
+
+    def self.build(attrs)
+      attrs[:mosaicId] = MosaicId.build(attrs[:mosaicId])
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/mosaic_properties.rb

@@ -1,13 +1,18 @@
 class Nis::Struct
   # @attr [Array] properties
   # @attr [Integer] divisibility
-  # @attr [Integer] initial_supply
-  # @attr [Boolean] supply_mutable
+  # @attr [Integer] initialSupply
+  # @attr [Boolean] supplyMutable
   # @attr [Boolean] transferable
   # @see http://bob.nem.ninja/docs/#mosaicProperties
   class MosaicProperties
     include Nis::Util::Assignable
-    attr_accessor :divisibility, :initial_supply, :supply_mutable, :transferable
+    attr_accessor :divisibility, :initialSupply, :supplyMutable, :transferable
+
+    alias initial_supply initialSupply
+    alias initial_supply= initialSupply=
+    alias supply_mutable supplyMutable
+    alias supply_mutable= supplyMutable=
 
     def self.build(attrs)
       new(attrs)

data/lib/nis/struct/namespace_meta_data.rb

@@ -0,0 +1,12 @@
+class Nis::Struct
+  # @attr [Integer] id
+  # @see http://bob.nem.ninja/docs/#namespaceMetaData
+  class NamespaceMetaData
+    include Nis::Util::Assignable
+    attr_accessor :id
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/namespace_meta_data_pair.rb

@@ -0,0 +1,16 @@
+class Nis::Struct
+  # @attr [String] meta
+  # @attr [String] namespace
+  # @see http://bob.nem.ninja/docs/#namespaceMetaDataPair
+  class NamespaceMetaDataPair
+    include Nis::Util::Assignable
+    attr_accessor :meta, :namespace
+
+    def self.build(meta:, namespace:)
+      new(
+        meta: NamespaceMetaData.build(meta),
+        namespace: Namespace.build(namespace)
+      )
+    end
+  end
+end

data/lib/nis/struct/nis_node_info.rb

@@ -0,0 +1,19 @@
+class Nis::Struct
+  # @attr [Nis::Struct::NodeInfo] node
+  # @attr [Nis::Struct::NodeInfo] nis_info
+  # @see http://bob.nem.ninja/docs/#nisNodeInfo
+  class NisNodeInfo
+    include Nis::Util::Assignable
+    attr_accessor :node, :nisInfo
+
+    alias :nis_info :nisInfo
+    alias :nis_info= :nisInfo=
+
+    def self.build(attrs)
+      new(
+        node: Nis::Struct::NodeInfo.build(attrs[:node]),
+        nisInfo: Nis::Struct::NodeInfo.build(attrs[:nisInfo])
+      )
+    end
+  end
+end

data/lib/nis/struct/node_collection.rb

@@ -0,0 +1,20 @@
+class Nis::Struct
+  # @attr [Array] inactive
+  # @attr [Array] active
+  # @attr [Array] busy
+  # @attr [Array] failure
+  # @see http://bob.nem.ninja/docs/#nodeCollection
+  class NodeCollection
+    include Nis::Util::Assignable
+    attr_accessor :inactive, :active, :busy, :failure
+
+    def self.build(attrs)
+      new(
+        inactive: attrs[:inactive].map { |n| NodeInfo.build(n) },
+        active:   attrs[:active].map { |n| NodeInfo.build(n) },
+        busy:     attrs[:busy].map { |n| NodeInfo.build(n) },
+        failure:  attrs[:failure].map { |n| NodeInfo.build(n) }
+      )
+    end
+  end
+end

data/lib/nis/struct/node_experience.rb

@@ -0,0 +1,13 @@
+class Nis::Struct
+  # @attr [Integer] s
+  # @attr [Integer] f
+  # @see http://bob.nem.ninja/docs/#
+  class NodeExperience
+    include Nis::Util::Assignable
+    attr_accessor :s, :f
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end