exel-sidekiq 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fcc3d8f156d37752c4590eccf49b68e1e777c99
+  data.tar.gz: d5973955df99b74878e54bd33701714fca41aa6b
+SHA512:
+  metadata.gz: 5f28626d9fb7d4d710160e0b4f3d5b5e87cde31728b3e1e38b68516c46d43015b78c015d9323ab9a8a1fefaa3e8d4b1f51bd39616758460d81855380c060b021
+  data.tar.gz: 9b12729a14ec7985e9333c8c265c96166c88172aa76d6a8f218e0cf76834eaf2e5a9be196bf4a92844b75bc63d6bf14f34694368bb9d904fb850b6ee6b74320f

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+*.iml
+.ruby-*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David
+
+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,34 @@
+# EXEL::Sidekiq
+
+This gem adds Sidekiq support for [EXEL's](https://github.com/47colborne/exel) async command.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exel-sidekiq'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exel-sidekiq
+
+## Usage
+
+If you wish to use a queue other than default, you may specify it's name in the options passed to `async`. The retry limit
+can also be set, as in the following example:
+
+    async queue: :my_queue, retry: 3 do
+        process with: MyProcessor
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/47colborne/exel-sidekiq )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/exel-sidekiq.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exel/sidekiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'exel-sidekiq'
+  spec.version       = EXEL::Sidekiq::VERSION
+  spec.authors       = ['yroo']
+  spec.email         = ['dev@yroo.com']
+  spec.summary       = %q{Async provider for EXEL using Sidekiq}
+  spec.description   = %q{When used with EXEL (https://github.com/47colborne/exel), the async command will launch a Sidekiq worker}
+  spec.homepage      = 'https://github.com/47colborne/exel-sidekiq'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'exel', '~> 1'
+  spec.add_dependency 'sidekiq', '~> 3'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'guard', '~> 2'
+  spec.add_development_dependency 'guard-rspec', '~> 4'
+  spec.add_development_dependency 'terminal-notifier', '~> 1'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1'
+end

data/lib/exel/sidekiq/execution_worker.rb

@@ -0,0 +1,15 @@
+require 'sidekiq'
+
+module EXEL
+  module Sidekiq
+    class ExecutionWorker
+      include ::Sidekiq::Worker
+
+      def perform(context_uri)
+        context = Context.deserialize(context_uri)
+        block = context[:_block]
+        block.start(context)
+      end
+    end
+  end
+end

data/lib/exel/sidekiq/sidekiq_provider.rb

@@ -0,0 +1,22 @@
+require 'sidekiq'
+require_relative 'execution_worker'
+
+module EXEL
+  module Sidekiq
+    class SidekiqProvider
+      def initialize(context)
+        @context = context
+      end
+
+      def do_async(block)
+        @context[:_block] = block
+
+        push_args = {'class' => EXEL::Sidekiq::ExecutionWorker, 'args' => [@context.serialize]}
+        push_args['queue'] = @context[:queue] if @context[:queue]
+        push_args['retry'] = @context[:retry] if @context[:retry]
+
+        ::Sidekiq::Client.push(push_args)
+      end
+    end
+  end
+end

data/lib/exel/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module EXEL
+  module Sidekiq
+    VERSION = '1.0.0'
+  end
+end

data/lib/exel/sidekiq.rb

@@ -0,0 +1,10 @@
+require 'exel/sidekiq/version'
+require_relative 'sidekiq/sidekiq_provider'
+
+module EXEL
+  module Sidekiq
+    EXEL.configure do |config|
+      config.async_provider = EXEL::Sidekiq::SidekiqProvider
+    end
+  end
+end

data/spec/exel/sidekiq/execution_worker_spec.rb

@@ -0,0 +1,15 @@
+module EXEL
+  module Sidekiq
+    describe ExecutionWorker do
+      it 'runs the given block with the deserialized context' do
+        dsl_block = instance_double(SequenceNode)
+        context = Context.new(test1: 'foo', test2: 2, _block: dsl_block)
+        context_uri = 'test uri'
+
+        expect(Context).to receive(:deserialize).with(context_uri).and_return(context)
+        expect(dsl_block).to receive(:start).with(context)
+        ExecutionWorker.new.perform(context_uri)
+      end
+    end
+  end
+end

data/spec/exel/sidekiq/sidekiq_provider_spec.rb

@@ -0,0 +1,54 @@
+module EXEL
+  module Sidekiq
+    describe SidekiqProvider do
+      subject(:provider) { described_class.new(context) }
+      let(:callback) { instance_double(SequenceNode) }
+      let(:context) { EXEL::Context.new }
+      let(:serialized_context_uri) { 'context_uri' }
+
+      describe '#do_async' do
+        before do
+          allow(context).to receive(:serialize).and_return(serialized_context_uri)
+        end
+
+        it 'adds the callback to the context before serializing it' do
+          expect(context).to receive(:[]=).with(:_block, callback).ordered
+          expect(context).to receive(:serialize).ordered
+          provider.do_async(callback)
+        end
+
+        context 'with queue name' do
+          let(:context) { EXEL::Context.new(queue: 'import_processor') }
+
+          it 'pushes the execution worker to the given queue' do
+            expect(::Sidekiq::Client).to receive(:push).with('queue' => context[:queue], 'class' => ExecutionWorker, 'args' => [serialized_context_uri])
+            provider.do_async(callback)
+          end
+        end
+
+        context 'without queue name' do
+          it 'pushes the execution worker to the default queue' do
+            expect(::Sidekiq::Client).to receive(:push).with('class' => ExecutionWorker, 'args' => [serialized_context_uri])
+            provider.do_async(callback)
+          end
+        end
+
+        context 'with retries specified' do
+          let(:context) { EXEL::Context.new(retry: 1) }
+
+          it 'pushes the execution worker with a specified number of retries' do
+            expect(::Sidekiq::Client).to receive(:push).with('retry' => context[:retry], 'class' => ExecutionWorker, 'args' => [serialized_context_uri])
+            provider.do_async(callback)
+          end
+        end
+
+        context 'with no retries specified' do
+          it 'pushes the execution worker with no specified number of retries' do
+            expect(::Sidekiq::Client).to receive(:push).with('class' => ExecutionWorker, 'args' => [serialized_context_uri])
+            provider.do_async(callback)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'exel'
+
+Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each { |f| require f }
+
+EXEL.logger = nil

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: exel-sidekiq
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- yroo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: exel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: When used with EXEL (https://github.com/47colborne/exel), the async command
+  will launch a Sidekiq worker
+email:
+- dev@yroo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exel-sidekiq.gemspec
+- lib/exel/sidekiq.rb
+- lib/exel/sidekiq/execution_worker.rb
+- lib/exel/sidekiq/sidekiq_provider.rb
+- lib/exel/sidekiq/version.rb
+- spec/exel/sidekiq/execution_worker_spec.rb
+- spec/exel/sidekiq/sidekiq_provider_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/47colborne/exel-sidekiq
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Async provider for EXEL using Sidekiq
+test_files:
+- spec/exel/sidekiq/execution_worker_spec.rb
+- spec/exel/sidekiq/sidekiq_provider_spec.rb
+- spec/spec_helper.rb