slicehost 0.1.1 → 0.2.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.2.0 2007-12-24
+
+* Capistrano tasks to
+  * Create DNS zone
+  * Create Google Apps MX records (all 5 of them in one command)
+* README + Website updated
+
 == 0.1.0 2007-12-23
 
 * 1 major enhancement:

data/Manifest.txt

@@ -6,7 +6,10 @@ Rakefile
 config/hoe.rb
 config/requirements.rb
 lib/slicehost.rb
+lib/slicehost/recipes/capistrano.rb
+lib/slicehost/samples/config.yml
 lib/slicehost/version.rb
+lib/tasks/zone.rake
 local/slicehost.rb.sample
 log/debug.log
 script/destroy
@@ -18,6 +21,7 @@ tasks/environment.rake
 tasks/website.rake
 test/test_admin.rb
 test/test_helper.rb
+test/test_sample_files.rb
 test/test_slices.rb
 test/test_zones.rb
 website/index.html

data/README.txt

@@ -4,8 +4,22 @@ This library provides a simple set of helper methods
 to manage slices and DNS zones/records on your Slicehost
 account (http://slicehost.com).
 
+== Capistrano tasks
+
+There are two capistrano tasks:
+    cap slicehost:zone:add       # Create DNS zone
+    cap slicehost:zone:mx:google # Add Google Apps MX records
+  
+To your config/deploy.rb, add the following:
+  
+    require "slicehost/recipes/capistrano" if Capistrano::Version::MAJOR >= 2
+    # Used to setup/update DNS registry of url => ip
+    set :domain_mapping, "myurl.com" => "123.456.789.012"
+  
+== Underlying API
+
 The current API is very alpha. It was just the simplest thing that worked.
-There are unit tests demonstrating it working and everything.
+There are unit tests demonstrating it working and everything. 
 
 Future releases will have a nicer, class-based API. 
 

data/config/hoe.rb

@@ -48,7 +48,7 @@ end
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
 hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.author = AUTHOR 
-  p.description = p.paragraphs_of("README.txt", 1..3).join("\n\n")
+  p.description = p.paragraphs_of("README.txt", 1..-1).join("\n\n")
   p.email = EMAIL
   p.summary = p.description
   p.url = HOMEPATH

data/lib/slicehost.rb

@@ -4,6 +4,7 @@ require 'rubygems'
 require 'mechanize'
 
 module Slicehost
+  ConfigSampleFile = File.dirname(__FILE__) + "/slicehost/samples/config.yml"
 end
 
 class Slicehost::Helper

data/lib/slicehost/recipes/capistrano.rb

@@ -0,0 +1,109 @@
+require "yaml"
+require File.dirname(__FILE__) + '/../../slicehost'
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :slicehost do
+    namespace :zone do
+      desc "Create DNS zone"
+      task :add do
+        
+        begin 
+          # check that the capistrano variable is set, else it raises exception
+          # TODO cleaner way to test this?
+          domain_mapping
+        rescue
+          puts (<<-EOS).gsub(/^\s+/s,"")
+          ERROR: must setup domain_mapping capistrano variable
+          For example, add to deploy.rb:
+          set :domain_mapping, #{domain} => "123.456.789.012"
+          EOS
+          next
+        end
+        config_file = File.join(File.dirname(__FILE__), "../slicehost.yml")
+        unless File.exists?(config_file)
+          require 'fileutils'
+          FileUtils.copy(Slicehost::ConfigSampleFile, config_file + ".sample")
+          puts (<<-EOS).gsub(/^\s+/s,"")
+          ERROR: No config/slicehost.yml found.
+          Copied sample file to config/slicehost.yml.sample. 
+          Please modify with your email/password for slicehost.
+          EOS
+          next
+        end
+        config = YAML.load File.open(config_file)
+        email, password = config["email"], config["password"]
+      
+        session = Slicehost::Helper.new
+        if session.login(email, password)
+          puts "Logged in as #{email}"
+          # TODO only tested for one pair, e.g url.com => "123.456.789.012"
+          # not sure what the correct DNS setup is if multiple
+          # domain_mapping pairs passed in.
+          # Tell Dr Nic if you know @ drnicwilliams@gmail.com
+          domain_mapping.each_pair do |url, ipaddr|
+            puts "Creating zone for #{url}"
+            if session.zone?(url)
+              session.delete_zone(url)
+              puts "Deleted existing DNS settings for #{url}"
+            end
+            session.create_zone(url)
+            puts "Created zone" if session.zone?(url)
+            session.create_simple_zone(url, ipaddr)
+            puts "Created basic DNS settings for #{url}"
+          end
+        else
+          puts "Login failed. Check email/password in config/slicehost.yml"
+          next
+        end
+      end
+    
+      namespace :mx do
+        desc "Add Google Apps MX records"
+        task :google do
+          begin 
+            # check that the capistrano variable is set, else it raises exception
+            # TODO cleaner way to test this?
+            domain_mapping
+          rescue
+            puts (<<-EOS).gsub(/^\s+/s,"")
+            ERROR: must setup domain_mapping capistrano variable
+            For example, add to deploy.rb:
+            set :domain_mapping, #{domain} => "123.456.789.012"
+            EOS
+            next
+          end
+          config_file = File.join(File.dirname(__FILE__), "../slicehost.yml")
+          unless File.exists?(config_file)
+            require 'fileutils'
+            FileUtils.copy(Slicehost::ConfigSampleFile, config_file + ".sample")
+            puts (<<-EOS).gsub(/^\s+/s,"")
+            ERROR: No config/slicehost.yml found.
+            Copied sample file to config/slicehost.yml.sample. 
+            Please modify with your email/password for slicehost.
+            EOS
+            next
+          end
+          config = YAML.load File.open(config_file)
+          email, password = config["email"], config["password"]
+
+          session = Slicehost::Helper.new
+          unless session.login(email, password)
+            puts "Login failed. Check email/password in config/slicehost.yml"
+            next
+          end
+          puts "Logged in as #{email}"
+          # TODO only tested for one pair, e.g url.com => "123.456.789.012"
+          # not sure what the correct DNS setup is if multiple
+          # domain_mapping pairs passed in.
+          # Tell Dr Nic if you know @ drnicwilliams@gmail.com
+          url = domain_mapping.keys.first # TODO .smallest really
+          unless session.zone?(url)
+            puts "No zone setup for #{url}; use: cap slicehost_zone_add"
+            next
+          end
+          session.create_googleapps_mx(url)
+          puts "Created MX records for Google Apps for #{url}" 
+        end
+      end
+    end
+  end
+end

data/lib/slicehost/samples/config.yml

@@ -0,0 +1,3 @@
+--- 
+email: your@email.com
+password: yourpassword

data/lib/slicehost/version.rb

@@ -1,8 +1,8 @@
 module Slicehost #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 1
+    MINOR = 2
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/tasks/zone.rake

@@ -0,0 +1,42 @@
+namespace :slicehost do
+  namespace :zone do
+    desc "Create DNS zone"
+    task :add do
+      require 'rubygems'
+      require 'hpricot'
+      require 'open-uri'
+      require "yaml"
+      require 'slicehost'
+      
+      # require File.dirname(__FILE__) + "/../lib/core-ext/open-uri"
+      unless (url = ENV['URL']) && (ipaddr = ENV['IP'])
+        puts "USAGE: rake slicehost:zone URL=url.com IP=123.456.789.012"
+        next
+      end
+      config_file = File.join(File.dirname(__FILE__), "../config/slicehost.yml")
+      unless File.exists?(config_file)
+        require 'fileutils'
+        FileUtils.copy File.join(File.dirname(__FILE__), "../config/slicehost.yml.sample"), config_file
+        puts (<<-EOS).gsub(/^\s+/s,"")
+        ERROR: No config/slicehost.yml found.
+        Copied sample file. Please modify with your email/password for slicehost.
+        EOS
+        next
+      end
+      config = YAML.load File.open(config_file)
+      
+      session = Slicehost::Helper.new
+      if session.login(config["email"], config["password"])
+        puts "Logged in as #{config['email']}"
+        puts "Creating zone for #{url}"
+        session.delete_zone(url) if session.zone?(url)
+        session.create_zone(url)
+        puts "Created zone" if session.zone?(url)
+        session.create_simple_zone(url, ipaddr)
+      else
+        puts "Login failed. Check email/password in config/slicehost.yml"
+        next
+      end
+    end
+  end
+end

data/test/test_sample_files.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestSampleFiles < Test::Unit::TestCase
+  def setup
+  end
+  
+  def teardown
+  end
+  
+  # Replace this with your real tests.
+  def test_config_sample
+    file = Slicehost::ConfigSampleFile
+    assert_not_nil(file)
+    assert(File.exists?(file), "The constant is defined, but no actual file available at #{file}")
+  end
+end

data/website/index.html

@@ -5,7 +5,7 @@
   <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>
-      slicehost
+      Slicehost Helpers
   </title>
   <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
 <style>
@@ -30,42 +30,81 @@
 <body>
 <div id="main">
 
-    <h1>slicehost</h1>
+    <h1>Slicehost Helpers</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/slicehost"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/slicehost" class="numbers">0.1.1</a>
+      <a href="http://rubyforge.org/projects/slicehost" class="numbers">0.2.0</a>
     </div>
-    <h1>&#x2192; &#8216;slicehost&#8217;</h1>
+    <h1>cap slicehost:zone:add</h1>
 
 
 	<h2>What</h2>
 
 
+	<p>This library provides a simple set of helper methods
+and Capistrano tasks
+to manage slices and <span class="caps">DNS</span> zones/records on your Slicehost
+account (http://slicehost.com).</p>
+
+
 	<h2>Installing</h2>
 
 
 	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">slicehost</span></pre></p>
 
 
-	<h2>The basics</h2>
+	<h2>Capistrano tasks</h2>
 
 
-	<h2>Demonstration of usage</h2>
+	<p>There are two capistrano tasks:</p>
 
 
-	<h2>Forum</h2>
+	<p><pre class='syntax'>
+<span class="ident">cap</span> <span class="ident">slicehost</span><span class="symbol">:zone:add</span>       <span class="comment"># Create DNS zone</span>
+<span class="ident">cap</span> <span class="ident">slicehost</span><span class="symbol">:zone:mx:google</span> <span class="comment"># Add Google Apps MX records</span>
+</pre></p>
+
+
+	<p>To your config/deploy.rb, add the following:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">require</span> <span class="punct">&quot;</span><span class="string">slicehost/recipes/capistrano</span><span class="punct">&quot;</span> <span class="keyword">if</span> <span class="constant">Capistrano</span><span class="punct">::</span><span class="constant">Version</span><span class="punct">::</span><span class="constant">MAJOR</span> <span class="punct">&gt;=</span> <span class="number">2</span>
+
+<span class="comment"># Used to setup/update DNS registry of url =&gt; ip</span>
+<span class="ident">set</span> <span class="symbol">:domain_mapping</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">myurl.com</span><span class="punct">&quot;</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">123.456.789.012</span><span class="punct">&quot;</span>
+</pre></p>
+
+
+	<p>Then run <code>cap slicehost:zone:add</code> to create a base <span class="caps">DNS</span> zone. This will include the <code>myurl.com</code> and <code>www</code> entry, <span class="caps">PLUS</span> three nameserver entries for Slicehost&#8217;s namesevers.</p>
+
 
+	<p>If you are using Google Apps for your Email, then once you have created the Google Apps account, and you are asked to point the MX records to Google, you simply need to run one capistrano task: <code>cap slicehost:zone:mx:google</code> and all 5 MX records are added automatically.</p>
 
-	<p><a href="http://groups.google.com/group/slicehost">http://groups.google.com/group/slicehost</a></p>
+
+	<p>Easy peasy.</p>
+
+
+	<h2>Underlying <span class="caps">API</span></h2>
+
+
+	<p>The current <span class="caps">API</span> is very alpha. It was just the simplest thing that worked.
+There are unit tests demonstrating it working and everything.</p>
+
+
+	<p>Future releases will have a nicer, class-based <span class="caps">API</span>.</p>
+
+
+	<h2>Forum</h2>
 
 
-	<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; slicehost</p>
+	<p>To discuss bugs and features, go to the Google Group <a href="http://groups.google.com/group/slicehost-ruby-api">forum</a></p>
 
 
 	<h2>How to submit patches</h2>
 
 
-	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8c-rubyforge">8b: Submit patch to Rubyforge Tracker</a>, via <a href="http://rubyforge.org/tracker/?group_id=5140">Tracker</a>.</p>
 
 
 	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/slicehost/trunk</code> for anonymous access.</p>
@@ -80,9 +119,9 @@
 	<h2>Contact</h2>
 
 
-	<p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a> via the <a href="http://groups.google.com/group/slicehost">forum</a></p>
+	<p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a> via the <a href="http://groups.google.com/group/slicehost-ruby-api">forum</a></p>
     <p class="coda">
-      <a href="drnicwilliams@gmail.com">Dr Nic Williams</a>, 23rd December 2007<br>
+      <a href="drnicwilliams@gmail.com">Dr Nic Williams</a>, 24th December 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -1,31 +1,57 @@
-h1. slicehost
+h1. Slicehost Helpers
 
-h1. → 'slicehost'
+h1. cap slicehost:zone:add
 
 
 h2. What
 
+This library provides a simple set of helper methods
+and Capistrano tasks
+to manage slices and DNS zones/records on your Slicehost
+account (http://slicehost.com).
 
 h2. Installing
 
 <pre syntax="ruby">sudo gem install slicehost</pre>
 
-h2. The basics
+h2. Capistrano tasks
 
+There are two capistrano tasks:
+    
+<pre syntax="ruby">
+cap slicehost:zone:add       # Create DNS zone
+cap slicehost:zone:mx:google # Add Google Apps MX records
+</pre>
 
-h2. Demonstration of usage
+To your config/deploy.rb, add the following:
 
+<pre syntax="ruby">
+require "slicehost/recipes/capistrano" if Capistrano::Version::MAJOR >= 2
 
+# Used to setup/update DNS registry of url => ip
+set :domain_mapping, "myurl.com" => "123.456.789.012"
+</pre>
 
-h2. Forum
+Then run <code>cap slicehost:zone:add</code> to create a base DNS zone. This will include the <code>myurl.com</code> and <code>www</code> entry, PLUS three nameserver entries for Slicehost's namesevers.
+
+If you are using Google Apps for your Email, then once you have created the Google Apps account, and you are asked to point the MX records to Google, you simply need to run one capistrano task: <code>cap slicehost:zone:mx:google</code> and all 5 MX records are added automatically. 
+
+Easy peasy.
+
+h2. Underlying API
 
-"http://groups.google.com/group/slicehost":http://groups.google.com/group/slicehost
+The current API is very alpha. It was just the simplest thing that worked.
+There are unit tests demonstrating it working and everything. 
+
+Future releases will have a nicer, class-based API. 
+
+h2. Forum
 
-TODO - create Google Group - slicehost
+To discuss bugs and features, go to the Google Group "forum":http://groups.google.com/group/slicehost-ruby-api
 
 h2. How to submit patches
 
-Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Rubyforge Tracker":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8c-rubyforge, via "Tracker":http://rubyforge.org/tracker/?group_id=5140.
 
 The trunk repository is <code>svn://rubyforge.org/var/svn/slicehost/trunk</code> for anonymous access.
 
@@ -35,5 +61,5 @@ This code is free to use under the terms of the MIT license.
 
 h2. Contact
 
-Comments are welcome. Send an email to "Dr Nic Williams":mailto:drnicwilliams@gmail.com via the "forum":http://groups.google.com/group/slicehost
+Comments are welcome. Send an email to "Dr Nic Williams":mailto:drnicwilliams@gmail.com via the "forum":http://groups.google.com/group/slicehost-ruby-api
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: slicehost
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-12-23 00:00:00 +10:00
+date: 2007-12-24 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
-description: This library provides a simple set of helper methods to manage slices and DNS zones/records on your Slicehost account (http://slicehost.com).  The current API is very alpha. It was just the simplest thing that worked. There are unit tests demonstrating it working and everything.  Future releases will have a nicer, class-based API.
+description: "This library provides a simple set of helper methods to manage slices and DNS zones/records on your Slicehost account (http://slicehost.com).  == Capistrano tasks  There are two capistrano tasks: cap slicehost:zone:add       # Create DNS zone cap slicehost:zone:mx:google # Add Google Apps MX records  To your config/deploy.rb, add the following:  require \"slicehost/recipes/capistrano\" if Capistrano::Version::MAJOR >= 2 # Used to setup/update DNS registry of url => ip set :domain_mapping, \"myurl.com\" => \"123.456.789.012\"  == Underlying API  The current API is very alpha. It was just the simplest thing that worked. There are unit tests demonstrating it working and everything.   Future releases will have a nicer, class-based API.   Contact: Dr Nic Williams, drnicwilliams@gmail.com"
 email: drnicwilliams@gmail.com
 executables: []
 
@@ -34,7 +34,10 @@ files:
 - config/hoe.rb
 - config/requirements.rb
 - lib/slicehost.rb
+- lib/slicehost/recipes/capistrano.rb
+- lib/slicehost/samples/config.yml
 - lib/slicehost/version.rb
+- lib/tasks/zone.rake
 - local/slicehost.rb.sample
 - log/debug.log
 - script/destroy
@@ -46,6 +49,7 @@ files:
 - tasks/website.rake
 - test/test_admin.rb
 - test/test_helper.rb
+- test/test_sample_files.rb
 - test/test_slices.rb
 - test/test_zones.rb
 - website/index.html
@@ -79,9 +83,10 @@ rubyforge_project: slicehost
 rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
-summary: This library provides a simple set of helper methods to manage slices and DNS zones/records on your Slicehost account (http://slicehost.com).  The current API is very alpha. It was just the simplest thing that worked. There are unit tests demonstrating it working and everything.  Future releases will have a nicer, class-based API.
+summary: "This library provides a simple set of helper methods to manage slices and DNS zones/records on your Slicehost account (http://slicehost.com).  == Capistrano tasks  There are two capistrano tasks: cap slicehost:zone:add       # Create DNS zone cap slicehost:zone:mx:google # Add Google Apps MX records  To your config/deploy.rb, add the following:  require \"slicehost/recipes/capistrano\" if Capistrano::Version::MAJOR >= 2 # Used to setup/update DNS registry of url => ip set :domain_mapping, \"myurl.com\" => \"123.456.789.012\"  == Underlying API  The current API is very alpha. It was just the simplest thing that worked. There are unit tests demonstrating it working and everything.   Future releases will have a nicer, class-based API.   Contact: Dr Nic Williams, drnicwilliams@gmail.com"
 test_files: 
 - test/test_admin.rb
 - test/test_helper.rb
+- test/test_sample_files.rb
 - test/test_slices.rb
 - test/test_zones.rb