win32-taskscheduler 0.2.0 → 2.0.4

data/lib/win32/taskscheduler/time_calc_helper.rb

@@ -0,0 +1,163 @@
+module Win32
+  class TaskScheduler
+    module TimeCalcHelper
+
+      # No of days in given month. Deliberately placed 0 in the
+      # beginning to avoid any miscalculations
+      #
+      DAYS_IN_A_MONTH = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31].freeze
+
+      # No of days in a month for given year
+      #
+      # @param [Integer] month
+      # @param [Integer] year
+      # @return [Integer] No of days
+      #
+      def days_in_month(month, year)
+        month == 2 && is_leap_year?(year) ? 29 : DAYS_IN_A_MONTH[month]
+      end
+
+      # Checks weather the given year is a leap year or not
+      #
+      # @param [Integer] year
+      # @return [Boolean]
+      #
+      def is_leap_year?(year)
+        (((year % 4).zero? && !(year % 100).zero?) || (year % 400).zero?)
+      end
+
+      # Calculates the total minutes within given PTM format time
+      #
+      # @param [Integer] time_str
+      # @return [Integer] Time duration in minutes
+      #
+      def time_in_minutes(time_str)
+        time_in_seconds(time_str) / 60
+      end
+
+      # Calculates the total seconds within given PTM format time
+      #
+      # @param [Integer] time_str the time in PTM format
+      # @return [Integer] Time duration in seconds
+      #
+      def time_in_seconds(time_str)
+        dt_tm_hash = time_details(time_str)
+        curr_time = Time.now
+
+        # Basic time variables
+        future_year = curr_time.year + dt_tm_hash[:year].to_i
+        future_month = curr_time.month + dt_tm_hash[:month].to_i
+        future_day = curr_time.day + dt_tm_hash[:day].to_i
+        future_hr = curr_time.hour + dt_tm_hash[:hour].to_i
+        future_min = curr_time.min + dt_tm_hash[:min].to_i
+        future_sec = curr_time.sec + dt_tm_hash[:sec].to_i
+
+        # 'extra value' calculations for these time variables
+        future_sec, future_min = extra_time(future_sec, future_min, 60)
+        future_min, future_hr = extra_time(future_min, future_hr, 60)
+        future_hr, future_day = extra_time(future_hr, future_day, 24)
+
+        # explicit method to calculate overloaded days;
+        # They may stretch upto years; heance leap year & months are into consideration
+        future_day, future_month, future_year = extra_days(future_day, future_month, future_year, curr_time.month, curr_time.year)
+
+        future_month, future_year = extra_months(future_month, future_year, curr_time.month, curr_time.year)
+
+        future_time = Time.new(future_year, future_month, future_day, future_hr, future_min, future_sec)
+
+        # Difference in time will return seconds
+        future_time.to_i - curr_time.to_i
+      end
+
+      # Adjusts the overlapping seconds and returns actual minutes and seconds
+      #
+      # @example
+      #   extra_time(65, 2, 60) #=> => [5, 3]
+      #
+      def extra_time(low_rank, high_rank, div_val)
+        a, b = low_rank.divmod(div_val)
+        high_rank += a; low_rank = b
+        [low_rank, high_rank]
+      end
+
+      # Adjusts the overlapping months and returns actual month and year
+      #
+      def extra_months(month_count, year_count, _init_month, _init_year)
+        year, month_count = month_count.divmod(12)
+        if year.positive? && month_count.zero?
+          month_count = 12
+          year -= 1
+        end
+        year_count += year
+        [month_count, year_count]
+      end
+
+      # Adjusts the overlapping years and months and returns actual days, month and year
+      #
+      def extra_days(days_count, month_count, year_count, init_month, init_year)
+        # Will keep increamenting them with surplus days
+        days = days_count
+        mth = init_month
+        yr = init_year
+
+        loop do
+          days -= days_in_month(mth, yr)
+          break if days <= 0
+          mth += 1
+          if mth > 12
+            mth = 1; yr += 1
+          end
+          days_count = days
+        end
+
+        # Setting actual incremented values
+        month_count += (mth - init_month)
+        year_count += (yr - init_year)
+
+        [days_count, month_count, year_count]
+      end
+
+      # Extracts a hash out of given PTM formatted time
+      #
+      # @param [String] time_str
+      # @return [Hash<:year, :month, :day, :hour, :min, :sec>] With their values in Integer
+      #
+      # @example
+      #   time_details("PT3S") #=> {sec: 3}
+      #
+      def time_details(time_str)
+        tm_detail = {}
+        if time_str.to_s != ""
+          # time_str will be like "PxxYxxMxxDTxxHxxMxxS"
+          # Ignoring 'P' and extracting date and time
+          dt, tm = time_str[1..-1].split("T")
+
+          # Replacing strings
+          if dt.to_s != ""
+            dt["Y"] = "year" if dt["Y"]; dt["M"] = "month" if dt["M"]; dt["D"] = "day" if dt["D"]
+            dt_tm_string_to_hash(dt, tm_detail)
+          end
+
+          if tm.to_s != ""
+            tm["H"] = "hour" if tm["H"]; tm["M"] = "min" if tm["M"]; tm["S"] = "sec" if tm["S"]
+            dt_tm_string_to_hash(tm, tm_detail)
+          end
+        end
+        tm_detail
+      end
+
+      # Converts the given date/time string to the hash
+      #
+      # @param [String] str
+      # @param [Hash] tm_detail May be loaded
+      # @return [Hash]
+      #
+      # @example
+      #   dt_tm_string_to_hash("10year3month", {}) #=> {:year=>"10", :month=>"3"}
+      #
+      def dt_tm_string_to_hash(str, tm_detail)
+        str.split(/(\d+)/)[1..-1].each_slice(2).each_with_object(tm_detail) { |i, h| h[i.last.to_sym] = i.first; }
+      end
+    end
+  end
+end

data/lib/win32/taskscheduler/version.rb

@@ -0,0 +1,6 @@
+module Win32
+  class TaskScheduler
+    # The version of the win32-taskscheduler library
+    VERSION = "2.0.4".freeze
+  end
+end

metadata

@@ -1,67 +1,110 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: win32-taskscheduler
-version: !ruby/object:Gem::Version 
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 2.0.4
 platform: ruby
-authors: 
+authors:
 - Park Heesob
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-06-19 00:00:00 -06:00
-default_executable: 
-dependencies: []
-
-description: "      The win32-taskscheduler library provides an interface to the MS Windows\n      Task Scheduler. With this interface you can create new scheduled tasks,\n      configure existing tasks, or delete tasks.\n"
+date: 2019-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: structured_warnings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: win32-security
+  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'
+description: |2
+      The win32-taskscheduler library provides an interface to the MS Windows
+      Task Scheduler. With this interface you can create new scheduled tasks,
+      configure existing tasks, or delete tasks.
 email: djberg96@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-- CHANGES
-- MANIFEST
-- doc/taskscheduler.txt
-files: 
-- CHANGES
-- doc/taskscheduler.txt
-- examples/taskscheduler_example.rb
+extra_rdoc_files: []
+files:
+- lib/win32-taskscheduler.rb
 - lib/win32/taskscheduler.rb
-- MANIFEST
-- Rakefile
-- README
-- test/test_taskscheduler.rb
-- win32-taskscheduler.gemspec
-has_rdoc: true
-homepage: http://www.rubyforge.org/projects/win32utils
-licenses: 
-- Artistic 2.0
+- lib/win32/taskscheduler/constants.rb
+- lib/win32/taskscheduler/helper.rb
+- lib/win32/taskscheduler/sid.rb
+- lib/win32/taskscheduler/time_calc_helper.rb
+- lib/win32/taskscheduler/version.rb
+homepage: https://github.com/chef/win32-taskscheduler
+licenses:
+- Artistic-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.8.0
-  version: 
-required_rubygems_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"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: win32utils
-rubygems_version: 1.3.4
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A library for the Windows task scheduler
-test_files: 
-- test/test_taskscheduler.rb
+test_files: []

data/CHANGES

@@ -1,51 +0,0 @@
-== 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 +0,0 @@
-* 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

data/README

@@ -1,68 +0,0 @@
-= Description
-The win32-taskscheduler library is a Ruby interface to the MS Windows Task
-Scheduler. It is analogous to the Unix cron daemon.
-
-= 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('foo', trigger)
-   ts.application_name = 'notepad.exe'
-   ts.save
-
-= Prerequisites
-Ruby 1.8.2 or later.
-Building from source requires VC++ 6.0 or later.
-Windows XP or earlier. Vista and later not currently supported.
-
-= Installation
-rake install (non-gem) OR rake install_gem (gem)
-
-For most of you 'gem install win32-taskscheduler' will work.
-
-= 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.
-
-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.
-
-= On using OLE + WMI + Win32_ScheduledJob
-I will probably include a pure Ruby version of this library at some point,
-and you can find what I have so far in CVS under lib/win32. Note, however,
-that there are some significant differences in behavior between the C
-library and WMI, along with limitations regarding modification to existing
-tasks.
-
-You can find a list of differences here: http://tinyurl.com/2l3yau
-
-= Developer's Notes
-The CoInitialize() function is used internally instead of CoInitializeEx()
-function intentionally. The CoInitialize() function merely calls the
-CoInitializeEx() function with NULL and COINIT_APARTMENTTHREADED arguments,
-which is what we would do in any case.