nis-ruby 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 061a83269fcef596e746171c60d75f215c1ee99c
-  data.tar.gz: 943f352e756874a0622196046708e533c2b43a56
+  metadata.gz: a3cee816f2425c27c2f6c1e0cc6bf4e08a0b8db1
+  data.tar.gz: 893039b8833f10bcb9802e04d1819c73fd1ee662
 SHA512:
-  metadata.gz: 430fbd5bebbfd64f3edef98fca026873a7255b710e987af87dc77bd09597f8111aa3c04e15eb2ef6c0b5f7df91d4636cdff685c02f5d02030cfede35c5d53679
-  data.tar.gz: a32054344daeef7210c1c4dfbadf08629a2fb213d4f209e545ab36dec02bb56e3f308daeaa50f1bfaeabdd37bec75918ea223f5876db1ff4660e4e58aac46542
+  metadata.gz: a3f908e45854fca103743aef337b0f87970922e46c0b7c86165c4aa2ffdff6751528044a524e31820907c780bdb3cf5ce9db346bd9b56f563748925a196c4504
+  data.tar.gz: 79fe99b46a5c77f8e17998f13a6083716602af36b460a702ce66613126ca9cae1f9d3333e05860cdd569525489c89c079e4ff565b35fc9d742b50b13ecc1cc0c

data/README.md

@@ -29,6 +29,10 @@ gem 'nis-ruby'
 
 ## Usage
 
+More specific demonstrations are in samples/ directory.
+
+### Methods
+
 ```ruby
 nis = Nis.new
 
@@ -39,6 +43,12 @@ nis.heartbeat
 nis.status
 # => {code: 6, type: 4, message: "status"}
 # See http://bob.nem.ninja/docs/#status-request
+```
+
+### Requesting
+
+```ruby
+nis = Nis.new
 
 nis.request(:get, '/account/get',
   address: 'TALICELCD3XPH4FFI5STGGNSNSWPOTG5E4DS2TOS'
@@ -52,7 +62,7 @@ nis.request(:post, '/account/unlock',
 # => Nothing
 # See http://bob.nem.ninja/docs/#locking-and-unlocking-accounts
 
-t = {
+tx = {
   amount: 10_000_000,
   fee:     3_000_000,
   recipient: 'TALICELCD3XPH4FFI5STGGNSNSWPOTG5E4DS2TOS',
@@ -67,15 +77,13 @@ t = {
   version: -1_744_830_463 # testnet version 1
 }
 puts nis.request! :post, 'transaction/prepare-announce', {
-  transaction: t,
+  transaction: tx,
   privateKey: '68e4f79f886927de698df4f857de2aada41ccca6617e56bb0d61623b35b08cc0'
 }
 # => {innerTransactionHash: {}, code: 1, type: 1, message: "SUCCESS", transactionHash: {data: "9da41fd6c6886740ae6a15c869df0470015d78103e5b216971aa09fdbcce9cde"}}
 # See http://bob.nem.ninja/docs/#initiating-a-transfer-transaction
 ```
 
-More specific demonstrations are in demo/ directory.
-
 
 ## Commandline
 
@@ -116,8 +124,10 @@ Nis.new(url: 'http://bigalice3.nem.ninja:7890')
 
 ## TODO
 
-- Do more improvements.
-
+* Do more improvements.
+  * Implementation Apostille
+  * Implementation Mosaic
+  * Implementation Encryption
 
 ## Documentation
 

data/lib/nis/client.rb

@@ -14,6 +14,14 @@ class Nis::Client
     timeout: 5
   }.freeze
 
+  LOCAL_ONLY_PATHES = [
+    '/local/account/transfers/incoming',
+    '/local/account/transfers/outgoing',
+    '/local/account/transfers/all',
+    '/node/boot',
+    '/transaction/prepare-announce'
+  ]
+
   attr_reader :options
 
   # @param [hash] options HTTP Client connection information
@@ -31,6 +39,9 @@ class Nis::Client
   # @param [Hash] params API Parameters
   # @return [Hash] Hash converted API Response
   def request(method, path, params = {})
+    if connection.remote? && local_only?(path)
+      raise Nis::Error, "The request (#{method} #{path}) is only permitted to local NIS."
+    end
     if params.is_a?(Hash) && !params.empty?
       params.reject! { |_, value| value.nil? }
     end
@@ -53,6 +64,10 @@ class Nis::Client
 
   private
 
+  def local_only?(path)
+    LOCAL_ONLY_PATHES.include?(path)
+  end
+
   def connection
     @connection ||= Faraday.new(url: @options[:url]) do |f|
       f.options[:timeout] = @options[:timeout]
@@ -61,7 +76,7 @@ class Nis::Client
       #   logger.filter(/(privateKey=)(\w+)/,'\1[FILTERED]')
       # end
       f.adapter Faraday.default_adapter
-    end
+    end.tap { |c| c.extend(Local) }
   end
 
   def parse_body(body)
@@ -103,4 +118,14 @@ class Nis::Client
 
     options
   end
+
+  module Local
+    def local?
+      host == '127.0.0.1' || host == 'localhost'
+    end
+
+    def remote?
+      !local?
+    end
+  end
 end

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

@@ -1,6 +1,6 @@
 module Nis::Endpoint
   module Node::ActivePeers
-    # @return [Nis::Struct::NodeInfo]
+    # @return [Nis::Struct::Node]
     # @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|

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

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

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

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

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

@@ -6,19 +6,19 @@ module Nis::Endpoint
       Nis::Struct::NodeCollection.build request!(:get, '/node/peer-list/all')
     end
 
-    # @return [Array <Nis::Struct::NodeInfo>]
+    # @return [Array <Nis::Struct::Node>]
     # @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) }
+        res[:data].map { |n| Nis::Struct::Node.build(n) }
       end
     end
 
-    # @return [Array <Nis::Struct::NodeInfo>]
+    # @return [Array <Nis::Struct::Node>]
     # @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) }
+        res[:data].map { |n| Nis::Struct::Node.build(n) }
       end
     end
   end

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

@@ -1,7 +1,7 @@
 module Nis::Endpoint
   module Transaction::Announce
     # @param [Nis::Struct::RequestAnnounce] request_announce
-    # @return [Nis::Struct::NodeInfo]
+    # @return [Nis::Struct::Node]
     # @see http://bob.nem.ninja/docs/#sending-the-data-to-NIS
     def transaction_announce(request_announce:)
       Nis::Struct::NemAnnounceResult.build request!(:post,

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

@@ -1,7 +1,7 @@
 module Nis::Endpoint
   module Transaction::PrepareAnnounce
     # @param [Nis::Struct::RequestPrepareAnnounce] request_prepare_announce
-    # @return [Nis::Struct::NodeInfo]
+    # @return [Nis::Struct::Node]
     # @see http://bob.nem.ninja/docs/#initiating-a-transaction
     def transaction_prepare_announce(request_prepare_announce:)
       Nis::Struct::NemAnnounceResult.build request!(:post,

data/lib/nis/struct/extended_node_experience_pair.rb

@@ -1,5 +1,5 @@
 class Nis::Struct
-  # @attr [Nis::Struct::NodeInfo] node
+  # @attr [Nis::Struct::Node] node
   # @attr [Integer] syncs
   # @attr [Nis::Struct::NodeExperience] experience
   # @see http://bob.nem.ninja/docs/#extendedNodeExperiencePair

data/lib/nis/struct/message.rb

@@ -0,0 +1,55 @@
+class Nis::Struct
+  # @attr [String] value
+  # @attr [Integer] type
+  # @attr [String] payload
+  class Message
+    attr_accessor :value, :type, :payload
+
+    TYPE_PLAIN     = 1
+    TYPE_ENCRYPTED = 2
+
+    def initialize(value = '')
+      @value = value
+      @type  = TYPE_PLAIN
+    end
+
+    # @return [Boolean]
+    def encrypted?
+      @type == TYPE_ENCRYPTED
+    end
+
+    # @return [Boolean]
+    def plain?
+      @type == TYPE_PLAIN
+    end
+
+    # @return [Integer]
+    def bytesize
+      payload.bytesize
+    end
+
+    # @return [Boolean]
+    def valid?
+      bytesize <= 512
+    end
+
+    # @return [Hash]
+    def to_hash
+      { payload: payload, type: @type }
+    end
+
+    # @return [String]
+    def to_s
+      @value
+    end
+
+    # @return [Boolean]
+    def ==(other)
+      @value == other.value
+    end
+
+    def payload
+      @payload ||= value.unpack('H*').join
+    end
+  end
+end

data/lib/nis/struct/nem_announce_result.rb

@@ -13,6 +13,8 @@ class Nis::Struct
     alias :inner_transaction_hash :innerTransactionHash
 
     def self.build(attrs)
+      attrs[:transactionHash] = Nis::Unit::Hash.new(attrs[:transactionHash][:data])
+      attrs[:innerTransactionHash] = Nis::Unit::Hash.new(attrs[:innerTransactionHash][:data])
       new(attrs)
     end
   end

data/lib/nis/struct/nis_node_info.rb

@@ -1,6 +1,6 @@
 class Nis::Struct
   # @attr [Nis::Struct::NodeInfo] node
-  # @attr [Nis::Struct::NodeInfo] nis_info
+  # @attr [Nis::Struct::NodeInfo] nisInfo
   # @see http://bob.nem.ninja/docs/#nisNodeInfo
   class NisNodeInfo
     include Nis::Util::Assignable
@@ -11,8 +11,8 @@ class Nis::Struct
 
     def self.build(attrs)
       new(
-        node: Nis::Struct::NodeInfo.build(attrs[:node]),
-        nisInfo: Nis::Struct::NodeInfo.build(attrs[:nisInfo])
+        node: Nis::Struct::Node.build(attrs[:node]),
+        nisInfo: Nis::Struct::ApplicationMetaData.build(attrs[:nisInfo])
       )
     end
   end

data/lib/nis/struct/node.rb

@@ -0,0 +1,16 @@
+class Nis::Struct
+  # @attr [String] metaData
+  # @attr [String] networkId
+  # @attr [String] identity
+  # @see http://bob.nem.ninja/docs/#node
+  class Node
+    include Nis::Util::Assignable
+    attr_accessor :metaData, :endpoint, :identity
+
+    alias :meta_data  :metaData
+
+    def self.build(attrs)
+      new(attrs)
+    end
+  end
+end

data/lib/nis/struct/node_collection.rb

@@ -10,10 +10,10 @@ class Nis::Struct
 
     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) }
+        inactive: attrs[:inactive].map { |n| Node.build(n) },
+        active:   attrs[:active].map { |n| Node.build(n) },
+        busy:     attrs[:busy].map { |n| Node.build(n) },
+        failure:  attrs[:failure].map { |n| Node.build(n) }
       )
     end
   end

data/lib/nis/struct/transaction.rb

@@ -5,7 +5,7 @@ class Nis::Struct
   # @attr [String]  recipient
   # @attr [Integer] type
   # @attr [Integer] deadline
-  # @attr [String]  message
+  # @attr [Nis::Struct::Message] message
   # @attr [Integer] version
   # @attr [String]  signer
   # @attr [Array <Nis::Struct::MosaicId>] mosaics
@@ -41,8 +41,6 @@ class Nis::Struct
     MAINNET_VERSION_1 = MAINNET | VERSION_1 # 0x68000001 =  1744830465
     MAINNET_VERSION_2 = MAINNET | VERSION_2 # 0x68000002 =  1744830466
 
-    @mosaics = []
-
     def self.build(attrs)
       new(attrs)
     end
@@ -61,5 +59,39 @@ class Nis::Struct
     def mainnet?
       (0x0000000F & @version) == MAINNET
     end
+
+    # @return [Integer]
+    def fee
+      @fee ||= calculate_fee
+    end
+
+    def mosaics
+      @mosaics ||= []
+    end
+
+    alias to_hash_old to_hash
+
+    def to_hash
+      fee
+      to_hash_old
+    end
+
+    # @return [Integer]
+    def calculate_fee
+      if mosaics.empty?
+        tmp_fee = [1, amount / 1_000_000 / 10000].max
+        fee = (tmp_fee > 25 ? 25 : tmp_fee)
+      else
+        # TODO: calc mosaics fee
+        raise NotImplementedError, 'not implemented calculation mosaic fee.'
+        fee = 25
+      end
+
+      if message.bytesize > 0
+        fee += [1, (message.bytesize / 2 / 32) + 1].max
+      end
+
+      fee * 1_000_000
+    end
   end
 end

data/lib/nis/version.rb

@@ -1,3 +1,3 @@
 class Nis
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.9'.freeze
 end

data/{demo → samples}/request_transaction.rb

@@ -7,18 +7,15 @@ A_PRIVATE_KEY = '00b4a68d16dc505302e9631b860664ba43a8183f0903bc5782a2403b2f9eb3c
 A_PUBLIC_KEY  = '5aff2e991f85d44eed8f449ede365a920abbefc22f1a2f731d4a002258673519'.freeze
 
 # Account B (Dist)
-B_ADDRESS = 'TAFPFQOTRYEKMKWWKLLLMYA3I5SCFDGYFACCOFWS'.freeze
+B_ADDRESS = 'TA4TX6U5HG2MROAESH2JE5524T4ZOY2EQKQ6ELHF'.freeze
 
 # build Transaction Object
-t = Nis::Struct::Transaction.new(
+tx = Nis::Struct::Transaction.new(
   amount:  1_000_000,
-  fee:     1_000_000,
+  fee:     3_000_000,
   recipient: B_ADDRESS,
   signer: A_PUBLIC_KEY,
-  message: {
-    payload: '',
-    type: 1
-  },
+  message: Nis::Struct::Message.new('Hello'),
   type: Nis::Struct::Transaction::TRANSFER,
   timeStamp: Nis::Util.timestamp,
   deadline:  Nis::Util.timestamp + 43_200,
@@ -27,7 +24,7 @@ t = Nis::Struct::Transaction.new(
 
 # build RequestPrepareAnnounce Object
 rpa = Nis::Struct::RequestPrepareAnnounce.new(
-  transaction: t,
+  transaction: tx,
   privateKey: A_PRIVATE_KEY
 )
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nis-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Yoshiyuki Ieyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -167,14 +167,6 @@ files:
 - README.md
 - Rakefile
 - bin/nis
-- demo/request_account.rb
-- demo/request_block.rb
-- demo/request_debug.rb
-- demo/request_local.rb
-- demo/request_namespace.rb
-- demo/request_nis.rb
-- demo/request_node.rb
-- demo/request_transaction.rb
 - lib/nis.rb
 - lib/nis/client.rb
 - lib/nis/endpoint.rb
@@ -239,6 +231,7 @@ files:
 - lib/nis/struct/extended_node_experience_pair.rb
 - lib/nis/struct/harvest_info.rb
 - lib/nis/struct/key_pair_view_model.rb
+- lib/nis/struct/message.rb
 - lib/nis/struct/mosaic.rb
 - lib/nis/struct/mosaic_definition.rb
 - lib/nis/struct/mosaic_definition_meta_data.rb
@@ -253,9 +246,9 @@ files:
 - lib/nis/struct/nem_async_timer_visitor.rb
 - lib/nis/struct/nem_request_result.rb
 - lib/nis/struct/nis_node_info.rb
+- lib/nis/struct/node.rb
 - lib/nis/struct/node_collection.rb
 - lib/nis/struct/node_experience.rb
-- lib/nis/struct/node_info.rb
 - lib/nis/struct/request_announce.rb
 - lib/nis/struct/request_prepare_announce.rb
 - lib/nis/struct/time_synchronization_result.rb
@@ -276,6 +269,14 @@ files:
 - lib/nis/util/assignable.rb
 - lib/nis/version.rb
 - nis.gemspec
+- samples/request_account.rb
+- samples/request_block.rb
+- samples/request_debug.rb
+- samples/request_local.rb
+- samples/request_namespace.rb
+- samples/request_nis.rb
+- samples/request_node.rb
+- samples/request_transaction.rb
 homepage: https://github.com/44uk/nis-ruby
 licenses:
 - MIT

data/lib/nis/struct/node_info.rb

@@ -1,28 +0,0 @@
-class Nis::Struct
-  # @attr [String] metaData
-  # @attr [String] features
-  # @attr [String] networkId
-  # @attr [String] application
-  # @attr [String] version
-  # @attr [String] platform
-  # @attr [String] endpoint
-  # @attr [String] protocol
-  # @attr [String] port
-  # @attr [String] host
-  # @attr [String] identity
-  # @attr [String] name
-  # @attr [String] publicKey
-  # @see http://bob.nem.ninja/docs/#nodeInfo
-  class NodeInfo
-    include Nis::Util::Assignable
-    attr_accessor :metaData, :features, :networkId, :application, :version, :platform, :endpoint, :protocol, :port, :host, :identity, :name, :publicKey
-
-    alias :meta_data :metaData
-    alias :network_id :networkId
-    alias :public_key :publicKey
-
-    def self.build(attrs)
-      new(attrs)
-    end
-  end
-end