win-service 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1.0 / 2011-05-05
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,16 @@
+Manifest.txt
+History.txt
+README.txt
+Rakefile
+win-service.gemspec
+lib/win/service.rb
+lib/win/service_controller.rb
+lib/win/service_controller/service_controller.rb
+lib/win/service_controller/service_errors.rb
+lib/win/service_controller/unix_service.rb
+lib/win/service_controller/windows_service.rb
+spec/service_controller_spec.rb
+spec/service_spec.rb
+spec/spec_helper.rb
+spec/unix_service_spec.rb
+spec/windows_service_spec.rb

data/README.txt

@@ -0,0 +1,60 @@
+= win_service
+
+http://rubyforge.org/projects/win-service/
+
+== DESCRIPTION:
+
+A ruby gem that will allow the basic functions of getting the status, stopping and starting of a windows service from both a windows and a mac os x operating system.
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+  $ irb
+  >> require 'win/service'
+  >> service = Win::Service.new('SERVICE_NAME', 'IP_OF_SERVER', 'USER_NAME', 'PASSWORD')
+  >> service.status
+  >> service.start
+  >> service.pause
+  >> service.resume
+  >> service.stop
+
+== REQUIREMENTS:
+
+== INSTALL:
+
+rake rspec (optional)
+rake install
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake install
+
+This task will install the gem, any missing dependencies and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 FIX
+
+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/Rakefile

@@ -0,0 +1,108 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rspec/version'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+require 'rbconfig'
+require 'hoe'
+include Config
+
+# Hoe.plugin :compiler
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :inline
+# Hoe.plugin :racc
+# Hoe.plugin :rubyforge
+
+Hoe.spec 'win-service' do
+  self.name         = 'win-service'
+  self.version      = '0.1.0'
+  self.author       = 'James T. Pavlic'
+  self.email        = 'james_pavlic@hotmail.com'
+  self.summary      = 'An interface for MS Windows services'
+  self.remote_rdoc_dir = '' # Release to root
+  self.url = 'http://codinghappy.blogspot.com/'
+ 
+  self.extra_rdoc_files = [
+    'History.txt',
+    'README.txt',
+    'Manifest.txt'
+  ]
+
+  self.description = <<-EOF
+      A ruby gem that will allow the basic functions of getting the status,
+      stopping and starting of a windows service from both a windows and a mac os x operating system.
+  EOF
+end
+
+desc 'Install the (non-gem) win-service library.'
+task :install_non_gem do
+  install_dir = CONFIG['sitelibdir']
+  Dir.mkdir(install_dir) unless File.exists?(install_dir)
+  FileUtils.cp_r('lib/win', install_dir, :verbose => true)
+end
+
+desc 'Uninstall the (non-gem) win-service library.'
+task :uninstall_non_gem do
+  install_dir = File.join(CONFIG['sitelibdir'], 'win')
+  FileUtils.rm_r(install_dir, :verbose => true) if File.exists?(install_dir)
+end
+
+desc "Run the test suite for the win-service library."
+RSpec::Core::RakeTask.new('rspec') do |t|
+  t.pattern = '**/*_spec.rb'
+end
+
+desc "Install the win-service gem"
+task :install do
+  spec = Gem::Specification.new do |gem|
+    gem.name         = 'win-service'
+    gem.version      = '0.1.0'
+    gem.authors      = ['James T. Pavlic']
+    gem.email        = 'james_pavlic@hotmail.com'
+    gem.license      = 'The MIT License'
+    gem.homepage     = 'https://github.com/jpavlic/win-service'
+    gem.platform     = Gem::Platform::RUBY
+    gem.summary      = 'An interface for MS Windows services'
+    gem.add_development_dependency('rspec')
+    gem.has_rdoc     = true
+    gem.files        = Dir['**/*'].delete_if { |f|
+    }
+
+    gem.extra_rdoc_files = [
+      'History.txt',
+      'README.txt',
+      'Manifest.txt'
+    ]
+
+    gem.rubyforge_project     = 'win-service'
+    gem.required_ruby_version = '>= 1.8.7'
+
+    gem.description = <<-EOF
+      A ruby gem that will allow the basic functions of getting the status,
+      stopping and starting of a windows service from both a windows and a mac os x operating system.
+    EOF
+  end
+
+  Gem::Builder.new(spec).build
+
+  file = Dir['win-service*.gem'].first
+  sh "gem install #{file}"
+end
+
+Rake::RDocTask.new do |rdoc|
+  files = [ 'README.txt',
+            'History.txt',
+            'Manifest.txt',
+            'doc/*.rdoc',
+            'spec/*_spec.rb',
+            'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.title = 'win-service documentation'
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options << '--line-number' << '--inline-source'
+end
+
+# vim: syntax=ruby

data/lib/win/service.rb

@@ -0,0 +1,36 @@
+require 'rbconfig'
+require 'win/service_controller'
+
+module Win
+  class Service
+    VERSION = '0.1.0'
+    include Win::ServiceController
+
+    def initialize(service_name, service_address, user_name, user_password)
+      @name = service_name
+      @host = service_address
+      @user = user_name
+      @password = user_password
+    end
+
+    def start
+      start_service
+    end
+
+    def stop
+      stop_service
+    end
+
+    def pause
+      pause_service
+    end
+
+    def resume
+      resume_service
+    end
+
+    def status
+      service_status
+    end
+  end
+end

data/lib/win/service_controller.rb

@@ -0,0 +1,2 @@
+require 'win/service_controller/service_controller'
+require 'win/service_controller/service_errors'

data/lib/win/service_controller/service_controller.rb

@@ -0,0 +1,14 @@
+require 'win/service_controller/unix_service'
+require 'win/service_controller/windows_service'
+
+module Win
+  module ServiceController
+    def self.included(clz)
+      if Config::CONFIG['host_os'] =~ /mingw32/
+        clz.send :include, WindowsService
+      else
+        clz.send :include, UnixService
+      end
+    end
+  end
+end

data/lib/win/service_controller/service_errors.rb

@@ -0,0 +1,57 @@
+module Win
+  module ServiceErrors
+    class Error
+      attr_reader :error
+
+      def initialize(error)
+        @error = error
+      end
+    end
+
+    class Errors
+      @errors = {
+        "0x0000041B"=> "A stop control has been sent to a service that other running services are dependent on.",
+        "0x0000041C" => "The requested control is not valid for this service.",
+        "0x0000041D" => "The service did not respond to the start or control request in a timely fashion.",
+        "0x0000041E" => "A thread could not be created for the service.",
+        "0x0000041F" => "The service database is locked.",
+        "0x00000420" => "An instance of the service is already running.",
+        "0x00000421" => "The account name is invalid or does not exist, or the password is invalid for the account name specified.",
+        "0x00000422" => "The service cannot be started, either because it is disabled or because it has no enabled devices associated with it.",
+        "0x00000423" => "Circular service dependency was specified.",
+        "0x00000424" => "The specified service does not exist as an installed service.",
+        "0x00000425" => "The service cannot accept control messages at this time.",
+        "0x00000426" => "The service has not been started.",
+        "0x00000427" => "The service process could not connect to the service controller.",
+        "0x00000428" => "An exception occurred in the service when handling the control request.",
+        "0x00000429" => "The database specified does not exist.",
+        "0x0000042A" => "The service has returned a service-specific error code.",
+        "0x0000042B" => "The process terminated unexpectedly.",
+        "0x0000042C" => "The dependency service or group failed to start.",
+        "0x0000042D" => "The service did not start due to a logon failure.",
+        "0x0000042E" => "After starting, the service hung in a start-pending state.",
+        "0x0000042F" => "The specified service database lock is invalid.",
+        "0x00000430" => "The specified service has been marked for deletion.",
+        "0x00000431" => "The specified service already exists.",
+        "0x00000432" => "The system is currently running with the last-known-good configuration.",
+        "0x00000433" => "The dependency service does not exist or has been marked for deletion.",
+        "0x00000434" => "The current boot has already been accepted for use as the last-known-good control set.",
+        "0x00000435" => "No attempts to start the service have been made since the last boot.",
+        "0x00000436" => "The name is already in use as either a service name or a service display name.",
+        "0x00000437" => "The account specified for this service is different from the account specified for other services running in the same process.",
+        "0x00000438" => "Failure actions can only be set for Win32 services, not for drivers.",
+        "0x00000439" => "This service runs in the same process as the service control manager. Therefore, the service control manager cannot take action if this service's process terminates unexpectedly.",
+        "0x0000043A" => "No recovery program has been configured for this service.",
+        "0x0000043B" => "The executable program that this service is configured to run in does not implement the service."
+        }
+
+      def self.error_from_code(code)
+        result = @errors[code]
+
+        return Error.new("#{code}") if result.nil?
+
+        Error.new(result)
+      end
+    end
+  end
+end

data/lib/win/service_controller/unix_service.rb

@@ -0,0 +1,51 @@
+require 'open3'
+
+module Win
+  module ServiceController
+    module UnixService
+      def start_service
+        execute_net_rpc_command :start
+      end
+
+      def stop_service
+        execute_net_rpc_command :stop
+      end
+
+      def service_status
+        result = execute_net_rpc_command :status
+        status = remove_tabs_from_string(result).split("\n")[0].scan(/\w+/)
+        return status[status.size-1]
+      end
+
+      def pause_service
+        execute_net_rpc_command :pause
+      end
+
+      def resume_service
+        execute_net_rpc_command :resume
+      end
+
+      private
+
+      def execute_net_rpc_command(command)
+        stdin, stdout, stderr = Open3.popen3(net_rpc_for command.to_s)
+        out = stdout.read
+        err = stderr.read
+
+        error_code = err.scan(/0x00000\d*/)[0] if err.size > 0
+        error_code = err.gsub("\n", "") if error_code.nil?
+
+        raise ServiceErrors::Errors.error_from_code(error_code).error unless err.size == 0
+        out if command.to_s == 'status'
+      end
+
+      def net_rpc_for(command)
+        "net rpc -I #{@host} -U #{@user}%#{@password} service #{command} #{@name}"
+      end
+
+      def remove_tabs_from_string(result)
+        result.gsub("\t", "")
+      end
+    end
+  end
+end

data/lib/win/service_controller/windows_service.rb

@@ -0,0 +1,65 @@
+module Win
+  module ServiceController
+    module WindowsService
+      def start_service
+        execute_service_control_command(service_control_for :start)
+      end
+
+      def stop_service
+        execute_service_control_command(service_control_for :stop)
+      end
+
+      def pause_service
+         execute_service_control_command(service_control_for :pause)
+      end
+
+      def resume_service
+        execute_service_control_command(service_control_for :continue)
+      end
+
+      def service_status
+        result = execute_service_control_command(service_control_for :query)
+
+        status = remove_tabs_from_string(result).split("\n").find_all{|item| item =~ /STATE/}[0].scan(/\w+/).last.downcase
+        status = "pending" if status.include? "pending"
+
+        status
+      end
+
+      private
+
+      def execute_shell_command(command)
+        %x[#{command}]
+      end
+
+      def execute_service_control_command(service_control_command)
+        logon # required to authenticate
+        result = execute_shell_command(service_control_command)
+
+        extract_error_code_from_results(result) if result.upcase.include? "FAILED"
+        return result if service_control_command.include? 'query'
+      end
+      
+      def remove_tabs_from_string(result)
+        result.gsub("\t", "")
+      end
+
+      def extract_error_code_from_results(result)
+        raise ServiceErrors::Errors.error_from_code(result).error
+      end
+
+      def service_control_for(command)
+        "sc \\\\#{@host} #{command.to_s} #{@name}"
+      end
+
+      def login_command
+        #net use \\ADDRESS\IPC$ PASSWORD /user:USERWITHDOMAIN
+        "net use \\\\#{@host}\\IPC$ #{@password} /user:#{@host}\\#{@user}"
+      end
+
+      def logon
+        result = %x[#{login_command}].gsub("\n", "")
+      end
+    end
+  end
+end

data/spec/service_controller_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.configure do |config|
+  if Config::CONFIG['host_os'] =~ /darwin/
+    config.filter_run_excluding :windows => true
+  end
+end
+
+describe Win::ServiceController do
+  describe "when module is loaded on Windows", :windows => true do
+    let(:service) { double('service')}
+
+    it "should extend the WindowsService module when on Windows platform" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+    end
+  end
+
+  describe "when module is loaded on UNIX", :unix => true do
+    let(:service) { double('service')}
+      it "should extend the UnixService module when on the OS X platform" do
+        service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+        Win::ServiceController.included(service)
+    end
+  end
+end

data/spec/service_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Win::Service do
+  before do
+    @remote_service = Win::Service.new("W3SVC", "10.30.0.62", "Administrator", "passpass00")
+  end
+
+  it "should give the status of running when the service has been started" do
+    @remote_service.stub!(:service_status).and_return("running")
+    @remote_service.status.should == "running"
+  end
+
+  it "should confirm that the service has been started" do
+    @remote_service.stub!(:start_service).and_return(true)
+    @remote_service.start.should be_true
+  end
+
+  it "should give an error if the service was already started when starting" do
+    @remote_service.stub!(:start_service).and_return(Win::ServiceErrors::Errors.error_from_code("0x00000420").error)
+    @remote_service.start.should == "An instance of the service is already running."
+  end
+
+  it "should give the status of running when the service has been stopped" do
+    @remote_service.stub!(:service_status).and_return("stopped")
+    @remote_service.status.should == "stopped"
+  end
+
+  it "should give an error if the service was already stopped when stopping" do
+    @remote_service.stub!(:stop_service).and_return(Win::ServiceErrors::Errors.error_from_code("0x00000426").error)
+    @remote_service.stop.should == "The service has not been started."
+  end
+
+  it "should confirm that the service has been stopped" do
+    @remote_service.stub!(:stop_service).and_return(true)
+    @remote_service.stop.should be_true
+  end
+
+  it "should give the status of pending when the service is being stopped" do
+    @remote_service.stub!(:service_status).and_return("pending")
+    @remote_service.status.should == "pending"
+  end
+
+  it "should confirm that the service has been paused" do
+    @remote_service.stub!(:pause_service).and_return(true)
+    @remote_service.pause.should be_true
+  end
+
+  it "should give the status of paused when the service has been paused" do
+    @remote_service.stub!(:service_status).and_return("paused")
+    @remote_service.status.should == "paused"
+  end
+
+  it "should confirm that the service has been resumed" do
+    @remote_service.stub!(:resume_service).and_return(true)
+    @remote_service.resume.should be_true
+  end
+
+  it "should give the status of started when the service has been resumed" do
+    @remote_service.stub!(:service_status).and_return("running")
+    @remote_service.status.should == "running"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib')
+
+require "rspec"
+require "rbconfig"
+require "win/service"

data/spec/unix_service_spec.rb

@@ -0,0 +1,157 @@
+require "rspec"
+
+RSpec.configure do |config|
+  if Config::CONFIG['host_os'] =~ /mingw32/
+    config.filter_run_excluding :unix => true
+  end
+end
+
+describe Win::ServiceController::UnixService, :unix => true do
+  
+  describe "when service status is being requested" do
+    let(:service) {Win::Service.new('Service', '127.0.0.1', 'admin', 'password')}
+    let(:stdout) {double('stdout')}
+    let(:stderr) {double('stderr')}
+    let(:stdin) {double('stdin')}
+
+    it "should successfully return running when the service is started" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return("W3SVC service is running.\nConfiguration details:\n\tControls Accepted    = 0x7\n\tService Type         = 0x20\n\tStart Type           = 0x2\n\tError Control        = 0x1\n\tTag ID               = 0x0\n\tExecutable Path      = C:\\WINDOWS\\System32\\svchost.exe -k iissvcs\n\tLoad Order Group     = \n\tDependencies         = RPCSS/HTTPFilter/IISADMIN/\n\tStart Name           = LocalSystem\n\tDisplay Name         = World Wide Web Publishing Service\n")
+      stderr.should_receive(:read).and_return('')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      service.status.should == "running"
+    end
+
+    it "should successfully return stopped when the service is stopped" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return("W3SVC service is stopped.\nConfiguration details:\n\tControls Accepted    = 0x0\n\tService Type         = 0x20\n\tStart Type           = 0x2\n\tError Control        = 0x1\n\tTag ID               = 0x0\n\tExecutable Path      = C:\\WINDOWS\\System32\\svchost.exe -k iissvcs\n\tLoad Order Group     = \n\tDependencies         = RPCSS/HTTPFilter/IISADMIN/\n\tStart Name           = LocalSystem\n\tDisplay Name         = World Wide Web Publishing Service\n")
+      stderr.should_receive(:read).and_return('')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      service.status.should == "stopped"
+    end
+
+    it "should successfully return pending when the service is stopping" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return("W3SVC service is stop pending.\nConfiguration details:\n\tControls Accepted    = 0x5\n\tService Type         = 0x10\n\tStart Type           = 0x3\n\tError Control        = 0x1\n\tTag ID               = 0x0\n\tExecutable Path      = \"C:\\Program Files\\Virtual Hold Technology\\VHT_QueueManager_Service.exe\"\n\tLoad Order Group     = \n\tDependencies         = /\n\tStart Name           = LocalSystem\n\tDisplay Name         = VHT_QueueManager\n")
+      stderr.should_receive(:read).and_return('')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      service.status.should == "pending"
+    end
+
+    it "should successfully return paused when the service is paused" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return("W3SVC service is paused.\nConfiguration details:\n\tControls Accepted    = 0x7\n\tService Type         = 0x20\n\tStart Type           = 0x2\n\tError Control        = 0x1\n\tTag ID               = 0x0\n\tExecutable Path      = C:\\WINDOWS\\System32\\svchost.exe -k iissvcs\n\tLoad Order Group     = \n\tDependencies         = RPCSS/HTTPFilter/IISADMIN/\n\tStart Name           = LocalSystem\n\tDisplay Name         = World Wide Web Publishing Service\n")
+      stderr.should_receive(:read).and_return('')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      service.status.should == "paused"
+    end
+  end
+
+  describe "when service is being controlled" do
+    let(:service) {Win::Service.new('Service', '127.0.0.1', 'admin', 'password')}
+    let(:stdout) {double('stdout')}
+    let(:stderr) {double('stderr')}
+    let(:stdin) {double('stdin')}
+
+    it "should successfully start a stopped service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return('..\nSuccessfully started service: VHT_QueueManager\n')
+      stderr.should_receive(:read).and_return('')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      expect { service.start }.should_not raise_error
+    end
+
+    it "should successfully stop a started service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return('..............................\nVHT_QueueManager service is stop pending.\n')
+      stderr.should_receive(:read).and_return('')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      expect { service.stop }.should_not raise_error
+    end
+
+    it "should successfully pause a started service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return('service pause W3SVC\n.\nW3SVC service is paused.')
+      stderr.should_receive(:read).and_return('')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      expect { service.pause }.should_not raise_error
+    end
+
+    it "should successfully resume a paused service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return('service resume W3SVC\n.\nW3SVC service is running.')
+      stderr.should_receive(:read).and_return('')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      expect { service.resume }.should_not raise_error
+    end
+
+    it "should raise an error when trying to stop an already stopped service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return('')
+      stderr.should_receive(:read).and_return('Control service request failed.  [DOS code 0x00000426]')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      expect { service.stop }.should raise_error
+    end
+
+    it "should raise an error when trying to start an already started service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return('')
+      stderr.should_receive(:read).and_return('Query status request failed.  [DOS code 0x00000420]')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      expect { service.stop }.should raise_error
+    end
+
+    it "should raise an error when trying to pause an already stopped service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return('')
+      stderr.should_receive(:read).and_return('Control service request failed.  [DOS code 0x00000426]')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      expect { service.pause }.should raise_error
+    end
+
+    it "should raise an error when trying to resume an already stopped service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::UnixService)
+
+      stdout.should_receive(:read).and_return('')
+      stderr.should_receive(:read).and_return('Control service request failed.  [DOS code 0x00000426]')
+
+      Win::ServiceController.included(service)
+      Open3.stub!(:popen3).and_return([stdin, stdout, stderr])
+      expect { service.resume }.should raise_error
+    end
+
+  end
+end

data/spec/windows_service_spec.rb

@@ -0,0 +1,121 @@
+require "rspec"
+
+RSpec.configure do |config|
+  if Config::CONFIG['host_os'] =~ /darwin/
+    config.filter_run_excluding :windows => true
+  end
+end
+
+describe Win::ServiceController::WindowsService, :windows => true do
+  describe "when service status is being requested" do
+    let(:service) {Win::Service.new('Service', '127.0.0.1', 'admin', 'password')}
+    
+    it "should successfully return running when the service is started" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("\nSERVICE_NAME: W3SVC\n\t\tTYPE               : 20  WIN32_SHARE_PROCESS\n\t\tSTATE              : 4  RUNNING\n\t\t\t\t\t\t\t\t(STOPPABLE, NOT_PAUSABLE, ACCEPTS_SHUTDOWN)\n\t\tWIN32_EXIT_CODE    : 0  (0x0)\n\t\tSERVICE_EXIT_CODE  : 0  (0x0)\n\t\tCHECKPOINT         : 0x0\n\t\tWAIT_HINT          : 0x0\n")
+      service.status.should == "running"
+    end
+
+    it "should successfully return stopped when the service is stopped" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("\nSERVICE_NAME: W3SVC\n\t\tTYPE               : 20  WIN32_SHARE_PROCESS\n\t\tSTATE              : 1  STOPPED\n\t\t\t\t\t\t\t\t(STOPPABLE, NOT_PAUSABLE, ACCEPTS_SHUTDOWN)\n\t\tWIN32_EXIT_CODE    : 0  (0x0)\n\t\tSERVICE_EXIT_CODE  : 0  (0x0)\n\t\tCHECKPOINT         : 0x0\n\t\tWAIT_HINT          : 0x0\n")
+      service.status.should == "stopped"
+    end
+
+    it "should successfully return pending when the service is stopping" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("\nSERVICE_NAME: W3SVC\n\t\tTYPE               : 20  WIN32_SHARE_PROCESS\n\t\tSTATE              : 3  STOP_PENDING\n\t\t\t\t\t\t\t\t(NOT_STOPPABLE, NOT_PAUSABLE, IGNORESs_SHUTDOWN)\n\t\tWIN32_EXIT_CODE    : 0  (0x0)\n\t\tSERVICE_EXIT_CODE  : 0  (0x0)\n\t\tCHECKPOINT         : 0x0\n\t\tWAIT_HINT          : 0x0\n")
+      service.status.should == "pending"
+    end
+
+    it "should successfully return paused when the service is paused" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("\nSERVICE_NAME: W3SVC\n\t\tTYPE               : 20  WIN32_SHARE_PROCESS\n\t\tSTATE              : 7  PAUSED\n\t\t\t\t\t\t\t\t(NOT_STOPPABLE, NOT_PAUSABLE, IGNORES_SHUTDOWN)\n\t\tWIN32_EXIT_CODE    : 0  (0x0)\n\t\tSERVICE_EXIT_CODE  : 0  (0x0)\n\t\tCHECKPOINT         : 0x0\n\t\tWAIT_HINT          : 0x0\n")
+      service.status.should == "paused"
+    end
+  end
+
+  describe "when service is being controlled" do
+    let(:service) {Win::Service.new('Service', '127.0.0.1', 'admin', 'password')}
+
+    it "should successfully start a stopped service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("\nSERVICE_NAME: W3SVC\n\t\tTYPE               : 20  WIN32_SHARE_PROCESS\n\t\tSTATE              : 2  START_PENDING\n\t\t\t\t\t\t\t\t(NOT_STOPPABLE, NOT_PAUSABLE, IGNORES_SHUTDOWN)\n\t\tWIN32_EXIT_CODE    : 0  (0x0)\n\t\tSERVICE_EXIT_CODE  : 0  (0x0)\n\t\tCHECKPOINT         : 0x0\n\t\tWAIT_HINT          : 0x7d0\n\t\tPID                : 632\n\t\tFLAGS              :\n")
+      expect { service.start }.should_not raise_error
+    end
+
+    it "should successfully stop a started service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("\nSERVICE_NAME: W3SVC\n\t\tTYPE               : 20  WIN32_SHARE_PROCESS\n\t\tSTATE              : 3  STOP_PENDING\n\t\t\t\t\t\t\t\t(NOT_STOPPABLE, NOT_PAUSABLE, IGNORES_SHUTDOWN)\n\t\tWIN32_EXIT_CODE    : 0  (0x0)\n\t\tSERVICE_EXIT_CODE  : 0  (0x0)\n\t\tCHECKPOINT         : 0x1\n\t\tWAIT_HINT          : 0x4e20\n")
+      expect { service.stop }.should_not raise_error
+    end
+
+    it "should successfully pause a started service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("\nSERVICE_NAME: W3SVC\n\t\tTYPE               : 20  WIN32_SHARE_PROCESS\n\t\tSTATE              : 6  PAUSE_PENDING\n\t\t\t\t\t\t\t\t(NOT_STOPPABLE, NOT_PAUSABLE, IGNORES_SHUTDOWN)\n\t\tWIN32_EXIT_CODE    : 0  (0x0)\n\t\tSERVICE_EXIT_CODE  : 0  (0x0)\n\t\tCHECKPOINT         : 0x1\n\t\tWAIT_HINT          : 0x4e20\n")
+      expect { service.pause }.should_not raise_error
+    end
+
+    it "should successfully resume a paused service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("\nSERVICE_NAME: W3SVC\n\t\tTYPE               : 20  WIN32_SHARE_PROCESS\n\t\tSTATE              : 5  CONTINUE_PENDING\n\t\t\t\t\t\t\t\t(NOT_STOPPABLE, NOT_PAUSABLE, IGNORES_SHUTDOWN)\n\t\tWIN32_EXIT_CODE    : 0  (0x0)\n\t\tSERVICE_EXIT_CODE  : 0  (0x0)\n\t\tCHECKPOINT         : 0x1\n\t\tWAIT_HINT          : 0x4e20\n")
+      expect { service.resume }.should_not raise_error
+    end
+
+    it "should raise an error when trying to stop an already stopped service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("[SC] ControlService FAILED 1061:\n\nThe service cannot accept control messages at this time.")
+      expect { service.stop }.should raise_error
+    end
+
+    it "should raise an error when trying to start an already started service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("[SC] ControlService FAILED 1056:\n\nAn instance of the service is already running.")
+      expect { service.start }.should raise_error
+    end
+
+    it "should raise an error when trying to start an already started service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("[SC] ControlService FAILED 1056:\n\nAn instance of the service is already running.")
+      expect { service.start }.should raise_error
+    end
+
+    it "should raise an error when trying to pause an already stopped service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("[SC] ControlService FAILED 1062:\n\nAn instance of the service is already running.")
+      expect { service.pause }.should raise_error
+    end
+
+    it "should raise an error when trying to resume an already stopped service" do
+      service.should_receive(:send).with(:include, Win::ServiceController::WindowsService)
+      Win::ServiceController.included(service)
+      service.stub!(:logon).and_return("")
+      service.stub!(:execute_shell_command).and_return("[SC] ControlService FAILED 1062:\n\nAn instance of the service is already running.")
+      expect { service.resume }.should raise_error
+    end
+  end
+end

data/test/test_win_service.rb

@@ -0,0 +1,5 @@
+require "test/unit"
+require "win-service"
+
+class TestWinService < Test::Unit::TestCase
+end

data/win-service.gemspec

@@ -0,0 +1,34 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |gem|
+   gem.name         = 'win-service'
+   gem.version      = '0.1.0'
+   gem.authors      = ['James T. Pavlic']
+   gem.email        = 'james_pavlic@hotmail.com'
+   gem.license      = 'The MIT License'
+   gem.homepage     = 'https://github.com/jpavlic/win-service'
+   gem.platform     = Gem::Platform::RUBY
+   gem.summary      = 'An interface for MS Windows services'
+   gem.add_development_dependency('rspec')
+   gem.has_rdoc     = true
+
+   gem.extra_rdoc_files = [
+    'History.txt',
+    'README.txt',
+    'Manifest.txt',     
+    'doc/service.rdoc'
+   ]
+
+   gem.rubyforge_project     = 'win-service'
+   gem.required_ruby_version = '>= 1.8.7'
+
+   gem.description = <<-EOF
+      A ruby gem that will allow the basic functions of getting the status,
+      stopping and starting of a windows service from both a windows and a mac os x operating system.
+   EOF
+end
+
+if $PROGRAM_NAME == __FILE__
+   Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.0
+   Gem::Builder.new(spec).build
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: win-service
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- James T. Pavlic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 9
+        - 4
+        version: 2.9.4
+  type: :development
+  version_requirements: *id001
+description: "      A ruby gem that will allow the basic functions of getting the status,\n      stopping and starting of a windows service from both a windows and a mac os x operating system.\n"
+email: james_pavlic@hotmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- History.txt
+- README.txt
+files: 
+- Manifest.txt
+- History.txt
+- README.txt
+- Rakefile
+- win-service.gemspec
+- lib/win/service.rb
+- lib/win/service_controller.rb
+- lib/win/service_controller/service_controller.rb
+- lib/win/service_controller/service_errors.rb
+- lib/win/service_controller/unix_service.rb
+- lib/win/service_controller/windows_service.rb
+- spec/service_controller_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+- spec/unix_service_spec.rb
+- spec/windows_service_spec.rb
+- test/test_win_service.rb
+- .gemtest
+homepage: http://codinghappy.blogspot.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: win-service
+rubygems_version: 1.8.0
+signing_key: 
+specification_version: 3
+summary: An interface for MS Windows services
+test_files: 
+- test/test_win_service.rb