ost-job 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf157669a9fa68fba51edff012ef23c333a51fbf
+  data.tar.gz: cc9484c6ae96085f9bda35d8de8bd9cf61bb34bd
+SHA512:
+  metadata.gz: 0f2c57418b5950dc607ff83a9378a94d3fbfcb574952d397a9a8eee003fd4d3ae46eec2b8cd87a49213191f88724cccbadbeab7e7d495a9e963dae4dc86ff1d9
+  data.tar.gz: e2a55ee73a1b9a6636a4db771f296b93da7d40203e22bc7845a6598606fcde1662db98e8088f9b1e2452fa91707090ea377b0da45986283143c426fb668e2c9c

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Brendon Murphy
+
+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/Makefile

@@ -0,0 +1,4 @@
+test:
+	cutest test/*.rb
+
+.PHONY: test

data/README.md

@@ -0,0 +1,53 @@
+Ost::Job
+========
+
+Job base classes for [Ost](https://github.com/soveran/ost) and
+[ost-bin](https://github.com/djanowski/ost-bin).
+
+Description
+-----------
+
+Ost provides simple, lightweight background job functionality.  By
+default, it assumes you are passing very primative ids like a numeric
+user id to the queue.
+
+`Ost::Job` and `Ost::JsonJob` provide a super thin interface to a job
+class that plays nice with `ost-bin`.
+
+Installation
+------------
+
+    $ gem install ost-job
+
+Usage
+-----
+
+Setup your `Ostfile` as specified by ost-bin.
+
+Declare a job class with a `#perform` instance method.
+
+For a regular job that is passed a single id or string:
+
+```ruby
+class Plain < Ost::Job
+  def perform(user_id)
+    user = User.find(id)
+    # do something with user
+  end
+end
+```
+
+If you want to pass richer data to your job, inherit `Ost::JsonJob`
+
+```ruby
+# Enqueue the job
+Ost[:Mailer] << {user_id: 42, subject: 'Hello', body: 'World'}.to_json
+
+# Declare your Job Class
+class Mailer < Ost::JsonJob
+  def perform(data)
+    user = User.find(data['id'])
+    Mail.deliver(user: user, subject: data['subject'], body: data['body'])
+  end
+end
+```

data/lib/ost/job.rb

@@ -0,0 +1,19 @@
+require "json"
+
+module Ost
+  class Job
+    def call(data)
+      perform(deserialize(data))
+    end
+
+    def deserialize(data)
+      data
+    end
+  end
+
+  class JsonJob < Job
+    def deserialize(data)
+      JSON[data]
+    end
+  end
+end

data/ost-job.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = "ost-job"
+  s.version     = "0.0.1"
+  s.summary     = "Job base classes for Ost"
+  s.description = s.summary
+  s.authors     = ["Brendon Murphy"]
+  s.email       = ["xternal1+github@gmail.com"]
+  s.homepage    = "http://github.com/bemurphy/ost-job"
+  s.license     = "MIT"
+
+  s.files = Dir[
+    "LICENSE",
+    "README.md",
+    "Makefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/**/*.rb"
+  ]
+
+  s.add_development_dependency "cutest", "~> 1.2"
+end

data/test/ost_job_test.rb

@@ -0,0 +1,29 @@
+require "cutest"
+require_relative "../lib/ost/job"
+
+class PlainJob < Ost::Job
+  def perform(data)
+    $plain_data ||= []
+    $plain_data << data
+  end
+end
+
+test "deserializing the data for a plain job" do
+  PlainJob.new.call(1)
+  PlainJob.new.call(22)
+  PlainJob.new.call(333)
+  assert_equal [1, 22, 333], $plain_data
+end
+
+class JsonJob < Ost::JsonJob
+  def perform(data)
+    $deserialized_data ||= []
+    $deserialized_data << data
+  end
+end
+
+test "deserializing the data for a json based job" do
+  JsonJob.new.call(JSON.dump({foo: 'bar', job: 1}))
+  JsonJob.new.call(JSON.dump({fizz: 'buzz', job: 2}))
+  assert_equal [{"foo" => "bar", "job" => 1}, {"fizz" => "buzz", "job" => 2}], $deserialized_data
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ost-job
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Job base classes for Ost
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Makefile
+- README.md
+- lib/ost/job.rb
+- ost-job.gemspec
+- test/ost_job_test.rb
+homepage: http://github.com/bemurphy/ost-job
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Job base classes for Ost
+test_files: []