sqs-queue-locator 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sqs-queue-locator.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+end

data/README.markdown

@@ -0,0 +1,30 @@
+SQS Queue Locator
+=================
+
+Amazon SQS queue names need to be unique at the account level.                    
+This gem implements a simple naming convention of <environment>-<queue-name> to   
+allow your app to have keep track of queues per environment.                      
+                                                                                   
+For the development environment, an extra prefix is added based on your machine's 
+hostname so that multiple developers can work at the same time without stepping   
+on each others' queues.
+
+Usage
+-----
+
+in your Gemfile:
+
+    gem 'sqs-queue-locator'
+
+Somewhere in your app's initialization:
+
+    AWS.config :access_key_id => YOUR_ACCESS_KEY_ID,
+               :secret_access_key => YOUR_SECRET_ACCESS_KEY
+
+Where you need to locate the queue:
+
+    queue = SQSQueueLocator.locate :env => Rails.env,
+                                   :queue => 'your-queue-name'
+                                  
+Note: Locate will create the queue if it doesn't exist, or return a reference to
+the existing queue.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+Bundler.require :default, :development
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+  t.rspec_opts = "--color"
+end
+

data/lib/sqs-queue-locator.rb

@@ -0,0 +1,29 @@
+require "sqs-queue-locator/version"
+
+module SQSQueueLocator
+  def self.locate(options)
+    name = queue_name(options)
+    sqs = AWS::SQS.new
+    sqs.queues.create name
+  end
+
+  def self.queue_name(options)
+    if options[:env].to_s.empty?
+      raise ArgumentError, ":env option in required for QueueLocator.queue_name"
+    end
+
+    if options[:queue].to_s.empty?
+      raise ArgumentError, ":queue option in required for QueueLocator.queue_name"
+    end
+
+    "#{options[:env]}-#{options[:queue]}#{uniqifier(options[:env])}"
+  end
+
+  def self.uniqifier(env)
+    if env == "development"
+      "-#{Digest::MD5.hexdigest Socket.gethostname}"
+    else
+      ""
+    end
+  end
+end

data/lib/sqs-queue-locator/version.rb

@@ -0,0 +1,7 @@
+module Sqs
+  module Queue
+    module Locator
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/queue_locator_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe SQSQueueLocator do
+  describe "queue_name" do
+    it "concatenates environment and name" do
+      SQSQueueLocator.queue_name(
+        env: "production",
+        queue: "foo"
+      ).should == "production-foo"
+    end
+
+    it "adds something special in development env" do
+      name = SQSQueueLocator.queue_name env: "development", queue: "foo"
+      name.should =~ /\Adevelopment-foo.*/
+      name.length.should > "development-foo".length
+      name.length.should <= 80
+    end
+
+    it "uniqifies development queues consistently on this same machine" do
+      SQSQueueLocator.uniqifier("development").should ==
+        SQSQueueLocator.uniqifier("development")
+    end
+
+    it "raises error if env is omitted" do
+      -> do
+        SQSQueueLocator.queue_name env: "", queue: "foo"
+      end.should raise_error
+    end
+
+    it "raises error if queue is omitted" do
+      -> do
+        SQSQueueLocator.queue_name env: "production", queue: ""
+      end.should raise_error
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/sqs-queue-locator'

data/sqs-queue-locator.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sqs-queue-locator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sqs-queue-locator"
+  s.version     = Sqs::Queue::Locator::VERSION
+  s.authors     = ["David Vollbracht"]
+  s.email       = ["david@flipstone.com"]
+  s.homepage    = "http://github.com/flipstone/sqs-queue/locator"
+  s.summary     = %q{Implements a naming conversion for SQS queues in multiple environments}
+  s.description = <<-end_desc
+Amazon SQS queue names need to be unique at the account level.
+This gem implements a simple naming convention of <environment>-<queue-name> to
+allow your app to have keep track of queues per environment.
+
+For the development environment, an extra prefix is added based on your machine's
+hostname so that multiple developers can work at the same time without stepping
+on each others' queues.
+  end_desc
+
+  s.rubyforge_project = "sqs-queue-locator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: sqs-queue-locator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Vollbracht
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156775000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156775000
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156774420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156774420
+description: ! 'Amazon SQS queue names need to be unique at the account level.
+
+  This gem implements a simple naming convention of <environment>-<queue-name> to
+
+  allow your app to have keep track of queues per environment.
+
+
+  For the development environment, an extra prefix is added based on your machine''s
+
+  hostname so that multiple developers can work at the same time without stepping
+
+  on each others'' queues.
+
+'
+email:
+- david@flipstone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/sqs-queue-locator.rb
+- lib/sqs-queue-locator/version.rb
+- spec/queue_locator_spec.rb
+- spec/spec_helper.rb
+- sqs-queue-locator.gemspec
+homepage: http://github.com/flipstone/sqs-queue/locator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1563020620707368870
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1563020620707368870
+requirements: []
+rubyforge_project: sqs-queue-locator
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Implements a naming conversion for SQS queues in multiple environments
+test_files:
+- spec/queue_locator_spec.rb
+- spec/spec_helper.rb