shinq 0.0.1.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dc7ce36cb2fc9173d2ba088c3a6786adf715318
+  data.tar.gz: b3230473df8c6a018af822d8f596c0643565b455
+SHA512:
+  metadata.gz: 5a684c09a3e04352ab2186b70c50b5f12f5d2c1fa189bd050bf225819255fa999ca33c7667d49c956d96c6f2452bddbe8b153ed3fe33bde1bdd436d42c48c29b
+  data.tar.gz: eb33a3f9c85156db99f1ab4bf2a9f3fe89210505395487deaba696d286cb23ac24090c387d7c8079577048604da5bb374aa64c8f17d0c65673705a753bc2fc34

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryoichi SEKIGUCHI
+
+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,57 @@
+# Shinq
+
+Worker and enqueuer for Q4M using the interface of ActiveJob.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shinq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shinq
+
+[Install Q4M](http://q4m.github.io/install.html)
+
+## Usage
+
+### Initialize
+```ruby
+Rails.application.configure do
+  config.active_job.queue_adapter = :shinq
+end
+```
+
+### Worker
+```ruby
+class FooWorker < ActiveJob::Base
+  aueue_as :my_queues #name of queue table
+
+  def perform(args)
+    #perform asynchronous
+  end
+end
+```
+
+### Enqueue
+```ruby
+FooWorker.perform_later(foo: 'bar', baz: 'qux')
+```
+
+### Worker execution
+TBD
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/shinq/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 a new Pull Request

data/Rakefile

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

data/bin/shinq

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/shinq/cli'
+
+Shinq::CLI.new.run
+
+

data/lib/shinq/active_job/queue_adapters/shinq_adapter.rb

@@ -0,0 +1,11 @@
+module ActiveJob
+  module QueueAdapters
+    class ShinqAdapter
+      class << self
+        def enqueue(job)
+          Shinq::Client.enqueue(table_name: job.queue_name, args: job.arguments)
+        end
+      end
+    end
+  end
+end

data/lib/shinq/cli.rb

@@ -0,0 +1,66 @@
+require 'optparse'
+require 'yaml'
+require 'shinq'
+require 'shinq/launcher'
+
+module Shinq
+  class OptionParseError < StandardError; end
+
+  class CLI
+    def initialize(args=ARGV)
+      parse_options(args)
+      setup_db_config
+      bootstrap
+    end
+
+    def parse_options(args)
+      @opts = {}
+      parser = OptionParser.new do |opt|
+        opt.on('--worker VALUE') do |v|
+          @opts[:worker_name] = v
+        end
+
+        opt.on('--db-config VALUE') do |v|
+          raise OptionParseError, "#{v} does not exist" unless File.exist?(v)
+          @opts[:db_config] = YAML.load_file(v)
+        end
+
+        opt.on('--queue-database VALUE') do |v|
+          raise OptionParseError, "#{v}'s settings does not exist" unless @opts[:db_config][v]
+          @opts[:queue_db] = v
+          @opts[:queue_db_settings] = @opts[:db_config][v]
+        end
+
+        opt.on('--require VALUE') do |v|
+          @opts[:require] = v
+        end
+      end
+
+      parser.parse!(args)
+      @opts
+    end
+
+    def setup_db_config
+      Shinq.default_db = @opts[:queue_db]
+      Shinq.db_config = @opts[:db_config]
+    end
+
+    def bootstrap
+      return unless @opts[:require]
+
+      if File.directory?(@opts[:require])
+        require 'rails'
+        require File.expand_path("#{@opts[:require]}/config/application.rb")
+
+        require 'shinq/rails'
+        require File.expand_path("#{@opts[:require]}/config/environment.rb")
+      else
+        require @opts[:require]
+      end
+    end
+
+    def run
+      Shinq::Launcher.new(@opts[:worker_name]).run
+    end
+  end
+end

data/lib/shinq/client.rb

@@ -0,0 +1,44 @@
+require 'sql-maker'
+
+module Shinq
+  class Client
+    def self.builder
+      @builder ||= SQL::Maker.new(driver: 'mysql')
+    end
+
+    def self.enqueue(table_name: , args:)
+      case args
+      when Hash
+        sql, bind = builder.insert(table_name, args)
+        Shinq.connection.xquery(sql, bind)
+      when Array
+        args.each do |queue|
+          sql, bind = builder.insert(table_name, queue)
+
+          Shinq.connection.xquery(sql, bind)
+        end
+      else
+        raise ArgumentError, "queue should be Array[Hash] or Hash"
+      end
+    end
+
+    def self.dequeue(table_name:)
+      has_queue = Shinq.connection.xquery('select queue_wait(?)', table_name)
+
+      if has_queue
+        sql = builder.select(table_name, ['*']).first
+        results = Shinq.connection.xquery(sql)
+      end
+
+      results.first
+    end
+
+    def self.done
+      Shinq.connection.query('select queue_end()')
+    end
+
+    def self.abort
+      Shinq.connection.query('select queue_abort()')
+    end
+  end
+end

data/lib/shinq/launcher.rb

@@ -0,0 +1,24 @@
+require 'shinq/client'
+require 'active_support/inflector'
+
+module Shinq
+  class Launcher
+    def initialize(worker_name)
+      @worker_name = worker_name
+      @worker_class = @worker_name.camelize.constantize
+    end
+
+    def run
+      queue = Shinq::Client.dequeue(table_name: @worker_name.pluralize)
+
+      begin
+        @worker_class.new.perform(queue)
+      rescue => e
+        Shinq::Client.abort
+        raise
+      end
+
+      Shinq::Client.done
+    end
+  end
+end

data/lib/shinq/rails.rb

@@ -0,0 +1,14 @@
+require 'shinq/active_job/queue_adapters/shinq_adapter'
+
+module Shinq
+  class Rails < ::Rails::Engine
+    initializer :shinq do
+      Shinq::Rails.rails_bootstrap
+    end
+
+    def self.rails_bootstrap
+      Shinq.db_config = ActiveRecord::Base.configurations
+      Shinq.default_db = ::Rails.env
+    end
+  end
+end

data/lib/shinq.rb

@@ -0,0 +1,35 @@
+require "mysql2-cs-bind"
+require 'shinq/client'
+
+module Shinq
+  VERSION = Gem.loaded_specs['shinq'].version.to_s
+
+  def self.db_config=(config)
+    @db_config = config
+    @connections = {}
+  end
+
+  def self.db_config
+    @db_config
+  end
+
+  def self.default_db=(db_name)
+    @default_db = db_name
+  end
+
+  def self.default_db
+    @default_db || ENV['RACK_ENV'] || ENV['RAILS_ENV']
+  end
+
+
+  def self.setup_db_connection(db_name)
+    @connection ||= {}
+    @connections[db_name] = Mysql2::Client.new(db_config[db_name])
+  end
+
+  def self.connection(db_name: default_db)
+    @connections[db_name] ||= setup_db_connection(db_name)
+  end
+end
+
+require 'shinq/rails' if defined?(::Rails::Engine)

data/shinq.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "shinq"
+  spec.version       = '0.0.1.alpha1'
+  spec.authors       = ["Ryoichi SEKIGUCHI"]
+  spec.email         = ["ryopeko@gmail.com"]
+  spec.summary       = %q{Worker and enqueuer for Q4M using the interface of ActiveJob.}
+  spec.homepage      = "https://github.com/ryopeko/shinq"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "mysql2-cs-bind", "~>  0.0.6"
+  spec.add_dependency "sql-maker", "~> 0.0.4"
+  spec.add_dependency "activesupport", "~> 4.2.0.beta2"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: shinq
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha1
+platform: ruby
+authors:
+- Ryoichi SEKIGUCHI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: mysql2-cs-bind
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: sql-maker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0.beta2
+description: 
+email:
+- ryopeko@gmail.com
+executables:
+- shinq
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/shinq
+- lib/shinq.rb
+- lib/shinq/active_job/queue_adapters/shinq_adapter.rb
+- lib/shinq/cli.rb
+- lib/shinq/client.rb
+- lib/shinq/launcher.rb
+- lib/shinq/rails.rb
+- shinq.gemspec
+homepage: https://github.com/ryopeko/shinq
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Worker and enqueuer for Q4M using the interface of ActiveJob.
+test_files: []