pika_q 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 951a4d2ae70a0d126742d38e474ff382657c351e
+  data.tar.gz: 819074c2a632ef1081a64d1237820ce064a38baf
+SHA512:
+  metadata.gz: c62c0a7c4d95a439bac2efd04135a67fde5e81621594fc50c4870b4b0a4ad2e16739eec4413f2d6d6c201055c8a1a75018e326577280c8892d3b83092f53a2e1
+  data.tar.gz: 3cd6a7c6b89afce072deafa1a42981d89c0fb2b7aa58fc1622d516a0ec699f47c4f3f9b9abbc89c39987c923526afc6a78584b51a31fd5fcd153665eaf5b9a28

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6
+services:
+  - rabbitmq

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :rake do
+  gem 'bundler'
+end
+
+group :rake do
+  gem 'rake'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'minitest-spec-context'
+  gem 'minitest-reporters', require: 'minitest/reporters'
+end
+
+group :development do
+  gem 'gem-release', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eric Marden
+
+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,118 @@
+# pika_q
+[![Build Status](https://travis-ci.org/xentek/pika_q.svg)](https://travis-ci.org/xentek/pika_q)
+
+---
+
+![PikaQ, I choose you!](http://xentek-images.s3.amazonaws.com/pikachu-and-ash.png "PikaQ, I choose you!")
+
+#### __PikaQ, I choose YOU!__
+
+PikaQ makes working with Rabbit MQ _even_ easier. It provides a thin layer around [Bunny](http://rubybunny.info), the defacto standard ruby library for Rabbit MQ. It provides objects for writing your own high performance, message consumers, as well a generic service object for publishing messages to any Rabbit MQ exchange.
+
+> The name "pika" is used for any member of the Ochotonidae, a family within the order of lagomorphs, which also includes the Leporidae (rabbits and hares).
+> __-- [Wikipedia](https://en.wikipedia.org/wiki/Pika)__
+
+---
+
+### Gemfile
+
+    gem 'pika_q'
+
+## Require
+
+    require 'pika_q'
+
+## Usage
+
+### Creating a connection
+
+```ruby
+connection = PikaQ::Connection.new
+channel = connection.channel
+```
+
+By default, it uses the value of `ENV['RABBITMQ_URL']` as the connection string, which if `nil`, will fallback to Bunny's default connection string (i.e. `ampq://guest:guest@localhost:5672'`). You can also supply a connection string when initalizing `PikaQ::Connection`.
+
+### Publishing a message
+
+This sends a message to the default exchange:
+
+```ruby
+channel = PikaQ::Connection.new.channel
+publisher = PikaQ::Publisher.new(channel, '', :default)
+
+# publish a message to the exchange
+publisher.send_message('{"test":"ok"}')
+```
+
+`PikaQ::Publisher.new` takes the same arguments as [`Bunny::Exchange.new`](http://reference.rubybunny.info/Bunny/Exchange.html#initialize-instance_method).
+
+### Establishing an Exchange
+
+Establish the default exchange:
+
+```ruby
+channel = PikaQ::Connection.new.channel
+exchange = PikaQ::Exchanges::Default.establish(channel)
+```
+
+__The default exchange is special and can't be removed -- it's built into the Rabbit MQ server.__
+
+To establish other types of exchanges, you need to create an object that responds to `establish` and takes a `channel` as an argument. The easiest way to do this is to subclass `PikaQ::Exchanges::Base` and overwrite the `establish` method.
+
+`PikaQ::Exchanges::Base.establish` provides a default implementation that returns a `:direct` exchange. The name is created automatically by `PikaQ::Exchanges::Base.generated_exchange_name`, which will return a string based on the name of your class and the value of `ENV['RUBY_ENV']`, e.g. `pikaq.exchanges.base.development`.
+
+### Creating a Queue
+
+```ruby
+channel = PikaQ::Connection.new.channel
+queue = PikaQ::Queues::Base.create(channel, { durable: false, auto_delete: false, exclusive: false })
+```
+
+Your consumer will bind your queues to exhcnages. Create subclasses only for the sake of identity (helpful if the queue throws an exception). `PikaQ::Queues::Base.create` is a factory method that returns an instance of `Bunny::Queue`. Like exchanges, the `PikaQ::Queues::Base.generated_queue_name` method will generate a queue name for you based on the name of your subclass, e.g. `pikaq.queues.base.development`.
+
+### Creating a Consumer
+
+Create and configure a consumer subclass:
+
+```ruby
+class MyConsumer < PikaQ::Consumers::Base
+      config queue:       PikaQ::Queues::Default,
+             exchange:     PikaQ::Exchanges::Default,
+             consumer_tag: default_consumer_tag('abcd-1234-efgh-5678'),
+             routing_key:  'test.routing.key'
+end
+```
+
+Pass the name of your `queue` and `exchange` clases. You can use any string for the optional `consumer_tag`, but it must be unique. It's recommended to use the `default_consumer_tag` method, which will generate a new UUID for you if you don't supply an argument. The routing key is also optional, and only required by some types of exchanges.
+
+Now you're ready to make it do some actual work when it recieves a message. I prefer to create an executable shellscript for these but you can run them however you like. Just know that a consumer is a essentially a daemon and will keep running until it's stopped. Use `foreman` to manaage these and export them to upstart, etc for use in production.
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'pika/mq'
+require 'my_consumer'
+channel = PikaQ::Connection.new.channel
+channel.prefetch(20) # this will affect your throughput, so expiriment with what's right for your environment.
+Log = Logger.new(STDOUT)
+
+MyConsumer.start do |delivery_info, properties, payload|
+  Log.info(delivery_info)
+  Log.info(properties)
+  Log.info(payload)
+end
+
+channel.close # this will run when the consumer is stopped
+```
+
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [xentek/pika_q](https://github.com/xentek/pika_q). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+# environment
+ENV['RUBY_ENV'] ||= 'development'
+ENV['RABBITMQ_URL'] = 'amqp://guest:guest@127.0.0.1:5672'
+
+# load path
+lib_path = File.expand_path('../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+# tasks
+task :default => [:test]

data/lib/pika_q/connection.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module PikaQ
+  class Connection
+    attr_reader :channel, :rabbitmq_url, :session
+
+    def initialize(rabbitmq_url = ENV['RABBITMQ_URL'])
+      @session = Bunny.new(rabbitmq_url)
+      @session.start
+      @channel = @session.create_channel
+    end
+  end
+end

data/lib/pika_q/consumers/base.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module PikaQ
+  module Consumers
+    class Base
+      class << self
+        attr_reader :consumer, :consumer_tag, :exchange, :routing_key, :queue
+      end
+
+      def self.config(options = {})
+        options ||= {} if options.nil?
+        options = default_config.merge(options)
+        @consumer_tag = options.fetch(:consumer_tag)
+        @exchange = options.fetch(:exchange)
+        @routing_key = options.fetch(:routing_key)
+        @queue = options.fetch(:queue)
+      end
+
+      def self.start(channel, &block)
+        @exchange = exchange.establish(channel) if exchange.respond_to? :establish
+        @queue = queue.create(channel) if queue.respond_to? :create
+
+        unless exchange.predeclared?
+          queue.bind(exchange, { routing_key: routing_key })
+        end
+
+        @consumer = queue.subscribe(manual_ack: true,
+                                  block: true,
+                                  consumer_tag: consumer_tag,
+                                  &Proc.new)
+        consumer
+      rescue Interrupt
+        consumer.cancel
+        consumer.channel.close
+      end
+
+      private
+
+      def self.default_consumer_tag(unique_id = SecureRandom.uuid)
+        "#{self.to_s.gsub('::','.')}.#{ENV['RUBY_ENV']}.#{unique_id}".downcase
+      end
+
+      def self.default_config
+        {
+          consumer_tag: default_consumer_tag,
+          exchange: PikaQ::Exchanges::Default,
+          routing_key: nil,
+          queue: ''
+        }.freeze
+      end
+    end
+  end
+end

data/lib/pika_q/exchanges/base.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module PikaQ
+  module Exchanges
+    class Base < Bunny::Exchange
+      def self.establish(channel)
+        new(channel, :direct, generated_exchange_name, auto_delete: false, durable: false)
+      end
+
+      def self.generated_exchange_name
+        "#{self.to_s.gsub('::','.')}.#{ENV['RUBY_ENV']}".downcase
+      end
+    end
+  end
+end

data/lib/pika_q/exchanges/default.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module PikaQ
+  module Exchanges
+    class Default < Base
+      def self.establish(channel)
+        channel.default_exchange
+      end
+    end
+  end
+end

data/lib/pika_q/publisher.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'bunny'
+
+module PikaQ
+  class Publisher
+    attr_reader :channel, :exchange, :exchange_name, :exchange_type, :exchange_options
+
+    def initialize(channel, exchange_name, exchange_type = :default, exchange_options = { durable: false, auto_delete: false })
+      @channel = channel
+      @exchange_name = exchange_name
+      @exchange_type = exchange_type
+      @exchange_options = exchange_options
+      @exchange = connect_to_exchange
+    end
+
+    def send_message(payload, message_options = {})
+      message_options ||= {}
+      message_options = default_message_options.merge(message_options)
+      published = exchange.publish(payload, message_options)
+      channel.close
+      published
+    end
+
+    private
+
+    def default_message_options
+      {
+        content_type: 'application/json',
+        message_id: SecureRandom.uuid,
+        persistent: false,
+        routing_key: nil,
+        timestamp: DateTime.now.to_time.to_i
+      }
+    end
+
+    def connect_to_exchange
+      if exchange_type == :default
+        channel.default_exchange
+      else
+        ::Bunny::Exchange.new(channel, exchange_type, exchange_name, exchange_options)
+      end
+    end
+  end
+end

data/lib/pika_q/queues/base.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module PikaQ
+  module Queues
+    class Base < Bunny::Queue
+      def self.create(channel, options = { durable: false, auto_delete: false, exclusive: false })
+        new(channel, generated_queue_name, options)
+      end
+
+      def self.generated_queue_name
+        "#{self.to_s.gsub('::','.')}.#{ENV['RUBY_ENV']}".downcase
+      end
+    end
+  end
+end

data/lib/pika_q/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module PikaQ
+  VERSION = "1.0.0"
+end

data/lib/pika_q.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+# dependencies
+require 'securerandom'
+require 'bunny'
+
+# mq
+require 'pika_q/connection'
+require 'pika_q/publisher'
+require 'pika_q/exchanges/base'
+require 'pika_q/exchanges/default'
+require 'pika_q/queues/base'
+require 'pika_q/consumers/base'
+require 'pika_q/version'

data/pika_q.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pika_q/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pika_q"
+  gem.version       = PikaQ::VERSION
+  gem.authors       = ["Eric Marden"]
+  gem.email         = ["eric.marden@gmail.com"]
+  gem.summary       = %q{PikaQ makes working with Rabbit MQ easier.}
+  gem.description   = %q{PikaQ makes working with Rabbit MQ easier.  It provides a thin layer around Bunny, the defacto standard ruby library for Rabbit MQ.}
+  gem.homepage      = "http://github.com/xentek/pika_q"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'bunny'
+end

data/spec/pika_q/connection_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe PikaQ::Connection do
+  let(:connection) { PikaQ::Connection.new }
+
+  it 'has a session' do
+    connection.session.must_be_kind_of Bunny::Session
+  end
+
+  it 'has a channel' do
+    connection.channel.must_be_kind_of Bunny::Channel
+  end
+end

data/spec/pika_q/consumers/base_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe PikaQ::Consumers::Base do
+  before do
+    class TestConsumer < PikaQ::Consumers::Base
+      config queue: PikaQ::Queues::Base,
+             exchange: PikaQ::Exchanges::Default,
+             consumer_tag: default_consumer_tag('2d931510-d99f-494a-8c67-87feb05e1594'),
+             routing_key: 'test.routing.key'
+    end
+  end
+
+  it 'has a queue' do
+    TestConsumer.queue.must_equal PikaQ::Queues::Base
+  end
+
+  it 'has an exchange' do
+    TestConsumer.exchange.must_equal PikaQ::Exchanges::Default
+  end
+
+  it 'has a consumer tag' do
+    TestConsumer.consumer_tag.must_equal 'testconsumer.test.2d931510-d99f-494a-8c67-87feb05e1594'
+  end
+
+  it 'has a routing key' do
+    TestConsumer.routing_key.must_equal 'test.routing.key'
+  end
+end

data/spec/pika_q/exchanges/base_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe PikaQ::Exchanges::Base do
+  it 'can establish the default exchange' do
+    PikaQ::Exchanges::Base.establish(PikaQ::Connection.new.channel).must_be_kind_of ::Bunny::Exchange
+  end
+
+  it 'can generate the exchange name' do
+    PikaQ::Exchanges::Base.generated_exchange_name.must_equal 'pikaq.exchanges.base.test'
+  end
+end

data/spec/pika_q/exchanges/default_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe PikaQ::Exchanges::Default do
+  it 'can establish the default exchange' do
+    PikaQ::Exchanges::Default.establish(PikaQ::Connection.new.channel).must_be_kind_of ::Bunny::Exchange
+  end
+end

data/spec/pika_q/publisher_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe PikaQ::Publisher do
+  let(:publisher) { PikaQ::Publisher.new(PikaQ::Connection.new.channel, '', :default) }
+
+  it "has a channel" do
+    publisher.channel.must_be_kind_of ::Bunny::Channel
+  end
+
+  it "has an exchange name" do
+    publisher.exchange_name.must_equal ''
+  end
+
+  it "has an exchange type" do
+    publisher.exchange_type.must_equal :default
+  end
+
+  it "has an exchange" do
+    publisher.exchange.must_be_kind_of ::Bunny::Exchange
+  end
+
+  it "can publish a message" do
+    publisher.send_message('{"test":"ok"}').must_be_kind_of ::Bunny::Exchange
+  end
+end

data/spec/pika_q/queues/base_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe PikaQ::Queues::Base do
+  it 'can create the default queue' do
+    PikaQ::Queues::Base.new(PikaQ::Connection.new.channel).must_be_kind_of ::Bunny::Queue
+  end
+
+  it 'can generate a queue name' do
+    PikaQ::Queues::Base.generated_queue_name.must_equal 'pikaq.queues.base.test'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+ENV['RUBY_ENV'] = 'test'
+ENV['RABBITMQ_URL'] ||= 'amqp://guest:guest@127.0.0.1:5672'
+lib_path = File.expand_path('../../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+Bundler.require(:default, ENV['RUBY_ENV'])
+require 'minitest-spec-context'
+require 'minitest/autorun'
+MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: pika_q
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Marden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 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'
+description: PikaQ makes working with Rabbit MQ easier.  It provides a thin layer
+  around Bunny, the defacto standard ruby library for Rabbit MQ.
+email:
+- eric.marden@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pika_q.rb
+- lib/pika_q/connection.rb
+- lib/pika_q/consumers/base.rb
+- lib/pika_q/exchanges/base.rb
+- lib/pika_q/exchanges/default.rb
+- lib/pika_q/publisher.rb
+- lib/pika_q/queues/base.rb
+- lib/pika_q/version.rb
+- pika_q.gemspec
+- spec/pika_q/connection_spec.rb
+- spec/pika_q/consumers/base_spec.rb
+- spec/pika_q/exchanges/base_spec.rb
+- spec/pika_q/exchanges/default_spec.rb
+- spec/pika_q/publisher_spec.rb
+- spec/pika_q/queues/base_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/xentek/pika_q
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: PikaQ makes working with Rabbit MQ easier.
+test_files:
+- spec/pika_q/connection_spec.rb
+- spec/pika_q/consumers/base_spec.rb
+- spec/pika_q/exchanges/base_spec.rb
+- spec/pika_q/exchanges/default_spec.rb
+- spec/pika_q/publisher_spec.rb
+- spec/pika_q/queues/base_spec.rb
+- spec/spec_helper.rb