ledger-lite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc54a08adc58f1f0a7c50cb0ce42439ed2dd5312
+  data.tar.gz: '05199c14456c983c82d94981f098075ea49d743b'
+SHA512:
+  metadata.gz: e52f287dbe9e9aff4cfe896f728a19c060e730bc86db485e1ff555ac6df3239d1b032f48684adf91b8810f97e50f57cc3ae60055d0398d588ca9339a5faddfa8
+  data.tar.gz: a4fbb0a4344cdd8dfe161c5ec855e9e49943d4414c29b58da4cf829ffb09664b10a95b313faf45c697e9b05657c3c780f09434c99aaa4849c7a1064253759fc2

data/HISTORY.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2018-01-02
+
+* Everything is new. First release

data/LICENSE.md

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/Manifest.txt

@@ -0,0 +1,9 @@
+HISTORY.md
+LICENSE.md
+Manifest.txt
+README.md
+Rakefile
+lib/ledger-lite.rb
+lib/ledger-lite/version.rb
+test/helper.rb
+test/test_transfer.rb

data/README.md

@@ -0,0 +1,19 @@
+# Ledger Lite (Ruby Edition)
+
+ledger-lite library / gem - hyper ledger book for the distributed blockchain internet era; add your transactions one block at a time; transfer crypto(currencie)s and balance the accounts
+
+
+* home  :: [github.com/openblockchains/ledger.lite.rb](https://github.com/openblockchains/ledger.lite.rb)
+* bugs  :: [github.com/openblockchains/ledger.lite.rb/issues](https://github.com/openblockchains/ledger.lite.rb/issues)
+* gem   :: [rubygems.org/gems/ledger-lite](https://rubygems.org/gems/ledger-lite)
+* rdoc  :: [rubydoc.info/gems/ledger-lite](http://rubydoc.info/gems/ledger-lite)
+
+
+
+
+## License
+
+![](https://publicdomainworks.github.io/buttons/zero88x31.png)
+
+The `ledger-lite` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'hoe'
+require './lib/ledger-lite/version.rb'
+
+Hoe.spec 'ledger-lite' do
+
+  self.version = LedgerLite::VERSION
+
+  self.summary = "ledger-lite -  hyper ledger book for the distributed blockchain internet era; add your transactions one block at a time; transfer crypto(currencie)s and balance the accounts"
+  self.description = summary
+
+  self.urls    = ['https://github.com/openblockchains/ledger.lite.rb']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'HISTORY.md'
+
+  self.extra_deps = [
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end

data/lib/ledger-lite.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+
+require 'pp'        # for pp => pretty printer
+
+require 'date'
+require 'time'
+require 'json'
+
+
+
+## our own code
+require 'ledger-lite/version'    # note: let version always go first
+
+
+
+module LedgerLite
+
+class Ledger
+
+  attr_reader :addr     ## make addr private e.g. remove - why? e.g. use hash forwards/delegates - why not?
+
+  def initialize( args=[] )
+    ## todo/fix: use *args - same interface as merkletree/blochchain-lite
+
+    @addr = {}
+
+    args.each do |arg|
+      if arg.respond_to?( :transactions )   ## bingo! assume it's block if it has transactions method
+        transfer( arg.transactions )
+      else
+        transfer( arg )
+      end
+    end
+  end # method initialize
+
+
+
+  ##
+  # find a better name - why? why not?
+  ##  e.g. use can? funds? sufficient? has_funds?
+  def sufficient_funds?( addr, amount )
+    ## fix:
+    true
+  end
+
+
+  def transfer( arg )
+    ## todo/fix: use *args - same interface as merkletree/blochchain-lite
+
+    puts "transfer:"
+    pp arg
+
+    if arg.is_a?( Array )
+      txs = arg
+      txs.each { |tx| do_transfer( *unpack(tx) ) }  ## unpack & unsplat array (to pass in args) => from, to, amount
+    else
+      ## assume single tx
+      tx = arg
+      do_transfer( *unpack(tx) )  ## unpack & unsplat array (to pass in args) => from, to, amount
+    end
+  end
+
+
+  def unpack( tx )
+    ## "unpack" from, to, amount values
+
+    puts "unpack:"
+    pp tx
+
+    if tx.is_a?( Hash )   ## support hashes
+      from   = tx[:from]
+      to     = tx[:to]
+      amount = tx[:amount]
+    else   ## assume it's a transaction (tx) struct/class
+      from   = tx.from
+      to     = tx.to
+      amount = tx.amount
+    end
+    [from,to,amount]
+  end
+
+
+  ## apply/do single transaction
+  ##  - find a different name - why? why not?
+  def do_transfer( from, to, amount )
+
+    if sufficient_funds?( from, amount )
+      @addr[ from ] ||= 0
+      @addr[ from ] -= amount
+      @addr[ to ] ||= 0
+      @addr[ to ] += amount
+    end
+
+  end  # do_transfer
+
+
+end # class Ledger
+
+end # module LedgerLite
+
+
+###
+# add convenience top-level shortcut / alias
+Ledger = LedgerLite::Ledger
+
+# say hello
+puts LedgerLite.banner    if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG

data/lib/ledger-lite/version.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+
+module LedgerLite
+
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "ledger-lite/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end
+
+end # module LedgerLite

data/test/helper.rb

@@ -0,0 +1,50 @@
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+
+require 'ledger-lite'
+
+
+
+## some helper classes for testing
+
+class Transaction
+
+  attr_reader :from, :to, :amount
+
+  #####
+  # flexible for testing - allows:
+  #  Tx.new( 'Alice', 'Bob', 12 )
+  #  Tx.new( from: 'Alice', to: 'Bob', amount: 12 )
+
+  def initialize( *args, **kwargs )
+    if args.empty? # try keyword args
+      @from   = kwargs[:from]
+      @to     = kwargs[:to]
+      @amount = kwargs[:amount]
+    else           # try positional args
+      @from   = args[0]
+      @to     = args[1]
+      @amount = args[2]
+    end
+  end
+
+end # class Transaction
+
+Tx = Transaction  ## convenience shortcut
+
+
+class Block
+  def initialize( *transactions )
+    @transactions = transactions
+  end
+
+  def transactions
+    @transactions
+  end
+end  # class Block

data/test/test_transfer.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_transfer.rb
+
+
+require 'helper'
+
+
+class TestTransfer < MiniTest::Test
+
+
+def test_do_transfer
+
+  ledger = Ledger.new
+
+  ledger.do_transfer( "Vicent",  "Anne",    3 )
+  ledger.do_transfer( "Anne",    "Julia",   2 )
+  ledger.do_transfer( "Julia",   "Luuk",    1 )
+
+  ledger.do_transfer( "Vincent", "Max",     3 )
+  ledger.do_transfer( "Anne",    "Martijn", 2 )
+  ledger.do_transfer( "Ruben",   "Julia",   1 )
+
+  pp ledger
+
+  balances = {"Vicent"=>-3,
+              "Anne"=>-1,
+              "Julia"=>2,
+              "Luuk"=>1,
+              "Vincent"=>-3,
+              "Max"=>3,
+              "Martijn"=>2,
+              "Ruben"=>-1}
+  assert_equal balances, ledger.addr
+end
+
+
+def test_transfer_with_tx_v1
+
+  ledger = Ledger.new
+
+  ledger.transfer( Tx.new( "Vicent",  "Anne",    3 ))
+  ledger.transfer( Tx.new( "Anne",    "Julia",   2 ))
+  ledger.transfer( Tx.new( "Julia",   "Luuk",    1 ))
+
+  ledger.transfer( Tx.new( "Vincent", "Max",     3 ))
+  ledger.transfer( Tx.new( "Anne",    "Martijn", 2 ))
+  ledger.transfer( Tx.new( "Ruben",   "Julia",   1 ))
+
+  pp ledger
+
+  balances = {"Vicent"=>-3,
+              "Anne"=>-1,
+              "Julia"=>2,
+              "Luuk"=>1,
+              "Vincent"=>-3,
+              "Max"=>3,
+              "Martijn"=>2,
+              "Ruben"=>-1}
+  assert_equal balances, ledger.addr
+end
+
+
+def test_transfer_with_tx_v2
+
+  ledger = Ledger.new
+
+  ledger.transfer( [Tx.new( "Vicent",  "Anne",    3 ),
+                    Tx.new( "Anne",    "Julia",   2 ),
+                    Tx.new( "Julia",   "Luuk",    1 )])
+
+  ledger.transfer( [Tx.new( "Vincent", "Max",     3 ),
+                    Tx.new( "Anne",    "Martijn", 2 ),
+                    Tx.new( "Ruben",   "Julia",   1 )])
+
+  pp ledger
+
+  balances = {"Vicent"=>-3,
+              "Anne"=>-1,
+              "Julia"=>2,
+              "Luuk"=>1,
+              "Vincent"=>-3,
+              "Max"=>3,
+              "Martijn"=>2,
+              "Ruben"=>-1}
+  assert_equal balances, ledger.addr
+end
+
+
+def test_transfer_with_hash
+
+  ledger = Ledger.new
+
+  ledger.transfer( [{ from: "Vicent",  to: "Anne",  amount: 3 },
+                    { from: "Anne",    to: "Julia", amount: 2 },
+                    { from: "Julia",   to: "Luuk",  amount: 1 }])
+
+  ledger.transfer( [{ from: "Vincent", to: "Max",     amount: 3 },
+                    { from: "Anne",    to: "Martijn", amount: 2 },
+                    { from: "Ruben",   to: "Julia",   amount: 1 }])
+
+  pp ledger
+
+  balances = {"Vicent"=>-3,
+              "Anne"=>-1,
+              "Julia"=>2,
+              "Luuk"=>1,
+              "Vincent"=>-3,
+              "Max"=>3,
+              "Martijn"=>2,
+              "Ruben"=>-1}
+  assert_equal balances, ledger.addr
+end
+
+
+end  # class TestTransfer

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: ledger-lite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: ledger-lite -  hyper ledger book for the distributed blockchain internet
+  era; add your transactions one block at a time; transfer crypto(currencie)s and
+  balance the accounts
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- HISTORY.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+files:
+- HISTORY.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/ledger-lite.rb
+- lib/ledger-lite/version.rb
+- test/helper.rb
+- test/test_transfer.rb
+homepage: https://github.com/openblockchains/ledger.lite.rb
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: ledger-lite -  hyper ledger book for the distributed blockchain internet
+  era; add your transactions one block at a time; transfer crypto(currencie)s and
+  balance the accounts
+test_files: []