inetmgr 0.4.0

data/README.rdoc

@@ -0,0 +1,159 @@
+= About inetmgr
+
+inetmgr is primarily a library that helps automate the configuration of IIS (7+).
+It is built on top of the standard IIS configuration API (http://www.iis.net/ConfigReference)
+but provides a more elegant, ruby-like interface which, typically, can be used
+from your rake tasks.
+
+The inetmgr library lets you inspect add/remove and alter various IIS objects
+like sites, application pools, bindings, virtual directories, etc.
+
+== How to install
+
+Get the gem:
+
+ gem install inetmgr
+
+That should do the trick. Another option would be forking the source from the
+github repository:
+
+ git clone git@github.com:typesafe/inetmgr.git inetmgr
+
+== How to use
+
+*_Notes_*: inetmgr requires a Windows machine (well, duh) with IIS7+ and depends
+on WIN32OLE (obviously), which should be available by default. Inetmgr has only
+been tested with Ruby version 1.9.2 (on a Windows 7 box).
+
+=== Create a new site
+
+The following code creates a new web site with an http and https binding. Note
+the use of the +configure+ method to ensure the changes get committed.
+
+ require 'inetmgr'
+
+ IisConfiguration.configure do |cfg|
+     cfg.get_sites.add do |site|
+         site.name = "Contoso"
+         site.auto_start = true
+         site.bindings.add do |b|
+             b.protocol = "http"
+             b.binding_information = "*:80:www.******.be"
+         end
+
+         site.bindings.add do |b|
+             b.protocol = "https"
+             b.binding_information = "*:443:"
+             b.add_ssl_certificate "e2564766bad7ebec8cf6899caa2a27c6391c4f19", "MY"
+         end
+
+         site.applications.add do |app|
+             app.path = "/"
+             app.virtual_directories.add do |dir|
+                 dir.path = "/"
+                 dir.physical_path = "D:\\sites\\www.******.be"
+             end
+         end
+     end
+ end
+
+=== Print the currently configured pools
+
+This code sample print the currently configured pools. Note the use of a newed
+configuration instance (since were not applying any changes).
+
+ require 'inetmgr'
+ cfg = IisConfiguration.new
+ pools = cfg.get_application_pools
+
+ pools.each do |p|
+     puts "\r\nPOOL: #{p.name}"
+     puts "----"
+     puts " - auto_start:\t #{p.auto_start}"
+     puts " - always_running:\t #{p.always_running}"
+     puts " - CLRConfigFile:\t #{p.CLRConfigFile}"	# not yet mapped
+     puts " - enable_32bit:\t #{p.enable_32bit}"
+     puts " - enableConfigurationOverride:\t #{p.enableConfigurationOverride}"	# not yet mapped
+     puts " - classic_pipeline:\t #{p.classic_pipeline}"
+     puts " - runtime_version:\t #{p.runtime_version}"
+     puts " - passAnonymousToken:\t #{p.passAnonymousToken}"
+
+     puts "\r\n - process_model:"
+     puts "    - identity_type: #{p.process_model.identity_type}"
+     puts "    - idleTimeout: #{p.process_model.idleTimeout}"
+     puts "    - logon_type: #{p.process_model.logon_type}"
+     puts "    - user_name '#{p.process_model.user_name}'"
+     puts "    - password '#{p.process_model.password.gsub(/./, '*')}'"
+     puts "    - load_user_profile: #{p.process_model.load_user_profile}"
+
+     puts "\r\n - recycling:"
+     puts "    - logEventOnRecycle: #{p.recycling.logEventOnRecycle}"
+     puts "    - periodic_restart.schedulecount: #{p.recycling.periodic_restart.schedule.size}"
+     puts "----------------------------"
+ end
+
+The output of the above code would be something like the following:
+
+ POOL: static.******.be
+ ----
+ - auto_start:         false
+ - always_running:         false
+ - CLRConfigFile:
+ - enable_32bit:         false
+ - enableConfigurationOverride:         true
+ - classic_pipeline:         false
+ - runtime_version:
+ - passAnonymousToken:         true
+
+ - process_model:
+    - identity_type: application_pool_identity
+    - idleTimeout: 12000000000
+    - logon_type: batch
+    - user_name ''
+    - password ''
+    - load_user_profile: false
+
+ - recycling:
+     - logEventOnRecycle: 137
+     - periodic_restart.schedulecount: 0
+ ----------------------------
+ 
+ POOL: www.******.be
+ ----
+ - auto_start:         false
+ - always_running:         true
+ - CLRConfigFile:
+ - enable_32bit:         false
+ - enableConfigurationOverride:         true
+ - classic_pipeline:         false
+ - runtime_version:         v4.0
+ - passAnonymousToken:         true
+
+ - process_model:
+    - identity_type: specific_user
+    - idleTimeout: 12000000000
+    - logon_type: batch
+    - user_name 'gino'
+    - password '*********'
+    - load_user_profile: false
+ 
+  - recycling:
+     - logEventOnRecycle: 137
+     - periodic_restart.schedulecount: 0
+ ----------------------------
+
+== 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/RELEASE-NOTES.rdoc

@@ -0,0 +1,35 @@
+= inetmgr Release Notes
+
+== Latest Version (0.3.0)
+
+- more property mappings for ApplicationPool & Site.
+- Added support for site-level configuration (only appSettings, for now).
+
+== Previous Versions
+
+=== 0.2.1
+
+- Added static configure method to IisConfiguratin to support atomic changes:
+
+ IisConfiguration.configure do |cfg|
+     #use cfg param to configure
+ end
+
+- Added some RDoc
+- Added application_pool prop to Application (alias for applicationPool)
+- Added logon_type prop to ProcessModel (alias for logonType)
+- Added physical_path to VirtualDirectory (alias for physicalPath)
+- Extended SSL support to BindingInformation 
+
+=== 0.2.0
+
+Initial version with support for configuring the following IIS/Machine level objects:
+
+- ApplicationPool
+- Application
+- AutoStartProvider
+- Site
+- ProcessModel
+- PeriodicRestart
+- Recycling
+

data/doc/Application.html

@@ -0,0 +1,177 @@
+<?xml version="1.0" encoding="IBM437"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=IBM437" http-equiv="Content-Type" />
+
+  <title>Class: Application</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/inetmgr/iis_object/application_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/inetmgr/iis_object/application.rb">lib/inetmgr/iis_object/application.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+
+      <!-- Parent Class -->
+      
+      <div id="parent-class-section" class="section">
+        <h3 class="section-header">Parent</h3>
+        
+        <p class="link"><a href="IisObject.html">IisObject</a></p>
+        
+      </div>
+      
+
+      <!-- Namespace Contents -->
+      
+
+      <!-- Method Quickref -->
+      
+
+      <!-- Included Modules -->
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
+        
+          <li class="file"><a href="./RELEASE-NOTES_rdoc.html">RELEASE-NOTES.rdoc</a></li>
+        
+          <li class="file"><a href="./nbproject/private/rake-d_txt.html">rake-d.txt</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./Inetmgr.html">Inetmgr</a></li>
+        
+          <li><a href="./Inetmgr/InetmgrTask.html">Inetmgr::InetmgrTask</a></li>
+        
+          <li><a href="./Application.html">Application</a></li>
+        
+          <li><a href="./ApplicationPool.html">ApplicationPool</a></li>
+        
+          <li><a href="./AutoStartProvider.html">AutoStartProvider</a></li>
+        
+          <li><a href="./BindingInformation.html">BindingInformation</a></li>
+        
+          <li><a href="./Configuration.html">Configuration</a></li>
+        
+          <li><a href="./IisConfiguration.html">IisConfiguration</a></li>
+        
+          <li><a href="./IisObject.html">IisObject</a></li>
+        
+          <li><a href="./IisObjectCollection.html">IisObjectCollection</a></li>
+        
+          <li><a href="./Object.html">Object</a></li>
+        
+          <li><a href="./PeriodicRestart.html">PeriodicRestart</a></li>
+        
+          <li><a href="./ProcessModel.html">ProcessModel</a></li>
+        
+          <li><a href="./RSpecExtensions.html">RSpecExtensions</a></li>
+        
+          <li><a href="./Recycling.html">Recycling</a></li>
+        
+          <li><a href="./Site.html">Site</a></li>
+        
+          <li><a href="./SiteConfiguration.html">SiteConfiguration</a></li>
+        
+          <li><a href="./SiteLimit.html">SiteLimit</a></li>
+        
+          <li><a href="./VirtualDirectory.html">VirtualDirectory</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="class">Application</h1>
+
+    <div id="description">
+      
+    </div>
+
+    <!-- Constants -->
+    
+
+    <!-- Attributes -->
+    
+
+    <!-- Methods -->
+    
+
+  </div>
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+

data/doc/ApplicationPool.html

@@ -0,0 +1,177 @@
+<?xml version="1.0" encoding="IBM437"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=IBM437" http-equiv="Content-Type" />
+
+  <title>Class: ApplicationPool</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/inetmgr/iis_object/application_pool_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/inetmgr/iis_object/application_pool.rb">lib/inetmgr/iis_object/application_pool.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+
+      <!-- Parent Class -->
+      
+      <div id="parent-class-section" class="section">
+        <h3 class="section-header">Parent</h3>
+        
+        <p class="link"><a href="IisObject.html">IisObject</a></p>
+        
+      </div>
+      
+
+      <!-- Namespace Contents -->
+      
+
+      <!-- Method Quickref -->
+      
+
+      <!-- Included Modules -->
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
+        
+          <li class="file"><a href="./RELEASE-NOTES_rdoc.html">RELEASE-NOTES.rdoc</a></li>
+        
+          <li class="file"><a href="./nbproject/private/rake-d_txt.html">rake-d.txt</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./Inetmgr.html">Inetmgr</a></li>
+        
+          <li><a href="./Inetmgr/InetmgrTask.html">Inetmgr::InetmgrTask</a></li>
+        
+          <li><a href="./Application.html">Application</a></li>
+        
+          <li><a href="./ApplicationPool.html">ApplicationPool</a></li>
+        
+          <li><a href="./AutoStartProvider.html">AutoStartProvider</a></li>
+        
+          <li><a href="./BindingInformation.html">BindingInformation</a></li>
+        
+          <li><a href="./Configuration.html">Configuration</a></li>
+        
+          <li><a href="./IisConfiguration.html">IisConfiguration</a></li>
+        
+          <li><a href="./IisObject.html">IisObject</a></li>
+        
+          <li><a href="./IisObjectCollection.html">IisObjectCollection</a></li>
+        
+          <li><a href="./Object.html">Object</a></li>
+        
+          <li><a href="./PeriodicRestart.html">PeriodicRestart</a></li>
+        
+          <li><a href="./ProcessModel.html">ProcessModel</a></li>
+        
+          <li><a href="./RSpecExtensions.html">RSpecExtensions</a></li>
+        
+          <li><a href="./Recycling.html">Recycling</a></li>
+        
+          <li><a href="./Site.html">Site</a></li>
+        
+          <li><a href="./SiteConfiguration.html">SiteConfiguration</a></li>
+        
+          <li><a href="./SiteLimit.html">SiteLimit</a></li>
+        
+          <li><a href="./VirtualDirectory.html">VirtualDirectory</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="class">ApplicationPool</h1>
+
+    <div id="description">
+      
+    </div>
+
+    <!-- Constants -->
+    
+
+    <!-- Attributes -->
+    
+
+    <!-- Methods -->
+    
+
+  </div>
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+