honest_pubsub 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc6a19fcd7590a3594ce7dce30c525ffad8d862e
-  data.tar.gz: 3904cd4bde4b1498a993d868a0fc7c8b8bd0cec6
+  metadata.gz: c7c53a089f1fad2b656c8134008f95ce5e4422e7
+  data.tar.gz: 32c4c3e5f5c90697fdc092d81d2f86e22c126ff1
 SHA512:
-  metadata.gz: 07e917724a4763ceea12384d38ecd153fbc22d9055b648eb6ead02832512491394b7d1ecb4690b66c670cf0afd17a907dba57ccb9fcdc6981ef662621c9565ad
-  data.tar.gz: b28f6207461e9c0f0b09d31fda4c2819fb92cdab523f0e96294198a27e2d41895ea63d0f90310c5d4fa1907d54f6b15b194ddca0a51c5ae217cd64955d0b07ea
+  metadata.gz: d4740278b6b995f74e69338bd600ef74e4803a67d1e5584179d73412ce894f889093079eabf594b91900cb0f34737eac393d0a43cef2c1664f0c15c179827220
+  data.tar.gz: e6f84c3ded8940652bdf7da0a21a9eb159dc633c75e9ae87da27d28cd74037ebb13ee53a5bffe6a84a9a15998af18e982042c151eb5ba1606df205dcde0b409a

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Thanh Lim
+Copyright (c) 2014 The Honest Company
 
 MIT License
 

data/honest_pubsub.gemspec

@@ -8,8 +8,8 @@ require 'honest_pubsub/version'
 Gem::Specification.new do |spec|
   spec.name          = "honest_pubsub"
   spec.version       = HonestPubsub::VERSION
-  spec.authors       = ["Thanh Lim"]
-  spec.email         = ["thanh@thehonestcompany.com"]
+  spec.authors       = ["tech@honest.com", "Thanh Lim", "tusharranka@gmail.com", "Joel Jackson"]
+  spec.email         = ["webadmin@thehonestcompany.com"]
   spec.description   = "Pub sub gem for Honest Company"
   spec.summary       = "Pub sub gem for Honest Company"
   spec.homepage      = ""

data/lib/honest_pubsub/exceptions/payload_validation_error.rb

@@ -0,0 +1,4 @@
+module HonestPubsub
+  class PayloadValidationError < StandardError
+  end
+end

data/lib/honest_pubsub/server/client_queue_listener.rb

@@ -11,12 +11,12 @@ module HonestPubsub
       attr_reader :worker_class
 
       def initialize(worker_class, request_key, queue, durable = true, topic = "honest")
-        @topic = topic
-        @request_key = request_key
+        @topic        = topic
+        @request_key  = request_key
         @worker_class = worker_class
-        @queue_name = queue
-        @durable = durable
-        @subscriber = ::HonestPubsub::Subscriber.new(@request_key, @durable, @topic)
+        @queue_name   = queue
+        @durable      = durable
+        @subscriber   = ::HonestPubsub::Subscriber.new(@request_key, @durable, @topic)
       end
 
       def start
@@ -34,16 +34,18 @@ module HonestPubsub
       end
 
       def message_received(delivery_info, properties, envelope)
-        begin
-          HonestPubsub.logger.debug( "Message recieved by listener with payload: #{envelope[:payload]}" )
-          worker = "#{@worker_class}".constantize.new(delivery_info, properties)
-          raise PayloadError.new("Invalid Payload") unless worker.valid_payload?(envelope[:payload])
-          HonestPubsub.logger.debug( "Calling worker perform on message" )
-          worker.perform(envelope[:context], envelope[:payload])
-        rescue => e
-          #puts "Error in worker #{e.message}!!!"
-          Airbrake.notify("Failed perform for #{self.class.name}", params: {info: delivery_info, properties: properties, envelope: envelope.to_hash } )
-        end
+        HonestPubsub.logger.debug("Message received by listener on #{worker_class.name} with payload: #{envelope[:payload]}")
+        worker = worker_class.new(delivery_info, properties)
+        worker.perform!(envelope[:context], envelope[:payload])
+      rescue => e
+        HonestPubsub.logger.error("Failed message for #{worker_class.name}")
+        Airbrake.notify("Failed perform for #{worker_class.name}",
+                        params: {
+                          info:       delivery_info,
+                          properties: properties,
+                          context:    envelope[:context],
+                          payload:    envelope[:payload] })
+
       end
 
       protected

data/lib/honest_pubsub/server/client_worker.rb

@@ -1,6 +1,9 @@
 require 'rubygems'
 require 'active_support/core_ext'
 
+# This class provders the worker for executing the subscriber. It receives a message from rabbitmq and
+# creates an instance of the subscriber to execute with the message and context
+
 module HonestPubsub
   module Server
     class ClientWorker
@@ -20,7 +23,7 @@ module HonestPubsub
         unless validate_routing_key_name(routing_key_name)
           raise ArgumentError.new("#{routing_key_name} is not supported. Only lower case characters separated by periods are allowed.")
         end
-        self.subscribed_key = routing_key_name
+        self.subscribed_key   = routing_key_name
         self.subscribed_queue = generated_queue_name(routing_key_name, options[:on])
       end
 
@@ -32,13 +35,6 @@ module HonestPubsub
       def self.validates_payload_with(*validators)
         self.payload_validators ||= []
         self.payload_validators += validators
-        #
-        # executable = if validator.class <= Proc then
-        #                validator
-        #              elsif validator.class == Symbol
-        #                self.method(validator)
-        #              end
-        # self.payload_validators.push executable
       end
 
       # Sets an error handler for the class
@@ -48,24 +44,41 @@ module HonestPubsub
 
       def initialize(delivery_routing_data, delivery_properties)
         @delivery_routing_data = delivery_routing_data
-        @delivery_properties = delivery_properties
+        @delivery_properties   = delivery_properties
+      end
+
+      # Performs validation if validates_payload_with is defined and then calls the perform method
+      # @param [Object] payload Payload of the message
+      # @param [Hash] context Context from invocation
+      def perform!(context, payload)
+        if !valid_payload?(payload)
+          HonestPubsub.logger.error("Payload validation failed for #{self.class.name}")
+          raise ::HonestPubsub::PayloadValidationError.new("Invalid Payload for #{self.class.name}")
+        end
+
+        perform(context, payload)
       end
 
-      # Need to have a real perform method for the message to be processed.
-      def perform(payload)
+      # Actual subscribers need to implement perform method. This is the method where the message is actually processed.
+      # @param [Object] payload Payload of the message
+      # @param [Hash] context Context from invocation
+      def perform(context, payload)
         raise "Need implementation for your worker."
       end
 
+      # @return [String] The original routing key with which the current message was published
       def routing_key
         delivery_routing_data[:routing_key]
       end
 
       # Iterates over all the payload validators and returns false if any of them are false
+      # @param [Object] payload The payload/arguments of the message
+      # @return [Boolen] Should return true or false value - If no validators are specified, then returns true
       def valid_payload?(payload)
         return true unless payload_validators.present?
 
         payload_validators.inject(true) { |is_valid, validator|
-          is_valid && (validator.respond_to?(:call) ? validator.call(payload) : send(validator, payload) )
+          is_valid && (validator.respond_to?(:call) ? validator.call(payload) : send(validator, payload))
         }
       end
 
@@ -78,7 +91,7 @@ module HonestPubsub
 
       def self.generated_queue_name(routing_key, queue_name)
         return queue_name if queue_name.present?
-        [ HonestPubsub::Configuration.application_name.to_s.gsub(/[^\w\_]/, ''), routing_key.gsub(".", '_') ].reject(&:blank?).join('_')
+        [HonestPubsub::Configuration.application_name.to_s.gsub(/[^\w\_]/, ''), routing_key.gsub(".", '_')].reject(&:blank?).join('_')
       end
 
     end

data/lib/honest_pubsub/version.rb

@@ -1,3 +1,3 @@
 module HonestPubsub
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/lib/honest_pubsub.rb

@@ -12,7 +12,7 @@ require "honest_pubsub/message"
 require "honest_pubsub/publisher"
 require "honest_pubsub/subscriber"
 require "honest_pubsub/version"
-require "honest_pubsub/exceptions/payload_error"
+require "honest_pubsub/exceptions/payload_validation_error"
 require 'honest_pubsub/server'
 
 if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: honest_pubsub
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
+- tech@honest.com
 - Thanh Lim
+- tusharranka@gmail.com
+- Joel Jackson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,7 +183,7 @@ dependencies:
         version: '0.15'
 description: Pub sub gem for Honest Company
 email:
-- thanh@thehonestcompany.com
+- webadmin@thehonestcompany.com
 executables:
 - start_subscribers
 extensions: []
@@ -201,7 +204,7 @@ files:
 - lib/honest_pubsub/configuration.rb
 - lib/honest_pubsub/context.rb
 - lib/honest_pubsub/db_logger.rb
-- lib/honest_pubsub/exceptions/payload_error.rb
+- lib/honest_pubsub/exceptions/payload_validation_error.rb
 - lib/honest_pubsub/logger.rb
 - lib/honest_pubsub/logging.rb
 - lib/honest_pubsub/message.rb
@@ -243,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Pub sub gem for Honest Company

data/lib/honest_pubsub/exceptions/payload_error.rb

@@ -1,2 +0,0 @@
-class PayloadError < StandardError
-end