robinhood 0.0.1.pre

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/.ruby-version

@@ -0,0 +1 @@
+rbx

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josep Jaume
+
+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,39 @@
+# Robinhood
+
+Robinhood is a DSL for constructing iteration-based synchronous processes
+(aka can't be run as jobs) in a distributed manner.
+
+It leverages celluloid actors for each process and uses Redis as a locking
+mechanism to ensure the process is run in a single server.
+
+## Usage
+
+```ruby
+Robinhood.setup do
+  process :assigner, timeout: 10.minutes do
+    UserAssigner.process!
+  end
+
+  process :sweeper, throttle: 1.minute do
+    Sweeper.sweep!
+  end
+end
+```
+
+## How does it work?
+
+Each time a process finishes its execution, the lock is released so any other
+server (or system process) can execute it again. This ensures it will be
+executed in a synchronous manner (one after the other).
+
+You can also set a timeout (in case a process hangs for some reason) and a
+throttling mechanism (so a process can't be re-scheduled before this time has
+passed).
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/robinhood/process.rb

@@ -0,0 +1,46 @@
+require 'celluloid'
+require 'redis-mutex'
+require 'benchmark'
+
+module Robinhood
+  class Process
+    attr_reader :name, :options
+
+    include Celluloid
+    include Celluloid::Logger
+
+    def initialize(name, options, block)
+      @name = name
+      @options = options
+      @block = block
+      async.run
+    end
+
+    def run
+      mutex.lock
+
+      time = Benchmark.realtime{ @block.call }
+
+      sleep(difference) if difference = throttle - time
+    ensure
+      mutex.unlock
+      async.run
+    end
+
+    def lock_name
+      "robinhood:#{name}:lock"
+    end
+
+    def throttle
+      if (throttle = options[:throttle]) != nil
+        throttle
+      else
+        0.1
+      end
+    end
+
+    def mutex
+      @mutex ||= Redis::Mutex.new(lock_name, block: 1, sleep: 0.1, expire: 300)
+    end
+  end
+end

data/lib/robinhood/setup.rb

@@ -0,0 +1,54 @@
+require "robinhood/process"
+require "celluloid"
+
+module Robinhood
+  class Setup
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+      @processes = []
+    end
+
+    def process(name, options = {}, &block)
+      @processes << [name, options, block]
+    end
+
+    def redis
+      @redis = yield
+    end
+
+    def supervision_group
+      @supervision_group ||= Class.new(Celluloid::SupervisionGroup)
+    end
+
+    def start
+      setup_supervision_group
+      Redis::Classy.db = @redis || Redis.new
+
+      @supervision_group_actor = if options[:background]
+                                   supervision_group.run!
+                                 else
+                                   supervision_group.run
+                                 end
+    end
+
+    def stop
+      @supervision_group_actor.finalize if @supervision_group_actor
+    end
+
+    def redis_options
+      options[:redis] || {}
+    end
+
+    def setup_supervision_group
+      @processes.each do |process|
+        name, options, block = process
+
+        supervision_group.supervise Process,
+          as: "robinhood_#{name}",
+          args: [name, options.merge(autostart: true), block]
+      end
+    end
+  end
+end

data/lib/robinhood/version.rb

@@ -0,0 +1,3 @@
+module Robinhood
+  VERSION = "0.0.1.pre"
+end

data/lib/robinhood.rb

@@ -0,0 +1,20 @@
+require "robinhood/version"
+require "robinhood/setup"
+require "celluloid/autostart"
+
+module Robinhood
+  def self.setup(options = {}, &block)
+    @setup ||= Setup.new(options)
+    @setup.instance_eval(&block)
+    @setup.start
+  end
+
+  def self.stop
+    @setup.stop if @setup
+  end
+
+  def self.reset!
+    stop
+    @setup = nil
+  end
+end

data/robinhood.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'robinhood/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "robinhood"
+  spec.version       = Robinhood::VERSION
+  spec.authors       = ["Josep Jaume"]
+  spec.email         = ["josepjaume@gmail.com"]
+  spec.description   = %q{Robin hood leverages celluloid actors and redis-mutex to distribute long-lived, single-instance processes across multiple servers.}
+  spec.summary       = spec.description
+  spec.homepage      = "http://www.codegram.com"
+  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 'celluloid'
+  spec.add_dependency 'redis-mutex'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+end

data/spec/acceptance/setup_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+require "robinhood"
+
+module Robinhood
+  describe ".setup" do
+    it "creates actors for each process" do
+      Robinhood.setup(background: true) do
+        process(:ed){}
+        process(:balls){}
+      end
+
+      sleep(1)
+
+      expect(Celluloid::Actor[:robinhood_ed]).to_not be_nil
+      expect(Celluloid::Actor[:robinhood_balls]).to_not be_nil
+    end
+
+    it "executes a process iteratively until it ends" do
+      queue = [1, 2]
+
+      Robinhood.setup(background: true) do
+        process :test do
+          queue.pop
+        end
+      end
+
+      sleep(1)
+      expect(queue).to be_empty
+    end
+
+    it "allows setting an arbitrary throttle" do
+      queue = [1, 2]
+
+      Robinhood.setup(background: true) do
+        process :test, throttle: 0.5 do
+          queue.pop
+        end
+      end
+
+      sleep(0.2)
+      expect(queue).not_to be_empty
+      sleep(1)
+      expect(queue).to be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "pry"
+require "pry-nav"
+
+RSpec.configure do |config|
+  config.color = true
+
+  unless ENV["TRAVIS"]
+    config.formatter = :documentation
+  end
+
+  config.before(:each) do
+    Celluloid.logger = nil
+    redis = Redis.new
+    redis.flushdb
+  end
+
+  config.after(:each) do
+    Robinhood.reset!
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: robinhood
+version: !ruby/object:Gem::Version
+  prerelease: 6
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Josep Jaume
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: celluloid
+  type: :runtime
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: redis-mutex
+  type: :runtime
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  name: bundler
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rake
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rspec
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: pry
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: pry-nav
+  type: :development
+  prerelease: false
+description: Robin hood leverages celluloid actors and redis-mutex to distribute long-lived,
+  single-instance processes across multiple servers.
+email:
+- josepjaume@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  LnJ1YnktdmVyc2lvbg==
+- !binary |-
+  LnRyYXZpcy55bWw=
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  TElDRU5TRS50eHQ=
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  bGliL3JvYmluaG9vZC5yYg==
+- !binary |-
+  bGliL3JvYmluaG9vZC9wcm9jZXNzLnJi
+- !binary |-
+  bGliL3JvYmluaG9vZC9zZXR1cC5yYg==
+- !binary |-
+  bGliL3JvYmluaG9vZC92ZXJzaW9uLnJi
+- !binary |-
+  cm9iaW5ob29kLmdlbXNwZWM=
+- !binary |-
+  c3BlYy9hY2NlcHRhbmNlL3NldHVwX3NwZWMucmI=
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==
+homepage: http://www.codegram.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      hash: 2002549777813010636
+      segments:
+      - 0
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Robin hood leverages celluloid actors and redis-mutex to distribute long-lived,
+  single-instance processes across multiple servers.
+test_files:
+- !binary |-
+  c3BlYy9hY2NlcHRhbmNlL3NldHVwX3NwZWMucmI=
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==