kronos-ruby 0.2.1 → 0.3.0.alpha.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 138131adeba7fb2ccff6d4f4b83eb3fca66940c7
-  data.tar.gz: 9f7c9106549b7c4ed245f9a7b8d9c00475716365
+  metadata.gz: d48ccce63684b70ad4e4c6f5ff2e2350a043ed7f
+  data.tar.gz: d5e32958a4d1c2e2c91341f2686f3bef9829427b
 SHA512:
-  metadata.gz: bcf5c19cab28bc0b8d69a18358888f27f428e39af639cbc454a7fc2ff1d2f89b7a2debdc8cbcd35b4359816bebf47f131ea596b27ebee10874f0206c9be96946
-  data.tar.gz: 811141eff3ac9afbc5ad8ce0b34981378543a6a7b2c29a04a617877c84fae6fa4e526b0c88caaf4f7611bb3b2bf91f1006becbd396111c9932e84b36e5417b8d
+  metadata.gz: b4c7ec7555173f715585f9c4d331c3df9199eb83c53dcf12a8634f43df067abd024a3f01d84c3df8b5534a4501b5402cd91fe40e8e3bc798b2de9eaa18d96b51
+  data.tar.gz: c2202ac1bf3e632842f3bbd49bfe3dc5e52cad0dae5f1a84981390ea27679ad9da3b34c89d4e09a4020d0a9709c163e2a90fc50a912d714b78985b041f1a51a7

data/CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ### Unreleased
 
+### 0.3.0 [2017-09-27]
+- [Added] Distributed lock capabilities
+
 ### 0.2.1 [2017-09-22]
 - [Added] Fields to ReportModel
 - [Fixed] Update Docs

data/README.md

@@ -12,7 +12,7 @@ This project allows you to use a scheduler with well defined concepts of runners
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kronos-ruby'
+gem 'kronos-ruby', require: ['kronos']
 ```
 
 And then execute:
@@ -47,6 +47,15 @@ To view Krono's web dashboard, simply mount it into your Rack stack:
 mount Kronos::Web::App, at: '/kronos-dashboard'
 ```
 
+If you want to protect Kronos dashboard, try using `Rack::Auth::Basic`:
+```ruby
+protected_kronos = Rack::Auth::Basic.new(Kronos::Web::App) do |username, password|
+  # Check if username/password tuple is valid
+end
+
+mount protected_kronos, at: '/kronos-dashboard'
+```
+
 ## Developing
 - Clone this repository
 - Run `bin/setup` to install dependencies

data/lib/kronos.rb

@@ -4,6 +4,7 @@ require 'concurrent'
 require 'chronic'
 require 'erb'
 require 'ostruct'
+require 'forwardable'
 
 require 'kronos/config_agent'
 require 'kronos/dependencies'

data/lib/kronos/runner/synchronous.rb

@@ -24,6 +24,7 @@ module Kronos
       def initialize(tasks, dependencies)
         @tasks = tasks
         @dependencies = dependencies
+        @lock_manager = LockManager.new(dependencies.storage)
       end
 
       def start
@@ -66,9 +67,10 @@ module Kronos
 
       # rubocop:disable RescueException
       def run_task(task)
-        raw_execute_task(task)
+        task_id = task.id
+        @lock_manager.lock_and_execute(task_id) { raw_execute_task(task) }
       rescue ::Exception => error
-        register_task_failure(task.id, error)
+        register_task_failure(task_id, error)
       end
       # rubocop:enable
 
@@ -109,3 +111,5 @@ module Kronos
     end
   end
 end
+
+require 'kronos/runner/synchronous/lock_manager'

data/lib/kronos/runner/synchronous/lock_manager.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kronos
+  module Runner
+    class Synchronous
+      class LockManager
+        extend Forwardable
+
+        def initialize(storage)
+          @storage = storage
+        end
+
+        def lock_and_execute(task_id)
+          return if locked_task?(task_id)
+          lock_id = lock_task(task_id)
+          return unless check_lock(task_id, lock_id)
+          yield
+        ensure
+          release_lock(task_id)
+        end
+
+        def_delegator :@storage, :locked_task?, :locked_task?
+        def_delegator :@storage, :lock_task,    :lock_task
+        def_delegator :@storage, :check_lock,   :check_lock
+        def_delegator :@storage, :release_lock, :release_lock
+      end
+    end
+  end
+end

data/lib/kronos/storage/in_memory.rb

@@ -9,6 +9,7 @@ module Kronos
       def initialize
         @scheduled_tasks = []
         @reports = []
+        @locks = {}
       end
 
       def schedule(scheduled_task)
@@ -48,6 +49,24 @@ module Kronos
       def remove_reports_for(id)
         @reports.reject! { |report| report.task_id == id }
       end
+
+      def locked_task?(task_id)
+        @locks.key?(task_id)
+      end
+
+      def lock_task(task_id)
+        SecureRandom.uuid.tap do |lock_id|
+          @locks[task_id] = lock_id
+        end
+      end
+
+      def check_lock(task_id, lock_id)
+        @locks[task_id] == lock_id
+      end
+
+      def release_lock(task_id)
+        @locks.delete(task_id)
+      end
     end
   end
 end

data/lib/kronos/storage/mongo/model/lock_model.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'mongoid'
+
+module Kronos
+  module Storage
+    module Mongo
+      module Model
+        class LockModel
+          include Mongoid::Document
+          store_in collection: :kronos_locks
+
+          field :task_id, type: Symbol
+          field :value, type: String
+        end
+      end
+    end
+  end
+end

data/lib/kronos/storage/mongo_db.rb

@@ -2,13 +2,16 @@
 
 require 'kronos/storage/mongo/model/scheduled_task_model'
 require 'kronos/storage/mongo/model/report_model'
+require 'kronos/storage/mongo/model/lock_model'
 
 module Kronos
   module Storage
     # :reek:UtilityFunction:
+    # :reek:TooManyMethods:
     class MongoDb
       SHEDULED_TASK_MODEL = Mongo::Model::ScheduledTaskModel
       REPORT_MODEL = Mongo::Model::ReportModel
+      LOCK_MODEL = Mongo::Model::LockModel
 
       def scheduled_tasks
         # Returns all current Kronos::ScheduledTask, resolved or pending
@@ -53,13 +56,31 @@ module Kronos
         query.exists? && query.first.next_run > Time.now
       end
 
+      def locked_task?(task_id)
+        LOCK_MODEL.where(task_id: task_id).exists?
+      end
+
+      def lock_task(task_id)
+        SecureRandom.uuid.tap do |lock_id|
+          LOCK_MODEL.create(task_id: task_id, value: lock_id)
+        end
+      end
+
+      def check_lock(task_id, lock_id)
+        LOCK_MODEL.where(task_id: task_id, value: lock_id).exists?
+      end
+
+      def release_lock(task_id)
+        LOCK_MODEL.where(task_id: task_id).destroy_all
+      end
+
       private
 
       def mount_report(report_model)
         case report_model.status
-        when 0
+        when Kronos::Report::STATUSES[:success]
           mount_success_report(report_model)
-        when 1
+        when Kronos::Report::STATUSES[:failure]
           mount_failure_report(report_model)
         end
       end

data/lib/kronos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kronos
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kronos-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0.alpha.11
 platform: ruby
 authors:
 - Gabriel Teles
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -255,9 +255,11 @@ files:
 - lib/kronos/runner.rb
 - lib/kronos/runner/asynchronous.rb
 - lib/kronos/runner/synchronous.rb
+- lib/kronos/runner/synchronous/lock_manager.rb
 - lib/kronos/scheduled_task.rb
 - lib/kronos/storage.rb
 - lib/kronos/storage/in_memory.rb
+- lib/kronos/storage/mongo/model/lock_model.rb
 - lib/kronos/storage/mongo/model/report_model.rb
 - lib/kronos/storage/mongo/model/scheduled_task_model.rb
 - lib/kronos/storage/mongo_db.rb
@@ -281,12 +283,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Persistent cron jobs manager