rufus-scheduler-win32-service 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rufus-scheduler-win32-service.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jurgens du Toit
+
+MIT License
+
+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,42 @@
+# Rufus::Scheduler::Win32::Service
+
+A simple wrapper around the rufus-cheduler (https://github.com/jmettraux/rufus-scheduler) to run it as a Windows Service (https://github.com/djberg96/win32-service).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rufus-scheduler-win32-service'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rufus-scheduler-win32-service
+
+## Usage
+
+You want to run your rufus-scheduler tasks as a Windows service. This gem provides the boilerplate:
+
+```
+require 'rufus/scheduler/win32/service'
+
+class MyService < Rufus::Scheduler::Win32::Service
+  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
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

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

@@ -0,0 +1,59 @@
+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

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

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

data/rufus-scheduler-win32-service.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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'
+  ).strip
+  spec.summary       = %(
+    A simple wrapper around the rufus-cheduler to run it as a Windows Service
+  ).strip
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rufus-scheduler'
+  spec.add_runtime_dependency 'win32-service'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec', '~> 2.6'
+
+end

data/spec/rufus_scheduler_win32_service_spec.rb

@@ -0,0 +1,68 @@
+require 'rufus/scheduler/win32/service'
+
+describe Rufus::Scheduler::Win32::Service do
+  subject { Rufus::Scheduler::Win32::Service.new }
+
+  it 'provides a scheduler' do
+    expect(subject).to respond_to :scheduler
+  end
+
+  it 'shuts down the scheduler when the service stops' do
+    scheduler = double.as_null_object
+    subject.stub(:scheduler) { scheduler }
+
+    subject.service_stop
+
+    expect(scheduler).to have_received(:shutdown).with(:wait)
+  end
+
+  it 'pauses the scheduler when the service pauses' do
+    scheduler = double.as_null_object
+    allow(scheduler).to receive('paused?').and_return(false)
+    subject.stub(:scheduler) { scheduler }
+
+    subject.service_pause
+
+    expect(scheduler).to have_received(:pause)
+  end
+
+  it 'does not pause an already paused scheduler when the service pauses' do
+    scheduler = double.as_null_object
+    allow(scheduler).to receive('paused?').and_return(true)
+    subject.stub(:scheduler) { scheduler }
+
+    subject.service_pause
+
+    expect(scheduler).to have_not_received(:pause)
+  end
+
+  it 'resumes the scheduler when the service resumes' do
+    scheduler = double.as_null_object
+    allow(scheduler).to receive('paused?').and_return(true)
+    subject.stub(:scheduler) { scheduler }
+
+    subject.service_resume
+
+    expect(scheduler).to have_received(:resume)
+  end
+
+  it 'does not resume an already running scheduler when the service resumes' do
+    scheduler = double.as_null_object
+    allow(scheduler).to receive('paused?').and_return(false)
+    subject.stub(:scheduler) { scheduler }
+
+    subject.service_resume
+
+    expect(scheduler).to have_not_received(:resume)
+  end
+
+  it 'has a basic logger' do
+    expect(subject).to respond_to :logger
+  end
+
+  it 'can have another logger' do
+    logger = Logger.new(STDOUT)
+    subject.logger = logger
+    expect(subject.logger).to be logger
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: rufus-scheduler-win32-service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jurgens du Toit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: win32-service
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: A simple wrapper around the rufus-cheduler to run it as a Windows Service'
+email:
+- jrgns@jrgns.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rufus/scheduler/win32/service.rb
+- lib/rufus/scheduler/win32/service/version.rb
+- rufus-scheduler-win32-service.gemspec
+- spec/rufus_scheduler_win32_service_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple wrapper around the rufus-cheduler to run it as a Windows Service
+test_files:
+- spec/rufus_scheduler_win32_service_spec.rb