dns-zone 0.0.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82c71fa4e618b0bff6f946e6097511699e49aec0
+  data.tar.gz: b4021e5692ea47f2ca8a3d129aed828593155af7
+SHA512:
+  metadata.gz: f162ed2a6e7804120dd8b6fadac2c5b4c6d2a51b9044e66dc8e48fc2c86e1dbad34f89b185934febb26cc41d6f032dfff742bf7254b5fd553cbf77363d82653c
+  data.tar.gz: 4242b9bbf4fe966a790e948ff5e31affc9488ac0fe5c6f6dd1ae2e92cd4b4e2f68f04bfe2f0bb685e7f8eac15e2420855568da9419a1849534c43e089022acd3

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+# Run minitest suite
+guard :minitest do
+  watch(%r{^dns-zone\.gemspec})                  { 'all' }
+  watch(%r{^lib/dns/(.*)\.rb})                   { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^lib/dns/zone/test_case\.rb})         { 'all' }
+  watch(%r{^lib/dns/zone/(.*/)?([^/]+)\.rb})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/(.*/)*(.*)_test\.rb})
+end
+
+# Run `bundle update|install` when gem files altered.
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/HISTORY.md

@@ -0,0 +1,3 @@
+## 0.0.0 (2014-02-16)
+
+* Initial development/hacking initiated.

data/README.md

@@ -0,0 +1,100 @@
+dns-zone
+========
+
+A Ruby library for building and parsing DNS zone files.
+
+## Installation
+
+Add this line to your Gemfile:
+
+    gem 'dns-zone'
+
+And then execute:
+
+    bundle install
+
+Require the gem in your code:
+
+    require 'dns/zone'
+
+## Usage
+
+    DNS::Zone.new
+    DNS::Zone.load(zone_as_string)
+    DNS::Zone::RR.load(rr_as_string)
+    DNS::Zone::RR::A.load(a_rr_as_string)
+
+    zone = DNS::Zone.new
+    zone.origin = 'example.com.'
+    # FIXME: not sure what RFC (if any) defines the time formatting
+    zone.ttl = '1d'
+    # FIXME: keep DNS style representation? for <domain-name>s and email addresses
+    zone.soa.nameserver = 'ns0.lividpenguin.com.'
+    zone.soa.email = 'hostmaster.lividpenguin.com.'
+
+    # output as dns zone file
+    zone.to_zone_file
+
+# Development
+
+## Development Commands
+
+    # install external gem dependencies first
+    bundle install
+
+    # run all tests and build code coverage
+    bundle exec rake test
+
+    # hints where to improve docs
+    bundle exec inch
+
+    # watch for changes and run development commands (tests, documentation, etc)
+    bundle exec guard
+
+# TODO
+
+## Must have
+
+    [ ] Ability to load a whole zone
+    [x] Add support for RR Type: SOA
+    [ ] Add support for RR Type: PTR
+    [ ] Add support for RR Type: SPF
+    [ ] Add support for RR Type: LOC
+    [ ] Add support for RR Type: HINFO
+
+## Would be nice
+
+    [ ] Handle parsing a zone file that uses more then one $ORIGIN directive.
+    [ ] Validation, error checking...
+        [ ] Only one SOA per zone.
+        [ ] CNAMEs can't use a label of `@`.
+
+    [ ] Ability to 'include' defaults/records into a zone.
+        This may or may not want to mean supporting the `$INCLUDE` directive.
+
+## At some point; low priority
+
+    [ ] Configuration options:
+        [ ] spaces/tabs used between RR params in zone file output
+        [ ] time format to use (seconds or bind time format (e.g. 1d))
+        [ ] add comments to explain TTL's that are in seconds
+    [ ] Ability to add comment to RR (n.b. currently we strip comments when parsing)
+    [ ] Add support for RR Type: DNAME
+    [ ] Add support for RR Type: DNSKEY
+    [ ] Add support for RR Type: DS
+    [ ] Add support for RR Type: KEY
+    [ ] Add support for RR Type: NSEC
+    [ ] Add support for RR Type: RRSIG
+    [ ] Add support for RR Type: NAPTR
+    [ ] Add support for RR Type: RP
+    [ ] Add support for RR Type: RT
+
+# Notes
+
+- RR Format: `[<TTL>] [<class>] <type> <RDATA>`
+- A DNS zone is built from RR's and a couple of other special directives.
+- If zone file does not include $ORIGIN, it will be inferred by the `zone "<zone-name>" {}` clause from bind.conf
+  In general we should always explicitly define an $ORIGIN directive unless there is a very good reason not to.
+- [RFC 1035 - Domain Names - Implementation and Specification](http://www.ietf.org/rfc/rfc1035.txt)
+- [RFC 2308 - Negative Caching of DNS Queries (DNS NCACHE)](http://www.ietf.org/rfc/rfc2308.txt)
+- [RFC 3596 - DNS Extensions to Support IP Version 6](http://www.ietf.org/rfc/rfc3596.txt)

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems' unless defined?(Gem)
+require 'bundler'
+require 'rake'
+require 'rake/testtask'
+
+# by default run unit tests.
+task :default => 'test'
+
+desc 'Run full test suite and generate code coverage -- COVERAGE=false to disable code coverage'
+Rake::TestTask.new(:test) do |task|
+  ENV['COVERAGE'] ||= 'yes'
+  task.libs << 'test'
+  task.pattern = 'test/**/*_test.rb'
+  task.verbose = true
+end

data/dns-zone.gemspec

@@ -0,0 +1,41 @@
+require './lib/dns/zone/version'
+
+spec = Gem::Specification.new do |s|
+  # gem information/details
+  s.name                = 'dns-zone'
+  s.version             = DNS::Zone::Version
+  s.date                = Time.now.strftime('%Y-%m-%d')
+  s.summary             = 'A Ruby library for building and parsing DNS zone files.'
+  s.license             = 'MIT'
+  s.homepage            = 'https://github.com/lantins/dns-zone'
+  s.authors             = ['Luke Antins']
+  s.email               = ['luke@lividpenguin.com']
+
+  # gem settings for what files to include.
+  s.files               = %w(Rakefile README.md HISTORY.md Gemfile Guardfile dns-zone.gemspec)
+  s.files              += Dir.glob('{test/**/*,lib/**/*}')
+  s.require_paths       = ['lib']
+  #s.executables         = ['dns-zone']
+  #s.default_executable  = 'dns-zone'
+
+  # min ruby version
+  s.required_ruby_version = ::Gem::Requirement.new("~> 1.9")
+
+  # cross platform gem dependencies
+  #s.add_dependency('gli')
+  #s.add_dependency('paint')
+  s.add_development_dependency('bundler', '~> 0')
+  s.add_development_dependency('rake', '~> 0')
+  s.add_development_dependency('minitest', '~> 0')
+  s.add_development_dependency('simplecov', '~> 0.7')
+  s.add_development_dependency('yard', '~> 0')
+  s.add_development_dependency('inch', '~> 0')
+  s.add_development_dependency('guard-minitest', '~> 0')
+  s.add_development_dependency('guard-bundler', '~> 0')
+
+  # long description.
+  s.description       = <<-EOL
+A Ruby library for building and parsing DNS zone files for use with
+Bind and PowerDNS (with Bind backend) DNS servers.
+  EOL
+end

data/lib/dns/zone.rb

@@ -0,0 +1,105 @@
+require 'dns/zone/rr'
+require 'dns/zone/version'
+
+# :nodoc:
+module DNS
+
+  # Represents a 'whole' zone of many resource records (RRs).
+  #
+  # This is also the primary namespace for the `dns-zone` gem.
+  class Zone
+
+    attr_accessor :ttl, :origin, :records
+
+    def initialize
+      @records = []
+    end
+
+    # FROM RFC:
+    #     The format of these files is a sequence of entries.  Entries are
+    #     predominantly line-oriented, though parentheses can be used to continue
+    #     a list of items across a line boundary, and text literals can contain
+    #     CRLF within the text.  Any combination of tabs and spaces act as a
+    #     delimiter between the separate items that make up an entry.  The end of
+    #     any line in the master file can end with a comment.  The comment starts
+    #     with a ";" (semicolon). 
+
+    def self.load(string)
+      # get entries
+      entries = self.extract_entries(string)
+
+      instance = self.new
+
+      entries.each do |entry|
+        if entry =~ /\$(ORIGIN|TTL)\s+(.+)/
+          instance.ttl    = $2 if $1 == 'TTL'
+          instance.origin = $2 if $1 == 'ORIGIN'
+          next
+        end
+
+        if entry =~ DNS::Zone::RR::RX_RR
+          rec = DNS::Zone::RR.load(entry)
+          instance.records << rec if rec
+        end
+
+      end
+
+      # read in special statments like $TTL and $ORIGIN
+      # parse each RR and create a Ruby object for it
+      return instance
+    end
+
+    def self.extract_entries(string)
+      entries = []
+      mode = :line
+      entry = ''
+
+      parentheses_ref_count = 0
+
+      string.lines.each do |line|
+        # strip comments unless escaped
+        line = line.gsub(/(?<!\\);.*/o, '').chomp
+
+        next if line.gsub(/\s+/, '').empty?
+
+        # append to entry line
+        entry << line
+
+        quotes = entry.count('"')
+        has_quotes = quotes > 0
+
+        parentheses = entry.count('()')
+        has_parentheses = parentheses > 0
+
+        if has_quotes
+          character_strings = entry.scan(/("(?:[^"\\]+|\\.)*")/).join(' ')
+          without = entry.gsub(/"((?:[^"\\]+|\\.)*)"/, '')
+          parentheses_ref_count = without.count('(') - without.count(')')
+        else
+          parentheses_ref_count = entry.count('(') - entry.count(')')
+        end
+
+        # are parentheses balanced?
+        if parentheses_ref_count == 0
+          if has_quotes
+            without.gsub!(/[()]/, '')
+            without.gsub!(/[ ]{2,}/, '  ')
+            #entries << (without + character_strings)
+            entry = (without + character_strings)
+          else
+            entry.gsub!(/[()]/, '')
+            entry.gsub!(/[ ]{2,}/, '  ')
+            entry.gsub!(/[ ]+$/, '')
+            #entries << entry
+          end
+          entries << entry
+          entry = ''
+        end
+
+      end
+
+      return entries
+    end
+
+  end
+end

data/lib/dns/zone/rr.rb

@@ -0,0 +1,51 @@
+module DNS
+  class Zone
+
+    # The module containes resource record types supported by this gem.
+    # The #{load} method will convert RR string data into a Ruby class.
+    module RR
+
+      RX_TTL = /\d+[wdmhs]?/i
+      RX_KLASS = /(?<klass>IN)?/i
+      RX_TYPE = /(?<type>A|AAAA|CNAME|MX|NS|SOA|SRV|TXT)\s{1}/i
+      RX_RR = /^(?<label>\S+|\s{1})\s*(?<ttl>#{RX_TTL})?\s*#{RX_KLASS}\s*#{RX_TYPE}\s*(?<rdata>[\s\S]*)$/i
+      RX_DOMAINNAME = /\S+\./i
+
+      # Load RR string data and return an instance representing the RR.
+      #
+      # @param string [String] RR ASCII string data
+      # @param options [Hash] additional data required to correctly parse a 'whole' zone
+      # @option options [String] :last_label The last label used by the previous RR
+      # @return [Object]
+      def self.load(string, options = {})
+        # strip comments, unless its escaped.
+        string.gsub!(/(?<!\\);.*/o, "");
+
+        captures = string.match(RX_RR)
+        return nil unless captures
+
+        case captures[:type]
+        when 'A' then A.new.load(string, options)
+        when 'AAAA' then AAAA.new.load(string, options)
+        when 'TXT' then TXT.new.load(string, options)
+        when 'SOA' then SOA.new.load(string, options)
+        when 'NS' then NS.new.load(string, options)
+        else
+          raise 'Unknown RR Type'          
+        end
+      end
+
+      autoload :Record, 'dns/zone/rr/record'
+
+      autoload :A,      'dns/zone/rr/a'
+      autoload :AAAA,   'dns/zone/rr/aaaa'
+      autoload :CNAME,  'dns/zone/rr/cname'
+      autoload :MX,     'dns/zone/rr/mx'
+      autoload :NS,     'dns/zone/rr/ns'
+      autoload :SOA,    'dns/zone/rr/soa'
+      autoload :SRV,    'dns/zone/rr/srv'
+      autoload :TXT,    'dns/zone/rr/txt'
+    end
+
+  end
+end

data/lib/dns/zone/rr/a.rb

@@ -0,0 +1,21 @@
+# `A` resource record.
+#
+# RFC 1035
+class DNS::Zone::RR::A < DNS::Zone::RR::Record
+
+  attr_accessor :address
+
+  def to_s
+    parts = general_prefix
+    parts << address
+    parts.join(' ')
+  end
+
+  def load(string, options = {})
+    rdata = load_general_and_get_rdata(string, options)
+    return nil unless rdata
+    @address = rdata
+    self
+  end
+
+end

data/lib/dns/zone/rr/aaaa.rb

@@ -0,0 +1,5 @@
+# `AAAA` resource record.
+#
+# RFC xxxx
+class DNS::Zone::RR::AAAA < DNS::Zone::RR::A
+end

data/lib/dns/zone/rr/cname.rb

@@ -0,0 +1,14 @@
+# `CNAME` resource record.
+#
+# RFC 1035
+class DNS::Zone::RR::CNAME < DNS::Zone::RR::Record
+
+  attr_accessor :domainname
+
+  def to_s
+    parts = general_prefix
+    parts << domainname
+    parts.join(' ')
+  end
+
+end

data/lib/dns/zone/rr/mx.rb

@@ -0,0 +1,16 @@
+# `MX` resource record.
+#
+# RFC 1035
+class DNS::Zone::RR::MX < DNS::Zone::RR::Record
+
+  attr_accessor :preference
+  attr_accessor :exchange
+
+  def to_s
+    parts = general_prefix
+    parts << preference
+    parts << exchange
+    parts.join(' ')
+  end
+
+end

data/lib/dns/zone/rr/ns.rb

@@ -0,0 +1,21 @@
+# `NS` resource record.
+#
+# RFC 1035
+class DNS::Zone::RR::NS < DNS::Zone::RR::Record
+
+  attr_accessor :nameserver
+
+  def to_s
+    parts = general_prefix
+    parts << nameserver
+    parts.join(' ')
+  end
+
+  def load(string, options = {})
+    rdata = load_general_and_get_rdata(string, options)
+    return nil unless rdata
+    @nameserver = rdata
+    self
+  end
+
+end

data/lib/dns/zone/rr/record.rb

@@ -0,0 +1,81 @@
+# Parent class of all RR types, common resource record code lives here.
+# Is responsible for building a Ruby object given a RR string.
+#
+# @abstract Each RR TYPE should subclass and override: {#load} and #{to_s} 
+class DNS::Zone::RR::Record
+
+  attr_accessor :label, :ttl
+  attr_reader :klass
+
+  def initialize
+    @label = '@'
+    @klass = 'IN'
+  end
+
+  # FIXME: should we just: `def type; 'SOA'; end` rather then do the class name convension?
+  #
+  # Figures out TYPE of RR using class name.
+  # This means the class name _must_ match the RR ASCII TYPE.
+  #
+  # When called directly on the parent class (that you should never do), it will
+  #   return the string as `<type>`, for use with internal tests.
+  #
+  # @return [String] the RR type
+  def type
+    name = self.class.name.split('::').last
+    return '<type>' if name == 'Record'
+    name
+  end
+
+  # Returns 'general' prefix (in parts) that come before the RDATA.
+  # Used by all RR types, generates: `[<label>] [<ttl>] [<class>] <type>`
+  #
+  # @return [Array<String>] rr prefix parts
+  def general_prefix
+    parts = []
+    parts << label
+    parts << ttl if ttl
+    parts << 'IN'
+    parts << type
+    parts
+  end
+
+  # Build RR zone file output.
+  #
+  # @return [String] RR zone file output
+  def to_s
+    general_prefix.join(' ')
+  end
+
+  # @abstract Override to update instance with RR type spesific data.
+  # @param string [String] RR ASCII string data
+  # @param options [Hash] additional data required to correctly parse a 'whole' zone
+  # @option options [String] :last_label The last label used by the previous RR
+  # @return [Object]
+  def load(string, options = {})
+    raise 'must be implemented by subclass'
+  end
+
+  # Load 'general' RR data/params and return the remaining RDATA for further parsing.
+  #
+  # @param string [String] RR ASCII string data
+  # @param options [Hash] additional data required to correctly parse a 'whole' zone
+  # @return [String] remaining RDATA
+  def load_general_and_get_rdata(string, options = {})
+    # strip comments, unless its escaped.
+    string.gsub!(/(?<!\\);.*/o, "");
+
+    captures = string.match(DNS::Zone::RR::RX_RR)
+    return nil unless captures
+
+    if captures[:label] == ' '
+      @label = options[:last_label]
+    else
+      @label = captures[:label]
+    end
+
+    @ttl = captures[:ttl]
+    captures[:rdata]
+  end
+
+end

data/lib/dns/zone/rr/soa.rb

@@ -0,0 +1,52 @@
+# `SRV` resource record.
+#
+# RFC xxxx
+class DNS::Zone::RR::SOA < DNS::Zone::RR::Record
+
+  RX_SOA_RDATA = %r{
+    (?<nameserver>#{DNS::Zone::RR::RX_DOMAINNAME})\s* # get nameserver domainname
+    (?<email>#{DNS::Zone::RR::RX_DOMAINNAME})\s*      # get mailbox domainname
+    (?<serial>\d+)\s*
+    (?<refresh_ttl>#{DNS::Zone::RR::RX_TTL})\s*
+    (?<retry_ttl>#{DNS::Zone::RR::RX_TTL})\s*
+    (?<expiry_ttl>#{DNS::Zone::RR::RX_TTL})\s*
+    (?<minimum_ttl>#{DNS::Zone::RR::RX_TTL})\s*
+  }mx
+
+  attr_accessor :nameserver, :email, :serial, :refresh_ttl, :retry_ttl, :expiry_ttl, :minimum_ttl
+
+  def to_s
+    parts = general_prefix
+    parts << nameserver
+    parts << email
+
+    parts << '('
+    parts << serial
+    parts << refresh_ttl
+    parts << retry_ttl
+    parts << expiry_ttl
+    parts << minimum_ttl
+    parts << ')'
+    parts.join(' ')
+  end
+
+  def load(string, options = {})
+    rdata = load_general_and_get_rdata(string, options)
+    return nil unless rdata
+
+    captures = rdata.match(RX_SOA_RDATA)
+    return nil unless captures
+
+    @nameserver = captures[:nameserver]
+    @email = captures[:email]
+    @serial = captures[:serial].to_i
+    @refresh_ttl = captures[:refresh_ttl]
+    @retry_ttl = captures[:retry_ttl]
+    @expiry_ttl = captures[:expiry_ttl]
+    @minimum_ttl = captures[:minimum_ttl]
+
+
+    self
+  end
+
+end

data/lib/dns/zone/rr/srv.rb

@@ -0,0 +1,17 @@
+# `SRV` resource record.
+#
+# RFC xxxx
+class DNS::Zone::RR::SRV < DNS::Zone::RR::Record
+
+  attr_accessor :priority, :weight, :port, :target
+
+  def to_s
+    parts = general_prefix
+    parts << priority
+    parts << weight
+    parts << port
+    parts << target
+    parts.join(' ')
+  end
+
+end

data/lib/dns/zone/rr/txt.rb

@@ -0,0 +1,22 @@
+# `A` resource record.
+#
+# RFC 1035
+class DNS::Zone::RR::TXT < DNS::Zone::RR::Record
+
+  attr_accessor :text
+
+  def to_s
+    parts = general_prefix
+    parts << %Q{"#{text}"}
+    parts.join(' ')
+  end
+
+  def load(string, options = {})
+    rdata = load_general_and_get_rdata(string, options)
+    return nil unless rdata
+    # extract text from within quotes; allow multiple quoted strings; ignore escaped quotes
+    @text = rdata.scan(/"((?:[^"\\]+|\\.)*)"/).join
+    self
+  end
+
+end

data/lib/dns/zone/test_case.rb

@@ -0,0 +1,28 @@
+#
+# test_case.rb - A file used to setup the testing enviroment for the library.
+#
+
+require 'rubygems'
+
+# --- code coverage on MRI 1.9 ruby only, but disabled by default --------------
+if RUBY_VERSION >= '1.9' && RUBY_ENGINE == 'ruby' && ENV['COVERAGE']
+  require 'simplecov'
+  #SimpleCov.command_name 'test:unit'
+  SimpleCov.start do
+    # code coverage groups.
+    add_filter 'test/'
+  end
+end
+
+# --- load our dependencies using bundler --------------------------------------
+require 'bundler/setup'
+Bundler.setup
+require 'minitest/autorun'
+require 'minitest/pride'
+
+# --- Load lib to test ---------------------------------------------------------
+require 'dns/zone'
+
+# --- Extend DNS::Zone::TestCase -------------------------------------------------
+class DNS::Zone::TestCase < Minitest::Test
+end

data/lib/dns/zone/version.rb

@@ -0,0 +1,6 @@
+module DNS
+  class Zone
+    # Version number (major.minor.tiny)
+    Version = '0.0.0.alpha'
+  end
+end

data/test/rr/a_test.rb

@@ -0,0 +1,36 @@
+require 'dns/zone/test_case'
+
+class RR_A_Test < DNS::Zone::TestCase
+
+  def test_build_rr__a
+    rr = DNS::Zone::RR::A.new    
+
+    # ensure we can set address parameter
+    rr.address = '10.0.1.1'
+    assert_equal '@ IN A 10.0.1.1', rr.to_s
+    rr.address = '10.0.2.2'
+    assert_equal '@ IN A 10.0.2.2', rr.to_s
+
+    # with a label set
+    rr.label = 'labelname'
+    assert_equal 'labelname IN A 10.0.2.2', rr.to_s
+
+    # with a ttl
+    rr.ttl = '4w'
+    assert_equal 'labelname 4w IN A 10.0.2.2', rr.to_s
+  end
+
+  def test_load
+    rr = DNS::Zone::RR::A.new.load('@ IN A 127.0.0.1')
+    assert_equal '@', rr.label
+    assert_equal 'A', rr.type
+    assert_equal '127.0.0.1', rr.address
+
+    rr = DNS::Zone::RR::A.new.load('www IN A 127.0.0.1')
+    assert_equal 'www', rr.label
+    assert_equal 'A', rr.type
+    assert_equal 'IN', rr.klass
+    assert_equal '127.0.0.1', rr.address
+  end
+
+end

data/test/rr/aaaa_test.rb

@@ -0,0 +1,13 @@
+require 'dns/zone/test_case'
+
+class RR_AAAA_Test < DNS::Zone::TestCase
+
+  def test_build_rr__aaaa
+    rr = DNS::Zone::RR::AAAA.new    
+
+    # ensure we can set address parameter
+    rr.address = '2001:db8::3'
+    assert_equal '@ IN AAAA 2001:db8::3', rr.to_s
+  end
+
+end

data/test/rr/cname_test.rb

@@ -0,0 +1,12 @@
+require 'dns/zone/test_case'
+
+class RR_CNAME_Test < DNS::Zone::TestCase
+
+  def test_build_rr__cname
+    rr = DNS::Zone::RR::CNAME.new
+    rr.label = 'google9d97d7f266ee521d'
+    rr.domainname = 'google.com.'
+    assert_equal 'google9d97d7f266ee521d IN CNAME google.com.', rr.to_s
+  end
+
+end

data/test/rr/mx_test.rb

@@ -0,0 +1,18 @@
+require 'dns/zone/test_case'
+
+class RR_MX_Test < DNS::Zone::TestCase
+
+  def test_build_rr__mx
+    rr = DNS::Zone::RR::MX.new    
+
+    # ensure we can set preference and exchange parameter
+    rr.preference = '10'
+    rr.exchange = 'mx0.lividpenguin.com.'
+    assert_equal '@ IN MX 10 mx0.lividpenguin.com.', rr.to_s
+
+    rr.preference = '20'
+    rr.exchange = 'mx1.lividpenguin.com.'
+    assert_equal '@ IN MX 20 mx1.lividpenguin.com.', rr.to_s
+  end
+
+end

data/test/rr/ns_test.rb

@@ -0,0 +1,11 @@
+require 'dns/zone/test_case'
+
+class RR_NS_Test < DNS::Zone::TestCase
+
+  def test_build_rr__ns
+    rr = DNS::Zone::RR::NS.new
+    rr.nameserver = 'ns0.lividpenguin.com.'
+    assert_equal '@ IN NS ns0.lividpenguin.com.', rr.to_s
+  end
+
+end

data/test/rr/record_test.rb

@@ -0,0 +1,30 @@
+require 'dns/zone/test_case'
+
+class RR_Record_Test < DNS::Zone::TestCase
+
+  def test_rr_record_defaults
+    rr = DNS::Zone::RR::Record.new
+    assert_equal '@', rr.label, 'label is @, by default'
+    assert_equal nil, rr.ttl, 'ttl is nil, by default'
+  end
+
+  def test_rr_record_with_label
+    rr = DNS::Zone::RR::Record.new
+    rr.label = 'labelname'
+    assert_equal 'labelname IN <type>', rr.to_s
+  end
+
+  def test_rr_record_with_label_and_ttl
+    rr = DNS::Zone::RR::Record.new
+    rr.label = 'labelname'
+    rr.ttl = '2d'
+    assert_equal 'labelname 2d IN <type>', rr.to_s
+  end
+
+  def test_rr_record_with_ttl
+    rr = DNS::Zone::RR::Record.new
+    rr.ttl = '2d'
+    assert_equal '@ 2d IN <type>', rr.to_s
+  end
+
+end

data/test/rr/soa_test.rb

@@ -0,0 +1,34 @@
+require 'dns/zone/test_case'
+
+class RR_SRV_Test < DNS::Zone::TestCase
+
+  EXAMPLE_SOA_IN  = '@ IN SOA ns0.lividpenguin.com. luke.lividpenguin.com. 2014021601 3h 15m 4w 30m'
+  EXAMPLE_SOA_OUT = '@ IN SOA ns0.lividpenguin.com. luke.lividpenguin.com. ( 2014021601 3h 15m 4w 30m )'
+
+  def test_build
+    rr = DNS::Zone::RR::SOA.new
+    rr.nameserver = 'ns0.lividpenguin.com.'
+    rr.email = 'luke.lividpenguin.com.'
+    rr.serial = 2014_02_16_01
+    rr.refresh_ttl = '3h'
+    rr.retry_ttl = '15m'
+    rr.expiry_ttl = '4w'
+    rr.minimum_ttl = '30m'
+    assert_equal EXAMPLE_SOA_OUT, rr.to_s
+  end
+
+  def test_load
+    rr = DNS::Zone::RR::SOA.new.load(EXAMPLE_SOA_IN)
+    assert_equal '@', rr.label
+    assert_equal 'SOA', rr.type
+
+    assert_equal 'ns0.lividpenguin.com.', rr.nameserver
+    assert_equal 'luke.lividpenguin.com.', rr.email
+    assert_equal 2014_02_16_01, rr.serial
+    assert_equal '3h', rr.refresh_ttl
+    assert_equal '15m', rr.retry_ttl
+    assert_equal '4w', rr.expiry_ttl
+    assert_equal '30m', rr.minimum_ttl
+  end
+
+end

data/test/rr/srv_test.rb

@@ -0,0 +1,14 @@
+require 'dns/zone/test_case'
+
+class RR_SRV_Test < DNS::Zone::TestCase
+
+  def test_build_rr__srv
+    rr = DNS::Zone::RR::SRV.new
+    rr.priority = 5
+    rr.weight = 0
+    rr.port = 5269
+    rr.target = 'xmpp-server.l.google.com.'
+    assert_equal '@ IN SRV 5 0 5269 xmpp-server.l.google.com.', rr.to_s
+  end
+
+end

data/test/rr/txt_test.rb

@@ -0,0 +1,44 @@
+require 'dns/zone/test_case'
+
+class RR_TXT_Test < DNS::Zone::TestCase
+
+  def test_build_rr__txt
+    rr = DNS::Zone::RR::TXT.new
+
+    # ensure we can set text parameter
+    rr.text = 'test text'
+    assert_equal '@ IN TXT "test text"', rr.to_s
+
+    # with a label set
+    rr.label = 'labelname'
+    assert_equal 'labelname IN TXT "test text"', rr.to_s
+
+    # with a ttl
+    rr.ttl = '2w'
+    assert_equal 'labelname 2w IN TXT "test text"', rr.to_s
+  end
+
+  def test_load
+    rr = DNS::Zone::RR::TXT.new.load('txtrecord IN TXT "test text"')
+    assert_equal 'txtrecord', rr.label
+    assert_equal 'IN', rr.klass
+    assert_equal 'TXT', rr.type
+    assert_equal 'test text', rr.text
+  end
+
+  def test_load_multiple_quoted_strings
+    rr = DNS::Zone::RR::TXT.new.load('txtrecord IN TXT "part1 yo" " part2 yo"')
+    assert_equal 'part1 yo part2 yo', rr.text
+  end
+
+  def test_load_string_with_quotes
+    rr = DNS::Zone::RR::TXT.new.load('txtrecord IN TXT "we have \"double\" quotes"')
+    assert_equal %q{we have \"double\" quotes}, rr.text
+  end
+
+  def test_load_multiple_strings_with_quotes
+    rr = DNS::Zone::RR::TXT.new.load('txtrecord IN TXT "part1 " "we have \"double\" quotes" " part3"')
+    assert_equal %q{part1 we have \"double\" quotes part3}, rr.text
+  end
+
+end

data/test/rr_test.rb

@@ -0,0 +1,42 @@
+require 'dns/zone/test_case'
+
+class RRTest < DNS::Zone::TestCase
+
+  def test_load_ignores_comments
+    rr = DNS::Zone::RR.load('; comment lines are ignored')
+    assert_nil rr, 'should be nil when its a comment line'
+  end
+
+  def test_load_ignores_unparsable_input
+    rr = DNS::Zone::RR.load('invalid input should not be parsed')
+    assert_nil rr, 'should be nil when input cant be parsed at all'
+  end
+
+  def test_load_a_rr
+    rr = DNS::Zone::RR.load('www IN A 10.2.3.1')
+    assert_instance_of DNS::Zone::RR::A, rr, 'should be instance of A RR'
+    assert_equal 'www', rr.label
+    assert_equal 'A', rr.type
+    assert_equal '10.2.3.1', rr.address
+  end
+
+  def test_load_txt_rr
+    rr = DNS::Zone::RR.load('mytxt IN TXT "test text"')
+    assert_instance_of DNS::Zone::RR::TXT, rr, 'should be instance of TXT RR'
+    assert_equal 'mytxt', rr.label
+    assert_equal 'TXT', rr.type
+    assert_equal 'test text', rr.text
+  end
+
+  def test_load_a_rr_with_options_hash
+    rr = DNS::Zone::RR.load(' IN A 10.2.3.1', { last_label: 'www' })
+    assert_equal 'www', rr.label
+
+    rr = DNS::Zone::RR.load('blog IN A 10.2.3.1', { last_label: 'www' })
+    assert_equal 'blog', rr.label
+
+    rr = DNS::Zone::RR.load('@ IN A 10.2.3.1', { last_label: 'mail' })
+    assert_equal '@', rr.label
+  end
+
+end

data/test/version_test.rb

@@ -0,0 +1,9 @@
+require 'dns/zone/test_case'
+
+class VersionTest < DNS::Zone::TestCase
+
+  def test_should_have_a_version
+    assert DNS::Zone::Version, 'unable to access the version number'
+  end
+
+end

data/test/zone_test.rb

@@ -0,0 +1,111 @@
+require 'dns/zone/test_case'
+
+class ZoneTest < DNS::Zone::TestCase
+
+  ZONE_EXAMPLE_SIMPLE =<<-EOL
+$ORIGIN lividpenguin.com.
+$TTL 3d
+@    IN  SOA  ns0.lividpenguin.com. luke.lividpenguin.com. (
+                                                             2013101406 ; zone serial number
+                                                             12h        ; refresh ttl
+                                                             15m        ; retry ttl
+                                                             3w         ; expiry ttl
+                                                             3h         ; minimum ttl
+                                                           )
+
+; a more difficult ; comment ( its trying to break things!
+
+@    IN  NS   ns0.lividpenguin.com.
+@    IN  NS   ns1.lividpenguin.com.
+@    IN  NS   ns2.lividpenguin.com.
+
+@    IN  A    77.75.105.197
+@    IN  AAAA 2a01:348::6:4d4b:69c5:0:1
+
+foo  IN  TXT "part1""part2"
+bar  IN  TXT ("part1 "
+              "part2 "
+              "part3")
+EOL
+
+  def test_create_new_instance
+    assert DNS::Zone.new
+  end
+
+  def test_load_simple_zone
+    zone = DNS::Zone.load(ZONE_EXAMPLE_SIMPLE)
+    assert_equal '3d', zone.ttl, 'check ttl matches example input'
+    assert_equal 'lividpenguin.com.', zone.origin, 'check origin matches example input'
+    assert_equal 8, zone.records.length, 'we should have 8 records (including SOA)'
+
+    p ''
+    zone.records.each do |rec|
+      p rec
+    end
+  end
+
+  def test_extract_entry_from_one_line
+    entries = DNS::Zone.extract_entries(%Q{maiow IN TXT "purr"})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT "purr"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_should_ignore_comments
+    entries = DNS::Zone.extract_entries(%Q{maiow IN TXT "purr"; this is a comment})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT "purr"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_should_ignore_empty_lines
+    entries = DNS::Zone.extract_entries(%Q{\n\nmaiow IN TXT "purr";\n\n})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT "purr"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_using_parentheses_but_not_crossing_line_boundary
+    entries = DNS::Zone.extract_entries(%Q{maiow  IN  TXT ("part1" "part2")})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow  IN  TXT  "part1" "part2"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_crossing_line_boundary
+    entries = DNS::Zone.extract_entries(%Q{maiow1  IN  TXT ("part1"\n "part2" )})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow1  IN  TXT  "part1" "part2"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_soa_crossing_line_boundary
+    entries = DNS::Zone.extract_entries(%Q{
+@ IN  SOA  ns0.lividpenguin.com. luke.lividpenguin.com. (
+ 2013101406 ; zone serial number
+ 12h ; refresh ttl
+ 15m ; retry ttl
+ 3w  ; expiry ttl
+ 3h  ; minimum ttl
+)})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+
+    expected_soa = '@ IN  SOA  ns0.lividpenguin.com. luke.lividpenguin.com.  2013101406  12h  15m  3w  3h'
+    assert_equal expected_soa, entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entries_with_parentheses_crossing_multiple_line_boundaries
+    entries = DNS::Zone.extract_entries(%Q{maiow1  IN  TXT (\n"part1"\n "part2"\n)})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow1  IN  TXT  "part1" "part2"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entries_with_legal_but_crazy_parentheses_used
+    entries = DNS::Zone.extract_entries(%Q{maiow IN TXT (\n(\n("part1")\n \n("part2" \n("part3"\n)\n)\n)\n)})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT  "part1" "part2" "part3"', entries[0], 'entry should match expected'
+  end
+
+  def test_extract_entry_with_parentheses_in_character_string
+    entries = DNS::Zone.extract_entries(%Q{maiow IN TXT ("purr((maiow)")})
+    assert_equal 1, entries.length, 'we should have 1 entry'
+    assert_equal 'maiow IN TXT "purr((maiow)"', entries[0], 'entry should match expected'
+  end
+
+
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: dns-zone
+version: !ruby/object:Gem::Version
+  version: 0.0.0.alpha
+platform: ruby
+authors:
+- Luke Antins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  A Ruby library for building and parsing DNS zone files for use with
+  Bind and PowerDNS (with Bind backend) DNS servers.
+email:
+- luke@lividpenguin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Guardfile
+- HISTORY.md
+- README.md
+- Rakefile
+- dns-zone.gemspec
+- lib/dns/zone.rb
+- lib/dns/zone/rr.rb
+- lib/dns/zone/rr/a.rb
+- lib/dns/zone/rr/aaaa.rb
+- lib/dns/zone/rr/cname.rb
+- lib/dns/zone/rr/mx.rb
+- lib/dns/zone/rr/ns.rb
+- lib/dns/zone/rr/record.rb
+- lib/dns/zone/rr/soa.rb
+- lib/dns/zone/rr/srv.rb
+- lib/dns/zone/rr/txt.rb
+- lib/dns/zone/test_case.rb
+- lib/dns/zone/version.rb
+- test/rr/a_test.rb
+- test/rr/aaaa_test.rb
+- test/rr/cname_test.rb
+- test/rr/mx_test.rb
+- test/rr/ns_test.rb
+- test/rr/record_test.rb
+- test/rr/soa_test.rb
+- test/rr/srv_test.rb
+- test/rr/txt_test.rb
+- test/rr_test.rb
+- test/version_test.rb
+- test/zone_test.rb
+homepage: https://github.com/lantins/dns-zone
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A Ruby library for building and parsing DNS zone files.
+test_files: []
+has_rdoc: