sidekiq-encryptor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbf6216993306970a0046e788f4b033a8565db1e
+  data.tar.gz: db90b1555b00991e53aca580cb923872b5c5e99c
+SHA512:
+  metadata.gz: 5dc4b9b01365ad77d9c833bedc238c64c7a5a4a7e6e25d4ba0660f573f891f8082bedc1991b8da88ac1a92ae95f37211d7c8e94f3486c439ffb091ead339853c
+  data.tar.gz: f7dc81e8b26fcd47c5d244a6fca04f23ae0ae34155140acbdf1a3e12a0a050af09142ce5d3beaad5670757a9791bbae6bcdedc85421d283409a9aa1ce500adff

data/.gitignore

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

data/.pryrc

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require 'pathname'
+$LOAD_PATH.unshift(Pathname.getwd.join('lib').to_s)
+require 'sidekiq/throttler'
+
+def reload!
+  Dir["#{Dir.pwd}/lib/**/*.rb"].each { |f| load f }
+end

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+branches:
+  only:
+    - master
+notifications:
+  email:
+    recipients:
+      - gabe@ga.be
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode

data/.yardopts

@@ -0,0 +1,3 @@
+--title 'Sidekiq::Encryptor Documentation'
+--charset utf-8
+--markup markdown

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch('sidekiq-throttler.gemspec')
+end
+
+guard 'rspec' do
+  watch(%r{^spec/app/.+_worker\.rb$}) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard 'yard' do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+end

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2013 Jonathan Dance
+
+Portions of initial project skeleton are copyright (c) 2012 Gabe Evans
+
+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,57 @@
+# Sidekiq::Encryptor
+
+[![Build Status](https://secure.travis-ci.org/wuputah/sidekiq-encryptor.png)](http://travis-ci.org/wuputah/sidekiq-encryptor)
+[![Dependency Status](https://gemnasium.com/wuputah/sidekiq-encryptor.png)](https://gemnasium.com/wuputah/sidekiq-encryptor)
+
+Sidekiq::Encryptor is a middleware set for Sidekiq that encrypts your
+job data when enqueuing a job and decrypts that data when running a job.
+
+## Compatibility
+
+Sidekiq::Encryptor is actively tested against MRI versions 2.0.0 and 1.9.3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-encryptor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-encryptor
+
+## Configuration
+
+In a Rails initializer or wherever you've configured Sidekiq, add
+the relevant Sidekiq::Encryptor middlewares as follows:
+
+```ruby
+key = ENV['SIDEKIQ_ENCRYPTION_KEY']
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Encryptor::Server, key: key
+  end
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Encryptor::Client, key: key
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Encryptor::Client, key: key
+  end
+end
+```
+
+## Contributing
+
+Pull requests gladly accepted. Please write tests for any code changes.
+
+## License
+
+MIT Licensed. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+desc 'Start Pry with runtime dependencies loaded'
+task :console, :script do |t, args|
+  command  = 'bundle exec pry'
+  command += "-r #{args[:script]}" if args[:script]
+  sh command
+end

data/lib/sidekiq/encryptor/version.rb

@@ -0,0 +1,14 @@
+module Sidekiq
+  class Encryptor
+
+    module Version
+      MAJOR = 0
+      MINOR = 0
+      PATCH = 1
+      SUFFIX = ""
+    end
+
+    VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::PATCH}#{Version::SUFFIX}"
+
+  end
+end

data/lib/sidekiq/encryptor.rb

@@ -0,0 +1,46 @@
+require 'sidekiq'
+require 'active_support/message_encryptor'
+require 'active_support/message_verifier'
+
+require 'sidekiq/encryptor/version'
+
+module Sidekiq
+  class Encryptor
+
+    Error = Class.new(::RuntimeError)
+    DecryptionError = Class.new(Error)
+    VersionChangeError = Class.new(DecryptionError)
+
+    class Base
+      def initialize(options = {})
+        @key = options[:key]
+        @encryptor = ActiveSupport::MessageEncryptor.new(@key) if @key
+      end
+    end
+
+    class Client < Base
+      def call(worker, msg, queue)
+        return yield unless @key
+        msg['args'] = ['Sidekiq::Encryptor', Sidekiq::Encryptor::Version::MAJOR, @encryptor.encrypt_and_sign(Sidekiq.dump_json(msg['args']))]
+        yield
+      end
+    end
+
+    class Server < Base
+      def call(worker, msg, queue)
+        return yield unless @key
+        if msg['args'][0] == 'Sidekiq::Encryptor'
+          if msg['args'][1] != Sidekiq::Encryptor::Version::MAJOR
+            raise VersionChangeError, 'incompatible change detected'
+          else
+            msg['args'] = Sidekiq.load_json(@encryptor.decrypt_and_verify(msg['args'][2]))
+          end
+        end
+        yield
+      rescue ActiveSupport::MessageVerifier::InvalidSignature, ActiveSupport::MessageEncryptor::InvalidMessage
+        raise DecryptionError, 'key not identical or data was corrupted'
+      end
+    end
+
+  end # Encryptor
+end # Sidekiq

data/lib/sidekiq-encryptor.rb

@@ -0,0 +1 @@
+require 'sidekiq/encryptor'

data/sidekiq-encryptor.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/encryptor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'sidekiq-encryptor'
+  gem.version       = Sidekiq::Encryptor::VERSION
+  gem.authors       = ['Jonathan Dance']
+  gem.email         = ['rubygems@wuputah.com']
+  gem.description   = %q{Sidekiq middleware that encrypts your job data into and out of Redis.}
+  gem.summary       = %q{Sidekiq::Encryptor is a middleware for Sidekiq that keeps your information safe by using 2-way encryption when storing and retrieving jobs from Redis.}
+  gem.homepage      = 'https://github.com/wuputah/sidekiq-encryptor'
+
+  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.require_paths = ['lib']
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'sidekiq', '>= 2.5', '< 3.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-redis_helper'
+  gem.add_development_dependency 'timecop'
+  gem.add_development_dependency 'simplecov'
+
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-bundler'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-yard'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'rb-inotify'
+  gem.add_development_dependency 'growl'
+end

data/spec/app/workers/regular_worker.rb

@@ -0,0 +1,7 @@
+class RegularWorker
+  include Sidekiq::Worker
+
+  def perform(name)
+    puts "..."
+  end
+end

data/spec/sidekiq/encryptor_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+[Sidekiq::Encryptor::Client, Sidekiq::Encryptor::Server].each do |klass|
+
+  describe klass do
+
+    subject(:middleware) do
+      described_class.new
+    end
+
+    let(:worker) do
+      RegularWorker.new
+    end
+
+    let(:message) do
+      {
+        args: 'Clint Eastwood'
+      }
+    end
+
+    let(:queue) do
+      'default'
+    end
+
+    describe '#call' do
+
+      it 'yields' do
+        expect { |b| middleware.call(worker, message, queue, &b) }.to yield_with_no_args
+      end
+    end
+  end
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+WORKERS = File.join(File.dirname(__FILE__), 'app', 'workers')
+$LOAD_PATH.unshift(WORKERS)
+
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'rspec'
+require 'timecop'
+
+require 'sidekiq/encryptor'
+
+# Autoload every worker for the test suite that sits in spec/app/workers
+Dir[File.join(WORKERS, '*.rb')].sort.each do |file|
+  name = File.basename(file, '.rb')
+  autoload name.camelize.to_sym, name
+end
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/sidekiq.rb

@@ -0,0 +1,20 @@
+require 'sidekiq/util'
+Sidekiq.logger.level = Logger::ERROR
+
+require 'rspec-redis_helper'
+RSpec::RedisHelper::CONFIG.merge!(:url => 'redis://localhost/15', :namespace => 'testy')
+
+require 'sidekiq/redis_connection'
+REDIS = Sidekiq::RedisConnection.create(RSpec::RedisHelper::CONFIG)
+
+RSpec.configure do |spec|
+  spec.include RSpec::RedisHelper, redis: true
+
+  # clean the Redis database around each run
+  # @see https://www.relishapp.com/rspec/rspec-core/docs/hooks/around-hooks
+  spec.around( :each, redis: true ) do |example|
+    with_clean_redis do
+      example.run
+    end
+  end
+end

metadata

@@ -0,0 +1,311 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-encryptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Dance
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.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: 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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: redcarpet
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-redis_helper
+  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: timecop
+  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: simplecov
+  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: guard
+  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: guard-bundler
+  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: guard-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: guard-yard
+  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: rb-fsevent
+  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: rb-inotify
+  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: growl
+  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: Sidekiq middleware that encrypts your job data into and out of Redis.
+email:
+- rubygems@wuputah.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- .travis.yml
+- .yardopts
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-encryptor.rb
+- lib/sidekiq/encryptor.rb
+- lib/sidekiq/encryptor/version.rb
+- sidekiq-encryptor.gemspec
+- spec/app/workers/regular_worker.rb
+- spec/sidekiq/encryptor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/sidekiq.rb
+homepage: https://github.com/wuputah/sidekiq-encryptor
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Sidekiq::Encryptor is a middleware for Sidekiq that keeps your information
+  safe by using 2-way encryption when storing and retrieving jobs from Redis.
+test_files:
+- spec/app/workers/regular_worker.rb
+- spec/sidekiq/encryptor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/sidekiq.rb