ssd 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66fbedba3d0cd3cae41d234f436fd58b706d0fd7
-  data.tar.gz: 13b3f1c961041b5ce1f3b93b961597c374dd1b90
+  metadata.gz: deeb33a039ae9fe9134ce820c77d31dbebdac967
+  data.tar.gz: a5ff690e9e4104f532d4f05065899ea5cd49c45c
 SHA512:
-  metadata.gz: 2afea1097690895891a0cd9c7f6e6037ef8e53cc0e5db637e86426ee518dfd777097afd6e9f6b9e562a1ff1e9436695f6548d737951f07f123e2b555a5dbe4cc
-  data.tar.gz: 7bf3abe7e9b32b7fe3b7b8f31f00278acc8cb36e7fa8c468ae0cce283743d8cbfe9649216233fd0306e9b0fb157da3cc9639a62bf5d42872870375e36d15603d
+  metadata.gz: 2be1fd3a716666afba008493a4c177315682e46afc679d3099058d512c7b04579420c012bac67b96ca1bc8b832c3cc87e644bd2f127d3bcf896f3588899cb15a
+  data.tar.gz: 0ed3aed894aefe020752028fb59901bb983c205c9746ceeb40ce7f5cfbd92f23eeb08c9fea7c9955e58d014fcfd7644130f84a2c8a120dd99a9d000eafac1bcc

data/README.md

@@ -4,18 +4,23 @@ SSD (Simply-Smart-Data) is an append-only, file-based, immutable key-value store
 
 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).
+- **Scalable file**-based design (each key gets its own file).
+- **Immutable** (timestamped inserts as **accountants don't use erasers, otherwise they go to jail**).
+- **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**.
+- **Super easy to learn and use** (up & running in mins).
+
+TODO
+======
+- **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**.
+- REPL console
+- Server Web-based Admin Interface
 
 Use Cases
 ==========
@@ -28,14 +33,17 @@ module MyApp
  class User
   include SSD
   attr_accessor :id # ssd key
+  
+  def initialize id
+   @ssd = id
+  end
  end
 
  class API < Sinatra::Base
    get '/' do 
-     @user = User.new		# Initialize an object form any Class that `include SSD`
-     @user.id = "generated_id" 	# Give it an ssd key via it's :id
-     @user.append! 		# Do an `append!` operation and viola! DONE 
-     User.ssd("generated_id")  	# Later to read it via Class.ssd(id)
+     @user = User.new("generated_id")		# Initialize an object form any Class that `include SSD` and assign it a :ssd key 
+     @user.append! 				# Do an `append!` operation and viola! DONE 
+     @user = User.ssd("generated_id")  			# Afterwards read it via Class.ssd(:ssd)
    end
  end
 end

data/bin/console

@@ -6,9 +6,5 @@ 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/repl.rb

@@ -0,0 +1,41 @@
+puts "SSD Console -h for help"
+puts " "
+puts " "
+
+def colorize(text, color_code)
+  "#{color_code}#{text}e[0m"
+end
+
+def red(text); colorize(text, "e[31m"); end
+def green(text); colorize(text, "e[32m"); end
+
+# Actual work
+puts 'Importing categories [ ' + green('DONE') + ' ]'
+# Actual work
+puts 'Importing tags       [' + red('FAILED') + ']'
+
+# Handle the input, this would probably run some method
+# as a part of the DSL you'd have to create. Place this
+# repl as your command line interface to your service.
+def handle_input(input)
+  result = eval(input)
+  puts(" => #{result}")
+end
+
+# This is a lambda that runs the content of the block
+# after the input is chomped.
+repl = -> prompt do
+  begin
+    print prompt
+    handle_input(gets.chomp!)
+  rescue "Error"
+    raise "ERROR"
+  end
+end
+
+# After evaling and returning, fire up the prompt lambda
+# again, this loops after every input and exits with
+# exit or a HUP.
+loop do
+  repl["SSD> "]
+end

data/lib/ssd.rb

@@ -23,12 +23,12 @@ module SSD
       @@ssd_name  		= base.new.class.to_s.downcase
     end
 
-    attr_accessor :id
+    attr_accessor :ssd
 
-    def id= value
-      @id	= value
+    def ssd= value
+      @ssd	= value
       FileUtils::mkdir_p ".ssd/#{@@ssd_name}"
-      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@id}.ssd" 
+      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@ssd}.ssd" 
       @@ssd_db 			= PStore.new @@ssd_path, true
       @@ssd_db.ultra_safe 	= true
       @@ssd_db.transaction(true) {}
@@ -44,14 +44,13 @@ module SSD
 
     def []= 
       begin  
-	if !@id.nil? then 
+	if !@ssd.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 
+	    #todo should be somthing like??? timestamp instead of ssd as a key?? and use .last while reading
 	    @@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)'  
+	  raise 'ssd key can not be nil. see more (documentation url)'  
 	end
       end  
     end
@@ -72,50 +71,50 @@ module SSD
       #@@ssd_db
     end 
 
-    def setup id
-      @@id = id
+    def setup ssd 
+      @@ssd = ssd
       FileUtils::mkdir_p ".ssd/#{@@ssd_name}"
-      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@@id}.ssd" 
+      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@@ssd}.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 
+    def last_key ssd 
+      setup ssd
       last_key = @@ssd_db.transaction true do
 	@@ssd_db.roots
       end
       last_key.last
     end
 
-    def keys id
-      setup id 
+    def keys ssd
+      setup ssd
       @@ssd_db.transaction true do
 	@@ssd_db.roots
       end
     end
 
-    def key? id 
-      setup id 
+    def key? ssd 
+      setup ssd
       @@ssd_db.transaction true do
-	@@ssd_db.root? id.to_sym
+	@@ssd_db.root? ssd 
       end
     end
 
     alias exists? key?
 
-    def [] id 
-      setup id 
+    def [] ssd 
+      setup ssd 
       @@ssd_db.transaction true do
-	@@ssd_db[id.to_sym]
+	@@ssd_db[ssd]
       end
     end
 
-    def ssd id  
-      #TODO add raise if id.nil?
-      last_key = (last_key id) 
+    def ssd ssd 
+      #TODO add raise if ssd.nil?
+      last_key = (last_key ssd) 
       @@ssd_db.transaction true do
 	@@ssd_db.fetch last_key
       end
@@ -124,20 +123,20 @@ module SSD
     #alias get fetch 
     #alias find fetch 
 
-    def delete *ids
+    def delete *ssds
       @@ssd_db.transaction do
-	ids.each do |id|
-	  @@ssd_db.delete id.to_sym
+	ssds.each do |ssd|
+	  @@ssd_db.delete ssd.to_sym
 	end
 	@@ssd_db.commit
       end
     end
     alias remove delete
 
-    def count id
-      setup id 
+    def count ssd
+      setup ssd 
       $log.info("count")
-      return keys(id).count
+      return keys(ssd).count
     end
   end
 

data/lib/ssd/version.rb

@@ -1,3 +1,3 @@
 module SSD
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/specs/ssd_spec.rb

@@ -3,21 +3,31 @@ require_relative "./spec_helper"
 describe SSD do
 
   before do
-    class User 
+
+    class User
       include SSD
-      attr_accessor :first_name, :last_name, :location
+      attr_accessor :id, :first_name, :last_name, :location
+
+      def initialize id=""
+	@ssd = id
+      end
+
+      def id= id
+	@id = id
+	@ssd = @id
+      end
     end
 
-    @generated_id = Random.new.seed
+    @generated_ssd = Random.new.seed
   end
 
   describe "#append!" do
     it "saves an object to the database" do
       #skip
       @user 	= User.new
-      @user.id	= @generated_id
+      @user.ssd = @generated_ssd
       @user.append!
-      @user.id.must_equal @generated_id
+      @user.ssd.must_equal @generated_ssd
     end
   end
 
@@ -25,10 +35,10 @@ describe SSD do
     it "fetches an object from the database" do
       #    skip
       @user 	= User.new
-      @user.id	= @generated_id
+      @user.ssd = @generated_ssd
       @user.append!
-      user = User.ssd(@generated_id)
-      user.id.must_equal @generated_id
+      user = User.ssd(@generated_ssd)
+      user.ssd.must_equal @generated_ssd
     end
   end
 
@@ -36,19 +46,19 @@ describe SSD do
     it "it keeps adding new objects" do
       @user 		= User.new
 
-      @user.id		= @generated_id 
+      @user.ssd		= @generated_ssd 
       @user.location	= "Egypt"
       @user.append!
 
-      @user = User.ssd(@generated_id)
+      @user = User.ssd(@generated_ssd)
       @user.location = "Brazil"
       @user.append!
 
-      @user = User.ssd(@generated_id)
+      @user = User.ssd(@generated_ssd)
       @user.location = "France"
       @user.append!
 
-      User.count(@generated_id).must_equal 3
+      User.count(@generated_ssd).must_equal 3
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssd
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - zotherstupidguy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2016-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/repl.rb
 - bin/setup
 - lib/encrypt.rb
 - lib/ssd.rb