splicer 0.0.1 → 0.1.0

data/.ruby-gemset

@@ -1 +1 @@
-splice
+splicer

data/README.md

@@ -3,22 +3,80 @@
 Allows for interactions with multiple DNS' through one abstract API. You can use
 this to talk to one or more DNS providers if you choose.
 
+> splice: join or connect (a rope or ropes) by interweaving the strands.
+
+You are joining multiple DNS providers together. This can be used to transfer
+records from one to the other without breaking the primary provider.
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'splicer'
+```rb
+gem 'splicer'
+```
 
 
 ## Configuring
 
-TODO: Write this
+```rb
+Splicer.configure do |config|
+  config.register(Splicer::Dynect.new('company','user','pass')) # gem 'splicer-dynect'
+  config.register(Splicer::DNSMadeEasy.new('user','pass')) # gem 'splicer-dns_made_easy'
+end
+```
+
+This library does rely on 3rd party sources, so it can and will take time to
+publish the zones. It would be wise to put this into a background job.
+
+
+## Under The Hood
+
+Splicer is a simple abstract data structure that allows you to put together DNS
+zones and records quickly. The providers are what take this abstract DNS model
+and turn it into the concrete model in some external API.
+
+
+### Records
+
+All records are relative to a zone.
+
+```rb
+record = Splicer::Records::ARecord('example.com', '127.0.0.1')
+```
+
+### Zones
+
+Is a collection of records.
+
+```rb
+zone = Splicer::Zone.new('example.com')
+zone.add_record(record)
+zone.publish
+```
+
+When `Splicer::Zone#publish` is called, the provider can be passed to only push
+the updates to that zone in the DNS.
+
+
+## Provider
 
+Providers are adapters to a 3rd party API, such as Dynect or DNSMadeEasy. Both
+API's are very different but similar in many respects.
 
-## Using
+If you write a provider you **MUST** follow a few rules:
 
-TODO: Write this
+  * A provider must utilize the abstract model.
+  * Do **NOT** monkey patch the abstract model. This can cause problems with
+    other provider gems, and cause the library to be unstable.
+  * Provide a way to build an abstract model from the concrete (3rd party)
+    model. This will allow for easier export to other DNS providers.
+  * If a provider does not have an ability to use/create a record such as a KEY
+    record, then ignore it.
+  * When publishing the zone, there should be ways to completely overwrite the
+    zone and merge existing records with that zone.
+  * Tests must be written.
 
 
 ## Contributions

data/lib/splicer/configuration.rb

@@ -0,0 +1,21 @@
+module Splicer
+
+  class Configuration
+    def initialize
+      @configs = []
+    end
+
+    # @param [Object] config the configuration for a provider
+    # @return [void]
+    def register(config)
+      @configs << config
+    end
+
+    # Returns a list of providers.
+    # @return [Array] an array of providers
+    def providers
+      @configs.collect { |config| config.provider }
+    end
+  end
+
+end

data/lib/splicer/errors.rb

@@ -4,5 +4,11 @@ module Splicer
     class Error < StandardError
     end
 
+    class NotImplemented < Error
+    end
+
+    class RequestError < Error
+    end
+
   end
 end

data/lib/splicer/version.rb

@@ -1,3 +1,3 @@
 module Splicer
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/splicer/zone.rb

@@ -22,6 +22,15 @@ module Splicer
     def add_records(records)
       @records.concat(records)
     end
+
+    # @param [Symbol] method the method by which you want to publish
+    # @return [void]
+    def publish(method)
+      Splicer.providers.each do |provider|
+        provider.publish(self, method)
+      end
+      true
+    end
   end
 
 end

data/lib/splicer.rb

@@ -1,8 +1,8 @@
 require 'splicer/version'
 require 'splicer/errors'
+require 'splicer/configuration'
 require 'splicer/records'
 require 'splicer/zone'
-require 'splicer/provider'
 
 # Splicer is a simple DNS data structure that allows you to publish changes to
 # one or more dns services if desired.
@@ -18,46 +18,29 @@ require 'splicer/provider'
 #
 #   * splicer-dynect
 #   * splicer-dns_made_easy
+#   * splicer-no_op_provider
 #
 # == Example Configureation
 #
 #   Splicer.configure do |config|
-#     config.add_provider Splicer::Dynect('company','user','password')
-#     config.add_provider Splicer::DNSMadeEasy('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
 #
 # @author Matthew A. Johnston <warmwaffles@gmail.com>
 module Splicer
-  class << self
-    # All of the available providers
-    @@providers = {}
+  @@configuration = nil
 
-    # Configure Splicer
-    def configure
-      yield self
-    end
-  end
-
-  # Add a DNS provider to your
-  #
-  # @raise [ArgumentError]
-  # @param [Splicer::Provider] provider the provider you want to add
-  # @return [Splicer::Provider]
-  def self.register(provider)
-    providers[provider.name] = provider
-  end
-
-  # Get a provider from the providers hash. If the provider is not found `nil`
-  # will be returned
-  #
-  # @return [Splicer::Provider]
-  def self.provider(name)
-    providers[name]
+  def self.configure &block
+    @@configuration = Configuration.new
+    yield(@@configuration)
   end
 
   def self.providers
-    @@providers ||= {}
+    @@configuration ||= Configuration.new
+    @@configuration.providers
   end
+
 end

data/spec/splicer/configuration_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Splicer::Configuration do
+  let(:config) { Splicer::Configuration.new }
+
+  describe 'fields' do
+    it { should respond_to :providers }
+  end
+
+  describe '#initialize' do
+    subject { config }
+    its(:providers) { should eq([]) }
+  end
+
+  describe '#register' do
+    let(:provider) { double('Splicer::SomeProvider') }
+    subject { config.register(provider) }
+    it { should eq([provider]) }
+  end
+
+  describe '#providers' do
+    let(:one_provider) { double('Splicer::OneDNS::Provider')}
+    let(:two_provider) { double('Splicer::TwoDNS::Provider')}
+    let(:one_dns) { double('Splicer::OneDNS', provider: one_provider) }
+    let(:two_dns) { double('Splicer::TwoDNS', provider: two_provider) }
+    before do
+      config.register(one_dns)
+      config.register(two_dns)
+    end
+    subject { config.providers }
+    it { should eq([one_provider, two_provider])}
+  end
+end

data/spec/splicer/zone_spec.rb

@@ -9,6 +9,7 @@ describe Splicer::Zone do
     it { should respond_to :name= }
     it { should respond_to :records }
   end
+
   describe '#initialize' do
     subject { zone }
     its(:name) { should eq('example.com') }
@@ -32,4 +33,9 @@ describe Splicer::Zone do
     end
   end
 
+  describe '#publish' do
+    subject { zone.publish(:merge) }
+    it { should eq(true) }
+  end
+
 end

data/spec/splicer_spec.rb

@@ -1,31 +1,40 @@
 require 'spec_helper'
 
 describe Splicer do
-  let(:provider) { double('Splicer::Provider', name: 'someone') }
-  let(:another) { double('Splicer::Provider', name: 'another') }
+  let(:provider) { double('Splicer::Provider', name: :someone) }
+  let(:another) { double('Splicer::Another', name: :another) }
 
   describe '.configure' do
     it "should accept a block" do
-      expect {
-        Splicer.configure do |config|
-        end
-      }.to_not raise_error(StandardError)
+      Splicer.configure do |config|
+        @config = config
+      end
+      expect(@config).to be_a(Splicer::Configuration)
+      @config = nil
     end
   end
 
-  describe '.register' do
-    it "should register a provider" do
-      Splicer.register(provider)
-      expect(Splicer.providers.count).to eq(1)
-    end
-    it "should register more than one provider" do
-      Splicer.register(provider)
-      Splicer.register(another)
-      expect(Splicer.providers.count).to eq(2)
+  describe '.configuration' do
+    subject { Splicer.providers }
+
+    context 'when no configurations are present' do
+      before do
+        Splicer.configure do |config|
+        end
+      end
+      it { should eq([]) }
     end
-  end
 
-  describe '.provider' do
+    context 'when a configuration is present' do
+      let(:one_provider) { double('Splicer::OneDNS::Provider')}
+      let(:one_dns) { double('Splicer::OneDNS', provider: one_provider) }
+      before do
+        Splicer.configure do |config|
+          config.register(one_dns)
+        end
+      end
+      it { should eq([one_provider]) }
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: splicer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,8 +75,8 @@ files:
 - README.md
 - Rakefile
 - 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
@@ -91,6 +91,7 @@ files:
 - lib/splicer/version.rb
 - lib/splicer/zone.rb
 - spec/spec_helper.rb
+- spec/splicer/configuration_spec.rb
 - spec/splicer/records/a_record_spec.rb
 - spec/splicer/records/aaaa_record_spec.rb
 - spec/splicer/records/cname_record_spec.rb
@@ -119,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -20106687361328625
+      hash: 3236930637488513078
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -128,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -20106687361328625
+      hash: 3236930637488513078
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -137,6 +138,7 @@ specification_version: 3
 summary: Splicer allows communication with one or more dns providers
 test_files:
 - spec/spec_helper.rb
+- spec/splicer/configuration_spec.rb
 - spec/splicer/records/a_record_spec.rb
 - spec/splicer/records/aaaa_record_spec.rb
 - spec/splicer/records/cname_record_spec.rb

data/lib/splicer/provider.rb

@@ -1,11 +0,0 @@
-module Splicer
-
-  class Provider
-    attr_reader :name
-
-    def initialize(name)
-      @name = name
-    end
-  end
-
-end