ssd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3612cdb1ce4050fcce37d43f7bed735b2ab3a8e3
+  data.tar.gz: 034c08db0254a426d7236d79374ff042e1ea5c5e
+SHA512:
+  metadata.gz: 1e7700b75c47565ac400f184fee70134bf52e94f69dca1a923a25dea8a0d8db008b408775461e27dd0b791fa7909c64c726436a7b4184f14a4bf3fa7ee524fb8
+  data.tar.gz: 2e4b4138b8031616a268ccf5fabb1cbff44635467e7fe14231a3b56a59dcee7bc974c990780846e19abfaeb07d5cb8de1b4217dac80c6c754733cde9b61d15ff

data/.gitignore

@@ -0,0 +1,6 @@
+*.swp
+SSD
+*.lock
+*.gem
+.ssd
+pkg

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at zotherstupidguy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ssd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 zotherstupidguy
+
+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,51 @@
+What is SSD?
+==================
+SSD (Simply-Smart-Data) is an append-only, file-based, immutable key-value store for Microservices written in Ruby. 
+
+Key Features
+=================
+- Scalable file-based design (each key gets its own file).
+- Immutable (timestamped inserts).
+- Fault tolerance (transactional operations).
+- Measurably low technical debt (consciously clean small-sized library that wouldn't complect your codebase).
+- Zero external dependencies.
+- Schemaless (easily meets your Application evolution needs).
+- Append-only (easily keeps track of Applications Data timeline).
+- Key-based rolling-forward\rolling-back.
+- Strict Security-first policy SHA256 Encryption (implment your own logging for intercepting keys required for decrypting data).
+- JSON objects (based on ruby's native pstore).
+- RESTful HTTP/JSON API Endpoint.
+- Super easy to learn (up & running in mins).
+
+Use Cases
+==========
+SSD is carefully crafted to scale specially-well with the Microservies Architeturual Pattern to allow providing storage for independently deployable services with ease. 
+
+Usage
+======
+```ruby 
+class User
+ include SSD
+ attr_accessor :id # ssd key
+end
+```
+
+Concerns FAQs
+===============
+Asynchronous I/O [https://en.wikipedia.org/wiki/Asynchronous_I/O]
+
+Other Alternatives
+======================
+- ArangoDB  	[https://www.arangodb.com/].
+- Persistent 	[https://github.com/ismasan/persistent].
+- CouchDB 	[http://couchdb.apache.org/].
+- DataMapper 	[http://github.com/datamapper/dm-core/tree/master]. 
+- Persistable 	[http://github.com/andykent/persistable/tree/master].
+- Stone 	[http://github.com/ndemonner/stone/tree/master].
+
+References
+===========
+- The rise of append-only, immutable data stores. [http://www.pwc.com/us/en/technology-forecast/2015/remapping-database-landscape/features/assets/pwc-append-only-immutable-data-stores-rise.pdf]
+- NoSQL DB. 	[http://nosql-database.org/]
+- Anti-RDBMs. 	[https://www.metabrew.com/article/anti-rdbms-a-list-of-distributed-key-value-stores]
+- Architecture of immutable data stores. [http://www.toadworld.com/platforms/oracle/w/wiki/11548.architecture-of-immutable-data-stores]

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ssd"
+
+# 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

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

@@ -0,0 +1,33 @@
+require 'openssl'
+require 'digest/sha1'
+
+# Get SHA256 Hash of a file
+# puts Digest::SHA256.hexdigest File.read "data.dat"
+# # Get MD5 Hash of a file
+# puts Digest::MD5.hexdigest File.read "data.dat"
+# # Get MD5 Hash of a string
+# puts Digest::SHA256.hexdigest "Hello World"
+#
+# # Get SHA256 Hash of a string using update
+# sha256 = Digest::SHA256.new
+# sha256.update "Hello"
+# sha256.update " World"
+# puts sha256.hexdigest
+
+c = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+c.encrypt
+# your pass is what is used to encrypt/decrypt
+# puts Digest::SHA256.hexdigest "Hello World"
+c.key = key = Digest::SHA256.hexdigest "user_id_1232131313123131313135341"
+#Digest::SHA1.hexdigest("yourpass")
+c.iv = iv = c.random_iv
+e = c.update("this is verylongwithmany special characters jsonfile")
+e << c.final
+puts "encrypted: #{e}\n"
+c = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+c.decrypt
+c.key = key
+c.iv = iv
+d = c.update(e)
+d << c.final
+puts "decrypted: #{d}\n"

data/lib/ssd.rb

@@ -0,0 +1,144 @@
+require 'fileutils'
+require 'logger'
+require 'securerandom'
+require 'pstore'
+require 'digest'
+
+require_relative "./ssd/version"
+
+$log = Logger.new(STDOUT)
+
+module SSD 
+  attr_reader :db
+  attr_reader :path
+
+  def self.included(base)
+    base.send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+
+  module InstanceMethods
+
+    def self.included(base)
+      @@ssd_name  		= base.new.class.to_s.downcase
+    end
+
+    attr_accessor :id
+
+    def id= value
+      @id	= value
+      FileUtils::mkdir_p ".ssd/#{@@ssd_name}"
+      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@id}.ssd" 
+      @@ssd_db 			= PStore.new @@ssd_path, true
+      @@ssd_db.ultra_safe 	= true
+      @@ssd_db.transaction(true) {}
+      return @@ssd_db
+    end
+
+    def transaction
+      @@ssd_db.transaction do
+	yield @@ssd_db
+	@@ssd_db.commit
+      end
+    end
+
+    def []= 
+      begin  
+	if !@id.nil? then 
+	  @@ssd_db.transaction do
+	    #todo should be somthing like??? timestamp instead of id as a key?? and use .last while reading
+	    #@@ssd_db[id.to_sym] = self 
+	    @@ssd_db[Time.now.utc.to_s + "_" + Random.new_seed.to_s ] = self 
+	  end
+	else
+	  raise 'ssd id can not be nil. see more (documentation url)'  
+	end
+      end  
+    end
+
+    alias append []= 
+      alias save []= 
+      alias store []= 
+  end
+
+  module ClassMethods
+    def self.extended(base)
+      @@ssd_name  		= base.new.class.to_s.downcase
+      #FileUtils::mkdir_p 'DS'
+      #@@ssd_path 			= "DS/#{name}.pstore" 
+      #@@ssd_db 			= PStore.new @@ssd_path, true
+      #@@ssd_db.ultra_safe 	= true
+      #@@ssd_db.transaction(true) {}
+      #@@ssd_db
+    end 
+
+    def setup id
+      @@id = id
+      FileUtils::mkdir_p ".ssd/#{@@ssd_name}"
+      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@@id}.ssd" 
+      @@ssd_db 			= PStore.new @@ssd_path, true
+      @@ssd_db.ultra_safe 	= true
+      @@ssd_db.transaction(true) {}
+      return @@ssd_db
+    end
+
+    def last_key id
+      setup id 
+      last_key = @@ssd_db.transaction true do
+	@@ssd_db.roots
+      end
+      last_key.last
+    end
+
+    def keys id
+      setup id 
+      @@ssd_db.transaction true do
+	@@ssd_db.roots
+      end
+    end
+
+    def key? id 
+      setup id 
+      @@ssd_db.transaction true do
+	@@ssd_db.root? id.to_sym
+      end
+    end
+
+    alias exists? key?
+
+    def [] id 
+      setup id 
+      @@ssd_db.transaction true do
+	@@ssd_db[id.to_sym]
+      end
+    end
+
+    def fetch id  
+      #TODO add raise if id.nil?
+      last_key = (last_key id) 
+      @@ssd_db.transaction true do
+	@@ssd_db.fetch last_key
+      end
+    end
+
+    alias get fetch 
+    alias find fetch 
+
+    def delete *ids
+      @@ssd_db.transaction do
+	ids.each do |id|
+	  @@ssd_db.delete id.to_sym
+	end
+	@@ssd_db.commit
+      end
+    end
+    alias remove delete
+
+    def count id
+      setup id 
+      $log.info("count")
+      return keys(id).count
+    end
+  end
+
+end

data/lib/ssd/version.rb

@@ -0,0 +1,3 @@
+module SSD
+  VERSION = "0.1.0"
+end

data/specs/spec_helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+require "minitest/pride"
+
+require_relative "./../lib/ssd"

data/specs/ssd_spec.rb

@@ -0,0 +1,55 @@
+require_relative "./spec_helper"
+
+describe SSD do
+
+  before do
+    class User 
+      include SSD
+      attr_accessor :first_name, :last_name, :location
+    end
+
+    @generated_id = Random.new.seed
+  end
+
+  describe "#append" do
+    it "saves an object to the database" do
+      #skip
+      @user 	= User.new
+      @user.id	= @generated_id
+      @user.append
+      @user.id.must_equal @generated_id
+    end
+  end
+
+  describe "#read" do
+    it "fetches an object from the database" do
+      #    skip
+      @user 	= User.new
+      @user.id	= @generated_id
+      @user.append
+      user = User.get(@generated_id)
+      user.id.must_equal @generated_id
+    end
+  end
+
+  describe "an append-only operations" do
+    it "it keeps adding new objects" do
+      @user 		= User.new
+
+      @user.id		= @generated_id 
+      @user.location	= "Egypt"
+      @user.append
+
+      @user = User.get(@generated_id)
+      @user.location = "Brazil"
+      @user.append
+
+      @user = User.get(@generated_id)
+      @user.location = "France"
+      @user.append
+
+      User.count(@generated_id).must_equal 3
+    end
+  end
+
+end

data/ssd.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ssd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ssd"
+  spec.version       = SSD::VERSION
+  spec.authors       = ["zotherstupidguy"]
+  spec.email         = ["zotherstupidguy@gmail.com"]
+
+  spec.summary       = %q{SSD is an append-only, file-based, immutable key-value store for Microservices written in Ruby.}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/ssd-rb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ssd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zotherstupidguy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- zotherstupidguy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/encrypt.rb
+- lib/ssd.rb
+- lib/ssd/version.rb
+- logo.png
+- specs/spec_helper.rb
+- specs/ssd_spec.rb
+- ssd.gemspec
+homepage: https://github.com/ssd-rb
+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.5.1
+signing_key: 
+specification_version: 4
+summary: SSD is an append-only, file-based, immutable key-value store for Microservices
+  written in Ruby.
+test_files: []