sidekiq_result 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e2aac7b1b6efeb70b0098d1eaa66cbd56115fbc
+  data.tar.gz: b07e84fde3df1bc864d7bc871011f7d73892bbdc
+SHA512:
+  metadata.gz: c4dcfe4d9d2488b86e8c68d7235b1b4885f2b15b1ecaa9aba73bddeb0192e9a54149dc570ac573cea170076f338b822f26e0902328c9bf36fc052e89beb24769
+  data.tar.gz: 24cb6451126992645a9c90e358d44a5f557b6c22618507ba483629ef4b4fbb4dc27beb8f8ff745bb30005206c15fbba4a68d1646075560570867e72ccf61f0cd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby
+  - rbx-2
+before_install: gem install bundler -v 1.10.5
+gemfile:
+  - Gemfile
+services: redis
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: rbx-2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris MacNaughton
+
+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,80 @@
+# Sidekiq::Result
+[![Gem Version](https://badge.fury.io/rb/sidekiq_result.png)](http://badge.fury.io/rb/sidekiq_result)
+[![Code Climate](https://codeclimate.com/github/chrismacnaughton/sidekiq_result.png)](https://codeclimate.com/github/chrismacnaughton/sidekiq_result)
+[![Build Status](https://secure.travis-ci.org/chrismacnaughton/sidekiq_result.png)](http://travis-ci.org/chrismacnaughton/sidekiq_result)
+
+An extension to [Sidekiq](http://github.com/mperham/sidekiq) message processing to track your jobs.
+
+## Installation
+
+gem install sidekiq-result
+
+## Usage
+
+### Configuration
+
+Configure your middleware chains, lookup [Middleware usage](https://github.com/mperham/sidekiq/wiki/Middleware)
+on Sidekiq wiki for more info.
+
+``` ruby
+require 'sidekiq'
+require 'sidekiq-result'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Result::ServerMiddleware, expiration: 30.minutes # default
+  end
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Result::ClientMiddleware
+  end
+end
+```
+
+After that you can use your jobs as usual and only include `Sidekiq::Result::Worker` module if you want additional functionality of passing the job's finished stateto the client.
+
+``` ruby
+class MyJob
+  include Sidekiq::Worker
+  include Sidekiq::Result::Worker
+
+  def perform(*args)
+  # your code goes here
+  end
+end
+```
+
+To overwrite expiration on worker basis and don't use global expiration for all workers write a expiration method like this below:
+
+``` ruby
+class MyJob
+  include Sidekiq::Worker
+  include Sidekiq::Result::Worker
+
+  def expiration
+    @expiration ||= 60*60*24*30 # 30 days
+  end
+
+  def perform(*args)
+    # your code goes here
+  end
+end
+```
+
+But keep in mind that such thing will store details of job as long as expiration is set, so it may charm your Redis storage/memory consumption. Because Redis stores all data in RAM.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chrismacnaughton/sidekiq_result.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq_result"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq_result/server_middleware.rb

@@ -0,0 +1,35 @@
+module Sidekiq::Result
+  class ServerMiddleware
+    include Storage
+
+    # Parameterized initialization, use it when adding middleware to server chain
+    # chain.add Sidekiq::Result::ServerMiddleware, :expiration => 60 * 5
+    # @param [Hash] opts middleware initialization options
+    # @option opts [Fixnum] :expiration ttl for saving complete jobs
+    def initialize(opts = {})
+      @expiration = opts[:expiration]
+    end
+
+    # Uses sidekiq's internal jid as id
+    # saves result of worker's method into the specified key
+    # @param [Worker] worker worker instance, processed here if it's class includesResult::Worker
+    # @param [Array] msg job args, should have jid format
+    # @param [String] queue queue name
+    def call(worker, msg, queue)
+      # a way of overriding default expiration time,
+      # so worker wouldn't lose its data
+      # and it allows also to overwrite global expiration time on worker basis
+      if worker.respond_to? :expiration
+        if !worker.expiration && worker.respond_to?(:expiration=)
+          worker.expiration = @expiration
+        else
+          @expiration = worker.expiration
+        end
+      end
+      result = yield
+      if worker.respond_to?(:store_result?) && worker.store_result?
+        set_object_for_id(worker.jid, result, @expiration)
+      end
+    end
+  end
+end

data/lib/sidekiq_result/storage.rb

@@ -0,0 +1,55 @@
+require 'base64'
+module Sidekiq::Result::Storage
+  protected
+
+  # Gets the object stored at the given key
+  def get_object_for_id(id, redis_pool = nil)
+    redis_connection(redis_pool) do |conn|
+      decode_object_from_redis(conn.get(key(id)))
+    end
+  end
+
+  # Stores the given object in the specific key
+  def set_object_for_id(id, object, expiration = nil, redis_pool = nil)
+    object = encode_object_for_redis(object)
+    return if object.nil?
+    redis_connection(redis_pool) do |conn|
+      conn.setex(key(id), expiration || Sidekiq::Result::DEFAULT_EXPIRATION, object)
+    end
+  end
+
+  private
+
+  def encode_object_for_redis(object)
+    puts "About to encode: #{object}"
+    begin
+      Base64.encode64(Marshal.dump(object))
+    rescue
+      nil
+    end
+  end
+
+  def decode_object_from_redis(string)
+    begin
+      Marshal.load(Base64.decode64(string))
+    rescue
+      nil
+    end
+  end
+
+  def redis_connection(redis_pool=nil)
+    if redis_pool
+      redis_pool.with do |conn|
+        yield conn
+      end
+    else
+      Sidekiq.redis do |conn|
+        yield conn
+      end
+    end
+  end
+
+  def key(id)
+    "sidekiq:result:#{id}"
+  end
+end

data/lib/sidekiq_result/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Result
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq_result/worker.rb

@@ -0,0 +1,7 @@
+module Sidekiq::Result::Worker
+  attr_accessor :expiration
+
+  def store_result?
+    true
+  end
+end

data/lib/sidekiq_result.rb

@@ -0,0 +1,22 @@
+require 'sidekiq_result/version'
+require 'sidekiq_result/storage'
+require 'sidekiq_result/server_middleware'
+require 'sidekiq_result/worker'
+module Sidekiq::Result
+  extend Storage
+  DEFAULT_EXPIRATION = 5 * 60 # 5 minute timeouts
+
+  class << self
+    # Check if job has registered complete by storing key
+    # in it's space
+    def complete? id
+      !get_object_for_id(id).nil?
+    end
+
+    def result(id)
+      get_object_for_id(id)
+    end
+
+    private
+  end
+end

data/sidekiq_result.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq_result/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq_result'
+  spec.version       = Sidekiq::Result::VERSION
+  spec.authors       = ['Chris MacNaughton']
+  spec.email         = ['chmacnaughton@gmail.com']
+
+  spec.summary       = %q{An extension to sidekiq to retrieve the job result}
+  spec.homepage      = "https://github.com/ChrisMacNaughton/sidekiq_result"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency             'sidekiq', '>= 2.7'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_result
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris MacNaughton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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: 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'
+description: 
+email:
+- chmacnaughton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq_result.rb
+- lib/sidekiq_result/server_middleware.rb
+- lib/sidekiq_result/storage.rb
+- lib/sidekiq_result/version.rb
+- lib/sidekiq_result/worker.rb
+- sidekiq_result.gemspec
+homepage: https://github.com/ChrisMacNaughton/sidekiq_result
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: An extension to sidekiq to retrieve the job result
+test_files: []