barbeque 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4189910f9a93c337aa4baf8491098e3c5cfb0d83
-  data.tar.gz: 8d460cc32edf6f00514f2448b583ee0e5c857977
+  metadata.gz: 5c4a66c06a41f0c69f6b58200d649ecfa9864d32
+  data.tar.gz: a99fb1a847e6e661eafa78a087eaec2ad967ce62
 SHA512:
-  metadata.gz: 7c50e0ef9258dd7b9fce1940dd4ef3d60d7b0eb29e6d9dc54456de19549c2ce45ccaf56f67f2487e43bb5394d3f026caae42964008e059796ecf3f1f1db4127a
-  data.tar.gz: 766e2abd01645473c086649441b3f3753a43e6f776d9ea49a28677f258102a60e63f37a557c356159caff8e2aa7b500b17db221ce4dee3726da7c8c04dc4bf7f
+  metadata.gz: d0f78d987a36eea2f2ff15e5bdb0e7769ac36cfafae1fb7710b654385722d1090b7c348589c3e26b13d2f98daa2d0bc6a8e384236634b4d53d631e6c68a39959
+  data.tar.gz: 2fa5ea52ab2aab1d310da0ddf72090561169886d9f9fbd71273f7ac016ba36dec0e38b58d1d0d830617914fba925186ad29895cb76b7b3f768c4afa54bd820e7

data/README.md

@@ -1,29 +1,57 @@
 # Barbeque [![Build Status](https://travis-ci.org/cookpad/barbeque.svg?branch=master)](https://travis-ci.org/cookpad/barbeque)
 
-## Status
+Job queue system to run job with Docker
 
-We've just open-sourced this library and documentation is work in progress.  
-Barbeque is already used on production at Cookpad.
+<img src="https://raw.githubusercontent.com/cookpad/barbeque/master/doc/images/job_definitions.png" height="280px" />
+<img src="https://raw.githubusercontent.com/cookpad/barbeque/master/doc/images/statistics.png" height="280px" />
 
-## Installation
-Add this line to your application's Gemfile:
+## Project Status
 
-```ruby
-gem 'barbeque'
-```
+Barbeque is under development but already used on production at Cookpad.  
+Documentation and open-sourcing plugins are work in progress.
 
-And then execute:
-```bash
-$ bundle
-```
+## What's Barbeque?
+
+Barbeque is a job queue system that consists of:
+
+- Web console to manage jobs
+- Web API to queue a job
+- Worker to execute a job
+
+A job for Barbeque is a command you configured on web console.
+A message serialized by JSON and a job name are given to the command when performed.
+In Barbeque worker, they are done on Docker container.
+
+## Why Barbeque?
+
+- You can achieve job-level auto scaling using tools like [Amazon ECS](https://aws.amazon.com/ecs/) and [EC2 Auto Scaling group](https://aws.amazon.com/autoscaling/)
+  - It requires a plugin to run job with ECS, but it's not open-sourced for now
+- You don't have to manage infrastructure for each application like Resque or Sidekiq
+
+For details, see [Scalable Job Queue System Built with Docker // Speaker Deck](https://speakerdeck.com/k0kubun/scalable-job-queue-system-built-with-docker).
+
+## Deployment
+
+### Web API & console
+
+Install barbeque.gem to an empty Rails app and mount `Barbeque::Engine`.
+And deploy it as you like.
+
+You also need to prepare MySQL, Amazon SQS and Amazon S3.
+
+### Worker
 
-Or install it yourself as:
 ```bash
-$ gem install barbeque
+$ rake barbeque:worker BARBEQUE_QUEUE=default
 ```
 
-## Contributing
-Contribution directions go here.
+## Usage
+
+Web API documentation is available at [doc/toc.md](./doc/toc.md).
+
+### Ruby
+
+[barbeque\_client.gem](https://github.com/cookpad/barbeque_client) has API client and ActiveJob integration.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/barbeque/configuration.rb

@@ -4,6 +4,11 @@ require 'hashie'
 
 module Barbeque
   module Configuration
+    DEFAULT_CONFIG = {
+      'exception_handler' => 'RailsLogger',
+      'runner'            => 'Docker',
+    }
+
     def config
       @config ||= build_config
     end
@@ -11,7 +16,7 @@ module Barbeque
     def build_config
       filename = Rails.root.join('config', 'barbeque.yml').to_s
       hash = YAML.load(ERB.new(File.read(filename)).result)
-      Hashie::Mash.new(hash[Rails.env])
+      Hashie::Mash.new(DEFAULT_CONFIG.merge(hash[Rails.env]))
     end
   end
 

data/lib/barbeque/exception_handler.rb

@@ -0,0 +1,29 @@
+require 'barbeque/configuration'
+
+module Barbeque
+  module ExceptionHandler
+    class << self
+      def handle_exception(e)
+        handler.handle_exception(e)
+      end
+
+      private
+
+      def handler
+        @handler ||= const_get(Barbeque.config.exception_handler, false)
+      end
+    end
+
+    module RailsLogger
+      def self.handle_exception(e)
+        Rails.logger.error("#{e.inspect}\n#{e.backtrace.join("\n")}")
+      end
+    end
+
+    module Raven
+      def self.handle_exception(e)
+        ::Raven.capture_exception(e)
+      end
+    end
+  end
+end

data/lib/barbeque/version.rb

@@ -1,3 +1,3 @@
 module Barbeque
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
 end

data/lib/barbeque/worker.rb

@@ -1,3 +1,4 @@
+require 'barbeque/exception_handler'
 require 'barbeque/message_handler'
 require 'barbeque/message_queue'
 require 'serverengine'
@@ -53,8 +54,7 @@ module Barbeque
       handler = MessageHandler.const_get(message.type, false)
       handler.new(message: message, job_queue: message_queue.job_queue).run
     rescue => e
-      # Use Raven.capture_exception
-      Rails.logger.fatal("[ERROR] #{e.inspect}\n#{e.backtrace.join("\n")}")
+      Barbeque::ExceptionHandler.handle_exception(e)
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barbeque
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adminlte2-rails
@@ -262,7 +262,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Job queue interface to run job with Docker
+description: Job queue system to run job with Docker
 email:
 - takashi-kokubun@cookpad.com
 executables: []
@@ -348,6 +348,7 @@ files:
 - lib/barbeque/configuration.rb
 - lib/barbeque/docker_image.rb
 - lib/barbeque/engine.rb
+- lib/barbeque/exception_handler.rb
 - lib/barbeque/execution_log.rb
 - lib/barbeque/message.rb
 - lib/barbeque/message/base.rb
@@ -388,5 +389,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Job queue interface to run job with Docker
+summary: Job queue system to run job with Docker
 test_files: []