barbeque_client 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6af93b3528723f585a7877985325b6767ebf6924
+  data.tar.gz: cfa14afd2152039fecc9d8c82b60a37b67efca3d
+SHA512:
+  metadata.gz: ac6983702e340af395f84936868183abbd8ea0c4b947ee44f04533215a833bafed0038d7bbe582ca8ff5b7ca137b9d773478108655701281ef850a2746411c2d
+  data.tar.gz: 407c2073c7d61819028ffd0a1db5ce20a59c2b613e65a8bcc6a4076d35f0f3fc93ce91bd34fae65c711a65c278ad7c54f23a679162bbc3208e682787f4099be0

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,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in barbeque.gemspec
+gemspec
+
+gem 'pry-byebug'
+gem 'pry-doc'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Takashi Kokubun
+
+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,41 @@
+# BarbequeClient
+
+BarbequeClient client for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'barbeque_client'
+```
+
+And create "config/initializers/barbeque.rb" and edit it like:
+
+```rb
+BarbequeClient.configure do |config|
+  config.application   = 'cookpad'
+  config.default_queue = 'default'
+  config.endpoint      = 'https://barbeque.example.com'
+end
+```
+
+## Usage
+### Enqueuing a job
+
+```rb
+execution = BarbequeClient.enqueue(
+  job:     'NotifyAuthor',       # @param [String] job     - Job name to enqueue.
+  message: { user_id: 7553989 }, # @param [Object] message - An object which is serializable as JSON.
+  queue:   'default',            # @param optional [String] queue - A queue name to enqueue a job.
+)
+execution.message_id #=> "a3c653c1-335e-4d4d-a6f9-eb91c0253d02"
+execution.status     #=> "pending"
+```
+
+### Polling the job's status
+
+```rb
+message_id = "a3c653c1-335e-4d4d-a6f9-eb91c0253d02"
+BarbequeClient.status(message_id: message_id) #=> "success"
+```

data/Rakefile

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

data/barbeque.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barbeque_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'barbeque_client'
+  spec.version       = BarbequeClient::VERSION
+  spec.authors       = ['Takashi Kokubun']
+  spec.email         = ['takashi-kokubun@cookpad.com']
+
+  spec.summary       = %q{Barbeque client for Ruby}
+  spec.description   = %q{Barbeque client for Ruby}
+  spec.homepage      = 'https://github.com/cookpad/barbeque_client'
+  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 'garage_client'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rails', '~> 4.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails'
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "barbeque"
+
+require "pry"
+Pry.start

data/bin/setup

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

data/lib/active_job/queue_adapters/barbeque_adapter.rb

@@ -0,0 +1,28 @@
+module ActiveJob
+  module QueueAdapters
+    class BarbequeAdapter
+      # Interface for ActiveJob 5.0
+      def enqueue(job)
+        BarbequeAdapter.enqueue(job)
+      end
+
+      class << self
+        # Interface for ActiveJob 4.2
+        def enqueue(job)
+          execution = BarbequeClient.enqueue(
+            job:     job.class.to_s,
+            message: ActiveJob::Arguments.serialize(job.arguments),
+            queue:   job.queue_name,
+          )
+          job.job_id = execution.message_id
+        end
+
+        def enqueue_at(job, timestamp)
+          raise NotImplementedError.new(
+            'Currently setting timestamp is not supported'
+          )
+        end
+      end
+    end
+  end
+end

data/lib/barbeque_client.rb

@@ -0,0 +1,51 @@
+require 'barbeque_client/configuration'
+require 'barbeque_client/client'
+require 'barbeque_client/version'
+require 'barbeque_client/executor'
+
+begin
+  require 'rails'
+rescue LoadError
+else
+  require 'barbeque_client/railtie'
+end
+
+module BarbequeClient
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    # @param  [String] job     - Job name to enqueue.
+    # @param  [Object] message - An object which is serializable as JSON.
+    # @param  optional [String] queue - A queue name to enqueue a job.
+    # @return [Hashie::Mash] resonse - { message_id: String, status: String }
+    def enqueue(job:, message:, queue: nil)
+      response = client.create_execution(
+        job:     job,
+        message: message,
+        queue:   queue,
+      )
+      response.body
+    end
+
+    # @param  [String] message_id - Job execution's message_id to check status
+    # @return [String] status     - Job execution's status like "success", "pending", "failure", ...
+    def status(message_id:)
+      response = client.execution(message_id: message_id)
+      response.body.status
+    end
+
+    def client
+      @client ||= Client.new(
+        application:   config.application,
+        default_queue: config.default_queue,
+        endpoint:      config.endpoint,
+      )
+    end
+  end
+end

data/lib/barbeque_client/client.rb

@@ -0,0 +1,54 @@
+require 'garage_client'
+require 'json'
+
+module BarbequeClient
+  class Client
+    def initialize(application:, default_queue:, endpoint:)
+      @application   = application
+      @default_queue = default_queue
+      @endpoint      = endpoint
+    end
+
+    # @param [String] job     - Job name to enqueue.
+    # @param [Object] message - An object which is serializable as JSON.
+    # @param optional [String] queue - A queue name to enqueue a job.
+    # @return [Faraday::Response]
+    def create_execution(job:, message:, queue: nil)
+      params = {
+        application: @application,
+        job:         job,
+        message:     message,
+        queue:       queue || @default_queue,
+      }
+      result = garage_client.post('/v2/job_executions', params)
+      result.response
+    end
+
+    # @param [String] message_id     - Job execution's message_id to retry
+    # @param [Integer] delay_seconds - Retry delay in seconds. Maximum is 900s.
+    # @return [Faraday::Response]
+    def retry_execution(message_id:, delay_seconds: 0)
+      result = garage_client.post(
+        "/v1/job_executions/#{message_id}/retries",
+        delay_seconds: delay_seconds,
+      )
+      result.response
+    end
+
+    # @param [String] message_id - Job execution's message_id to check status
+    # @return [Faraday::Response]
+    def execution(message_id:)
+      result = garage_client.get("/v1/job_executions/#{message_id}")
+      result.response
+    end
+
+    private
+
+    def garage_client
+      @garage_client ||= GarageClient::Client.new(
+        endpoint: @endpoint,
+        path_prefix: '/',
+      )
+    end
+  end
+end

data/lib/barbeque_client/configuration.rb

@@ -0,0 +1,13 @@
+module BarbequeClient
+  class Configuration
+    def initialize
+      @default_queue = 'default'
+    end
+
+    attr_accessor *%i[
+      application
+      default_queue
+      endpoint
+    ]
+  end
+end

data/lib/barbeque_client/executor.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+module BarbequeClient
+  class Executor
+    # @param [String] job - Job class name
+    # @param [String] message - JSON-serialized object
+    # @param [String] message_id - SQS mesasge_id
+    # @param [String] queue_name - barbeque's job_queues.name
+    def initialize(job:, message:, message_id:, queue_name:)
+      @job        = job
+      @message    = JSON.load(message)
+      @message_id = message_id
+      @queue_name = queue_name
+    end
+
+    def run
+      ActiveJob::Base.execute(
+        'job_class'  => @job,
+        'job_id'     => @message_id,
+        'queue_name' => @queue_name,
+        'arguments'  => @message,
+      )
+    end
+  end
+end

data/lib/barbeque_client/exponential_retry.rb

@@ -0,0 +1,30 @@
+module BarbequeClient
+  class ExponentialRetry
+    MAX_DELAY_SECONDS = (ENV['BARBEQUE_MAX_RETRY_DELAY'] || 900).to_i
+
+    # https://github.com/mperham/sidekiq/blob/v4.1.2/lib/sidekiq/middleware/server/retry_jobs.rb#L176-L179
+    # @return [Integer] seconds
+    def self.exponential_backoff(count)
+      (count ** 4) + 15 + (rand(30) * (count + 1))
+    end
+
+    # @param [Integer] count - Count of retry
+    def initialize(count)
+      @count = count
+    end
+
+    # @param [String] message_id
+    def retry(message_id)
+      BarbequeClient.client.retry_execution(
+        message_id:    message_id,
+        delay_seconds: [delay_seconds, MAX_DELAY_SECONDS].min,
+      )
+    end
+
+    private
+
+    def delay_seconds
+      ExponentialRetry.exponential_backoff(@count)
+    end
+  end
+end

data/lib/barbeque_client/railtie.rb

@@ -0,0 +1,12 @@
+ActiveSupport.on_load(:active_job) do
+  require 'active_job/queue_adapters/barbeque_adapter'
+  require 'barbeque_client/retryable'
+end
+
+module BarbequeClient
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'barbeque_client/tasks/execute.rake'
+    end
+  end
+end

data/lib/barbeque_client/retryable.rb

@@ -0,0 +1,28 @@
+require 'barbeque_client/exponential_retry'
+
+module BarbequeClient
+  module Retryable
+    extend ActiveSupport::Concern
+
+    class EmptyRetryCount < StandardError; end
+
+    module ClassMethods
+      def barbeque_retry(limit:, retryable_exceptions: nil)
+        exceptions = Array.wrap(retryable_exceptions || StandardError)
+
+        rescue_from *exceptions do |exception|
+          unless ENV['BARBEQUE_RETRY_COUNT']
+            raise EmptyRetryCount.new('ENV["BARBEQUE_RETRY_COUNT"] is not set')
+          end
+          count = ENV['BARBEQUE_RETRY_COUNT'].to_i
+
+          if count < limit
+            ExponentialRetry.new(count).retry(self.job_id)
+          else
+            raise exception
+          end
+        end
+      end
+    end
+  end
+end

data/lib/barbeque_client/runner.rb

@@ -0,0 +1,42 @@
+require 'sinatra/base'
+require 'securerandom'
+require 'json'
+
+module BarbequeClient
+  # Fake API to run job locally
+  class Runner < Sinatra::Base
+    set :port, ENV['PORT'] || 3003
+
+    post '/v1/job_executions' do
+      params = JSON.parse(request.body.read)
+      spawn(
+        'bundle', 'exec', 'rake', 'barbeque:execute',
+        "BARBEQUE_JOB=#{params['job']}", "BARBEQUE_MESSAGE=#{params['message']}",
+        "BARBEQUE_RETRY_COUNT=0",
+      )
+
+      content_type :json
+      { status: 'pending', message_id: SecureRandom.uuid }.to_json
+    end
+
+    post '/v2/job_executions' do
+      params = JSON.parse(request.body.read)
+      spawn(
+        'bundle', 'exec', 'rake', 'barbeque:execute',
+        "BARBEQUE_JOB=#{params['job']}", "BARBEQUE_MESSAGE=#{params['message'].to_json}",
+        "BARBEQUE_RETRY_COUNT=0",
+      )
+
+      content_type :json
+      { status: 'pending', message_id: SecureRandom.uuid }.to_json
+    end
+
+    post '/v1/job_executions/:message_id/retries' do
+      # TODO: Save message on "/v1/job_executions" and stop skipping retry.
+      puts "Received retry: #{params['message_id']} (retry skipped)"
+
+      content_type :json
+      { status: 'pending', message_id: SecureRandom.uuid }.to_json
+    end
+  end
+end

data/lib/barbeque_client/tasks/execute.rake

@@ -0,0 +1,17 @@
+namespace :barbeque do
+  desc 'Execute ActiveJob task with barbeque envs'
+  task execute: :environment do
+    BarbequeClient::Executor.new(
+      job:        ENV['BARBEQUE_JOB'],
+      message:    ENV['BARBEQUE_MESSAGE'],
+      message_id: ENV['BARBEQUE_MESSAGE_ID'],
+      queue_name: ENV['BARBEQUE_QUEUE_NAME'],
+    ).run
+  end
+
+  desc 'Start a fake barbeque API for development'
+  task :runner do
+    require 'barbeque_client/runner'
+    BarbequeClient::Runner.run!
+  end
+end

data/lib/barbeque_client/version.rb

@@ -0,0 +1,3 @@
+module BarbequeClient
+  VERSION = '0.8.0'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: barbeque_client
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Takashi Kokubun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: garage_client
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Barbeque client for Ruby
+email:
+- takashi-kokubun@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- barbeque.gemspec
+- bin/console
+- bin/setup
+- lib/active_job/queue_adapters/barbeque_adapter.rb
+- lib/barbeque_client.rb
+- lib/barbeque_client/client.rb
+- lib/barbeque_client/configuration.rb
+- lib/barbeque_client/executor.rb
+- lib/barbeque_client/exponential_retry.rb
+- lib/barbeque_client/railtie.rb
+- lib/barbeque_client/retryable.rb
+- lib/barbeque_client/runner.rb
+- lib/barbeque_client/tasks/execute.rake
+- lib/barbeque_client/version.rb
+homepage: https://github.com/cookpad/barbeque_client
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Barbeque client for Ruby
+test_files: []