perobs 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 059ab4702a14c6ff6328881c528eda77d321de51
-  data.tar.gz: 5a8944222bf1feccb2eda749f05d963598e3b945
+  metadata.gz: e8576de664206470a3b075101951c4a65144d643
+  data.tar.gz: 26a46db076eea54ca4dbb5ed6312a3ec855971d7
 SHA512:
-  metadata.gz: eeab29c68225efd8efbfb6a94b14c708fac38e16c6c1a399b55941e11e7dab83ecea925382180b803a7a152b71509eef30c50e40e568d5c9900c0dea1eec1d7f
-  data.tar.gz: 993b3ff327426b2797e4696a43ad0a0483d45a22638241fe34409b8fe4bbdddbe5a27adb0f06b088ae5f45638515fe11aa0b4f1baf6079afbfde4d7c06188ea5
+  metadata.gz: fac5c8714eba1be5beb6647330044177ea4eff24ada10243e0a3a4dc595eb7316662a4fdf0e63e8faf07f9b57eff15d232e66a63a4d3a84019d1b8b2d5a08b70
+  data.tar.gz: 93a75aeb2430c57535f6a4fb792db48717c1278d22939be9168e9341c4dddd94565de6adca739ebde76b6d72845f1800394b0aa8ed24da7488f6f10c1772a539

data/README.md

@@ -60,7 +60,7 @@ class Person < PEROBS::Object
   def initialize(store, name)
     super
     attr_init(:name, name)
-    attr_init(:kids, PEROBS::Array.new)
+    attr_init(:kids, PEROBS::Array.new(store))
   end
 
   def to_s
@@ -71,9 +71,9 @@ class Person < PEROBS::Object
 end
 
 store = PEROBS::Store.new('family')
-store['grandpa'] = joe = Person.new('Joe')
-store['grandma'] = jane = Person.new('Jane')
-jim = Person.new('Jim')
+store['grandpa'] = joe = Person.new(store, 'Joe')
+store['grandma'] = jane = Person.new(store, 'Jane')
+jim = Person.new(store, 'Jim')
 jim.father = joe
 joe.kids << jim
 jim.mother = jane

data/lib/perobs/BTreeDB.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 #
-# = BTreeBlob.rb -- Persistent Ruby Object Store
+# = BTreeDB.rb -- Persistent Ruby Object Store
 #
 # Copyright (c) 2015 by Chris Schlaeger <chris@taskjuggler.org>
 #
@@ -25,6 +25,8 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require 'fileutils'
+
 require 'perobs/DataBase'
 require 'perobs/BTreeBlob'
 
@@ -88,6 +90,10 @@ module PEROBS
       @dir_mask = 2 ** @dir_bits - 1
     end
 
+    def BTreeDB::delete_db(db_name)
+      FileUtils.rm_rf(db_name)
+    end
+
     # Return true if the object with given ID exists
     # @param id [Fixnum or Bignum]
     def include?(id)

data/lib/perobs/DynamoDB.rb

@@ -0,0 +1,250 @@
+# encoding: UTF-8
+#
+# = DynamoDB.rb -- Persistent Ruby Object Store
+#
+# Copyright (c) 2015 by Chris Schlaeger <chris@taskjuggler.org>
+#
+# MIT License
+#
+# 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.
+
+require 'aws-sdk-core'
+
+require 'perobs/DataBase'
+require 'perobs/BTreeBlob'
+
+module PEROBS
+
+  # This class implements an Amazon DynamoDB storage engine for PEROBS.
+  class DynamoDB < DataBase
+
+    # Create a new DynamoDB object.
+    # @param db_name [String] name of the DB directory
+    # @param options [Hash] options to customize the behavior. Currently only
+    #        the following options are supported:
+    #        :serializer    : Can be :json and :yaml
+    #        :aws_id        : AWS credentials ID
+    #        :aws_key       : AWS credentials key
+    #        :aws_region    : AWS region to host the data
+    def initialize(db_name, options = {})
+      # :marshal serialization results in a binary format that cannot easily
+      # be stored in DynamoDB. We fall back to :yaml.
+      if options[:serializer] == :marshal
+        options[:serializer] = :yaml
+      end
+
+      super(options[:serializer] || :json)
+
+      if options.include?(:aws_id) && options.include?(:aws_key)
+        Aws.config[:credentials] = Aws::Credentials.new(options[:aws_id],
+                                                        options[:aws_key])
+      end
+      if options.include?(:aws_region)
+        Aws.config[:region] = options[:aws_region]
+      end
+
+      @dynamodb = Aws::DynamoDB::Client.new
+      @table_name = db_name
+      ensure_table_exists(@table_name)
+
+      # Read the existing DB config.
+      @config = get_hash('config')
+      check_option('serializer')
+      put_hash('config', @config)
+    end
+
+    def DynamoDB::delete_db(table_name)
+      dynamodb = Aws::DynamoDB::Client.new
+      dynamodb.delete_table(:table_name => table_name)
+      dynamodb.wait_until(:table_not_exists, table_name: table_name)
+    end
+
+    # Return true if the object with given ID exists
+    # @param id [Fixnum or Bignum]
+    def include?(id)
+      dynamo_get_item(id.to_s)
+    end
+
+    # Store a simple Hash as a JSON encoded file into the DB directory.
+    # @param name [String] Name of the hash. Will be used as file name.
+    # @param hash [Hash] A Hash that maps String objects to strings or
+    # numbers.
+    def put_hash(name, hash)
+      dynamo_put_item(name, hash.to_json)
+    end
+
+    # Load the Hash with the given name.
+    # @param name [String] Name of the hash.
+    # @return [Hash] A Hash that maps String objects to strings or numbers.
+    def get_hash(name)
+      if (item = dynamo_get_item(name))
+        JSON.parse(item)
+      else
+        ::Hash.new
+      end
+    end
+
+    # Store the given object into the cluster files.
+    # @param obj [Hash] Object as defined by PEROBS::ObjectBase
+    def put_object(obj, id)
+      dynamo_put_item(id.to_s, serialize(obj))
+    end
+
+    # Load the given object from the filesystem.
+    # @param id [Fixnum or Bignum] object ID
+    # @return [Hash] Object as defined by PEROBS::ObjectBase or nil if ID does
+    #         not exist
+    def get_object(id)
+      (item = dynamo_get_item(id.to_s)) ? deserialize(item) : nil
+    end
+
+    # This method must be called to initiate the marking process.
+    def clear_marks
+      each_item do |id|
+        dynamo_mark_item(id, false)
+      end
+      # Mark the 'config' item so it will not get deleted.
+      dynamo_mark_item('config')
+    end
+
+    # Permanently delete all objects that have not been marked. Those are
+    # orphaned and are no longer referenced by any actively used object.
+    def delete_unmarked_objects
+      each_item do |id|
+        dynamo_delete_item(id) unless dynamo_is_marked?(id)
+      end
+    end
+
+    # Mark an object.
+    # @param id [Fixnum or Bignum] ID of the object to mark
+    def mark(id)
+      dynamo_mark_item(id.to_s, true)
+    end
+
+    # Check if the object is marked.
+    # @param id [Fixnum or Bignum] ID of the object to check
+    def is_marked?(id)
+      dynamo_is_marked?(id.to_s)
+    end
+
+    # Basic consistency check.
+    # @param repair [TrueClass/FalseClass] True if found errors should be
+    #        repaired.
+    def check_db(repair = false)
+      # TODO: See if we can add checks here
+    end
+
+    # Check if the stored object is syntactically correct.
+    # @param id [Fixnum/Bignum] Object ID
+    # @param repair [TrueClass/FalseClass] True if an repair attempt should be
+    #        made.
+    # @return [TrueClass/FalseClass] True if the object is OK, otherwise
+    #         false.
+    def check(id, repair)
+      begin
+        get_object(id)
+      rescue => e
+        $stderr.puts "Cannot read object with ID #{id}: #{e.message}"
+        return false
+      end
+
+      true
+    end
+
+    private
+
+    def ensure_table_exists(table_name)
+      begin
+        @dynamodb.describe_table(:table_name => table_name)
+      rescue Aws::DynamoDB::Errors::ResourceNotFoundException
+        @dynamodb.create_table(
+          :table_name => table_name,
+          :attribute_definitions => [
+            {
+              :attribute_name => :Id,
+              :attribute_type => :S
+            }
+          ],
+          :key_schema => [
+            {
+              :attribute_name => :Id,
+              :key_type => :HASH
+            }
+          ],
+          :provisioned_throughput => {
+            :read_capacity_units => 1,
+            :write_capacity_units => 1,
+          }
+        )
+
+        @dynamodb.wait_until(:table_exists, table_name: table_name)
+      end
+    end
+
+    def dynamo_get_item(id)
+      resp = @dynamodb.get_item(:table_name => @table_name,
+                                :key => { :Id => id })
+      resp[:item] ? resp[:item]['Value'] : nil
+    end
+
+    def dynamo_put_item(id, value)
+      @dynamodb.put_item(:table_name => @table_name,
+                         :item => { :Id => id, :Value => value })
+    end
+
+    def dynamo_delete_item(id)
+      @dynamodb.delete_item(:table_name => @table_name,
+                            :key => { :Id => id })
+    end
+
+    def dynamo_mark_item(id, set_mark = true)
+      @dynamodb.update_item(:table_name => @table_name,
+                            :key => { :Id => id },
+                            :attribute_updates => {
+                              :Mark => { :value => set_mark,
+                                         :action => "PUT" }})
+    end
+
+    def dynamo_is_marked?(id)
+      resp = @dynamodb.get_item(:table_name => @table_name,
+                               :key => { :Id => id })
+      resp[:item] && resp[:item]['Mark']
+    end
+
+    def each_item
+      start_key = nil
+      loop do
+        resp = @dynamodb.scan(:table_name => @table_name,
+                              :exclusive_start_key => start_key)
+        break if resp.count <= 0
+
+        resp.items.each do |item|
+          yield(item['Id'])
+        end
+
+        break unless resp.last_evaluated_key
+        start_key = resp.last_evaluated_key['AttributeName']
+      end
+    end
+
+  end
+
+end
+

data/lib/perobs/version.rb

@@ -1,4 +1,4 @@
 module PEROBS
   # The version number
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/perobs.gemspec

@@ -16,6 +16,7 @@ GEM_SPEC = Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>=2.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'yard', '~>0.8.7'

data/spec/BTreeDB_spec.rb

@@ -23,24 +23,19 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'fileutils'
 require 'time'
 
+require 'spec_helper'
 require 'perobs/BTreeDB'
 
 describe PEROBS::BTreeDB do
 
-  class UStruct < Struct.new(:first, :second, :third)
-  end
-
   before(:all) do
-    FileUtils.rm_rf('fs_test')
+    PEROBS::BTreeDB::delete_db('fs_test')
   end
 
   after(:each) do
-    FileUtils.rm_rf('fs_test')
+    PEROBS::BTreeDB::delete_db('fs_test')
   end
 
   it 'should create database' do
@@ -93,7 +88,7 @@ describe PEROBS::BTreeDB do
       @db.include?(0).should be_true
       @db.check(0, false).should be_true
       @db.get_object(0).should == h
-      FileUtils.rm_rf('fs_test')
+      PEROBS::BTreeDB::delete_db('fs_test')
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perobs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chris Schlaeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-06 00:00:00.000000000 Z
+date: 2015-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - lib/perobs/Cache.rb
 - lib/perobs/ClassMap.rb
 - lib/perobs/DataBase.rb
+- lib/perobs/DynamoDB.rb
 - lib/perobs/Hash.rb
 - lib/perobs/Object.rb
 - lib/perobs/ObjectBase.rb
@@ -100,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='