rufus-scheduler-win32-service 0.0.1 → 0.0.2

data/README.md

@@ -18,21 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
-You want to run your rufus-scheduler tasks as a Windows service. This gem provides the boilerplate:
+You want to run your rufus-scheduler tasks as a Windows service. This gem provides the boilerplate.
+
+Use the `Daemon` class as the base for the class you're going to run as a service:
 
 ```
-require 'rufus/scheduler/win32/service'
+require 'rufus/scheduler/win32/daemon'
 
-class MyService < Rufus::Scheduler::Win32::Service
+class MyService < RufusSchedulerWin32::Daemon
   def service_init
     # Set up everything and create your scheduled tasks here
     scheduler.every '5m' do |_job|
       logger.info 'Reports of my death have been greatly exaggerated'
     end
+
+    scheduler.join
   end
 end
+
+# Start the service
+MyService.mainloop
 ```
 
+You get access to the `scheduler` property to schedule your tasks and the `logger`
+property for logging.
+
 ## Contributing
 
 1. Fork it

data/lib/rufus/scheduler/win32/daemon.rb

@@ -0,0 +1,52 @@
+require 'rufus/scheduler/win32/service/version'
+require 'logger'
+require 'win32/daemon'
+require 'rufus-scheduler'
+
+module RufusSchedulerWin32
+  # Service wrapper around rufus-scheduler
+  class Daemon < Win32::Daemon
+    attr_writer :logger
+
+    def service_main
+      logger.info 'Running Main Loop'
+      while scheduler.up?
+        logger.debug 'Still Running'
+        sleep 10
+      end
+      logger.info 'Scheduler down. Exiting main loop'
+    end
+
+    def service_stop
+      logger.info 'Stopping scheduler service'
+
+      scheduler.shutdown(:wait)
+
+      logger.info 'Service stopped'
+    end
+
+    def service_pause
+      logger.info 'Pausing scheduler service'
+
+      scheduler.pause unless scheduler.paused?
+
+      logger.info 'Paused scheduler service'
+    end
+
+    def service_resume
+      logger.info 'Resuming scheduler service'
+
+      scheduler.resume if scheduler.paused?
+
+      logger.info 'Resumed scheduler service'
+    end
+
+    def scheduler
+      @scheduler ||= Rufus::Scheduler.new
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end

data/lib/rufus/scheduler/win32/service/version.rb

@@ -1,10 +1,5 @@
-module Rufus
-  module Scheduler
-    module Win32
-      # Service wrapper around rufus-scheduler
-      class Service
-        VERSION = '0.0.1'
-      end
-    end
+module RufusSchedulerWin32
+  class Service
+    VERSION = '0.0.2'
   end
 end

data/rufus-scheduler-win32-service.gemspec

@@ -5,16 +5,16 @@ require 'rufus/scheduler/win32/service/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'rufus-scheduler-win32-service'
-  spec.version       = Rufus::Scheduler::Win32::Service::VERSION
+  spec.version       = RufusSchedulerWin32::Service::VERSION
   spec.authors       = ['Jurgens du Toit']
   spec.email         = ['jrgns@jrgns.net']
   spec.description   = %(
-    A simple wrapper around the rufus-cheduler to run it as a Windows Service'
+    A simple wrapper around the rufus-scheduler to run it as a Windows Service
   ).strip
   spec.summary       = %(
-    A simple wrapper around the rufus-cheduler to run it as a Windows Service
+    A simple wrapper around the rufus-scheduler to run it as a Windows Service
   ).strip
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/jrgns/rufus-scheduler-win32-service'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($RS)

data/spec/rufus_scheduler_win32_service_spec.rb

@@ -1,7 +1,7 @@
-require 'rufus/scheduler/win32/service'
+require 'rufus/scheduler/win32/daemon'
 
-describe Rufus::Scheduler::Win32::Service do
-  subject { Rufus::Scheduler::Win32::Service.new }
+describe RufusSchedulerWin32::Daemon do
+  subject { RufusSchedulerWin32::Daemon.new }
 
   it 'provides a scheduler' do
     expect(subject).to respond_to :scheduler

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rufus-scheduler-win32-service
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -107,7 +107,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
-description: A simple wrapper around the rufus-cheduler to run it as a Windows Service'
+description: A simple wrapper around the rufus-scheduler to run it as a Windows Service
 email:
 - jrgns@jrgns.net
 executables: []
@@ -119,11 +119,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/rufus/scheduler/win32/service.rb
+- lib/rufus/scheduler/win32/daemon.rb
 - lib/rufus/scheduler/win32/service/version.rb
 - rufus-scheduler-win32-service.gemspec
 - spec/rufus_scheduler_win32_service_spec.rb
-homepage: ''
+homepage: https://github.com/jrgns/rufus-scheduler-win32-service
 licenses:
 - MIT
 post_install_message: 
@@ -144,9 +144,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.28
 signing_key: 
 specification_version: 3
-summary: A simple wrapper around the rufus-cheduler to run it as a Windows Service
+summary: A simple wrapper around the rufus-scheduler to run it as a Windows Service
 test_files:
 - spec/rufus_scheduler_win32_service_spec.rb

data/lib/rufus/scheduler/win32/service.rb

@@ -1,59 +0,0 @@
-require 'rufus/scheduler/win32/service/version'
-require 'logger'
-require 'win32/daemon'
-require 'rufus-scheduler'
-
-module Rufus
-  module Scheduler
-    # Containing module for the Service class
-    module Win32
-      include ::Win32
-
-      # Service wrapper around rufus-scheduler
-      class Service
-        attr_writer :logger
-
-        def service_main
-          logger.info 'Running Main Loop'
-          while scheduler.up?
-            logger.debug 'Still Running'
-            sleep 10
-          end
-          logger.info 'Scheduler down. Exiting main loop'
-        end
-
-        def service_stop
-          logger.info 'Stopping scheduler service'
-
-          scheduler.shutdown(:wait)
-
-          logger.info 'Service stopped'
-        end
-
-        def service_pause
-          logger.info 'Pausing scheduler service'
-
-          scheduler.pause unless scheduler.paused?
-
-          logger.info 'Paused scheduler service'
-        end
-
-        def service_resume
-          logger.info 'Resuming scheduler service'
-
-          scheduler.resume if scheduler.paused?
-
-          logger.info 'Resumed scheduler service'
-        end
-
-        def scheduler
-          @scheduler ||= Rufus::Scheduler.new
-        end
-
-        def logger
-          @logger ||= Logger.new(STDOUT)
-        end
-      end
-    end
-  end
-end