splicer 1.0.1 → 1.1.0

data/lib/splicer/provider.rb

@@ -0,0 +1,66 @@
+module Splicer
+
+  # The base Provider class. All providers **MUST** inherit from this class.
+  # @author Matthew A. Johnston <warmwaffles@gmail.com>
+  class Provider
+
+    # Creates the zone in the DNS provider. If the zone exists, then nothing
+    # will happen.
+    #
+    # @param [Splicer::Zone] zone
+    def create_zone(zone)
+      false
+    end
+
+    # Updates a zone in the DNS provider. This will take any current changes
+    # that are made to the {Splicer::Zone} object and push them to the DNS. If
+    # the zone does not exist, then nothing will be done.
+    #
+    # @param [Splicer::Zone] zone
+    def update_zone(zone)
+      false
+    end
+
+    # Rewrites a zone in the DNS provider. If the zone does not exist, then it
+    # will be created. It will destroy all of the records in the DNS and rewrite
+    # all of them.
+    #
+    # @param [Splicer::Zone] zone
+    def rewrite_zone(zone)
+      false
+    end
+
+    # Will simply delete the zone from the DNS provider.
+    #
+    # @param [Splicer::Zone] zone
+    def delete_zone(zone)
+      false
+    end
+
+    # Deletes a single record from a zone in the DNS provider.
+    #
+    # @param [Splicer::Records::Record] record
+    # @param [Splicer::Zone] zone
+    def delete_record_in_zone(record, zone)
+      false
+    end
+
+    # Updates a single record in a zone.
+    #
+    # @param [Splicer::Records::Record] record
+    # @param [Splicer::Zone] zone
+    def update_record_in_zone(record, zone)
+      false
+    end
+
+    # Creates a single record for a zone in the DNS provider. If the record
+    # exists, then it will not do anything.
+    #
+    # @param [Splicer::Records::Record] record
+    # @param [Splicer::Zone] zone
+    def create_record_in_zone(record, zone)
+      false
+    end
+  end
+
+end

data/lib/splicer/records/record.rb

@@ -10,6 +10,12 @@ module Splicer
         @name = name
         @ttl = ttl
       end
+
+      # Check to see if the name is nil
+      # @return [Boolean]
+      def name?
+        !!@name
+      end
     end
 
   end

data/lib/splicer/version.rb

@@ -1,3 +1,3 @@
 module Splicer
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/splicer/zone.rb

@@ -13,15 +13,17 @@ module Splicer
     end
 
     # Adds a single record to this zone
-    # @return [void]
+    # @return [Boolean]
     def add_record(record)
+      return false unless record.is_a?(Splicer::Records::Record)
       @records.push(record)
+      true
     end
 
     # Adds a set of records to this zone
-    # @return [void]
+    # @return [Boolean]
     def add_records(records)
-      @records.concat(records)
+      records.each { |r| add_record(r) }
     end
 
     # @param [Symbol] method the method by which you want to publish

data/lib/splicer.rb

@@ -1,6 +1,7 @@
 require 'splicer/version'
 require 'splicer/errors'
 require 'splicer/configuration'
+require 'splicer/provider'
 require 'splicer/records'
 require 'splicer/zone'
 
@@ -23,8 +24,8 @@ require 'splicer/zone'
 # == Example Configureation
 #
 #   Splicer.configure do |config|
-#     config.register Splicer::Dynect::Config.new('company','user','password')
-#     config.register Splicer::DNSMadeEasy::Config.new('user','password')
+#     config.register(Splicer::Dynect::Config.new('company','user','password'))
+#     config.register(Splicer::DNSMadeEasy::Config.new('user','password'))
 #   end
 #
 # @see Splicer::Provider for more information
@@ -33,14 +34,77 @@ require 'splicer/zone'
 module Splicer
   @@configuration = nil
 
+  # Configures the splicer library
+  # @return [void]
   def self.configure &block
     @@configuration = Configuration.new
     yield(@@configuration)
   end
 
+  # Gets a list of providers
+  # @return [Array<Splicer::Providers::Base>]
   def self.providers
     @@configuration ||= Configuration.new
     @@configuration.providers
   end
 
+  # @return [void]
+  def self.create_zone(zone)
+    return false unless zone.is_a?(Splicer::Zone)
+    providers.each do |provider|
+      provider.create_zone(zone)
+    end
+  end
+
+  # @return [void]
+  def self.delete_zone(zone)
+    return false unless zone.is_a?(Splicer::Zone)
+    providers.each do |provider|
+      provider.delete_zone(zone)
+    end
+  end
+
+  # @return [void]
+  def self.rewrite_zone(zone)
+    return false unless zone.is_a?(Splicer::Zone)
+    providers.each do |provider|
+      provider.rewrite_zone(zone)
+    end
+  end
+
+  # @return [void]
+  def self.update_zone(zone)
+    return false unless zone.is_a?(Splicer::Zone)
+    providers.each do |provider|
+      provider.update_zone(provider)
+    end
+  end
+
+  # @return [void]
+  def self.create_record_in_zone(record, zone)
+    return false unless zone.is_a?(Splicer::Zone)
+    return false unless record.is_a?(Splicer::Records::Record)
+    providers.each do |provider|
+      provider.create_record_in_zone(record, zone)
+    end
+  end
+
+  # @return [void]
+  def self.update_record_in_zone(record, zone)
+    return false unless zone.is_a?(Splicer::Zone)
+    return false unless record.is_a?(Splicer::Records::Record)
+    providers.each do |provider|
+      provider.update_record_in_zone(record, zone)
+    end
+  end
+
+  # Deletes a record from a zone
+  # @return [void]
+  def self.delete_record_in_zone(record, zone)
+    return false unless zone.is_a?(Splicer::Zone)
+    return false unless record.is_a?(Splicer::Records::Record)
+    providers.each do |provider|
+      provider.delete_record_in_zone(record, zone)
+    end
+  end
 end

data/spec/splicer/provider_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Splicer::Provider do
+  let(:provider) { Splicer::Provider.new }
+  let(:zone) { Splicer::Zone.new('example.com') }
+  let(:record) { Splicer::Records::Record.new('name',123) }
+
+  describe '#create_zone' do
+    subject { provider.create_zone(zone) }
+    it { should eq(false) }
+  end
+
+  describe '#update_zone' do
+    subject { provider.update_zone(zone) }
+    it { should eq(false) }
+  end
+
+  describe '#rewrite_zone' do
+    subject { provider.rewrite_zone(zone) }
+    it { should eq(false) }
+  end
+
+  describe '#delete_zone' do
+    subject { provider.delete_zone(zone) }
+    it { should eq(false) }
+  end
+
+  describe '#delete_record_in_zone' do
+    subject { provider.delete_record_in_zone(record, zone) }
+    it { should eq(false) }
+  end
+
+  describe '#update_record_in_zone' do
+    subject { provider.update_record_in_zone(record, zone) }
+    it { should eq(false) }
+  end
+
+  describe '#create_record_in_zone' do
+    subject { provider.create_record_in_zone(record, zone) }
+    it { should eq(false) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: splicer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2013-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - lib/splicer.rb
 - lib/splicer/configuration.rb
 - lib/splicer/errors.rb
+- lib/splicer/provider.rb
 - lib/splicer/records.rb
 - lib/splicer/records/a_record.rb
 - lib/splicer/records/aaaa_record.rb
@@ -92,6 +93,7 @@ files:
 - lib/splicer/zone.rb
 - spec/spec_helper.rb
 - spec/splicer/configuration_spec.rb
+- spec/splicer/provider_spec.rb
 - spec/splicer/records/a_record_spec.rb
 - spec/splicer/records/aaaa_record_spec.rb
 - spec/splicer/records/cname_record_spec.rb
@@ -120,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1920739090551014309
+      hash: -162604281930152343
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -129,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1920739090551014309
+      hash: -162604281930152343
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -139,6 +141,7 @@ summary: Splicer allows communication with one or more dns providers
 test_files:
 - spec/spec_helper.rb
 - spec/splicer/configuration_spec.rb
+- spec/splicer/provider_spec.rb
 - spec/splicer/records/a_record_spec.rb
 - spec/splicer/records/aaaa_record_spec.rb
 - spec/splicer/records/cname_record_spec.rb