sidekiq-global_id 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 542565433c36e2b4b31292fd5ad06dfa0cb7e803
+  data.tar.gz: fbaea7575f98d205913d2e283920e65f8f2a7fa1
+SHA512:
+  metadata.gz: 257bea221617b5deebf139271ddc2189ee446a18a5cfd21dba35dedb1277391d1a2e359adfc86b0f195a50c6e1650bbc52768e608774c8841ae6ffea0a72c7fc
+  data.tar.gz: 27c1b23517701e659cda76a46fba133f37c9e4391ab3579f6b6ce261c45ae0402df3d9ad4bbd6b91846fc66797f574b9172aa4e39acc9ae70defded8677d14c2

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  spbtv_code_style: .strict_rubocop.yml
+
+
+Style/Documentation:
+  Exclude:
+    - spec/**/*.rb

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5
+script:
+- bundle exec rake spec
+- bundle exec rubocop --fail-level C

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-globalid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Artem Bolshakov
+
+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,74 @@
+[![Build Status](https://travis-ci.org/bolshakov/sidekiq-global_id.svg?branch=master)](https://travis-ci.org/bolshakov/sidekiq-global_id)
+
+# Sidekiq::GlobalId
+
+This gem provides Sidekiq middleware to serialize ActiveRecord objects with GlobalId. Actually it uses the same mechanism as
+ ActiveJob uses internally to serialize job arguments, and works not only with ActiveRecord objects, but also with Hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-global_id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-global_id
+
+## Usage
+
+Configure Sidekiq to use server and client middleware:
+
+
+```ruby
+Sidekiq.server_middleware do |chain|
+  chain.prepend Sidekiq::GlobalId::ServerMiddleware
+end
+
+Sidekiq.client_middleware do |chain|
+  chain.prepend Sidekiq::GlobalId::ClientMiddleware
+end
+```
+
+Now you can pass ActiveRecord arguments into Sidekiq worker:
+
+```ruby
+user = User.create!(params)
+
+WelcomeEmailSender.perform_async(user)
+```
+
+## Testing 
+
+If you're using [rspec-sidekiq](https://github.com/philostler/rspec-sidekiq) gem, `require 'sidekiq/global_id/rspec'` to deserialize global ids:
+ 
+```ruby
+require 'sidekiq/global_id/rspec'
+
+it 'sends welcome email to user' do 
+  WelcomeEmailSender.perform_async(user)
+  expect(WelcomeEmailSender).to have_enqueued_job(user)
+end
+```
+   
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/bolshakov/sidekiq-global_id.
+
+
+## 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,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sidekiq/globalid'
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/global_id.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'globalid'
+require 'active_job/arguments'
+
+module Sidekiq
+  # Sidekiq and GlobalId integration
+  module GlobalId
+    autoload :Arguments, 'sidekiq/global_id/arguments'
+    autoload :ClientMiddleware, 'sidekiq/global_id/client_middleware'
+    autoload :ServerMiddleware, 'sidekiq/global_id/server_middleware'
+  end
+end

data/lib/sidekiq/global_id/client_middleware.rb

@@ -0,0 +1,18 @@
+module Sidekiq
+  module GlobalId
+    # Sidekiq client middleware serializes arguments before
+    # pushing job to Redis.
+    #
+    class ClientMiddleware
+      # @param _worker_class [Class<Sidekiq::Worker>]
+      # @param job [Hash] sidekiq job
+      # @param _queue [String]
+      # @param _redis_pool [ConnectionPool]
+      # @return [Hash] sidekiq job
+      def call(_worker_class, job, _queue, _redis_pool)
+        job['args'] = ActiveJob::Arguments.serialize(job['args'])
+        yield
+      end
+    end
+  end
+end

data/lib/sidekiq/global_id/rspec.rb

@@ -0,0 +1,18 @@
+require 'rspec/sidekiq/matchers/have_enqueued_job'
+
+Sidekiq::Testing.server_middleware do |c|
+  c.prepend Sidekiq::GlobalId::ServerMiddleware
+end
+
+# Overrides rspec-sidekiq `have_enqueued_job` matcher to deserialize
+# arguments.
+class RSpec::Sidekiq::Matchers::HaveEnqueuedJob # rubocop:disable Style/ClassAndModuleChildren
+  private
+
+  def job_arguments(hash)
+    if hash.is_a?(Hash)
+      args = hash['arguments'] || hash['args']
+      ActiveJob::Arguments.deserialize(args)
+    end
+  end
+end

data/lib/sidekiq/global_id/server_middleware.rb

@@ -0,0 +1,16 @@
+module Sidekiq
+  module GlobalId
+    # Sidekiq client middleware deserializes arguments before
+    # executing job.
+    class ServerMiddleware
+      # @param _worker [Sidekiq::Worker]
+      # @param job [Hash] sidekiq job
+      # @param _queue [String]
+      # @return [<any>] job args
+      def call(_worker, job, _queue)
+        job['args'] = ActiveJob::Arguments.deserialize(job['args'])
+        yield
+      end
+    end
+  end
+end

data/sidekiq-global_id.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-global_id'
+  spec.version       = '0.1'
+  spec.authors       = ['Tema Bolshakov']
+  spec.email         = ['abolshakov@spbtv.com']
+
+  spec.summary       = 'Sidekiq and GlobalId integration'
+  spec.description   = 'Provides Sidekiq middleware to serialize ActiveRecord objects with GlobalId'
+  spec.homepage      = 'https://github.com/bolshakov/sidekiq-global_id'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'sidekiq', '>= 4.0'
+  spec.add_runtime_dependency 'globalid', '~> 0.3.7'
+  spec.add_runtime_dependency 'activejob', '>= 4.2.5'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'spbtv_code_style', '1.4.1'
+  spec.add_development_dependency 'temping', '~> 3.7.1'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.10'
+  spec.add_development_dependency 'rspec-sidekiq', '~> 2.2'
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-global_id
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Tema Bolshakov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: spbtv_code_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: rspec-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Provides Sidekiq middleware to serialize ActiveRecord objects with GlobalId
+email:
+- abolshakov@spbtv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/global_id.rb
+- lib/sidekiq/global_id/client_middleware.rb
+- lib/sidekiq/global_id/rspec.rb
+- lib/sidekiq/global_id/server_middleware.rb
+- sidekiq-global_id.gemspec
+homepage: https://github.com/bolshakov/sidekiq-global_id
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Sidekiq and GlobalId integration
+test_files: []