activejob-cancel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99ba1ad25092d81d1e814585fd026fd68f813c2a
+  data.tar.gz: 272ae21271e5ddc2b5081b2de32756885dfb5352
+SHA512:
+  metadata.gz: 9c5f55cf87d82c363d00148021bcf08f481723f58da89c91d4f445d8289ce87eba3a0c39167c6dd355ff0830357aef3480f392f738d1cabbbb76bced0f3097d9
+  data.tar.gz: ca5b5d7aae41db84ff5d4ea694f01bebfbd155ded00073c2dac1dc591a4f436b7584b53022cc4042f35c391610c8e0ffe2282dd64475d63dad051c133a0d7c19

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.2.5
+  - 2.3.1
+
+gemfile:
+  - gemfiles/active_job_42.gemfile
+  - gemfiles/active_job_50.gemfile
+
+before_install: gem install bundler -v 1.11.2
+
+services:
+  - redis

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at yuuji.yaginuma@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+# Specify your gem's dependencies in activejob-cancel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yuji Yaginuma
+
+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,60 @@
+# ActiveJob::Cancel
+
+`activejob-cancel` provides cancel method to Active Job. Currently it supports only `Sidekiq` and `Delayed Job`.
+
+[![Build Status](https://travis-ci.org/y-yagi/activejob-cancel.svg?branch=master)](https://travis-ci.org/y-yagi/activejob-cancel)
+[![Gem Version](https://badge.fury.io/rb/activejob-cancel.svg)](http://badge.fury.io/rb/activejob-cancel)
+[![Code Climate](https://codeclimate.com/github/y-yagi/activejob-cancel/badges/gpa.svg)](https://codeclimate.com/github/y-yagi/activejob-cancel)
+[![Coverage Status](https://coveralls.io/repos/github/y-yagi/activejob-cancel/badge.svg?branch=master)](https://coveralls.io/github/y-yagi/activejob-cancel?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activejob-cancel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activejob-cancel
+
+## Usage
+
+```ruby
+# app/jobs/hello_job.rb
+class HelloJob < ActiveJob::Base
+  def perform
+  end
+end
+```
+
+```ruby
+job = HelloJob.perform_later
+job.cancel
+```
+
+Or
+
+```ruby
+HelloJob.cancel(job id) # You must use the job id that Active Job provided.
+```
+
+If you want to use an id that backend job provided, use the `cancel_by` method.
+
+```ruby
+HelloJob.cancel_by(provider_job_id: job_id)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/y-yagi/activejob-cancel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/activejob-cancel.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_job/cancel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activejob-cancel"
+  spec.version       = ActiveJob::Cancel::VERSION
+  spec.authors       = ["Yuji Yaginuma"]
+  spec.email         = ["yuuji.yaginuma@gmail.com"]
+
+  spec.summary       = %q{activejob-cancel provides cancel method to Active Job}
+  spec.homepage      = "https://github.com/y-yagi/activejob-cancel"
+  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_dependency 'activejob', '>= 4.2.0'
+  spec.add_dependency 'activesupport', '>= 4.2.0'
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "sidekiq"
+  spec.add_development_dependency "activerecord", '>= 4.2.0'
+  spec.add_development_dependency "delayed_job"
+  spec.add_development_dependency "delayed_job_active_record"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activejob/cancel"
+
+# 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/gemfiles/active_job_42.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+gem 'rake'
+gem 'sidekiq'
+gem 'delayed_job'
+gem 'delayed_job_active_record'
+gem 'sqlite3'
+gem 'activesupport', '~> 4.2.0'
+gem 'activejob', '~> 4.2.0'
+gem 'activerecord', '~> 4.2.0'

data/gemfiles/active_job_50.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+gem 'rake'
+gem 'sidekiq'
+gem 'delayed_job'
+gem 'delayed_job_active_record'
+gem 'sqlite3'
+gem 'activesupport', '~> 5.0.0'
+gem 'activejob', '~> 5.0.0'
+gem 'activerecord', '~> 5.0.0'

data/lib/active_job/cancel.rb

@@ -0,0 +1,57 @@
+require 'active_support'
+require 'active_job'
+require 'active_job/cancel/queue_adapters'
+require 'active_job/cancel/version'
+
+module ActiveJob
+  module Cancel
+    extend ActiveSupport::Concern
+
+    SUPPORTED_ADAPTERS = %w(Sidekiq DelayedJob).freeze
+
+    def cancel
+      if self.class.can_cancel?
+        self.class.cancel_adapter_class.new.cancel(job_id, queue_name)
+      else
+        raise NotImplementedError, 'This queueing backend does not support cancel.'
+      end
+    end
+
+    module ClassMethods
+      def cancel(job_id)
+        if can_cancel?
+          cancel_adapter_class.new.cancel(job_id, self.queue_name)
+        else
+          raise NotImplementedError, 'This queueing backend does not support cancel.'
+        end
+      end
+
+      def cancel_by(opts)
+        if can_cancel?
+          cancel_adapter_class.new.cancel_by(opts, self.queue_name)
+        else
+          raise NotImplementedError, 'This queueing backend does not support cancel_by.'
+        end
+      end
+
+      def can_cancel?
+        SUPPORTED_ADAPTERS.include?(adapter_name)
+      end
+
+      def cancel_adapter_class
+        Object.const_get("ActiveJob::Cancel::QueueAdapters::#{adapter_name}Adapter")
+      end
+
+      private
+        def adapter_name
+          if ActiveJob.version > Gem::Version.new('4.3')
+            self.queue_adapter.class.name.demodulize.chomp('Adapter')
+          else
+            self.queue_adapter.name.demodulize.chomp('Adapter')
+          end
+        end
+    end
+  end
+end
+
+ActiveJob::Base.include(ActiveJob::Cancel)

data/lib/active_job/cancel/queue_adapters.rb

@@ -0,0 +1,10 @@
+module ActiveJob
+  module Cancel
+    module QueueAdapters
+      extend ActiveSupport::Autoload
+
+      autoload :SidekiqAdapter
+      autoload :DelayedJobAdapter
+    end
+  end
+end

data/lib/active_job/cancel/queue_adapters/delayed_job_adapter.rb

@@ -0,0 +1,36 @@
+require 'delayed_job'
+require 'delayed_job_active_record'
+
+module ActiveJob
+  module Cancel
+    module QueueAdapters
+      class DelayedJobAdapter
+        def cancel(job_id, queue_name)
+          job = find_job(job_id, queue_name)
+          if job
+            job.destroy
+            return true
+          end
+          false
+        end
+
+        def cancel_by(opts, _queue_name)
+          raise ArgumentError, 'Please specify ":provider_job_id"' unless opts[:provider_job_id]
+          job_id = opts[:provider_job_id]
+
+          job = Delayed::Job.find_by(id: job_id)
+          if job
+            job.destroy
+            return true
+          end
+          false
+        end
+
+        private
+          def find_job(job_id, queue_name)
+            Delayed::Job.where('handler LIKE ?', "%job_id: #{job_id}%").where(queue: queue_name).first
+          end
+      end
+    end
+  end
+end

data/lib/active_job/cancel/queue_adapters/sidekiq_adapter.rb

@@ -0,0 +1,58 @@
+require 'sidekiq/api'
+
+module ActiveJob
+  module Cancel
+    module QueueAdapters
+      class SidekiqAdapter
+        def cancel(job_id, queue_name)
+          job = find_job_by_job_id(job_id, queue_name)
+
+          if job
+            job.delete
+            return true
+          end
+
+          false
+        end
+
+        def cancel_by(opts, queue_name)
+          raise ArgumentError, 'Please specify ":provider_job_id"' unless opts[:provider_job_id]
+
+          job = find_job_by_provider_job_id(opts[:provider_job_id], queue_name)
+          if job
+            job.delete
+            return true
+          end
+
+          false
+        end
+
+        private
+          def find_job_by_job_id(job_id, queue_name)
+            find_job_from_queue(job_id, queue_name) || find_job_from_scheduled_set(job_id) || find_job_from_retry_set(job_id)
+          end
+
+          def find_job_by_provider_job_id(provider_job_id, queue_name)
+            Sidekiq::Queue.new(queue_name).find_job(provider_job_id) ||
+            Sidekiq::ScheduledSet.new.find_job(provider_job_id) ||
+            Sidekiq::RetrySet.new.find_job(provider_job_id)
+          end
+
+          def find_job_from_queue(job_id, queue_name)
+            queue = Sidekiq::Queue.new(queue_name)
+            queue.detect { |j| j.args.first['job_id'] == job_id }
+          end
+
+          def find_job_from_scheduled_set(job_id)
+            scheduled_set = Sidekiq::ScheduledSet.new
+            scheduled_set.detect { |j| j.args.first['job_id'] == job_id }
+          end
+
+          def find_job_from_retry_set(job_id)
+            scheduled_set = Sidekiq::RetrySet.new
+            scheduled_set.detect { |j| j.args.first['job_id'] == job_id }
+          end
+      end
+    end
+  end
+end

data/lib/active_job/cancel/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module Cancel
+    VERSION = "0.1.0"
+  end
+end

data/lib/activejob/cancel.rb

@@ -0,0 +1 @@
+require "active_job/cancel"

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: activejob-cancel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Yaginuma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  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: delayed_job_active_record
+  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: sqlite3
+  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: byebug
+  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:
+- yuuji.yaginuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activejob-cancel.gemspec
+- bin/console
+- bin/setup
+- gemfiles/active_job_42.gemfile
+- gemfiles/active_job_50.gemfile
+- lib/active_job/cancel.rb
+- lib/active_job/cancel/queue_adapters.rb
+- lib/active_job/cancel/queue_adapters/delayed_job_adapter.rb
+- lib/active_job/cancel/queue_adapters/sidekiq_adapter.rb
+- lib/active_job/cancel/version.rb
+- lib/activejob/cancel.rb
+homepage: https://github.com/y-yagi/activejob-cancel
+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: activejob-cancel provides cancel method to Active Job
+test_files: []
+has_rdoc: