arask 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b51288be65c487cc7ef84a0911f9e2848e443ff
-  data.tar.gz: 329f36f92c8a6f877caeb401a036a609774c7f02
+  metadata.gz: e0ccff09799aceb6f771f22a6d9d981ee0edcfcd
+  data.tar.gz: 015acd74815a762ef5f837e0388e268613519952
 SHA512:
-  metadata.gz: a89e7b82c415166c5b17752b3af454c2a08d1ebbf3d66af68d4ad6035262d2d06894680725b595aede27fb49fa31cf344c94a17b8601c23ebc21c14684832af4
-  data.tar.gz: bfe056cb38d460e6516539cf26093185d275edb52bfdcf9f61e7e316b324c4450f83f8b66f7997f6b5a3923a92e79bde7260457a61da9db04e283d970f8c9191
+  metadata.gz: b599908a948826e65cbfc794a1c94ca245199a47a75dad79711fe5880c8a9f912265b4b07342d84017ee7646612bdb701653d94bbe2600151f24df28910e476e
+  data.tar.gz: d8a2fc39027e99da66b37be2fe442449f8c8257f6d61cd27a6752c3f7ebe924135237316a99fdf810f3816528f5c20b02e07c3944000155b4633bb9229201fe0

data/README.md

@@ -1,19 +1,33 @@
 # Arask
 Automatic RAils taSKs (with minimal setup).
 
-The interval starts when the task has started running. If a task with the interval `:hourly` is run at 08:37PM, then it will run the next time at 09:37PM.
+No need to setup anything outside of Rails. If Rails is running, so is Arask.
+
+Use cron syntax or simply define the interval.
 
 ## Usage
 After installation, you can edit config/initializers/arask.rb with your tasks.
 
-### Examples
+### Examples of jobs in the initializer
 ```ruby
 arask.create script: 'puts "IM ALIVE!"', interval: :daily, run_first_time: true
 arask.create script: 'Attachment.process_new', interval: 5.hours if Rails.env.production?
+arask.create task: 'send:logs', cron: '0 2 * * *' # At 02:00 every day
+arask.create task: 'update:cache', cron: '*/5 * * * *' # Every 5 minutes
 # Run rake task:
 arask.create task: 'my:awesome_task', interval: :hourly
+# On exceptions, send email
+arask.on_exception email: 'errors@example.com'
 ```
 
+### About cron
+Arask uses [fugit](https://github.com/floraison/fugit) to parse cron and get next execution time. It follows normal cron syntax. You can test your cron at https://crontab.guru/.
+
+Not supported is `@reboot`.
+
+### About interval
+The interval starts when the task has started running. If a task with the interval `:hourly` is run at 08:37PM, then it will run the next time at 09:37PM.
+
 ## Installation
 Add this line to your application's Gemfile:
 ```ruby
@@ -27,11 +41,14 @@ $ rails generate arask:install
 $ rails db:migrate
 ```
 
-Setup your tasks in config/initializers/arask.rb.
+Setup your tasks in config/initializers/arask.rb. Initially it looks [like this](lib/arask/initialize.rb).
 
 ## Todos
-* Be able to setup error handling. For instance in initializer: `arask.on_fail email: 'gr34test_dev@example.com'`
 * Have a "try again" feature. For instance `arask.create script: 'raise "I failed"', interval: :daily, fail_retry: 5.minutes, retry_at_most: 2`
+* Tests
+
+## Setup for Heroku
+None. But if you use a hobby dyno and it falls to sleep, so will Arask. As soon as the dyno wakes up, Arask will run any pending jobs.
 
 ## Caveats
 If you reload a database dump, your jobs could be run again.

data/lib/arask/arask_job.rb

@@ -2,18 +2,38 @@ module Arask
   require 'rake'
 
   class AraskJob < ActiveRecord::Base
+    after_create :calculate_new_execute_at
+
     def run
-      self.update_attribute(:execute_at, self.interval.seconds.from_now)
+      calculate_new_execute_at
       begin
         if self.job.start_with?('Rake::Task')
           Rake.load_rakefile Rails.root.join( 'Rakefile' )
         end
         eval(self.job)
       rescue Exception => e
-        # TODO: Alert broken job
         puts 'Arask: Job failed'
         p self
         puts e.message
+
+        unless Arask.exception_email.nil?
+          ActionMailer::Base.mail(
+            from: Arask.exception_email_from,
+            to: Arask.exception_email,
+            subject: "Arask failed",
+            body: "Job: #{self.inspect}\n\nException:\n#{e.message}"
+          ).deliver
+        end
+      end
+    end
+
+    private
+    def calculate_new_execute_at
+      if self.interval.start_with?('cron: ')
+        cron = Fugit::Cron.parse(self.interval.split(' ', 2)[1])
+        self.update_attribute(:execute_at, cron.next_time.to_t)
+      else
+        self.update_attribute(:execute_at, self.interval.to_i.seconds.from_now)
       end
     end
   end

data/lib/arask/initialize.rb

@@ -2,6 +2,10 @@ Arask.setup do |arask|
   # Examples
   #arask.create script: 'puts "IM ALIVE!"', interval: :daily, run_first_time: true
   #arask.create script: 'Attachment.process_new', interval: 5.hours if Rails.env.production?
+  #arask.create task: 'send:logs', cron: '0 2 * * *' # At 02:00 every day
+  #arask.create task: 'update:cache', cron: '*/5 * * * *' # Every 5 minutes
   # Run rake task:
   #arask.create task: 'my:awesome_task', interval: :hourly
+  # On exceptions, send email
+  #arask.on_exception email: 'errors@example.com'
 end

data/lib/arask/run_jobs.rb

@@ -0,0 +1,17 @@
+module Arask
+  class RunJobs < ActiveJob::Base
+    queue_as :default
+
+    def perform
+      begin
+        AraskJob.transaction do
+          AraskJob.where('execute_at < ?', DateTime.now).lock.each do |job|
+            job.run
+          end
+        end
+      rescue
+      end
+      Arask.queue_self
+    end
+  end
+end

data/lib/arask/setup.rb

@@ -0,0 +1,51 @@
+module Arask
+  class Setup
+    def self.on_exception(email: nil, from: 'robot@server')
+      Arask.exception_email = email
+      Arask.exception_email_from = from
+      puts "Arask could not parse parameter for on_exception!" unless email.class == String
+    end
+
+    def self.create(script: nil, task: nil, interval: nil, cron: nil, run_first_time: false)
+      unless interval.nil?
+        case interval
+        when :hourly
+          interval = 1.hour
+        when :daily
+          interval = 1.day
+        when :monthly
+          interval = 1.month
+        end
+        interval = interval.to_s.to_i
+      end
+      unless cron.nil?
+        interval = 'cron: ' + cron
+      end
+      if interval.nil?
+        puts 'Arask: You did not specify either cron: or interval:! When should the task run?'
+        return
+      end
+      unless task.nil?
+        script = "Rake::Task['#{task}'].invoke"
+      end
+      if script.nil?
+        puts 'Arask: You did not specify a script or task to run!'
+        return
+      end
+      begin
+        job = AraskJob.where(job: script, interval: interval).first
+        if job
+          Arask.jobs_touched << job.id
+        else
+          job = AraskJob.create(job: script, interval: interval)
+          Arask.jobs_touched << job.id
+          if run_first_time===true
+            job.run
+          end
+        end
+      rescue ActiveRecord::StatementInvalid => e
+        puts 'Could not create arask job! Looks like the database is not migrated? Remember to run `rails generate arask:install` and `rails db:migrate`'
+      end
+    end
+  end
+end

data/lib/arask/version.rb

@@ -1,3 +1,3 @@
 module Arask
-  VERSION = '0.1.2'
+  VERSION = '1.0.0'
 end

data/lib/arask.rb

@@ -1,14 +1,17 @@
 require "arask/railtie"
 require "arask/arask_job"
+require "arask/run_jobs"
+require "arask/setup"
+require 'fugit' # To parse cron
 
 module Arask
-  class << self; attr_accessor :time_cache; end
+  class << self; attr_accessor :jobs_touched, :exception_email, :exception_email_from; end
 
   def self.setup
-    @jobs_touched = []
-    yield Arask
+    Arask.jobs_touched = []
+    yield Setup
     begin
-      AraskJob.all.where.not(id: @jobs_touched).delete_all
+      AraskJob.all.where.not(id: Arask.jobs_touched).delete_all
       Arask.queue_self
     rescue
     end
@@ -24,53 +27,4 @@ module Arask
     end
   end
 
-  def self.create(script: nil, task: nil, interval:, run_first_time: false)
-    case interval
-    when :hourly
-      interval = 1.hour
-    when :daily
-      interval = 1.day
-    when :monthly
-      interval = 1.month
-    end
-    interval = interval.to_s.to_i
-    unless task.nil?
-      script = "Rake::Task['#{task}'].invoke"
-    end
-    if script.nil?
-      puts 'Arask: You did not specify a script or task to run!'
-      return
-    end
-    begin
-      job = AraskJob.where(job: script, interval: interval).first
-      if job
-        @jobs_touched << job.id
-      else
-        job = AraskJob.create(job: script, interval: interval, execute_at: interval.seconds.from_now)
-        @jobs_touched << job.id
-        if run_first_time===true
-          job.run
-        end
-      end
-    rescue ActiveRecord::StatementInvalid => e
-      puts 'Could not create arask job! Looks like the database is not migrated? Remember to run `rails generate arask:install` and `rails db:migrate`'
-    end
-  end
-
-
-  class RunJobs < ActiveJob::Base
-    queue_as :default
-
-    def perform
-      begin
-        AraskJob.transaction do
-          AraskJob.where('execute_at < ?', DateTime.now).lock.each do |job|
-            job.run
-          end
-        end
-      rescue
-      end
-      Arask.queue_self
-    end
-  end
 end

data/lib/generators/arask/install_generator.rb

@@ -8,6 +8,6 @@ class Arask::InstallGenerator < Rails::Generators::Base
     Arask::InstallGenerator.source_root File.expand_path('../../arask', __FILE__)
     copy_file '../../arask/initialize.rb', 'config/initializers/arask.rb'
 
-    generate 'migration', 'create_arask_jobs job:string execute_at:datetime:index interval:integer'
+    generate 'migration', 'create_arask_jobs job:string execute_at:datetime:index interval:string'
   end
 end

metadata

@@ -1,30 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: arask
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Esben Damgaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '5.1'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: fugit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: rspec
+  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: 5.1.0
-description: With minimal setup, be able to regularly run tasks.
+        version: '0'
+description: With minimal setup, be able to regularly run tasks in Rails. Either user
+  cron syntax or simply define an interval.
 email:
 - ebbe@hvemder.dk
 executables: []
@@ -38,6 +81,8 @@ files:
 - lib/arask/arask_job.rb
 - lib/arask/initialize.rb
 - lib/arask/railtie.rb
+- lib/arask/run_jobs.rb
+- lib/arask/setup.rb
 - lib/arask/version.rb
 - lib/generators/arask/install_generator.rb
 homepage: http://github.com/Ebbe/arask