active_beaneater 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cef3e6bc47d58798b948cfda4e5a627fbf2426cf
+  data.tar.gz: d433befd9375f671e29ff1a5179e6b650c210f32
+SHA512:
+  metadata.gz: ec2d3fcd031b05c967927cba6e84fbecf6a2db7718955b0886bd56fe04c77cc8cf6a3fdfff51675a8f76cbf7fed0ca9877070ee418871d7dae00466b3871a979
+  data.tar.gz: 77c3774729f824c819d6419d16d7a3c7596adb11a736559a344400bcf8c5561cdbe650f4d15e697a766c72d12878eb139489a1d5285c5320a9123f9eb1ed421a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_beaneater.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nicolas Goy
+
+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,67 @@
+# ActiveBeaneater
+
+Simple beanstalk backend for Rails's ActiveJob.
+
+Require Rails 4.2 or greater
+
+WARNING: This is early alpha, not supposed to be stable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_beaneater'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_beaneater
+
+## Usage
+
+Set your `ActiveJob` backend to active_beaneater:
+
+In `development.rb` and/or `production.rb`:
+
+```ruby
+config.active_job.queue_adapter = :active_beaneater
+```
+
+The env var `BEANSTALK_URL` will be used to connect to beanstalk.
+
+### Configuration
+
+You may configure `ActiveBeanter` in a rails initializer:
+
+```ruby
+ActiveBeaneater.configure do |config|
+  config.client = Beaneater.new("localhost:11300") # Default to BEANSTALK_URL ENV var
+  config.prefix = 'yourapp' # Default to active-beaneater, can be an array, elements will be joined by a dot
+end
+```
+
+### Running jobs
+
+Simply issue `active_beaneater` from within your app root directory.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_beaneater. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_beaneater.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_beaneater/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_beaneater"
+  spec.version       = ActiveBeaneater::VERSION
+  spec.authors       = ["Nicolas Goy"]
+  spec.email         = ["kuon@goyman.com"]
+
+  spec.summary       = %q{Simple beanstalk backend for Rails's ActiveJob.}
+  spec.homepage      = "http://github.com/kuon/active_beaneater"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '~> 4.2'
+  spec.add_dependency 'beaneater', '~> 1.0'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_beaneater"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/active_beaneater

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+
+require 'optparse'
+require 'active_beaneater'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: active_beaneater [options]"
+
+  opts.on("--only=NAMES", "Run only jobs on given queues") do |v|
+    options[:only] = v.split(',').map(&:to_sym)
+  end
+
+  opts.on("--exclude=NAMES", "Run jobs on all tubes except those listed") do |v|
+    options[:exclude] = v.split(',').map(&:to_sym)
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts(opts)
+    exit
+  end
+end.parse!
+
+
+require "rails"
+require File.expand_path("./config/environment.rb")
+
+Rails.application.eager_load!
+
+# Override the rails logger in development to ensure we see it
+if Rails.env.development?
+  Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new(STDERR))
+end
+
+Rails.logger.info("Starting job worker")
+
+ActiveBeaneater::Worker.work(options)
+

data/lib/active_beaneater.rb

@@ -0,0 +1,42 @@
+require "active_job/queue_adapters/active_beaneater_adapter"
+require "active_beaneater/version"
+require "active_beaneater/queue_options"
+require "active_beaneater/worker"
+require "ostruct"
+require "beaneater"
+
+module URI
+  class BEANSTALK < Generic
+    DEFAULT_PORT = 11300
+  end
+  @@schemes['BEANSTALK'] = BEANSTALK
+end
+
+module ActiveBeaneater
+
+  def self.configure
+
+    url = ENV['BEANSTALK_URL']
+    url ||=  ['beanstalk://localhost']
+    uri = URI(url)
+
+
+    config = {
+      client: Beaneater.new("#{uri.host}:#{uri.port}"),
+      prefix: 'active-beaneater'
+    }
+
+    config = OpenStruct.new(config)
+    yield(config) if block_given?
+
+
+    Rails.application.config.beaneater = config.freeze
+  end
+
+  def self.resolve_queue_name(queue)
+    prefix = Rails.application.config.beaneater.prefix
+    prefix = [prefix] if !prefix.respond_to?(:to_ary)
+    (prefix + [queue]).join('.')
+  end
+
+end

data/lib/active_beaneater/queue_options.rb

@@ -0,0 +1,39 @@
+require 'active_support/concern'
+
+module ActiveBeaneater
+  module QueueOptions
+    extend ::ActiveSupport::Concern
+
+    module ClassMethods
+
+      def queue_priority(pri)
+        self.queue_priority_number = case pri
+        when Integer
+          pri
+        when :low
+          10000
+        when :high
+          0
+        else
+          fails ArgumentError, 'unknown priority'
+        end
+      end
+
+      def queue_timeout_after(timeout)
+        self.queue_respond_timeout = timeout
+      end
+
+    end
+
+    included do
+      # Beaneater native job, this is required for touch for long running jobs
+      attr_accessor :native_job
+
+      class_attribute :queue_priority_number
+      class_attribute :queue_respond_timeout
+
+      self.queue_priority_number = 0
+      self.queue_respond_timeout = 1.minute
+    end
+  end
+end

data/lib/active_beaneater/version.rb

@@ -0,0 +1,3 @@
+module ActiveBeaneater
+  VERSION = "0.1.0"
+end

data/lib/active_beaneater/worker.rb

@@ -0,0 +1,43 @@
+module ActiveBeaneater
+  class Worker
+
+    def self.work(only: nil, exclude: [])
+      client = Rails.application.config.beaneater.client
+
+
+      tube_names = []
+
+      ObjectSpace.each_object(Class) do |k|
+        if k.ancestors.include?(ActiveJob::Base)
+          tube_names << ActiveBeaneater.resolve_queue_name(k.queue_name)
+        end
+      end
+
+      tube_names = only if only
+      tube_names.uniq!
+      tube_names -= exclude
+
+      tube_names.each do |name|
+        client.jobs.register(name) do |job|
+          Rails.logger.debug("Processing job on tube #{name}")
+          begin
+            perform(job)
+          rescue Exception => e
+            Rails.logger.error(e)
+            raise e
+          end
+        end
+      end
+
+      Rails.logger.info("Watching tubes [#{tube_names.join(', ')}]")
+      client.jobs.process!
+    end
+
+    def self.perform(job)
+      active_job = ActiveJob::Base.deserialize(MultiJson.load(job.body))
+      active_job.native_job = job if active_job.respond_to?(:native_job=)
+      active_job.perform_now
+    end
+
+  end
+end

data/lib/active_job/queue_adapters/active_beaneater_adapter.rb

@@ -0,0 +1,38 @@
+module ActiveJob
+  module QueueAdapters
+    #   Rails.application.config.active_job.queue_adapter = :beaneater
+    class ActiveBeaneaterAdapter
+
+      class << self
+        def enqueue(job) #:nodoc:
+          enqueue_at(job, nil)
+        end
+
+        def enqueue_at(job, timestamp) #:nodoc:
+          delay = timestamp ? timestamp - Time.current.to_f : 0
+
+          tube = client.tubes[ActiveBeaneater.resolve_queue_name(job.queue_name)]
+
+          pri = job.respond_to?(:queue_priority_number) ?
+            job.queue_priority_number : 0
+
+          ttr = job.respond_to?(:queue_respond_timeout) ?
+            job.queue_respond_timeout : 10.minutes
+
+          tube.put(job.serialize.to_json,
+                   delay: delay,
+                   pri: pri,
+                   ttr: ttr)
+        end
+
+        private
+
+        def client
+          Rails.application.config.beaneater.client
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: active_beaneater
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Goy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: beaneater
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: 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'
+description: 
+email:
+- kuon@goyman.com
+executables:
+- active_beaneater
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_beaneater.gemspec
+- bin/console
+- bin/setup
+- exe/active_beaneater
+- lib/active_beaneater.rb
+- lib/active_beaneater/queue_options.rb
+- lib/active_beaneater/version.rb
+- lib/active_beaneater/worker.rb
+- lib/active_job/queue_adapters/active_beaneater_adapter.rb
+homepage: http://github.com/kuon/active_beaneater
+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: Simple beanstalk backend for Rails's ActiveJob.
+test_files: []