diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ee23c51 --- /dev/null +++ b/.gitignore @@ -0,0 +1,31 @@ +*.gem +*.rbc +/.config +/coverage/ +/InstalledFiles +/pkg/ +/spec/reports/ +/test/tmp/ +/test/version_tmp/ +/tmp/ + + +## Documentation cache and generated files: +/.yardoc/ +/_yardoc/ +/doc/ +/rdoc/ + +## Environment normalisation: +/.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 diff --git a/HISTORY.md b/HISTORY.md new file mode 100644 index 0000000..4525210 --- /dev/null +++ b/HISTORY.md @@ -0,0 +1,3 @@ +### 0.0.1 / 2017-09-16 + +* Everything is new. First release diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..72cdf27 --- /dev/null +++ b/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 + diff --git a/Manifest.txt b/Manifest.txt new file mode 100644 index 0000000..f1dac7d --- /dev/null +++ b/Manifest.txt @@ -0,0 +1,7 @@ +HISTORY.md +LICENSE.md +Manifest.txt +README.md +Rakefile +lib/blockchainlite.rb +lib/blockchainlite/version.rb diff --git a/README.md b/README.md index 7e9512b..4e6a5ea 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,80 @@ -# blockchain.lite -blockchainlite gem - build your own blockchain with crypto hashes - revolutionize the world with blockchains, blockchains, blockchains - on block at a time +# Blockchain Lite + +blockchainlite gem - build your own blockchain with crypto hashes - revolutionize the world with blockchains, blockchains, blockchains on block at a time + +* home :: [github.com/rubylibs/blockchain.lite](https://github.com/rubylibs/blockchain.lite) +* bugs :: [github.com/rubylibs/blockchain.lite/issues](https://github.com/rubylibs/blockchain.lite/issues) +* gem :: [rubygems.org/gems/blockchainlite](https://rubygems.org/gems/blockchainlite) +* rdoc :: [rubydoc.info/gems/blockchainlite](http://rubydoc.info/gems/blockchainlite) + + +## What's a Blockchain? + +> A blockchain (originally block chain) is a distributed database +> with a linked list (that is, chain) of records (that is, blocks) +> secured by crypto(graphic) hashes. + +See the [Awesome Blockchains](https://github.com/planetopendata/awesome-blockchains) page for more. + + +## Usage + +Let's get started. Build your own blockchain a block at a time. +Example: + + +``` ruby +require 'blockchainlite' + +b0 = Block.first( "Genesis" ) +b1 = Block.next( b0, "Transaction Data..." ) +b2 = Block.next( b1, "Transaction Data......" ) +b3 = Block.next( b2, "More Transaction Data..." ) + +blockchain = [b0, b1, b2, b3] + +pp blockchain + +###### +# will pretty print (pp) something like: +# +# [#, +# #, +# #, +# #] +``` + + +## Install + +Just install the gem: + + $ gem install blockchainlite + + +## License + +![](https://publicdomainworks.github.io/buttons/zero88x31.png) + +The `blockchain.lite` scripts are dedicated to the public domain. +Use it as you please with no restrictions whatsoever. diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..6b2c5c0 --- /dev/null +++ b/Rakefile @@ -0,0 +1,29 @@ +require 'hoe' +require './lib/blockchainlite/version.rb' + +Hoe.spec 'blockchainlite' do + + self.version = BlockchainLite::VERSION + + self.summary = "blockchainlite - build your own blockchain with crypto hashes - revolutionize the world with blockchains, blockchains, blockchains on block at a time" + self.description = summary + + self.urls = ['https://github.com/rubylibs/blockchain.lite'] + + 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 diff --git a/lib/blockchainlite.rb b/lib/blockchainlite.rb new file mode 100644 index 0000000..1fbd112 --- /dev/null +++ b/lib/blockchainlite.rb @@ -0,0 +1,11 @@ +# encoding: utf-8 + +require 'pp' + + +## our own code +require 'blockchainlite/version' # note: let version always go first + + +pp BlockchainLite.banner +pp BlockchainLite.root diff --git a/lib/blockchainlite/version.rb b/lib/blockchainlite/version.rb new file mode 100644 index 0000000..ed44526 --- /dev/null +++ b/lib/blockchainlite/version.rb @@ -0,0 +1,23 @@ +# encoding: utf-8 + + +module BlockchainLite + + MAJOR = 0 + MINOR = 0 + PATCH = 1 + VERSION = [MAJOR,MINOR,PATCH].join('.') + + def self.version + VERSION + end + + def self.banner + "blockchainlite/#{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 BlockchainLite