deferrer 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWYxNDY1MDIxNTJkNTJiMmFkYWQyMWFmZWQ5Y2ZkZjMwMmE1MTkwZQ==
+  data.tar.gz: !binary |-
+    MjE0OWFiYjA1NjlkMmE0NjgwMzViMDY4ZjVmYTdhODQzNzdjYjJmMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjMzNmU0ZmVjOWRiYWVhODY1YzU4MmY5OTRmNzNhYTdiNTMwMmUzMTdlOTE3
+    NWIxNjI4MGI1ODkxNDVhODFhYjJjMDkyMzNlYTg1MDVkODU2NzY1YTMyMzEx
+    NGUxNzNjMjY5MWRjZDBhNDMwYzQ2YjZhMjkzN2EwMTg1ZDNmZjc=
+  data.tar.gz: !binary |-
+    YWEzOTI3NWVjNjk3OTVjMDdjOGM4NGU1ZTA2ZDFmOWE3OGE2NDM0NTJiZjkx
+    YTY5Y2Q1NmUzOTgzNjE0ZjZjNjY3YjYzZDlmNDAxNWJjY2Y2ZjZlNmM1Zjdm
+    NGNjM2E5ZmU5NTEwY2NjZGE3YjE3NzliNDI5YjBjZjZmYTNlN2Y=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dalibor Nasevic
+
+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/README.md

@@ -0,0 +1,63 @@
+# Deferrer
+
+Defer executions and run only the last update at the scheduled time
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deferrer'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install deferrer
+
+
+
+## Usage
+
+Configure redis
+
+    Deferrer.redis_config = { :host => "localhost", :port => 6379 }
+
+
+Define deferrer class (must have perform class method)
+
+    class NameDeferrer
+      def self.perform(first_name, last_name)
+        puts "#{first_name} #{last_name}".upcase
+      end
+    end
+
+
+Start a worker process. It needs to have redis configured and access to deferrer classes.
+
+    Deferrer.run
+
+
+Defer some executions
+
+    Deferrer.defer_in(5, 'identifier', NameDeferrer, 'User', '1')
+    Deferrer.defer_in(6, 'identifier', NameDeferrer, 'User', '2')
+    Deferrer.defer_in(9, 'identifier', NameDeferrer, 'User', '3')
+
+
+It will stack all defered executions per identifier until first timeout expires (5 seconds) and then it will only execute the last update for the expired identifier:
+
+    NameDeferrer.perform('User', '3') => USER 3
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/deferrer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deferrer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deferrer"
+  spec.version       = Deferrer::VERSION
+  spec.authors       = ["Dalibor Nasevic"]
+  spec.email         = ["dalibor.nasevic@gmail.com"]
+  spec.description   = %q{Defer executions and run only the last update}
+  spec.summary       = %q{Defer executions and run only the last update at the scheduled time}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_dependency "redis"
+  spec.add_dependency "multi_json"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/example/README.md

@@ -0,0 +1,9 @@
+# Example
+
+1. Open first terminal and run:
+
+    bundle exec ruby runner.rb
+
+2. Open second terminal and run:
+
+    bundle exec ruby client.rb

data/example/client.rb

@@ -0,0 +1,8 @@
+require 'deferrer'
+require_relative './name_deferrer'
+
+Deferrer.redis_config = { :host => "localhost", :port => 6379 }
+
+Deferrer.defer_in(5, 'identifier', NameDeferrer, 'User', '1')
+Deferrer.defer_in(6, 'identifier', NameDeferrer, 'User', '2')
+Deferrer.defer_in(9, 'identifier', NameDeferrer, 'User', '3')

data/example/name_deferrer.rb

@@ -0,0 +1,9 @@
+# setup redis
+Deferrer.redis_config = { :host => "localhost", :port => 6379 }
+
+# define deferrer class (must have perform class method)
+class NameDeferrer
+  def self.perform(first_name, last_name)
+    puts "#{first_name} #{last_name}".upcase
+  end
+end

data/example/runner.rb

@@ -0,0 +1,21 @@
+require 'deferrer'
+require_relative './name_deferrer'
+
+Deferrer.redis_config = { :host => "localhost", :port => 6379 }
+
+class Logger
+  def self.info(message)
+    puts "INFO: #{message}"
+  end
+
+  def self.error(message)
+    puts "ERROR: #{message}"
+  end
+end
+
+puts 'Runner started'
+
+Deferrer.run({
+  :loop_frequency => 0.5,
+  :logger => Logger
+})

data/lib/deferrer.rb

@@ -0,0 +1,13 @@
+require 'redis'
+require "deferrer/version"
+
+module Deferrer
+
+  autoload :Configuration, 'deferrer/configuration'
+  autoload :JsonEncoding,  'deferrer/json_encoding'
+  autoload :Deferral,      'deferrer/deferral'
+
+  extend Configuration
+  extend JsonEncoding
+  extend Deferral
+end

data/lib/deferrer/configuration.rb

@@ -0,0 +1,14 @@
+module Deferrer
+  module Configuration
+
+    # Deferrer.redis_config = { :host => "localhost", :port => 6379 }
+    def redis_config=(config)
+      @redis = Redis.new(config)
+    end
+
+    # Returns the configured Redis instance
+    def redis
+      @redis
+    end
+  end
+end

data/lib/deferrer/deferral.rb

@@ -0,0 +1,90 @@
+module Deferrer
+  module Deferral
+
+    LIST_KEY = :deferred_list
+
+    def run(options = {})
+      loop_frequency = options[:loop_frequency] || 0.1
+      logger = options[:logger] || nil
+
+      loop do
+        while item = next_item
+          begin
+            klass = constantize(item['class'])
+            args  = item['args']
+
+            logger.info("Executing: #{item['key']}") if logger
+
+            klass.send(:perform, *args)
+          rescue Exception => e
+            logger.error("Error: #{e.class}: #{e.detail}") if logger
+          end
+        end
+
+        sleep loop_frequency
+      end
+    end
+
+    def next_item
+      item = nil
+      decoded_item = nil
+      score = calculate_score(Time.now)
+
+      key = redis.zrangebyscore(LIST_KEY, '-inf', score, :limit => [0, 1]).first
+
+      if key
+        _, item = redis.brpop(key, 0)
+        decoded_item = decode(item) if item
+        decoded_item['key'] = key
+
+        remove(key)
+      end
+
+      decoded_item
+    end
+
+    def constantize(klass_string)
+      klass_string.split('::').inject(Object) {|memo,name| memo = memo.const_get(name); memo}
+    end
+
+    def defer_in(number_of_seconds_from_now, identifier, klass, *args)
+      timestamp = Time.now + number_of_seconds_from_now
+      defer_at(timestamp, identifier, klass, *args)
+    end
+
+    def defer_at(timestamp, identifier, klass, *args)
+      item = build_item(klass, args)
+      key = item_key(identifier)
+      score = calculate_score(timestamp)
+
+      count = redis.rpush(key, encode(item))
+
+      # set score only on first update
+      if count == 1
+        redis.zadd(LIST_KEY, score, key)
+      end
+    end
+
+    def item_key(identifier)
+      "deferred:#{identifier}"
+    end
+
+    private
+    def build_item(klass, args)
+      {'class' => klass.to_s, 'args' => args}
+    end
+
+    def calculate_score(timestamp)
+      timestamp.to_f
+    end
+
+    def remove(key)
+      redis.watch(key)
+      redis.multi do
+        redis.del(key)
+        redis.zrem(LIST_KEY, key)
+      end
+      redis.unwatch
+    end
+  end
+end

data/lib/deferrer/json_encoding.rb

@@ -0,0 +1,20 @@
+require 'multi_json'
+
+module Deferrer
+  module JsonEncoding
+
+    class DecodeException < StandardError; end
+
+    def encode(item)
+      MultiJson.dump(item)
+    end
+
+    def decode(item)
+      begin
+        MultiJson.load(item)
+      rescue ::MultiJson::DecodeError => e
+        raise DecodeException, e.message, e.backtrace
+      end
+    end
+  end
+end

data/lib/deferrer/version.rb

@@ -0,0 +1,3 @@
+module Deferrer
+  VERSION = "0.0.1"
+end

data/spec/deferrer/deferral_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+class CarDeferrer
+  def self.perform(car)
+    car.upcase
+  end
+end
+
+describe Deferrer::Deferral do
+  let(:car) { 'car' }
+  let(:car2) { 'car2' }
+  let(:identifier) { 'car1' }
+  let(:redis) { Deferrer.redis }
+  let(:list_key) { Deferrer::Deferral::LIST_KEY }
+
+  before :each do
+    redis.flushall
+  end
+
+  describe ".defer_at" do
+    it "deferrs at given time" do
+      Deferrer.defer_at(Time.now, identifier, CarDeferrer, car)
+
+      redis.zrangebyscore(list_key, '-inf', Time.now.to_f, :limit => [0, 1]).first.should_not be_nil
+      redis.exists(Deferrer.item_key(identifier)).should be_true
+    end
+
+    it "deferrs in given interval" do
+      Deferrer.defer_in(1, identifier, CarDeferrer, car)
+
+      redis.zrangebyscore(list_key, '-inf', (Time.now + 1).to_f, :limit => [0, 1]).first.should_not be_nil
+      redis.exists(Deferrer.item_key(identifier)).should be_true
+    end
+  end
+
+  describe ".next_item" do
+    it "returns the next item" do
+      Deferrer.defer_at(Time.now, identifier, CarDeferrer, car)
+
+      item = Deferrer.next_item
+
+      item['class'].should == CarDeferrer.to_s
+      item['args'].should == [car]
+    end
+
+    it "returns last update of an item" do
+      Deferrer.defer_at(Time.now - 3, identifier, CarDeferrer, car)
+      Deferrer.defer_at(Time.now - 2, identifier, CarDeferrer, car2)
+
+      item = Deferrer.next_item
+
+      item['class'].should == CarDeferrer.to_s
+      item['args'].should == [car2]
+    end
+
+    it "keep the old score value" do
+      Deferrer.defer_at(Time.now - 3, identifier, CarDeferrer, car)
+      Deferrer.defer_at(Time.now + 1, identifier, CarDeferrer, car2)
+
+      Deferrer.next_item.should_not be_nil
+    end
+
+    it "returns nil when no next item" do
+      Deferrer.next_item.should be_nil
+    end
+
+    it "removes values from redis" do
+      Deferrer.defer_at(Time.now, identifier, CarDeferrer, car)
+
+      item = Deferrer.next_item
+
+      redis.zrangebyscore(list_key, '-inf', Time.now.to_f, :limit => [0, 1]).first.should be_nil
+      redis.exists(Deferrer.item_key(identifier)).should be_false
+      Deferrer.next_item.should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'deferrer'
+
+Deferrer.redis_config = { :host => "localhost", :port => 6379 }

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: deferrer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dalibor Nasevic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Defer executions and run only the last update
+email:
+- dalibor.nasevic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deferrer.gemspec
+- example/README.md
+- example/client.rb
+- example/name_deferrer.rb
+- example/runner.rb
+- lib/deferrer.rb
+- lib/deferrer/configuration.rb
+- lib/deferrer/deferral.rb
+- lib/deferrer/json_encoding.rb
+- lib/deferrer/version.rb
+- spec/deferrer/deferral_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Defer executions and run only the last update at the scheduled time
+test_files:
+- spec/deferrer/deferral_spec.rb
+- spec/spec_helper.rb