shinq 0.0.1.alpha1 → 0.0.1

checksums.yaml

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1
+gemfile:
+  - Gemfile
+before_install:
+  - mysql -e "create database IF NOT EXISTS shinq_test;" -uroot
+  - mysql -e "use shinq_test; create table queue_test (job_id varchar(255) not null, title varchar(255), enqueued_at datetime not null) ENGINE=QUEUE;" -uroot
+script: bundle exec rspec

data/README.md

@@ -1,4 +1,5 @@
 # Shinq
+[![Build Status](https://travis-ci.org/ryopeko/shinq.svg)](https://travis-ci.org/ryopeko/shinq)
 
 Worker and enqueuer for Q4M using the interface of ActiveJob.
 

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

@@ -3,7 +3,11 @@ module ActiveJob
     class ShinqAdapter
       class << self
         def enqueue(job)
-          Shinq::Client.enqueue(table_name: job.queue_name, args: job.arguments)
+          Shinq::Client.enqueue(
+            table_name: job.queue_name,
+            job_id: job.job_id,
+            args: job.arguments.first
+          )
         end
       end
     end

data/lib/shinq/cli.rb

@@ -2,65 +2,94 @@ require 'optparse'
 require 'yaml'
 require 'shinq'
 require 'shinq/launcher'
+require 'shinq/configuration'
+require 'serverengine'
 
 module Shinq
   class OptionParseError < StandardError; end
 
   class CLI
     def initialize(args=ARGV)
-      parse_options(args)
-      setup_db_config
+      setup_option(args)
       bootstrap
     end
 
+    def setup_option(args)
+      opts = parse_options(args)
+
+      Shinq.configuration = Shinq::Configuration.new(opts)
+    end
+
     def parse_options(args)
-      @opts = {}
+      opts = {}
       parser = OptionParser.new do |opt|
-        opt.on('--worker VALUE') do |v|
-          @opts[:worker_name] = v
+        opt.on('-d', '--daemon') do |v|
+          opts[:daemonize] = v
+        end
+
+        opt.on('--worker value') do |v|
+          opts[:worker_name] = v
+        end
+
+        opt.on('--process VALUE') do |v|
+          opts[:process] = v.to_i
+        end
+
+        opt.on('--queue-timeout VALUE') do |v|
+          opts[:queue_timeout] = v.to_i
         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)
+          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]
+          raise OptionParseError, "#{v}'s settings does not exist" unless opts[:db_config][v]
+          opts[:queue_db] = v
         end
 
         opt.on('--require VALUE') do |v|
-          @opts[:require] = v
+          opts[:require] = v
+        end
+
+        opt.on('-v', '--version') do |v|
+          puts "Shinq #{Shinq::VERSION}"
+          exit(0)
         end
       end
 
       parser.parse!(args)
-      @opts
+      opts
     end
 
-    def setup_db_config
-      Shinq.default_db = @opts[:queue_db]
-      Shinq.db_config = @opts[:db_config]
+    def options
+      Shinq.configuration
     end
 
     def bootstrap
-      return unless @opts[:require]
+      target = options.require
 
-      if File.directory?(@opts[:require])
+      if File.directory?(target)
         require 'rails'
-        require File.expand_path("#{@opts[:require]}/config/application.rb")
+        require File.expand_path("#{target}/config/application.rb")
 
         require 'shinq/rails'
-        require File.expand_path("#{@opts[:require]}/config/environment.rb")
+        require File.expand_path("#{target}/config/environment.rb")
       else
-        require @opts[:require]
+        require target
       end
     end
 
     def run
-      Shinq::Launcher.new(@opts[:worker_name]).run
+      se = ServerEngine.create(nil, Shinq::Launcher, {
+        daemonize: options.daemonize,
+        worker_type: 'process',
+        pid_file: 'shinq.pid',
+        workers: options.process
+      })
+
+      se.run
     end
   end
 end

data/lib/shinq/client.rb

@@ -1,36 +1,38 @@
 require 'sql-maker'
+require 'sql/maker/quoting'
+require 'active_support/core_ext/hash/keys'
 
 module Shinq
   class Client
     def self.builder
-      @builder ||= SQL::Maker.new(driver: 'mysql')
+      @builder ||= SQL::Maker.new(driver: 'mysql', auto_bind: true)
     end
 
-    def self.enqueue(table_name: , args:)
+    def self.enqueue(table_name: , job_id: , 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
+        sql = builder.insert(table_name, args.merge(
+          job_id: job_id,
+          enqueued_at: Time.now
+        ))
+        Shinq.connection.query(sql)
       else
-        raise ArgumentError, "queue should be Array[Hash] or Hash"
+        raise ArgumentError, "Queue should be Hash"
       end
     end
 
     def self.dequeue(table_name:)
-      has_queue = Shinq.connection.xquery('select queue_wait(?)', table_name)
+      quoted = SQL::Maker::Quoting.quote(table_name)
+      queue_timeout_quoted = SQL::Maker::Quoting.quote(Shinq.configuration.queue_timeout)
 
-      if has_queue
-        sql = builder.select(table_name, ['*']).first
-        results = Shinq.connection.xquery(sql)
-      end
+      wait_query = "queue_wait(#{quoted}, #{queue_timeout_quoted})"
+      has_queue = Shinq.connection.query("select #{wait_query}").first
 
-      results.first
+      unless has_queue[wait_query].to_i == 0
+        sql = builder.select(table_name, ['*'])
+        results = Shinq.connection.query(sql)
+        return results.first.symbolize_keys
+      end
     end
 
     def self.done

data/lib/shinq/configuration.rb

@@ -0,0 +1,29 @@
+module Shinq
+  class ConfigurationError < StandardError; end
+
+  class Configuration
+    attr_accessor :require, :worker_name, :db_config, :queue_db, :default_db, :process, :queue_timeout, :daemonize
+
+    DEFAULT = {
+      require: '.',
+      process: 1,
+      queue_timeout: 1,
+      daemonize: false
+    }
+
+    def initialize(opts)
+      %i(require worker_name db_config queue_db default_db process queue_timeout daemonize).each do |k|
+        send(:"#{k}=", opts[k] || DEFAULT[k])
+      end
+    end
+
+    def default_db_config
+      raise ConfigurationError if !(default_db && db_defined?(default_db))
+      db_config[default_db]
+    end
+
+    def db_defined?(db_name)
+      !!(db_config && db_config[db_name])
+    end
+  end
+end

data/lib/shinq/launcher.rb

@@ -2,23 +2,29 @@ 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
-
+  module Launcher
     def run
-      queue = Shinq::Client.dequeue(table_name: @worker_name.pluralize)
+      worker_name = Shinq.configuration.worker_name
+      worker_class = worker_name.camelize.constantize
+
+      until @stop
+        queue = Shinq::Client.dequeue(table_name: worker_name.pluralize)
+        #TODO use logger
+        next p "Queue is empty (#{Time.now})" unless queue
 
-      begin
-        @worker_class.new.perform(queue)
-      rescue => e
-        Shinq::Client.abort
-        raise
+        begin
+          worker_class.new.perform(queue)
+        rescue => e
+          Shinq::Client.abort
+          raise
+        end
+
+        Shinq::Client.done
       end
+    end
 
-      Shinq::Client.done
+    def stop
+      @stop = true
     end
   end
 end

data/lib/shinq/rails.rb

@@ -7,8 +7,8 @@ module Shinq
     end
 
     def self.rails_bootstrap
-      Shinq.db_config = ActiveRecord::Base.configurations
-      Shinq.default_db = ::Rails.env
+      Shinq.configuration.db_config = ActiveRecord::Base.configurations
+      Shinq.configuration.default_db = ::Rails.env
     end
   end
 end

data/lib/shinq.rb

@@ -1,33 +1,34 @@
-require "mysql2-cs-bind"
+require 'mysql2'
 require 'shinq/client'
+require 'shinq/configuration'
 
 module Shinq
   VERSION = Gem.loaded_specs['shinq'].version.to_s
 
-  def self.db_config=(config)
-    @db_config = config
-    @connections = {}
+  def self.configuration=(config)
+    @configuration = case config
+    when Shinq::Configuration
+      config
+    else
+      Shinq::Configuration.new(config)
+    end
   end
 
-  def self.db_config
-    @db_config
-  end
-
-  def self.default_db=(db_name)
-    @default_db = db_name
+  def self.configuration
+    @configuration ||= Shinq::Configuration.new({})
   end
 
   def self.default_db
-    @default_db || ENV['RACK_ENV'] || ENV['RAILS_ENV']
+    self.configuration.default_db ||= ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
   end
 
-
   def self.setup_db_connection(db_name)
-    @connection ||= {}
-    @connections[db_name] = Mysql2::Client.new(db_config[db_name])
+    raise Shinq::ConfigurationError unless self.configuration.db_defined?(db_name)
+    @connections[db_name] = Mysql2::Client.new(self.configuration.db_config[db_name])
   end
 
-  def self.connection(db_name: default_db)
+  def self.connection(db_name: self.default_db)
+    @connections ||= {}
     @connections[db_name] ||= setup_db_connection(db_name)
   end
 end

data/shinq.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "shinq"
-  spec.version       = '0.0.1.alpha1'
+  spec.version       = '0.0.1'
   spec.authors       = ["Ryoichi SEKIGUCHI"]
   spec.email         = ["ryopeko@gmail.com"]
   spec.summary       = %q{Worker and enqueuer for Q4M using the interface of ActiveJob.}
@@ -19,8 +19,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "tapp"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "simplecov"
 
-  spec.add_dependency "mysql2-cs-bind", "~>  0.0.6"
+  spec.add_dependency "mysql2", "~> 0.3.16"
   spec.add_dependency "sql-maker", "~> 0.0.4"
   spec.add_dependency "activesupport", "~> 4.2.0.beta2"
+  spec.add_dependency 'serverengine', '~> 1.5.9'
 end

data/spec/config/database.yml

@@ -0,0 +1,5 @@
+test:
+  encoding: utf8
+  username: root
+  host: localhost
+  database: shinq_test

data/spec/integration_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'shinq'
+require 'shinq/client'
+
+describe "Integration" do
+  before do
+    load_database_config(Shinq)
+  end
+
+  context "When create queue", skip: ENV['TRAVIS'] do
+    let(:queue_table) { 'queue_test' }
+    let(:args) { {title: 'foo'} }
+
+    before do
+      Shinq::Client.enqueue(
+        table_name: queue_table,
+        job_id: 'jobid',
+        args: args
+      )
+
+      @queue = Shinq::Client.dequeue(table_name: queue_table)
+      Shinq::Client.done
+    end
+
+    it { expect(@queue[:title]).to eq args[:title] }
+  end
+end

data/spec/shinq/configuration_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'shinq/configuration'
+
+describe Shinq::Configuration do
+  describe "accessors" do
+    subject { Shinq::Configuration.new({}) }
+
+    it { is_expected.to respond_to(:require) }
+    it { is_expected.to respond_to(:worker_name) }
+    it { is_expected.to respond_to(:db_config) }
+    it { is_expected.to respond_to(:queue_db) }
+    it { is_expected.to respond_to(:default_db) }
+    it { is_expected.to respond_to(:process) }
+    it { is_expected.to respond_to(:queue_timeout) }
+  end
+
+  describe ".new" do
+    context "when key does not have a accessor method" do
+      let(:configuration) { Shinq::Configuration.new(undefined_key_name: 'foo') }
+
+      it { expect {configuration.undefined_key_name}.to raise_error(NoMethodError) }
+    end
+
+    context "when key has a accessor method" do
+      let(:configuration) { Shinq::Configuration.new(worker_name: 'foo') }
+
+      it { expect {configuration.worker_name}.not_to raise_error() }
+    end
+  end
+
+  describe "#default_db_config" do
+    context "when default_db is present" do
+      let(:configuration) { Shinq::Configuration.new({}) }
+
+      it {expect { configuration.default_db_config }.to raise_error(Shinq::ConfigurationError)}
+    end
+
+    context "when default_db's config is present" do
+      let(:configuration) { Shinq::Configuration.new(default_db: :foo) }
+
+      it {expect { configuration.default_db_config }.to raise_error(Shinq::ConfigurationError)}
+    end
+
+    context "when default_db's config is present" do
+      let(:configuration) { Shinq::Configuration.new(default_db: :test) }
+
+      it {expect { configuration.default_db_config }.to raise_error(Shinq::ConfigurationError)}
+    end
+  end
+
+  describe "#db_defined?" do
+    context "when db_config is present" do
+      let (:configuration) { Shinq::Configuration.new({}) }
+
+      it { expect(configuration.db_defined?(:test)).to be false }
+    end
+
+    context "when db_config is not present" do
+      context "when db_config does not have a value by specified key" do
+        let (:configuration) {
+          Shinq::Configuration.new(
+            db_config: {
+              test: 'foo'
+            }
+          )
+        }
+
+        it { expect(configuration.db_defined?(:foo)).to be false }
+      end
+
+      context "when db_config has a value by specified key" do
+        let (:configuration) {
+          Shinq::Configuration.new(
+            db_config: {
+              test: 'foo'
+            }
+          )
+        }
+
+        it { expect(configuration.db_defined?(:test)).to be true }
+      end
+    end
+  end
+end

data/spec/shinq_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'shinq'
+require 'shinq/configuration'
+
+def shinq_class
+  Shinq.dup
+end
+
+describe Shinq do
+  subject { shinq_class }
+
+  it { is_expected.to respond_to(:configuration) }
+  it { is_expected.to respond_to(:configuration=) }
+
+  describe ".configuration" do
+    context "when configuration is not present" do
+      let(:shinq) { shinq_class }
+
+      it { expect(shinq.configuration).to be_a_kind_of(Shinq::Configuration) }
+    end
+
+    context "when configuration is present" do
+      let(:shinq) {
+        shinq_class.tap {|s|
+          s.configuration = Hash.new
+        }
+      }
+
+      it { expect(shinq.configuration).to be_a_kind_of(Shinq::Configuration) }
+    end
+  end
+
+  describe ".configuration=" do
+    context "when specify args" do
+      let(:shinq) { shinq_class }
+      let(:args) { Hash.new }
+
+      it 'is expect to return specified args' do
+        expect(shinq.configuration=(args)).to eq args
+      end
+    end
+  end
+
+  describe ".connection" do
+    context "when db_config is present" do
+      let(:shinq) { shinq_class }
+
+      it { expect{ shinq.connection(db_name: :unknown) }.to raise_error(Shinq::ConfigurationError) }
+    end
+
+    context "when db_config is not preset" do
+      let(:shinq) {
+        shinq_class.tap {|s|
+          load_database_config(s)
+        }
+      }
+
+      it { expect(shinq.connection(db_name: :test)).to be_a_kind_of(Mysql2::Client) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rspec/mocks/standalone'
+require 'simplecov'
+require 'yaml'
+require 'active_support/core_ext/hash'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter
+]
+
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.full_backtrace = true
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end
+
+def load_database_config(klass)
+  db_config = YAML.load_file(File.expand_path('./config/database.yml', __dir__)).symbolize_keys
+  klass.configuration = {
+    db_config: db_config,
+    default_db: :test
+  }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shinq
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha1
+  version: 0.0.1
 platform: ruby
 authors:
 - Ryoichi SEKIGUCHI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2-cs-bind
+  name: tapp
+  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: rspec-mocks
+  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: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.3.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.3.16
 - !ruby/object:Gem::Dependency
   name: sql-maker
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0.beta2
+- !ruby/object:Gem::Dependency
+  name: serverengine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.9
 description: 
 email:
 - ryopeko@gmail.com
@@ -103,6 +173,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -112,9 +184,15 @@ files:
 - lib/shinq/active_job/queue_adapters/shinq_adapter.rb
 - lib/shinq/cli.rb
 - lib/shinq/client.rb
+- lib/shinq/configuration.rb
 - lib/shinq/launcher.rb
 - lib/shinq/rails.rb
 - shinq.gemspec
+- spec/config/database.yml
+- spec/integration_spec.rb
+- spec/shinq/configuration_spec.rb
+- spec/shinq_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/ryopeko/shinq
 licenses:
 - MIT
@@ -130,13 +208,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 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: []
+test_files:
+- spec/config/database.yml
+- spec/integration_spec.rb
+- spec/shinq/configuration_spec.rb
+- spec/shinq_spec.rb
+- spec/spec_helper.rb