win32-taskscheduler 0.2.2 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10db6c303493c5c308511397a042a8595eeb63da
+  data.tar.gz: 3d8cca5c8168f5232c6cbfb1ffa0924dac6d81d9
+SHA512:
+  metadata.gz: 435915b83d71f4f2fb45222d530be067ea6a36d1fb7d4584cd67ef72b7f6f83af677e73b31c03186fb41568c68c5ce0d674c065a9c5dfa50cadf852f19ec8a6e
+  data.tar.gz: 1c0a7dbe1185f14cbb897510ffe1fa4d99299d2de655ec0e639c00a55fa91976d3b08533e4af3cd2dcdd906afe7c8e2c3fb3d9c8f6ef6f6af4c720d5d87bd914

data/CHANGES

@@ -1,73 +1,88 @@
-== 0.2.2 - 29-Feb-2012
-* Moved some include statements inside the TaskScheduler class to avoid
-  polluting Object. Thanks go to Josh Cooper for the spot and patch.
-* Minor formatting tweaks to silence 1.9 warnings.
-
-== 0.2.1 - 8-Oct-2011
-* Fixed a bug that would not allow task to run as SYSTEM. Thanks go to
-  Josh cooper for the spot and patch.
-* Fixed a bug in new_work_item that would cause it to crash if you tried
-  to create a work item that already existed. An error is now raised instead.
-  Thanks go to Pete Higgins for the spot.
-* The set_trigger and trigger= methods now internally transform and validate
-  the trigger hash in the same manner as new_work_item. Thanks again go to
-  Pete Higgins.
-* Cleaned up the repo. The C source files have been removed from the main
-  repository (and this gem). They are in a separate branch on github for
-  anyone who misses them.
-* Refactored the Rakefile, removing tasks related to the old C source files,
-  and added tasks for cleaning, building and installing a gem.
-* Updated the README file, eliminating references to anything that was only
-  related to the older C version.
-
-== 0.2.0 - 19-Jun-2009
-* Rewritten in pure Ruby!
-* The TaskScheduler::ONCE constant is now a valid trigger type. Thanks go to
-  Uri Iurgel for the spot and patch.
-* Added the TaskScheduler#exists? method.
-* Added the TaskScheduler#tasks alias for the TaskScheduler#enum method.
-* The TaskScheduler#new_work_item method now accepts symbols as well as
-  strings for hash keys, and ignores case. Also, the keys are now validated.
-* Renamed the example file and test file.
-* Added the 'example' Rake task.
-* Fixed some code in the README synopsis that was incorrect.
-
-== 0.1.0 - 11-May-2008
-* The TaskScheduler#save instance method now accepts an optional file name.
-* Most of the TaskScheduler setter methods now return the value specified
-  instead of true.
-* Removed the RUN_ONLY_IF_DOCKED and RUN_IF_CONNECTED_TO_INTERNET constants.
-  The MSDN docs say that they are unused.
-* Added more documentation. Much more rdoc friendly now.
-* Added many more tests.
-* Better type handling for bad arguments.
-* Added a Rakefile with tasks for building, installation and testing.
-* Added a gemspec.
-* Inlined the rdoc documentation.
-* Internal project reorganization and code cleanup.
-
-== 0.0.3 - 1-Mar-2005
-* Bug fix for the bitFieldToHumanDays() internal function.
-* Moved the 'examples' directory to the toplevel directory.
-* Made the CHANGES and README files rdoc friendly.
-* Minor updates to taskscheduler.h.
-
-== 0.0.2 - 04-Aug-2004
-* Now uses the newer allocation framework and replaced all instances of the
-  deprecated STR2CSTR() function with StringValuePtr().  This means that, as
-  of this release, Ruby 1.8.0 or later is required.
-* Modified the constructor to accept arguments.  This is just some sugar for
-  creating a new task item in one call instead of two.
-* The argument to trigger= now must be a hash.  The same goes for the 'type'
-  sub-hash.
-* Added the add_trigger() method.  Actually, the C code for this method was
-  already in place, I simply forgot to create a corresponding Ruby method
-  for it.
-* Removed the create_trigger() method.  This was really nothing more than an
-  alias for trigger=().  I got confused somehow.
-* Test suite modified and many more tests added.
-* Documentation updates, including docs for a couple of methods that I had
-  accidentally omitted previously.
-
-== 0.0.1 - 24-Apr-2004
-* Initial release
+== 0.3.0 - 15-Jan-2014
+* Rewritten to use Win32OLE instead of using wrapping the C API. Benefits
+  include working on Windows Vista or later, and working with JRuby.
+* Modified the constructor to accept 3rd and 4th arguments. These indicate
+  which folder to use, and whether or not to create it if it doesn't exist.
+* The TaskScheduler#save method is now no longer necessary. It is retained
+  for backwards compatibility, but will raise a deprecation warning. In this
+  version simply calling TaskScheduler#activate will implement the task.
+* Added support for the AT_SYSTEMSTART, AT_LOGON and ON_IDLE trigger types.
+* Now requires the structured_warnings gem.
+* Removed the doc directory and separate documentation file. Everything is
+  inlined now. There's still an example under the "examples" directory, too.
+* Added test-unit, rake, and win32-security as development dependencies.
+  These are needed for testing only.
+
+== 0.2.2 - 29-Feb-2012
+* Moved some include statements inside the TaskScheduler class to avoid
+  polluting Object. Thanks go to Josh Cooper for the spot and patch.
+* Minor formatting tweaks to silence 1.9 warnings.
+
+== 0.2.1 - 8-Oct-2011
+* Fixed a bug that would not allow task to run as SYSTEM. Thanks go to
+  Josh cooper for the spot and patch.
+* Fixed a bug in new_work_item that would cause it to crash if you tried
+  to create a work item that already existed. An error is now raised instead.
+  Thanks go to Pete Higgins for the spot.
+* The set_trigger and trigger= methods now internally transform and validate
+  the trigger hash in the same manner as new_work_item. Thanks again go to
+  Pete Higgins.
+* Cleaned up the repo. The C source files have been removed from the main
+  repository (and this gem). They are in a separate branch on github for
+  anyone who misses them.
+* Refactored the Rakefile, removing tasks related to the old C source files,
+  and added tasks for cleaning, building and installing a gem.
+* Updated the README file, eliminating references to anything that was only
+  related to the older C version.
+
+== 0.2.0 - 19-Jun-2009
+* Rewritten in pure Ruby!
+* The TaskScheduler::ONCE constant is now a valid trigger type. Thanks go to
+  Uri Iurgel for the spot and patch.
+* Added the TaskScheduler#exists? method.
+* Added the TaskScheduler#tasks alias for the TaskScheduler#enum method.
+* The TaskScheduler#new_work_item method now accepts symbols as well as
+  strings for hash keys, and ignores case. Also, the keys are now validated.
+* Renamed the example file and test file.
+* Added the 'example' Rake task.
+* Fixed some code in the README synopsis that was incorrect.
+
+== 0.1.0 - 11-May-2008
+* The TaskScheduler#save instance method now accepts an optional file name.
+* Most of the TaskScheduler setter methods now return the value specified
+  instead of true.
+* Removed the RUN_ONLY_IF_DOCKED and RUN_IF_CONNECTED_TO_INTERNET constants.
+  The MSDN docs say that they are unused.
+* Added more documentation. Much more rdoc friendly now.
+* Added many more tests.
+* Better type handling for bad arguments.
+* Added a Rakefile with tasks for building, installation and testing.
+* Added a gemspec.
+* Inlined the rdoc documentation.
+* Internal project reorganization and code cleanup.
+
+== 0.0.3 - 1-Mar-2005
+* Bug fix for the bitFieldToHumanDays() internal function.
+* Moved the 'examples' directory to the toplevel directory.
+* Made the CHANGES and README files rdoc friendly.
+* Minor updates to taskscheduler.h.
+
+== 0.0.2 - 04-Aug-2004
+* Now uses the newer allocation framework and replaced all instances of the
+  deprecated STR2CSTR() function with StringValuePtr().  This means that, as
+  of this release, Ruby 1.8.0 or later is required.
+* Modified the constructor to accept arguments.  This is just some sugar for
+  creating a new task item in one call instead of two.
+* The argument to trigger= now must be a hash.  The same goes for the 'type'
+  sub-hash.
+* Added the add_trigger() method.  Actually, the C code for this method was
+  already in place, I simply forgot to create a corresponding Ruby method
+  for it.
+* Removed the create_trigger() method.  This was really nothing more than an
+  alias for trigger=().  I got confused somehow.
+* Test suite modified and many more tests added.
+* Documentation updates, including docs for a couple of methods that I had
+  accidentally omitted previously.
+
+== 0.0.1 - 24-Apr-2004
+* Initial release

data/MANIFEST

@@ -1,11 +1,9 @@
-* CHANGES
-* MANIFEST
-* README
-* Rakefile
-* win32-taskscheduler.gemspec
-* ext/extconf.rb
-* ext/win32/taskscheduler.c
-* ext/win32/taskscheduler.h
-* doc/taskscheduler.txt
-* examples/taskscheduler_test.rb
-* test/tc_taskscheduler.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* win32-taskscheduler.gemspec
+* lib/win32/taskscheduler.rb
+* lib/win32/windows/helper.rb
+* examples/taskscheduler_test.rb
+* test/test_taskscheduler.rb

data/README

@@ -1,76 +1,68 @@
-= Description
-  The win32-taskscheduler library is a Ruby interface to the MS Windows Task
-  Scheduler. It is analogous to the Unix cron daemon.
-
-= Prerequisites
-  * win32-api
-  * windows-pr
-
-= Installation
-  gem install win32-taskscheduler
-
-= Synopsis
-  require 'win32/taskscheduler'
-  include Win32
-
-  ts = TaskScheduler.new
-
-  # Create a trigger that starts on April 25, 2014 at 11:05 pm. The trigger
-  # will run on the first and last week of the month, on Monday and Friday,
-  # in the months of April and May.
-  #
-  trigger = {
-    :start_year   => 2014,
-    :start_month  => 4,
-    :start_day    => 25,
-    :start_hour   => 23,
-    :start_minute => 5,
-    :trigger_type => TaskScheduler::MONTHLYDOW,
-    :type => {
-      :weeks        => TaskScheduler::FIRST_WEEK | TaskScheduler::LAST_WEEK,
-      :days_of_week => TaskScheduler::MONDAY | TaskScheduler::FRIDAY,
-      :months       => TaskScheduler::APRIL | TaskScheduler::MAY
-    }
-  }
-
-  ts.new_work_item('my_notepad', trigger)
-  ts.application_name = 'notepad.exe'
-  ts.save
-
-= Documentation
-  If you installed this library as a gem then the documentation was built for
-  you and can be viewed if your gem server is running. There is also some
-  documentation on the github wiki page.
-
-  Otherwise, you can look at the doc/taskscheduler.txt file which should have
-  everything you need.
-
-= Acknowledgements
-  This library was modeled to some degree on the Win32::TaskScheduler Perl
-  module by Umberto Nicoletti. However, there are some differences. Please see
-  the documentation for details.
-
-= Using OLE
-  There's an OLE version in the works. Please see the 'ole' branch on github.
-
-= Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-   
-= Known Issues
-  None known.
-
-  Please submit any bug reports to the project page at
-  http://www.rubyforge.org/projects/win32utils.
-
-= Copyright
-  (C) 2003-2012 Daniel J. Berger
-  All Rights Reserved
-
-= License
-  Artistic 2.0
-
-= Authors
-  Park Heesob
-  Daniel Berger
+= Description
+  The win32-taskscheduler library is a Ruby interface to the MS Windows Task
+  Scheduler. It is analogous to the Unix cron daemon.
+
+= Installation
+  gem install win32-taskscheduler
+
+= Synopsis
+  require 'win32/taskscheduler'
+  include Win32
+
+  ts = TaskScheduler.new
+
+  # Create a trigger that starts on April 25, 2014 at 11:05 pm. The trigger
+  # will run on the first and last week of the month, on Monday and Friday,
+  # in the months of April and May.
+  #
+  trigger = {
+    :start_year   => 2014,
+    :start_month  => 4,
+    :start_day    => 25,
+    :start_hour   => 23,
+    :start_minute => 5,
+    :trigger_type => TaskScheduler::MONTHLYDOW,
+    :type => {
+      :weeks        => TaskScheduler::FIRST_WEEK | TaskScheduler::LAST_WEEK,
+      :days_of_week => TaskScheduler::MONDAY | TaskScheduler::FRIDAY,
+      :months       => TaskScheduler::APRIL | TaskScheduler::MAY
+    }
+  }
+
+  ts.new_work_item('my_notepad', trigger)
+  ts.application_name = 'notepad.exe'
+  ts.activate('my_notepad')
+
+= Documentation
+  If you installed this library as a gem then the documentation was built for
+  you and can be viewed if your gem server is running. There is also some
+  documentation on the github wiki page.
+
+= Acknowledgements
+  This library was modeled to some degree on the Win32::TaskScheduler Perl
+  module by Umberto Nicoletti. However, there are some differences. Please see
+  the documentation for details.
+
+= Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+   
+= Known Issues
+  In some cases JRuby appears to raise a native exception rather than a
+  Ruby exception on failure. This should be mostly harmless.
+
+  Please submit any bug reports to the project page at
+  http://github.com/djberg96/win32-taskscheduler or
+  http://www.rubyforge.org/projects/win32utils.
+
+= Copyright
+  (C) 2003-2014 Daniel J. Berger
+  All Rights Reserved
+
+= License
+  Artistic 2.0
+
+= Authors
+  Park Heesob
+  Daniel Berger

data/Rakefile

@@ -1,34 +1,37 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/clean'
-require 'rbconfig'
-include Config
-
-CLEAN.include("**/*.gem", "**/*.rbc", ".rbx")
-
-namespace 'gem' do
-  desc 'Create the win32-taskscheduler gem'
-  task :create => [:clean] do
-    spec = eval(IO.read('win32-taskscheduler.gemspec'))
-    Gem::Builder.new(spec).build
-  end
-
-  desc 'Install the win32-taskscheduler library as a gem'
-  task :install => [:create] do
-    file = Dir['win32-taskscheduler*.gem'].first
-    sh "gem install #{file}"
-  end
-end
-
-desc 'Run the example code'
-task :example do
-  ruby '-Iib examples/taskscheduler_example.rb'
-end
-
-desc 'Run the test suite for the win32-taskscheduler library'
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = true
-end
-
-task :default => :test
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include("**/*.gem", "**/*.rbc")
+
+namespace 'gem' do
+  desc 'Build the win32-taskscheduler gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-taskscheduler.gemspec'))
+    if Gem::VERSION < "2.0"
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
+  end
+
+  desc 'Install the win32-taskscheduler library as a gem'
+  task :install => [:build] do
+    file = Dir['win32-taskscheduler*.gem'].first
+    sh "gem install #{file}"
+  end
+end
+
+desc 'Run the example code'
+task :example do
+  ruby '-Iib examples/taskscheduler_example.rb'
+end
+
+desc 'Run the test suite for the win32-taskscheduler library'
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = true
+end
+
+task :default => :test

data/examples/taskscheduler_example.rb

@@ -1,56 +1,56 @@
-#######################################################################
-# taskscheduler_example.rb
-#
-# A test script for general futzing. You can run this example via the
-# 'example' rake task.
-#
-# Modify as you see fit.
-#######################################################################
-require 'win32/taskscheduler'
-require 'fileutils'
-require 'pp'
-include Win32
-
-puts 'VERSION: ' + TaskScheduler::VERSION
-
-ts = TaskScheduler.new
-
-trigger = {
-	"start_year" 	=> 2009,
-	"start_month" 	=> 4,
-	"start_day"   	=> 11,
-	"start_hour"	=> 7,
-	"start_minute"	=> 14,
-	"trigger_type"	=> TaskScheduler::DAILY,
-	"type"			=> { "days_interval" => 1 }
-}
-
-unless ts.enum.grep(/foo/).length > 0
-	ts.new_work_item("foo", trigger)
-	ts.application_name = "notepad.exe"
-	ts.save
-	puts "Task Added"
-end
-
-ts.activate("foo")
-ts.priority = TaskScheduler::IDLE
-ts.working_directory = "C:\\"
-
-puts "App name: " + ts.application_name
-puts "Creator: " + ts.creator
-puts "Exit code: " + ts.exit_code.to_s
-puts "Flags: " + ts.flags.to_s
-puts "Max run time: " + ts.max_run_time.to_s
-puts "Next run time: " + ts.next_run_time.to_s
-puts "Parameters: " + ts.parameters
-puts "Priority: " + ts.priority.to_s
-puts "Status: " + ts.status
-puts "Trigger count: " + ts.trigger_count.to_s
-puts "Trigger string: " + ts.trigger_string(0)
-puts "Working directory: " + ts.working_directory
-puts "Trigger: "
-
-pp ts.trigger(0)
-
-ts.delete("foo")
-puts "Task deleted"
+#######################################################################
+# taskscheduler_example.rb
+#
+# A test script for general futzing. You can run this example via the
+# 'example' rake task.
+#
+# Modify as you see fit.
+#######################################################################
+require 'win32/taskscheduler'
+require 'fileutils'
+require 'pp'
+include Win32
+
+puts 'VERSION: ' + TaskScheduler::VERSION
+
+ts = TaskScheduler.new
+
+trigger = {
+	"start_year" 	=> 2009,
+	"start_month" 	=> 4,
+	"start_day"   	=> 11,
+	"start_hour"	=> 7,
+	"start_minute"	=> 14,
+	"trigger_type"	=> TaskScheduler::DAILY,
+	"type"			=> { "days_interval" => 1 }
+}
+
+unless ts.enum.grep(/foo/).length > 0
+	ts.new_work_item("foo", trigger)
+	ts.application_name = "notepad.exe"
+	ts.save
+	puts "Task Added"
+end
+
+ts.activate("foo")
+ts.priority = TaskScheduler::IDLE
+ts.working_directory = "C:\\"
+
+puts "App name: " + ts.application_name
+puts "Creator: " + ts.creator
+puts "Exit code: " + ts.exit_code.to_s
+puts "Flags: " + ts.flags.to_s
+puts "Max run time: " + ts.max_run_time.to_s
+puts "Next run time: " + ts.next_run_time.to_s
+puts "Parameters: " + ts.parameters
+puts "Priority: " + ts.priority.to_s
+puts "Status: " + ts.status
+puts "Trigger count: " + ts.trigger_count.to_s
+puts "Trigger string: " + ts.trigger_string(0)
+puts "Working directory: " + ts.working_directory
+puts "Trigger: "
+
+pp ts.trigger(0)
+
+ts.delete("foo")
+puts "Task deleted"