nem-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74250572f96e346748c614f5dca30929f2f4deed
+  data.tar.gz: e2e273e49e7d9c5defc1f94b2093cf551ae8e92a
+SHA512:
+  metadata.gz: f71c7a0ca04e9f2f0a0169790ee3e63cc56075498a72ce306a25a0c2b3db4b1bfd86648b804f63095a3fa8ad77cfee54e5e9629772e6e3871cede0a65f183dce
+  data.tar.gz: 37ce2b96c1ba4bfb0fe926e14536dd88374f2913a4540651857b45d34841b41c251fc2d8fa4dbc5218048af2e108edcc74631f11e13543c2297c0a800a15694b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

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/.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+language: ruby
+cache: bundler
+bundler_args: --without development
+
+rvm:
+  - ruby-head
+  - 2.4.0
+  - 2.3.0
+  - 2.2.6
+
+branches:
+  only:
+    - master
+    - development
+
+matrix:
+  fast_finish: true
+
+before_install:
+  # Bundler on Travis may be too out of date
+  # Update bundler to a recent version.
+  - gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yukku0423@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nem-ruby.gemspec
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+# nem-ruby
+
+[![Build Status](https://travis-ci.org/44uk/nem-ruby.svg?branch=master)](https://travis-ci.org/44uk/nem-ruby)
+[![Gem Version](https://badge.fury.io/rb/nem-ruby.svg)](https://badge.fury.io/rb/nem-ruby)
+[![Code Climate](https://codeclimate.com/github/44uk/nem-ruby/badges/gpa.svg)](https://codeclimate.com/github/44uk/nem-ruby)
+[![Join the chat at https://gitter.im/44uk/nem-ruby](https://badges.gitter.im/44uk/nem-ruby.svg)](https://gitter.im/44uk/nem-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+<img src="https://cloud.githubusercontent.com/assets/370508/24320282/a332d238-1175-11e7-96dc-75bc30e562d2.png" width="280" height="280" alt="nem" align="right" />
+
+Ruby gem for communicating with the nem.
+
+*The gem is under development. Incompatible changes can be made.*
+
+*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 \- 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
+
+```bash
+$ gem install nem-ruby
+```
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'nem-ruby'
+```
+
+## Usage
+
+```ruby
+require 'pp'
+require 'nem'
+
+node = Nem::Node.new(host: '104.128.226.60')
+account_endpoint = Nem::Endpoint::Account.new(node)
+
+pp account_endpoint.find('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+# => #<Nem::Model::Account:0x007fe95b35f560
+#  @address="TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4",
+#  @balance=68000000,
+#  @cosignatories=[],
+#  @cosignatory_of=[],
+#  @harvested_blocks=1,
+#  @importance=0.0,
+#  @label=nil,
+#  @public_key=
+#   "e59ef184a612d4c3c4d89b5950eb57262c69862b2f96e59c5043bf41765c482f",
+#  @remote_status="INACTIVE",
+#  @status="LOCKED",
+#  @vested_balance=62145647>
+```
+
+### Examples
+
+More specific example codes are in **[examples/](examples/)** directory.
+
+## 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/nem-ruby - gitter](https://gitter.im/44uk/nem-ruby)
+
+## For More Information
+
+* [Documentation for nem-ruby - rubydoc.info](http://www.rubydoc.info/gems/nem-ruby)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/44uk/nem-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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/examples/apostille_audit.rb

@@ -0,0 +1,22 @@
+require 'pp'
+require 'nem'
+
+Nem.logger.level = Logger::DEBUG
+
+FIXTURES_PATH = File.expand_path('../../spec/fixtures', __FILE__)
+
+node = Nem::Node.new(host: '104.128.226.60')
+tx_endpoint = Nem::Endpoint::Transaction.new(node)
+
+# transaction hash from Filename
+tx_hash = 'c035c2603356852687c4730fbc6f8d21da3af7c4c0eb8b3619bc9ecdc833255a'
+tx = tx_endpoint.find(tx_hash)
+
+# NOTE: it may return "Hash was not found in cache"
+# because of NIS not supporting caching transactions.
+# 'fe4e545902cde315617a435ebfd5fe8875d699e2f2363262f5'
+apostille_hash = tx.message.payload
+file = File.open("#{FIXTURES_PATH}/nemLogoV2 -- Apostille TX c035c2603356852687c4730fbc6f8d21da3af7c4c0eb8b3619bc9ecdc833255a -- Date 2017-12-18.png")
+
+apa = Nem::ApostilleAudit.new(file, apostille_hash)
+pp apa.valid? ? 'OK, Valid Apostille!' : 'Bad, Invalid Apostille!'

data/examples/apostille_create.rb

@@ -0,0 +1,31 @@
+require 'pp'
+require 'nem'
+
+Nem.logger.level = Logger::DEBUG
+
+FIXTURES_PATH = File.expand_path('../../spec/fixtures', __FILE__)
+
+# sender
+A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
+
+kp = Nem::Keypair.new(A_PRIVATE_KEY)
+node = Nem::Node.new(host: '23.228.67.85')
+tx_endpoint = Nem::Endpoint::Transaction.new(node)
+
+file = File.open("#{FIXTURES_PATH}/nemLogoV2.png")
+apo = Nem::Apostille.new(kp, file, :sha1,
+  multisig: false,
+  private: false,
+  network: :testnet
+)
+tx = apo.transaction
+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}"
+pp "ApostilleFormat: #{apo.apostille_format(res.transaction_hash)}"
+
+FileUtils.cp(file.path, apo.apostille_format(res.transaction_hash))

data/examples/endpoint/account.rb

@@ -0,0 +1,73 @@
+require 'pp'
+require 'nem'
+
+Nem.logger.level = Logger::DEBUG
+
+# single node
+# node = Nem::Node.new(host: '104.128.226.60')
+
+# multiple nodes
+node = Nem::NodePool.new([
+  Nem::Node.new(host: 'bigalice2.nem.ninja'),
+  Nem::Node.new(host: '192.3.61.243'),
+  Nem::Node.new(host: '104.128.226.60')
+])
+
+# new Account Endpoint Object
+account_endpoint = Nem::Endpoint::Account.new(node)
+
+# find by address
+pp account_endpoint.find('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+# find by public key
+pp account_endpoint.find_by_public_key('e59ef184a612d4c3c4d89b5950eb57262c69862b2f96e59c5043bf41765c482f')
+
+# find forwarded by address
+pp account_endpoint.find_forwarded('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+# find forwarded by public key
+pp account_endpoint.find_forwarded_by_public_key('e59ef184a612d4c3c4d89b5950eb57262c69862b2f96e59c5043bf41765c482f')
+
+# fetch harvests
+pp account_endpoint.harvests('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+# namespace
+pp account_endpoint.namespace('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
+
+# fetch mosaic definition of account
+pp account_endpoint.mosaic_definition('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
+
+# fetch owned mosaics of account
+pp account_endpoint.mosaic_owned('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
+
+# transfers
+
+## incomings
+pp account_endpoint.transfers_incoming('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+## outgoings
+pp account_endpoint.transfers_outgoing('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+## all
+pp account_endpoint.transfers_all('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+## unconfirmed
+pp account_endpoint.transfers_unconfirmed('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+# status
+# pp account_endpoint.status('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+pp account_endpoint.status('TDJNDAQ7F7AQRXKP2YVTH67QYCWWKE6QLSJFWN64')
+pp account_endpoint.status('TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB')
+
+# fetch importances
+pp account_endpoint.importances
+
+# unlock info
+pp account_endpoint.unlocked_info
+
+# historical data
+pp account_endpoint.historical('TDWWYDGQNBKSAJBSHZX7QWVX7WNVAWWB7HGPWRB2',
+  start_height: 1245390,
+  end_height: 1245400,
+  increment: 1
+)