hawking 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dc5cdf9adf6ca786efe48dbd040d7b00583f5b9
+  data.tar.gz: 80267e423e17f81fa36649c31bdf1a1d4f37a71c
+SHA512:
+  metadata.gz: 0252cd0ee608b20e548627af88bb68c135bba7cf2bc77866f52240e9c865a1a005db59273f9254e03bea9314ced2a7cf1e73df00a893915131f561ff2a03ecd5
+  data.tar.gz: 0dbbd239b80976bec8b258e72940ee36588e83a4c94960c9ad59e7c777cf451f274c0b5e4001ea9d09eef963326595b1d05c24847cbc9d2aafddb3fd0598ad81

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    hawking (0.1)
+      json_pure
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    json_pure (1.8.1)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hawking!
+  rake
+  rspec

data/README.md

@@ -0,0 +1,75 @@
+Hawking
+=======
+
+[![Build Status](https://travis-ci.org/rogeriozambon/hawking.png?branch=master)](https://travis-ci.org/rogeriozambon/hawking)
+[![Code Climate](https://codeclimate.com/github/rogeriozambon/hawking.png)](https://codeclimate.com/github/rogeriozambon/hawking)
+
+Background job queueing using Socket. Inspired in the [Stalkeg gem](https://github.com/han/stalker).
+
+Queueing jobs
+-------------
+
+From anywhere in your app:
+
+    require 'hawking'
+
+    Hawking::Queue.new('email.send', :to => 'joe@example.com')
+    Hawking::Queue.new('post.cleanup', :id => post.id)
+
+Working jobs
+------------
+
+In a standalone file, typically jobs.rb or worker.rb:
+
+    require 'hawking'
+
+    extend Hawking
+
+    job 'email.send' do |args|
+      Pony.send(:to => args['to'], :subject => "Hello there")
+    end
+
+    job 'post.cleanup' do |args|
+      Post.find(args['id']).cleanup
+    end
+
+Running
+-------
+
+Hawking:
+
+    $ sudo gem install hawking
+
+Now run a worker using the stalk binary:
+
+    $ hawking jobs.rb
+    Working 2 jobs: [ email.send post.cleanup ]
+    Working send.email (email=hello@example.com)
+
+Hawk will log to stdout as it starts working each job.
+
+Filter to a list of jobs you wish to run with an argument:
+
+    $ hawking jobs.rb email.send
+    Working 1 jobs: [ email.send ]
+
+Running the tests
+-----------------
+
+    $ rake spec
+
+Maintainer
+----------
+
+* Rogério Zambon (http://rogerio.me)
+
+Licence
+-------
+
+(The 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/Rakefile

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

data/bin/hawking

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+STDERR.sync = STDOUT.sync = true
+
+require "hawking"
+extend Hawking
+
+usage = "hawking <jobs.rb> [<job>[,<job>,..]]"
+
+file = ARGV.shift or abort usage
+jobs = ARGV.shift.split(',') rescue nil
+
+file = "./#{file}" unless file.match(/^[\/.]/)
+
+require file
+
+trap("INT") do
+  puts "\rExiting"
+  exit
+end
+
+Hawking.run

data/examples/enqueue.rb

@@ -0,0 +1,4 @@
+require "hawking"
+
+hawking = Hawking::Queue.new
+hawking.put "send.email", :email => "hello@example.com"

data/examples/jobs.rb

@@ -0,0 +1,3 @@
+job "send.email" do |data|
+  puts "Sending email to #{data[:email]}"
+end

data/hawking.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "hawking"
+
+Gem::Specification.new do |s|
+  s.name          = "hawking"
+  s.version       = Hawking::VERSION
+  s.platform      = Gem::Platform::RUBY
+
+  s.authors       = ["Rogério Zambon"]
+  s.email         = ["rogeriozambon@gmail.com"]
+  s.homepage      = "http://github.com/rogeriozambon/hawking"
+  s.summary       = "Background job queueing using Socket. Inspired in the Stalkeg gem."
+  s.description   = s.summary
+
+  s.executables   = ["hawking"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "json_pure"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/lib/hawking.rb

@@ -0,0 +1,56 @@
+require "socket"
+require "json"
+require "timeout"
+
+module Hawking
+  extend self
+
+  VERSION = "0.1"
+
+  def run
+    puts "Working #{@@jobs.size} jobs: [ #{@@jobs.keys.join(' ')} ]"
+
+    server = TCPServer.open "127.0.0.1", 4481
+
+    loop { work_jobs server }
+  end
+
+  def work_jobs(server)
+    Thread.start(server.accept) do |listener|
+      job = JSON.parse listener.gets, symbolize_names: true
+
+      puts "Working on #{job[:queue]} (#{job[:data]})"
+
+      begin
+        Timeout::timeout(120) do
+          handler = @@jobs[job[:queue]]
+          handler.call(job[:data])
+        end
+      rescue Timeout::Error
+        raise "The job hit 120 seconds timeout"
+      end
+    end
+  end
+
+  def job(queue, &block)
+    @@jobs ||= {}
+    @@jobs[queue] = block
+  end
+
+  def jobs
+    @@jobs
+  end
+
+  class Queue
+    def initialize
+      @socket = TCPSocket.open "127.0.0.1", 4481
+    end
+
+    def put(queue, data)
+      info = JSON.generate :queue => queue, :data => data
+
+      @socket.write info
+      @socket.close
+    end
+  end
+end

data/spec/hawking_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe "Hawking" do
+  before do
+    $stdout.stub(:write).and_return ""
+  end
+
+  it "storing a job" do
+    Hawking.job "example" do |data|
+      puts "Some example with #{data}"
+    end
+
+    jobs = Hawking.jobs
+
+    jobs.should be_a(Hash)
+    jobs.keys.should include("example")
+
+    jobs["example"].should be_a(Proc)
+  end
+
+  it "queuing data" do
+    server = TCPServer.open "127.0.0.1", 4481
+
+    hawking = Hawking::Queue.new
+    hawking.put "example", :data => "john@example.org"
+
+    data = JSON.parse server.accept.gets, symbolize_names: true
+
+    server.close
+
+    data.should be_a(Hash)
+    data.keys.should include(:queue, :data)
+
+    expect(data[:queue]).to eq "example"
+    expect(data[:data]).to eq data: "john@example.org"
+  end
+
+  it "works" do
+    Hawking.job "example" do |data|
+      puts "Some example with #{data}"
+    end
+
+    server = TCPServer.open "127.0.0.1", 4481
+
+    hawking = Hawking::Queue.new
+    hawking.put "example", :data => "john@example.org"
+
+    Hawking.work_jobs server
+
+    server.close
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "bundler/setup"
+Bundler.require :default, :development
+
+require "hawking"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: hawking
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Rogério Zambon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  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: rake
+  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'
+description: Background job queueing using Socket. Inspired in the Stalkeg gem.
+email:
+- rogeriozambon@gmail.com
+executables:
+- hawking
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/hawking
+- examples/enqueue.rb
+- examples/jobs.rb
+- hawking.gemspec
+- lib/hawking.rb
+- spec/hawking_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rogeriozambon/hawking
+licenses: []
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Background job queueing using Socket. Inspired in the Stalkeg gem.
+test_files: []