tennis-jobs-rmq 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3c7ec8863688705b71c4b3ae5c2e20f1ef5a039
+  data.tar.gz: f273be2bf52df1d3e87daabcdac9afbdf16ca355
+SHA512:
+  metadata.gz: 7beff035b3f5e766cdbf1f2b32599561d319246d9a974e1500bf55aa68f8d546e25a201c668bd8a38858476c5ef672ba5f55affccaa97d3d2bc9146391e7206b
+  data.tar.gz: 1d5aaf81decbf901f152bec2902153c389648d65e07720ff48a528d6676bae98517af482fc5307cdc4a4b0de998e2c2581e0a264c8f02f19f73a9fc7e3b2d66a

data/.codeclimate.yml

@@ -0,0 +1,44 @@
+# For an overview of the Code Climate Platform, see here:
+# http://docs.codeclimate.com/article/300-the-codeclimate-platform
+
+# Under the engines key, you can configure which engines will analyze your repo.
+# Each key is an engine name. For each value, you need to specify enabled: true
+# to enable the engine as well as any other engines-specific configuration.
+
+# For more details, see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+# For a list of all available engines, see here:
+# http://docs.codeclimate.com/article/296-engines-available-engines
+
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/EmptyLinesAroundClassBody:
+        enabled: false
+      Rubocop/Style/BracesAroundHashParameters:
+        enabled: fals
+      Rubocop/Style/StringLiterals:
+        enabled: false
+      Rubocop/Style/StringLiteralsInInterpolation:
+        enabled: false
+      Rubocop/Style/TrailingComma:
+        enabled: false
+
+# Engines can analyze files and report issues on them, but you can separately
+# decide which files will receive ratings based on those issues. This is
+# specified by path patterns under the ratings key.
+
+# For more details see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+ratings:
+  paths:
+  - lib/**
+
+# You can globally exclude files from being analyzed by any engine using the
+# exclude_paths key.
+
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "2.2.3"
+branches:
+  only:
+    - master
+services:
+  - redis-server
+script: bundle exec rspec spec
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nicolas ZERMATI
+
+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,31 @@
+# Tennis::Backend::Rabbit
+
+A RabbitMQ backend for [tennis-jobs][tennis-jobs].
+
+<a target="_blank" href="https://travis-ci.org/nicoolas25/tennis-rmq"><img src="https://travis-ci.org/nicoolas25/tennis-rmq.svg?branch=master" /></a>
+<a target="_blank" href="https://codeclimate.com/github/nicoolas25/tennis-rmq"><img src="https://codeclimate.com/github/nicoolas25/tennis-rmq/badges/gpa.svg" /></a>
+<a target="_blank" href="https://codeclimate.com/github/nicoolas25/tennis-rmq/coverage"><img src="https://codeclimate.com/github/nicoolas25/tennis-rmq/badges/coverage.svg" /></a>
+<a target="_blank" href="https://rubygems.org/gems/tennis-jobs-rmq"><img src="https://badge.fury.io/rb/tennis-jobs-rmq.svg" /></a>
+
+## Usage
+
+Simply configure Tennis with this backend:
+
+``` ruby
+AMQP_URL = "redis://localhost:6379"
+
+Tennis.configure do |config|
+  config.backend = Tennis::Backend::Rabbit.new(logger: logger, url: AMQP_URL)
+end
+```
+
+## TODO
+
+- Support the delay option.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+[tennis-jobs]: https://github.com/nicoolas25/tennis

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/async_sum.rb

@@ -0,0 +1,57 @@
+#
+# bundle exec ruby examples/async_sum.rb client
+# bundle exec ruby examples/async_sum.rb server
+#
+
+require "tennis"
+require "tennis/backend/rabbit"
+
+logger = Logger.new(STDOUT)
+logger.level = Logger::DEBUG
+amqp_url = "amqp://guest:guest@localhost:5672"
+
+Tennis.configure do |config|
+  config.backend = Tennis::Backend::Rabbit.new(logger: logger, url: amqp_url)
+  config.logger = logger
+end
+
+class Job
+  include Tennis::Job
+
+  def sum(*numbers)
+    sleep 0.4
+    total = numbers.inject(&:+)
+    puts "Sum #{numbers} => #{total}"
+  end
+
+  def job_dump
+    nil
+  end
+
+  def self.job_load(_)
+    new
+  end
+end
+
+
+if ARGV[0] == "server"
+  require "tennis/launcher"
+
+  # Start Tennis.
+  launcher = Tennis::Launcher.new(concurrency: 2, job_classes: [Job])
+  launcher.async.start
+
+  begin
+    sleep 5 while true
+  rescue Interrupt
+    puts "Stopping the server..."
+  ensure
+    launcher.async.stop
+  end
+else
+  # Instanciate a job and add the sum to the job to do.
+  numbers = (1..9).to_a
+  10.times do
+    Job.new.async.sum(*numbers.sample(3))
+  end
+end

data/lib/tennis/backend/rabbit.rb

@@ -0,0 +1,136 @@
+require "bunny"
+require "securerandom"
+
+require "tennis"
+require "tennis/backend/abstract"
+require "tennis/backend/serializer"
+require "tennis/backend/task"
+
+require_relative "rabbit/queue"
+
+module Tennis
+  module Backend
+    class Rabbit < Abstract
+
+      def initialize(logger:, url:, namespace: "tennis")
+        super(logger: logger)
+        @rabbit_url = url
+        @rabbit_namespace = namespace
+        @payload_queue = RabbitQueue.new
+        @job_classes = nil
+        @setup = false
+      end
+
+      # Delayed jobs are not yet supported with Rabbit backend
+      def enqueue(job:, method:, args:, delay: nil)
+        queue(job.class)
+        meta = { "enqueued_at" => Time.now.to_i }
+        task = Task.new(self, generate_task_id, job, method, args, meta)
+        exchange.publish(serialize(task), routing_key: routing_key(job.class))
+      end
+
+      def receive(job_classes:, timeout: 1.0)
+        setup(job_classes)
+        payload = @payload_queue.pop(timeout)
+        payload && deserialize_task(*payload)
+      end
+
+      def ack(task)
+        delivery_info = task.meta["_backend"]["delivery_info"]
+        channel.acknowledge(delivery_info.delivery_tag, false)
+      end
+
+      def requeue(task)
+        delivery_info = task.meta["_backend"]["delivery_info"]
+        channel.reject(delivery_info.delivery_tag, true)
+      end
+
+      # Reset the backend:
+      # - stop getting messages from the queues
+      # - requeue unacked messages
+      def reset
+        return unless @setup
+        @consumers.each(&:cancel)
+        @job_classes = nil
+        @setup = false
+      end
+
+      private
+
+      def setup(job_classes)
+        return if @job_classes == job_classes
+        raise "The Rabbit backend can't dynamically update its job_classes" if @setup
+        @job_classes = job_classes
+        @consumers = job_classes.map { |klass| subscribe(klass) }
+        @setup = true
+      end
+
+      def subscribe(klass)
+        queue(klass).subscribe(manual_ack: true) do |delivery_info, properties, payload|
+          @payload_queue << [delivery_info, properties, payload]
+        end
+      end
+
+      def serialize(task)
+        filtered_meta = task.meta.dup
+        filtered_meta.delete("_backend")
+        Serializer.new.dump({
+          "id"     => task.task_id,
+          "job"    => task.job,
+          "method" => task.method,
+          "args"   => task.args,
+          "meta"   => filtered_meta,
+        })
+      end
+
+      def deserialize_task(delivery_info, properties, serialized_task)
+        hash = Serializer.new.load(serialized_task)
+        hash["meta"].merge!("_backend" => {
+          "delivery_info" => delivery_info,
+          "properties" => properties,
+        })
+        Task.new(self, hash["id"], hash["job"], hash["method"], hash["args"], hash["meta"])
+      end
+
+      def generate_task_id
+        SecureRandom.hex(10)
+      end
+
+      def queue(klass)
+        @queue ||= {}
+        @queue[klass] ||=
+          channel.queue(queue_name(klass), durable: true).tap do |q|
+            q.bind(exchange, routing_key: routing_key(klass))
+          end
+      end
+
+      def queue_name(klass)
+        @queue_name ||= {}
+        @queue_name[klass] ||= "%{namespace}:queue:%{klass_name}" % {
+          namespace: @rabbit_namespace,
+          klass_name: routing_key(klass),
+        }
+      end
+
+      def routing_key(klass)
+        @routing_key ||= {}
+        @routing_key[klass] ||= klass.name.gsub("::", "-").downcase
+      end
+
+      def exchange
+        @echange ||= channel.topic(@rabbit_namespace, durable: true)
+      end
+
+      def channel
+        @channel ||= client.create_channel.tap do |chan|
+          chan.prefetch(10)
+        end
+      end
+
+      def client
+        @client ||= ::Bunny.new(@rabbit_url).tap(&:start)
+      end
+
+    end
+  end
+end

data/lib/tennis/backend/rabbit/queue.rb

@@ -0,0 +1,25 @@
+require "thread"
+
+module Tennis::Backend
+  class RabbitQueue
+    def initialize
+      @mutex = Mutex.new
+      @queue = []
+      @received = ConditionVariable.new
+    end
+
+    def <<(x)
+      @mutex.synchronize do
+        @queue << x
+        @received.signal
+      end
+    end
+
+    def pop(timeout = nil)
+      @mutex.synchronize do
+        @received.wait(@mutex, timeout) if @queue.empty?
+        @queue.shift
+      end
+    end
+  end
+end

data/tennis-jobs-rmq.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "tennis-jobs-rmq"
+  spec.version       = "0.4.0"
+  spec.authors       = ["Nicolas ZERMATI"]
+  spec.email         = ["nicoolas25@gmail.com"]
+
+  spec.summary       = %q{A RabbitMQ backend for tennis-jobs.}
+  spec.description   = %q{A RabbitMQ backend for tennis-jobs.}
+  spec.homepage      = "https://github.com/nicoolas25/tennis-rmq"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "bunny"
+  spec.add_runtime_dependency "tennis-jobs", "~> 0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: tennis-jobs-rmq
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Nicolas ZERMATI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-25 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: tennis-jobs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: guard-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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: A RabbitMQ backend for tennis-jobs.
+email:
+- nicoolas25@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/async_sum.rb
+- lib/tennis/backend/rabbit.rb
+- lib/tennis/backend/rabbit/queue.rb
+- tennis-jobs-rmq.gemspec
+homepage: https://github.com/nicoolas25/tennis-rmq
+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.8
+signing_key: 
+specification_version: 4
+summary: A RabbitMQ backend for tennis-jobs.
+test_files: []