bunny_priority_queue 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80c8adb42bfdad05da54a586ef20e1a9335519ff
+  data.tar.gz: d9ee1f4e411a7cc7473c0d2483ba26c2d4449fa2
+SHA512:
+  metadata.gz: 539f1067c4b75689013866f4ad66bdcb221ca1ac83ccfccde8a6e9c004543a48dcf594f1219d37372aa754f33154500a798b3c6dd1f0d7307d0e098e2fcbaf8a
+  data.tar.gz: b247415a0889e9d84976bafc5651ed67f7c30de230612853feab28cc100d6982494eff3842b982751f12d88bc5a84ed84f2c7568226b643600ad8882a6df2f2f

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.idea
+.bundle
+.config
+.yardoc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Takahiro Kikumoto
+
+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,29 @@
+# BunnyPriorityQueue
+
+Priority Queue library using Bunny with RabbitMQ.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bunny_priority_queue'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bunny_priority_queue
+
+## Usage
+
+see https://github.com/kikumoto/bunny_priority_queue/tree/master/examples
+
+## Contributing
+
+1. Fork it ( https://github.com/kikumoto/bunny_priority_queue/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bunny_priority_queue.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bunny_priority_queue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bunny_priority_queue"
+  spec.version       = BunnyPriorityQueue::VERSION
+  spec.authors       = ["Takahiro Kikumoto"]
+  spec.email         = ["takakiku810@gmail.com"]
+  spec.summary       = %q{Priority Queue library using Bunny with RabbitMQ.}
+  spec.description   = %q{Priority Queue library using Bunny with RabbitMQ.}
+  spec.homepage      = "https://github.com/kikumoto/bunny_priority_queue"
+  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.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "bunny"
+end

data/examples/common.rb

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+
+EXCHANE_NAME = "sample_exchange"
+QUEUE_PREFIX = "sample_queue"
+
+
+PRIORITY_HIGH   = "high"
+PRIORITY_NORMAL = "normal"
+PRIORITY_LOW    = "low"
+
+PRIORITIES = [
+    PRIORITY_HIGH,
+    PRIORITY_NORMAL,
+    PRIORITY_LOW,
+]

data/examples/consumer.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+require 'bunny_priority_queue'
+require_relative './common.rb'
+
+begin
+  conn = Bunny.new.start
+  exchange = conn.create_channel.direct(EXCHANE_NAME)
+
+  q = BunnyPriorityQueue.create(
+      QUEUE_PREFIX,
+      PRIORITIES,
+      exchange
+  )
+
+  q.bind
+
+  q.subscribe(:block => true) do |delivery_info, properties, body|
+    puts "routing_key: #{delivery_info.routing_key}"
+    puts "properties : #{properties}"
+    puts "payload    : #{body}"
+  end
+
+ensure
+  conn.close
+end

data/examples/producer.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+require 'bunny_priority_queue'
+require_relative './common.rb'
+
+begin
+  conn = Bunny.new.start
+
+  exchange = conn.create_channel.direct(EXCHANE_NAME)
+
+  q = BunnyPriorityQueue.new(
+      QUEUE_PREFIX,
+      PRIORITIES,
+  )
+
+  exchange.publish("normal", :routing_key => q.name(PRIORITY_NORMAL))
+ensure
+  conn.close
+end

data/lib/bunny_priority_queue.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8; mode: ruby -*-
+
+require "bunny"
+
+require "bunny_priority_queue/version"
+require "bunny_priority_queue/queue"
+
+module BunnyPriorityQueue
+  # @return [String] Bunny version
+  def self.version
+    VERSION
+  end
+
+  # Instantiates a new priority queue.
+  #
+  # @return [BunnyPriorityQueue::Queue]
+  # @see BunnyPriorityQueue::Queue#initialize
+  # @api public
+  def self.new(prefix, priorities)
+    Queue.new(prefix, priorities)
+  end
+
+  # Instantiates a new priority queue and create queue.
+  #
+  # @return [BunnyPriorityQueue::Queue]
+  # @see BunnyPriorityQueue::Queue#initialize
+  # @see BunnyPriorityQueue::Queue#create
+  # @api public
+  def self.create(prefix, priorities, exchange, level_ttl = 2000, queue_opts = {})
+    q = Queue.new(prefix, priorities)
+    q.create(exchange, level_ttl, queue_opts)
+    q
+  end
+end

data/lib/bunny_priority_queue/queue.rb

@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-
+require "bunny"
+
+
+module BunnyPriorityQueue
+  class Queue
+    # @param prefix [String] prefix of queue name
+    # @param priorities [Array] each prirority queue names
+    def initialize(prefix, priorities)
+      @prefix = prefix
+      @priorities = priorities
+    end
+
+    # @return [String] a priority queue name
+    def name(priority)
+      "#{@prefix}.#{priority}"
+    end
+
+    # create priority queues
+    #
+    # @return [Queue]
+    # @param exchange [Bunny::Exchange] exchange
+    # @param level_ttl [Integer] PriorityQueue Message TTL (msec)
+    # @param queue_opts [Hash] Bunny::Queue options
+    def create(exchange, level_ttl = 2000, queue_opts = {})
+      @exchange = exchange
+
+      queue_opts[:arguments] ||= {}
+      args = queue_opts[:arguments]
+
+      original_arguments = backup_arguments(args, ["x-dead-letter-exchange", "x-message-ttl", "x-dead-letter-routing-key"])
+
+      @queues = @priorities.map.with_index do |priority, i|
+        args["x-priority-level-index"] = i
+
+        if i == 0
+          original_arguments.each do |k, v|
+            args[k] = v unless v.nil?
+          end
+        else
+          # when a message is expired, its is deivered to upper priority queue fia DLX.
+          args["x-dead-letter-routing-key"] = self.name(@priorities[i-1])
+          args["x-message-ttl"] = level_ttl
+          args["x-dead-letter-exchange"] = @exchange.name
+        end
+
+        @exchange.channel.queue("#{self.name(priority)}", queue_opts)
+      end
+
+      self
+    end
+
+    # bind queue to exchange
+    #
+    def bind
+      @queues.each do |q|
+        q.bind(@exchange, :routing_key => q.name)
+      end
+      self
+    end
+
+    # subscribe queue
+    #
+    def subscribe(opts, &block)
+      manual_ack = opts[:ack] || opts[:manual_ack]
+      consumers = @queues.map do |q|
+        q.subscribe(:ack => true) do |delivery_info, properties, body|
+          d, p, b = check_higher_queue(q.arguments["x-priority-level-index"])
+
+          unless d.nil?
+            channel.reject(delivery_info.delivery_tag, true)
+            delivery_info = d
+            properties = p
+            body = b
+          end
+
+          channel.ack(delivery_info.delivery_tag) unless manual_ack
+          yield delivery_info, properties, body
+        end
+      end
+
+      if opts[:block]
+        channel.work_pool.join
+      end
+
+      consumers
+    end
+
+
+    private
+
+    def channel
+      @exchange.channel
+    end
+
+    def check_higher_queue(current_queue_index)
+      0.upto(current_queue_index -1) do |i|
+        d, p, b = @queues[i].pop(:ack => true)
+        return [d, p, b] unless d.nil?
+      end
+      
+      [nil, nil, nil]
+    end
+
+    def backup_arguments(args, keys)
+      original = {}
+      keys.each do |k|
+        original[k] = args[k]
+        args.delete k
+      end
+      original
+    end
+  end
+end

data/lib/bunny_priority_queue/version.rb

@@ -0,0 +1,3 @@
+module BunnyPriorityQueue
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: bunny_priority_queue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takahiro Kikumoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 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: Priority Queue library using Bunny with RabbitMQ.
+email:
+- takakiku810@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bunny_priority_queue.gemspec
+- examples/common.rb
+- examples/consumer.rb
+- examples/producer.rb
+- lib/bunny_priority_queue.rb
+- lib/bunny_priority_queue/queue.rb
+- lib/bunny_priority_queue/version.rb
+homepage: https://github.com/kikumoto/bunny_priority_queue
+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.0
+signing_key: 
+specification_version: 4
+summary: Priority Queue library using Bunny with RabbitMQ.
+test_files: []