module Splicer

Splicer is a simple DNS data structure that allows you to publish changes to one or more dns services if desired.

This was constructed with the need for a way to transition from one dns host to another and allow for a failover solution should your primary provider go down.

Note: You will still have to manually point your name servers over to the new provider.

Available Providers¶ ↑

* splicer-dynect
* splicer-dns_made_easy
* splicer-no_op_provider

Example Configureation¶ ↑

Splicer.configure do |config|
  config.register(Splicer::Dynect::Config.new('company','user','password'))
  config.register(Splicer::DNSMadeEasy::Config.new('user','password'))
  config.logger = Logger.new(STDOUT)
end

@see Splicer::Provider for more information

@author Matthew A. Johnston <warmwaffles@gmail.com>

Constants

VERSION

Public Class Methods

configure() { |configuration| ... } click to toggle source

Configures the splicer library @return [void]

# File lib/splicer.rb, line 42
def self.configure &block
  @@configuration = Configuration.new
  yield(@@configuration)
  @@logger = @@configuration.logger
end

create_record_in_zone(record, zone) click to toggle source

@return [void]

# File lib/splicer.rb, line 72
def self.create_record_in_zone(record, zone)
  return false if domain_information_is_invalid(record, zone)
  providers.map do |provider|
    provider.create_record_in_zone(record, zone)
  end
end

create_zone(zone) click to toggle source

@return [void]

# File lib/splicer.rb, line 56
def self.create_zone(zone)
  return false if zone_is_invalid(zone)
  providers.map do |provider|
    provider.create_zone(zone)
  end
end

delete_record_in_zone(record, zone) click to toggle source

Deletes a record from a zone @return [void]

# File lib/splicer.rb, line 103
def self.delete_record_in_zone(record, zone)
  return false if domain_information_is_invalid(record, zone)
  providers.each do |provider|
    provider.delete_record_in_zone(record, zone)
  end
end

delete_zone(zone) click to toggle source

@return [void]

# File lib/splicer.rb, line 64
def self.delete_zone(zone)
  return false if zone_is_invalid(zone)
  providers.map do |provider|
    provider.delete_zone(zone)
  end
end

domain_information_is_invalid(record, zone) click to toggle source

# File lib/splicer.rb, line 116
def self.domain_information_is_invalid(record, zone)
  !record.is_a?(Splicer::Records::Record) || zone_is_invalid(zone)
end

get_records_for(zone) click to toggle source

Fetches list of associated records @returns an array of Record objects

# File lib/splicer.rb, line 96
def self.get_records_for(zone)
  return [] if zone_is_invalid(zone)
  providers.map { |provider| provider.get_records_for(zone) }.flatten
end

get_zone_for(zone) click to toggle source

Returns the zone data from domain host

# File lib/splicer.rb, line 88
def self.get_zone_for(zone)
  return false if zone_is_invalid(zone)
  zone_array = providers.map { |provider| provider.get_zone_for(zone) }
  zone_array.compact.first
end

logger() click to toggle source

The logger that splicer will use @return [Logger|Splicer::NullObject]

# File lib/splicer.rb, line 112
def self.logger
  @@logger || NullObject.new
end

providers() click to toggle source

Gets a list of providers @return [Array<Splicer::Providers::Base>]

# File lib/splicer.rb, line 50
def self.providers
  @@configuration ||= Configuration.new
  @@configuration.providers
end

update_record_in_zone(record, zone) click to toggle source

@return [void]

# File lib/splicer.rb, line 80
def self.update_record_in_zone(record, zone)
  return false if domain_information_is_invalid(record, zone)
  providers.map do |provider|
    provider.update_record_in_zone(record, zone)
  end
end

zone_is_invalid(zone) click to toggle source

# File lib/splicer.rb, line 120
def self.zone_is_invalid(zone)
  !zone.is_a?(Splicer::Zone)
end