win32-service 0.6.1-x86-mswin32-60 → 0.7.0-x86-mswin32-60

data/CHANGES

@@ -1,3 +1,24 @@
+== 0.7.0 - 30-Jun-2009
+* INTERFACE CHANGE: The Service.new and Service.configure methods now accept
+  a single hash argument only. The :service_name key is mandatory, while the
+  :host key is optional.
+* Fixed a bug in the Service.services method where a segfault would occur if
+  the binary_path_name was greater than 260 characters. The buffer size has
+  been increased to 1024 characters. Thanks go to Dan Daniels for the spot.
+* Altered the Daemon class so that the Ruby interpreter was not invoked within
+  the Service_Main function. The functions that close stdin, stdout and stderr
+  are now called within the mainloop method. Thanks go to Tim Hanson for the
+  spot and the patch.
+* Eliminated a minor build warning in daemon.c
+* License changed to Artistic 2.0, with corresponding gemspec update.
+* Added an uninstall rake task.
+* Updated the service_stop method in the demo_daemon.rb file, and added some
+  additional comments.
+* The test files were renamed.
+* Several tests were updated and refactored to use Test::Unit 2.x. That
+  library is now a dependency.
+* The 'uninstall' Rakefile task is now more verbose.
+
 == 0.6.1 - 1-Jan-2008
 * The Service.services method now handles the scenario where a particular
   service may still exist, but its underlying registry entry has been deleted.

data/MANIFEST

@@ -11,8 +11,9 @@
 * examples/demo_daemon_ctl.rb
 * examples/demo_services.rb
 * lib/win32/service.rb
-* test/tc_daemon.rb
-* test/tc_service_create.rb
-* test/tc_service_info.rb
-* test/tc_service_status.rb
-* test/tc_service.rb
+* test/test_win32_daemon.rb
+* test/test_win32_service_configure.rb
+* test/test_win32_service_create.rb
+* test/test_win32_service_info.rb
+* test/test_win32_service_status.rb
+* test/test_win32_service.rb

data/README

@@ -41,4 +41,5 @@ will happen if your W32Time service isn't running.
 
 = Future Plans
 * Pure Ruby Daemon class
-* Add service_session_change hook
+* Add service_session_change hook
+* Add a WMI variant of the Service class.

data/Rakefile

@@ -0,0 +1,128 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+include Config
+
+desc "Cleans up the C related files created during the build"
+task :clean do
+   Dir.chdir('ext') do
+      if File.exists?('daemon.o') || File.exists?('daemon.so')
+         sh 'nmake distclean'
+      end
+      File.delete('win32/daemon.so') if File.exists?('win32/daemon.so')
+   end
+end
+
+desc "Builds, but does not install, the win32-service library"
+task :build => [:clean] do
+   Dir.chdir('ext') do
+      ruby 'extconf.rb'
+      sh 'nmake'
+      FileUtils.cp('daemon.so', 'win32/daemon.so')      
+   end  
+end
+
+desc "Install the win32-service library (non-gem)"
+task :install => [:build] do
+   Dir.chdir('ext') do
+      sh 'nmake install'
+   end
+   install_dir = File.join(CONFIG['sitelibdir'], 'win32')
+   Dir.mkdir(install_dir) unless File.exists?(install_dir)
+   FileUtils.cp('lib/win32/service.rb', install_dir, :verbose => true)
+end
+
+desc 'Install the win32-service library as a gem'
+task :install_gem => [:clean] do
+   ruby 'win32-service.gemspec'
+   file = Dir['win32-service*.gem'].first
+   sh "gem install #{file}"
+end
+
+desc 'Uninstall the (non-gem) win32-service library.'
+task :uninstall do
+   service = File.join(CONFIG['sitelibdir'], 'win32', 'service.rb')
+   FileUtils.rm(service, :verbose => true) if File.exists?(service)
+
+   daemon = File.join(CONFIG['sitearchdir'], 'win32', 'daemon.so')
+   FileUtils.rm(daemon, :verbose => true) if File.exists?(daemon)
+end
+
+desc "Build a binary gem"
+task :build_binary_gem => [:build] do
+   if File.exists?('lib/win32/daemon.rb')
+      mv 'lib/win32/daemon.rb', 'lib/win32/daemon.orig'
+   end
+
+   cp 'ext/win32/daemon.so', 'lib/win32/daemon.so'
+
+   task :build_binary_gem => [:clean]
+
+   spec = Gem::Specification.new do |gem|
+      gem.name         = 'win32-service'
+      gem.version      = '0.7.0'
+      gem.authors      = ['Daniel J. Berger', 'Park Heesob']
+      gem.email        = 'djberg96@gmail.com'
+      gem.license      = 'Artistic 2.0'
+      gem.homepage     = 'http://www.rubyforge.org/projects/win32utils'
+      gem.platform     = Gem::Platform::CURRENT
+      gem.summary      = 'An interface for MS Windows services'
+      gem.test_files   = Dir['test/test*.rb']
+      gem.has_rdoc     = true
+      gem.files        = Dir['**/*'].delete_if{ |f|
+         f.include?('CVS') || f.include?('ext') || f.include?('daemon.orig')
+      }
+
+      gem.extra_rdoc_files = [
+         'CHANGES',
+         'README',
+         'MANIFEST',
+         'doc/service.txt',
+         'doc/daemon.txt',
+         'ext/win32/daemon.c'
+      ]
+
+      gem.rubyforge_project     = 'win32utils'
+      gem.required_ruby_version = '>= 1.8.2'
+
+      gem.add_dependency('windows-pr', '>= 1.0.5')
+      gem.add_dependency('test-unit', '>= 2.0.2')
+
+      gem.description = <<-EOF
+         The win32-service library provides a Ruby interface to services on
+         MS Windows. You can create new services, or control, configure and
+         inspect existing services.
+
+         In addition, you can create a pure Ruby service by using the Daemon
+         class that is included as part of the library.
+      EOF
+   end
+
+   Gem::Builder.new(spec).build
+end
+
+desc "Run the test suite for the win32-service library"
+Rake::TestTask.new do |t|
+   task :test => :build
+   t.libs << 'ext'
+   t.verbose = true
+   t.warning = true
+end
+
+desc "Run the test suite for the Win32::Daemon class (only)"
+Rake::TestTask.new('test_daemon') do |t|
+   task :test_daemon => :build
+   t.libs << 'ext'
+   t.verbose = true
+   t.warning = true
+   t.test_files = FileList['test/test_win32_daemon.rb']
+end
+
+task :test do
+   Rake.application[:clean].execute
+end
+
+task :test_daemon do
+   Rake.application[:clean].execute
+end

data/doc/daemon.txt

@@ -7,7 +7,7 @@
       def service_main
          while running?
             sleep 3
-            File.open("c:\\test.log","a+"){ |f| f.puts "service is running" }
+            File.open("c:\\test.log", "a"){ |f| f.puts "service is running" }
          end
       end
    end
@@ -131,6 +131,8 @@ Daemon::IDLE
    http://rubyforge.org/projects/win32utils.
 
 = Future Plans
+   Rewrite the Daemon class in pure Ruby.
+
    Suggestions welcome. Please log them on the Feature Request tracker at
    http://rubyforge.org/projects/win32utils
    
@@ -140,10 +142,10 @@ Daemon::IDLE
    service responsiveness issues.
     
 = Copyright
-   (C) 2003-2008 Daniel J. Berger, All Rights Reserved
+   (C) 2003-2009 Daniel J. Berger, All Rights Reserved
 
 = License
-   Ruby's
+   Artistic 2.0
 
 = Warranty
    This package is provided "as is" and without any express or

data/doc/service.txt

@@ -17,7 +17,8 @@
    include Win32
     
    # Create a new service
-   Service.create('some_service', nil, 
+   Service.create(
+      :service_name       => 'some_service', 
       :service_type       => Service::WIN32_OWN_PROCESS,
       :description        => 'A custom service I wrote just for fun'
       :start_type         => Service::AUTO_START,
@@ -52,11 +53,12 @@
    }
     
 = Class Methods
-Service.new(service_name, host=nil, options={})
-   Creates a new service with +service_name+ on +host+, or the local host
-   if no host is specified. The +options+ parameter is a hash that can
+Service.new(options={})
+   Creates a new service. The +options+ parameter is a hash that can
    contain any of the following parameters, and their default values:
    
+   * service_name       => nil (mandatory)
+   * host               => nil
    * display_name       => service_name
    * desired_access     => Service::ALL_ACCESS
    * service_type       => Service::WIN32_OWN_PROCESS | Service::INTERACTIVE_PROCESS
@@ -69,11 +71,12 @@ Service.new(service_name, host=nil, options={})
    * password           => nil
    * description        => nil
 
-Service.configure(service_name, host=nil, options={})   
-   Configures the named +service_name+ on +host+, or the local host if no
-   host is specified. The +options+ parameter is a hash that can contain any
-   of the following parameters:
+Service.configure(options={})   
+   Configures an existing service. The +options+ parameter is a hash that can
+   contain any of the following parameters:
    
+   * service_name (mandatory)
+   * host
    * service_type
    * start_type
    * error_control
@@ -350,10 +353,10 @@ Service::ERROR_CRITICAL
    Use RegisterServiceCtrlHandlerEx().
     
 = Copyright
-   (C) 2003-2008, Daniel J. Berger, All Rights Reserved
+   (C) 2003-2009, Daniel J. Berger, All Rights Reserved
     
 = License
-   Ruby's
+   Artistic 2.0
     
 = Warranty
    This package is provided "as is" and without any express or

data/examples/demo_daemon.rb

@@ -0,0 +1,89 @@
+LOG_FILE = 'C:\\test.log'
+
+begin  
+   require 'win32/daemon'
+   include Win32
+
+   class DemoDaemon < Daemon
+      # This method fires off before the +service_main+ mainloop is entered.
+      # Any pre-setup code you need to run before your service's mainloop
+      # starts should be put here. Otherwise the service might fail with a
+      # timeout error when you try to start it.
+      #
+      def service_init
+         10.times{ |i|
+            File.open(LOG_FILE , 'a'){ |f| f.puts("#{i}") }
+            sleep 1
+         }
+      end
+      
+      # This is the daemon's mainloop. In other words, whatever runs here
+      # is the code that runs while your service is running. Note that the
+      # loop is not implicit.
+      #
+      # You must setup a loop as I've done here with the 'while running?'
+      # code, or setup your own loop. Otherwise your service will exit and
+      # won't be especially useful.
+      #
+      # In this particular case, I've setup a loop to append a short message
+      # and timestamp to a file on your C: drive every 20 seconds. Be sure
+      # to stop the service when you're done!
+      #
+      def service_main(*args)
+         msg = 'service_main entered at: ' + Time.now.to_s
+         File.open(LOG_FILE, 'a'){ |f|
+            f.puts msg
+            f.puts "Args: " + args.join(',')
+         }
+
+         while running?
+            if state == RUNNING
+               sleep 20 
+               msg = 'Service is running as of: ' + Time.now.to_s
+               File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+            else
+               sleep 0.5
+            end
+         end
+      
+         File.open(LOG_FILE, 'a'){ |f| f.puts "STATE: #{state}" }
+      
+         msg = 'service_main left at: ' + Time.now.to_s
+         File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+      end
+   
+      # This event triggers when the service receives a signal to stop. I've
+      # added an explicit "exit!" here to ensure that the Ruby interpreter exits
+      # properly. I use 'exit!' instead of 'exit' because otherwise Ruby will
+      # raise a SystemExitError, which I don't want.
+      #
+      def service_stop
+         msg = 'Received stop signal at: ' + Time.now.to_s
+         File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+         exit!
+      end
+      
+      # This event triggers when the service receives a signal to pause. 
+      #
+      def service_pause
+         msg = 'Received pause signal at: ' + Time.now.to_s
+         File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+      end
+      
+      # This event triggers when the service receives a signal to resume
+      # from a paused state.
+      #
+      def service_resume
+         msg = 'Received resume signal at: ' + Time.now.to_s
+         File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+      end
+   end
+
+   # Create an instance of the Daemon and put it into a loop. I borrowed the
+   # method name 'mainloop' from Tk, btw.
+   #
+   DemoDaemon.mainloop
+rescue Exception => err
+   File.open(LOG_FILE, 'a'){ |fh| fh.puts 'Daemon failure: ' + err }
+   raise
+end

data/examples/demo_daemon_ctl.rb

@@ -0,0 +1,122 @@
+############################################################################
+# demo_daemon_ctl.rb
+#
+# This is a command line script for installing and/or running a small
+# Ruby program as a service.  The service will simply write a small bit
+# of text to a file every 20 seconds. It will also write some text to the
+# file during the initialization (service_init) step.
+#
+# It should take about 10 seconds to start, which is intentional - it's a test
+# of the service_init hook, so don't be surprised if you see "one moment,
+# start pending" about 10 times on the command line.
+#
+# The file in question is C:\test.log.  Feel free to delete it when finished.
+#
+# To run the service, you must install it first.
+#
+# Usage: ruby demo_daemon_ctl.rb <option>
+#
+# Note that you *must* pass this program an option
+#
+# Options:
+#    install    - Installs the service.  The service name is "DemoSvc"
+#                 and the display name is "Demo".
+#    start      - Starts the service.  Make sure you stop it at some point or
+#                 you will eventually fill up your filesystem!.
+#    stop       - Stops the service.
+#    pause      - Pauses the service.
+#    resume     - Resumes the service.
+#    uninstall  - Uninstalls the service.
+#    delete     - Same as uninstall.
+#
+# You can also used the Windows Services GUI to start and stop the service.
+#
+# To get to the Windows Services GUI just follow:
+#    Start -> Control Panel -> Administrative Tools -> Services
+############################################################################
+require 'win32/service'
+require 'rbconfig'
+include Win32
+include Config
+
+# Make sure you're using the version you think you're using.
+puts 'VERSION: ' + Service::VERSION
+
+SERVICE_NAME = 'DemoSvc'
+SERVICE_DISPLAYNAME = 'Demo'
+
+# Quote the full path to deal with possible spaces in the path name.
+ruby = File.join(CONFIG['bindir'], 'ruby').tr('/', '\\')
+path = ' "' + File.dirname(File.expand_path($0)).tr('/', '\\')
+path += '\demo_daemon.rb"'
+cmd = ruby + path
+
+# You must provide at least one argument.
+raise ArgumentError, 'No argument provided' unless ARGV[0]
+
+case ARGV[0].downcase
+   when 'install'
+      Service.new(
+         :service_name     => SERVICE_NAME,
+         :display_name     => SERVICE_DISPLAYNAME,
+         :description      => 'Sample Ruby service',
+         :binary_path_name => cmd
+      )
+      puts 'Service ' + SERVICE_NAME + ' installed'      
+   when 'start'
+      if Service.status(SERVICE_NAME).current_state != 'running'
+         Service.start(SERVICE_NAME, nil, 'hello', 'world')
+         while Service.status(SERVICE_NAME).current_state != 'running'
+            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+            sleep 1
+         end
+         puts 'Service ' + SERVICE_NAME + ' started'
+      else
+         puts 'Already running'
+      end
+   when 'stop'
+      if Service.status(SERVICE_NAME).current_state != 'stopped'
+         Service.stop(SERVICE_NAME)
+         while Service.status(SERVICE_NAME).current_state != 'stopped'
+            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+            sleep 1
+         end
+         puts 'Service ' + SERVICE_NAME + ' stopped'
+      else
+         puts 'Already stopped'
+      end
+   when 'uninstall', 'delete'
+      if Service.status(SERVICE_NAME).current_state != 'stopped'
+         Service.stop(SERVICE_NAME)
+      end
+      while Service.status(SERVICE_NAME).current_state != 'stopped'
+         puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+         sleep 1
+      end
+      Service.delete(SERVICE_NAME)
+      puts 'Service ' + SERVICE_NAME + ' deleted'
+   when 'pause'
+      if Service.status(SERVICE_NAME).current_state != 'paused'
+         Service.pause(SERVICE_NAME)
+         while Service.status(SERVICE_NAME).current_state != 'paused'
+            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+            sleep 1
+         end
+         puts 'Service ' + SERVICE_NAME + ' paused'
+      else
+         puts 'Already paused'
+      end
+   when 'resume'
+      if Service.status(SERVICE_NAME).current_state != 'running'
+         Service.resume(SERVICE_NAME)
+         while Service.status(SERVICE_NAME).current_state != 'running'
+            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+            sleep 1
+         end
+         puts 'Service ' + SERVICE_NAME + ' resumed'
+      else
+         puts 'Already running'
+      end
+   else
+      raise ArgumentError, 'unknown option: ' + ARGV[0]
+end