redzone 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGIzOTRjZmY0MmE1YmNmYTA0YjFlODAxYzY5NzgxNDg0YmI5ODc3MA==
+    ZmI1Mjc3YWJmMjYzYTg5YTFhZDlkOGZiMzhhZTUwODFhZDdiNTJjMQ==
   data.tar.gz: !binary |-
-    YWY5OGI0YzMyOWNjMGNjOWY4ZThkOGJkMmJjMzBmNzYzYzRjNWQyMQ==
+    ODU2Mjk3NDc2YWM5MGFiNjExOTg1Nzc4Mzg1OWIxMWNlZGI1M2ZkYw==
 SHA512:
   metadata.gz: !binary |-
-    NTI0Y2ZhZjhmMTg3Y2VkODc3MDBhMDY0N2VlZmRjODhiMWJkODgxOTU3MmZk
-    NzBkZTYwNzk0ODVlYzBlNzYxNGViN2EzZjQwOTlhZTI2NTgzNmY2MzczM2My
-    ZDg4NjFmYTM5NzE0YmQ4MDRiZjI5NzdjOWM1ZWM4N2E1YTgwNWE=
+    YTRhNzRmYjZkYzZhYWRiNjI2MWYzZDMwNWM0OGIzYTRlOTE1ZjYwMDU4YWNm
+    ZWMyNWFhMTdhZDBjODcwOWVlNDU3YWI5ODRhNGEwYjc0ODA5M2QyNmIxYWRh
+    NGNiOTNmNTk3MzE1YTg3ZWQ0N2Q2NTFlYjUwODQ3ZGQ1ZDhlMjg=
   data.tar.gz: !binary |-
-    MTYzMTc3YjRkNjA2OTA3YjVhY2Q4ZDRjOTk2ZDkyYzJmZGFhNzY2ZTkzY2Qx
-    NTVjMzk5NTU5ODAxODQ1N2Y3ZjVmZTg0N2VlMGI5OWI2MmUzODM3NmVlNzcy
-    MDQzOGY4MTAzZDRmZTE0YmU1NGNlODYzNjlmYTViOTE2ZTYxZDk=
+    ZTk0ODhkOTJkMTFlYTUwNGNjMzA4N2IyYzQ1ZmFlMGFlZTdmY2JiZWE0NTY3
+    NGQ1Mjc3MzUyMjdiOWQ4ZDQ2NzEzNzEyNDc5YzdjZWNmZDRiMjE4ODgzMmY2
+    NDFhM2M4ZThlOTQ4MjY4ODVlMjYyYmNlNTJkMzBkODk5MDgzYmE=

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+bundler_args: --without development
+script: "SPEC_OPTS='--format=d' rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+before_install:
+  - gem update --system 2.1.11 #  todo: workaround for https://github.com/rubygems/rubygems/pull/763
+notifications:
+  email: false

data/LICENSE.md

@@ -1,6 +1,3 @@
-# @markup markdown
-# @title MIT License
-
 Copyright (C) 2014 Justen Walker
 
 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:

data/README.md

@@ -1,12 +1,17 @@
-# RedZone - Generate BIND zone files from simple YAML syntax
+RedZone 
+=======
+
+[![Gem Version](https://badge.fury.io/rb/redzone.png)](http://badge.fury.io/rb/redzone)
+[![Build Status](https://travis-ci.org/justenwalker/redzone.png?branch=master)](https://travis-ci.org/justenwalker/redzone)
+
+Generate BIND zone files from simple yaml configuration.
 
 Introduction
 ------------
 
-RedZone is a command-line utility for generating BIND DNS zone files from a YAML file. The tools follows the
-UNIX philosophy and therefore does not attempt to do anything besides this.
+RedZone is a command-line utility for generating BIND DNS zone files from a YAML file.
 
-RedZone was inspired by Daniel P. Berrange's [NoZone](http://search.cpan.org/~danberr/NoZone-1.0/lib/NoZone.pm) i
+RedZone was inspired by Daniel P. Berrange's [NoZone](http://search.cpan.org/~danberr/NoZone-1.0/lib/NoZone.pm)
 script which does something very similar in Perl.
 The notable differences are:
  - Added support for reverse-dns generation
@@ -17,19 +22,22 @@ The notable differences are:
 Disclaimer
 ----------
 
-This gem was just released (pre 1.0) and probably doesn't have everything (or anything) you want yet.
+This gem was just released (pre 1.0) and is not ready for production use yet.
 
 During pre 1.0, things may change that break backwards compatibility between releases. Most likely these breaking
 changes would be related to the YAML file syntax.
 
-### Current TODO List
-
-- More test coverage for existing features
+To Do
+-----
+See the [Issue Tracker](https://github.com/justenwalker/redzone/issues)
 
 Installation
 ------------
 
-TODO: Publish to RubyGems.org
+```
+$ gem install redzone
+```
+### gem install redzone
 
 Usage
 -----
@@ -47,17 +55,21 @@ Options:
 ### Generating zone databases
 
 - Create a zones.yml file (See [zones.yml.example]) in `/etc/redzone`
-- Execute `redzone generate /var/named`
-- Each zone and reverse record database should be present in /var/named
+- Execute `redzone generate /var/named/data`
+- Each zone and reverse record database should be present in `/var/named`
 
 For example, if your zone.yml file is like the zones.yml.example file
 then the resulting db files are:
-- `0.0.0.0.0.0.0.0.0.0.c.f.ip6.arpa.db`
-- `1.168.192.in-addr.arpa.db`
-- `32.12.in-addr.arpa.db`
-- `9.8.7.6.4.3.2.1.1.0.0.2.ip6.arpa.db`
-- `qa.redzone.com.db`
-- `redzone.com.db`
+
+```
+$ ls -1 /var/named/data
+0.0.0.0.0.0.0.0.0.0.c.f.ip6.arpa.db
+1.168.192.in-addr.arpa.db
+32.12.in-addr.arpa.db
+9.8.7.6.4.3.2.1.1.0.0.2.ip6.arpa.db
+qa.redzone.com.db
+redzone.com.db
+```
 
 How to Contribute
 -----------------
@@ -79,6 +91,6 @@ Please include a reproducible test case.
 License
 -------
 
-Copyright (c) 2013 Justen Walker.
+Copyright (c) 2014 Justen Walker.
 
-Released under the terms of the MIT License. For further information, please see the file [LICENSE.md].
+Released under the terms of the MIT License. For further information, please see the file `LICENSE.md`.

data/Rakefile

@@ -1,7 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require "yard"
 
+# Optionally require yard and 
+# construct document tasks
+begin
+require "yard"
 yard_files = ['lib/**/*.rb','-','LICENSE.md']
 yard_opts  = [ 
     '--markup', 'markdown',
@@ -10,23 +13,25 @@ yard_opts  = [
     '--no-private',
     '--exclude', 'lib/*/cli.rb'
 ]
-
 YARD::Rake::YardocTask.new do |t|
   t.files   = yard_files
   t.options = yard_opts
 end
 task :yard_server => [:yard] do
-  system "yard server --reload"
+  system 'yard server --reload'
 end
+rescue LoadError
+end
+
 begin
   require 'ci/reporter/rake/rspec'
 rescue LoadError
 end
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = "spec/unit/**/*_spec.rb"
+  t.pattern = 'spec/unit/**/*_spec.rb'
 end
 
 task :default do
   sh %{rake -T}
-end
+end

data/lib/redzone/soa.rb

@@ -17,6 +17,10 @@ module RedZone
   #
   class SOA
     # Returns a new instance of a zone SOA record
+    #
+    # See [SOA reference](http://www.zytrax.com/books/dns/ch8/soa.html) 
+    # for explaination of the fields.
+    #
     # @param [Hash] opts
     # @option opts [String] :domain     Zone (domain) name
     # @option opts [String] :ns         Primary name server
@@ -24,15 +28,17 @@ module RedZone
     # @option opts [String] :refresh    Time between refreshes from slave servers
     # @option opts [String] :retry      Time between retrying failed zone transfers
     # @option opts [String] :expire     The maximum time that a secondary server will keep trying to complete a zone transfer.
+    # @option opts [String] :negative   The maximum negative caching time.
     # @option opts [String] :ttl        The minimum time-to-live that applies to all resource records in the zone file
     def initialize(opts)
       @domain     = opts[:domain]
       @ns         = opts[:ns]
-      @hostmaster = escape(opts[:hostmaster]   || "hostmaster.#{@domain}") 
-      @ttl        = Lifetime.new(opts[:ttl]     || '1H')
-      @refresh    = Lifetime.new(opts[:refresh] || '1H')
-      @retry      = Lifetime.new(opts[:retry]   || '10M')
-      @expire     = Lifetime.new(opts[:expire]  || '1D')
+      @hostmaster = escape(opts[:hostmaster]     || "hostmaster.#{@domain}") 
+      @ttl        = Lifetime.new(opts[:ttl]      || '1H')
+      @refresh    = Lifetime.new(opts[:refresh]  || '1H')
+      @retry      = Lifetime.new(opts[:retry]    || '10M')
+      @expire     = Lifetime.new(opts[:expire]   || '1D')
+      @negative   = Lifetime.new(opts[:negative] || '1H')
     end
     # Returns the SOA record with the serial set to the current unix timestamp
     # @return [String] SOA Record
@@ -52,7 +58,7 @@ module RedZone
       io << "               %-10s ; ref = refresh = %s\n"  % [@refresh.seconds,@refresh] 
       io << "               %-10s ; rt  = retry   = %s\n"  % [@retry.seconds,@retry]
       io << "               %-10s ; ex  = expiry  = %s\n"  % [@expire.seconds,@expire]
-      io << "               %-10s ; ttl = %s\n"  % [@ttl.seconds,@ttl]
+      io << "               %-10s ; nx  = nxdomain ttl = %s\n"  % [@negative.seconds,@negative]
       io << ")\n\n"
       io.string
     end

data/lib/redzone/version.rb

@@ -2,5 +2,5 @@
 #
 module RedZone
   # Current version of RedZone
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/redzone/zone.rb

@@ -155,9 +155,11 @@ module RedZone
 
     private
     def sorted_each(hash,&block)
-      keys = hash.keys.sort
-      keys.each do |key|
-        block.call(key,hash[key])
+      unless hash.nil?
+        keys = hash.keys.sort
+        keys.each do |key|
+          block.call(key,hash[key])
+        end
       end
     end
     def symbolize(hash) 
@@ -268,7 +270,7 @@ module RedZone
     end
     def generate_records
       @records = []
-      if @config.has_key?('records')
+      if @config.has_key?('records') and not @config['records'].nil?
         @config['records'].each do |record|
           @records << Record.new(symbolize(record))
         end

data/spec/unit/arpa_spec.rb

@@ -19,14 +19,11 @@ describe RedZone::Arpa do
     subject { arpa_ipv4 }
     its(:name) { should == '32.12.in-addr.arpa'}
     its(:network) { should == IPAddr.new('12.32.0.0/16') }
-    its ("to_s") { should eq("") }
-
   end
   context "ipv6 network" do
     subject { arpa_ipv6 }
     its (:name)    { should == '9.8.7.6.4.3.2.1.1.0.0.2.ip6.arpa' }
     its (:network) { should == IPAddr.new('2001:1234:6789::/48') }
-    it { subject.to_s.should eq("") }
   end
   it 'should require name option' do
     expect { described_class.new({:network => '12.32.0.0/16', :soa => 'soa'})}.to raise_error(ArgumentError,':name is required')

data/spec/unit/zone_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RedZone::Zone do
+  it "should skip empty mailservers"
+  it "should skip empty nameservers"
+  it "should skip empty aliases"
+  it "should skip empty cnames"
+  it "should skip empty default"
+  it "should skip empty wildcard"
+  it "should skip empty records"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redzone
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justen Walker
@@ -65,6 +65,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.md
 - README.md
@@ -85,11 +86,11 @@ files:
 - lib/redzone/zone_config.rb
 - lib/redzone/zonefile_writer.rb
 - redzone.gemspec
-- redzone.rb
 - spec/spec_helper.rb
 - spec/unit/arpa_spec.rb
 - spec/unit/record_spec.rb
-- zones.yml
+- spec/unit/zone_spec.rb
+- zones.yml.example
 homepage: https://github.com/justenwalker/redzone
 licenses:
 - MIT
@@ -118,4 +119,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/arpa_spec.rb
 - spec/unit/record_spec.rb
+- spec/unit/zone_spec.rb
 has_rdoc: 

data/redzone.rb

@@ -1,279 +0,0 @@
-#! /usr/bin/env ruby
-
-require 'yaml'
-require 'tsort'
-
-class String
-  def unindent 
-    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
-  end
-end
-module RedZone
-  class ZoneConfig
-    include TSort
-    def initialize(zonefile)
-      @cfg = YAML.load_file(zonefile)
-      @zones = Hash.new {|h,k| h[k] = []}
-      @machines = []
-      @ips = []
-      @cfg['zones'].each do |k,v|
-        add(Zone.new(k,v))
-      end
-    end
-    def add(zone)
-      @zones[zone.name] = zone
-    end
-    def tsort_each_node(&block)
-      @zones.each_key(&block)
-    end
-    def tsort_each_child(node, &block)
-      @zones[node].dependencies.each(&block) if @zones.has_key?(node)
-    end
-    def domains
-      d = []
-      @zones.each do |k,v|
-        d << v.domains
-      end
-      d.flatten
-    end
-    def setup!
-      self.tsort.each do |z|
-        zone = @zones[z]
-        zone.dependencies.each do |dep|
-          zone.inherit!(@zones[dep])
-        end
-      end
-    end
-    def generate_domain(domain) 
-      io = StringIO.new
-      @zones.each do |k,v|
-        if v.domains.include?(domain)
-          io << v.generate_zonefile(domain)
-        end
-      end
-      io.string
-    end
-  end
-  class Zone
-    attr_reader :name,:dependencies,:config
-    def inherit!(zone)
-      unless @inherited.include?(zone.name)
-        @config = zone.config.merge(@config)
-        @inherited << zone.name
-      end
-    end
-    def initialize(name,config)
-      @inherited = []
-      @name   = name
-      @config = config
-      @dependencies = []
-      if @config.has_key?('inherits')
-        @dependencies << @config['inherits']
-        @dependencies = @dependencies.flatten
-      end
-    end
-    def domains
-      @config['domains'] || []
-    end
-    def generate_conffile(domain,datafile,masters=[])
-      io = StringIO.new
-      write_conffile(io,domain,datafile,masters)
-      io.string
-    end
-    def write_conffile(io,domain,datafile,masters=[])
-      if not masters.empty?
-        masterlist = masters.join(" ; ")
-        io << <<-eos.unindent
-        zone "#{domain}" in {
-          type slave;
-          file "#{datafile}";
-          masters { #{masterlist} ; } ;
-        }
-        eos
-      else
-        io << <<-eos.unindent
-        zone "#{domain}" in {
-          type master;
-          file "#{datafile}";
-        }
-        eos
-      end
-    end
-    def generate_zonefile(domain)
-      io = StringIO.new
-      write_zonefile(io,domain)
-      io.string
-    end
-    def write_zonefile(io,domain)
-      io << generate_soa(domain)
-      io << generate_default
-      io << generate_dns
-      io << generate_mail
-      io << generate_machines
-      io << generate_names
-      io << generate_aliases
-      io << generate_wildcard
-    end
-    
-    private
-    def all_machines
-      machines = []
-      @config['machines'].each do |name,cfg|
-        machines << Machine.new(name,cfg)
-      end
-      machines
-    end
-    def get_machine(name)
-      Machine.new(name,@config['machines'][name])
-    end
-    def generate_soa(domain)
-      lifetimes  = @config['lifetimes']
-      ttl        = lifetimes['ttl']
-      hostmaster = @config['hostmaster']
-      now        = Time.now.to_i
-      refresh    = lifetimes['refresh']
-      re         = lifetimes['retry']
-      expire     = lifetimes['expire']
-      negative   = lifetimes['negative']
-      <<-eos.unindent
-      $ORIGIN  #{domain}.
-      $TTL     #{ttl} ; queries are cached for this long
-      @        IN    SOA    ns1    #{hostmaster} (
-                     #{now} ; Date $time
-                     #{refresh}  ; slave queries for refresh this often
-                     #{re} ; slave retries refresh this often after failure
-                     #{expire} ; slave expires after this long if not refreshed
-                     #{negative} ; errors are cached for this long
-      )
-      
-      eos
-    end
-    def generate_record(name,type,detail,value,comment=nil)
-      suffix = " ; #{comment}" unless comment.nil?
-      "%-20s IN    %-8s %-6s %s%s\n" % [name, type, detail, value, suffix || ""]
-    end
-    def generate_machine(name,machine)
-      comment = "Machine #{machine}" unless name == machine
-      if machine.is_a? String
-        machine = get_machine(machine)
-      end
-      io = StringIO.new
-      io << generate_record(name,"A","",machine.ipv4,comment) if machine.ipv4?
-      io << generate_record(name,"AAAA","",machine.ipv6,comment) if machine.ipv6?
-      io.string
-    end
-    def generate_default
-      io = StringIO.new
-      if @config['default']
-        io <<  "; Primary name records for unqualfied domain\n"
-        io << generate_machine("@",@config['default'])
-        io << "\n"
-      end
-      io.string
-    end
-    def generate_dns
-      io = StringIO.new
-      if @config.has_key?('dns')
-        io << ": DNS Server Records\n"
-        dns_keys = @config['dns'].keys.sort
-        dns_keys.each do |k|
-          io << generate_record("@","NS","",k)
-        end
-        dns_keys.each do |k|
-          machine = @config['dns'][k]
-          io << generate_machine(k,machine)
-        end
-        io << "\n"
-      end
-      io.string
-    end
-    def generate_mail
-      io = StringIO.new
-      if @config.has_key?('mail')
-        io << "; Email Servers\n"
-        mail_keys = @config['mail'].keys.sort
-        mail_keys.each do |k|
-          mail = @config['mail'][k]
-          priority = mail['priority']
-          io << generate_record("@","MX",priority,k)
-        end
-        mail_keys.each do |k|
-          mail = @config['mail'][k]
-          machine = mail['machine']
-          io << generate_machine(k,machine)
-        end
-        io << "\n"
-      end
-      io.string
-    end
-    def generate_machines 
-      io = StringIO.new
-      io << "; Primary Machine Names\n"
-      all_machines.each do |machine|
-        io << generate_machine(machine.name,machine)
-      end
-      io << "\n"
-      io.string
-    end
-    def generate_names
-      io = StringIO.new
-      if @config.has_key?('mail')
-        io << "; Extra Names\n"
-        name_keys = @config['names'].keys.sort
-        name_keys.each do |name|
-          machine = @config['names'][name]
-          io << generate_machine(name,machine)
-        end
-        io << "\n"
-      end
-      io.string
-    end
-    def generate_aliases
-      io = StringIO.new
-      if @config.has_key?('mail')
-        io << "; Extra Names\n"
-        cname_keys = @config['aliases'].keys.sort
-        cname_keys.each do |cname|
-          value = @config['aliases'][cname]
-          io << generate_record(cname,"CNAME","",value)
-        end
-        io << "\n"
-      end
-      io.string
-    end
-    def generate_wildcard
-      io = StringIO.new
-      if @config['wildcard']
-        io <<  "; Wildcard\n"
-        io << generate_machine("*",@config['wildcard'])
-        io << "\n"
-      end
-      io.string
-    end
-  end
-  class Machine
-    attr_reader :name,:ipv4,:ipv6
-    def initialize(name,config) 
-      @name = name
-      @ipv4 = config['ipv4']
-      @ipv6 = config['ipv6']
-    end
-    def ipv4?
-      not @ipv4.nil?
-    end
-    def ipv6?
-      not @ipv6.nil?
-    end
-    def to_s
-      @name
-    end
-  end
-end
-
-zonecfg = RedZone::ZoneConfig.new 'zones.yml'
-zonecfg.setup!
-zonecfg.domains.each do |d|
-  puts zonecfg.generate_domain(d)
-end
-
-