proletariat 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.2
+
+Features:
+
+  - Rake task added

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright 2014 Sebastian Edwards
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+All of the files in this project are under the project-wide license
+unless they are otherwise marked.

data/README.md

@@ -2,6 +2,8 @@
 
 Lightweight background processing in Ruby powered by RabbitMQ and the excellent concurrent-ruby gem.
 
+[![Code Climate](https://codeclimate.com/repos/52d75c166956805abe000226/badges/bf98213c1d629072560c/gpa.png)](https://codeclimate.com/repos/52d75c166956805abe000226/feed)
+
 ### Warning!
 
 This software is early-alpha, may contain bugs and change considerably in the near future.
@@ -24,7 +26,7 @@ And run:
 
 If you aren't using default RabbitMQ connection settings, ensure the `RABBITMQ_URL` env variable is present. Here's how that might look in your `.env` if you use Foreman:
 
-	RABBITMQ_URL=amqp://someuser:somepass@127.0.0.1/another_vhost
+  RABBITMQ_URL=amqp://someuser:somepass@127.0.0.1/another_vhost
 
 ### Setting up a Worker
 
@@ -35,51 +37,61 @@ Proletariat works exclusively on RabbitMQ Topic exchanges and routing keys can b
 The `#work` method should return `:ok` on success or `:drop` / `:requeue` on failure.
 
 Here's a complete example:
-	
-	class SendUserIntroductoryEmail < Proletariat::Worker
-	  listen_on 'user.created'
-	
-	  def work(message)
-	    params = JSON.parse(message)
-	
-	    UserMailer.introductory_email(params).deliver!
-	
-	    publish 'email_sent.user.introductory', {id: params['id']}.to_json
-	
-	    :ok
-	  end
-	end
-	
+
+  class SendUserIntroductoryEmail < Proletariat::Worker
+    listen_on 'user.created'
+
+    def work(message)
+      params = JSON.parse(message)
+
+      UserMailer.introductory_email(params).deliver!
+
+      publish 'email_sent.user.introductory', {id: params['id']}.to_json
+
+      :ok
+    end
+  end
+
 ### Select your Workers
 
 If you are using Rails just create a `proletariat.rb` file in your initializers directory.
 
-	Proletariat.configure worker_classes: [SendUserIntroductoryEmail, SomeOtherWorker]
-	Proletariat.run!
-	
+  Proletariat.configure worker_classes: [SendUserIntroductoryEmail, SomeOtherWorker]
+  Proletariat.run!
+
 Or define the `WORKERS` env variable.
 
-	WORKERS=SendUserIntroductoryEmail,SomeOtherWorker
-	
+  WORKERS=SendUserIntroductoryEmail,SomeOtherWorker
+
+### Deploying on Heroku
+
+It's not recommended to run your background workers in the same process as your main web process. Heroku will shutdown idle `web` processes, killing your background workers in the process. Instead create a new process type for Proletariat by adding the following to your Procfile:
+
+  workers: bundle exec rake proletariat:run
+
+And run:
+
+  heroku ps:scale workers=1
+
 ### Testing with Cucumber
 
 Add the following to your `env.rb`:
 
-	require 'proletariat/cucumber'
-	
+  require 'proletariat/cucumber'
+
 Use the provided helpers in your step definitions to synchronize your test suite with your workers without sacrificing the ability to test in production-like environment:
 
-	When(/^I submit a valid 'register user' form$/) do
-	  wait_for message.on_topic('email_sent.user.introductory') do
-	    visit   ...
-	    fill_in ...
-	    submit  ...
-	  end
-	end
-	
-	Then(/^the user should receive an introductory email$/) do
-	  expect(unread_emails_for(new_user_email).size).to eq 1
-	end
+  When(/^I submit a valid 'register user' form$/) do
+    wait_for message.on_topic('email_sent.user.introductory') do
+      visit   ...
+      fill_in ...
+      submit  ...
+    end
+  end
+
+  Then(/^the user should receive an introductory email$/) do
+    expect(unread_emails_for(new_user_email).size).to eq 1
+  end
 
 ## FAQ
 
@@ -90,4 +102,4 @@ I wanted a library which shared one RabbitMQ connection across all of the worker
 ## TODO
 - Improve test suite :(
 - Add command line interface
-- Abstract retry strategies
+- Abstract retry strategies

data/lib/proletariat/tasks.rb

@@ -0,0 +1,16 @@
+require 'proletariat'
+
+task :environment
+
+namespace :proletariat do
+  desc 'Start background processing'
+  task run: :environment do
+    STDOUT.sync = true
+
+    Proletariat.run!
+
+    at_exit { Proletariat.stop }
+
+    sleep
+  end
+end

data/lib/proletariat/version.rb

@@ -1,4 +1,4 @@
 # Public: Adds a constant for the current version number.
 module Proletariat
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: proletariat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Sebastian Edwards
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -27,43 +30,49 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   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: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.0
 description: Lightweight background processing powered by RabbitMQ
@@ -73,9 +82,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
+- .gitignore
+- .rspec
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/proletariat.rb
@@ -86,6 +97,7 @@ files:
 - lib/proletariat/queue_config.rb
 - lib/proletariat/runner.rb
 - lib/proletariat/subscriber.rb
+- lib/proletariat/tasks.rb
 - lib/proletariat/testing.rb
 - lib/proletariat/testing/expectation.rb
 - lib/proletariat/testing/expectation_guarantor.rb
@@ -96,26 +108,27 @@ files:
 - spec/lib/proletariat_spec.rb
 homepage: https://github.com/SebastianEdwards/proletariat
 licenses: []
-metadata: {}
 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: 2.2.0
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Lightweight background processing powered by RabbitMQ
 test_files:
 - spec/lib/proletariat_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: ccf124f3fb011f0dd8f06666daa0f8748c70fe32
-  data.tar.gz: a601e7e559d77d40b30f91be6824d4d51b13af3b
-SHA512:
-  metadata.gz: 22cd707dcdcbfbefbff38a8c4c4bf74cceefa87c42c30706f9028a89d2039fc0095ac1deff157f5efa9c4e60c881e4fe6cd2b8f10596142ef257cfbb54460cdb
-  data.tar.gz: 0160aced5ba612299ddb023b8cf19c361a2d02e9212bfb8c2e1d79dfbe2db07d017378ba7b9b029d894e7d18903ee371ec34623cef2941e611e4f80148a34fe6