philotic 0.8.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 4b6c5ea9acde32413d17038555e1d6d4a47584f5
-  data.tar.gz: 064a0af07b4f685a58bb4c7a4016ac929a4ff338
-SHA512: 
-  metadata.gz: 7c4bdeeeaab84fe4033d1f2df512677b4a5400c82cb01903b539b37d249285b4a6b33060153359154a87a0e3167936eeaf51a892a427128a658fca88356844fc
-  data.tar.gz: e2894d10d9de9fd0186cfefcbbdabaa48863a8f3ac99fb4d18317338df5fc5bd383b7c0a09d9828f703dae1a97ca6faefea615c02a23da9cf424e82a42233f31
+---
+SHA1:
+  metadata.gz: 2e126429cf9f92b56a49a1f1e609479736b965c1
+  data.tar.gz: 2b0f1b015e34e9e7d773973cee7b4d7657186229
+SHA512:
+  metadata.gz: 18e0412f7f720e0a382e17f109d54472ec0d6328e5d739ed8eabdf45058e33f70eb322908335d28a8b3d1825f67d42f47a63f622b3bd0df19751b0648533c00a
+  data.tar.gz: 1f06ba6e3e167d1c4d79540c7555435754b8ebee2bc62a7e3787309ab4115ec815110f036d7a2c66819e68858f08eea4993447e396196f6fbb97086ccfa0f121

data/.travis.yml

@@ -1,13 +1,12 @@
 language: ruby
 rvm:
-- 1.9.3
 - 2.0.0
-- 2.1.0
-- rbx-2.2.10
-#- rbx-2.3.0
-- jruby-19mode
+- 2.1
+- 2.2
+- rbx-2
+# - jruby-19mode
 - ruby-head
-- jruby-head
+# - jruby-head
 script:
 - bundle exec rspec
 addons:

data/README.md

@@ -20,8 +20,8 @@ Philotic.config.message_return_handler = lambda do |basic_return, metadata, mess
   Philotic.logger.warn { "Message returned. reply_text: #{basic_return.reply_text}" }
 end
 
-Philotic.subscribe(header_key: 'header_1') do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe(header_key: 'header_1') do |message|
+  ap message.attributes
 end
 
 # normally we'd do:
@@ -31,7 +31,7 @@ end
 # to keep the parent thread alive while the subscribers do their thing
 # but this infinite publish loop takes care of that
 loop do
-  Philotic::Event.publish({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
+  Philotic::Message.publish({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
   # only send a message every two seconds so we can see whats going on
   sleep 2
 end
@@ -49,8 +49,8 @@ philotic.config.message_return_handler = lambda do |basic_return, metadata, mess
   philotic.logger.warn { "Message returned. reply_text: #{basic_return.reply_text}" }
 end
 
-philotic.subscribe(header_key: 'header_1') do |message, metadata, queue|
-  ap message[:attributes]
+philotic.subscribe(header_key: 'header_1') do |message|
+  ap message.attributes
 end
 
 # normally we'd do:
@@ -60,19 +60,16 @@ end
 # to keep the parent thread alive while the subscribers do their thing
 # but this infinite publish loop takes care of that
 loop do
-  event = Philotic::Event.new({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
-  philotic.publish event
+  message = Philotic::Message.new({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
+  philotic.publish message
   # only send a message every two seconds so we can see whats going on
   sleep 2
 end
 ```
 
 ### Tested with the following Rubies
-* 1.9.3
 * 2.0.0
-* 2.1.0
-* rbx-2.2.10
-* rbx-2.3.0
-* jruby-19mode
+* 2.1.x
+* 2.2.x
+* rbx-2
 * ruby-head
-* jruby-head

data/examples/creating_named_queues/manually.rb

@@ -8,7 +8,7 @@ require 'philotic'
 # Philotic.config.initialize_named_queues must be truthy to run Philotic.initialize_named_queue!
 Philotic.config.initialize_named_queues = true
 
-Philotic.initialize_named_queue!('male_queue', bindings: [{:'x-match' => 'all', gender: :M, available: true}])
-Philotic.initialize_named_queue!('female_queue', bindings: [{:'x-match' => 'all', gender: :F, available: true}])
-Philotic.initialize_named_queue!('test_queue', bindings: [{ :'x-match' => 'any', gender: :M, available: true }])
-Philotic.initialize_named_queue!('flaky_queue', bindings: [{ :'x-match' => 'any', gender: :M, available: true }])
+Philotic.initialize_named_queue!('mauve_queue', bindings: [{:'x-match' => 'all', hue: :M, available: true}])
+Philotic.initialize_named_queue!('fuchsia_queue', bindings: [{:'x-match' => 'all', hue: :F, available: true}])
+Philotic.initialize_named_queue!('test_queue', bindings: [{ :'x-match' => 'any', hue: :M, available: true }])
+Philotic.initialize_named_queue!('flaky_queue', bindings: [{ :'x-match' => 'any', hue: :M, available: true }])

data/examples/creating_named_queues/with_rake.rb

@@ -7,5 +7,8 @@ require 'rake'
 
 require 'philotic/tasks'
 # equivelant of:
-# rake philotic:init_queues[examples/creating_named_queues/philotic_queues.yml]
+# PHILOTIC_DELETE_EXISTING_QUEUES=true rake philotic:init_queues[examples/creating_named_queues/philotic_queues.yml]
+
+# Philotic.config.self.config.delete_existing_queues must be truthy to redefine existing queues
+ENV['PHILOTIC_DELETE_EXISTING_QUEUES'] = 'true'
 Rake::Task['philotic:init_queues'].invoke(File.join(File.dirname(__FILE__), 'philotic_queues.yml'))

data/examples/publishing/publish.rb

@@ -3,29 +3,29 @@ $:.unshift File.expand_path('../../../lib', __FILE__)
 $stdout.sync = true
 
 require 'philotic'
-require 'philotic/dummy_event'
+require 'philotic/dummy_message'
 
 
 Philotic.logger.level = Logger::WARN
 
-@event = Philotic::DummyEvent.new
+@message = Philotic::DummyMessage.new
 
-@event.philotic_firehose   = true
-@event.philotic_product    = 'rabbit'
-@event.philotic_component  = 'speed_test'
-@event.philotic_event_type = 'ping'
+@message.philotic_firehose   = true
+@message.philotic_product    = 'rabbit'
+@message.philotic_component  = 'speed_test'
+@message.philotic_message_type = 'ping'
 
-@event.subject   = 'Hey'
-@event.available = true
+@message.subject   = 'Hey'
+@message.available = true
 
-@event.message_metadata = {mandatory: true}
-@event.message_metadata = {app_id: 'PHX'}
+@message.metadata = {mandatory: true}
+@message.metadata = {app_id: 'PHX'}
 
 def send_message number
-  @event.gender  = [:F, :M].sample
-  @event.message = "Message #{number}: Hey #{@event.gender == :M ? 'dude' : 'dudette'}"
+  @message.hue  = [:F, :M].sample
+  @message.message = "Message #{number}: Hue - #{@message.hue == :M ? 'mauve' : 'fuchsia'}"
 
-  Philotic.publish @event
+  Philotic.publish @message
 
 end
 
@@ -35,5 +35,5 @@ loop do
   send_message i
   print "Message rate: #{(i/(Time.now - start)).round(2)}/sec          \r"
   i+= 1
-  sleep 0.01
+  sleep 0.001
 end

data/examples/simple_instance.rb

@@ -12,8 +12,8 @@ philotic.config.message_return_handler = lambda do |basic_return, metadata, mess
   philotic.logger.warn { "Message returned. reply_text: #{basic_return.reply_text}" }
 end
 
-philotic.subscribe(header_key: 'header_1') do |message, metadata, queue|
-  ap message[:attributes]
+philotic.subscribe(header_key: 'header_1') do |message|
+  ap message.attributes
 end
 
 # normally we'd do:
@@ -23,8 +23,8 @@ end
 # to keep the parent thread alive while the subscribers do their thing
 # but this infinite publish loop takes care of that
 loop do
-  event = Philotic::Event.new({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
-  philotic.publish event
+  message = Philotic::Message.new({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
+  philotic.publish message
   # only send a message every two seconds so we can see whats going on
   sleep 2
 end

data/examples/simple_singleton.rb

@@ -10,8 +10,8 @@ Philotic.config.message_return_handler = lambda do |basic_return, metadata, mess
   Philotic.logger.warn { "Message returned. reply_text: #{basic_return.reply_text}" }
 end
 
-Philotic.subscribe(header_key: 'header_1') do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe(header_key: 'header_1') do |message|
+  ap header_key: message.header_key, payload_key: message.payload_key, methods: message.methods - Philotic::Message.new.methods
 end
 
 # normally we'd do:
@@ -21,7 +21,7 @@ end
 # to keep the parent thread alive while the subscribers do their thing
 # but this infinite publish loop takes care of that
 loop do
-  Philotic::Event.publish({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
+  Philotic::Message.publish({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
   # only send a message every two seconds so we can see whats going on
   sleep 2
 end

data/examples/subscribing/acks.rb

@@ -6,20 +6,20 @@ require 'philotic'
 require 'awesome_print'
 
 # sometimes ack
-Philotic.subscribe('flaky_queue', ack: true) do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe('flaky_queue', ack: true) do |message|
+  ap message.attributes
    [true, false].sample ? acknowledge(message) : reject(message)
 end
 
 # always ack
-Philotic.subscribe('flaky_queue', ack: true) do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe('flaky_queue', ack: true) do |message|
+  ap message.attributes
   acknowledge(message, true)
 end
 
 # always reject
-Philotic.subscribe('flaky_queue', ack: true) do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe('flaky_queue', ack: true) do |message|
+  ap message.attributes
   reject message
 end
 Philotic.subscriber.endure

data/examples/subscribing/anonymous_queue.rb

@@ -7,8 +7,8 @@ require 'awesome_print'
 
 Philotic.config.load_file(File.join(File.dirname(__FILE__), '../../', 'Philotic.yml.example'))
 
-Philotic.subscribe(philotic_firehose: true) do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe(philotic_firehose: true) do |message|
+  ap message.attributes
 end
 
 Philotic.subscriber.endure

data/examples/subscribing/consumer.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../../lib', __FILE__)
+$stdout.sync = true
+
+require 'philotic'
+require 'awesome_print'
+
+class NamedQueueConsumer < Philotic::Consumer
+
+  # subscribe to an existing named queue
+  subscribe_to :test_queue
+
+  #use acknowledgements
+  ack_messages
+
+  # REQUEUE the message with RabbitMQ if consume throws these errors. I.e., something went wrong with the consumer
+  # Only valid with ack_messages
+  requeueable_errors PossiblyTransientErrorOne, PossiblyTransientErrorTwo
+
+  # REJECT the message with RabbitMQ if consume throws these errors. I.e., The message is malformed/invalid
+  # Only valid with ack_messages
+  rejectable_errors BadMessageError
+
+  def consume(message)
+    ap named: message.attributes
+  end
+end
+
+class AnonymousQueueConsumer < Philotic::Consumer
+
+  # subscribe anonymously to a set of headers:
+  # subscribe_to header_1: 'value_1',
+  #              header_2: 'value_2',
+  #              header_3: 'value_3'
+  subscribe_to philotic_firehose: true
+
+  def consume(message)
+    ap anon: message.attributes
+  end
+end
+
+#run the consumers
+AnonymousQueueConsumer.subscribe
+NamedQueueConsumer.subscribe
+
+# keep the parent thread alive
+Philotic.endure

data/examples/subscribing/multiple_named_queues.rb

@@ -7,12 +7,12 @@ require 'awesome_print'
 
 Philotic.config.load_file(File.join(File.dirname(__FILE__), '../../', 'Philotic.yml.example'))
 
-Philotic.subscribe('female_queue') do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe('fuchsia_queue') do |message|
+  ap message.attributes
 end
 
-Philotic.subscribe('male_queue') do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe('mauve_queue') do |message|
+  ap message.attributes
 end
 
 Philotic.subscriber.endure

data/examples/subscribing/named_queue.rb

@@ -5,8 +5,8 @@ $stdout.sync = true
 require 'philotic'
 require 'awesome_print'
 
-Philotic.subscribe('test_queue') do |message, metadata, queue|
-  ap message[:attributes]
+Philotic.subscribe('test_queue') do |message|
+  ap message.attributes
 end
 
-Philotic.subscriber.endure
+Philotic.subscriber.endure

data/lib/philotic.rb

@@ -1,4 +1,3 @@
-require 'active_support/all'
 require 'pathname'
 
 module Philotic
@@ -16,8 +15,8 @@ require 'philotic/singleton'
 require 'philotic/connection'
 require 'philotic/version'
 require 'philotic/config'
-require 'philotic/routable'
-require 'philotic/event'
+require 'philotic/message'
 require 'philotic/publisher'
 require 'philotic/subscriber'
+require 'philotic/consumer'
 require 'philotic/logging'

data/lib/philotic/config.rb

@@ -144,7 +144,7 @@ module Philotic
 
     def load_file(filename, env = 'development')
       config = YAML.load_file(filename)
-      load(config[env])
+      load_config(config[env])
     end
   end
 end

data/lib/philotic/connection.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'bunny'
 require 'logger'
 require 'bunny'
+require 'active_support/all'
 require 'philotic/constants'
 require 'philotic/config'
 require 'philotic/publisher'

data/lib/philotic/constants.rb

@@ -32,7 +32,7 @@ module Philotic
       :philotic_firehose,
       :philotic_product,
       :philotic_component,
-      :philotic_event_type,
+      :philotic_message_type,
   ]
 
   DEFAULT_NAMED_QUEUE_OPTIONS     = {

data/lib/philotic/consumer.rb

@@ -0,0 +1,93 @@
+require 'philotic/singleton'
+require 'philotic/subscriber'
+
+module Philotic
+  class Consumer < Philotic::Subscriber
+
+    class << self
+
+      def subscribe_to(subscription)
+        @subscription = subscription
+      end
+
+      def subscription
+        @subscription
+      end
+
+      def ack_messages
+        @ack_messages = true
+      end
+
+      def exclusive
+        @exclusive = true
+      end
+
+      def ack_messages?
+        !!@ack_messages
+      end
+
+      def exclusive?
+        !!@exclusive
+      end
+
+      def requeueable_errors(*errors)
+        @requeueable_errors ||= Set.new
+        @requeueable_errors.merge errors
+        @requeueable_errors
+      end
+
+      def rejectable_errors(*errors)
+        @rejectable_errors ||= Set.new
+        @rejectable_errors.merge errors
+        @rejectable_errors
+      end
+
+      def subscribe
+        new(Philotic.connection).tap do |instance|
+          instance.subscribe
+        end
+      end
+
+      def subscription_options
+        {
+          manual_ack: ack_messages?,
+          exclusive:  exclusive?,
+        }
+      end
+    end
+
+    def subscribe
+      super(self.class.subscription, self.class.subscription_options) do |message|
+        _consume(message)
+      end
+    end
+
+    def consume(message)
+      raise NotImplementedError
+    end
+
+    private
+
+    def _consume(message)
+      if self.class.ack_messages?
+        begin
+          consume(message)
+        rescue => e
+
+          if self.class.requeueable_errors.include? e.class
+            reject(message, true)
+            return
+          elsif self.class.rejectable_errors.include? e.class
+            reject(message, false)
+            return
+          else
+            raise e
+          end
+        end
+        acknowledge(message)
+      else
+        consume(message)
+      end
+    end
+  end
+end