whirl 0.0.3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'autotest'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jesse Trimble
+
+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,53 @@
+# Whirl
+
+A watered-down gem for looping over jobs. Pre-wired with Redis and HTTParty. Built with Heroku usage in mind.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'whirl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whirl
+
+## Usage
+
+A contrived example, but this is all you need:
+
+```ruby
+require 'whirl'
+
+class Whirl::Job::DoBusiness < Whirl::Job::Base
+  action do
+    say "HA HA! _BUSINESS_: http://i.imgur.com/EFcX1.jpg", :red
+  end
+end
+
+class Whirl::Job::MonitorSomeStuff < Whirl::Job::Base
+  action do
+    # Monitor a website, make api calls, send emails...
+    say "Do ALL THE MONITORING!"
+  end
+end
+
+Whirl.run # <= continuously loops over the DoBusiness and MonitorSomeStuff jobs
+```
+
+## TODO
+
+- Finish documentation
+- Detailed usage examples
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require File.expand_path("../lib/whirl", __FILE__)
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run all examples"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = %w[--color]
+  end
+
+  task :default => [:spec]
+rescue LoadError; end

data/lib/whirl/job/base.rb

@@ -0,0 +1,49 @@
+module Whirl
+
+  module Job
+
+    class Base
+
+      class << self
+        attr_accessor :job_action
+      end
+
+      def self.action(&block)
+        self.job_action = block
+      end
+
+      def self.perform
+        say "starting...", :blue
+        begin
+          job_action.call
+        rescue Exception => e
+          say "Job #{self.name} failed!", :red
+          say ".. Reason: #{e.message}", :red
+          if ENV['DEBUG']
+            say ".. Backtrace:"
+            puts e.backtrace
+          end
+        ensure
+        end
+      end
+
+      def self.newline
+        puts "\n"
+      end
+
+      def self.say(*args)
+        args.push :cyan if args.size == 1
+        @shell ||= Thor::Shell::Color.new
+        message = "#{self.name.ljust(28, " ")} === #{args.shift}"
+        @shell.say *[message, *args]
+      end
+
+      def self.redis_key(val)
+        "#{self.name}:#{val}"
+      end
+
+    end
+
+  end
+
+end

data/lib/whirl/redis.rb

@@ -0,0 +1,24 @@
+require 'forwardable'
+
+module Whirl
+
+  class Redis
+    extend Forwardable
+    include Singleton
+
+    def_delegators :@client, :get, :set
+
+    attr_accessor :client
+
+    def initialize
+      self.client = if redis_url = ENV['REDISTOGO_URL']
+        u = URI.parse(redis_url)
+        ::Redis.new host: u.host, port: u.port, password: u.password
+      else
+        ::Redis.new
+      end
+    end
+
+  end
+
+end

data/lib/whirl/version.rb

@@ -0,0 +1,3 @@
+module Whirl
+  VERSION = '0.0.3'
+end

data/lib/whirl.rb

@@ -0,0 +1,50 @@
+$:.unshift File.expand_path("..", __FILE__) unless $:.include? File.expand_path("..", __FILE__)
+
+require 'rake'
+require 'thor'
+require 'httparty'
+require 'redis'
+require 'json'
+
+require 'whirl/version'
+require 'whirl/redis'
+require 'whirl/job/base'
+
+module Whirl
+
+  def self.jobs
+    jobs = Whirl::Job.constants.
+      map { |d| Whirl::Job.const_get(d) }.
+      select { |d| d.respond_to? :perform }
+
+    jobs -= [Whirl::Job::Base]
+  end
+
+  def self.run
+    trap("SIGINT") do
+      Whirl::Job::Base.newline
+      Whirl::Job::Base.say "Whirled.", :green
+      Whirl::Job::Base.newline
+      exit 0
+    end
+
+    begin
+      jobs.each do |j|
+        fork do
+          j.perform
+        end
+      end
+
+      sleep whirl_interval.to_i
+    end while loop?
+  end
+
+  def self.loop?
+    true
+  end
+
+  def self.whirl_interval
+    ENV['WHIRL_LOOP_INTERVAL'] || 10
+  end
+
+end

data/spec/lib/whirl_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Whirl do
+
+  module Whirl::Job
+    class FakeJob
+      def self.perform(*); end
+    end
+
+    class Nope; end
+  end
+
+  describe '.jobs' do
+
+    it "returns an array of all constants under Whirl::Job that respond to #perform, less Base" do
+      Whirl.jobs.should == [Whirl::Job::FakeJob]
+    end
+
+  end
+
+  describe '.run' do
+
+    # Don't want Whirl to fork, keep spinning or have delays.
+    #
+    before do
+      Whirl.stub(:fork) do |&block|
+        block.call
+      end
+      Whirl.stub(:loop?).and_return(false)
+      Whirl.stub(:whirl_interval).and_return(0)
+    end
+
+    it 'knows its jobs' do
+      job_mock = mock
+      job_mock.should_receive(:perform)
+
+      Whirl.stub(:jobs).and_return [job_mock]
+      Whirl.run
+    end
+
+    it 'runs each job' do
+      class Whirl::Job::FakeAgain
+        def perform(*); end
+      end
+
+      Whirl::Job::FakeJob.should_receive(:perform).once
+      Whirl::Job::FakeAgain.should_receive(:perform).once
+
+      Whirl.run
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+File.expand_path("../../lib", __FILE__).tap { |p| $:.unshift p unless $:.include? p }
+
+require 'whirl'

data/whirl.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/whirl/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jesse Trimble"]
+  gem.email         = ["jlowelltrim@gmail.com"]
+  gem.description   = %q{A watered-down task runner pre-wired with Redis. Built with Heroku Cedar in mind.}
+  gem.summary       = %q{A watered-down task runner pre-wired with Redis. Built with Heroku Cedar in mind.}
+  gem.homepage      = ""
+
+  gem.add_dependency 'thor'
+  gem.add_dependency 'httparty'
+  gem.add_dependency 'redis'
+
+  gem.add_development_dependency 'rspec'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "whirl"
+  gem.require_paths = ["lib"]
+  gem.version       = Whirl::VERSION
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: whirl
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Jesse Trimble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70311718593320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311718593320
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70311718592820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311718592820
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70311718592340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311718592340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70311718591840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70311718591840
+description: A watered-down task runner pre-wired with Redis. Built with Heroku Cedar
+  in mind.
+email:
+- jlowelltrim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/whirl.rb
+- lib/whirl/job/base.rb
+- lib/whirl/redis.rb
+- lib/whirl/version.rb
+- spec/lib/whirl_spec.rb
+- spec/spec_helper.rb
+- whirl.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A watered-down task runner pre-wired with Redis. Built with Heroku Cedar
+  in mind.
+test_files:
+- spec/lib/whirl_spec.rb
+- spec/spec_helper.rb