simple_messaging 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c42f9f5b324c4fa8978193e856ad49b8fcf62681
+  data.tar.gz: b5b1aab8dc6ebe074f6ca8b28115488ba9042f0f
+SHA512:
+  metadata.gz: a2d3a05c535d6b5fb38aac16760f9ecbfe81e9df80817772977a239d37f92b68e4ee5f2fb7aac8f23c0822379adf76c61aafa7d76cf4a36b9e876b263225c24d
+  data.tar.gz: 16f9802ce4e7b93fa12b555f4e25d9827d27947e58b23d5ab86927d8514ee70180967aba7b51329e9248578c457958acedafbfa4718e2768ec26a509a1f8c499

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+config

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple-messaging.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Maxime Santerre
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# SimpleMessaging
+
+Simple messaging abstracts your messaging needs so you can easily switch between
+supported drivers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple-messaging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-messaging
+
+## Usage
+
+Set the driver name manually
+```ruby
+  SimpleMessaging::MessageQueue.driver_name = "sqs"
+```
+
+or set it in your config/messaging.yml file
+
+```ruby
+  instance = SimpleMessaging::MessageQueue.instance(queue_name)
+  instance.enqueue(message)
+  instance.poll do |message|
+    p message
+  end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple-messaging/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/simple_messaging.rb

@@ -0,0 +1,7 @@
+require 'simple_messaging/message_queue'
+require 'simple_messaging/message_queue/rabbit'
+require 'simple_messaging/message_queue/sqs'
+
+module SimpleMessaging
+
+end

data/lib/simple_messaging/message_queue.rb

@@ -0,0 +1,65 @@
+module SimpleMessaging
+  class MessageQueue
+
+    # Deriving classes need to implement the following methods
+    # def enqueue(message)
+    # def poll(&block)
+    # def pop(&block)
+
+    def self.unregister_queue(name)
+      @queues[name] = nil
+    end
+
+    def self.driver_name=(driver_name)
+      if driver_name != @driver_name
+        @driver_class = nil
+        @queues = nil
+        @driver_name = driver_name.to_s
+      end
+    end
+
+    def self.instance(name)
+      @queues ||= {}
+      return @queues[name] if @queues[name]
+
+      @driver_class ||=
+        case driver_name
+        when 'sqs'
+          MessageQueue::SQS
+        when 'rabbit'
+          MessageQueue::Rabbit
+        else
+          raise 'Messaging driver "#{driver_name}" not implemented'
+        end
+
+      @queues[name] = @driver_class.new(name)
+    end
+
+    def self.driver_name
+      return @driver_name if @driver_name
+      messaging_config_file = Pathname.new(Dir.pwd).join('config', 'messaging.yml').to_s
+
+      if File.exist? messaging_config_file
+        messaging_configs = YAML.load(File.open(messaging_config_file).read)
+        messaging_configs[environment]['driver']
+      else
+        raise "Messaging driver isn't set"
+      end
+    end
+
+    protected
+
+    def environment
+      if defined? Rails
+        Rails.env
+      else
+        ENV["RUBY_ENV"] || "development"
+      end
+    end
+
+    def queue_name(name)
+      "#{queue_identifier}-#{name}"
+    end
+
+  end
+end

data/lib/simple_messaging/message_queue/rabbit.rb

@@ -0,0 +1,67 @@
+require 'amqp'
+
+module SimpleMessaging
+
+  class MessageQueue::Rabbit < MessageQueue
+
+  attr_reader :channel, :queue, :channel, :name
+
+  def initialize(name)
+    @@em_thread  ||= Thread.new { EventMachine.run }
+    @@connection ||= AMQP.connect(rabbit_configs)
+    @channel       = AMQP::Channel.new(@@connection)
+    @exchange      = @channel.default_exchange
+    @queue         = @channel.queue(queue_name(name))
+    @name          = name
+  end
+
+  def enqueue(message)
+    @exchange.publish message,
+      :routing_key => @queue.name,
+      :app_id => app_id
+  end
+
+  def poll(&block)
+    @queue.subscribe do |metadata, payload|
+      yield payload
+    end
+  end
+
+  def pop(&block)
+    @queue.subscribe do |metadata, payload|
+      yield payload
+      break
+    end
+  end
+
+  def delete
+    MessageQueue.unregister_queue(name)
+    @queue.delete
+  end
+
+  private
+
+  def queue_identifier
+    environment
+  end
+
+  def rabbit_configs
+    rabbit_config_file = Pathname.new(Dir.pwd).join('config', 'rabbit.yml').to_s
+    if File.exist? rabbit_config_file
+      YAML.load(File.open(rabbit_config_file).read)[environment]
+    else
+      { host: "127.0.0.1" }
+    end
+  end
+
+  def app_id
+    if defined? Rails
+      Rails.application.class.parent.to_s
+    else
+      "unknown"
+    end
+  end
+
+  end
+
+end

data/lib/simple_messaging/message_queue/sqs.rb

@@ -0,0 +1,50 @@
+require 'aws-sdk'
+
+module SimpleMessaging
+
+  class MessageQueue::SQS < MessageQueue
+
+    attr_reader :name
+
+    def initialize(name)
+      @sqs = AWS::SQS.new
+      @queue = @sqs.queues.create(queue_name(name))
+      @name = name
+    end
+
+    def enqueue(message)
+      @queue.send_message(message)
+    end
+
+    def pop(&block)
+      @queue.receive_message do |message|
+        yield message.body
+      end
+    end
+
+    def poll(&block)
+      @queue.poll do |message|
+        yield message.body
+      end
+    end
+
+    def delete
+      MessageQueue.unregister_queue(name)
+      @queue.delete
+    end
+
+    private
+
+    def queue_identifier
+      case environment
+      when "development"
+        prefix = (ENV["SQS_IDENTIFIER"] || `whoami`).strip
+        "#{prefix}-development"
+      else
+        environment
+      end
+    end
+
+  end
+
+end

data/lib/simple_messaging/version.rb

@@ -0,0 +1,3 @@
+module SimpleMessaging
+ VERSION = '0.0.1'
+end

data/simple_messaging.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_messaging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_messaging"
+  spec.version       = SimpleMessaging::VERSION
+  spec.authors       = ["Maxime Santerre"]
+  spec.email         = ["mooxeh@gmail.com"]
+  spec.summary       = %q{Abstraction layer for simple messaging operations}
+  spec.description   = """Lets you easily change messaging adapters for simple queue and poll operations"""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "amqp"
+  spec.add_dependency "aws-sdk"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/message_queue_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+RSpec.describe SimpleMessaging::MessageQueue, 'loads appropriate driver' do
+
+  context 'Using SQS driver' do
+
+    before(:each) do
+      SimpleMessaging::MessageQueue.driver_name = "sqs"
+      @queue = SimpleMessaging::MessageQueue.instance("test-queue")
+    end
+
+    it 'should load' do
+      expect(@queue.class.name.to_s).to eq "SimpleMessaging::MessageQueue::SQS"
+    end
+
+    it 'should publish messages' do
+      @queue.enqueue("Message")
+      @queue.pop do |message|
+        expect(message).to eq "Message"
+        expect(message).not_to eq "Potato"
+      end
+    end
+  end
+
+  context 'Using the RabbitMQ driver' do
+
+    before(:each) do
+      SimpleMessaging::MessageQueue.driver_name = "rabbit"
+      @queue = SimpleMessaging::MessageQueue.instance("test-queue")
+    end
+
+    it 'should load the rabbitmq driver' do
+      expect(@queue.class.name.to_s).to eq "SimpleMessaging::MessageQueue::Rabbit"
+    end
+
+    it 'should publish and receive messages' do
+      @queue.enqueue("Potato")
+      @queue.pop do |message|
+        expect(message).to eq "Message"
+        expect(message).not_to eq "Potato"
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'simple_messaging'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: simple_messaging
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maxime Santerre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amqp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lets you easily change messaging adapters for simple queue and poll operations
+email:
+- mooxeh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_messaging.rb
+- lib/simple_messaging/message_queue.rb
+- lib/simple_messaging/message_queue/rabbit.rb
+- lib/simple_messaging/message_queue/sqs.rb
+- lib/simple_messaging/version.rb
+- simple_messaging.gemspec
+- spec/message_queue_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Abstraction layer for simple messaging operations
+test_files:
+- spec/message_queue_spec.rb
+- spec/spec_helper.rb