task_scheduler 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5667540718eb766101b3c4e9bfc1257fb7247585
+  data.tar.gz: efe74860457dfdc5892855bb280be7a15f30ea2e
+SHA512:
+  metadata.gz: 97c228d282e5ea77e29c897004c03245522022812868bbec7a51252cbf84284d5726ad4c7463482382c5795c4465b99265d7d75f1f71d3f469760330109e5a9e
+  data.tar.gz: 808d9688f615c4a6baba02304cdd38cb13182c4ef1079d5114f59b409bb92d0dbaff2e91378426de2fbcef94a852763ce8263c89d5544d2f4b86f4ccb65dba85

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 SecZetta
+
+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,28 @@
+# TaskScheduler
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'task_scheduler'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install task_scheduler
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TaskScheduler'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/task_runner.bat

@@ -0,0 +1,21 @@
+@echo off
+
+set RESTVAR=
+shift
+:loop1
+	if "%1"=="" goto after_loop
+	set RESTVAR=%RESTVAR% %1=%2
+	shift
+	shift
+goto loop1
+
+:after_loop
+	echo %RESTVAR%
+
+
+REM params have to be separated by a single space
+set "param1=%~1"
+set "param2=%~2"
+
+cd %param1%
+jruby -S bundle exec rake scheduled_task:start_ldap_auto_sync %RESTVAR%

data/lib/task_scheduler.rb

@@ -0,0 +1,5 @@
+module TaskScheduler
+end
+
+require 'task_scheduler/scheduler'
+require 'task_scheduler/windows_scheduler'

data/lib/task_scheduler/scheduler.rb

@@ -0,0 +1,33 @@
+module TaskScheduler
+  module Scheduler
+    TIMEFRAMES = %w[hours days months].freeze
+    
+    def self.included(base)
+      base.class_eval do
+        after_save :update_scheduled_task, if: 'OS.windows?'
+        after_create :create_scheduled_task, if: 'OS.windows?'
+        
+        validates_presence_of :scheduler, :task_name, :rake_task_name, :import_at,
+                              :import_time, :repeat_time, :repeat_type
+      end
+    end
+    
+    private
+    
+    def create_scheduled_task
+      process_name = 'directory_auto_sync_scheduler.bat'
+      
+      scheduler = WindowsScheduler.new(task_name, process_name)
+      task = scheduler.create_task(import_at, repeat_type, repeat_time, bat_params)
+      task.run
+    end
+    
+    def update_scheduled_task
+      process_name = 'directory_auto_sync_scheduler.bat'
+      
+      scheduler = WindowsScheduler.new(task_name, process_name)
+      task = scheduler.update_task(import_at, repeat_type, repeat_time, bat_params)
+      task.run
+    end
+  end
+end

data/lib/task_scheduler/version.rb

@@ -0,0 +1,3 @@
+module TaskScheduler
+  VERSION = '1.0.1'.freeze
+end

data/lib/task_scheduler/windows_scheduler.rb

@@ -0,0 +1,67 @@
+module TaskScheduler
+  class WindowsScheduler
+    attr_reader :task_name, :rake_task, :import_at, :repeat_type, :repeat_time
+    
+    def initialize(task_name, rake_task)
+      @task_name = task_name
+      @rake_task = rake_task
+    end
+    
+    def run_task(system_ip = nil)
+      io = StringIO.new
+      io << 'SchTasks /Run '
+      io << "/S #{system_ip} " if system_ip # run a task on a different system
+      io << "/TN '#{task_name}' "
+      io
+    end
+    
+    # creates a windows scheduled task via command line
+    #
+    def create_task(import_at, repeat_type, repeat_time, bat_params = nil)
+      io = StringIO.new
+      io << 'SchTasks /Create '
+      if repeat_type && repeat_time
+        io << "/SC #{repeat_type} " # schedule frequency
+        io << "/MO #{repeat_time} " # time between runs
+      end      
+      io << "/TN '#{task_name}' " # name of the task
+      io << "/TR '#{build_bat_params(bat_params)}' " # what to execute when task runs
+      io << "/ST '#{import_at}'" if import_at # start time
+      io
+    end
+    
+    # updates a windows scheuled task via the command line
+    # 
+    def update_task(import_at, repeat_type, repeat_time, bat_params = nil)
+      delete_task&.run
+      create_task(import_at, repeat_type, repeat_time, bat_params)
+    end
+    
+    def delete_task
+      io = StringIO.new
+      io << "SchTasks /Delete /TN '#{task_name}' /F"
+    end
+    
+    private
+    
+    def build_bat_params(bat_params)
+      io = StringIO.new
+      io << "#{File.join(File.dirname(__FILE__), 'task_runner.bat')} "
+      
+      return io.string unless bat_params
+      
+      io << "#{Rails.root} " # first param so the bat file knows where to cd into
+      bat_params.each do |_param_name, value|
+        io << "#{value} "
+      end
+      io.string
+    end
+  end
+end
+
+class StringIO
+  # I built this method because I couldn't test with the system method in the create_task method
+  def run
+    system(string)
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: task_scheduler
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Corey Votta
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  name: rails
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: os
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses system commands to create scheduled tasks in a windows envoirment.
+email:
+- cvotta@seczetta.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/task_runner.bat
+- lib/task_scheduler.rb
+- lib/task_scheduler/scheduler.rb
+- lib/task_scheduler/version.rb
+- lib/task_scheduler/windows_scheduler.rb
+homepage:
+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.6.8
+signing_key:
+specification_version: 4
+summary: Creates scheduled tasks via the windows task scheduler
+test_files: []