sidekiq_result 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af1f1ead019b8f8d1fad91d209a3591533906e3a
-  data.tar.gz: c743536d3f8fac81989545ea0a9214b41e56d6d3
+  metadata.gz: 98d8d02fe6a8c1d6c48ed1661147f36dee0db6b3
+  data.tar.gz: e55be9cd0ff5b319c47d26b8342515ded423a648
 SHA512:
-  metadata.gz: e86bb703f49bdf3db1e89225b0049e03453b8412983a0c93070c38a29edc9bfe99ddb7dee70ddc027a0136c6f37c3c84bb288af2aaa1d4c74b0d0692a2527f68
-  data.tar.gz: d23ff8f6e60b7b129469be1d3c7f5e5cc1d326a0333a448ef2049514c36b9a9988f4d3c5cfb8bd9501f712a59732e12ab5f820eaf60bccda432bcfb0e880b393
+  metadata.gz: 7c59bb09bcde652a5576461abf5d7213a6074c0b3e5ff9268aa94758f428619193732c253821f3ba790cf76a94c8a6ae9e0b84846500c40c6797b2647d0fdff1
+  data.tar.gz: 88657ff68f8edf58c3cc7ec3e4eae0861039eb434542e678e7e4e1e04929cce5cb6fd8aa9c41b8c433e4d3d5308374b0eae085e7a52c9de0f29f933b0118b967

data/.travis.yml

@@ -2,8 +2,8 @@ language: ruby
 rvm:
   - 2.0
   - 2.1
-  - 2.2
-  - jruby
+  - 2.2.0
+  - 2.2.2
   - rbx-2
 before_install: gem install bundler -v 1.10.5
 gemfile:
@@ -11,5 +11,8 @@ gemfile:
 services: redis
 matrix:
   allow_failures:
-    - rvm: jruby
-    - rvm: rbx-2
+    - rvm: rbx-2
+notifications:
+  email:
+    on_success: never
+    on_failure: change

data/README.md

@@ -2,6 +2,7 @@
 [![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)
+[![Inline docs](https://inch-ci.org/github/ChrisMacNaughton/sidekiq_result.png)](https://inch-ci.org/github/ChrisMacNaughton/sidekiq_result)
 
 An extension to [Sidekiq](http://github.com/mperham/sidekiq) message processing to track your job results.
 
@@ -24,9 +25,6 @@ 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
 ```
 
@@ -62,18 +60,10 @@ 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/lib/sidekiq_result.rb

@@ -2,6 +2,9 @@ require 'sidekiq_result/version'
 require 'sidekiq_result/storage'
 require 'sidekiq_result/server_middleware'
 require 'sidekiq_result/worker'
+
+
+# An extension to Sidekiq message processing to track your job results.
 module Sidekiq::Result
   extend Storage
   DEFAULT_EXPIRATION = 5 * 60 # 5 minute timeouts
@@ -13,6 +16,9 @@ module Sidekiq::Result
       !check_for_key(id).empty?
     end
 
+    # The result from the Sidekiq worker
+    # Returns whatever was returned from the Sidekiq job
+    # @param [String] id the id of the Sidekiq job
     def result(id)
       get_object_for_id(id)
     end

data/lib/sidekiq_result/server_middleware.rb

@@ -1,4 +1,7 @@
 module Sidekiq::Result
+  # ServerMiddleware must be included in the server Middlware Chain
+  # for the tracking functionality to work. It is used to wrap the
+  # actual job performance.
   class ServerMiddleware
     include Storage
 

data/lib/sidekiq_result/storage.rb

@@ -1,14 +1,21 @@
 require 'base64'
+# Storage is used to wrap all Redis persistence
 module Sidekiq::Result::Storage
   protected
 
   # Gets the object stored at the given key
+  # @param [String] id Sidekiq worker's JID
+  # @param [RedisPool] redis_pool the pool to use for connections to Redis
   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
 
+  # Checks if a given key is present
+  # Returns an array of matching keys
+  # @param [String] id Sidekiq worker's JID
+  # @param [RedisPool] redis_pool the pool to use for connections to Redis
   def check_for_key(id, redis_pool = nil)
     redis_connection(redis_pool) do |conn|
       keys = conn.keys(key(id))
@@ -16,18 +23,23 @@ module Sidekiq::Result::Storage
   end
 
   # Stores the given object in the specific key
+  # Returns true / false based on success of storage
+  # @param [String] id Sidekiq worker's JID, used to track jobs internally
+  # @param [Object] object The object that we are going to marshal and store in Redis
+  # @param [Integer] expiration the number of seconds to store the result in Redis
+  # @param [RedisPool] redis_pool the pool to use for connections to Redis
   def set_object_for_id(id, object, expiration = nil, redis_pool = nil)
     object = encode_object_for_redis(object)
-    return if object.nil?
+    return false if object.nil?
     redis_connection(redis_pool) do |conn|
       conn.setex(key(id), expiration || Sidekiq::Result::DEFAULT_EXPIRATION, object)
     end
+    true
   end
 
   private
 
   def encode_object_for_redis(object)
-    puts "About to encode: #{object}"
     begin
       Base64.encode64(Marshal.dump(object))
     rescue

data/lib/sidekiq_result/version.rb

@@ -1,5 +1,6 @@
+# Sidekiq: https://github.com/mperham/sidekiq
 module Sidekiq
   module Result
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/lib/sidekiq_result/worker.rb

@@ -1,6 +1,15 @@
+# Worker is the module included in a worker so that we know
+# the user wants to track the jobs' results
+#
+# @!attribute expiration
+#   @return [Integer] How long to leave item in Redis (TTL)
+
 module Sidekiq::Result::Worker
   attr_accessor :expiration
 
+  # Internal method used to ensure user wants to track the result
+  # The user MUST include this module in their Worker as per the readme
+  # if they want to track the job results
   def store_result?
     true
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_result
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Chris MacNaughton
@@ -14,70 +14,70 @@ dependencies:
   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: 
@@ -87,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,17 +113,17 @@ 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
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: An extension to sidekiq to retrieve the job result