inetmgr 0.2.0-mswin32

data/README.rdoc

@@ -0,0 +1,51 @@
+= About inetmgr
+
+inetmgr is primarily a library that helps automate the configuration of IIS. It
+provides a straightforward ruby-like interface on top of the configuration API,
+which lets you inspect add/remove and modify various IIS objects like sites,
+application pools, bindings, virtual directories, etc.
+
+Additionally, intemgr provides some basic rake tasks that help adding IIS
+deployment aspects to your build (& deploy) process.
+
+== How to install
+
+Get the gem:
+
+	> gem install inetmgr
+	 	
+That should do the trick. Another option would be forking the source from github:
+	 	
+	> git clone git@github.com:typesafe/inetmgr.git inetmgr
+
+== How to use
+
+*Note*: inetmgr requires a Windows machine (well, duh) with IIS7+ and depends on
+WIN32OLE (for the sake of wrapping), which should be available by default.
+
+	require 'inetmgr'
+
+	cfg = IisConfiguration.new
+
+	cfg.get_sites.each do |site|
+		puts 'site: #{site.name}'
+	end
+
+	cfg.application_pools.add { |p| p.name = "newPool" }
+	cfg.apply_changes
+
+== License
+
+Copyright (c) 2010 Gino Heyman
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/inetmgr.gemspec

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+
+	s.platform   = 'mswin32'
+    s.name       = "inetmgr"
+    s.version    = "0.2.0"
+    s.summary    = "A library for managing IIS configuration settings."
+    s.description = "inetmgr allows you to inspect/configure IIS configuration sections and elements."
+
+	s.required_ruby_version     = '>= 1.8.7'
+	s.required_rubygems_version = ">= 1.3.6"
+	
+	s.author     = "Gino Heyman"
+    s.email      = "gino.heyman@gmail.com"
+    s.homepage   = "http://typesafe.be/inetmgr/"
+
+    s.files      = FileList["**/**/*"].to_a
+    s.require_path      = "lib"
+    
+end

data/lib/inetmgr.rb

@@ -0,0 +1,23 @@
+require 'win32ole'
+
+path = File.expand_path(File.dirname(__FILE__))
+
+requires = 
+[
+  'inetmgr/iis_object_collection.rb',
+  'inetmgr/iis_object.rb',
+  'inetmgr/iis_object/virtual_directory.rb',
+  'inetmgr/iis_object/application.rb',
+  'inetmgr/iis_object/binding_information.rb',
+  'inetmgr/iis_object/site.rb'
+]
+
+requires.each do |file|
+	require File.join(path, file)
+end
+
+Dir.glob(File.join(path, 'inetmgr/iis_object/*.rb')).each do |f|
+	require f unless requires.include?(f)
+end
+
+require File.join(path, 'inetmgr/iis_configuration.rb')

data/lib/inetmgr/iis_configuration.rb

@@ -0,0 +1,40 @@
+
+# Represents the local IIS configuration settings (meta base)
+class IisConfiguration
+	
+	def initialize
+		@admin_manager = WIN32OLE.new "Microsoft.ApplicationHost.WritableAdminManager"
+		@admin_manager.CommitPath = "MACHINE/WEBROOT/APPHOST";
+	end
+
+	# applies/commits all changes made since the creation of the
+	# IisConfiguration instance or the last time this method was called.
+    def apply_changes
+	    @admin_manager.CommitChanges
+    end
+
+	# Gets all configured web sites.
+    def get_sites
+		s = get_config_section "system.applicationHost/sites"
+	    IisObjectCollection.new s.Collection, :site, Site, lambda { |site| site.id = s.Collection.Count + 1 }
+    end
+
+	# Gets all configure application pools.
+    def get_application_pools
+		s = get_config_section "system.applicationHost/applicationPools"
+		IisObjectCollection.new s.Collection, :add, ApplicationPool
+    end
+
+	# Gets all configured service auto start providers.
+	def get_auto_start_providers
+		s = get_config_section "system.applicationHost/serviceAutoStartProviders"
+		IisObjectCollection.new s.Collection, :add, AutoStartProvider
+	end
+	
+private
+
+	def get_config_section section_name, path = "MACHINE/WEBROOT/APPHOST"
+		@admin_manager.GetAdminSection(section_name, path)
+	end
+
+end

data/lib/inetmgr/iis_object.rb

@@ -0,0 +1,52 @@
+
+class IisObject
+
+	def initialize element
+		@element = element
+	end
+
+	def self.prop name, actual_name, setter = Proc.new { |v| v }, reader = Proc.new { |v| v }
+		define_method(name.to_s) do
+		  reader.call(@element.Properties.Item(actual_name.to_s).Value)
+		end
+
+		define_method("#{name.to_s}=") do |val|
+		  @element.Properties.Item(actual_name.to_s).Value = setter.call(val)
+		end
+	end
+
+	def self.collection name, item_name, type
+		define_method(name.to_s) do
+			IisObjectCollection.new @element.Collection, item_name.to_s, type
+		end
+	end
+
+	def self.children name, item_name, type
+		define_method(name.to_s) do
+			IisObjectCollection.new @element.ChildElements.Item(name.to_s).Collection, item_name.to_s, type
+		end
+	end
+
+	def self.child name, element_name, type
+		define_method(name.to_s) do
+			type.new @element.ChildElements.Item(element_name.to_s)
+		end
+	end
+
+	def element
+		@element
+	end
+
+private
+
+	def method_missing(symbol, *args)
+		name = symbol.to_s
+		if (/=$/.match(name))
+			@element.Properties.Item(name.sub(/=$/, '')).Value = args[0]
+		else
+			@element.Properties.Item(name).Value
+		end
+	end
+
+end
+

data/lib/inetmgr/iis_object/application.rb

@@ -0,0 +1,9 @@
+
+class Application  < IisObject
+
+  prop :auto_start, "serviceAutoStartEnabled"
+  prop :auto_start_provider, "serviceAutoStartProvider"
+
+  collection :virtual_directories, :virtualDirectory, VirtualDirectory
+ 
+end

data/lib/inetmgr/iis_object/application_pool.rb

@@ -0,0 +1,26 @@
+
+class ProcessModel < IisObject
+
+end
+
+class PeriodicRestart < IisObject
+	children :schedule, :schedule, IisObject
+end
+
+class Recycling < IisObject
+	child :periodic_restart, :periodicRestart, PeriodicRestart
+end 
+
+class ApplicationPool < IisObject
+	
+	prop :auto_start,        :autoStart,              Proc.new { |a| a == true ? "true" : "false" },            Proc.new {|value| value == "true" }
+	prop :runtime_version,   :managedRuntimeVersion,  Proc.new { |a| a },                                       Proc.new {|value| value }
+	prop :classic_pipeline,  :managedPipelineMode,    Proc.new { |a| a == true ? 1 : 0 },                       Proc.new {|value| value.to_i == 1 }
+	prop :enable_32bit,      :enable32BitAppOnWin64,  Proc.new { |a| a },                                       Proc.new {|value| value }
+	prop :always_running,    :startMode,              Proc.new { |a| a == true ? "AlwaysRunning" : "OnDemand" },Proc.new {|value| value.to_i == 1 }
+
+    child :process_model, :processModel, ProcessModel
+    child :recycling, :recycling, Recycling 
+
+end
+

data/lib/inetmgr/iis_object/auto_start_provider.rb

@@ -0,0 +1,3 @@
+class AutoStartProvider < IisObject
+
+end

data/lib/inetmgr/iis_object/binding_information.rb

@@ -0,0 +1,8 @@
+
+class BindingInformation < IisObject
+
+	#prop :protocol, "protocol"
+
+	prop :binding_information, :bindingInformation
+
+end

data/lib/inetmgr/iis_object/site.rb

@@ -0,0 +1,10 @@
+
+class Site < IisObject
+
+	prop :auto_start, :serverAutoStart
+
+	collection :applications, :application, Application
+
+    children :bindings, :binding, BindingInformation
+    
+end

data/lib/inetmgr/iis_object/virtual_directory.rb

@@ -0,0 +1,5 @@
+class VirtualDirectory < IisObject
+
+	#prop :path, "path"
+	
+end

data/lib/inetmgr/iis_object_collection.rb

@@ -0,0 +1,43 @@
+# Represents a collection of IIS configuration objects.
+class IisObjectCollection
+
+	def initialize element, item_name, type, add_callback = nil
+		@collection_element = element
+		@item_name = item_name
+	    @type = type
+		@add_callback = add_callback
+	end
+
+    def size
+	    @collection_element.Count
+    end
+
+    def [](index)
+		return @type.new @collection_element.Item index
+    end
+
+    def each
+			size.times { |i| yield self[i] }
+    end
+
+    def add
+		e = @collection_element.CreateNewElement @item_name.to_s
+	    added = @type.new e
+		@add_callback.call added unless @add_callback.nil?
+	    yield added
+        @collection_element.AddElement e
+		added
+    end
+
+	def find 
+		size.times do |i|
+			instance = self[i]
+			return instance if yield(instance)
+		end
+		nil
+	end
+
+    def remove(index)
+	    @collection_element.DeleteElement index
+    end
+end

data/lib/rake/inetmgrtask.rb

@@ -0,0 +1,74 @@
+require 'rake/tasklib'
+
+module Inetmgr
+
+  class InetmgrTask < ::Rake::TaskLib
+    attr_accessor :name
+
+    def initialize(name, *args, &block)
+      @block = block
+      args = args.insert(0, name)
+      define name, args
+    end
+
+    def define(name, args)
+      task *args do |task, task_args|
+      	@task_args = task_args
+        execute name.to_s
+      end
+    end
+
+    def call_task_block(obj)
+      if !@block.nil?
+      	if @block.arity == 1
+      	  @block.call(obj)
+        else
+      	  @block.call(obj, @task_args)
+  	    end
+  	  end
+    end
+  end
+end
+
+def create_task(taskname, task_object_proc, &execute_body)
+  taskclass = :"Inetmgr_TaskFor_#{taskname}"
+  taskmethod = taskname.to_s.downcase.to_sym
+
+  Object.class_eval(<<-EOF, __FILE__, __LINE__)
+    def #{taskmethod}(name=:#{taskname}, *args, &block)
+      Inetmgr.const_get("#{taskclass}").new(name, *args, &block)
+    end
+  EOF
+
+  Inetmgr.class_eval do
+    const_set(taskclass, Class.new(Inetmgr::InetmgrTask) do
+      define_method :execute do |name|
+        task_object = task_object_proc.call
+
+        call_task_block(task_object)
+      	execute_body.call(task_object) unless execute_body.nil?
+      end
+    end)
+  end
+end
+
+
+create_task :application_pool, Proc.new { ApplicationPool.new } do |pool|
+  pool.create
+end
+
+create_task :application, Proc.new { Application.new } do |pool|
+  pool.create
+end
+
+create_task :site, Proc.new { Site.new } do |site|
+  site.create
+end
+
+create_task :auto_start_provider, Proc.new { AutoStartProvider.new } do |p|
+  p.create
+end
+
+create_task :virtual_directory, Proc.new { VirtualDirectory.new } do |dir|
+  dir.create
+end

data/nbproject/private/private.properties

@@ -0,0 +1,4 @@
+file.reference.inetmgr-lib=D:\\_git\\typesafe\\inetmgr\\lib
+file.reference.inetmgr-spec=D:\\_git\\typesafe\\inetmgr\\spec
+file.reference.inetmgr-test=D:\\_git\\typesafe\\inetmgr\\test
+platform.active=Ruby

data/nbproject/private/rake-d.txt

@@ -0,0 +1,2 @@
+default=
+show_all_settings=

data/nbproject/project.properties

@@ -0,0 +1,10 @@
+file.reference.inetmgr-lib=lib
+file.reference.inetmgr-spec=spec
+file.reference.inetmgr-test=test
+javac.classpath=
+main.file=
+platform.active=Ruby
+source.encoding=UTF-8
+src.dir=${file.reference.inetmgr-lib}
+test.spec.dir=spec
+test.src.dir=${file.reference.inetmgr-test}

data/nbproject/project.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>inetmgr</name>
+            <source-roots>
+                <root id="src.dir"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.spec.dir"/>
+                <root id="test.src.dir"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

data/spec/application_pool_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_env'
+
+describe "When adding a new application pool" do
+
+	before(:all) do
+		@pools = IisConfiguration.new.get_application_pools
+		@before_count = @pools.size
+		@pool = @pools.add do |p|
+			p.name = "tralala"
+		end
+	end
+
+	it "it should be present in the application pool collection" do
+		@pools.size.should == @before_count + 1
+	end
+
+	it "the auto_start value should default to false" do
+		@pool.auto_start.should == false
+	end
+
+	# TODO: fix this -> it depends on the defaults in the config
+	it "the runtime_version value should default to 'v2.0'" do
+		@pool.runtime_version.should == "v2.0"
+	end
+
+	it "the classic_pipeline value should default to false" do
+		@pool.classic_pipeline.should == false
+	end
+
+	it "the enable_32bit value should default to false" do
+		@pool.enable_32bit.should == false
+	end
+
+	it "the always_running value should default to false" do
+		@pool.always_running.should == false
+	end
+end
+
+describe "When updating application pool" do
+
+	before(:all) do
+
+		@name = generate_random_name()
+
+		configure do |cfg|
+
+			pool = cfg.get_application_pools.add { |p| p.name = @name } # defaults
+
+			pool.auto_start = true
+			pool.runtime_version = "v4.0"
+			pool.classic_pipeline = true
+			pool.enable_32bit = true
+			pool.always_running = true
+
+		end
+
+		configure do |cfg|
+			@pool = cfg.get_application_pools.find { |p| p.name == @name }
+		end
+		
+	end
+
+	it "the name should be changed" do
+		@pool.name.should == @name
+	end
+
+	it "the auto_start value should be changed" do
+		@pool.auto_start.should == false
+	end
+
+	it "the runtime_version value should be changed" do
+		@pool.runtime_version.should == "v4.0"
+	end
+
+	it "the classic_pipeline value should be changed" do
+		@pool.classic_pipeline.should == true
+	end
+
+	it "the enable_32bit value should be changed" do
+		@pool.enable_32bit.should == true
+	end
+
+	it "the always_running value should be changed" do
+		puts @pool.startMode
+		@pool.always_running.should == true
+	end
+
+end

data/spec/application_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_env'
+
+describe "When adding an Application to a site" do
+	
+	before(:all) do
+
+		configure do |cfg|
+			site = cfg.get_sites[0]
+			@app_name = "/#{generate_random_name}"
+			site.applications.add do|a|
+				a.path = @app_name
+				a.virtual_directories.add do |vd|
+					vd.path = @app_name
+					vd.physicalPath = "D:\\"
+				end
+			end
+		end
+
+		configure do |cfg|
+			@site = cfg.get_sites[0]
+			@app = @site.applications.find {|a| a.path == @app_name}
+		end
+	end
+
+	it "the app should be added" do
+		@app.should_not be_nil
+	end
+
+	it "the app should contain the associated virtual directory" do
+		@app.virtual_directories.size.should == 1
+	end
+
+	it "the virtual directory physical path should be set" do
+		@app.virtual_directories[0].physicalPath.should == "D:\\"
+	end
+
+end
+

data/spec/auto_start_provider_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_env'
+
+describe "When adding an auto start provider" do
+
+	before(:all) do
+		configure do |cfg|
+			@name = generate_random_name
+			@type = generate_random_name
+			@provider = cfg.get_auto_start_providers.add { |p| p.name = @name; p.type = @type }
+		end
+	end
+
+	it "the provider should not be nil" do
+		@provider.should_not be_nil
+	end
+
+	it "the provider name should be set" do
+		@provider.name.should == @name
+	end
+
+	it "the provider type should be set" do
+		@provider.type.should == @type
+	end
+
+end

data/spec/iis_configuration_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_env'
+
+describe "When getting the configured application pools" do
+
+	before(:all) do
+		configure do |cfg|
+			@pools = cfg.get_application_pools
+		end
+	end
+
+	it "at least one item should be returned" do
+		@pools.size > 1
+	end
+	
+end
+
+describe "When rolling back configuration changes" do
+
+	before(:all) do
+		configure false do |cfg|
+			cfg.get_application_pools.add do |p|
+				p.name = "foobar"
+			end
+		end
+		configure false do |cfg|
+			@non_existing_pool = cfg.get_application_pools.find { |p| p.name == "foobar" }
+		end
+	end
+
+	it "the changes should not be applied" do
+		@non_existing_pool.should be_nil
+	end
+
+end
+

data/spec/site_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_env'
+
+describe "When getting the configured sites" do
+
+	before(:all) do
+		configure do |cfg|
+			@sites = cfg.get_sites
+		end
+	end
+
+	it "at least one item should be returned" do
+		@sites.size > 1
+	end
+
+end
+
+describe "When adding a new site" do
+
+	before(:all) do
+		configure do |cfg|
+			@sites = cfg.get_sites
+			@site = @sites.add { |s| s.name = generate_random_name }
+		end
+	end
+
+	it "the site should be created" do
+		@site.should_not be_nil
+	end
+
+	it "the site should have the highest id" do
+		@site.id.should == @sites.size
+	end
+
+end

data/spec/spec_env.rb

@@ -0,0 +1,23 @@
+require 'spec'
+require 'test/unit'
+require 'spec_env'
+require 'uuid'
+require File.expand_path(File.join(File.dirname(__FILE__), "../lib/inetmgr"))
+
+module RSpecExtensions
+
+	def configure(apply_changes = true)
+		cfg = IisConfiguration.new
+		yield cfg
+	    cfg.apply_changes if apply_changes
+	end
+
+    def generate_random_name
+	    UUID.generate(:compact).to_s
+    end
+
+end
+
+Spec::Runner.configure do |config|
+  config.include RSpecExtensions
+end

data/spec/virtual_directory_spec.rb

@@ -0,0 +1 @@
+require 'spec_env'

data/test/print_iis_config.rb

@@ -0,0 +1,36 @@
+require '..\lib\inetmgr.rb'
+
+cfg = IisConfiguration.new
+
+sites = cfg.get_sites
+pools = cfg.get_application_pools
+
+pools.each do |p|
+	puts "\r\nPOOL: #{p.name}"
+	puts "----"
+
+	puts " - process_model:"
+	puts "    - identityType: #{p.process_model.identityType}"
+
+	puts " - recycling:"
+	puts "    - logEventOnRecycle: #{p.recycling.logEventOnRecycle}"
+	puts "    - periodic_restart.schedulecount: #{p.recycling.periodic_restart.schedule.size}"
+
+end
+
+sites.each do |s|
+
+	puts "SITE: #{s.name} #{s.bindings.size}"
+
+	s.bindings.each do |b|
+		puts "binding: #{b.protocol} - #{b.binding_information}"
+	end
+
+	s.applications.each do |a|
+		puts "    app: #{a.path}"
+		a.virtual_directories.each do |d|
+			puts "       dir: #{d.path}"
+		end
+	end
+
+end

data/test/rakefile.rb

@@ -0,0 +1,27 @@
+require '../lib/inetmgr'
+
+task :default => [:show_all_settings]
+
+task :show_all_settings do
+  
+  cfg = IisConfiguration.new
+  
+  puts "APPLICATION POOLS:"
+  puts ""
+  puts "name                     |auto_start|runtime_version|classic_pipeline|always_running"
+  puts "------------------------------------------------------------------------------------"
+  cfg.get_application_pools.each do |p|
+    puts sprintf "%-25s|%-10s|%-15s|%-16s|%-s", p.name, p.auto_start, p.runtime_version, p.classic_pipeline, p.always_running
+  end
+
+  puts "SITES:"
+  puts ""
+  puts "name                     |auto_start"
+  puts "------------------------------------------"
+  cfg.get_sites.each do |s|
+    puts sprintf "%-25s|%-10s", s.name, s.auto_start
+  end
+end
+
+
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: inetmgr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: mswin32
+authors: 
+- Gino Heyman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-14 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: inetmgr allows you to inspect/configure IIS configuration sections and elements.
+email: gino.heyman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- inetmgr.gemspec
+- lib/inetmgr/iis_configuration.rb
+- lib/inetmgr/iis_object/application.rb
+- lib/inetmgr/iis_object/application_pool.rb
+- lib/inetmgr/iis_object/auto_start_provider.rb
+- lib/inetmgr/iis_object/binding_information.rb
+- lib/inetmgr/iis_object/site.rb
+- lib/inetmgr/iis_object/virtual_directory.rb
+- lib/inetmgr/iis_object.rb
+- lib/inetmgr/iis_object_collection.rb
+- lib/inetmgr.rb
+- lib/rake/inetmgrtask.rb
+- nbproject/private/config.properties
+- nbproject/private/private.properties
+- nbproject/private/rake-d.txt
+- nbproject/project.properties
+- nbproject/project.xml
+- README.rdoc
+- spec/application_pool_spec.rb
+- spec/application_spec.rb
+- spec/auto_start_provider_spec.rb
+- spec/iis_configuration_spec.rb
+- spec/site_spec.rb
+- spec/spec_env.rb
+- spec/virtual_directory_spec.rb
+- test/print_iis_config.rb
+- test/rakefile.rb
+has_rdoc: true
+homepage: http://typesafe.be/inetmgr/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A library for managing IIS configuration settings.
+test_files: []
+