sucker_punch 0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Hilkert
+
+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,95 @@
+# Sucker Punch
+
+Sucker Punch is a Ruby asynchronous processing using Celluloid, heavily influenced by Sidekiq and girl_friday. With Celluloid's actor pattern, we use do asynchronous processing within a single process. This reduces costs of hosting on a service like Heroku along with the memory footprint of having to maintain additional workers if hosting on a dedicated server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sucker_punch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sucker_punch
+
+## Usage
+
+Configuration:
+
+`app/config/sucker_punch.rb`
+
+```Ruby
+  SuckerPunch.config do
+    queue name: :log_queue, worker: LogWorker, size: 10
+    queue name: :awesome_queue, worker: AwesomeWorker, size: 2
+  end
+```
+
+Workers:
+
+`app/workers/log_worker.rb`
+
+```Ruby
+class LogWorker
+  include SuckerPunch::Worker
+
+  def perform(event)
+    Log.new(event).track
+  end
+end
+```
+
+All workers should define an instance method `perform`, of which the job being queued will adhere to.
+
+Workers interacting with `ActiveRecord` should take special precaution not to exhause connections in the pool. This can be done with `ActiveRecord::Base.connection_pool.with_connection`, which ensures the connection is returned back to the pool when completed.
+
+`app/workers/awesome_worker.rb`
+
+```Ruby
+class AwesomeWorker
+  include SuckerPunch::Worker
+
+  def perform(user_id)
+    ActiveRecord::Base.connection_pool.with_connection do
+      user = User.find(user_id)
+      user.update_attributes(is_awesome: true)
+    end
+  end
+end
+```
+
+Queues:
+
+```Ruby
+SuckerPunch::Queue[:log_queue] # Is just the class LogWorker
+```
+
+Synchronous:
+
+```Ruby
+SuckerPunch::Queue[:log_queue].perform("login")
+```
+
+Asynchronous:
+
+```Ruby
+SuckerPunch::Queue[:log_queue].async.perform("login") # => nil
+```
+
+## Gem Name
+
+With all due respect, [@jmazzi](https://twitter.com/jmazzi) is completely responsible for the name, which is totally awesome. If you're looking for a name for something, he is the one to go to.
+
+## 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,12 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+task :test => :spec
+
+task :console do
+  exec "irb -r sucker_punch -I ./lib"
+end

data/lib/sucker_punch.rb

@@ -0,0 +1,29 @@
+require 'celluloid'
+require 'sucker_punch/exceptions'
+
+module SuckerPunch
+  extend self
+
+  def config(&block)
+    instance_eval &block
+  end
+
+  def queue(options = {})
+    raise SuckerPunch::MissingQueueName unless options[:name]
+    raise SuckerPunch::MissingWorkerName unless options[:worker]
+
+    klass         = options.fetch(:worker)
+    registry_name = options.fetch(:name)
+    size          = options.fetch(:size, nil)
+
+    Celluloid::Actor[registry_name] = if size
+                                        klass.send(:pool, size: size)
+                                      else
+                                        klass.send(:pool)
+                                      end
+  end
+end
+
+require 'sucker_punch/queue'
+require 'sucker_punch/worker'
+require 'sucker_punch/version'

data/lib/sucker_punch/exceptions.rb

@@ -0,0 +1,6 @@
+module SuckerPunch
+  class Error < StandardError; end
+  class MissingQueueName < Error; end
+  class MissingWorkerName < Error; end
+
+end

data/lib/sucker_punch/queue.rb

@@ -0,0 +1,9 @@
+module SuckerPunch
+  module Queue
+    extend self
+
+    def [](name)
+      Celluloid::Actor[name]
+    end
+  end
+end

data/lib/sucker_punch/version.rb

@@ -0,0 +1,3 @@
+module SuckerPunch
+  VERSION = "0.1"
+end

data/lib/sucker_punch/worker.rb

@@ -0,0 +1,7 @@
+module SuckerPunch
+  module Worker
+    def self.included(base)
+      base.send :include, ::Celluloid
+    end
+  end
+end

data/spec/queue_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+class FakeWorker
+  include Celluloid
+end
+
+describe SuckerPunch::Queue do
+  describe ".[]" do
+    it "delegates to Celluloid" do
+      Celluloid::Actor[:fake] = FakeWorker.pool
+      Celluloid::Actor.should_receive(:[]).with(:fake)
+      SuckerPunch::Queue[:fake]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require 'sucker_punch'

data/spec/sucker_punch_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+class FakeWorker
+  include Celluloid
+end
+
+describe SuckerPunch do
+  context "config" do
+    context "properly configured" do
+      before(:all) do
+        SuckerPunch.config do
+          queue name: :crazy_queue, worker: FakeWorker, size: 7
+        end
+      end
+
+      it "turns the class into an actor" do
+        Celluloid::Actor[:crazy_queue].should be_a(FakeWorker)
+        Celluloid::Actor[:crazy_queue].methods.should include(:async)
+      end
+
+      it "allow asynchrounous processing" do
+      end
+
+      it "sets worker size" do
+        Celluloid::Actor[:crazy_queue].size.should == 7
+      end
+    end
+
+    context "with no queue name" do
+      it "raises an exception" do
+        expect {
+          SuckerPunch.config do
+            queue worker: FakeWorker
+          end
+        }.to raise_error(SuckerPunch::MissingQueueName)
+      end
+    end
+
+    context "with no worker name" do
+      it "raises an exception" do
+        expect {
+          SuckerPunch.config do
+            queue name: :fake
+          end
+        }.to raise_error(SuckerPunch::MissingWorkerName)
+      end
+    end
+
+  end
+end

data/spec/worker_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+class FakeWorker
+  include SuckerPunch::Worker
+
+  def perform
+    puts "do stuff"
+  end
+end
+
+describe SuckerPunch::Worker do
+  it "should include Celluloid into requesting class when included" do
+    FakeWorker.should respond_to(:pool)
+  end
+end

data/sucker_punch.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sucker_punch/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sucker_punch"
+  gem.version       = SuckerPunch::VERSION
+  gem.authors       = ["Brandon Hilkert"]
+  gem.email         = ["brandonhilkert@gmail.com"]
+  gem.description   = %q{Asynchronous processing library for Ruby}
+  gem.summary       = %q{Sucker Punch is a Ruby asynchronous processing using Celluloid, heavily influenced by Sidekiq and girl_friday.}
+  gem.homepage      = "https://github.com/brandonhilkert/sucker_punch"
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+
+  gem.add_dependency "celluloid", "> 0.11"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: sucker_punch
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Hilkert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Asynchronous processing library for Ruby
+email:
+- brandonhilkert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sucker_punch.rb
+- lib/sucker_punch/exceptions.rb
+- lib/sucker_punch/queue.rb
+- lib/sucker_punch/version.rb
+- lib/sucker_punch/worker.rb
+- spec/queue_spec.rb
+- spec/spec_helper.rb
+- spec/sucker_punch_spec.rb
+- spec/worker_spec.rb
+- sucker_punch.gemspec
+homepage: https://github.com/brandonhilkert/sucker_punch
+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.23
+signing_key: 
+specification_version: 3
+summary: Sucker Punch is a Ruby asynchronous processing using Celluloid, heavily influenced
+  by Sidekiq and girl_friday.
+test_files:
+- spec/queue_spec.rb
+- spec/spec_helper.rb
+- spec/sucker_punch_spec.rb
+- spec/worker_spec.rb