action_subscriber 2.5.0.pre-java → 3.0.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 915c64745ca55a9a6f8fc148717856f3e89061bd
-  data.tar.gz: 3e33152ee0f1c5116bdb6330368d01535c4c02be
+  metadata.gz: 9ad18409eae9a5a099a7263c0ade2678eab25342
+  data.tar.gz: 27072b9738bc2fe3cdd341092951ca9de3e6ac93
 SHA512:
-  metadata.gz: 1804d484c794bb5abe9aea0ecd59956c6a3e3a8c07e96578c5706e590f09b619f333c7c3707cc9c00ddcd191770fb422da3c190aa302d13cffa786ebf11a1ca7
-  data.tar.gz: e6cdcb2d5bfa138fa0d15501e3895add14cc3715c168688760c5ded0e8bb374affa71ca861844fcef5d05c3c2fd51df439d73638a3fb698282893dae87e17621
+  metadata.gz: 1419db5c28f91368548921aa60ad290544113c2580fcf5f63168cb025fad0969345ed62277c24850f47816893be95cc6542f05ab17681cc733d7d4760c4c3de6
+  data.tar.gz: 93858843bfd8de33cc95f4d85d3e671acd3abc010ada5b8b3ad3eb1a2d952f9e401d711492b0ae4d90cb02d41a3fcb0de2f75c5824c5ffff497daa1d69fca4b6

data/.travis.yml

@@ -3,8 +3,8 @@ rvm:
  - 2.2.4
  - 2.3.0
  - jruby-9.0.4.0
+ - jruby-9.1.5.0
  - jruby-head
- - rbx-2
 services:
  - rabbitmq
 sudo: false
@@ -12,4 +12,3 @@ cache: bundler
 matrix:
   allow_failures:
     - rvm: jruby-head
-    - rvm: rbx-2

data/README.md

@@ -24,8 +24,6 @@ A subscriber is set up by creating a class that inherits from ActionSubscriber::
 
 ```ruby
 class UserSubscriber < ::ActionSubscriber::Base
-  publisher :user_hq
-
   def created
     # do something when a user is created
   end
@@ -36,35 +34,29 @@ checkout the examples dir for more detailed examples.
 
 Usage
 -----------------
-ActionSubscriber is inspired by rails observers, and if you are familiar with rails
-observers the ActionSubscriber DSL should make you feel right at home!
-
-First, create a subscriber the inherits from ActionSubscriber::Base
 
-Then, when your app starts up, you will need to load your subscriber code and then do
+In your application setup you will draw your subscription routes. In a rails app this is usually done in `config/initializers/action_subscriber.rb`.
 
 ```ruby
-ActionSubscriber.start_subscribers
-while true
-  sleep 1.0
+::ActionSubscriber.draw_routes do
+  # you can define routes one-by-one for fine-grained controled
+  route UserSubscriber, :created
+
+  # or you can setup default routes for all the public methods in a subscriber
+  default_routes_for UserSubscriber
 end
 ```
 
-or
+Now you can start your subscriber process with:
 
-```ruby
-::ActionSubscriber.start_queues
-while true
-  ::ActionSubscriber.auto_pop!
-  sleep 1.0
-end
+
+```
+$ bundle exec action_subscriber start --mode=subscribe
 ```
 
-Any public methods on your subscriber will be registered as queues with rabbit with
-routing keys named intelligently.
+This will start your subscribers in a mode where they connect to rabbitmq and let the broker push messages down to them.
 
-Once ActionSubscriber receives a message, it will call the associated method and the
-parameter you recieve will be a decoded message.
+You can also start in `--mode=pop` where your process will poll the broker for messages.
 
 Configuration
 -----------------
@@ -80,11 +72,11 @@ In an initializer, you can set the host and the port like this :
 Other configuration options include :
 
 * config.add_decoder - add a custom decoder for a custom content type
-* config.allow_low_priority_methods - subscribe to queues for methods suffixed with "_low"
 * config.default_exchange - set the default exchange that your queues will use, using the default RabbitMQ exchange is not recommended
 * config.error_handler - handle error like you want to handle them!
 * config.heartbeat - number of seconds between hearbeats (default 5) [see bunny documentation for more details](http://rubybunny.info/articles/connecting.html)
-* config.hosts - an array of hostnames in your cluster
+* config.hosts - an array of hostnames in your cluster (ie `["rabbit1.myapp.com", "rabbit2.myapp.com"]`)
+* config.pop_interval - how long to wait between polling for messages in `--mode=pop`. It should be a number of milliseconds
 * config.threadpool_size - set the number of threads availiable to action_subscriber
 * config.timeout - how many seconds to allow rabbit to respond before timing out
 * config.times_to_pop - when using RabbitMQ's pull API, the number of messages we will grab each time we pool the broker

data/action_subscriber.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'middleware'
   spec.add_dependency 'thor'
 
+  spec.add_development_dependency "active_publisher", "~> 0.1.5"
   spec.add_development_dependency "activerecord", ">= 3.2"
   spec.add_development_dependency "bundler", ">= 1.6"
   spec.add_development_dependency "pry-nav"

data/lib/action_subscriber.rb

@@ -25,8 +25,6 @@ require "action_subscriber/subscribable"
 require "action_subscriber/bunny/subscriber"
 require "action_subscriber/march_hare/subscriber"
 require "action_subscriber/babou"
-require "action_subscriber/publisher"
-require "action_subscriber/publisher/async"
 require "action_subscriber/route"
 require "action_subscriber/route_set"
 require "action_subscriber/router"
@@ -80,19 +78,21 @@ module ActionSubscriber
     end
   end
 
-  def self.setup_queues!
-    route_set.setup_queues!
+  def self.setup_default_connection!
+    ::ActionSubscriber::RabbitConnection.setup_connection(:default, {})
+  end
+
+  def self.setup_subscriptions!
+    route_set.setup_subscriptions!
   end
 
   def self.start_queues
-    ::ActionSubscriber::RabbitConnection.subscriber_connection
-    setup_queues!
+    setup_subscriptions!
     print_subscriptions
   end
 
   def self.start_subscribers
-    ::ActionSubscriber::RabbitConnection.subscriber_connection
-    setup_queues!
+    setup_subscriptions!
     auto_subscribe!
     print_subscriptions
   end
@@ -105,21 +105,14 @@ module ActionSubscriber
   require "action_subscriber/railtie" if defined?(Rails)
   ::ActiveSupport.run_load_hooks(:action_subscriber, Base)
 
-  # Intialize async publisher adapter
-  ::ActionSubscriber::Publisher::Async.publisher_adapter
-
   ##
   # Private Implementation
   #
   def self.route_set
     @route_set ||= begin
-      if @draw_routes_block
-        routes = Router.draw_routes(&@draw_routes_block)
-        RouteSet.new(routes)
-      else
-        logger.warn "DEPRECATION WARNING: We are inferring your routes by looking at your subscribers. This behavior is deprecated and will be removed in version 2.0. Please see the routing guide at https://github.com/mxenabled/action_subscriber/blob/master/routing.md"
-        RouteSet.new(self.send(:default_routes))
-      end
+      fail "cannot start because no routes have been defined. Please make sure that you call ActionSubscriber.draw_routes when your application loads" unless @draw_routes_block
+      routes = Router.draw_routes(&@draw_routes_block)
+      RouteSet.new(routes)
     end
   end
   private_class_method :route_set
@@ -131,8 +124,3 @@ module ActionSubscriber
   end
   private_class_method :default_routes
 end
-
-at_exit do
-  ::ActionSubscriber::Publisher::Async.publisher_adapter.shutdown!
-  ::ActionSubscriber::RabbitConnection.publisher_disconnect!
-end

data/lib/action_subscriber/babou.rb

@@ -7,7 +7,7 @@ module ActionSubscriber
     def self.auto_pop!
       @pop_mode = true
       reload_active_record
-      load_subscribers unless subscribers_loaded?
+      ::ActionSubscriber.setup_default_connection!
       sleep_time = ::ActionSubscriber.configuration.pop_interval.to_i / 1000.0
 
       ::ActionSubscriber.start_queues
@@ -30,7 +30,7 @@ module ActionSubscriber
     def self.start_subscribers
       @prowl_mode = true
       reload_active_record
-      load_subscribers unless subscribers_loaded?
+      ::ActionSubscriber.setup_default_connection!
 
       ::ActionSubscriber.start_subscribers
       logger.info "Action Subscriber connected"
@@ -45,29 +45,6 @@ module ActionSubscriber
       !!@prowl_mode
     end
 
-    def self.load_subscribers
-      subscription_paths = ["subscriptions", "subscribers"]
-      path_prefixes = ["lib", "app"]
-      cloned_paths = subscription_paths.dup
-
-      path_prefixes.each do |prefix|
-        cloned_paths.each { |path| subscription_paths << "#{prefix}/#{path}" }
-      end
-
-      absolute_subscription_paths = subscription_paths.map{ |path| ::File.expand_path(path) }
-      absolute_subscription_paths.each do |path|
-        if ::File.exists?("#{path}.rb")
-          load("#{path}.rb")
-        end
-
-        if ::File.directory?(path)
-          ::Dir[::File.join(path, "**", "*.rb")].sort.each do |file|
-            load file
-          end
-        end
-      end
-    end
-
     def self.logger
       ::ActionSubscriber::Logging.logger
     end
@@ -108,9 +85,5 @@ module ActionSubscriber
 
       puts "threadpool empty. Shutting down"
     end
-
-    def self.subscribers_loaded?
-      !::ActionSubscriber::Base.inherited_classes.empty?
-    end
   end
 end

data/lib/action_subscriber/base.rb

@@ -26,10 +26,6 @@ module ActionSubscriber
     # Class Methods
     #
 
-    def self.connection
-      ::ActionSubscriber::RabbitConnection.subscriber_connection
-    end
-
     # Inherited callback, save a reference to our descendents
     #
     def self.inherited(klass)

data/lib/action_subscriber/bunny/subscriber.rb

@@ -11,12 +11,18 @@ module ActionSubscriber
         bunny_consumers.each(&:cancel)
       end
 
+      def create_queue(channel, queue_name, queue_options)
+        ::Bunny::Queue.new(channel, queue_name, queue_options)
+      end
+
       def auto_pop!
         # Because threadpools can be large we want to cap the number
         # of times we will pop each time we poll the broker
         times_to_pop = [::ActionSubscriber::Threadpool.ready_size, ::ActionSubscriber.config.times_to_pop].min
         times_to_pop.times do
-          queues.each do |route, queue|
+          subscriptions.each do |subscription|
+            route = subscription[:route]
+            queue = subscription[:queue]
             # Handle busy checks on a per threadpool basis
             next if route.threadpool.busy?
 
@@ -25,7 +31,6 @@ module ActionSubscriber
             ::ActiveSupport::Notifications.instrument "popped_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
             properties = {
               :action => route.action,
-              :channel => queue.channel,
               :content_type => properties[:content_type],
               :delivery_tag => delivery_info.delivery_tag,
               :exchange => delivery_info.exchange,
@@ -41,7 +46,9 @@ module ActionSubscriber
       end
 
       def auto_subscribe!
-        queues.each do |route, queue|
+        subscriptions.each do |subscription|
+          route = subscription[:route]
+          queue = subscription[:queue]
           channel = queue.channel
           channel.prefetch(route.prefetch) if route.acknowledgements?
           consumer = ::Bunny::Consumer.new(channel, queue, channel.generate_consumer_tag, !route.acknowledgements?)
@@ -59,7 +66,7 @@ module ActionSubscriber
               :queue => queue.name,
             }
             env = ::ActionSubscriber::Middleware::Env.new(route.subscriber, encoded_payload, properties)
-            enqueue_env(route.threadpool, env)
+            run_env(env)
           end
           bunny_consumers << consumer
           queue.subscribe_with(consumer)
@@ -76,6 +83,13 @@ module ActionSubscriber
           end
         end
       end
+
+      def run_env(env)
+        logger.info "RECEIVED #{env.message_id} from #{env.queue}"
+        ::ActiveSupport::Notifications.instrument "process_event.action_subscriber", :subscriber => env.subscriber.to_s, :routing_key => env.routing_key, :queue => env.queue do
+          ::ActionSubscriber.config.middleware.call(env)
+        end
+      end
     end
   end
 end

data/lib/action_subscriber/configuration.rb

@@ -4,10 +4,6 @@ require "action_subscriber/uri"
 module ActionSubscriber
   class Configuration
     attr_accessor :allow_low_priority_methods,
-                  :async_publisher,
-                  :async_publisher_drop_messages_when_queue_full,
-                  :async_publisher_max_queue_size,
-                  :async_publisher_supervisor_interval,
                   :decoder,
                   :default_exchange,
                   :error_handler,
@@ -19,7 +15,6 @@ module ActionSubscriber
                   :pop_interval,
                   :port,
                   :prefetch,
-                  :publisher_confirms,
                   :seconds_to_wait_for_graceful_shutdown,
                   :username,
                   :threadpool_size,
@@ -31,10 +26,6 @@ module ActionSubscriber
 
     DEFAULTS = {
       :allow_low_priority_methods => false,
-      :async_publisher => 'memory',
-      :async_publisher_drop_messages_when_queue_full => false,
-      :async_publisher_max_queue_size => 1_000_000,
-      :async_publisher_supervisor_interval => 200, # in milliseconds
       :default_exchange => 'events',
       :heartbeat => 5,
       :host => 'localhost',
@@ -42,8 +33,7 @@ module ActionSubscriber
       :mode => 'subscribe',
       :pop_interval => 100, # in milliseconds
       :port => 5672,
-      :prefetch => 5,
-      :publisher_confirms => false,
+      :prefetch => 2,
       :seconds_to_wait_for_graceful_shutdown => 30,
       :threadpool_size => 8,
       :timeout => 1,

data/lib/action_subscriber/default_routing.rb

@@ -1,19 +1,21 @@
 module ActionSubscriber
   module DefaultRouting
-    def routes
+    def routes(route_settings)
       @routes ||= begin
         routes = []
         exchange_names.each do |exchange_name|
           subscribable_methods.each do |method_name|
-            routes << ActionSubscriber::Route.new({
+            settings = {
               acknowledgements: acknowledge_messages?,
               action: method_name,
-              durable: false, 
+              durable: false,
               exchange: exchange_name,
               routing_key: routing_key_name_for_method(method_name),
               subscriber: self,
               queue: queue_name_for_method(method_name),
-            })
+            }
+            settings.merge!(route_settings)
+            routes << ActionSubscriber::Route.new(settings)
           end
         end
         routes

data/lib/action_subscriber/march_hare/subscriber.rb

@@ -7,12 +7,20 @@ module ActionSubscriber
         march_hare_consumers.each(&:cancel)
       end
 
+      def create_queue(channel, queue_name, queue_options)
+        queue = ::MarchHare::Queue.new(channel, queue_name, queue_options)
+        queue.declare!
+        queue
+      end
+
       def auto_pop!
         # Because threadpools can be large we want to cap the number
         # of times we will pop each time we poll the broker
         times_to_pop = [::ActionSubscriber::Threadpool.ready_size, ::ActionSubscriber.config.times_to_pop].min
         times_to_pop.times do
-          queues.each do |route,queue|
+          subscriptions.each do |subscription|
+            route = subscription[:route]
+            queue = subscription[:queue]
             # Handle busy checks on a per threadpool basis
             next if route.threadpool.busy?
 
@@ -21,7 +29,6 @@ module ActionSubscriber
             ::ActiveSupport::Notifications.instrument "popped_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
             properties = {
               :action => route.action,
-              :channel => queue.channel,
               :content_type => metadata.content_type,
               :delivery_tag => metadata.delivery_tag,
               :exchange => metadata.exchange,
@@ -40,7 +47,9 @@ module ActionSubscriber
       end
 
       def auto_subscribe!
-        queues.each do |route,queue|
+        subscriptions.each do |subscription|
+          route = subscription[:route]
+          queue = subscription[:queue]
           queue.channel.prefetch = route.prefetch if route.acknowledgements?
           consumer = queue.subscribe(route.queue_subscription_options) do |metadata, encoded_payload|
             ::ActiveSupport::Notifications.instrument "received_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
@@ -56,7 +65,7 @@ module ActionSubscriber
               :queue => queue.name,
             }
             env = ::ActionSubscriber::Middleware::Env.new(route.subscriber, encoded_payload, properties)
-            enqueue_env(route.threadpool, env)
+            run_env(env)
           end
 
           march_hare_consumers << consumer
@@ -78,6 +87,13 @@ module ActionSubscriber
         end
       end
 
+      def run_env(env)
+        logger.info "RECEIVED #{env.message_id} from #{env.queue}"
+        ::ActiveSupport::Notifications.instrument "process_event.action_subscriber", :subscriber => env.subscriber.to_s, :routing_key => env.routing_key, :queue => env.queue do
+          ::ActionSubscriber.config.middleware.call(env)
+        end
+      end
+
       def _normalized_headers(metadata)
         return {} unless metadata.headers
         metadata.headers.each_with_object({}) do |(header,value), hash|

data/lib/action_subscriber/message_retry.rb

@@ -46,7 +46,7 @@ module ActionSubscriber
     end
 
     def self.with_exchange(env, ttl, retry_queue_name)
-      channel = RabbitConnection.subscriber_connection.create_channel
+      channel = RabbitConnection.with_connection(:default){|connection| connection.create_channel}
       begin
         channel.confirm_select
         # an empty string is the default exchange [see bunny docs](http://rubybunny.info/articles/exchanges.html#default_exchange)

data/lib/action_subscriber/middleware/env.rb

@@ -28,7 +28,7 @@ module ActionSubscriber
       #         :routing_key => String
       def initialize(subscriber, encoded_payload, properties)
         @action = properties.fetch(:action)
-        @channel = properties.fetch(:channel)
+        @channel = properties[:channel]
         @content_type = properties.fetch(:content_type)
         @delivery_tag = properties.fetch(:delivery_tag)
         @encoded_payload = encoded_payload
@@ -41,12 +41,14 @@ module ActionSubscriber
       end
 
       def acknowledge
+        fail ::RuntimeError, "you can't acknowledge messages under the polling API" unless @channel
         acknowledge_multiple_messages = false
         @channel.ack(@delivery_tag, acknowledge_multiple_messages)
         true
       end
 
       def reject
+        fail ::RuntimeError, "you can't acknowledge messages under the polling API" unless @channel
         requeue_message = true
         @channel.reject(@delivery_tag, requeue_message)
         true