nem-ruby 0.0.5 → 0.0.6

data/docs/mosaic.md

@@ -0,0 +1,10 @@
+## Mosaic attachment definition
+
+```ruby
+class MyMosaic < Nem::Mosaic::Base
+  namespace_id 'my'
+  name 'moz'
+  divisibility 3
+  initial_supply 1_234_567_890
+end
+```

data/examples/configure.rb

@@ -0,0 +1,17 @@
+require 'nem'
+
+# Library configuration
+Nem.configure do |conf|
+  # set logger
+  conf.logger = Logger.new('./nem-ruby.log')
+  conf.logger.level = Logger::DEBUG
+
+  # debug flag
+  conf.debug = true
+
+  # you can set deadline(sec)
+  conf.default_deadline = 7200
+
+  # set :mainnet if you'd like to use on mainnet!
+  conf.default_network = :mainnet # use on mainnet!
+end

data/examples/endpoint/account.rb

@@ -38,7 +38,10 @@ pp account_endpoint.namespace('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
 pp account_endpoint.mosaic_definition('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
 
 # fetch owned mosaics of account
-pp account_endpoint.mosaic_owned('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
+mosaics = account_endpoint.mosaic_owned('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
+pp mosaics
+pp mosaics.find_by_namespace_id('tpico')
+pp mosaics.find_by_fqn('tpico:test')
 
 # transfers
 

data/examples/transaction/multisig_transfer.rb

@@ -1,15 +1,7 @@
 require 'pp'
 require 'nem'
 
-# Library configuration
-Nem.configure do |conf|
-  # conf.logger = Logger.new('./nem-ruby.log')
-  # conf.logger.level = Logger::DEBUG
-  # you can set deadline(sec)
-  # conf.deadline = 7200
-  # set :mainnet if you'd like to use on mainnet!
-  # conf.default_network = :mainnet # use on mainnet!
-end
+Nem.logger.level = Logger::DEBUG
 
 # multisig
 M_PUBLIC_KEY  = '6d72b57d2bc199d328e7ea3e24775f7f614760bc18f3f8501cd3daa9870cc40c'

data/examples/transaction/transfer.rb

@@ -1,15 +1,7 @@
 require 'pp'
 require 'nem'
 
-# Library configuration
-Nem.configure do |conf|
-  conf.logger = Logger.new('./nem-ruby.log')
-  conf.logger.level = Logger::DEBUG
-  # you can set deadline(sec)
-  # conf.deadline = 7200
-  # set :mainnet if you'd like to use on mainnet!
-  # conf.default_network = :mainnet # use on mainnet!
-end
+Nem.logger.level = Logger::DEBUG
 
 # sender
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
@@ -30,3 +22,13 @@ res = tx_endpoint.announce(req)
 
 pp "Message: #{res.message}"
 pp "TransactionHash: #{res.transaction_hash}"
+
+# with hexdecimal message
+tx = Nem::Transaction::Transfer.new(B_ADDRESS, 0, 'febaadfooddeadbeaf')
+pp "Fee: #{tx.fee.to_i}"
+
+req = Nem::Request::Announce.new(tx, kp)
+res = tx_endpoint.announce(req)
+
+pp "Message: #{res.message}"
+pp "TransactionHash: #{res.transaction_hash}"

data/examples/transaction/transfer_with_encrypted_message.rb

@@ -1,15 +1,7 @@
 require 'pp'
 require 'nem'
 
-# Library configuration
-Nem.configure do |conf|
-  conf.logger = Logger.new('./nem-ruby.log')
-  conf.logger.level = Logger::DEBUG
-  # you can set deadline(sec)
-  # conf.deadline = 7200
-  # set :mainnet if you'd like to use on mainnet!
-  # conf.default_network = :mainnet
-end
+Nem.logger.level = Logger::DEBUG
 
 # sender
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'

data/examples/transaction/transfer_with_local.rb

@@ -1,15 +1,7 @@
 require 'pp'
 require 'nem'
 
-# Library configuration
-Nem.configure do |conf|
-  conf.logger = Logger.new('./nem-ruby.log')
-  conf.logger.level = Logger::DEBUG
-  # you can set deadline(sec)
-  # conf.deadline = 7200
-  # set :mainnet if you'd like to use on mainnet!
-  # conf.default_network = :mainnet # use on mainnet!
-end
+Nem.logger.level = Logger::DEBUG
 
 # sender
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'

data/lib/nem/configuration.rb

@@ -2,15 +2,17 @@ require 'logger'
 
 module Nem
   module Configuration
-    DEADLINE = 3600
+    DEADLINE = 3600 # 1 hour
 
-    attr_accessor :logger, :deadline, :default_network, :debug
+    attr_accessor :logger, :debug,
+      :default_deadline,
+      :default_network
 
     def self.extended(base)
       base.logger = Logger.new($stdout).tap { |l| l.level = Logger::INFO }
-      base.deadline = DEADLINE
-      base.default_network = :testnet
       base.debug = false
+      base.default_deadline = DEADLINE
+      base.default_network = :testnet
     end
 
     # @yield [self]
@@ -18,7 +20,7 @@ module Nem
     #   Nem.configure do |conf|
     #     conf.logger = Logger.new('path/to/nem-ruby.log')
     #     conf.logger.level = Logger::DEBUG
-    #     conf.deadline = 7200
+    #     conf.default_deadline = 7200
     #     conf.default_network = :mainnet
     #   end
     def configure

data/lib/nem/endpoint/account.rb

@@ -121,9 +121,9 @@ module Nem
       # @see https://nemproject.github.io/#retrieving-mosaics-that-an-account-owns
       def mosaic_owned(address)
         request!(:get, '/account/mosaic/owned', address: address) do |res|
-          res[:data].map do |moa|
-            Nem::Model::Mosaic.new_from_mosaic(moa)
-          end
+          Nem::Model::MosaicCollection.new(
+            res[:data].map { |moa| Nem::Model::Mosaic.new_from_mosaic(moa) }
+          )
         end
       end
 

data/lib/nem/model/message.rb

@@ -2,7 +2,6 @@ module Nem
   module Model
     # @attr [String] value
     # @attr [Integer] type
-    # @attr [String] payload
     # @attr [String] public_key
     # @attr [String] private_key
     class Message
@@ -62,9 +61,14 @@ module Nem
         bytesize <= 1024
       end
 
+      # @return [Boolean]
+      def hex?
+        !!(value =~ /\Afe\h+\Z/)
+      end
+
       # @return [Hash]
       def to_hash
-        { payload: payload, type: @type }
+        { payload: payload, type: type }
       end
 
       # @return [String]
@@ -79,7 +83,7 @@ module Nem
 
       # @return [String]
       def payload
-        (value =~ /\Afe/ || encrypted?) ? value : value.unpack('H*').first
+        (hex? || encrypted?) ? value : value.unpack('H*').first
       end
 
       private

data/lib/nem/model/mosaic.rb

@@ -4,8 +4,7 @@ module Nem
       include Nem::Mixin::Assignable
 
       extend Forwardable
-
-      def_delegators :@mosaic_id, :fqn
+      def_delegators :@mosaic_id, :fqn, :namespace_id, :name
 
       attr_reader :mosaic_id, :quantity
 

data/lib/nem/model/mosaic_attachment.rb

@@ -12,7 +12,7 @@ module Nem
         :supply_mutable,
         :transferable
 
-      attr_reader :mosaic_id, :properties, :quantity
+      attr_reader :mosaic_id, :quantity, :properties
 
       def amount
         return quantity * (10**properties.divisibility)

data/lib/nem/model/mosaic_collection.rb

@@ -0,0 +1,31 @@
+module Nem
+  module Model
+    class MosaicCollection
+      include Enumerable
+      extend Forwardable
+      def_delegators :@attachments, :size, :empty?,
+        :each, :map, :find, :sort_by
+
+      attr_reader :attachments
+
+      # @param [Array] attachments
+      def initialize(attachments)
+        @attachments = attachments
+      end
+
+      # @param [String] fqn
+      # @return [Nem::Model::MosaicAttachment]
+      def find_by_fqn(fqn)
+        attachments.find {|a| a.fqn == fqn }
+      end
+
+      alias :[] :find_by_fqn
+
+      # @param [String] namespace_id
+      # @return [Nem::Model::MosaicCollection]
+      def find_by_namespace_id(namespace_id)
+        self.class.new(attachments.select {|a| a.namespace_id == namespace_id })
+      end
+    end
+  end
+end

data/lib/nem/model/transaction.rb

@@ -14,7 +14,7 @@ module Nem
         :height
 
       def version?(num)
-        num == 1 ? true : false  # TODO: version
+        version & 0x00000003 == num ? true : false
       end
 
       def self.new_from_account_transaction(hash)
@@ -40,6 +40,8 @@ module Nem
         klass.new_from_transaction_meta_data_pair(hash)
       end
 
+      private
+
       def self.common_part(hash)
         {
           timestamp: hash[:timeStamp],
@@ -53,18 +55,11 @@ module Nem
 
       def self.common_part_meta_data_pair(hash)
         meta = hash[:meta]
-        transaction = hash[:transaction]
-        {
+        common_part(hash[:transaction]).merge(
           id: meta[:id],
           hash: meta[:hash] ? meta[:hash][:data] : meta[:data],
-          height: meta[:height],
-          timestamp: transaction[:timeStamp],
-          version: transaction[:version],
-          type: transaction[:type],
-          signer: transaction[:signer],
-          fee: transaction[:fee],
-          deadline: transaction[:deadline]
-        }
+          height: meta[:height]
+        )
       end
     end
   end

data/lib/nem/request/announce.rb

@@ -1,13 +1,11 @@
 module Nem
   module Request
-    # @attr [Nem::Struct::Transaction] transaction
+    # @attr [Nem::Model::Transaction] transaction
     # @attr [Nem::Keypair] keypair
-    # @attr [String] data
-    # @attr [String] signature
     # @see https://nemproject.github.io/#requestAnnounce
     # @see https://nemproject.github.io/#requestPrepareAnnounce
     class Announce
-      attr_reader :transaction, :keypair, :data, :signature
+      attr_reader :transaction, :keypair
 
       def initialize(transaction, keypair)
         @transaction = transaction
@@ -47,7 +45,7 @@ module Nem
           type: tx.other_trans.type,
           fee: tx.other_trans.fee.to_i,
           timeStamp: Nem::Util.timestamp,
-          deadline: Nem::Util.deadline(Nem.deadline),
+          deadline: Nem::Util.deadline(Nem.default_deadline),
           signer: tx.signer,
           version: tx.other_trans.version
         )
@@ -61,7 +59,7 @@ module Nem
           type: transaction.type,
           fee: transaction.fee.to_i,
           timeStamp: Nem::Util.timestamp,
-          deadline: Nem::Util.deadline(Nem.deadline),
+          deadline: Nem::Util.deadline(Nem.default_deadline),
           signer: keypair.public,
           version: transaction.version
         )

data/lib/nem/version.rb

@@ -1,3 +1,3 @@
 module Nem
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/mkdocs.yml

@@ -0,0 +1,28 @@
+site_url: https://44uk.github.io/nem-ruby/
+site_name: nem-ruby
+site_description: Ruby client library for the NEM Infrastructure Server API
+repo_url: https://github.com/44uk/nem-ruby
+copyright: Copyright &copy; 2017, <a href="https://github.com/44uk">Yoshiyuki Ieyama</a>, <a href="https://twitter.com/44uk_i3">44uk_i3</a>.
+theme: readthedocs
+extra_css:
+  - custom.css
+pages:
+  - Home: index.md
+  - Examples:
+    - examples/configure.md
+    - examples/nis.md
+    - examples/account.md
+    - examples/block.md
+    - examples/chain.md
+    - examples/mosaic.md
+    - examples/namespace.md
+    - examples/node.md
+    - examples/transactions.md
+    - examples/define_mosaic_attachment.md
+    - examples/timesync.md
+    - examples/debug.md
+    - examples/local.md
+    - examples/apostille.md
+    - examples/offline.md
+    - examples/util.md
+  - About: about.md

data/nem-ruby.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'yard', '~> 0.9'
-  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_development_dependency 'rubocop', '~> 0.50'
   spec.add_development_dependency 'timecop', '~> 0.8'
   spec.add_development_dependency 'webmock', '~> 2.3'
   spec.add_development_dependency 'pry-byebug', '~> 3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nem-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Yoshiyuki Ieyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0.50'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -194,9 +194,30 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docs/about.md
+- docs/custom.css
+- docs/examples/account.md
+- docs/examples/apostille.md
+- docs/examples/block.md
+- docs/examples/chain.md
+- docs/examples/configure.md
+- docs/examples/debug.md
+- docs/examples/define_mosaic_attachment.md
+- docs/examples/local.md
+- docs/examples/mosaic.md
+- docs/examples/namespace.md
+- docs/examples/nis.md
+- docs/examples/node.md
+- docs/examples/offline.md
+- docs/examples/timesync.md
+- docs/examples/transactions.md
+- docs/examples/util.md
+- docs/index.md
+- docs/mosaic.md
 - examples/apostille/audit.rb
 - examples/apostille/create.rb
 - examples/apostille/create_private.rb
+- examples/configure.rb
 - examples/endpoint/account.rb
 - examples/endpoint/account_local.rb
 - examples/endpoint/block.rb
@@ -273,6 +294,7 @@ files:
 - lib/nem/model/message.rb
 - lib/nem/model/mosaic.rb
 - lib/nem/model/mosaic_attachment.rb
+- lib/nem/model/mosaic_collection.rb
 - lib/nem/model/mosaic_definition.rb
 - lib/nem/model/mosaic_definition_creation_transaction.rb
 - lib/nem/model/mosaic_id.rb
@@ -326,6 +348,7 @@ files:
 - lib/nem/util/ed25519.rb
 - lib/nem/util/serializer.rb
 - lib/nem/version.rb
+- mkdocs.yml
 - nem-ruby.gemspec
 homepage: https://github.com/44uk/nem-ruby
 licenses: