proletariat 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49905f9a8ecb2a3b12f565f7b6c7e07c7cac6e39
-  data.tar.gz: 76771f1121f542f06a8ee2d9f6f7ffcf07982404
+  metadata.gz: f18e4d2458922ab3466f6913a079616c7ab3e5ab
+  data.tar.gz: 0ed0637283e0056fca8e260bbb4fe97dc26eca1e
 SHA512:
-  metadata.gz: 5a1e573f1fd1028068f5f91dcd5625d4ddf90052d9711b8c8a85d810db0ea4b0440cb51384040c865eea540cbbf48368dc7b2dacdc770e85fa0430b5f63f887d
-  data.tar.gz: 193ecfabdc6bb3c0d25bda8a8e57a66a77aa6ab830a552f395acc626a88803ef556019556a950201a302089a830d8328fa42690943dca4a9376a345c98200217
+  metadata.gz: f6e31240a83223f4d67f2f0e08ae194927f07b6671fa193b32e7ed6527d37e66de29ff7830047cbbeb23a300b19eb43b1ad5765546ac51f406bdabd0d83cecee
+  data.tar.gz: 431900e4e0b1f59427666ceeca3197297c3723441c0f472242ee40dda0e3afe148bbc63cde95d10818a65358130a3ea83e46006042696385d6f4d7bd6a07dd3a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.0.4
+
+Features:
+
+  - The routing key is now sent to #work along with the message
+  - Workers now log when they publish a message
+  - Test guarantors can be used without blocks
+  - Amount of worker/publisher threads can be set via env variables
+
 ## 0.0.3
 
 Features:

data/README.md

@@ -26,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
 
@@ -38,60 +38,59 @@ The `#work` method should return `:ok` on success or `:drop` / `:requeue` on fai
 
 Here's a complete example:
 
-  class SendUserIntroductoryEmail < Proletariat::Worker
-    listen_on 'user.created'
+    class SendUserIntroductoryEmail < Proletariat::Worker
+      listen_on 'user.created'
 
-    def work(message)
-      params = JSON.parse(message)
+      def work(message, key)
+        params = JSON.parse(message)
 
-      UserMailer.introductory_email(params).deliver!
+        UserMailer.introductory_email(params).deliver!
 
-      publish 'email_sent.user.introductory', {id: params['id']}.to_json
+        publish 'email_sent.user.introductory', {id: params['id']}.to_json
 
-      :ok
+        :ok
+      end
     end
-  end
 
-### Select your Workers
+### Running your Workers
 
-If you are using Rails just create a `proletariat.rb` file in your initializers directory.
+Define the `WORKERS` env variable.
 
-  Proletariat.configure worker_classes: [SendUserIntroductoryEmail, SomeOtherWorker]
-  Proletariat.run!
+    WORKERS=SendUserIntroductoryEmail,SomeOtherWorker
 
-Or define the `WORKERS` env variable.
+Run the rake command.
 
-  WORKERS=SendUserIntroductoryEmail,SomeOtherWorker
+    bundle exec rake proletariat:run
 
 ### 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
+    workers: bundle exec rake proletariat:run
 
 And run:
 
-  heroku ps:scale workers=1
+    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  ...
+    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
-  end
 
-  Then(/^the user should receive an introductory email$/) do
-    expect(unread_emails_for(new_user_email).size).to eq 1
-  end
+    Then(/^the user should receive an introductory email$/) do
+      expect(unread_emails_for(new_user_email).size).to eq 1
+    end
 
 ## FAQ
 

data/lib/proletariat/configuration.rb

@@ -5,10 +5,10 @@ module Proletariat
     DEFAULT_EXCHANGE_NAME = 'proletariat'
 
     # Public: The default number of threads to use for publishers.
-    DEFAULT_PUBLISHER_THREADS = 2
+    DEFAULT_PUBLISHER_THREADS = (ENV['PUBLISHER_THREADS'] || 2).to_i
 
     # Public: The default number of threads to use for each worker class.
-    DEFAULT_WORKER_THREADS = 3
+    DEFAULT_WORKER_THREADS = (ENV['WORKER_THREADS'] || 3).to_i
 
     # Internal: Sets the RabbitMQ connection.
     attr_writer :connection

data/lib/proletariat/subscriber.rb

@@ -117,7 +117,7 @@ module Proletariat
     # Returns nil.
     def start_consumer
       @consumer = bunny_queue.subscribe ack: true do |info, properties, body|
-        future = listener.post?(body)
+        future = listener.post?(body, info.routing_key)
         acknowledgers << Acknowledger.new(future, info.delivery_tag)
 
         nil

data/lib/proletariat/testing/expectation_guarantor.rb

@@ -30,6 +30,9 @@ module Proletariat
         end
 
         @block = block
+        @noop = true if expectations.length == 0
+
+        run_subscribers
       end
 
       # Public: Execute the blocks and waits for the expectations to be met.
@@ -37,10 +40,10 @@ module Proletariat
       # Returns nil if expectations are met within timeout.
       # Raises MessageTimeoutError if expectations are not met within timeout.
       def guarantee
-        run_subscribers
-
         block.call if block
 
+        return nil if noop
+
         timer = 0.0
 
         until passed?
@@ -49,9 +52,9 @@ module Proletariat
           timer += MESSAGE_CHECK_INTERVAL
         end
 
-        stop_subscribers
-
         nil
+      ensure
+        stop_subscribers
       end
 
       private
@@ -63,6 +66,9 @@ module Proletariat
       # Internal: Returns an array of MessageCounter instances.
       attr_reader :counters
 
+      # Internal: Returns true if there aren't any expectations.
+      attr_reader :noop
+
       # Internal: Returns an array of Subscriber instances.
       attr_reader :subscribers
 
@@ -122,7 +128,7 @@ module Proletariat
         # message - The contents of the message.
         #
         # Returns a future-like object holding an :ok Symbol.
-        def post?(message)
+        def post?(message, routing_key)
           self.count = count + 1
 
           Concurrent::Future.new { :ok }

data/lib/proletariat/testing.rb

@@ -31,11 +31,12 @@ module Proletariat
     #   # ... [Time passes]
     #   # => MessageTimeoutError
     #
-    # Returns nil.
+    # Returns ExpectationGuarantor.
     def wait_for(*expectations, &block)
-      ExpectationGuarantor.new(expectations, &block).guarantee
+      guarantor = ExpectationGuarantor.new(expectations, &block)
+      guarantor.guarantee if block.present?
 
-      nil
+      guarantor
     end
   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.3'
+  VERSION = '0.0.4'
 end

data/lib/proletariat/worker.rb

@@ -38,7 +38,7 @@ module Proletariat
     # message - The incoming message.
     #
     # Raises NotImplementedError unless implemented in subclass.
-    def work(message)
+    def work(message, routing_key)
       fail NotImplementedError
     end
 
@@ -74,6 +74,7 @@ module Proletariat
     #
     # Returns nil.
     def publish(to, message = '')
+      log "Publishing to: #{to}"
       Proletariat.publish to, message
 
       nil

data/lib/proletariat.rb

@@ -44,7 +44,7 @@ module Proletariat
 
     def method_missing(method_sym, *arguments, &block)
       if config.respond_to? method_sym
-        config.send method_sym
+        config.send(method_sym, *arguments, &block)
       else
         super
       end

data/spec/lib/proletariat_spec.rb

@@ -8,7 +8,7 @@ class PingWorker < Proletariat::Worker
     attr_accessor :pinged
   end
 
-  def work(message)
+  def work(message, routing_key)
     self.class.pinged = true
 
     log 'PING'
@@ -27,7 +27,7 @@ class PongWorker < Proletariat::Worker
     attr_accessor :ponged
   end
 
-  def work(message)
+  def work(message, routing_key)
     self.class.ponged = true
 
     log 'PONG'

data/spec/lib/testing/expectation_guarantor_spec.rb

@@ -34,19 +34,19 @@ module Proletariat
 
         it 'should increment the count' do
           counter = ExpectationGuarantor::MessageCounter.new(1)
-          counter.post?('message')
+          counter.post?('message', 'key')
           expect(counter.expected_messages_received?).to be_truthy
         end
 
         it 'should return a future containing :ok' do
           counter = ExpectationGuarantor::MessageCounter.new(1)
           expect(Concurrent::Future).to receive(:new)
-          counter.post?('message')
+          counter.post?('message', 'key')
         end
 
         it 'should ensure the returned future contains :ok' do
           counter = ExpectationGuarantor::MessageCounter.new(1)
-          future = counter.post?('message')
+          future = counter.post?('message', 'key')
           expect(future.block.call).to eq :ok
         end
       end

data/spec/lib/worker_spec.rb

@@ -2,7 +2,7 @@ require 'proletariat/worker'
 
 module Proletariat
   describe Worker do
-    let(:logger) { double }
+    let(:logger) { double.as_null_object }
 
     before do
       allow(Proletariat).to receive(:logger).and_return(logger)
@@ -31,7 +31,7 @@ module Proletariat
 
     describe '#work' do
       it 'should raise NotImplementedError' do
-        expect { Worker.new.work('message') }.to \
+        expect { Worker.new.work('message', 'key') }.to \
           raise_exception NotImplementedError
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proletariat
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sebastian Edwards
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec