win-service-manager 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b41407d63fb3c6abaea5031856d95bbf3b9bf77
+  data.tar.gz: 870d3c815fe9ab9abde7b42ba97dd1fdb58d464c
+SHA512:
+  metadata.gz: ca882074025fc7da85937cb848d288f5d6460713737843e4153ada63e4ac9e181f721b5ba669e83469c6f591358b94e2933336106a6e4d1d0fe0ea2079a3840b
+  data.tar.gz: 8ccaa70a2b02b180cd7412028857a46383b4e910a308679798d5a52bc41eb3515509d090be5c6a6d3e1f322feda4fc657ab3e8ecaabd86050eddb20d6d688a60

data/History.txt

@@ -0,0 +1,6 @@
+== 1.0.0 / 2014-03-04
+* Trimmed down, Path parameter added
+== 0.1.0 / 2008-12-20
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/win-service-manager.rb
+tasks/gem.rake

data/README.rdoc

@@ -0,0 +1,67 @@
+= win-service-manager
+    by Ryan Castro (Originally by James Tucker)
+    http://github.com/ryancastro/win-service-manager/
+
+== DESCRIPTION:
+
+Install, configure, and manage Microsoft Windows services from Ruby. Using Microsoft's SRVany.exe from the MS Resource Toolkit, run a Ruby script as a Windows service.
+
+== FEATURES/PROBLEMS:
+
+* Turn any application into a Windows service using Srvany.exe. Manage existing services.
+* Depending on how your Ruby process launches (Like rails, which uses a batch file), stopping the service may stop SRVany.exe, but leave the child batch running.
+
+== SYNOPSIS:
+
+  #Create a new manager
+  sm = WinServiceManager.new(File.expand_path("srvany.exe"))
+  #Creat a new service.  Name, exe, arguments, directory to run from, Service description
+  sm.create('foo service', 'c:\ruby18\bin\rubyw', 'my_awesome_daemon.rb', 'c:\daemon', "This is my Daemon Service" )
+  sm.start('foo service')
+  sm.stop('foo service')
+  sm.delete('foo service')
+  puts sm.list
+
+== TURNING RAILS 4 INTO A WINDOWS SERVICE:
+  require 'win-service-manager'
+  service = WinServiceManager.new('c:\mc_ruby\srvany.exe')
+  service.create('Awesome Rails 4 service', 'c:\ruby200\bin\ruby', 'c:\ruby200\bin\rails server -e production', 'c:\projects\awesomerails', 'Rails 4 Service Description')
+
+
+== REQUIREMENTS:
+
+At the time of writing, some of the dependencies are only available as gems to
+the 'x86-mswin32-60' platform. If you are installing on mingw, you can get
+away with installing them using a specific --platform argument to rubygems.
+
+* gem inst win32-service win32-registry
+
+== INSTALL:
+
+* gem inst win-service-manager
+* To create services, download srvany.exe from Microsoft Resource Kit Tools and provide it's path to WinServiceManager
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 James Tucker
+
+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/lib/win-service-manager.rb

@@ -0,0 +1,73 @@
+require 'win32/service'
+require 'win32/registry'
+
+class WinServiceManager
+  #Name your service, provice a path to SRVANY.exe - found in the MS Windows Resource Kit
+  def initialize(srv_any_path = "#{ENV['ProgramFiles']}\\Windows Resource Kits\\Tools\\srvany.exe")
+    @name_key = ''
+    @srv_any_path = srv_any_path
+  end
+
+  # Create a new service. The service name will be appended to the name_key
+  # and inserted into the registry using Win32::Service. The arguments are
+  # then adjusted with win32-registry.
+  # One recommended pattern is to store persisence details about the service
+  # as yaml in the optional description field.
+  def create(name, command, args = '', app_directory = '', description = nil, options = {})
+    defaults = {
+      :service_type       => Win32::Service::WIN32_OWN_PROCESS,
+      :start_type         => Win32::Service::DEMAND_START,
+      :error_control      => Win32::Service::ERROR_NORMAL
+      }.merge(options)
+      name = @name_key + name.to_s
+      options = defaults.merge(
+      :display_name       => name,
+      :service_name       => name,
+      :description        => description || name,
+      :binary_path_name   => @srv_any_path
+      )
+      Win32::Service.create(options)
+      registry(name) do |reg|
+        reg.create('Parameters') do |params|
+          params.write_i("Start", 3)
+          params.write_s("Application", command)
+          params.write_s("AppParameters", args)
+          params.write_s("AppDirectory", app_directory)
+        end
+      end
+    end
+
+    # Mark a service for deletion (note, does not terminate the service)
+    def delete(name)
+      Win32::Service.delete(@name_key + name.to_s)
+    end
+
+    def start(name)
+      Win32::Service.start(@name_key + name.to_s)
+    end
+
+    def stop(name)
+      Win32::Service.stop(@name_key + name.to_s)
+    end
+
+    # Returns an array of tuples of name and description
+    def list
+      services = Win32::Service.services.select do |svc|
+        # TODO in future, 1.8.7, can use start_with?
+        svc.display_name[0,@name_key.size] == @name_key
+      end
+      services.map do |svc_info|
+        name = svc_info.display_name
+        [name.slice(@name_key.size, name.size), svc_info.description]
+      end
+    end
+
+    private
+    def registry(name, &block)
+      Win32::Registry::HKEY_LOCAL_MACHINE.open(
+      "SYSTEM\\CurrentControlSet\\Services",
+      Win32::Registry::KEY_WRITE | Win32::Registry::KEY_READ
+      ).open(name, &block)
+    end
+
+  end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: win-service-manager
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Ryan Castro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: win32-service
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Create, configure, and manage Windows services from Ruby
+email: git@ryancastro.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- README.rdoc
+files:
+- History.txt
+- Manifest.txt
+- README.rdoc
+- lib/win-service-manager.rb
+homepage: http://github.com/ryancastro/win-service-manager
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Create, configure, and manage Windows services from Ruby
+test_files: []