queue_worker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61ad138526af7bb4db5046afd0ef36ba115039b6
+  data.tar.gz: bdd3b71b5517e8a1a2a149621c8580a7635810c8
+SHA512:
+  metadata.gz: 422248c44d1f9f92c307299eb7b171429ead2cd40218e155617f1fe1117c214418f85c555d322acb5d5fccb6783a0217a083184960d50baaaf510b62283db083
+  data.tar.gz: d6a06b29daa84482c195e21c4c5d614cf001f8598593aa3f122a1fc62f1f216c3da7380e4217d6ddfc901736182a13f56a2927de700bbb12e1571f137eec2ee5

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/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Buckley
+
+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,32 @@
+# QueueWorker
+
+A light STOMP wrapper to ease interaction with a queueing system (e.g. ActiveMQ)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'queue_worker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install queue_worker
+
+## Usage
+
+    worker = QueueWorker.new('some_queue_name')
+    worker.push({ name: 'foo' })
+    worker.handler = proc { |args| puts "Got #{args}" }
+    worker.subscribe
+
+## Contributing
+
+1. Fork it ( https://github.com/ridiculous/queue_worker/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,14 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.title = "queue_worker #{QueueWorker::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/queue_worker.rb

@@ -0,0 +1,160 @@
+require 'json'
+require 'logger'
+require 'timeout'
+require 'forwardable'
+require 'stomp'
+
+class QueueWorker
+
+  VERSION = '0.0.1'
+
+  extend Forwardable
+
+  def_delegators :client,
+    :ack, :join, :close
+
+
+  class << self
+    attr_accessor :stomp
+
+    def configure
+      yield self
+    end
+  end
+
+  attr_writer :client
+  attr_accessor :queue, :handler
+
+  # @param [String] queue_name the queue to pub/sub
+  # @param [Stomp::Client] client that can communicate with ActiveMQ
+  def initialize(queue_name = nil, client = nil)
+    @queue = queue_name
+    @client = client
+    @handler = proc { |args, message| load_handler_class(message.headers['destination']).new(args).call }
+  end
+
+  # = Publish one or more messages to a queue
+  #
+  # @param [String] queue name
+  # @param [Array] messages a list of objects that are or can be converted to JSON
+  def self.publish(queue, *messages)
+    worker = new(queue)
+    messages.each { |msg| worker.publish(msg) }
+    worker.close
+  end
+
+  # = Peek at any number messages in the queue
+  #
+  # @param [String] queue_name
+  # @param [Integer] size specify the number of messages to return
+  def self.peek(queue_name, size = 1)
+    counter = 0
+    messages = []
+    worker = new(queue_name)
+    worker.subscribe_with_timeout(2, size) do |message|
+      counter += 1
+      messages << JSON.parse(message.body).merge('message-id' => message.headers['message-id'])
+      worker.quit if counter == size
+    end
+    messages
+  end
+
+  # = Publish a message to a queue
+  #
+  # @param [Hash] message - Data to serialize
+  # @param [Hash] headers - Additional header options for ActiveMQ
+  def publish(message, headers = {})
+    message = message.to_json unless message.is_a?(String)
+    client.publish("/queue/#{queue}", message, { priority: 4, persistent: true }.merge(headers))
+  end
+
+  alias push publish
+
+  # = Subscribe (listen) to a queue
+  #
+  # @param [Integer] size specify the number of messages the block may receive without sending +ack+
+  # @param [Proc] block to handle the subscribe callback
+  def subscribe(size = 1, &block)
+    callback = block || method(:default_subscribe_callback)
+    client.subscribe("/queue/#{queue}", { :ack => 'client', 'activemq.prefetchSize' => size }, &callback)
+  end
+
+  # = Subscribe to a queue for a limited time
+  #
+  # @param [Integer] duration to subscribe for before closing connection
+  # @param [Integer] size specify the number of messages the block may receive without sending +ack+
+  # @param [Proc] block to handle the subscribe callback
+  def subscribe_with_timeout(duration, size = 1, &block)
+    Timeout::timeout(duration) do
+      subscribe(size, &block)
+      join
+    end
+  rescue Timeout::Error
+    quit
+  end
+
+  # = Unsubscribe from the current queue
+  def unsubscribe
+    client.unsubscribe("/queue/#{queue}")
+  end
+
+  # = Unsubscribe from the current queue and close the connection
+  def quit
+    unsubscribe
+    close
+  end
+
+  # = Handles +subscribe+ callback
+  #
+  # Tries to delegate processing of message to a class based on the name of the queue. For example:
+  #
+  #   If the queue is named "scheduled/default" it will look for a class called Scheduled::Default to
+  #   initialize with the message body and then call it's +call+ method
+  #
+  # @param [Stomp::Message] message is the container object Stomp gives us for what is really a "frame" or package from the queue
+  def call(message)
+    handler.call(JSON.parse(message.body, symbolize_names: true), message)
+  rescue => e
+    log.error(e.message) { "\n#{e.backtrace.inspect}" }
+  ensure
+    ack(message)
+    log.info('Processed') { message }
+  end
+
+  #
+  # Private
+  #
+
+  def default_subscribe_callback(message)
+    if message.command == 'MESSAGE'
+      if message.body == 'UNSUBSCRIBE'
+        unsubscribe
+      else
+        call(message)
+      end
+    end
+  end
+
+  # = Converts the queue name to a constant
+  #
+  # @param [String] destination_queue
+  #
+  def load_handler_class(destination_queue)
+    destination_queue.gsub(%r!^/?queue/!, '').camelize.constantize
+  end
+
+  def client
+    @client ||= begin
+      if self.class.stomp
+        Stomp::Client.new(self.class.stomp)
+      else
+        fail ArgumentError, 'No STOMP config specified'
+      end
+    end
+  end
+
+  def log
+    @log ||= Logger.new(STDOUT)
+  end
+
+end

data/queue_worker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'queue_worker'
+
+Gem::Specification.new do |spec|
+  spec.name          = "queue_worker"
+  spec.version       = QueueWorker::VERSION
+  spec.authors       = ["Ryan Buckley"]
+  spec.email         = ["arebuckley@gmail.com"]
+  spec.summary       = %q{A light STOMP wrapper}
+  spec.description   = %q{A light STOMP wrapper to ease interaction with a queueing system (e.g. ActiveMQ)}
+  spec.homepage      = "https://github.com/ridiculous/queue_worker"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+
+  spec.add_runtime_dependency 'stomp', '~> 1.3', '>= 1.3.4'
+end

data/spec/lib/queue_worker_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe QueueWorker, slow: true do
+  let(:queue_name) { 'queue_foo' }
+
+  subject { described_class.new(queue_name, double(Stomp::Client)) }
+
+  describe '.publish' do
+    let(:message) { { id: 101 } }
+    let(:worker) { double('Worker') }
+
+    it 'publishes the messages to an instance of itself' do
+      expect(described_class).to receive(:new).with(queue_name).and_return(worker)
+      expect(worker).to receive(:close)
+      expect(worker).to receive(:publish).with(message)
+      described_class.publish(queue_name, message)
+    end
+  end
+
+  describe '#publish' do
+    let(:message) { {} }
+
+    before(:each) { allow(subject.client).to receive(:publish) }
+
+    context 'unless the message is a string' do
+      it "converts the message argument to json" do
+        expect(message).to receive(:to_json)
+        subject.publish(message)
+      end
+    end
+
+    it 'merges in default headers and publishes the message to the client' do
+      expect(subject.client).to receive(:publish).with("/queue/#{queue_name}", message.to_json, priority: 6, persistent: true)
+      # priority defaults to 4, so we override it here
+      subject.publish(message, priority: 6)
+    end
+  end
+
+  describe '#subscribe' do
+    let(:headers) { { :ack => 'client', 'activemq.prefetchSize' => 1 } }
+
+    context "when message command is not 'MESSAGE'" do
+      let(:message) { Struct.new(:command).new('PING') }
+
+      it 'does nothing' do
+        expect(subject.client).to receive(:subscribe).with("/queue/#{queue_name}", headers).and_yield(message)
+        expect(subject).to_not receive(:unsubscribe)
+        expect(subject).to_not receive(:call)
+        subject.subscribe
+      end
+    end
+
+    context "when message command is 'MESSAGE'" do
+      let(:message) { Struct.new(:command, :body).new('MESSAGE', nil) }
+
+      context "when message body is 'UNSUBSCRIBE'" do
+        before { message.body = 'UNSUBSCRIBE' }
+
+        it 'unsubscribes from the -queue-' do
+          expect(subject.client).to receive(:subscribe).with("/queue/#{queue_name}", headers).and_yield(message)
+          expect(subject).to receive(:unsubscribe)
+          subject.subscribe
+        end
+      end
+
+      context "when message body is JSON" do
+        before { message.body = '{}' }
+
+        it 'pass the -message- to +call+' do
+          expect(subject.client).to receive(:subscribe).with("/queue/#{queue_name}", headers).and_yield(message)
+          expect(subject).to receive(:call).with(message)
+          subject.subscribe
+        end
+      end
+    end
+  end
+
+  describe '#unsubscribe' do
+    it 'calls +unsubscribe+ on the client with the given queue' do
+      expect(subject.client).to receive(:unsubscribe).with("/queue/#{queue_name}")
+      subject.unsubscribe
+    end
+  end
+
+  describe '#call' do
+    let(:message) { double("Stomp::Message", body: %({"name":"trip_advisor"}), headers: { 'destination' => '/queue/null' }) }
+
+    it 'acknowledges the message and passes it along to the handler class' do
+      expect(subject.handler).to receive(:call).with({ name: 'trip_advisor' }, message)
+      expect(subject).to receive(:ack).with(message)
+      subject.call(message)
+    end
+  end
+
+  describe '#quit' do
+    it 'unsubscribes from the current queue and closes the connection' do
+      expect(subject).to receive(:unsubscribe)
+      expect(subject).to receive(:close)
+      subject.quit
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: queue_worker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-17 00:00:00.000000000 Z
+dependencies:
+- !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: '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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: stomp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+description: A light STOMP wrapper to ease interaction with a queueing system (e.g.
+  ActiveMQ)
+email:
+- arebuckley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/queue_worker.rb
+- queue_worker.gemspec
+- spec/lib/queue_worker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ridiculous/queue_worker
+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.3
+signing_key: 
+specification_version: 4
+summary: A light STOMP wrapper
+test_files:
+- spec/lib/queue_worker_spec.rb
+- spec/spec_helper.rb