win32-service 0.7.2 → 0.8.0

data/CHANGES

@@ -1,3 +1,7 @@
+== 0.8.0 - ???
+* Converted all code to use FFI. This includes the Daemon code, which means
+  that it also now works with JRuby.
+
 == 0.7.2 - 7-Sep-2011
 * Now works with mingw compiler by skipping __try and __finally if using
   mingw, or using them with mingw if the seh.h header is found.

data/MANIFEST

@@ -5,15 +5,14 @@
 * win32-service.gemspec
 * doc/daemon.txt
 * doc/service.txt
-* ext/extconf.rb
-* ext/win32/daemonc.c
 * examples/demo_daemon.rb
 * examples/demo_daemon_ctl.rb
 * examples/demo_services.rb
 * lib/win32/service.rb
+* lib/win32/daemon.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
+* test/test_win32_service.rb

data/README

@@ -1,71 +1,75 @@
-== Description
-  The win32-service library allows you to control or create MS Windows services.
-
-== Installation
-  gem install win32-service                        # Build from source
-  gem install win32-service --platform x86-mingw32 # Install binary
-
-== Synopsis
-  require 'win32/service'
-
-  # Iterate over the available services
-  Service.services do |service|
-    p service
-  end
-
-== More Documentation
-  Please see the documentation in the 'doc' directory, or the gem documentation
-  that was installed when you installed this library as a gem.
-
-== Known Issues
-=== Problem:
-  Service.delete causes "Unable to delete: The specified service has been
-  marked for deletion."
- 
-=== Troubleshooting:
-  This can be caused by one of two things. Either you attempted to delete a
-  running service without stopping it first, or you have the Services
-  Administrative Tool (GUI) open. In the former case, the solution is to first
-  stop the service if it's running. In the latter, close the Services GUI
-  admin tool before deleting.
-	
-=== Problem:
-  Service.start causes, "The service did not respond to the start or control
-  request in a timely fashion."
-
-=== Troubleshooting:
-  The best way to debug your services is to wrap your entire Daemon subclass
-  in a begin/end block and send error messages to a file. That should give a
-  good clue as to the nature of the problem. The most probable culprits are:
-
-  * You've tried to require a library that's not in your $LOAD_PATH. Make sure
-  that your require statements are inside the begin/rescue block so that you can
-  easily find those mistakes.
-
-  * Your have a bad binary path name. Be sure to use an absolute path name for
-  the binary path name, including the full path to the Ruby interpreter, e.g.
-  'c:\ruby\bin\ruby' instead of just 'ruby'.
-
-  * You've got a syntax error in your code somewhere.
-
-== See Also
-  ruby-wmi
-
-== Future Plans
-  Pure Ruby Daemon class
-  Add service_session_change hook
-
-== Copyright
-  (C) 2003-2011, Daniel J. Berger, All Rights Reserved
-    
-== License
-  Artistic 2.0
-    
-== 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.
-    
-== Authors
-  Daniel J. Berger   
-  Park Heesob
+== Description
+  The win32-service library allows you to control or create MS Windows services.
+
+== Installation
+  gem install win32-service
+
+== Synopsis
+  require 'win32/service'
+
+  # Iterate over the available services
+  Service.services do |service|
+    p service
+  end
+
+== More Documentation
+  Please see the documentation in the 'doc' directory, or the gem documentation
+  that was installed when you installed this library as a gem.
+
+== Known Issues
+=== Problem:
+  Service.delete causes "Unable to delete: The specified service has been
+  marked for deletion."
+ 
+=== Troubleshooting:
+  This can be caused by one of two things. Either you attempted to delete a
+  running service without stopping it first, or you have the Services
+  Administrative Tool (GUI) open. In the former case, the solution is to first
+  stop the service if it's running. In the latter, close the Services GUI
+  admin tool before deleting.
+	
+=== Problem:
+  Service.start causes, "The service did not respond to the start or control
+  request in a timely fashion."
+
+=== Troubleshooting:
+  The best way to debug your services is to wrap your entire Daemon subclass
+  in a begin/end block and send error messages to a file. That should give a
+  good clue as to the nature of the problem. The most probable culprits are:
+
+  * You've tried to require a library that's not in your $LOAD_PATH. Make sure
+  that your require statements are inside the begin/rescue block so that you can
+  easily find those mistakes.
+
+  * Your have a bad binary path name. Be sure to use an absolute path name for
+  the binary path name, including the full path to the Ruby interpreter, e.g.
+  'c:\ruby\bin\ruby' instead of just 'ruby'.
+
+  * You've got a syntax error in your code somewhere.
+
+== See Also
+  ruby-wmi
+
+== Future Plans
+  Add service_session_change hook
+
+== Copyright
+  (C) 2003-2013, Daniel J. Berger, All Rights Reserved
+    
+== License
+  Artistic 2.0
+
+== Contributions
+  Although this library is free, please consider having your company
+  setup a gittip if used by your company professionally.
+
+  http://www.gittip.com/djberg96/
+    
+== 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.
+    
+== Authors
+  Daniel J. Berger   
+  Park Heesob

data/Rakefile

@@ -2,105 +2,25 @@ require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rbconfig'
-include Config
+include RbConfig
 
 CLEAN.include(
-  '**/*.gem',    # Gem files
-  '**/*.rbc',    # Rubinius
-  '**/*.o',      # C object file
-  '**/*.log',    # Ruby extension build log
-  '**/Makefile', # C Makefile
-  "**/*.so",     # C shared object
-  "**/*.lib",    # C build file
-  "**/*.def",    # C build file
-  "**/*.pdb",    # C build file
-  "**/*.exp",    # C build file
-  "**/*.obj",    # C build file
-  "**/*.log",    # C build file
-  "lib/win32/ruby18", "lib/win32/ruby19", "lib/win32/daemon.rb"
+  '**/*.gem', # Gem files
+  '**/*.rbc'  # Rubinius
 )
 
-desc "Build the win32-service library"
-task :build => [:clean] do
-  make = CONFIG['host_os'] =~ /mingw|cygwin/i ? "make" : "nmake"
-
-  Dir.chdir('ext') do
-    ruby 'extconf.rb'
-    sh "#{make}"
-    FileUtils.cp('daemon.so', 'win32/daemon.so')      
-  end  
-end
-
 namespace 'gem' do
-  desc 'Build the gem'
+  desc "Create the win32-service gem"
   task :create => [:clean] do
-    spec = eval(IO.read('win32-service.gemspec')) 
+    spec = eval(IO.read('win32-service.gemspec'))
     Gem::Builder.new(spec).build
   end
 
-  desc 'Install the gem'
+  desc "Install the win32-service gem"
   task :install => [:create] do
     file = Dir['*.gem'].first
     sh "gem install #{file}"
   end
-
-  desc 'Build a binary gem'
-  task :binary => [:build] do
-    mkdir_p 'lib/win32'
-    mv 'ext/win32/daemon.so', 'lib/win32/daemon.so'
-
-    spec = eval(IO.read('win32-service.gemspec'))
-    spec.extensions = nil
-    spec.platform = Gem::Platform::CURRENT
-
-    spec.files = spec.files.reject{ |f| f.include?('ext') }
-
-    Gem::Builder.new(spec).build
-  end
-
-  # This is for me, not for you.
-  desc 'Create a gem with binaries for 1.8 and 1.9'
-  task :binaries => [:clean] do
-    make = CONFIG['host_os'] =~ /mingw|cygwin/i ? "make" : "nmake"
-
-    mkdir_p "lib/win32/ruby18"
-    mkdir_p "lib/win32/ruby19"
-
-    Dir.chdir('ext') do
-      # Ruby 1.8
-      sh "C:\\ruby187\\bin\\ruby extconf.rb"
-      sh "#{make}"
-      mv 'daemon.so', '../lib/win32/ruby18'
-      sh "#{make} distclean"
-
-      # Ruby 1.9
-      sh "C:\\ruby192\\bin\\ruby extconf.rb"
-      sh "#{make}"
-      mv 'daemon.so', '../lib/win32/ruby19'
-    end
-
-    File.open("lib/win32/daemon.rb", "w"){ |fh|
-      fh.puts "if RUBY_VERSION.to_f >= 1.9"
-      fh.puts "  require 'win32/ruby19/daemon'"
-      fh.puts "else"
-      fh.puts "  require 'win32/ruby18/daemon'"
-      fh.puts "end"
-    }
-
-    spec = eval(IO.read('win32-service.gemspec'))
-    spec.extensions = nil
-    spec.platform = Gem::Platform::CURRENT
-
-    spec.files = spec.files.reject{ |f| f.include?('ext') }
-
-    spec.files += [
-      'lib/win32/daemon.rb',
-      'lib/win32/ruby18/daemon.so',
-      'lib/win32/ruby19/daemon.so'
-    ]
-
-    Gem::Builder.new(spec).build
-  end
 end
 
 namespace :example do
@@ -113,16 +33,13 @@ end
 namespace 'test' do
   desc 'Run all tests for the win32-service library'
   Rake::TestTask.new('all') do |t|
-    task :all => :build
-    t.libs << 'ext'
     t.verbose = true
     t.warning = true
   end
 
   desc 'Run the tests for the Win32::Daemon class'
   Rake::TestTask.new('daemon') do |t|
-    task :daemon => :build
-    t.libs << 'ext'
+    task :daemon
     t.verbose = true
     t.warning = true
     t.test_files = FileList['test/test_win32_daemon.rb']

data/doc/daemon.txt

@@ -128,21 +128,21 @@ Daemon::IDLE
 
 = Known Bugs
   None known.  Please report any bugs you find on the Bug tracker at
-  http://rubyforge.org/projects/win32utils.
+  https//github.com/djberg96/win32-service
 
 = Future Plans
-  Rewrite the Daemon class in pure Ruby.
+  None at this time.
 
-  Suggestions welcome. Please log them on the Feature Request tracker at
-  http://rubyforge.org/projects/win32utils
+  Suggestions welcome. Please post them on the github project page at
+  https//github.com/djberg96/win32-service
    
 = Acknowledgements
   Many thanks go to Patrick Hurley for providing the fix for the thread
-  blocking issue. Thanks also go to Kevin Burge for his patch that solved
-  service responsiveness issues.
+  blocking issue for the original C code. Thanks also go to Kevin Burge for
+  his patch that solved service responsiveness issues.
     
 = Copyright
-  (C) 2003-2011 Daniel J. Berger, All Rights Reserved
+  (C) 2003-2013 Daniel J. Berger, All Rights Reserved
 
 = License
   Artistic 2.0

data/doc/service.txt

@@ -2,7 +2,7 @@
   An interface for MS Windows Services.
     
 = Prerequisites
-  Ruby 1.8.2 or later.
+  FFI 1.0 or later
 	
   This library is only supported for the Windows NT family of operating
   systems, e.g. 2000, XP, 2003, etc. It is NOT supported (and won't
@@ -28,7 +28,7 @@
     :dependencies       => ['W32Time','Schedule']
     :service_start_name => 'SomeDomain\\User',
     :password           => 'XXXXXXX',
-    :display_name       => 'This is some service',
+    :display_name       => 'This is some service'
   )
     
   # Configure a service that already exists
@@ -338,27 +338,26 @@ Service::ERROR_CRITICAL
   There may be a failure in the test suite if the W32Time dependency is
   not started.
 
-  If you find any bugs please log them on the bug tracker.  You can find it
-  on the project page at http://www.rubyforge.org/projects/win32utils.
+  If you find any bugs please log them on the github project page at
+  https://github.com/djberg96/win32-service
    
 = Acknowledgements
   Many thanks go to Patrick Hurley for providing the fix for the thread
-  blocking issue. Thanks also go to Kevin Burge for his patch that solved
-  service responsiveness issues.
+  blocking issue in the original C code. Thanks also go to Kevin Burge for
+  his patch that solved service responsiveness issues.
     
 = Future Plans
   Add Tag_ID support.
   Add ability to create or modify service failure actions.
-  Use RegisterServiceCtrlHandlerEx().
     
 = Copyright
-  (C) 2003-2011, Daniel J. Berger, All Rights Reserved
+  (C) 2003-2013, Daniel J. Berger, All Rights Reserved
     
 = 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.
     
-== Author(s)
+== Authors
 * Daniel J. Berger   
 * Park Heesob

data/examples/demo_daemon.rb

@@ -1,6 +1,6 @@
-LOG_FILE = 'C:\\win32_daemon_test.log'
+LOG_FILE = 'C:\\Tmp\\win32_daemon_test.log'
 
-begin  
+begin
   require 'rubygems'
   require 'win32/daemon'
   include Win32
@@ -17,7 +17,7 @@ begin
         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.
@@ -41,7 +41,7 @@ begin
       # While we're in here the daemon is running.
       while running?
         if state == RUNNING
-          sleep 20 
+          sleep 20
           msg = 'Service is running as of: ' + Time.now.to_s
           File.open(LOG_FILE, 'a'){ |f| f.puts msg }
         else # PAUSED or IDLE
@@ -50,14 +50,14 @@ begin
       end
 
       # We've left the loop, the daemon is about to exit.
-      
+
       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
@@ -68,14 +68,14 @@ begin
       File.open(LOG_FILE, 'a'){ |f| f.puts msg }
       exit!
     end
-      
-    # This event triggers when the service receives a signal to pause. 
+
+    # 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.
     #
@@ -90,6 +90,6 @@ begin
   #
   DemoDaemon.mainloop
 rescue Exception => err
-  File.open(LOG_FILE, 'a'){ |fh| fh.puts 'Daemon failure: ' + err }
+  File.open(LOG_FILE, 'a'){ |fh| fh.puts "Daemon failure: #{err}" }
   raise
 end