lisk 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ae0ec3ce26db828b0aae312d3caaa44a0c4dce7
+  data.tar.gz: ea7aab7e631ce1324b4be92fd364392c7dbc1b5c
+SHA512:
+  metadata.gz: 1602e278569adf67a0219260721333fd93218c4d8249f5c076647bf6719353f6a1e1004708f40c7ffff64a1138efbc696e750d8b798716f7123c2de95a1f1469
+  data.tar.gz: ce32d974e5623ca732af30f88813ca5734c6e01be2097cf9791386f9b67321c856d6e7a06220a248be6e544090858e7c731598aba7966d1097f5e8bc444ac221

data/.gitignore

@@ -0,0 +1,64 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# bundle
+/.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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

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 4fryn@users.noreply.github.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 lisk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 4fryn
+
+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,117 @@
+# Lisk.rb
+
+A simple Ruby wrapper for the Lisk API. 💎
+
+## Note before using
+
+This is very early work-in-progress. The idea is to publish this `gem` as soon as it is fully compatible with Lisk Core 1.0.0, which, however, is not released yet. The current implementation of the lisk.rb gem is pure minimal by design and barely allows checking the node status.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lisk'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install lisk
+```
+
+## Usage
+
+Make sure to include lisk.rb in your scripts.
+
+```ruby
+require 'lisk'
+```
+
+To get started, point the lisk.rb to any Lisk-API endpoint. By default, lisk.rb assumes a running Lisk node on localhost port 8000.
+
+```ruby
+client = Lisk::Client.new "127.0.0.1", 8000
+```
+
+For convenience, check if the Lisk node is connected, fully synchronized, and active by pinging it.
+
+```ruby
+if client.ping
+  # only do stuff if client is connected, fully synchronized, and active ...
+end
+```
+
+Get the version of the connected Lisk node.
+
+```ruby
+version = client.version
+p "Lisk node version #{version["version"]} build #{version["build"]}..."
+```
+
+Get the status of the connected Lisk node.
+
+```ruby
+status = client.status
+p "Lisk node is connected: #{status["success"]}... Blockchain loaded: #{status["loaded"]}..."
+```
+
+Figure out if the node is still synchronizing.
+
+```ruby
+syncing = client.sync
+p "Lisk node is syncing: #{syncing["syncing"]}... #{syncing["blocks"]} remaining blocks to latest block #{syncing["height"]}..."
+```
+
+Let's have a look at the connected peers.
+
+```ruby
+peers = client.peers
+cond = 0
+disd = 0
+band = 0
+peers.each do | peer |
+  case peer["state"]
+  when 0
+    band += 1
+  when 1
+    disd += 1
+  when 2
+    cond += 1
+  end
+end
+p "Lisk node saw #{peers.count} peers... #{cond} connected, #{disd} disconnected, #{band} banned..."
+```
+
+Get some global Lisk blockchain stats.
+
+```ruby
+chain = client.chain
+p "Lisk chain latest block: #{chain["height"]}... total supply: #{chain["supply"] / 1e8}... block reward: #{chain["reward"] / 1e8}"
+```
+
+To be continued, see `example.rb` for some examples.
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/4fryn/lisk.rb. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lisk.rb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/4fryn/lisk.rb/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 "lisk"
+
+# 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/debug

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+echo $PWD
+
+gem uninstall lisk
+rm pkg/*.gem
+git add -A
+bundle exec rake install
+ruby example.rb

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/example.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'lisk'
+
+# Try to connect a local Lisk client
+client = Lisk::Client.new
+
+# Configure host and port of the Lisk client
+client.configure "127.0.0.1", 8000
+
+# Same as above, just in one line
+client = Lisk::Client.new "127.0.0.1", 8000
+
+if client.ping
+  version = client.version
+  p "Lisk node version #{version["version"]} build #{version["build"]}..."
+
+  status = client.status
+  p "Lisk node is connected: #{status["success"]}... Blockchain loaded: #{status["loaded"]}..."
+
+  syncing = client.sync
+  p "Lisk node is syncing: #{syncing["syncing"]}... #{syncing["blocks"]} remaining blocks to latest block #{syncing["height"]}..."
+
+  peers = client.peers
+  cond = 0
+  disd = 0
+  band = 0
+  peers.each do | peer |
+    case peer["state"]
+    when 0
+      band += 1
+    when 1
+      disd += 1
+    when 2
+      cond += 1
+    end
+  end
+  p "Lisk node saw #{peers.count} peers... #{cond} connected, #{disd} disconnected, #{band} banned..."
+
+  chain = client.chain
+  p "Lisk chain latest block: #{chain["height"]}... total supply: #{chain["supply"] / 1e8}... block reward: #{chain["reward"] / 1e8}"
+else
+  p 'Lisk node disconnected or inactive ...'
+end
+
+#account = Lisk::Account.new("14524922419337843943L")
+#client.get_address(account)
+#block = Lisk::Block.new("11145685198263496703")
+#delegate = Lisk::Delegate.new("lightcurve")
+#client.get_address(delegate)
+#client.get_voters(delegate)
+#transaction = Lisk::Transaction.new("10153999325502978458")

data/lib/lisk/client.rb

@@ -0,0 +1,73 @@
+require "net/http"
+require "uri"
+require "json"
+
+module Lisk
+  class Client
+
+    attr_accessor :host, :port
+
+    def initialize host = "127.0.0.1", port = 8000
+      @host = host
+      @port = port
+    end
+
+    def configure host, port
+      if not host.empty? or not port.empty?
+        @host = host
+        @port = port
+      end
+    end
+
+    def query endpoint
+      node = ::Net::HTTP.new @host, @port
+      uri = URI.parse "http://#{host}:#{port}/api/#{endpoint}"
+      request = ::Net::HTTP::Get.new uri
+      response = node.request request
+      result = JSON::parse response.body
+    end
+
+    # Get the status of last received block.
+    # Returns true if block was received in the past 120 seconds.
+    def ping
+      ping = self.query "loader/status/ping"
+      ping["success"]
+    end
+
+    # Returns the sync status of the blockchain.
+    def status
+      status = self.query "loader/status"
+    end
+
+    # Get the synchronization status of the client.
+    def sync
+      sync = self.query "loader/status/sync"
+    end
+
+    # Gets list of peers.
+    def peers
+      peers = self.query "peers"
+      if peers["success"]
+        return peers["peers"]
+      else
+        return peers
+      end
+    end
+
+    # Gets version and build time.
+    def version
+      version = self.query "peers/version"
+    end
+
+    # Gets status of height, fee, milestone, blockreward and supply.
+    def chain
+      chain = self.query "blocks/getStatus"
+    end
+
+    # Unimplemented methods
+    def method_missing(name, *args, &block)
+      todo "#{self}::#{name} METHOD MISSING"
+    end
+
+  end
+end

data/lib/lisk/version.rb

@@ -0,0 +1,3 @@
+module Lisk
+  VERSION = "0.2.0"
+end

data/lib/lisk.rb

@@ -0,0 +1,11 @@
+require "lisk/version"
+require "todonotes"
+
+module Lisk
+  require "lisk/client"
+
+  # Unimplemented methods
+  def self.method_missing
+    todo "#{self}::#{__method__} METHOD MISSING"
+  end
+end

data/lisk.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lisk/version"
+
+Gem::Specification.new do |lisk|
+  lisk.name          = "lisk"
+  lisk.version       = Lisk::VERSION
+  lisk.authors       = ["4fryn Dings"]
+  lisk.email         = ["ruby@4fry.net"]
+
+  lisk.description   = 'A Ruby wrapper for the Lisk blockchain platform API.'
+  lisk.homepage      = 'https://github.com/4fryn/lisk.rb'
+  lisk.summary       = 'Lisk API Ruby wrapper.'
+  lisk.license       = "MIT"
+
+  lisk.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  lisk.bindir        = "exe"
+  lisk.executables   = lisk.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  lisk.require_paths = ["lib", "bin"]
+
+  lisk.add_development_dependency "bundler", "~> 1.15"
+  lisk.add_development_dependency "rake", "~> 10.0"
+  lisk.add_development_dependency "rspec", "~> 3.0"
+
+  lisk.add_dependency "todonotes", "~> 0.2.2"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: lisk
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- 4fryn Dings
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: todonotes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: A Ruby wrapper for the Lisk blockchain platform API.
+email:
+- ruby@4fry.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/debug
+- bin/setup
+- example.rb
+- lib/lisk.rb
+- lib/lisk/client.rb
+- lib/lisk/version.rb
+- lisk.gemspec
+homepage: https://github.com/4fryn/lisk.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Lisk API Ruby wrapper.
+test_files: []