clouddns 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,114 @@
+clouddns
+========
+
+A DSL for managing your DNS on cloud services through [fog](http://fog.io/).
+
+Clouddns allows a convenient way to manage DNS on Amazon Route 53, bluebox, DNSimple, DNS Made Easy, Linode DNS, Slicehost DNS or Zerigo DNS.
+DNS records are described by configuration files in ruby, which are in a readable commentable format.
+This also allows keeping your DNS configuration in version control.
+Since DNS records are described in ruby, they can be defined programmatically, allowing DNS records to be made from database entries or other sources like a [chef server](http://www.opscode.com/chef/).
+
+Installation
+============
+
+    gem install clouddns
+
+Usage
+=====
+
+To change your DNS to that in the config file run
+
+    clouddns migrate dns.rb
+
+Where dns.rb is a file in the following format
+
+Configuration file
+==================
+
+The configuration files used by clouddns are written in ruby and specify zones at the top level, and records within.
+
+*Zones* group all records within a domain (usually, second-level or third-level).
+Within these zones, records are declared in the format `TYPE 'FULL.DOMAIN.NAME' 'VALUE'`
+
+Example configuration
+---------------------
+
+    provider 'AWS'
+
+    defaults :ttl => 600
+
+    zone 'example.com' do
+      A 'example.com', '1.2.3.4'
+      CNAME 'www.example.com', 'example.com.'
+
+      A 'mail.example.com', '4.3.2.1'
+      MX 'www.example.com', '10 mail.example.com.', :ttl => 300
+    end
+
+    zone 'example.net' do
+      A 'www.example.net', '1.2.3.4'
+    end
+
+Zone
+----
+
+Defines a zone. Takes one argument, the fully qualified domain name, and a block, which declares the records associated with the zone.
+Domain names can end with a dot, if missing, is is implied.
+
+Records
+-------
+
+Records must be defined within a zone.
+They are defined by calling the helper method for their type (A, CNAME, etc) with their FQDN, value, and any options.
+If the domain name is missing the trailing dot, it is implied.
+
+Value can be an array to specify multiple entries for that record (like in the case of Round-robin DNS, or multiple MX records).
+
+Options is currently only :ttl, which is specified in seconds. :ttl defaults to 3600, which can be changed using the defaults directive.
+
+Provider (optional)
+-------------------
+
+Credentials are required to access whichever service is desired through dns.
+This can be specified in full in the config file
+
+    provider 'AWS',
+             :aws_secret_access_key => YOUR_SECRET_ACCESS_KEY,
+             :aws_access_key_id     => YOUR_SECRET_ACCESS_KEY_ID
+
+Alternatively, to avoid specifying access keys or access key in the file (A good idea if it's to enter version control),
+fog will read credentials from `~/.fog` or the file specified in `ENV["FOG_RC"]`.
+One can then specify the provider by itself in the config file (like `provider 'AWS'`) or using the `-p PROVIDER` option of the clouddns executable.
+
+Defaults
+--------
+
+Defaults specified options which will be used by any zones or records defined in the file.
+Currently, this can only be used to specify :ttl.
+
+
+Copyright
+=========
+
+(The MIT License)
+
+Copyright (c) 2011 [John Hawthorn](http://www.johnhawthorn.com/)
+
+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
+

data/bin/clouddns

@@ -37,11 +37,17 @@ files = ARGV
 raise "No action specified" unless action
 raise "No files specified" if files.empty?
 
+action = Clouddns::Actions.by_name(action)
+
 zones = files.map do |file|
-  Clouddns::DSL.parse_file(file).zones
-end.flatten
+  dsl = Clouddns::DSL.parse_file(file)
+
+  dsloptions = {:fog => dsl.fog_options}.merge(options) do |key, oldval, newval|
+    oldval.merge(newval)
+  end
 
-zones.each do |zone|
-  Clouddns::Actions.by_name(action).run(zone, options)
+  dsl.zones.each do |zone|
+    action.run(zone, dsloptions)
+  end
 end
 

data/lib/clouddns.rb

@@ -1,10 +1,11 @@
 require "fog"
 
-require "clouddns/version"
+require "clouddns/actions"
 require "clouddns/dsl"
-require "clouddns/zone"
 require "clouddns/record"
-require "clouddns/actions"
+require "clouddns/version"
+require "clouddns/zone"
+require "clouddns/zone_migration"
 
 module Clouddns
 end

data/lib/clouddns/actions/migrate.rb

@@ -7,83 +7,61 @@ module Clouddns
 
       def run
         @fog = Fog::DNS.new(@options[:fog])
-
         @fog_zone = @fog.zones.find { |z| z.domain == @zone.name }
 
         puts
         puts "Migrating '#{@zone.name}'"
 
-        unless @fog_zone
-          puts
-          puts "Zone '#{@zone.name}' does not exist. Creating..."
-          require_confirmation!
-          @fog_zone = @fog.zones.create(:domain => @zone.name)
-          puts "Zone '#{@zone.name}' created."
-        end
+        create_zone! unless @fog_zone
 
-        # required to pick up nameservers
+        # required to pick up nameservers and records
         @fog_zone = @fog_zone.reload
 
-        puts
-        puts "Nameservers:"
-        @fog_zone.nameservers.each do |nameserver|
-          puts "  #{nameserver}"
-        end
-
-        puts
-        puts "Changes:"
-        @records_to_remove = []
-        @records_to_add = []
-
-        @namelength = (@fog_zone.records.map(&:name) + @zone.records.map(&:name)).map(&:length).max
-
-        @actions = []
-
-        fog_records = Hash[@fog_zone.records.map {|r| [[r.name.gsub('\052', '*'), r.type], r] } ]
-        @zone.records.each do |record|
-          if (fog_record = fog_records.delete([record.name, record.type]))
-            if equal?(record, fog_record)
-              @actions << [' ', record]
-            else
-              @actions << ['-', fog_record]
-              @actions << ['+', record]
-            end
-          else
-            @actions << ['+', record]
-          end
-        end
+        print_nameservers
 
-        fog_records.each do |name, record|
-          @actions << ['-', record]
-        end
+        @migration = ZoneMigration.new(@zone, @fog_zone)
 
-        @actions.each do |(action, record)|
-          print_record record, @namelength, action
-        end
+        print_changes
 
         # no changes required
-        return if @actions.all? {|(action, record)| action == ' ' }
+        return if @migration.completed?
 
         require_confirmation!
 
-        @actions.each do |(action, record)|
-          if action == '+'
-            @fog_zone.records.create(:type => record.type, :name => record.name, :ip => record.value, :ttl => record.ttl)
-          elsif action == '-'
-            record.destroy
-          end
-        end
+        @migration.perform!
+
         puts "Done"
       end
 
       private
 
-      def equal? record, fog_record
-        # AWS replaces * with \052
-        record.name == fog_record.name.gsub('\052', '*') &&
-          record.type == fog_record.type &&
-          record.value == fog_record.ip &&
-          record.ttl.to_i == fog_record.ttl.to_i
+      def create_zone!
+        puts
+        puts "Zone '#{@zone.name}' does not exist. Creating..."
+        require_confirmation!
+        @fog_zone = @fog.zones.create(:domain => @zone.name)
+        puts "Zone '#{@zone.name}' created."
+      end
+
+      def print_nameservers
+        puts
+        puts "Nameservers:"
+        @fog_zone.nameservers.each do |nameserver|
+          puts "  #{nameserver}"
+        end
+      end
+
+      def print_changes
+        namelength = @migration.changes.map do |(action, record)|
+          record.name.length
+        end.max
+
+        puts
+        puts "Changes:"
+
+        @migration.changes.each do |(action, record)|
+          print_record record, namelength, action
+        end
       end
 
       def require_confirmation!

data/lib/clouddns/dsl.rb

@@ -1,20 +1,16 @@
 module Clouddns
   class DSL
     attr_reader :zones
+    attr_reader :fog_options
 
     # This need not be too strict. Only exists to help catch typos.
     DNS_REGEX = /\A.*\..*\.\z/
 
-    def scope options={}
-      oldscope = @scope
-      @scope = @scope.merge(options)
-      yield
-      @scope = oldscope
-    end
-
     def initialize
       @zones = []
-      @scope = {}
+      @zone = nil
+      @defaults = {}
+      @fog_options = {}
     end
 
     def self.parse_string string
@@ -26,37 +22,59 @@ module Clouddns
       parse_string open(filename).read
     end
 
-    def A *args
-      add_record 'A', *args
-    end
-    def CNAME *args
-      add_record 'CNAME', *args
-    end
-    def MX *args
-      add_record 'MX', *args
-    end
-    def NS *args
-      add_record 'NS', *args
-    end
-    def TXT name, value, options={}
-      add_record 'TXT', name, "\"#{value}\"", options
+    protected
+
+    record_types = %w{A AAAA CNAME MX NS PTR SOA SPF SRV TXT}
+    record_types.each do |type|
+      define_method type do |*args|
+        add_record type, *args
+      end
     end
 
     def add_record type, name, value, options={}
-      zone = @scope[:zone]
+      name = domainname(name)
+
+      value = "\"#{value}\"" if type == 'TXT'
 
-      raise "records must be added inside a zone" unless zone
-      raise "record's dns name must end with the current zone" unless name.end_with? zone.name
+      raise "records must be added inside a zone" unless @zone
+      raise "record's dns name must end with the current zone" unless name.end_with? @zone.name
 
-      @scope[:zone].records << Record.new(type, name, value, options)
+      @zone.records << Record.new(type, name, value, options)
     end
 
-    def zone name, &block
-      raise "zone must be at the top level" if @scope[:zone]
+    def zone name
+      raise "zones cannot be nested" if @zone
 
-      zone = Zone.new(name)
-      @zones << zone
-      scope :zone => zone, &block
+      @zone = Zone.new(domainname(name))
+      @zones << @zone
+      yield
+      @zone = nil
+    end
+
+    def defaults options={}
+      if block_given?
+        old = @defaults
+        @defaults = @defaults.merge(options)
+        yield
+        @defaults = old
+      else
+        raise "defaults must either take a block or be before any zone declarations" unless @zones.empty?
+        @defaults = @defaults.merge(options)
+      end
+    end
+
+    def provider name, options={}
+      @fog_options = options.merge({:provider => name})
+    end
+
+    private
+    def domainname name
+      if name.end_with? '.'
+        name
+      else
+        "#{name}."
+      end
     end
   end
 end
+

data/lib/clouddns/version.rb

@@ -1,3 +1,3 @@
 module Clouddns
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/clouddns/zone_migration.rb

@@ -0,0 +1,61 @@
+module Clouddns
+  class ZoneMigration
+    def initialize zone, fog_zone
+      @zone = zone
+      @fog_zone = fog_zone
+      @changes = nil
+    end
+    def changes
+      return @changes if @changes
+      @changes = []
+      fog_records = Hash[@fog_zone.records.map {|r| [[fog_record_name(r), r.type], r] } ]
+      @zone.records.each do |record|
+        if (fog_record = fog_records.delete([record.name, record.type]))
+          if records_equal?(record, fog_record)
+            @changes << [' ', record]
+          else
+            @changes << ['-', fog_record]
+            @changes << ['+', record]
+          end
+        else
+          @changes << ['+', record]
+        end
+      end
+
+      fog_records.each do |name, record|
+        @changes << ['-', record]
+      end
+      @changes
+    end
+
+    def perform!
+      changes.each do |(action, record)|
+        if action == '+'
+          @fog_zone.records.create(:type => record.type, :name => record.name, :ip => record.value, :ttl => record.ttl)
+        elsif action == '-'
+          record.destroy
+        end
+      end
+    end
+
+    def completed?
+      changes.all? do |(action, record)|
+        action == ' '
+      end
+    end
+
+    protected
+    def fog_record_name record
+      record.name.gsub('\052', '*')
+    end
+
+    def records_equal? record, fog_record
+      # AWS replaces * with \052
+      record.name == fog_record_name(fog_record) &&
+        record.type == fog_record.type &&
+        record.value == fog_record.ip &&
+        record.ttl.to_i == fog_record.ttl.to_i
+    end
+
+  end
+end

data/test/dsl_test.rb

@@ -19,5 +19,15 @@ class DslTest < Test::Unit::TestCase
     assert_equal 'www.example.com.', record.name
     assert_equal ['1.2.3.4'], record.value
   end
+  def test_trailing_dot_is_implied
+    dsl = Clouddns::DSL.parse_string <<-EOL
+      zone "example.com" do
+        A 'www.example.com', '1.2.3.4'
+      end
+    EOL
+
+    assert_equal 'example.com.', dsl.zones.first.name
+    assert_equal 'www.example.com.', dsl.zones.first.records.first.name
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clouddns
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - John Hawthorn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-11 00:00:00 Z
+date: 2011-07-14 00:00:00 Z
 dependencies: []
 
 description: A DSL for managing DNS through cloud services
@@ -30,6 +30,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - bin/clouddns
 - clouddns.gemspec
@@ -43,6 +44,7 @@ files:
 - lib/clouddns/record.rb
 - lib/clouddns/version.rb
 - lib/clouddns/zone.rb
+- lib/clouddns/zone_migration.rb
 - test/dsl_test.rb
 - test/test_helper.rb
 homepage: https://github.com/jhawthorn/clouddns