cloudwatch_scheduler 0.1.2 → 1.1.1

data/.travis.yml

@@ -1,8 +1,10 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.12.5
+  - 2.5.3
+  - 2.6.1
+before_install: gem install bundler
 gemfile:
-  - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile

data/Appraisals

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 
-appraise "rails-4.2" do
-  gem "rails", "~> 4.2.0"
+appraise "rails-5.2" do
+  gem "railties", "~> 5.2.0"
+  gem "activejob", "~> 5.2.0"
 end
 
-appraise "rails-5.0" do
-  gem "rails", "~> 5.0.0"
+appraise "rails-6.1" do
+  gem "railties", "~> 6.1"
+  gem "activejob", "~> 6.1"
 end

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in cloudwatch_scheduler.gemspec
 gemspec
@@ -8,5 +10,6 @@ group :development, :test do
   gem "guard"
   gem "guard-rspec"
 
-  gem "appraisal"
+  gem "rubocop"
+  gem "rubocop-rspec"
 end

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/README.md

@@ -1,5 +1,7 @@
 # CloudwatchScheduler
 
+[![Actions Status](https://github.com/paul/cloudwatch_scheduler/workflows/CI/badge.svg)](https://github.com/paul/cloudwatch_scheduler/actions)
+
 Are you using Rails 4.2+ and ActiveJob with the [Shoryuken
 driver][shoryuken-driver] to use SQS? Do you have recurring jobs that you kick
 off periodically with the [amazing Clockwork gem][clockwork]? Tired of paying
@@ -32,7 +34,7 @@ Or install it yourself as:
 
 ## Usage
 
-Make yourself a `config/cloudwatch_scheduler.rb` file:
+Make yourself a `config/cloudwatch_schedule.rb` file:
 
 ```ruby
 require "cloudwatch_scheduler"
@@ -52,10 +54,49 @@ CloudwatchScheduler do |config|
 end
 ```
 
+You'll also need to inform Shoryuken about the `cloudwatch_scheduler` queue,
+either in the `config/shoryuken.yml` or with `-q cloudwatch_scheduler` on the
+command line.
+
 Then do `rake cloudwatch_scheduler:setup`, and CloudwatchScheduler will provision the events and
 cloudwatch_scheduler queue. Then, start your Shoruken workers as normal, and the
 `CloudwatchScheduler::Job` will get those events, and perform the tasks defined.
 
+### IAM Permissions
+
+The setup task requires some permissions in the AWS account to create the queue
+and Cloudwatch Events. Here's a sample policy:
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "sqs:CreateQueue",
+        "sqs:GetQueueAttributes",
+        "sqs:SetQueueAttributes",
+      ],
+      "Resource": [
+        "arn:aws:sqs:REGION:AWS_ACCOUNT:cloudwatch_scheduler",
+        "arn:aws:sqs:REGION:AWS_ACCOUNT:cloudwatch_scheduler-failures"
+      ]
+    },
+    {
+      "Effect": "Allow",
+      "Action": [
+        "events:PutRule",
+        "events:PutTargets"
+      ],
+      "Resource": [
+        "*"
+      ]
+    }
+  ]
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -74,6 +115,6 @@ Bug reports and pull requests are welcome on GitHub at
 https://github.com/paul/cloudwatch_scheduler.
 
 [shoryuken-driver]: https://github.com/phstc/shoryuken/wiki/Rails-Integration-Active-Job
-[clockwork]: https://github.com/tomykaira/clockwork
+[clockwork]: https://rubygems.org/gems/clockwork
 [cloudwatch-events]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/ScheduledEvents.html
 

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/cloudwatch_scheduler.gemspec

@@ -1,7 +1,8 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cloudwatch_scheduler/version'
+require "cloudwatch_scheduler/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "cloudwatch_scheduler"
@@ -9,20 +10,24 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Paul Sadauskas"]
   spec.email         = ["psadauskas@gmail.com"]
 
-  spec.summary       = %q{Use AWS CloudWatch events to trigger recurring jobs.}
-  spec.description   = %q{Use Cloudwatch Events to kick off recurring SQS ActiveJob jobs.}
+  spec.summary       = "Use AWS CloudWatch events to trigger recurring jobs."
+  spec.description   = "Use Cloudwatch Events to kick off recurring SQS ActiveJob jobs."
   spec.homepage      = "https://github.com/paul/cloudwatch_scheduler"
 
   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.executables   = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "aws-sdk",   "~> 2.2"
-  spec.add_dependency "rails",     ">= 4.2.0"
-  spec.add_dependency "shoryuken", "~> 2.0"
+  spec.required_ruby_version = "~> 2.5"
+
+  spec.add_dependency "aws-sdk-cloudwatchevents", "~> 1.13"
+  spec.add_dependency "aws-sdk-sqs",              "~> 1.10"
+  spec.add_dependency "rails",     ">= 5.2.0"
+  spec.add_dependency "shoryuken", ">= 2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "appraisal", "~> 2.2.0"
+  spec.add_development_dependency "bundler", ">= 1.12"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/{rails_5.0.gemfile → rails_5.2.gemfile}

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0.0"
+gem "activejob", "~> 5.2.0"
+gem "railties", "~> 5.2.0"
 
 group :development, :test do
   gem "awesome_print"
   gem "guard"
   gem "guard-rspec"
-  gem "appraisal"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/{rails_4.2.gemfile → rails_6.0.gemfile}

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.2.0"
+gem "activejob", "~> 6.0"
+gem "railties", "~> 6.0"
 
 group :development, :test do
   gem "awesome_print"
   gem "guard"
   gem "guard-rspec"
-  gem "appraisal"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/cloudwatch_scheduler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require "cloudwatch_scheduler/configuration"
 require "cloudwatch_scheduler/task"
@@ -10,10 +11,7 @@ def CloudwatchScheduler(&config)
 end
 
 module CloudwatchScheduler
-
   def self.global
     @global ||= CloudwatchScheduler::Configuration.new
   end
-
 end
-

data/lib/cloudwatch_scheduler/configuration.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/numeric/time"
 
 module CloudwatchScheduler
   class Configuration
-
-    attr_accessor :queue_name,
-                  :queue_visibility_timeout,
+    attr_accessor :queue_visibility_timeout,
                   :queue_max_receive_count,
                   :use_dead_letter_queue
 
@@ -30,9 +30,10 @@ module CloudwatchScheduler
       @use_dead_letter_queue    = true
     end
 
+    attr_writer :queue_name
+
     def queue_name
       @queue_name ||= CloudwatchScheduler::Job.queue_name
     end
-
   end
 end

data/lib/cloudwatch_scheduler/engine.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module CloudwatchScheduler
   class Engine < Rails::Engine
@@ -13,6 +14,9 @@ module CloudwatchScheduler
         CloudwatchScheduler::Job.queue_name,
         ActiveJob::QueueAdapters::ShoryukenAdapter::JobWrapper
       )
+
+      # Load the configuration
+      require Rails.root.join("config/cloudwatch_schedule").to_s
     end
 
     rake_tasks do

data/lib/cloudwatch_scheduler/job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CloudwatchScheduler
   class Job < ::ApplicationJob
     queue_as :cloudwatch_scheduler
@@ -9,6 +11,5 @@ module CloudwatchScheduler
     def perform(job_to_spawn)
       @config.tasks[job_to_spawn].invoke
     end
-
   end
 end

data/lib/cloudwatch_scheduler/provisioner.rb

@@ -1,14 +1,17 @@
-require "aws-sdk"
+# frozen_string_literal: true
+
+require "aws-sdk-sqs"
+require "aws-sdk-cloudwatchevents"
 
 module CloudwatchScheduler
   class Provisioner
-
     attr_reader :config
 
     def initialize(config, sqs_client: Aws::SQS::Client.new,
-                           cwe_client: Aws::CloudWatchEvents::Client.new)
+                   cwe_client: Aws::CloudWatchEvents::Client.new)
       @config = config
-      @sqs_client, @cwe_client = sqs_client, cwe_client
+      @sqs_client = sqs_client
+      @cwe_client = cwe_client
     end
 
     def provision
@@ -20,37 +23,24 @@ module CloudwatchScheduler
       attributes = { "VisibilityTimeout" => config.queue_visibility_timeout.to_s }
       @queue_url = sqs.create_queue(queue_name: queue_name, attributes: attributes).queue_url
 
-      if config.use_dead_letter_queue
-        dlq_name = queue_name + "-failures"
-        dlq_url = sqs.create_queue(queue_name: dlq_name).queue_url
-        dlq_arn = sqs.get_queue_attributes(queue_url: dlq_url, attribute_names: ["QueueArn"]).attributes["QueueArn"]
-
-        redrive_attrs = {
-          maxReceiveCount: config.queue_max_receive_count.to_s,
-          deadLetterTargetArn: dlq_arn
-        }.to_json
-
-        attributes = {"RedrivePolicy" => redrive_attrs}
-
-        sqs.set_queue_attributes(queue_url: queue_url, attributes: attributes)
-      end
+      create_dead_letter_queue! if config.use_dead_letter_queue
     end
 
     def create_events!
       rule_arns = config.tasks.map do |_name, task|
         rule_arn = cwe.put_rule(
-          name: task.rule_name,
+          name:                task.rule_name,
           schedule_expression: task.rule_schedule_expression,
-          state: "ENABLED",
-          description: "CloudwatchScheduler task defined at #{task.code.source_location}"
+          state:               "ENABLED",
+          description:         "CloudwatchScheduler task defined at #{task.code.source_location}"
         ).rule_arn
 
         cwe.put_targets(
-          rule: task.rule_name,
+          rule:    task.rule_name,
           targets: [
             {
-              id: SecureRandom.uuid,
-              arn: queue_arn,
+              id:    task.rule_name,
+              arn:   queue_arn,
               input: task.event_data.to_json
             }
           ]
@@ -60,28 +50,28 @@ module CloudwatchScheduler
       end
 
       policy = {
-        "Version": "2012-10-17",
-        "Id": "#{queue_arn}/SQSDefaultPolicy",
-        "Statement": rule_arns.map { |rule_arn|
+        Version:   "2012-10-17",
+        Id:        "#{queue_arn}/SQSDefaultPolicy",
+        Statement: rule_arns.map do |rule_arn|
           {
-            "Sid": "TrustCWESendingToSQS",
-            "Effect": "Allow",
-            "Principal": {
-              "AWS": "*"
+            Sid:       "TrustCWESendingToSQS",
+            Effect:    "Allow",
+            Principal: {
+              AWS: "*"
             },
-            "Action": "sqs:SendMessage",
-            "Resource": queue_arn,
-            "Condition": {
-              "ArnEquals": {
+            Action:    "sqs:SendMessage",
+            Resource:  queue_arn,
+            Condition: {
+              ArnEquals: {
                 "aws:SourceArn": rule_arn
               }
             }
           }
-        }
+        end
       }
 
       sqs.set_queue_attributes(
-        queue_url: queue_url,
+        queue_url:  queue_url,
         attributes: {
           "Policy" => policy.to_json
         }
@@ -90,6 +80,21 @@ module CloudwatchScheduler
 
     private
 
+    def create_dead_letter_queue!
+      dlq_name = queue_name + "-failures"
+      dlq_url = sqs.create_queue(queue_name: dlq_name).queue_url
+      dlq_arn = sqs.get_queue_attributes(queue_url: dlq_url, attribute_names: ["QueueArn"]).attributes["QueueArn"]
+
+      redrive_attrs = {
+        maxReceiveCount:     config.queue_max_receive_count.to_s,
+        deadLetterTargetArn: dlq_arn
+      }.to_json
+
+      attributes = { "RedrivePolicy" => redrive_attrs }
+
+      sqs.set_queue_attributes(queue_url: queue_url, attributes: attributes)
+    end
+
     def queue_name
       config.queue_name
     end
@@ -112,6 +117,5 @@ module CloudwatchScheduler
     def sqs
       @sqs_client
     end
-
   end
 end

data/lib/cloudwatch_scheduler/task.rb

@@ -1,4 +1,6 @@
-require 'active_support/core_ext/digest/uuid'
+# frozen_string_literal: true
+
+require "active_support/core_ext/digest/uuid"
 
 module CloudwatchScheduler
   class Task
@@ -8,6 +10,7 @@ module CloudwatchScheduler
       @name = name
       @every, @cron = every, cron
       fail "You must specify one of every: or cron:" unless [@every, @cron].any?
+
       @code = code
     end
 
@@ -24,18 +27,18 @@ module CloudwatchScheduler
     #  "locale":"en"}
     def event_data
       {
-        job_class: CloudwatchScheduler::Job.name,
-        job_id: job_id,
+        job_class:  CloudwatchScheduler::Job.name,
+        job_id:     job_id,
         queue_name: CloudwatchScheduler::Job.queue_name,
-        arguments: [name],
-        locale: "en",
-        priority: nil
+        arguments:  [name],
+        locale:     "en",
+        priority:   nil
       }
     end
 
     def rule_name
-      limit = 64 - CloudwatchScheduler::Job.queue_name
-      [name[0, limit-1], CloudwatchScheduler::Job.queue_name].join("-")
+      limit = 64 - CloudwatchScheduler::Job.queue_name.length
+      [name[0, limit - 1], CloudwatchScheduler::Job.queue_name].join("-")
     end
 
     def rule_schedule_expression
@@ -65,6 +68,5 @@ module CloudwatchScheduler
     def cron_exp
       "cron(#{@cron})"
     end
-
   end
 end