dynect 0.0.1

data/lib/dynect.rb

@@ -0,0 +1,149 @@
+require 'rubygems'
+gem 'soap4r'
+
+require 'soap/rpc/driver'
+
+class Dynect
+  # Provide the customer, user, and password information to intiate the SOAP connection.
+  # If desired, an alternate driver can be supplied to enable mocking or the use of different protocols.
+  def initialize(customer, user, password, driver = nil)
+    @driver = driver || setup_driver
+    @creds = {"cust" => customer, "user" => user, "pass" => password }
+    
+    add_methods
+  end
+  
+  # Lists the zones associated with the accout. Specify a zone to get information on a specific one
+  def list_zones(zone = nil)
+    args = @creds
+    args["zone"] = zone if zone
+    
+    response = @driver.ZoneGet args
+    check_for_errors("when listing zone(s)", response)
+    response.zones
+  end
+  
+  # Create a new zone
+  def create_zone(zone, type, options ={})
+    args = @creds.merge("zone" => zone, "type" => type)
+    args.merge!(options)
+    
+    response = @driver.ZoneAdd args
+    check_for_errors("when creating a zone", response)
+  end
+  
+  # Lists all the A records associated with the account.
+  #
+  # == Options 
+  # * +node+ -- The fully qualified domain name of the node to retreive records from. Omit or enter an empty string to get the records of the root node
+  # * +record_id+ -- The ID of the record to retreive information of
+  #
+  # == Useage
+  #
+  #   d = Dynect.new("customer", "username", "password")
+  #   d.list_a_records("myzone.domain.com")
+  #
+  def list_a_records(zone, options ={})
+    args = @creds.merge("type" => "A", "zone" => zone)
+    args.merge!(options)
+    
+    response = @driver.RecordGet args
+    check_for_errors("when listing records", response)
+    response.records
+  end
+  
+  def add_a_record(zone, address, options = {})
+    args = @creds.merge("type" => "A", "zone" => zone, "rdata" => {"address" => address})
+    args.merge!(options)
+    
+    response = @driver.RecordAdd args
+    check_for_errors("when adding an A record", response)
+  end
+  
+  # Updates A records identified by the ID
+  def update_a_record(id, options = {})
+    args = @creds.merge("record_id" => id)
+    args.merge!(options)
+    
+    response = @driver.RecordUpdate args
+    check_for_errors("when updating an A record", response)
+  end
+  
+  # Deletes an A record identified by the ID
+  def delete_a_record(id)
+    response = @driver.RecordDelete @creds.merge("record_id" => id)
+    check_for_errors("when removing an A record", response)
+  end
+  
+  # Lists the CNAME records associated with an account
+  def list_cname_records(zone, options ={})
+    args = @creds.merge("type" => "CNAME", "zone" => zone)
+    args.merge!(options)
+    
+    response = @driver.RecordGet args
+    check_for_errors("when listing CNAME records", response)
+    response.records
+  end
+  
+  # Adds a CNAME record for the specified zone
+  def add_cname_record(zone, hostname, options = {} )
+    args = @creds.merge("type" => "CNAME", "zone" => zone, "rdata" => {"cname" => hostname})
+    args.merge!(options)
+    
+    response = @driver.RecordAdd args
+    check_for_errors("when adding a CNAME record", response)
+  end
+  
+  def update_cname_record(id, options = {})
+    args = @creds.merge("id" => id)
+    args.merge!(options)
+    
+    response = @driver.RecordUpdate args
+    check_for_errors("when updating a CNAME record", response)
+  end
+  
+  def delete_cname_record(id)
+    response = @driver.RecordDelete @creds.merge("record_id" => id)
+    check_for_errors("when removing a CNAME record", response)
+  end  
+  
+  def update_soa(id, options = {})
+    args = @creds.merge("record_id" => id)
+    args.merge!(options)
+    
+    response = @driver.RecordUpdate args
+    check_for_errors("when updating a SOA record", response)
+  end
+  
+  def list_soa(zone, options = {})
+    args = @creds.merge("type" => "SOA", "zone" => zone)
+    args.merge!(options)
+    
+    response = @driver.RecordGet args
+    check_for_errors("when listing SOA records", response)
+    response.records.first
+  end
+  
+private
+
+  def check_for_errors(message, response)
+    if response["errors"]
+      raise "#{message}, you got this error: #{response["errors"]["action"]}" unless response["errors"]["action"].nil?
+    end
+    response
+  end
+  
+  def setup_driver
+    SOAP::RPC::Driver.new('https://api.dynect.net/soap/', '/DynectAPI/')
+  end
+  
+  def add_methods
+    @driver.add_method("ZoneGet", "args")
+    @driver.add_method("ZoneAdd", "args")
+    @driver.add_method("RecordGet", "args")
+    @driver.add_method("RecordAdd", "args")
+    @driver.add_method("RecordUpdate", "args")
+    @driver.add_method("RecordDelete", "args")
+  end
+  
+end

data/spec/dynec_a_record_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/../lib/dynect.rb'
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Dynect, "when used to manage A records" do
+
+  before(:each) do
+    @driver = mock("driver")
+    @driver.should_receive(:add_method).at_least(:once)
+      
+    @d = Dynect.new("customer", "username", "password", @driver)
+    
+    @result = mock("test")
+    @result.stub!(:errors).and_return(false)
+    @result.stub!(:[])
+  end
+
+  it "should be able to list records" do
+    @d.should respond_to(:list_a_records)
+  end
+  
+  it "should be able to accept additional parameters to filter the records you want" do
+    @driver.should_receive(:RecordGet).and_return(@result)
+    @result.stub!(:records)
+    @d.list_a_records("myzone.domain.com")
+  end
+  
+  it "should be able to add an A record" do
+    @d.should respond_to(:add_a_record)
+  end
+  
+  it "should require zone, address information when adding an A record" do
+    @driver.should_receive(:RecordAdd).and_return(@result)   
+    @d.add_a_record("test.domain.com", "192.168.1.1" )
+  end
+  
+  it "should be able to accept additional parameters when creating an A record" do
+    @driver.should_receive(:RecordAdd).and_return(@result)    
+    @d.add_a_record("test.domain.com", "192.168.1.1", "ttl" => "64")
+  end
+  
+  it "should be able to update A records" do
+    @d.should respond_to(:update_a_record)
+  end
+   
+  it "should require the A record id to update" do
+    @driver.should_receive(:RecordUpdate).and_return(@result)
+    @d.update_a_record("id")    
+  end
+  
+  it "should be able to accept additional parameters when updating an A record" do
+    @driver.should_receive(:RecordUpdate).and_return(@result)
+    @d.update_a_record("id", "address" => "192.168.1.1")    
+  end
+  
+  it "should be able to delete A records" do
+    @d.should respond_to(:delete_a_record)
+  end
+    
+  it "should require the A record id to delete" do
+    @driver.should_receive(:RecordDelete).and_return(@result)
+    @d.delete_a_record("id")
+  end
+
+end

data/spec/dynec_cname_record_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/../lib/dynect.rb'
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Dynect, "when used to manage CNAME records" do
+
+  before(:each) do
+    @driver = mock("driver")
+    @driver.should_receive(:add_method).at_least(:once)
+      
+    @d = Dynect.new("customer", "username", "password", @driver)
+    
+    @result = mock("test")
+    @result.stub!(:errors).and_return(false)
+    @result.stub!(:[])
+  end
+
+  it "should be able to list records" do
+    @d.should respond_to(:list_cname_records)
+  end
+  
+  it "should be able to accept additional parameters to filter the records you want" do
+    @driver.should_receive(:RecordGet).and_return(@result)
+    @result.stub!(:records)
+    @d.list_cname_records("zone.domain.com")
+  end
+  
+  it "should be able to add an CNAME record" do
+    @d.should respond_to(:add_cname_record)
+  end
+  
+  it "should require zone, hostname information when adding an CNAME record" do
+    @driver.should_receive(:RecordAdd).and_return(@result)   
+    @d.add_cname_record("test.domain.com", "cname.domain.com" )
+  end
+  
+  it "should be able to accept additional parameters when creating an CNAME record" do
+    @driver.should_receive(:RecordAdd).and_return(@result)    
+    @d.add_cname_record("test.domain.com", "cname.domain.com")
+  end
+  
+  it "should be able to update CNAME records" do
+    @d.should respond_to(:update_cname_record)
+  end
+   
+  it "should require the CNAME record id to update" do
+    @driver.should_receive(:RecordUpdate).and_return(@result)
+    @d.update_cname_record("id")    
+  end
+  
+  it "should be able to accept additional parameters when updating an CNAME record" do
+    @driver.should_receive(:RecordUpdate).and_return(@result)
+    @d.update_cname_record("id", "address" => "192.168.1.1")    
+  end
+  
+  it "should be able to delete CNAME records" do
+    @d.should respond_to(:delete_cname_record)
+  end
+    
+  it "should require the CNAME record id to delete" do
+    @driver.should_receive(:RecordDelete).and_return(@result)
+    @d.delete_cname_record("id")
+  end 
+  
+
+end

data/spec/dynec_soa_record_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/../lib/dynect.rb'
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe Dynect, "when used to manage SOA" do
+  
+  before(:each) do
+    @driver = mock("driver")
+    @driver.should_receive(:add_method).at_least(:once)
+      
+    @d = Dynect.new("customer", "username", "password", @driver)
+    
+    @result = mock("test")
+    @result.stub!(:errors).and_return(false)
+    @result.stub!(:[])
+  end
+  
+  it "should be able to update SOA elements" do
+    @d.should respond_to(:update_soa)
+  end
+  
+  it "should accept options to update" do
+    @driver.should_receive(:RecordUpdate).and_return(@result)
+    @d.update_soa("rname" => "root.domain.com")
+  end
+  
+  it "should list SOA elements" do
+    @driver.should_receive(:RecordGet).and_return(@result)
+    @result.stub!(:records).and_return([])
+    @d.list_soa("foo.domain.com")
+  end  
+end

data/spec/dynect_zone_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../lib/dynect.rb'
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe Dynect, "when used to manage zones" do
+  
+  before(:each) do
+    @driver = mock("driver")
+    @driver.should_receive(:add_method).at_least(:once)
+      
+    @d = Dynect.new("customer", "username", "password", @driver)
+    
+    @result = mock("test")
+    @result.stub!(:errors).and_return(false)
+    @result.stub!(:[])
+  end
+  
+  it "should have a list zones method" do
+    @d.should respond_to(:list_zones)
+  end
+  
+  it "should be able to retireve info about a specific zone" do
+    @driver.should_receive(:ZoneGet).and_return(@result)
+    @result.stub!(:zones)
+    @d.list_zones("test.domain.com")
+  end
+  
+  it "should call the driver when list zones is called" do
+    expected_creds = {"cust" => "customer", "user" => "username", "pass" => "password"}
+    @driver.should_receive(:ZoneGet).with(expected_creds).and_return(@result)
+    @result.stub!(:zones)
+    @d.list_zones
+  end
+  
+  it "should have a create zone method" do
+    @d.should respond_to(:create_zone)
+  end
+      
+  it "should require a zone name and type when creating a zone" do
+    @driver.should_receive(:ZoneAdd).and_return(@result)
+    @d.create_zone("test.domain.com", "primary")
+  end
+  
+  it "should be able to accept additional parameters when creating a zone"  do
+    @result.stub!(:call)
+    @driver.should_receive(:ZoneAdd).and_return(@result)
+    
+    options = {"ttl" => "24", "data" => {"rname" => "test@example.com", "master" => "192.168.1.1"}}
+    
+    @d.create_zone("test.domain.com", "primary", options).should_not raise_error    
+  end
+  
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: dynect
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dave Hoover
+- Colin Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-02 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: soap4r
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple wrapper for Dynect SOAP API.
+email: dave@obtiva.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/dynect.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/dynect/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dynect
+rubygems_version: 1.0.0
+signing_key: 
+specification_version: 2
+summary: Simple wrapper for Dynect SOAP API.
+test_files: 
+- spec/dynec_a_record_spec.rb
+- spec/dynec_cname_record_spec.rb
+- spec/dynec_soa_record_spec.rb
+- spec/dynect_zone_spec.rb