ultradns_updater 0.0.15

data/lib/ultradns_updater/preconditions.rb

@@ -0,0 +1,25 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module UltraDNSUpdater::Preconditions
+
+  def precondition
+    self
+  end
+  
+  def not_empty(arg, msg = "Argument may not empty")
+    raise msg if arg == nil || arg == ''
+  end
+end

data/lib/ultradns_updater/strategies/configured.rb

@@ -0,0 +1,29 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module UltraDNSUpdater::Strategies
+  class Configured < UpdateStrategy
+    def update(strategy_config)
+      hostname = strategy_config[:name]
+      precondition.not_empty(hostname)
+      
+      ip = iface_ip(strategy_config)
+      precondition.not_empty(ip)
+      
+      strategy_config[:logger].debug("Mapping #{hostname} to #{ip}")
+      
+      ultradns.create_or_update_a(hostname, ip)
+    end
+  end
+end

data/lib/ultradns_updater/strategies/ec2.rb

@@ -0,0 +1,38 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module UltraDNSUpdater::Strategies
+  class Ec2 < UpdateStrategy
+    
+    def update(strategy_config)
+      ec2 = Ec2UltraDNSUpdater::Ec2.new(strategy_config)
+      name_tag_value = ec2.get_name_tag
+
+      result = false
+      if ec2.get_instance_public_hostname != ''
+        result = ultradns.create_or_update_cname(name_tag_value, ec2.get_instance_public_hostname)
+      else
+        ip = iface_ip(strategy_config)
+        
+        unless ip.nil?
+          # try using an ip that reaches the internet
+          result = ultradns.create_or_update_a(name_tag_value, ip)
+        end
+      end
+      
+      result ? name_tag_value : nil
+    end
+    
+  end
+end

data/lib/ultradns_updater/strategies/hostname.rb

@@ -0,0 +1,24 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'socket'
+require 'ultradns_updater/strategies/configured'
+
+module UltraDNSUpdater::Strategies
+  class Hostname < Configured
+    def update(strategy_config)
+      super(strategy_config.merge({:name => Socket::gethostname()}))
+    end
+  end
+end

data/lib/ultradns_updater/strategies/update_strategy.rb

@@ -0,0 +1,39 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class UltraDNSUpdater::Strategies::UpdateStrategy
+  include UltraDNSUpdater::Preconditions
+  
+  def initialize(ultradns)
+    @ultradns = ultradns
+  end
+  
+  # update ultradns based on the configuration provided
+  # returns: the hostname applied or else nil
+  def update(strategy_config); end
+  
+  def ultradns
+    @ultradns
+  end
+  
+  def iface_ip(strategy_config)
+    ip = nil
+    if strategy_config[:iface] == 'auto'
+      ip = UltraDNSUpdater::IpInfo.local_ipv4
+    else
+      ip = UltraDNSUpdater::IpInfo.ipv4_for_iface(strategy_config[:iface])
+    end
+    ip
+  end
+end

data/lib/ultradns_updater/strategies.rb

@@ -0,0 +1,39 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#fwd decl
+module UltraDNSUpdater::Strategies; end
+
+require 'ultradns_updater/strategies/update_strategy'
+require 'ultradns_updater/strategies/ec2'
+require 'ultradns_updater/strategies/configured'
+require 'ultradns_updater/strategies/hostname'
+
+module UltraDNSUpdater::Strategies
+
+  def self.strategy(strategy_name)
+    case strategy_name
+    when :ec2
+      UltraDNSUpdater::Strategies::Ec2
+    when :hostname
+      UltraDNSUpdater::Strategies::Hostname
+    when :configured
+      UltraDNSUpdater::Strategies::Configured
+    else
+      raise "No strategy found for: #{strategy_name}"
+    end
+  end
+  
+end
+

data/lib/ultradns_updater/ultradns.rb

@@ -0,0 +1,218 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+class UltraDNSUpdater::UltraDNS
+  include UltraDNSUpdater::Preconditions
+  
+  ULTRADNS_WSDL_URL = "http://ultra-api.ultradns.com:8008/UltraDNS_WS/v01?wsdl"
+  DEFAULT_TTL = 60
+  
+  module TYPE
+    ANY = ALL = 0
+    A = 1
+    CNAME = 5
+    AAAA = 28
+  end
+  
+  def initialize(opts = {})
+    @logger = opts[:logger] || Logger.new(STDOUT)
+    
+    Savon.configure do |config|
+      config.logger = @logger
+      config.raise_errors = false
+    end
+    # also configure HTTPI
+    HTTPI.logger = @logger
+
+    @username = opts[:username]
+    @password = opts[:password]
+    @zone = fix_zone_name(opts[:zone] || '')
+    
+    precondition.not_empty(@username)
+    precondition.not_empty(@password)
+    precondition.not_empty(@zone)
+  end
+  
+  
+  def get_cname_guid(cname)
+    get_guid_by_label_and_type(cname, TYPE::CNAME)
+  end
+  
+  def create_or_update_cname(cname, to_hostname)
+    create_or_update_info1(TYPE::CNAME, cname, fix_zone_name(to_hostname))
+  end
+  
+  def get_a_guid(node_label)
+    get_guid_by_label_and_type(node_label, TYPE::A)
+  end
+  
+  def create_or_update_a(node_label, to_ip)
+    create_or_update_info1(TYPE::A, node_label, to_ip)
+  end
+    
+  def network_status?    
+    resp = client.request(:get_neustar_network_status) 
+    @logger.debug(resp)
+    log_error(resp)
+    resp.success?
+  end
+  
+  def delete_record_by_guid(guid)
+    resp = client.request(:delete_resource_record) {
+      soap.body do |xml|
+        xml.transactionID()
+        xml.guid(guid)
+      end
+    }
+    log_error(resp)
+    resp.success?
+  end
+  
+  
+  def get_records_by_label(label)
+    get_record_by_label_and_type(label, TYPE::ALL)
+  end
+  
+  def delete_record_by_label(label)
+    recs = get_records_by_label(label)
+    unless recs.nil?
+      guid = (recs[:resource_record][:@guid] rescue '') || ''
+      delete_record_by_guid(guid) unless guid == ''
+    end
+  end
+  
+  def delete_record_by_label_not_matching_type(label, type)
+    recs = get_records_by_label(label)
+    unless recs.nil?
+      guid = (recs[:resource_record][:@guid] rescue '') || ''
+      rec_type = (recs[:resource_record][:@type] rescue '') || ''
+      if guid != '' && rec_type != type
+        delete_record_by_guid(guid)
+      end
+    end
+  end
+  
+  #############
+  
+  def create_or_update_info1(type, label, to_value)
+    precondition.not_empty(label)
+    precondition.not_empty(to_value)
+    
+    zone = @zone
+    fixed_label = fix_zone_name(label)
+    
+    guid = get_guid_by_label_and_type(label, type) || ''
+
+    change_method = :create_resource_record
+    record_opts = {'Type' => type, 'DName' => fixed_label, 'TTL' => DEFAULT_TTL}
+
+    if guid != ''
+      @logger.info "Updating Record Mapping: #{fixed_label} => #{to_value}"
+      change_method = :update_resource_record # update it
+      record_opts['Guid'] = guid;
+    else
+      # make sure there isn't another record at this label of a different type
+      delete_record_by_label_not_matching_type(label, type)
+      @logger.info "Creating Record Mapping: #{fixed_label} => #{to_value}"
+      record_opts['ZoneName'] = zone;
+    end
+
+    begin
+      resp = client.request(change_method) {
+        ns = ''
+        soap.namespaces.each do |k, v|
+          ns = k.gsub(/xmlns:/,'') if v =~ /schema\.ultraservice\.neustar\.com/
+        end
+        soap.body do |xml|
+          xml.transactionID()
+          xml.resourceRecord(record_opts) {
+            xml.tag!("#{ns}:InfoValues", {"Info1Value" => to_value})
+          }
+        end
+      }
+    
+      log_error(resp)
+      resp.success?
+    rescue
+      false
+    end
+  end
+  
+  def get_guid_by_label_and_type(label, type)
+    zone = @zone
+    fixed_label = fix_zone_name(label)
+
+    guids_resp = client.request(:get_resource_record_guid_list) {
+      soap.body do |xml|
+        xml.resourceRecord({
+          "ZoneName" => zone, 'Type' => type, 'DName' => fixed_label
+        }) 
+      end
+    }
+
+    log_error(guids_resp)
+    
+    begin
+      guid = guids_resp[:get_resource_record_guid_list_response][:resource_record_guid_list][:guid]
+      @logger.debug("guid found: #{guid}")
+    rescue
+      @logger.debug("guid not found")
+    end
+    guid
+  end
+  
+  
+  def get_record_by_label_and_type(label, type)
+    zone = @zone
+    fixed_label = fix_zone_name(label)
+    
+    begin
+      records_resp = client.request('getResourceRecordsOfDNameByType'.snakecase.to_sym) {
+        soap.body do |xml|
+          xml.zoneName(zone)
+          xml.rrType(type)
+          xml.hostName(fixed_label)
+        end
+      }
+      log_error(records_resp)  
+    
+      records_resp.to_hash[:get_resource_records_of_d_name_by_type_response][:resource_record_list]
+    rescue
+      @logger.debug("Resource Record list is empty")
+    end
+  end
+  
+  
+  def client
+    soap_username = @username
+    soap_password = @password
+    
+    @client ||= Savon::Client.new do
+      wsdl.document = ULTRADNS_WSDL_URL
+      wsse.credentials soap_username, soap_password
+    end
+
+    @client
+  end
+  
+  def log_error(response)
+    @logger.error {response.to_xml} unless response.success?
+  end
+  
+  # ..Must end with a '.'  
+  def fix_zone_name(name)
+    (name != nil && name.strip != '' && name[-1] != '.') ? "#{name}." : name
+  end
+end

data/lib/ultradns_updater/version.rb

@@ -0,0 +1,17 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module UltraDNSUpdater
+  VERSION = "0.0.15"
+end

data/lib/ultradns_updater.rb

@@ -0,0 +1,32 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rubygems'
+
+require 'aws-sdk'
+require 'savon'
+require 'net/http'
+
+
+module UltraDNSUpdater
+
+end
+
+require "ultradns_updater/preconditions"
+require "ultradns_updater/strategies"
+require "ultradns_updater/cli"
+require "ultradns_updater/ec2"
+require "ultradns_updater/ip_info"
+require "ultradns_updater/ultradns"
+require "ultradns_updater/version"

data/spec/lib/configured_spec.rb

@@ -0,0 +1,38 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'fakeweb'
+require 'ostruct'
+
+
+describe UltraDNSUpdater::Strategies::Configured do
+  it "should update ultradns with the configure name and ip address" do
+    begin
+      name = 'test.biz'
+      ip_addr = '192.168.1.1'
+      
+      ultradns = Object.new
+      ultradns.should_receive(:create_or_update_a).with(name, ip_addr)
+      configured_strategy = UltraDNSUpdater::Strategies::Configured.new(ultradns)
+      configured_strategy.stub(:iface_ip).and_return(ip_addr)
+
+      configured_strategy.update({:iface => 'eth0', :name => name})
+
+    ensure
+
+    end
+  end
+end
+

data/spec/lib/ec2_spec.rb

@@ -0,0 +1,74 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'fakeweb'
+require 'ostruct'
+
+describe UltraDNSUpdater::Ec2 do
+  
+  it "should return the instance id" do
+    begin
+      fake_id = "i-ffffffff"
+      FakeWeb.register_uri(:get, UltraDNSUpdater::Ec2::EC2_META_DATA_URL + "/instance-id", :body => fake_id)
+      ec2 = UltraDNSUpdater::Ec2.new
+      ec2.get_instance_id.should == fake_id
+      ec2.get_instance_id.should == fake_id # check memoize
+    ensure
+      FakeWeb.clean_registry
+    end
+  end
+  
+  it "should return the public hostname" do
+    begin
+      fake_name = "ec2-111-111-111-111.compute-1.amazonaws.com"
+      FakeWeb.register_uri(:get, UltraDNSUpdater::Ec2::EC2_META_DATA_URL + "/public-hostname", :body => fake_name)
+      ec2 = UltraDNSUpdater::Ec2.new
+      ec2.get_instance_public_hostname.should == fake_name
+      ec2.get_instance_public_hostname.should == fake_name # check memoize
+    ensure
+      FakeWeb.clean_registry
+    end
+  end
+  
+  it "should return the dns tag name" do
+    begin
+      tag = OpenStruct.new
+      tag.name = "Testname" # it expects "Name", but we configure it explictly below as an example
+      tag.value = "tag.test.biz"
+      tag.resource = 'i-eeeeee'
+    
+      tags = Object.new
+      tags.stub(:filter).and_return([tag])
+    
+#      AWS::EC2.any_instance.stub(:tags).and_return(tags)
+      
+      
+      fake_name = "ec2-111-111-111-111.compute-1.amazonaws.com"
+      FakeWeb.register_uri(:get, UltraDNSUpdater::Ec2::EC2_META_DATA_URL + "/public-hostname", :body => fake_name)
+      FakeWeb.register_uri(:get, UltraDNSUpdater::Ec2::EC2_META_DATA_URL + "/instance-id", :body => tag.resource)
+    
+      ec2 = UltraDNSUpdater::Ec2.new({:access_key_id => 123, :secret_access_key => 'abc', :name_tag => 'Testname'})
+      ec2_stub = Object.new
+      ec2_stub.stub(:tags).and_return(tags)
+      ec2.stub(:ec2).and_return(ec2_stub)
+      ec2.get_name_tag.should == tag.value
+    
+    ensure
+      #AWS::EC2.any_instance.unstub(:tags)
+      FakeWeb.clean_registry
+    end
+  end
+end
+

data/spec/lib/hostname_spec.rb

@@ -0,0 +1,39 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'fakeweb'
+require 'ostruct'
+
+
+describe UltraDNSUpdater::Strategies::Hostname do
+  it "should return the hostname and ip address" do
+    begin
+      hostname = 'test.biz'
+      ip_addr = '192.168.1.1'
+      
+      ultradns = Object.new
+      ultradns.should_receive(:create_or_update_a).with(hostname, ip_addr)
+      hostname_strategy = UltraDNSUpdater::Strategies::Hostname.new(ultradns)
+      hostname_strategy.stub(:iface_ip).and_return(ip_addr)
+      Socket.stub(:gethostname).and_return(hostname)
+      Socket.gethostname.should == hostname
+      hostname_strategy.update({:iface => 'eth0'})
+
+    ensure
+      Socket.unstub(:gethostname)
+    end
+  end
+end
+

data/spec/lib/ip_info_spec.rb

@@ -0,0 +1,47 @@
+# Copyright 2012 NeuStar, Inc. All rights reserved.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'fakeweb'
+require 'yaml'
+
+describe UltraDNSUpdater::IpInfo do
+  
+  it "should get an ipv4 address" do
+    UltraDNSUpdater::IpInfo.local_ipv4().should_not == ''
+    UltraDNSUpdater::IpInfo.local_ipv4().should match(/\d+\.\d+\.\d+\.\d+/)
+  end
+  
+  it "should get an ipv4 address from ifconfig" do
+    
+    iface = "eth0"
+    if RUBY_PLATFORM =~ /darwin/
+      iface = "en1"
+    end 
+    
+    UltraDNSUpdater::IpInfo.ipv4_for_iface(iface).should_not == ''
+    UltraDNSUpdater::IpInfo.ipv4_for_iface(iface).should match(/\d+\.\d+\.\d+\.\d+/)
+  end
+  
+  it "should get an ipv6 address from ifconfig" do
+    
+    iface = "eth0" # probably have eth0 on linux..
+    if RUBY_PLATFORM =~ /darwin/
+      iface = "en1"
+    end 
+    
+    UltraDNSUpdater::IpInfo.ipv6_for_iface(iface).should_not == ''
+    UltraDNSUpdater::IpInfo.ipv6_for_iface(iface).should match(/.*:.*:.*:.*:.*:/)
+  end
+end