dnsomatic 0.2.2 → 0.4.0

data/bin/dnsomatic

@@ -34,15 +34,17 @@ begin
       obj.send( opts.force ? 'update!' : 'update')
     end
   end
-rescue => e
+rescue SystemExit => e
+  # we call this in a few places (mainly from option processing [-h, -V])
+  # a no-op for us.
+rescue Exception => e
   if e.kind_of?(DNSOMatic::Error)
-    msg = e
+    msg = e.message
   else
     msg = "Rescued an unhandled exception of type: #{e.class}\n"
+    msg += e.message + "\n"
   end
 
-  msg += "The exception contains the following message:\n"
-  msg += e.message
 
   if opts.debug
     msg += "Backtrace:\n"

data/lib/dnsomatic.rb

@@ -106,7 +106,7 @@ require 'open-uri'
 #   -h, --help                       Display this help text
 
 module DNSOMatic
-  VERSION = '0.2.2'
+  VERSION = '0.4.0'
   USERAGENT = "Ruby_DNS-o-Matic/#{VERSION}"
 
   # We provide our easily distinguishable exception class so that we can easily
@@ -127,7 +127,7 @@ module DNSOMatic
     rescue OpenURI::HTTPError, SocketError => e
       msg = "Error communicating with #{uri.host}\n"
       msg += "Message was: #{e.message}\n"
-      msg += "Full URL being requested: #{uri}"
+      msg += "Full URL being requested: #{uri}\n"
       raise(DNSOMatic::Error, msg)
     end
   end

data/lib/dnsomatic/config.rb

@@ -1,49 +1,37 @@
-require 'net/https'
+require 'resolv'
 
 module DNSOMatic
   # A class to handle 'parsing' the configuration files and setting defaults
   # as required.  Config files are actually YAML files, so the parsing is
   # offloaded for the most part.
   class Config
-    #in most cases, a user can simply set username and password in a defaults:
-    #stanza and fire the client.
-    @@defaults = { 'hostname' => 'all.dnsomatic.com',
-		   'wildcard' => 'NOCHG',
-		   'mx' => 'NOCHG',
-		   'backmx' => 'NOCHG',
-		   'offline' => 'NOCHG',
-		   'webipfetchurl' => 'http://myip.dnsomatic.com/' }
-
     # Create a new instance with the option of specifying an alternate config
     # file to read.  The default config file is either $HOME/.dnsomatic.cf (on
     # unix or if Windows specifies a $HOME environment variable) or
     # %APPDATA%/.dnsomatic.cf for most Windows environments.
     def initialize(conffile = nil)
       stdcf = File.join(ENV['HOME'] || ENV['APPDATA'], '.dnsomatic.cf')
-      if conffile
-	if File.exists?(conffile)
-	  @cf = conffile
-	else
-	  raise(DNSOMatic::ConfErr, "Invalid config file: #{conffile}")
-	end
-      elsif File.exists?(stdcf)
-	@cf = stdcf
-      else
-	#in this case, the values from the defaults: stanza in the default conf
-	#will provide all values required.
-	@cf = nil
-      end
+      @cf = conffile.nil? ? stdcf : conffile
+      raise(DNSOMatic::Error, "Invalid config file: #{conffile}") unless  File.exists?(@cf)
 
       @updaters = nil
       @config = {}
 
-      # the user config must supply values for these, either in a specific
-      # host updater stanza or by overriding the global default in defaults:
-      @req_conf = %w(username password)
-
-      msg = @cf.nil? ?  "Couldn't find a user config.  Using defaults only." : \
-	  "Using config file #{@cf}"
-      Logger::log(msg)
+      #in most cases, a user can simply set username and password in a defaults:
+      #stanza and fire the client.
+      @defaults = { 'hostname' => 'all.dnsomatic.com',
+		    'wildcard' => 'NOCHG',
+		    'mx' => 'NOCHG',
+		    'backmx' => 'NOCHG',
+		    'offline' => 'NOCHG',
+		    'webipfetchurl' => 'http://myip.dnsomatic.com/' }
+
+      @type_validators = { 'hostname' => 'host',
+			    'wildcard' => 'on_nochg',
+			    'mx' => 'host',
+			    'backmx' => 'yes_nochg',
+			    'offline' => 'yes_nochg',
+			    'webipfetchurl' => 'url' }
 
       load()
     end
@@ -86,37 +74,61 @@ module DNSOMatic
     end
 
     def load
-      return @@defaults if @cf.nil?
-
       conf = DNSOMatic::yaml_read(@cf)
-      raise DNSOMatic::ConfErr, "Invalid configuration format in #{@cf}" unless conf.kind_of?(Hash)
+      raise DNSOMatic::Error, "Invalid configuration format in #{@cf}" unless conf.kind_of?(Hash)
 
       if conf.has_key?('defaults')
 	#allow the user to override our built-in defaults
-	@@defaults.merge!(conf['defaults'])
+	@defaults.merge!(conf['defaults'])
 	#if they've provided only the defaults stanza, we'll use it to perform
-	#the update, otherwise remove it as it has been folded into @@defaults
+	#the update, otherwise remove it as it has been folded into @defaults
 	conf.delete('defaults') if conf.keys.size > 1
       end
 
-      conf.each_key do |token|
-	stanza = @@defaults.merge(conf[token])
-	@req_conf.each do |required|
-	  #still test for existence in case the defaults get munged.
-	  if !stanza.has_key?(required) or stanza[required].nil?
-	    msg = "Invalid configuration for Host Updater named '#{token}'\n"
-	    msg += "Please define the field: #{required}."
-	    raise DNSOMatic::ConfErr, msg
-	  end
-	end
+      conf.each_key do |name|
+	stanza = @defaults.merge(conf[name])
 
 	#just in case
 	stanza.each_pair do |k,v|
 	  stanza[k] = fmt(v)
 	end
 
+	validate(name, stanza)
+
 	#save our merged version in case we're just dump our config to stdout
-	@config[token] = stanza
+	@config[name] = stanza
+      end
+    end
+
+    def validate(name, stanza)
+      #first, ensure we have the _required_ fields in an update def stanza
+      %w(username password).each do |required|
+	#still test for existence in case the defaults get munged.
+	if !stanza.has_key?(required) or stanza[required].nil?
+	  msg = "Invalid configuration for Host Updater named '#{name}'\n"
+	  msg += "Please define the field: #{required}.\n"
+	  raise(DNSOMatic::Error, msg)
+	end
+      end
+
+      @type_validators.each do |field, validator|
+	self.send("validate_#{validator}", field, stanza[field])
+      end
+	
+      #the dnsomatic api spec indicates that mx/back mx can be either NOCHG
+      #or a hostname that must resolve to an IP.
+      %w(mx backmx).each do |mxtype|
+	mxval = stanza[mxtype]
+	next if mxval.eql?('NOCHG')
+
+	begin
+	  Resolv.getaddress(mxval)
+	rescue Resolv::ResolvError => e
+	  msg = "Invalid value for #{mxtype}.\n"
+	  msg += "It must be either NOCHG or a valid hostname.\n"
+	  msg += e.message + "\n"
+	  raise(DNSOMatic::Error, msg)
+	end
       end
     end
 
@@ -138,5 +150,39 @@ module DNSOMatic
 	val.to_s.gsub(/\s+/, '')
       end
     end
+
+    def validate_host(field, val)
+      return true if val.eql?('NOCHG')
+      return true if val.match(/[^\s]+\.[^\s]+/)  #no great, but workable
+      msg = "Invalid hostname defined for #{field}.\n"
+      msg += "You gave: #{val}\n"
+      raise(DNSOMatic::Error, msg)
+    end
+
+    def validate_yes_nochg(field, val)
+      valid = %w(YES NO NOCHG)
+      return true if valid.include?(val.upcase)
+      msg = "Invalid value for #{field}.\n"
+      msg += "It should be one of: #{valid.join(', ')}\n"
+      msg += "You gave: #{val}\n"
+      raise(DNSOMatic::Error, msg)
+    end
+
+    def validate_on_nochg(field, val)
+      valid = %w(ON OFF NOCHG)
+      return true if valid.include?(val.upcase)
+      msg = "Invalid value for #{field}.\n"
+      msg += "It should be one of: #{valid.join(', ')}\n"
+      msg += "You gave: #{val}\n"
+      raise(DNSOMatic::Error, msg)
+    end
+
+    def validate_url(field, val)
+      return true if val.match('http.//.*')
+      msg = "Invalid value for #{field}.\n"
+      msg += "It should be on http(s)-style URL.\n"
+      msg += "You gave: #{val}\n"
+      raise(DNSOMatic::Error, msg)
+    end
   end
 end

data/lib/dnsomatic/opts.rb

@@ -84,7 +84,7 @@ module DNSOMatic
       rescue OptionParser::ParseError => e
 	msg = "Extra/Unknown arguments used:\n"
 	msg += "\t#{e.message}\n"
-	msg += "Remaining args: #{args.join(', ')}" if args.size > 0
+	msg += "Remaining args: #{args.join(', ')}\n" if args.size > 0
 	raise(DNSOMatic::Error, msg)
       end
     end

data/tests/confs/1_stanza_no_defs_no_u_p.cf

@@ -0,0 +1,2 @@
+stanza1:
+  hostname: blah.example.com

data/tests/confs/3_good_stanzas.cf

@@ -0,0 +1,9 @@
+defaults:
+  username: myuser
+  password: mypass
+stanza1:
+  hostname: foo.bar.baz
+stanza2:
+  webipfetchurl: http://somesite.com/whatismyip.php
+stanza3:
+  hostname: baz.bar.foo

data/tests/confs/3_stanzas_no_def_no_u_p.cf

@@ -0,0 +1,6 @@
+stanza1:
+  hostname: foo.bar.baz
+stanza2:
+  webipfetchurl: http://somesite.com/whatismyip.php
+stanza3:
+  hostname: baz.bar.foo

data/tests/confs/defs_with_bad_mx_set.cf

@@ -0,0 +1,4 @@
+defaults:
+  username: blah
+  password: blah
+  mx: blah.example.com

data/tests/confs/defs_with_mx_set.cf

@@ -0,0 +1,4 @@
+defaults:
+  username: blah
+  password: blah
+  mx: example.com

data/tests/confs/defs_with_override_ipfetch.cf

@@ -0,0 +1,4 @@
+stanza1:
+  username: foo
+  password: bar
+  webipfetchurl: http://example.com

data/tests/confs/working_only_defs.cf

@@ -0,0 +1,3 @@
+defaults:
+  username: myuser
+  password: mypass

data/tests/test_config.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby -w
+$: << '../lib'
+
+require 'test/unit'
+
+require 'dnsomatic'
+
+class TestConfig < Test::Unit::TestCase
+  def setup
+    $cfd = File.join(Dir.pwd, 'confs')
+    $orig_home = ENV['HOME']
+  end
+
+  def test_no_exception_with_basic_default_conf
+    assert_nothing_raised { DNSOMatic::Config.new }
+  end
+
+  def test_exception_on_no_default_config_file
+    ENV['HOME'] = '/tmp'
+    assert_raises(DNSOMatic::Error) { DNSOMatic::Config.new }
+  end
+
+  def test_non_existent_conf_raises_exception
+    conf = File.join($cfd, 'bad_conf_file_name.cf')
+    assert_raises(DNSOMatic::Error) { DNSOMatic::Config.new(conf) }
+  end
+
+  def test_empty_conf_raises_exception
+    conf = File.join($cfd, 'empty_conf.cf')
+    assert_raises(DNSOMatic::Error) { DNSOMatic::Config.new(conf) }
+  end
+
+  def test_no_exception_raised_for_basic_conf
+    conf = File.join($cfd, 'working_only_defs.cf')
+    assert_nothing_raised { DNSOMatic::Config.new(conf) }
+  end
+
+  def test_no_exception_raised_for_conf_with_multi_stanzas
+    conf = File.join($cfd, '3_good_stanzas.cf')
+    assert_nothing_raised { DNSOMatic::Config.new(conf) }
+  end
+
+  def test_1_def_and_3_alternates_gives_3_updaters
+    conf = File.join($cfd, '3_good_stanzas.cf')
+    c = DNSOMatic::Config.new(conf)
+    assert_equal(3, c.updaters.length)
+  end
+
+  def test_3_stanzas_no_def_no_u_p_raises
+    conf = File.join($cfd, '3_stanzas_no_def_no_u_p.cf')
+    assert_raises(DNSOMatic::Error) { DNSOMatic::Config.new(conf) }
+  end
+
+  def test_no_defs_no_u_p_raises
+    conf = File.join($cfd, '1_stanza_no_defs_no_u_p.cf')
+    assert_raises(DNSOMatic::Error) { DNSOMatic::Config.new(conf) }
+  end
+
+  def test_override_webipfetchurl_works
+    conf = File.join($cfd, 'defs_with_override_ipfetch.cf')
+    c = DNSOMatic::Config.new(conf)
+    #so we know our match below isn't hitting on another stanza
+    assert_equal(1, c.updaters.length)
+    assert_match(/.*webipfetchurl: http:\/\/example.com.*/m, c.merged_config)
+  end
+
+  def test_mx_rejects_improper_values
+    #either NOCHG or a name that resolves to an IP
+    conf = File.join($cfd, 'defs_with_mx_set.cf')
+    assert_nothing_raised { DNSOMatic::Config.new(conf) }
+    conf = File.join($cfd, 'defs_with_bad_mx_set.cf')
+    assert_raises(DNSOMatic::Error) { DNSOMatic::Config.new(conf) }
+  end
+
+  def teardown
+    ENV['HOME'] = $orig_home
+  end
+end

data/tests/test_logger.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby -w
+$: << '../lib'
+
+require 'test/unit'
+require 'stringio'
+
+require 'dnsomatic'
+
+class TestLogger < Test::Unit::TestCase
+  def setup
+    $opts = DNSOMatic::Opts.instance
+    $stdout = StringIO.new('')
+    $opts.parse([])
+  end
+
+  def test_nothing_logged_if_not_verbose
+    DNSOMatic::Logger.log('nothing logged')
+    assert_equal('', $stdout.string)
+  end
+
+  def test_log_matches_when_verbose
+    $opts.parse(%w(-v))	#enable verbose so that logs are generated
+    DNSOMatic::Logger.log('logged')
+    assert_equal("logged\n", $stdout.string)
+  end
+
+  def test_nothing_alerted_without_verb_or_alert
+    DNSOMatic::Logger.alert('nothing logged')
+    assert_equal('', $stdout.string)
+  end
+
+  def test_alert_with_alert_opt
+    $opts.parse(%w(-a))
+    DNSOMatic::Logger.alert('something logged')
+    assert_equal("something logged\n", $stdout.string)
+  end
+
+  def test_alert_with_verbose_opt
+    $opts.parse(%w(-v))
+    DNSOMatic::Logger.alert('something logged')
+    assert_equal("something logged\n", $stdout.string)
+  end
+
+  def test_alert_with_verbose_and_alert_opts
+    $opts.parse(%w(-v -a))
+    DNSOMatic::Logger.alert('something logged')
+    assert_equal("something logged\n", $stdout.string)
+  end
+
+  def test_warn_without_verbose_or_alert
+    DNSOMatic::Logger.warn('something logged')
+    assert_equal("something logged\n", $stdout.string)
+  end
+
+  def test_warn_with_verbose
+    $opts.parse(%w(-v))
+    DNSOMatic::Logger.warn('something logged')
+    assert_equal("something logged\n", $stdout.string)
+  end
+
+  def test_warn_with_alert
+    $opts.parse(%w(-a))
+    DNSOMatic::Logger.warn('something logged')
+    assert_equal("something logged\n", $stdout.string)
+  end
+
+  def test_warn_with_alert_and_verbose
+    $opts.parse(%w(-a -v))
+    DNSOMatic::Logger.warn('something logged')
+    assert_equal("something logged\n", $stdout.string)
+  end
+
+  def teardown
+    $stdout.truncate(0)
+  end
+end

data/tests/test_opts.rb

@@ -9,6 +9,24 @@ require 'dnsomatic'
 class TestOpts < Test::Unit::TestCase
   def setup
     $opts = DNSOMatic::Opts.instance
+    $stdout = StringIO.new('')
+    $opts.parse([])
+  end
+
+  def test_version_request_exits
+    assert_raises(SystemExit) { $opts.parse(%w(-V)) }
+  end
+
+  def test_version_number_sane
+    begin
+      $opts.parse(%w(-V))
+    rescue SystemExit
+      assert_equal("#{DNSOMatic::VERSION}\n", $stdout.string)
+    end
+  end
+
+  def test_help_exits
+    assert_raises(SystemExit) { $opts.parse(%w(-h)) }
   end
 
   def test_set_verbose
@@ -74,4 +92,8 @@ class TestOpts < Test::Unit::TestCase
   def test_extra_args_raise_exception
     assert_raise(DNSOMatic::Error) { $opts.parse(%w(somearg)) }
   end
+
+  def teardown
+    $stdout.truncate(0)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dnsomatic
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors: 
 - Ben Walton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-27 00:00:00 -04:00
+date: 2008-09-01 00:00:00 -04:00
 default_executable: dnsomatic
 dependencies: []
 
@@ -32,8 +32,19 @@ files:
 - lib/dnsomatic.rb
 - tests/test_ipstatus.rb
 - tests/test_opts.rb
+- tests/test_logger.rb
 - tests/test_updater.rb
 - tests/all_tests.rb
+- tests/confs
+- tests/confs/1_stanza_no_defs_no_u_p.cf
+- tests/confs/working_only_defs.cf
+- tests/confs/defs_with_mx_set.cf
+- tests/confs/3_good_stanzas.cf
+- tests/confs/empty_conf.cf
+- tests/confs/defs_with_override_ipfetch.cf
+- tests/confs/defs_with_bad_mx_set.cf
+- tests/confs/3_stanzas_no_def_no_u_p.cf
+- tests/test_config.rb
 - tests/test_iplookup.rb
 has_rdoc: true
 homepage: http://rubyforge.org/projects/dnsomatic