rubychain 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66da55fa18e22f2764bcf37fd1d13c9ee06ddd3f
+  data.tar.gz: 5c40b12e0a86a9aebe81470e77e970899fdd93e5
+SHA512:
+  metadata.gz: 68d24a8d28939700a4872180812b843f17720c9a9e97d8bd5fed59ee790795bc99cb1b9b1c45246138afefc113f64a4cfba9dfadd6c7311830e24619a5d5b7ea
+  data.tar.gz: 806220f881b10756730362fc2d2d59e9c4aeb85ee6042f5ecd2842962093b705f45970b5ac3111c7b2630dc7bf15c48a12c8032de5d0ec87fd4c27da592948be

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore environment specific files
+*.swp
+.DS_Store
+
+# Ignore gemfiles
+*.gem

data/.rspec

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

data/.travis.yml

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

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 rubychain.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    rubychain (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubychain!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Stuart Hanscombe
+
+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,111 @@
+# Rubychain
+
+Rubychain is a very simple implementation of a blockchain for education purposes.
+It is heavily inspired by the python version
+which can be found here: https://dev.to/aunyks/lets-build-the-tiniest-blockchain
+
+There are only 2 classes which are /lib/rubychain/chain and /lib/rubychain/block
+
+`Rubychain::Chain` for creating, updating and exploring the blockchain
+
+`Rubychain::Block` for creating each individual block
+
+Check out the instructions below or the specs to see how it all works
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubychain'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubychain
+
+## Usage
+
+require 'rubychain'
+
+## Rubychain::Chain
+### Available methods
+
+`add_next_block(prev_block, data)` => Adds a new block to the blockchain with the given data and previous block
+
+`genesis_block` => Returns the Genesis block
+
+`last_block` => Returns the last block that was added to the blockchain
+
+`find_block(hash)` => Returns a block from the blockchain with the given hash
+
+`blockchain` => Returns the whole blockchain as an array
+
+### Exploring the blockchain
+
+Initialize a new blockchain with a genesis block:
+
+`rc = Rubychain::Chain.new`
+
+`rc.add_next_block(rc.last_block, "some data")` => creates a new block with given data and previous block
+
+`rc.genesis_block` => returns the genesis block
+
+`rc.last_block` => returns the last block on the blockchain
+
+`rc.find_block(hash)` => return the block with the given hash
+
+`rc.blockchain` => [genesis_block, block2] => Returns the whole blockchain as an array
+
+## Rubychain::Block
+### Available methods
+
+`index` => returns the blocks index
+
+`timestamp` => returns the blocks timestamp
+
+`data` => returns the blocks data
+
+`prev_hash` => returns the previous blocks hash
+
+`hash` => returns a SHA256 hash representation of all the items in the block
+
+### Exploring a block
+
+`myblock = rc.last_block`
+
+or
+
+`myblock = rc.find_block(hash)`
+
+or directly
+
+`myblock = Rubychain::Block.new(1, Time.now, "Hello World", "abc123")`
+
+`myblock.index` => 1
+
+`myblock.timestamp` => Time of creation
+
+`myblock.data` => "Hello World"
+
+`myblock.pre_hash` => "abc123"
+
+`myblock.hash` => sha.hexdigest of index, timestamp, data and previous block hash
+
+## 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/[USERNAME]/rubychain.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "rubychain"
+
+# 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/lib/rubychain.rb

@@ -0,0 +1,8 @@
+require "rubychain/version"
+require 'rubychain/block'
+require 'rubychain/chain'
+
+module Rubychain
+
+
+end

data/lib/rubychain/block.rb

@@ -0,0 +1,26 @@
+require 'digest'
+
+module Rubychain
+  class Block
+
+    attr_reader :index, :timestamp, :data, :prev_hash, :hash
+
+    def initialize(index, timestamp, data, prev_hash)
+      @index = index
+      @timestamp = timestamp
+      @data = data
+      @prev_hash = prev_hash
+      @hash = hash_block
+    end
+
+    # Create the blocks hash by encrypting all the blocks data using SHA256
+
+    def hash_block
+      hash_string = [index,timestamp,data,prev_hash].join
+      sha = Digest::SHA256.new
+      sha.update(hash_string)
+      sha.hexdigest
+    end
+
+  end
+end

data/lib/rubychain/chain.rb

@@ -0,0 +1,61 @@
+module Rubychain
+  class Chain
+
+    attr_reader :blockchain
+
+    class InvalidBlockError < StandardError; end
+
+    # Initialize a new blockchain by creating a new array with the Genesis block
+    #
+    def initialize
+      @blockchain = [create_genesis_block]
+    end
+
+    # #add_next_block => Adds a new block to the blockchain with the given data
+    # it will raise an error if the previous_block hash does not match the last_block in our blockchain
+    #
+    def add_next_block(prev_block, data)
+      if valid_block?(prev_block)
+        blockchain << next_block(data)
+      else
+        raise InvalidBlockError
+      end
+    end
+
+    # #genesis_block => Returns the Genesis block
+    #
+    def genesis_block
+      blockchain.first
+    end
+
+    # #last_block => Returns the last block that was added to the blockchain
+    #
+    def last_block
+      blockchain.last
+    end
+
+    # #find_block(hash) => Returns a block from the blockchain with the given hash
+    #
+    def find_block(hash)
+      blockchain.select{|block| block if block.hash == hash}.first
+    end
+
+    private
+
+    def valid_block?(prev_block)
+      prev_block.hash == last_block.hash
+    end
+
+    def next_block(data)
+      index = last_block.index + 1
+      timestamp = Time.now
+      hash = last_block.hash
+      Block.new(index, timestamp, data, hash)
+    end
+
+    def create_genesis_block()
+      Block.new(0, Time.now, "Genesis Block", 0)
+    end
+
+  end
+end

data/lib/rubychain/version.rb

@@ -0,0 +1,3 @@
+module Rubychain
+  VERSION = "1.0.0"
+end

data/rubychain.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubychain/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubychain"
+  spec.version       = Rubychain::VERSION
+  spec.authors       = ["Stuart Hanscombe"]
+  spec.email         = ["hanscs1969@yahoo.co.uk"]
+
+  spec.summary       = "A simple blockchain built on Ruby"
+  spec.description   = "A very simple ruby implementation of a blockchain, based on python version: https://dev.to/aunyks/lets-build-the-tiniest-blockchain"
+  spec.homepage      = "https://github.com/thelazycamel/rubychain"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rubychain
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stuart Hanscombe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 'A very simple ruby implementation of a blockchain, based on python version:
+  https://dev.to/aunyks/lets-build-the-tiniest-blockchain'
+email:
+- hanscs1969@yahoo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubychain.rb
+- lib/rubychain/block.rb
+- lib/rubychain/chain.rb
+- lib/rubychain/version.rb
+- rubychain.gemspec
+homepage: https://github.com/thelazycamel/rubychain
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A simple blockchain built on Ruby
+test_files: []