robinhood 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 913bb9ef8276fd39f9c3ba6f1ad43548091601d9
-  data.tar.gz: fbb34da42c7ccc99289a41f5fc38495a9360f373
+  metadata.gz: d96b9f7a32f3b3a394c6601f4846040f22395c17
+  data.tar.gz: 859e805401593b304091c8f1cba88afe768a3e58
 SHA512:
-  metadata.gz: e09bdea365ad31009265edf0cf7607a0ca47c4b26464a646f35d94a1f556c196c9e3f2fec91297a41968bf1f9a0379adfdfc57adc6ca84b49efc8550a1525de5
-  data.tar.gz: 0e1aaae54ee25b24b35addf173a1f26c94bdd04cf9314ec5fade00e944e61ca106196dafd57caca42b700b415d5bb4e6af6a93fb35e0f57e174db61aec7d1d0c
+  metadata.gz: 2ffc6557319047d20031476ed520953999f7da88ebf321a68bfb97dfd5b4a6f71b4ddc8468c0a96b80c7623e881b27df3fcb5529361d4795706153b3083a4485
+  data.tar.gz: 01a789dd9627fac4f2d259fb429f1fac7da3266f11e6fa04f02e36fe247b7cfd9c748c0b8dd72fbcc93d7ff2f64613be58f04770a373a92f9ec36a9bf0ee56ea

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+log
+dump.rdb

data/.travis.yml

@@ -1,5 +1,7 @@
 rvm:
   - 1.9.3
   - 2.0.0
-  - rbx-19mode
-  - jruby-19mode
+  - rbx-2.1.1
+
+services:
+  - redis

data/README.md

@@ -9,9 +9,28 @@ the poor.
 It leverages celluloid actors for each process and uses Redis as a locking
 mechanism to ensure the process is run in a single server.
 
+## Compatibility
+
+Robinhood works on MRI 1.9.3 and upwards, and rubinius 2.1 and upwards. We
+don't intend to support JRuby at the moment because it lacks support for
+Process#fork which is needed in order to run robinhood as a daemon. 
+
+We could make daemonizing a separate module if there was enough interest,
+though.
+
 ## Usage
 
+Install the gem:
+
+```
+$ gem install robinhood
+```
+
+Create a `Robinhood` file in your root:
+
 ```ruby
+require 'your-app'
+
 Robinhood.define do
   redis{ Redis.new(:host => "10.0.1.1", :port => 6380) }
 
@@ -23,8 +42,31 @@ Robinhood.define do
     Sweeper.sweep!
   end
 end
+```
+
+Launch robinhood on the foreground:
+
+```
+$ robinhood
+```
+
+Launch robinhood in a daemonized way:
+
+```
+$ robinhood start
+```
 
-Robinhood.run
+Stop or restart a daemonized robinhood:
+
+```
+$ robinhood stop
+$ robinhood restart
+```
+
+You can also append options to robinhood's executable:
+
+```
+$ robinhood -c config.rb --pids-path /var/run --log-path /var/log
 ```
 
 ## How does it work?

data/Rakefile

@@ -3,4 +3,8 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task 'spinach' do
+  sh 'spinach'
+end
+
+task default: [:spec, :spinach]

data/bin/robinhood

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+require 'robinhood'
+require 'robinhood/daemon'
+require 'robinhood/daemon/options'
+
+# This executable is responsible of starting robinhood as a daemon, its basic usage is:
+#
+#   robinhood start
+#
+# This order will start a daemon with a file called robinhood.rb as the Robinhood instance
+#
+# Some options can be provided in order to modify the default behaviour, those are:
+#
+#   robinhood start --pids-path /tmp/pids
+#   robinhood stop --log-path /tmp/logs
+#   robinhood -c config_file
+#
+# To stop the daemon we will execute:
+#
+#   robinhood stop
+#
+# To run it as a foreground process:
+#
+#   robinhood run
+#
+
+# Extract the arguments
+options = Robinhood::Daemon::Options.new(ARGV).parse
+
+options[:command] ||= 'run'
+
+# Create the Daemonize object with the extracted arguments
+daemon = Robinhood::Daemon.new(options)
+
+if daemon.respond_to?(options[:command])
+  daemon.send(options[:command])
+else
+  $stderr.puts "Robinhood has no command #{options[:command]}"
+end

data/features/steps/throttling.rb

@@ -0,0 +1,32 @@
+class Spinach::Features::Throttling < Spinach::FeatureSteps
+  include Spinach::Robinhood
+
+  step 'I have a Robinhood file with a throttling ratio set at 3 seconds' do
+    @file_name = File.expand_path('./tmp/robin_tmp')
+    write_robinhood %Q{
+      Robinhood.define do
+        redis { Redis.new(database: 9) }
+        process :test, throttle: 3 do
+          File.open('#{@file_name}', 'a') do |f|
+            f.write("yeah")
+          end
+        end
+      end
+    }
+  end
+
+  step 'I run robinhood for 4 seconds' do
+    `bin/robinhood start -c tmp/Robinhood`
+    sleep 4
+    `bin/robinhood stop -c tmp/Robinhood`
+  end
+
+  step 'It has run less than 10 times' do
+    expect(File.read(@file_name).split('yeah').length).to be < 10
+  end
+
+  after do
+    FileUtils.rm(@file_name)
+    FileUtils.rm('tmp/Robinhood')
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+Spinach::FeatureSteps.include(RSpec::Matchers)

data/features/support/robinhood.rb

@@ -0,0 +1,10 @@
+require 'fileutils'
+
+module Spinach::Robinhood
+  def write_robinhood(content)
+    FileUtils.mkdir_p('tmp')
+    File.open('tmp/Robinhood', 'w') do |f|
+      f.write(content)
+    end
+  end
+end

data/features/throttling.feature

@@ -0,0 +1,9 @@
+Feature: Throttling
+  In order to limit the execution rate of a process
+  As a developer
+  I want to be able to specify throttling rates
+
+  Scenario: Throttle a process
+    Given I have a Robinhood file with a throttling ratio set at 3 seconds
+    When I run robinhood for 4 seconds
+    Then It has run less than 10 times

data/lib/robinhood.rb

@@ -1,7 +1,6 @@
 require "robinhood/version"
 require "robinhood/dsl"
 require "robinhood/runtime"
-require "celluloid/autostart"
 
 module Robinhood
   # Public: The starting point for Robinhood's DSL.

data/lib/robinhood/daemon.rb

@@ -0,0 +1,77 @@
+require 'robinhood'
+require 'daemons'
+
+module Robinhood
+  # This class will start robinhood as a daemon
+  #
+  class Daemon
+    attr_reader :file, :pids_path, :log_path
+
+    # Public: Instantiates a new Robinhood::Daemon object
+    #
+    # args - Hash with the different options that can be supplied to the Daemonize object
+    #        :config_file - File that will contain the robinhood tasks, by default it will be robinhood.rb
+    #        :pids_path - Dir to store de Pidfile for the daemon, by default it will be 'tmp/pids'
+    #        :log_path - Dir to store the logs for the daemon, by default it will be 'log'
+    #
+    # Returns a new Robinhood::Daemonize
+    def initialize(options={})
+      @options = default_options.merge(options)
+      @file = File.expand_path(@options[:config_file])
+      @pids_path = File.expand_path(@options[:pids_path])
+      @log_path = File.expand_path(@options[:log_path])
+    end
+
+    # Public: Start the daemon
+    #
+    # Returns nothing
+    def start
+      definition = File.read(file)
+
+      FileUtils.mkdir_p(log_path)
+      FileUtils.mkdir_p(pids_path)
+
+      Daemons.run_proc(filename, daemon_options.merge(ARGV: [@options[:command]])) do
+        instance_eval(definition, @file)
+        Robinhood.run
+      end
+    end
+    alias :run :start
+
+    def stop
+      Daemons.run_proc(filename, daemon_options.merge(ARGV: ['stop']))
+    end
+
+    def restart
+      stop
+      start
+    end
+
+    private
+
+    def default_options
+      {
+        command: 'start',
+        config_file: 'Robinhood',
+        log_path: 'log',
+        pids_path: File.join("tmp", "pids")
+      }
+    end
+
+    def daemon_options
+      {
+        dir_mode: :normal,
+        dir: pids_path,
+        monitor: true,
+        multiple: true,
+        app_name: 'robinhood',
+        log_dir: log_path,
+        log_output: true
+      }
+    end
+
+    def filename
+      File.basename file
+    end
+  end
+end

data/lib/robinhood/daemon/options.rb

@@ -0,0 +1,34 @@
+require_relative '../daemon'
+require 'optparse'
+
+class Robinhood::Daemon::Options
+  def initialize(data)
+    @data = data.dup
+  end
+
+  def parse
+    options = {}
+    parser(options).parse!(@data)
+    options[:command] = @data[0]
+
+    options
+  end
+
+  private
+
+  def parser(result)
+    OptionParser.new do |opts|
+      opts.on('-c', "--config FILE", String) do |file|
+        result[:config_file] = file
+      end
+
+      opts.on('--pids-path PATH') do |dir|
+        result[:pids_path] = dir
+      end
+
+      opts.on('--log-path PATH') do |dir|
+        result[:log_path] = dir
+      end
+    end
+  end
+end

data/lib/robinhood/process.rb

@@ -44,7 +44,7 @@ module Robinhood
       return unless lock
 
       begin
-        time = Benchmark.realtime{ @block.call }
+        time = Benchmark.realtime{ instance_eval(&@block) }
         if difference = throttle - time
           sleep(difference)
         end

data/lib/robinhood/runtime.rb

@@ -35,6 +35,8 @@ module Robinhood
     #
     # Returns the Runtime.
     def run(options = {})
+      Celluloid.start
+
       setup_supervision_group
       Mutex.db = redis
 

data/lib/robinhood/version.rb

@@ -1,3 +1,3 @@
 module Robinhood
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/robinhood.gemspec

@@ -20,10 +20,13 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'celluloid'
   spec.add_dependency 'redis-mutex'
+  spec.add_dependency 'daemons'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "spinach", ">= 0.8.7"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "fakefs"
 end

data/spec/lib/robinhood/daemon_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'fileutils'
+require 'fakefs/safe'
+require 'robinhood/daemon'
+
+describe Robinhood::Daemon do
+  let(:default_options) {
+    {
+      dir_mode: :normal,
+      dir: File.expand_path(File.join('tmp', 'pids')),
+      monitor: true,
+      multiple: true,
+      app_name: 'robinhood',
+      log_dir: File.expand_path('log'),
+      log_output: true,
+      ARGV: ['start']
+    }
+  }
+
+  describe '#start' do
+
+    before do
+      FakeFS.activate!
+
+      FileUtils.touch("Robinhood")
+    end
+
+    after do
+      FakeFS.deactivate!
+    end
+
+    context 'when no additional option is provided' do
+      it 'should start the daemon' do
+        daemon = Robinhood::Daemon.new
+
+        Daemons.should_receive(:run_proc).with('Robinhood', default_options)
+
+        daemon.start
+      end
+    end
+
+    context 'when different robinhood file is provided' do
+      it 'should start the daemon with the given file' do
+        daemon = Robinhood::Daemon.new(
+          config_file: File.expand_path('robinhood_2.rb')
+        )
+
+        Daemons.should_receive(:run_proc).with('robinhood_2.rb', default_options)
+
+        FileUtils.touch("robinhood_2.rb")
+
+        daemon.start
+      end
+    end
+
+    context 'when pid dir is provided' do
+      it 'start the daemon with the pid dir option' do
+        dir = File.expand_path(File.join('tmp', 'pids_2'))
+
+        daemon = Robinhood::Daemon.new(
+          pids_path: dir
+        )
+
+        Daemons.should_receive(:run_proc).with('Robinhood', default_options.merge(dir: dir))
+
+        daemon.start
+      end
+    end
+
+    context 'when log dir is provided' do
+      it 'start the daemon with the log dir option' do
+        dir = File.expand_path('log_2')
+
+        daemon = Robinhood::Daemon.new(
+          log_path: dir
+        )
+
+        Daemons.should_receive(:run_proc).with('Robinhood', default_options.merge(log_dir: dir))
+
+        daemon.start
+      end
+    end
+
+    describe '#stop' do
+      it 'should stop the daemon' do
+        daemon = Robinhood::Daemon.new(command: 'stop')
+
+        Daemons.should_receive(:run_proc).with('Robinhood', default_options.merge(ARGV: ['stop']))
+
+        daemon.stop
+      end
+    end
+  end
+end

metadata

@@ -1,129 +1,179 @@
 --- !ruby/object:Gem::Specification
 name: robinhood
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Josep Jaume
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
   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: redis-mutex
   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: daemons
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
+- !ruby/object:Gem::Dependency
+  name: spinach
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: pry
   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'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   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'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  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: Robin hood leverages celluloid actors and redis-mutex to distribute long-lived,
   single-instance processes across multiple servers.
 email:
 - josepjaume@gmail.com
-executables: []
+executables:
+- robinhood
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/robinhood
+- features/steps/throttling.rb
+- features/support/env.rb
+- features/support/robinhood.rb
+- features/throttling.feature
 - lib/robinhood.rb
+- lib/robinhood/daemon.rb
+- lib/robinhood/daemon/options.rb
 - lib/robinhood/dsl.rb
 - lib/robinhood/mutex.rb
 - lib/robinhood/process.rb
@@ -131,6 +181,7 @@ files:
 - lib/robinhood/version.rb
 - robinhood.gemspec
 - spec/acceptance/dsl_spec.rb
+- spec/lib/robinhood/daemon_spec.rb
 - spec/lib/robinhood/dsl_spec.rb
 - spec/lib/robinhood/process_spec.rb
 - spec/lib/robinhood/runtime_spec.rb
@@ -145,23 +196,28 @@ 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.3
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: Robin hood leverages celluloid actors and redis-mutex to distribute long-lived,
   single-instance processes across multiple servers.
 test_files:
+- features/steps/throttling.rb
+- features/support/env.rb
+- features/support/robinhood.rb
+- features/throttling.feature
 - spec/acceptance/dsl_spec.rb
+- spec/lib/robinhood/daemon_spec.rb
 - spec/lib/robinhood/dsl_spec.rb
 - spec/lib/robinhood/process_spec.rb
 - spec/lib/robinhood/runtime_spec.rb