pgjob 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+script:
+  - bundle exec rake db:prepare && bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# ChangeLog
+
+## PGJob 0.1.0 (July 8, 2012)
+
+* First public release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alexey Vakhov
+
+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,6 @@
+# PGJob
+
+Custom delayed jobs on pure PosgreSQL.
+
+[<img src="https://secure.travis-ci.org/avakhov/pgjob.png"/>](http://travis-ci.org/avakhov/pgjob)
+

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+def exec(cmd); puts "[exec] #{cmd}"; system cmd; end
+
+namespace :db do
+  desc "prepare db for specs"
+  task "prepare" do
+    exec "createdb pgjob_test"
+  end
+end

data/lib/pgjob/job.rb

@@ -0,0 +1,155 @@
+module PGJob
+  class Job
+    # Initialize with AR::connection or attributes for PG.connect
+    def initialize(*args, &block)
+      if args.first.respond_to?(:exec)
+        @conn = args.first
+        @can_finish = false
+      else
+        @conn = PG.connect(*args)
+        @can_finish = true
+      end
+
+      if block_given?
+        block.call(self)
+        finish!
+      end
+    end
+
+    # Creates jobs table
+    def migrate!
+      unless tables.include?('jobs')
+        @conn.exec <<-SQL
+          CREATE TABLE jobs (
+            id SERIAL,
+            name character varying(255),
+            params text,
+            status character varying(20),
+            log text
+          );
+        SQL
+      end
+    end
+
+    # Destroys jobs table
+    def rollback!
+      @conn.exec <<-SQL
+        DROP TABLE IF EXISTS jobs;
+      SQL
+    end
+
+    # Closes connection if possible
+    def finish!
+      if @can_finish
+        @conn.finish
+      end
+    end
+
+    # Creates new job
+    def create(name, params = {})
+      assert_symbol_keys!(params)
+
+      sql = <<-SQL
+        INSERT INTO jobs(name, params, status)
+        VALUES('#{@conn.escape(name)}', '#{@conn.escape JSON.dump(params)}', 'wait')
+        RETURNING id;
+      SQL
+      @conn.exec(sql).to_a.first['id'].to_i
+    end
+
+    # Returns name
+    def name(id)
+      sql = <<-SQL
+        SELECT name
+        FROM jobs
+        WHERE id = #{id};
+      SQL
+      @conn.exec(sql).to_a.first['name']
+    end
+
+    # Sets/Returns status
+    def status(id, value = nil)
+      if value
+        raise "wrong value" unless [:wait, :running, :success, :failed].include?(value.to_sym)
+        sql = <<-SQL
+          UPDATE jobs
+          SET status = '#{@conn.escape value.to_s}'
+          WHERE id = #{id};
+        SQL
+        @conn.exec(sql)
+      else
+        sql = <<-SQL
+          SELECT status
+          FROM jobs
+          WHERE id = #{id};
+        SQL
+        @conn.exec(sql).to_a.first['status'].to_sym
+      end
+    end
+
+    # Returns params
+    def params(id)
+      sql = <<-SQL
+        SELECT params
+        FROM jobs
+        WHERE id = #{id};
+      SQL
+      symbolize_keys JSON.load(@conn.exec(sql).to_a.first['params'])
+    end
+
+    # Returns full log
+    def log(id)
+      sql = <<-SQL
+        SELECT log
+        FROM jobs
+        WHERE id = #{id};
+      SQL
+      @conn.exec(sql).to_a.first['log']
+    end
+
+    # Adds log message
+    def add_log(id, msg)
+      sql = <<-SQL
+        UPDATE jobs
+        SET log = '#{@conn.escape [log(id), msg].compact.join("\n")}'
+        WHERE id = #{id};
+      SQL
+      @conn.exec(sql)
+    end
+
+    private
+    def assert_symbol_keys!(hash)
+      hash.each do |key, value|
+        unless key.is_a?(Symbol)
+          raise "#{key} should be symbol"
+        end
+
+        if value.is_a?(Hash)
+          assert_symbol_keys!(value)
+        end
+      end
+    end
+
+    def symbolize_keys(hash)
+      out = {}
+      hash.each do |key, value|
+        if value.is_a?(Hash)
+          out[key.to_sym] = symbolize_keys(value)
+        else
+          out[key.to_sym] = value
+        end
+      end
+      out
+    end
+                           
+    def tables
+      sql = <<-SQL
+        SELECT table_name
+        FROM information_schema.tables
+        WHERE table_schema = 'public';
+      SQL
+
+      @conn.exec(sql).map { |r| r['table_name'] }
+    end
+  end
+end

data/lib/pgjob/version.rb

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

data/lib/pgjob.rb

@@ -0,0 +1,4 @@
+require 'pgjob/version'
+require 'pg'
+require 'json'
+require 'pgjob/job'

data/pgjob.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pgjob/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alexey Vakhov"]
+  gem.email         = ["vakhov@gmail.com"]
+  gem.description   = %q{PgJob}
+  gem.summary       = %q{Pure PostgreSQL Job}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "pgjob"
+  gem.require_paths = ["lib"]
+  gem.version       = PGJob::VERSION
+
+  gem.add_dependency 'pg'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/spec/job_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe PGJob::Job do
+  before do
+    @job = PGJob::Job.new(dbname: 'pgjob_test')
+  end
+
+  after do
+    @job.finish!
+  end
+
+  describe '#create' do
+    it 'success' do
+      id = @job.create("test", key: 'value')
+      id.should > 0
+      id.should be_kind_of(Fixnum)
+    end
+
+    it 'accepts only symbol keys' do
+      -> {
+        @job.create("test", 'key' => 'value')
+      }.should raise_error
+
+      -> {
+        @job.create("test", :hash => {'key' => 'value'})
+      }.should raise_error
+    end
+  end
+
+  describe '#status' do
+    it 'returns' do
+      id = @job.create("test", key: 'value')
+      @job.status(id).should == :wait
+    end
+
+    it 'sets' do
+      id = @job.create("test", key: 'value')
+      @job.status(id, :running)
+      @job.status(id).should == :running
+    end
+  end
+
+  it '#name' do
+    id = @job.create("test", key: 'value')
+    @job.name(id).should == 'test'
+  end
+
+  describe '#params' do
+    it 'returns' do
+      id = @job.create("test", key: 'value')
+      @job.params(id).should == {key: 'value'}
+    end
+
+    it 'returns integer values' do
+      id = @job.create("test", key: 1054)
+      @job.params(id).should == {key: 1054}
+    end
+
+    it 'symbolizes all keys' do
+      id = @job.create("test", hash: {key: 1054})
+      @job.params(id).should == {hash: {key: 1054}}
+    end
+  end
+
+  describe '#log' do
+    it "success" do
+      id = @job.create("test")
+      @job.add_log(id, 'msg1')
+      @job.add_log(id, 'msg2')
+      @job.log(id).should == "msg1\nmsg2"
+    end
+
+    it 'escape' do
+      id = @job.create("test")
+      hard = ['"', "'", '#', '@', '!', "\n"].join
+      @job.add_log(id, hard)
+      @job.log(id).should == hard
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../../lib/pgjob", __FILE__)
+
+RSpec.configure do |config|
+  config.before(:all) do
+    PGJob::Job.new(dbname: 'pgjob_test') { |job| job.migrate! }
+  end
+
+  config.after(:all) do
+    PGJob::Job.new(dbname: 'pgjob_test') { |job| job.rollback! }
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: pgjob
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alexey Vakhov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PgJob
+email:
+- vakhov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pgjob.rb
+- lib/pgjob/job.rb
+- lib/pgjob/version.rb
+- pgjob.gemspec
+- spec/job_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Pure PostgreSQL Job
+test_files:
+- spec/job_spec.rb
+- spec/spec_helper.rb