active_scheduler 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24a57f88cef6610e4ad50c31ed383bca44c9b28e
+  data.tar.gz: 3070e1622de6dcae251394146347d7bbdae4d956
+SHA512:
+  metadata.gz: f3d4a07c0d161179ca17eba8e40102da2fdc86c920b96ada6a414c94341143898b55f1519cbcb85e4cf8aed7b65c05d60077cc612cf485ce05f2f2af67a180b1
+  data.tar.gz: 98b7ea984dcf84a5c44f3a1de4c1c3c1923c1b7977cbdf253d99cb5cd200b1432a1a4b1225b4dbb19a579acaaed3e795a607ef760b530080b9ba056bcc84a53b

data/.gitignore

@@ -0,0 +1,24 @@
+# Gem related stuff
+*.gem
+/pkg
+/.bundle
+/Gemfile.lock
+/vendor
+
+# Testing stuff
+/coverage
+/spec/reports
+*.log
+
+# RBX stuff
+/.rbx/
+
+# Editor temp/backup files
+*~
+.*.sw?
+
+# General
+/nbproject
+.DS_Store
+/.rvmrc
+/.yardoc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.5
+  - 2.2.0
+matrix:
+  allow_failures:
+    - rvm: 1.9.3
+env:
+  - "RAILS_VERSION=4.2.0"
+notifications:
+  email:
+    recipients:
+      - 60tonangel@gmail.com
+    on_success: change
+    on_failure: change

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+rails_version = ENV['RAILS_VERSION'] || '4.2.0'
+rails         = "~> #{rails_version}"
+
+gem "activejob",     rails
+gem "activesupport", rails
+
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rspec, all_after_pass: false, all_on_start: false, failed_mode: :none, cmd: 'NO_COVERALLS=true rspec --color --no-profile --format progress' do
+
+  # Run all tests if these change:
+  watch('spec/spec_helper.rb')               { 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$})         { 'spec' }
+
+  # Any spec runs itself:
+  watch(%r{^spec/.+_spec\.rb$})
+
+  # lib/foo.rb runs spec/foo.rb...
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Justin Aiken
+
+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.markdown

@@ -0,0 +1,48 @@
+[![Gem Version](http://img.shields.io/gem/v/active_scheduler.svg)](https://rubygems.org/gems/active_scheduler)[![Build Status](http://img.shields.io/travis/JustinAiken/active_scheduler/master.svg)](http://travis-ci.org/JustinAiken/active_scheduler) [![Coveralls branch](http://img.shields.io/coveralls/JustinAiken/active_scheduler/master.svg)](https://coveralls.io/r/JustinAiken/active_scheduler?branch=master)[![Code Climate](http://img.shields.io/codeclimate/github/JustinAiken/active_scheduler.svg)](https://codeclimate.com/github/JustinAiken/active_scheduler)
+
+# active_scheduler
+
+active_scheduler is a gem to take a standard schedule one would use with [resque scheduler](https://github.com/resque/resque-scheduler) and wraps it to work with [ActiveJob](https://github.com/rails/rails/tree/master/activejob).
+
+Currently only Resque is supported, but pull requests to add other queues (sidekiq, etc) would be welcomed!
+
+## Requirements/Support
+
+- Rails
+  - ActiveJob 4.2+
+  - ActiveSupport 4.2+
+- Resque
+- Resque Scheduler
+
+## Setup
+
+#### Installation
+
+Add `active_scheduler` to your Gemfile.
+
+## Usage
+
+In your Resque initializer:
+
+```ruby
+require 'resque/server'
+require 'resque/scheduler/server'
+require 'active_scheduler'
+
+# ... Set up your Resque ...
+...
+
+yaml_schedule    = YAML.load_file("#{Rails.root}/config/resque_schedule.yaml") || {}
+wrapped_schedule = ActiveScheduler::ResqueWrapper.wrap yaml_schedule
+Resque.schedule  = wrapped_schedule
+```
+
+## Credits
+
+- Written by [@JustinAiken](https://www.github.com/JustinAiken)
+- Wrapper class idea by [@ryanwjackson](https://www.github.com/ryanwjackson)
+- Special thanks to [Rocketmade](http://www.rocketmade.com/) for development resources.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+end
+
+desc "Run tests "
+task :default do
+  Rake::Task["spec"].invoke
+end

data/active_scheduler.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "active_scheduler/version"
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "active_scheduler"
+  s.version     = ActiveScheduler::VERSION
+  s.authors     = ["Justin Aiken"]
+  s.email       = ["jaiken@rocketmade.com"]
+  s.license     = 'MIT'
+  s.homepage    = "https://github.com/JustinAiken/active_scheduler"
+  s.summary     = %q{Scheduling for ActiveJob}
+  s.description = %q{A wrapper for scheduling jobs through ActiveJob}
+
+  s.rubyforge_project = "active_scheduler"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency             'activejob',     '>= 4.2.0'
+  s.add_dependency             'activesupport', '>= 4.2.0'
+
+  s.add_development_dependency 'rspec-rails',   '~> 3.1'
+  s.add_development_dependency 'guard-rspec',   '~> 4.2'
+  s.add_development_dependency 'coveralls'
+end

data/lib/active_scheduler.rb

@@ -0,0 +1,8 @@
+require 'active_support'
+require 'active_job'
+require 'active_scheduler/version'
+require 'active_scheduler/resque_wrapper'
+
+module ActiveScheduler
+
+end

data/lib/active_scheduler/resque_wrapper.rb

@@ -0,0 +1,38 @@
+module ActiveScheduler
+  class ResqueWrapper
+
+    def self.perform(job_data)
+      klass = Object.const_get job_data['job_class']
+
+      if job_data.has_key? 'arguments'
+        klass.perform_later *job_data['arguments']
+      else
+        klass.perform_later
+      end
+    end
+
+    def self.wrap(schedule)
+      schedule = HashWithIndifferentAccess.new(schedule)
+
+      schedule.each do |job, opts|
+        next if opts[:class] =~ /ActiveScheduler::ResqueWrapper/
+
+        queue = opts[:queue] || 'default'
+
+        schedule[job] = {
+          class:        'ActiveScheduler::ResqueWrapper',
+          queue:        queue,
+          args: [{
+            job_class:  opts[:class],
+            queue_name: queue,
+            arguments:  opts[:arguments]
+          }]
+        }
+
+        schedule[job][:description] = opts.fetch(:description, nil) if opts.fetch(:description, nil)
+        schedule[job][:every]       = opts.fetch(:every, nil)       if opts.fetch(:every, nil)
+        schedule[job][:cron]        = opts.fetch(:cron, nil)        if opts.fetch(:cron, nil)
+      end
+    end
+  end
+end

data/lib/active_scheduler/version.rb

@@ -0,0 +1,3 @@
+module ActiveScheduler
+  VERSION = "0.0.2"
+end

data/spec/active_scheduler/resque_wrapper_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'yaml'
+
+describe ActiveScheduler::ResqueWrapper do
+  describe ".wrap" do
+    let(:wrapped) { described_class.wrap schedule }
+
+    context "with a simple job yaml" do
+      let(:schedule) { YAML.load_file 'spec/fixtures/simple_job.yaml' }
+
+      it "queues up a simple job" do
+        expect(wrapped['simple_job']).to eq(
+          "class"       => "ActiveScheduler::ResqueWrapper",
+          "queue"       => "simple",
+          "description" => "It's a simple job.",
+          "every"       => "30s",
+          "args"        => [{
+            "job_class"  => "SimpleJob",
+            "queue_name" => "simple",
+            "arguments"  => nil
+          }]
+        )
+      end
+    end
+
+    context "with a simple job json" do
+      let(:schedule) { YAML.load_file 'spec/fixtures/simple_job.json' }
+
+      it "queues up a simple job" do
+        expect(wrapped['simple_job']).to eq(
+          "class"       => "ActiveScheduler::ResqueWrapper",
+          "queue"       => "simple",
+          "description" => "It's a simple job.",
+          "every"       => "30s",
+          "args"        => [{
+            "job_class"  => "SimpleJob",
+            "queue_name" => "simple",
+            "arguments"  => nil
+          }]
+        )
+      end
+    end
+
+    context "with a multiple jobs in the schedule" do
+      let(:schedule) { YAML.load_file 'spec/fixtures/two_jobs.yaml' }
+
+      it "queues them all up simple job" do
+        expect(wrapped['job_1']['args'][0]['job_class']).to eq 'JobOne'
+        expect(wrapped['job_2']['args'][0]['job_class']).to eq 'JobTwo'
+      end
+    end
+
+    context "with a cron instead of an every" do
+      let(:schedule) { YAML.load_file 'spec/fixtures/cron_job.yaml' }
+
+      it "uses that instead" do
+        expect(wrapped['cron_job']['cron']).to eq '* * * *'
+        expect(wrapped['cron_job']['every']).to be_nil
+      end
+    end
+
+    context "when the queue is blank" do
+      let(:schedule) { YAML.load_file 'spec/fixtures/no_queue.yaml' }
+
+      it "uses 'default'" do
+        expect(wrapped['no_queue_job']['queue']).to eq 'default'
+      end
+    end
+  end
+
+  describe ".perform" do
+    class TestKlass
+    end
+
+    let(:job_data) { {'job_class' => 'TestKlass'} }
+
+    after { described_class.perform job_data }
+
+    it "gets the true job class and ActiveJob's it up" do
+      expect(TestKlass).to receive :perform_later
+    end
+
+    context "with arguments" do
+      let(:job_data) { {'job_class' => 'TestKlass', 'arguments' => [1, 2]} }
+
+      it "passes the arguments" do
+        expect(TestKlass).to receive(:perform_later).with 1, 2
+      end
+    end
+  end
+end

data/spec/fixtures/cron_job.yaml

@@ -0,0 +1,7 @@
+cron_job:
+  cron: "* * * *"
+  queue: "cron"
+  class: "CronJob"
+  args:
+    -
+  description: "It's a cronned job."

data/spec/fixtures/no_queue.yaml

@@ -0,0 +1,6 @@
+no_queue_job:
+  every: "30s"
+  class: "SimpleJob"
+  args:
+    -
+  description: "It's a simple job."

data/spec/fixtures/simple_job.json

@@ -0,0 +1,8 @@
+{
+  "simple_job": {
+    "every": "30s",
+    "queue": "simple",
+    "class": "SimpleJob",
+    "description": "It's a simple job."
+  }
+}

data/spec/fixtures/simple_job.yaml

@@ -0,0 +1,7 @@
+simple_job:
+  every: "30s"
+  queue: "simple"
+  class: "SimpleJob"
+  args:
+    -
+  description: "It's a simple job."

data/spec/fixtures/two_jobs.yaml

@@ -0,0 +1,10 @@
+job_1:
+  every: "30s"
+  queue: "simple"
+  class: "JobOne"
+  description: "It's a simple job 1."
+job_2:
+  every: "30s"
+  queue: "simple"
+  class: "JobTwo"
+  description: "It's a simple job 2"

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'active_scheduler'
+
+unless ENV["NO_COVERALLS"]
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: active_scheduler
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Justin Aiken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: A wrapper for scheduling jobs through ActiveJob
+email:
+- jaiken@rocketmade.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.markdown
+- Rakefile
+- active_scheduler.gemspec
+- lib/active_scheduler.rb
+- lib/active_scheduler/resque_wrapper.rb
+- lib/active_scheduler/version.rb
+- spec/active_scheduler/resque_wrapper_spec.rb
+- spec/fixtures/cron_job.yaml
+- spec/fixtures/no_queue.yaml
+- spec/fixtures/simple_job.json
+- spec/fixtures/simple_job.yaml
+- spec/fixtures/two_jobs.yaml
+- spec/spec_helper.rb
+homepage: https://github.com/JustinAiken/active_scheduler
+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: active_scheduler
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Scheduling for ActiveJob
+test_files: []