simple_message_queue 0.0.2 → 0.0.3

data/README.md

@@ -6,12 +6,16 @@ Simple Message Queue can be used by a single application for background job proc
 
 ### Setting up Simple Message Queue
 
-In order to use Simple Message Queue in your application, you must first configure it. In order to configure Simple Message Queue, you must call a configure block and pass at least your AWS access_key_id and secret_access_key:
+In order to use Simple Message Queue in your application, you must first configure it. In order to configure Simple Message Queue, you must call a configure block and pass at least your AWS access_key_id and secret_access_key as well as the environment.
+
+The environment variable is used to name your queues. You don't want to be using the same queue in development as in production, so the environment is required, and will be appended to your queue name (e.g. test_queue_development and test_queue_production). In a rails application you can simply use Rails.env (as shown below). If you are using Sinatra or another framework, you will probably want to use ENV['RACK_ENV'], just make sure that you set ENV['RACK_ENV'] in all of your environments or SimpleMessageQueue will throw errors.
 
 ```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                      # For Rails applications
+  # config.environment = ENV['RACK_ENV']              # For non-Rails applications
 end
 ```
 
@@ -23,6 +27,7 @@ You can also pass in a few other variables to the configure block such as an idl
 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
@@ -43,18 +48,21 @@ end
 
 #### Queue Naming
 
-By default, your SQS queue will be named after the model you created (e.g. TestQueue will have a queue named test_queue). You can overwrite this in your model by adding a queue_name method to the class:
+By default, your SQS queue will be named after the model you created and appended with the environment name (e.g. TestQueue in development will have a queue named test_queue_development). You can overwrite this in your model by adding a @queue_name variable to the class:
 
 ```ruby
 class TestQueue
   extend SimpleMessageQueue
 
-  def self.queue_name
-    'my_new_queue_name'
-  end
+  @queue_name = 'super_awesome_queue'
 end
 ```
 
+This will generate a queue with the name of super_awesome_queue_development in your development environment. 
+
+**NOTE:** To prevent the same queue being used in multiple environments (which could wreak havoc with your application), the environment name is always appended to the queue_name. Although you can overwrite the queue_name method, this is a very, very bad idea (BUT if you do, please take multiple environments into account).
+
+
 #### Sending Messages
 
 In order to send a message with Simple Message Queue, simply call the following:
@@ -127,6 +135,7 @@ If you are using Simple Message Queue for background processing between sites yo
 
 **Note:** If you have multiple models receiving messages from the same queue, there is no guarantee which model will receive which message. This is why it is best to only have a single model (on a single site) receiving messages from a specific queue. If you need multiple queues, simply create multiple models with different queue_names.
 
+
 ## Contributing
 
 In order to contribute to this gem, please submit a pull request with passing tests. 

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
+    attr_accessor :access_key_id, :secret_access_key, :logger, :idle_timeout, :wait_time_seconds, :environment
 
     def initialize
       @access_key_id = nil
@@ -8,6 +8,7 @@ module SimpleMessageQueue
       @logger = nil
       @idle_timeout = 10
       @wait_time_seconds = 20
+      @environment = nil
     end
   end
 end

data/lib/simple_message_queue/errors.rb

@@ -2,7 +2,7 @@ module SimpleMessageQueue
 
   class ConfigurationError < StandardError
     def initialize
-      message = "SimpleMessageQueue has not been configured. Create an initializer with a SimpleMessageQueue.configure block and set the access_key_id and secret_access_key."
+      message = "SimpleMessageQueue has not been configured. Create an initializer with a SimpleMessageQueue.configure block and set the access_key_id, secret_access_key and environment variable."
       super(message)
     end
   end
@@ -14,4 +14,11 @@ module SimpleMessageQueue
     end
   end
 
+  class EnvironmentError < StandardError
+    def initialize
+      message = "You must define the environment in the SimpleMessageQueue.configure block. Without setting the environment the same queue will be used across environments causing unwanted results."
+      super(message)
+    end
+  end
+
 end

data/lib/simple_message_queue/version.rb

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

data/lib/simple_message_queue.rb

@@ -17,11 +17,17 @@ module SimpleMessageQueue
 
   def sqs
     raise SimpleMessageQueue::ConfigurationError unless SimpleMessageQueue.configuration
+    raise SimpleMessageQueue::EnvironmentError unless environment_defined?
     @@sqs ||= AWS::SQS.new(:access_key_id => SimpleMessageQueue.configuration.access_key_id, :secret_access_key => SimpleMessageQueue.configuration.secret_access_key)
   end
 
   def queue_name
-    name.underscore.gsub('/', '_')
+    raise SimpleMessageQueue::EnvironmentError unless environment_defined?
+    if @queue_name
+      @queue_name + "_#{SimpleMessageQueue.configuration.environment}"
+    else
+      name.underscore.gsub('/', '_') + "_#{SimpleMessageQueue.configuration.environment}"
+    end
   end
 
   def queue
@@ -70,4 +76,10 @@ module SimpleMessageQueue
     raise SimpleMessageQueue::NotImplementedError.new(name)
   end
 
+  protected
+
+    def environment_defined?
+      defined?(SimpleMessageQueue.configuration.environment)
+    end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_message_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: &70244156709540 !ruby/object:Gem::Requirement
+  requirement: &70130285737680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244156709540
+  version_requirements: *70130285737680
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70244156709120 !ruby/object:Gem::Requirement
+  requirement: &70130285736440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244156709120
+  version_requirements: *70130285736440
 description: SimpleMessageQueue is a simple interface for Amazon Web Service's SQS.
 email:
 - jim@jimsmithdesign.com