pelican 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 888a40fb4bb8c2b7f792e6bb2f8c1b4ce80cd97e
+  data.tar.gz: 21665d8b06ed665561ae9bbcdca2b2db54bbc4ec
+SHA512:
+  metadata.gz: 32407a6599efaf7394a3dbcd5259bcdd9718d981ad105d493caeaa2dd6798798517841d0b4b573ba9e6a328c84966434c84ce2dbe5e0dfeca833c7a68cdcabf8
+  data.tar.gz: a83d035689bc8431b4189147d04f9a5a5db7e3ccd7980dfbbf782c5ddd9f4ad054b6ac8400baae70e1246cd17342eef4e238a8cfbc00cc5a53a0259b8197aa57

data/.gitignore

@@ -0,0 +1,2 @@
+pelican-*.gem
+.bundle

data/.ruby-gemset

@@ -0,0 +1 @@
+pelican

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    pelican (0.0.1)
+      redis (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.1.0)
+    redis (3.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  pelican!
+  rake (= 10.1.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daniel Padden
+
+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.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end

data/Readme.md

@@ -0,0 +1,51 @@
+# Pelican
+
+Pelican stores the final state of modified objects. You can request a list of objects which were modified when compared to the last time you saw them, which provides a fast way of syncing states of objects across systems. When objects are modified multiple times, the history of those modifications are lost and only the final state is preserved. Pelican is ideal when only the final state of an object is important, so the history of modifications can be overwritten, which minimises disk space consumption and improves sync speed.
+
+Curently Pelican stores objects using Redis. This is a quick lightweight database, which is easily scalable to millions of objects.
+
+## Installation
+
+  You will need to have Redis installed. You can find this from http://redis.io/download
+  
+  Then it is easy to install Pelican.
+
+    gem install pelican
+
+  You will need to configure Redis for Pelican
+
+    Pelican.setup(indexing_key, redis_config)
+
+  Pelican uses any standard Redis config, so you can set up Redis in your usual way.
+
+  e.g.
+
+    Pelican.setup(
+      'pelican:state',
+      host: 'localhost',
+      port: 6379,
+      db: 1)
+
+  Then just require Pelican when you need it
+
+    require 'pelican'
+
+  The order in which objects are stored is determined by a score. When an object is added or updated, it is given a score. The order of most modified objects is preserved by incrementing the score for each new modified score.
+
+## Insert Objects
+
+  To insert or update an object with its current state, just use
+
+    Pelican::Event.insert('object1', 'state1')
+
+## Listing objects
+
+  You can list all the modified objects from the last known score
+
+    current_score = Pelican::Event.list(last_score) { |object|
+      puts "current object: #{object}"
+    }
+
+## Run Tests
+
+    rake test

data/lib/pelican.rb

@@ -0,0 +1,7 @@
+require 'securerandom'
+require 'redis'
+require_relative 'pelican/config'
+require_relative 'pelican/event'
+
+module Pelican
+end

data/lib/pelican/config.rb

@@ -0,0 +1,14 @@
+module Pelican
+  extend self
+  attr_accessor :redis, :key
+  
+  def setup(key = nil, opts = {})
+    @key = key || default_key
+    @redis = Redis.new(opts)
+  end
+
+  def default_key
+    'pelican:state'
+  end
+
+end

data/lib/pelican/event.rb

@@ -0,0 +1,60 @@
+module Pelican
+  module Event
+    extend self
+
+    def insert(id, state)
+      begin
+        Pelican.redis.multi do
+          Pelican.redis.set(pelican_id(id), state)
+        end
+        update_event_list(pelican_id(id))
+      end
+    end
+
+    def delete(id)
+      begin
+        Pelican.redis.multi do
+          Pelican.redis.zrem(Pelican.key, pelican_id(id))
+          Pelican.del(pelican_id(id))
+        end
+      end
+    end
+
+    def list(last_score = 0)
+      max_score = last_score
+      last_score = '(' + last_score.to_s # make the search on last score exclusive
+      Pelican.redis.zrangebyscore(Pelican.key, last_score, '+inf', { withscores: true }).each do |id|
+        yield Pelican.redis.get(id[0])
+        max_score = id[1]
+      end
+      max_score
+    end
+
+    def pelican_id(id)
+      ['pelican', id].join(':')
+    end
+
+    private
+
+    def update_event_list(id)
+      with_max_score do |max_score|
+        Pelican.redis.multi do
+          Pelican.redis.zadd(Pelican.key, max_score + 1, id)
+        end
+      end
+    end
+
+    def with_max_score
+      begin
+        Pelican.redis.watch(Pelican.key)
+        last_object = Pelican.redis.zrange(Pelican.key, -1, -1, { withscores: true })[0]
+        yield last_object.nil? ? 0 : last_object[1]
+      rescue => e
+        raise e
+      ensure
+        Pelican.redis.watch(Pelican.key)
+      end
+    end
+
+  end
+end

data/lib/pelican/version.rb

@@ -0,0 +1,3 @@
+module Pelican
+  VERSION = '0.0.1'
+end

data/pelican.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', 'pelican', 'version'))
+
+Gem::Specification.new do |gem|
+  gem.name          = 'pelican'
+  gem.version       = Pelican::VERSION
+  gem.authors       = ['Daniel Padden']
+  gem.email         = ['daniel.padden@forward3d.com']
+  gem.description   = %q{Monitoring states of modified objects}
+  gem.summary       = %q{Track changes to the state of an object and list all objects since a previous known state}
+  gem.homepage      = 'https://github.com/hypernova2002/pelican'
+  gem.license       = 'MIT'
+  
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  
+  gem.add_dependency 'redis', '~> 3.0'
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake', '10.1.0'
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'test/unit'
+require 'bundler'
+Bundler.require
+
+ROOT = File.dirname(File.dirname(File.expand_path(__FILE__)))
+
+require File.join(ROOT, 'lib', 'pelican')
+
+Pelican.setup(
+  'pelican_test:state',
+  host: 'localhost',
+  port: 6379,
+  db: 1)

data/test/unit/test_event.rb

@@ -0,0 +1,39 @@
+require_relative File.join('..', 'test_helper')
+
+class TestEvent < Test::Unit::TestCase
+
+  def setup
+    @objects = {'test_1' => 'state_1','test_2' => 'state_2','test_3' => 'state_3'}
+    clean_up!
+    
+    at_exit do
+      unless @clean_up
+        clean_up!
+      end
+    end
+  end
+
+  def test_insert
+    @objects.each do |(key, state)|
+      Pelican::Event.insert(key, state)
+    end
+
+    @objects.each_with_index do |(key, state), index|
+      assert_equal index + 1, Pelican.redis.zscore(Pelican.key, Pelican::Event.pelican_id(key))
+      assert_equal state, Pelican.redis.get(Pelican::Event.pelican_id(key))
+    end
+  end
+    
+  def clean_up!
+    @objects.each do |(key, state)|
+      Pelican.redis.del(Pelican::Event.pelican_id(key))
+      Pelican.redis.del(Pelican.key)
+    end
+  end
+  
+  def teardown
+    clean_up!
+    @clean_up = true
+  end
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: pelican
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Padden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+description: Monitoring states of modified objects
+email:
+- daniel.padden@forward3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Rakefile
+- Readme.md
+- lib/pelican.rb
+- lib/pelican/config.rb
+- lib/pelican/event.rb
+- lib/pelican/version.rb
+- pelican.gemspec
+- test/test_helper.rb
+- test/unit/test_event.rb
+homepage: https://github.com/hypernova2002/pelican
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Track changes to the state of an object and list all objects since a previous
+  known state
+test_files:
+- test/test_helper.rb
+- test/unit/test_event.rb