lapine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a016ee7c70d98cb4610ce8e1b5e3dd53c44c2af6
+  data.tar.gz: 6ded62d3a8a567c46e2d6b0279cf9b6aa859176d
+SHA512:
+  metadata.gz: ef82948b35e732df7e47632e83c6104b4a7a50502992109b6f1e5d2c906753f98f065f010f7b7eaafdafed1377dd24205d470e3c72ed84884b2c821253257ac0
+  data.tar.gz: be30ddb171156832f84b11e9561f13db7d60de38b11b956e72beafb20a9c87a714bfd1d630cf767f6794ae20e6b1f62450d2f47f10458bec12c1bcc6c9b91276

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Saxby & Matt Camuto
+
+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,87 @@
+Lapine
+======
+
+Speak to RabbitMQ. This gem serves as a wrapper for publishing messages
+to RabbitMQ via the Bunny gem.
+
+
+## Configuration
+
+Initialization can be done inline in a daemon, or if used in Rails
+an initializer should be made at `config/initializers/lapine.rb`
+
+Register a connection. This connection should be given a name, and
+a hash of connection options that will be passed through to Bunny.
+
+```ruby
+Lapine.add_connection 'my-connection', {
+  host: 'my-rabbitmq.mine.com',
+  port: 5672,
+  user: 'rabbit',
+  password: 'meow'
+}
+```
+
+Then register an exchange.
+
+```ruby
+Lapine.add_exchange 'efrafa', 
+  durable: true, 
+  connection: 'my-connection',  # required
+  type: 'topic'              # required
+```
+
+## Usage
+
+Define a class that configures which `exchange` is uses. This class
+must define `#to_hash`
+
+```ruby
+require 'lapine'
+
+class Worker
+  include Lapine::Publisher
+  
+  exchange 'efrafa'
+  
+  def initialize(action)
+    @action = action
+  end
+  
+  def to_hash
+    {
+      'action' => @action
+    }
+  end
+end
+```
+
+This class can be used to publish messages onto its exchange:
+
+```ruby
+Worker.new('dig').publish
+```
+
+Publishing can take a routing key for topic exchanges:
+
+```ruby
+Worker.new('dig').publish('rabbits.drones')
+```
+
+Note that the `#initialize` method and the contents of `#to_hash`
+are arbitrary.
+
+
+## But... WHY
+
+* This should be dead simple, but everything else was either too
+  complex or assumed very specific configurations different from what
+  we want.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lapine/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,2 @@
+require "bundler/gem_tasks"
+

data/lapine.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lapine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lapine'
+  spec.version       = Lapine::VERSION
+  spec.authors       = ['Eric Saxby','Matt Camuto']
+  spec.email         = ['dev@wanelo.com']
+  spec.summary       = %q{Talk to rabbits}
+  spec.description   = %q{Talk to rabbits}
+  spec.homepage      = 'https://github.com/wanelo/lapine'
+  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 'bunny'
+  spec.add_dependency 'oj'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'guard-rspec', '~> 4.3.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+
+end

data/lib/lapine.rb

@@ -0,0 +1,31 @@
+require 'lapine/version'
+require 'lapine/configuration'
+require 'lapine/connection'
+
+module Lapine
+  class UndefinedConnection < StandardError; end
+  class UndefinedExchange < StandardError; end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.add_connection(name, properties)
+    config.connection_properties[name] = properties
+  end
+
+  def self.add_exchange(name, properties)
+    connection = properties[:connection]
+    raise UndefinedConnection unless connection
+    raise UndefinedConnection unless config.connection_properties[connection]
+    config.exchange_properties[name] = properties
+  end
+
+  def self.find_exchange(name)
+    exchange = config.exchange_properties[name]
+    raise UndefinedExchange unless exchange
+    return config.exchanges[name].exchange if config.exchanges[name]
+    config.exchanges[name] = Lapine::Connection.new(name, exchange)
+    config.exchanges[name].exchange
+  end
+end

data/lib/lapine/configuration.rb

@@ -0,0 +1,19 @@
+module Lapine
+  class Configuration
+    def connections
+      @connections ||= {}
+    end
+
+    def connection_properties
+      @connection_properties ||= {}
+    end
+
+    def exchanges
+      @exchanges ||= {}
+    end
+
+    def exchange_properties
+      @exchange_properties ||= {}
+    end
+  end
+end

data/lib/lapine/connection.rb

@@ -0,0 +1,26 @@
+require 'bunny'
+
+module Lapine
+  class Connection
+    attr_reader :conn, :name, :props
+
+    def initialize(name, properties)
+      @name = name
+      @props = properties.dup
+    end
+
+    def exchange
+      reconnect unless conn && conn.connected?
+      @exchange
+    end
+
+    def reconnect
+      connection_props = Lapine.config.connection_properties[props.delete(:connection)]
+      @conn = Bunny.new(connection_props)
+      conn.start
+      channel = conn.create_channel
+      exchange_type = props.delete(:type)
+      @exchange = Bunny::Exchange.new(channel, exchange_type, name, props)
+    end
+  end
+end

data/lib/lapine/publisher.rb

@@ -0,0 +1,24 @@
+require 'oj'
+
+module Lapine
+  module Publisher
+
+    def self.included(klass)
+      klass.send :extend, ClassMethods
+    end
+
+    def publish(routing_key = nil)
+      Lapine.find_exchange(self.class.instance_variable_get(:@exchange)).publish(to_json, routing_key: routing_key)
+    end
+
+    def to_json
+      ::Oj.dump(to_hash, mode: :compat)
+    end
+
+    module ClassMethods
+      def exchange(name)
+        @exchange = name
+      end
+    end
+  end
+end

data/lib/lapine/version.rb

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

data/spec/lib/lapine/publisher_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'lapine/publisher'
+
+RSpec.describe Lapine::Publisher do
+  subject(:publisher) { publisher_class.new }
+
+  let(:publisher_class) {
+    Class.new.tap do |klass|
+      klass.send :include, Lapine::Publisher
+      klass.send :exchange, exchange
+      klass.send :define_method, :to_hash do
+        {}
+      end
+    end
+  }
+  let(:exchange) { 'test_exchange' }
+  let(:fake_exchange) { double }
+
+  before do
+    allow(Lapine).to receive(:find_exchange).with(exchange).and_return(fake_exchange)
+  end
+
+  describe '#to_json' do
+    before do
+      allow(publisher).to receive(:to_hash).and_return({foo: 'bar'})
+    end
+
+    it 'turns the output of #to_hash into JSON' do
+      expect(publisher.to_json).to eq('{"foo":"bar"}')
+    end
+  end
+
+  describe '#publish' do
+    let(:json) { '{"foo": "bar"}' }
+
+    it 'publishes data with routing key' do
+      expect(publisher).to receive(:to_json).and_return(json)
+      expect(fake_exchange).to receive(:publish).with(json, routing_key: 'thing.stuff')
+      publisher.publish('thing.stuff')
+    end
+  end
+end

data/spec/lib/lapine_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+require 'lapine'
+
+RSpec.describe Lapine do
+  let(:connection) { double('connection') }
+  let(:connection_properties) do
+    {
+      host: 'someplace.com'
+    }
+  end
+
+  let(:config) { Lapine::Configuration.new }
+
+  before do
+    Lapine.instance_variable_set(:@config, config)
+  end
+
+  describe '.add_connection' do
+    it 'saves the connection information' do
+      Lapine.add_connection 'my-connection', connection_properties
+      expect(config.connection_properties['my-connection']).to eq(connection_properties)
+    end
+  end
+
+  describe '.add_exchange' do
+    context 'when connection has been defined' do
+      before do
+        config.connection_properties['my-connection'] = {}
+      end
+
+      it 'saves the exchange information' do
+        Lapine.add_exchange 'my-exchange', durable: false, connection: 'my-connection'
+        expect(config.exchange_properties['my-exchange']).to eq({
+          durable: false,
+          connection: 'my-connection'
+        })
+      end
+    end
+
+    context 'when connection has not been defined' do
+      it 'raises' do
+        expect {
+          Lapine.add_exchange 'my-exchange', durable: false, connection: 'my-connection'
+        }.to raise_error(Lapine::UndefinedConnection)
+      end
+    end
+  end
+
+  describe '.find_exchange' do
+    before do
+      allow(Bunny).to receive(:new).and_return(connection)
+    end
+
+    context 'when exchange has not been registered' do
+      it 'raises' do
+        expect {
+          Lapine.find_exchange 'non-existent-exchange'
+        }.to raise_error(Lapine::UndefinedExchange)
+      end
+    end
+
+    context 'when exchange has been registered' do
+      let(:channel) { double('channel') }
+      let(:exchange) { double('exchange') }
+
+      before do
+        allow(connection).to receive(:start)
+        allow(connection).to receive(:create_channel).and_return(channel)
+        allow(Bunny::Exchange).to receive(:new).and_return(exchange)
+        config.exchange_properties['my-exchange'] = {connection: 'my-connection', type: :thing, some: 'exchange-property'}
+      end
+
+      context 'when exchanges has not been created' do
+        before do
+          allow(connection).to receive(:connected?).and_return(true)
+        end
+
+        it 'returns an exchange' do
+          expect(Lapine.find_exchange('my-exchange')).to eq(exchange)
+        end
+
+        it 'creates the exchange with its configured properties' do
+          Lapine.find_exchange('my-exchange')
+          expect(Bunny::Exchange).to have_received(:new).with(channel, :thing, 'my-exchange', some: 'exchange-property')
+        end
+
+        it 'starts a connection and creates a channel' do
+          Lapine.find_exchange('my-exchange')
+          expect(connection).to have_received(:start)
+          expect(connection).to have_received(:create_channel)
+        end
+
+        it 'only creates exchange once' do
+          Lapine.find_exchange('my-exchange')
+          Lapine.find_exchange('my-exchange')
+          expect(connection).to have_received(:start).once
+          expect(connection).to have_received(:create_channel).once
+        end
+      end
+
+      context 'with a created exchange' do
+        context 'that is closed' do
+          it 'establishes a new connection and exchange' do
+            Lapine.find_exchange('my-exchange')
+            allow(connection).to receive(:connected?).and_return(false)
+            Lapine.find_exchange('my-exchange')
+            expect(connection).to have_received(:start).twice
+            expect(connection).to have_received(:create_channel).twice
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'lapine'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  config.order = :random # use --seed NNNN
+  Kernel.srand config.seed
+
+  config.before :each do
+    Lapine.instance_variable_set(:@config, nil)
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: lapine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Saxby
+- Matt Camuto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  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: oj
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Talk to rabbits
+email:
+- dev@wanelo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lapine.gemspec
+- lib/lapine.rb
+- lib/lapine/configuration.rb
+- lib/lapine/connection.rb
+- lib/lapine/publisher.rb
+- lib/lapine/version.rb
+- spec/lib/lapine/publisher_spec.rb
+- spec/lib/lapine_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wanelo/lapine
+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: Talk to rabbits
+test_files:
+- spec/lib/lapine/publisher_spec.rb
+- spec/lib/lapine_spec.rb
+- spec/spec_helper.rb
+has_rdoc: