simple_message_queue 0.0.3 → 0.0.4

data/README.md

@@ -25,12 +25,14 @@ You can also pass in a few other variables to the configure block such as an idl
 
 ```ruby
 SimpleMessageQueue.configure do |config|
-  config.access_key_id = 'your_access_key_id'
-  config.secret_access_key= 'your_secret_access_key'
-  config.environment = Rails.env
-  config.idle_timeout = 10                                  # optional
-  config.wait_time_seconds = 20                             # optional
-  config.logger = Logger.new('simple_message_queue.log')    # optional
+  config.access_key_id = 'your_access_key_id'               # String                                              (required)
+  config.secret_access_key= 'your_secret_access_key'        # String                                              (required)
+  config.environment = Rails.env                            # String                                              (required)
+  config.idle_timeout = 10                                  # Integer                                             (optional)
+  config.wait_time_seconds = 20                             # Integer                                             (optional)
+  config.logger = Logger.new('simple_message_queue.log')    # Logger                                              (optional)
+  config.sns_notifications = true                           # Boolean                                             (optional)
+  config.sns_notification_prefix = 'my_prefix'              # String (alphanumeric, hyphen and underscore only)   (optional)
 end
 ```
 
@@ -54,7 +56,7 @@ By default, your SQS queue will be named after the model you created and appende
 class TestQueue
   extend SimpleMessageQueue
 
-  @queue_name = 'super_awesome_queue'
+  @queue_name = 'super_awesome_queue'                       # String (alphanumeric, hyphen and underscore only)   (optional)
 end
 ```
 
@@ -125,6 +127,26 @@ This is the default [name]_daemon.rb file generated, with out code placed in the
 
 **NOTE:** You will want to monitor these daemons and have something to restart them if they stop. Something like God (http://godrb.com/) or Monit (http://mmonit.com/monit/) will work nicely.
 
+### SNS Notifications
+
+Simple Message Queue allows you to send notifications via Amazon's SNS. Notifications will be sent when your queue fails to send a message.
+
+In order to set up notifications, add sns_notifications = true to your config. If you would like to prefix your queues with a name, add sns_notification_prefix = 'prefix'.
+
+```ruby
+SimpleMessageQueue.configure do |config|
+  ...
+  config.sns_notifications = true
+  config.sns_notification_prefix = 'my_prefix'
+end
+```
+
+After the configure block is parsed (usually during initialization), the SNS Topics are automatically created, allowing you to subscribe to those topics before a message is ever sent. 
+
+**Note:** Although the SNS Topics are created automatically, and messages will be sent to those topics, you will not receive any notifications until you create subscriptions to those topics. After your topics have been created, log into your AWS account and navigate to the SNS page. For each topic here, you will need to create at least one subscription in order to receive notifications.
+
+**Note:** SNS Topics are created for each environment (similar to the queues). You will need to subscribe to the topics after each environment is initialized in order to make sure you receive messages for each environment. You can also set up different subscriptions for each environment (e.g. maybe you only want to receive email notifications in development, but would like to receive email and SMS in production).
+
 ### Single Site Communication
 
 If you are using Simple Message Queue for background processing on a single site, all you need to do is create your model and extend SimpleMessageQueue. You will then be able to call the send and receive methods on that model.

data/lib/simple_message_queue/configuration.rb

@@ -1,6 +1,6 @@
 module SimpleMessageQueue
   class Configuration
-    attr_accessor :access_key_id, :secret_access_key, :logger, :idle_timeout, :wait_time_seconds, :environment
+    attr_accessor :access_key_id, :secret_access_key, :logger, :idle_timeout, :wait_time_seconds, :environment, :sns_notifications, :sns_notification_prefix
 
     def initialize
       @access_key_id = nil
@@ -9,6 +9,8 @@ module SimpleMessageQueue
       @idle_timeout = 10
       @wait_time_seconds = 20
       @environment = nil
+      @sns_notifications = false
+      @sns_notification_prefix = nil
     end
   end
 end

data/lib/simple_message_queue/notification.rb

@@ -0,0 +1,72 @@
+module SimpleMessageQueue
+  class Notification
+
+    class << self
+      
+      def sns
+        raise SimpleMessageQueue::ConfigurationError unless SimpleMessageQueue.configuration
+        raise SimpleMessageQueue::EnvironmentError unless defined?(SimpleMessageQueue.configuration.environment)
+        @@sns ||= AWS::SNS.new(:access_key_id => SimpleMessageQueue.configuration.access_key_id, :secret_access_key => SimpleMessageQueue.configuration.secret_access_key)
+      end
+
+    end
+
+    class Topic
+
+      attr_reader :sns_topic
+
+      class << self
+        def find(name)
+          topic_name = topic_name(name)
+          sns_topic = SimpleMessageQueue::Notification.sns.topics.find { |t| t.name == topic_name }
+          topic = (sns_topic) ? Topic.new(sns_topic.name, false) : nil
+        end
+
+        def find_by_full_name(full_name)
+          sns_topic = SimpleMessageQueue::Notification.sns.topics.find { |t| t.name == full_name }
+          topic = (sns_topic) ? Topic.new(sns_topic.name, false) : nil
+        end
+
+        def topic_name(name)
+          if defined?(SimpleMessageQueue.configuration.sns_notification_prefix) && !SimpleMessageQueue.configuration.sns_notification_prefix.nil?
+            topic_name = "#{SimpleMessageQueue.configuration.sns_notification_prefix}_#{name}_#{SimpleMessageQueue.configuration.environment}"
+          else
+            topic_name = "#{name}_#{SimpleMessageQueue.configuration.environment}"
+          end
+          topic_name
+        end
+      end
+
+      def sns
+        SimpleMessageQueue::Notification.sns
+      end
+
+      def initialize(name, generate_topic_name=true)
+        raise SimpleMessageQueue::ConfigurationError unless SimpleMessageQueue.configuration
+        raise SimpleMessageQueue::EnvironmentError unless defined?(SimpleMessageQueue.configuration.environment)
+
+        topic_name = (generate_topic_name) ? self.class.topic_name(name) : name
+        @sns_topic = sns.topics.create(topic_name)
+      end
+
+      def name
+        @sns_topic.name
+      end
+
+      def send(message, subject=nil)
+        message_hash = {
+          topic_arn: @sns_topic.arn,
+          message: message
+        }
+        message_hash[:subject] = subject if subject
+        sns.client.publish(message_hash)
+      end
+
+      def delete
+        @sns_topic.delete
+      end
+
+    end
+
+  end
+end

data/lib/simple_message_queue/version.rb

@@ -1,3 +1,3 @@
 module SimpleMessageQueue
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/simple_message_queue.rb

@@ -1,6 +1,7 @@
 require 'simple_message_queue/configuration'
 require 'simple_message_queue/core_ext/string'
 require 'simple_message_queue/errors'
+require 'simple_message_queue/notification'
 require 'aws'
 
 module SimpleMessageQueue
@@ -11,6 +12,14 @@ module SimpleMessageQueue
     def configure
       self.configuration ||= Configuration.new
       yield(configuration)
+
+      if self.configuration.sns_notifications
+        topics = ['send_message_failure']
+        topics.each do |topic|
+          SimpleMessageQueue::Notification::Topic.new(topic)
+        end
+      end
+
     end
 
   end
@@ -51,12 +60,21 @@ module SimpleMessageQueue
   end
 
   def send(message)
-    queue.send_message(message)
+    begin
+      queue.send_message(message)
+    rescue
+      logger.error "There was an error when sending an item to #{queue_name} at #{DateTime.now}."
+
+      if defined?(SimpleMessageQueue.configuration.sns_notifications) && SimpleMessageQueue.configuration.sns_notifications == true
+        topic = SimpleMessageQueue::Notification::Topic.new('send_message_failure')
+        topic.send("There was an error when sending an item to #{queue_name} at #{DateTime.now}.", "SimpleMessageQueue: Send Message Failure")
+      end
+    end
   end
 
   def logger
     if SimpleMessageQueue.configuration.logger
-      @logger ||= SimpleMessageQueue.configuration.logger
+      @logger = SimpleMessageQueue.configuration.logger
     else
       @logger ||= Logger.new(STDOUT)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_message_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: &70130285737680 !ruby/object:Gem::Requirement
+  requirement: &70212523769780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70130285737680
+  version_requirements: *70212523769780
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70130285736440 !ruby/object:Gem::Requirement
+  requirement: &70212523769360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70130285736440
+  version_requirements: *70212523769360
 description: SimpleMessageQueue is a simple interface for Amazon Web Service's SQS.
 email:
 - jim@jimsmithdesign.com
@@ -45,6 +45,7 @@ files:
 - lib/simple_message_queue/configuration.rb
 - lib/simple_message_queue/core_ext/string.rb
 - lib/simple_message_queue/errors.rb
+- lib/simple_message_queue/notification.rb
 - lib/simple_message_queue/version.rb
 - lib/simple_message_queue.rb
 - README.md