record_on_chain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a055bd220e515642030d9ead2e3b1eea3f0d14269f1cdb4618f1471742cae0d1
+  data.tar.gz: 6dd31036fb75b2bafebddacabf95c7b325d9e589fb3ef9020fc2cf4bff13408b
+SHA512:
+  metadata.gz: 34c114a61d4aeab9c56694626d76d7b1633a59be22e82fe9d72af012f5cbe08b0f1d4f69014474116c0dff53bba62226d30dfff2f49767060fb25fb18a23aa87
+  data.tar.gz: 17d196217781e6849c6ad9ac6771afab1227cde1300bac97dcd77a506d08f9aee391c1e1af47421ba253719897261ecec0d442c75b68e8fd01558bbbb166ffa5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

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 mijinco1024+git@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in record_on_chain.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    record_on_chain (0.1.0)
+      highline (= 2.0.0)
+      nem-ruby (~> 0.0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    base32 (0.3.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    digest-sha3 (1.1.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.0)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.8)
+    highline (2.0.0)
+    multipart-post (2.0.0)
+    nem-ruby (0.0.12)
+      base32 (~> 0.3)
+      digest-sha3 (~> 1.1)
+      faraday (~> 0.11)
+      faraday_middleware (~> 0.11)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  record_on_chain!
+  rspec (~> 3.0)
+  webmock (~> 3.5.1)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 MIJ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,172 @@
+# RecordOnChain
+
+You can record data on the **nem (NIS1)** chain by an operation like Git push.
+
+To use this gem you need xem to be consumed as a fee.
+
+**Data written by using this gem will be exposed without hiding it in the block chain.**
+
+## Installation
+
+    $ gem install record_on_chain
+
+## Usage
+
+#### Procedure
+
+1. init
+2. record / secret
+
+And you can use `help` command.
+
+```
+$ bundle exec rochain help
+
+== Record on Chain HELP ==
+
+descriptions
+ init   : initialize RecordOnChain
+ record : record message on nem(ver-1) chain
+ secret : recover secret from keyfile
+ help   : display usage
+
+...
+```
+
+#### init
+
+```
+$ bundle exec rochain init
+```
+
+This command generates `keyfile` and `configfile`. By default, these files are generated in the `$HOME/.ro_chain` directory.
+
+`default`
+```
+root
+└ home
+　 └ user_dir
+　 　 └ .ro_chain
+　 　 　 ├ default_key.yml
+　 　 　 └ default_config.yml
+```
+
+When you use `-p` option.  
+`-p /home/user_dir/my_dir`
+
+```
+root
+└ home
+　 └ user_dir
+　 　 └ my_dir
+　 　 　 └ .ro_chain
+　 　 　 　 ├ default_key.yml
+　 　 　 　 └ default_config.yml
+```
+
+`keyfile`  
+Information such as encrypted secret key is written in the key file. **Please note that the private key is not encrypted if the password is empty.**
+
+`configfile`  
+Information such as the destination of the data is written in the config file.
+
+The meaning of each item of the config file is as follows.
+
+- :keyfile_path: << path of keyfile >>
+- :recipient: << recipient address >>
+- :add_node: << additional node >>
+
+`RecordOnChain` sends the transaction preferentially to the node at the address written in `add_node`.
+
+**The format of the key file and config file is yaml.**
+
+```
+# sample
+
+:keyfile_path: XXX
+:recipient: XXX
+:add_node:
+ - http://127.0.0.1:7890
+```
+
+#### record
+
+```
+$ bundle exec rochain record -m good_luck!
+
+- Please enter your password
+**************
+!! confirm !!
+sender    : XXX
+recipient : XXX
+data      : good_luck!
+fee       : XXX xem
+
+Are you sure you want to record? (y)es or (n)o
+y
+Exit NOMAL : record command execution succeede.
+tx_hash [ XXX ]
+```
+
+By default, this command reads the configuration file in `$HOME/.ro_chain/default_config.yml`.
+
+If you want to use the specified file, you need to use the option.
+
+e.g. `$HOME/user_dir/my_dir/.ro_chain/my_config.yml`
+```
+$ bundle exec rochain record -p $HOME/user_dir/my_dir -c my_config.yml -m good_luck!
+```
+
+#### secret
+
+Restore the private key from the key file. You will need a password to restore.
+
+```
+$ bundle exec rochain secret
+
+- Please enter your password
+**************
+Exit NOMAL : secret command execution succeede.
+Secret [ XXX ]
+```
+
+By default, this command reads the configuration file in `$HOME/.ro_chain/default_key.yml`.
+
+If you want to use the specified file, you need to use the option.
+
+e.g. `$HOME/user_dir/my_dir/.ro_chain/my_key.yml`
+```
+$ bundle exec rochain secret -k $HOME/user_dir/my_dir/.ro_chain/my_key.yml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Dependencies
+
+**highline**
+
+https://github.com/JEG2/highline
+
+**nem-ruby**
+
+https://github.com/44uk/nem-ruby
+
+I also use the source code of the above repository for testing.
+
+___Thank you your development!___
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/record_on_chain. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RecordOnChain project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/record_on_chain/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "record_on_chain"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rochain

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/record_on_chain"
+
+RecordOnChain.exec

data/lib/record_on_chain/cli.rb

@@ -0,0 +1,140 @@
+require "highline"
+
+module RecordOnChain
+  class Cli
+    def initialize( input=$stdin , output=$stdout )
+      @input  = input
+      @output = output
+    end
+
+    def in ; return @input ; end
+    def out; return @output; end
+
+    ATTR_OFF = "\e[0m".freeze
+
+    ENHANCE = "\e[1m".freeze
+    # style      : bold
+
+    UNDERLINE = "\e[4m".freeze
+    # style      : underline
+
+    ERROR = "\e[31m\e[1m".freeze
+    # color      : red
+    # style      : bold
+
+    SUCCESS = "\e[32m\e[1m".freeze
+    # color      : green
+    # style      : bold
+
+    CAUTION = "\e[43m\e[30m\e[1m".freeze
+    # background : yellow
+    # color      : black
+    # style      : bold
+
+    ATTENTION = "\e[40m\e[36m\e[1m"
+    # background : black 40
+    # char       : cyan 36
+    # others     : bold 1
+
+    attributes = [ "enhance", "underline", "error", "success", "caution", "attention" ]
+    attributes.each do |attr|
+      const = self.const_get( attr.upcase )
+      # def enhance_str( str )
+      #   ENHANCE + str + ATTR_OFF
+      # end
+      define_method( "#{attr}_str" ){ |str| const + str + ATTR_OFF }
+      # def puts_enhance_msg( msg )
+      #   puts( enhance_str( msg ) )
+      # end
+      define_method( "puts_#{attr}_msg" ){ |msg| @output.puts( send( "#{attr}_str" , msg ) ) }
+    end
+
+    def blank_line( size= 1 )
+      puts( "\n"*size )
+    end
+
+    def agree( what )
+      return get_highline.agree( "Are you sure you want to #{what}? (y)es or (n)o" )
+    end
+
+    def decide_password
+      user_password = password_operation_base( 5 )do |answer|
+        # Enter pass again to see if it is equal
+        conf_answer = get_highline.ask("- Please enter your password again (confirm)"){ |q| q.echo = "*" }
+        answer == conf_answer
+      end
+      return user_password
+    end
+
+    def encrypt_with_password( decrypt_func )
+      decrypted_secret = password_operation_base( 3 ) do |attempt|
+        decrypted = decrypt_func.call( attempt )
+        if decrypted.empty? then
+          false # failure
+        else
+          # you can get decrypted data from attempt after valid_process
+          attempt.replace( decrypted )
+          true # success
+        end
+      end
+      return decrypted_secret
+    end
+
+    def puts_hash( hash , attribute= nil, indent= 0 )
+      formatted = format_hash( hash , indent )
+      formatted = send( "#{attribute}_str" , formatted ) unless attribute.nil?
+      @output.puts( formatted )
+    end
+
+    # [ example ]
+    # {alice:"alice",bob:"bob",dylan:"dylan",carol:"carol"}
+    #
+    # alice : alice
+    # bob   : bob
+    # dylan : dylan
+    # carol : carol
+    def format_hash( hash, indent= 0, split_word=" : "  )
+      # get max :key word length
+      max_key_length = hash.map{ |pair| pair.first.size }.max{ |a,b| a <=> b }
+      # initialize output
+      output = ""
+      hash.each do |key,val|
+        output << " " * indent
+        output << padding( key.to_s , max_key_length )
+        output << split_word
+        output << val.to_s
+        output << "\n"
+      end
+      return output
+    end
+
+    private
+
+    def get_highline
+      return HighLine.new( @input, @output )
+    end
+
+    # If you want to exit this method when password is valid,
+    # you should use "return" in valid_process block.
+    def password_operation_base( attempts_count, &valid_process )
+      1.step do |count|
+        # incorrect many times
+        return nil if count > attempts_count
+        # user enter pass here
+        answer = get_highline.ask("- Please enter your password"){ |q| q.echo = "*" }
+        # valid process
+        return answer if valid_process.call( answer )
+        # If it is empty, the attempt is incorrect.
+        puts_enhance_msg( "Your passwords don't match.Please try again." )
+      end
+    end
+
+    def padding( word , padded_size , char=" " )
+      num_of_pad_required = padded_size - word.size
+      # no need padding
+      return word if num_of_pad_required <= 0
+      # padding exec
+      return word + (char * num_of_pad_required)
+    end
+  end
+end