lib/dispatch-rider/publisher/base.rb in dispatch-rider-1.4.2 vs lib/dispatch-rider/publisher/base.rb in dispatch-rider-1.5.0

@@ -1,39 +1,43 @@
 require 'securerandom'
 
 module DispatchRider
+  # Main template for a dispatch rider publisher.
   class Publisher::Base
-
     class << self
-
+      # @param [Symbol] subject
       def subject(subject)
         @subject = subject
       end
 
+      # @param [Array<Symbol>, Symbol] destinations
       def destinations(destinations)
         @destinations = Array(destinations)
       end
 
+      # @return [DispatchRider::Publisher]
       def default_publisher
         @@default_publisher ||= DispatchRider::Publisher.new
       end
 
       def publish(*args, &block)
-        raise NotImplementedError
+        raise NotImplementedError, "subclass of DispatchRider::Publisher::Base must implement .publish"
       end
-
     end
 
     def initialize(publisher = nil)
       @publisher = publisher
     end
 
+    # @param [Hash] body
     def publish(body)
       raise ArgumentError, 'body should be a hash' unless body.kind_of?(Hash)
       publisher.publish(destinations: destinations, message: { subject: subject, body: body })
     end
 
+    private
+
     def publisher
       @publisher || self.class.default_publisher
     end
 
     def destinations
@@ -41,8 +45,7 @@
     end
 
     def subject
       self.class.instance_variable_get(:@subject)
     end
-
   end
 end