dnsapp 0.0.1 → 0.0.2

data/Manifest

@@ -1,3 +1,13 @@
+Manifest
+README.rdoc
 Rakefile
+dnsapp.gemspec
 lib/dnsapp.rb
-Manifest
+lib/dnsapp/auth_check_parser.rb
+lib/dnsapp/credentials.rb
+lib/dnsapp/domain.rb
+lib/dnsapp/object.rb
+lib/dnsapp/record.rb
+spec/credentials.yml
+spec/domain_spec.rb
+spec/record_spec.rb

data/README.rdoc

@@ -0,0 +1,73 @@
+== DNSApp.net
+
+This gem allows easy access to the DNSApp.net API.
+
+You will need a DNSApp.net account.
+
+* https://www.dnsapp.net
+* https://www.dnsapp.net/api
+
+== Installation
+
+  [sudo] gem install httparty
+  [sudo] gem install dnsapp
+
++sudo+ is optional depending on your setup.
+
+In your Ruby script you can now.
+
+  require 'rubygems'
+  require 'dnsapp'
+  
+  DNSApp::Credentials.username = 'mmr@dnsapp.net'
+  DNSApp::Credentials.password = 'p@ssw0rd'
+  DNSApp::Domain.all
+  => [#<DNSApp::Domain:0x101be6070 @auth_id=nil, @name="dnsapp.net", @handle=nil, @user_id=1, @created_at=Mon Nov 15 12:23:55 UTC 2010, @locked=nil, @authoritative=false, @id=16, @status="done", @updated_at=Fri Nov 19 11:30:00 UTC 2010>]
+  
+  
+== Example
+
+  require 'rubygems'
+  require 'dnsapp'
+
+  DNSApp::Credentials.username = 'mmr@dnsapp.net'
+  DNSApp::Credentials.password = 'p@ssw0rd'
+  
+  DNSApp::Domain.all.each do |domain|
+    records = domain.records.all.length
+    puts "#{domain.name} has #{records} records."
+  end
+  
+  new_domain = DNSApp::Domain.create("example.org")
+  new_domain.records.create :name => '%d', :content => '1.2.3.4', :type => 'A', :ttl => 3600
+  new_domain.records.create :name => '%d', :content => 'mailserver.somewhere.com', :type => 'MX', :ttl => 3600, :prio => "10"
+  
+  new_domain.records.all.last.destroy
+  
+  another_domain = DNSApp::Domain.find("another-domain.com") # could also specify numeric ID
+  another_domain.records.find(240).destroy # 240 is the numeric ID for the record
+  
+  third_domain = DNSApp::Domain.find(42)
+  third_domain.delete
+  
+== Testing / RSpec
+
+In order to run the test suite you have to have a DNSApp.net account (a trial account is not sufficient).
+
+You must create the file <tt>spec/credentials.yml</tt>.
+  spec/credentials.yml
+  
+  username: <your username>
+  password: <your password>
+
+The specs all depend on an active internet connection and access to https://dnsapp.net.
+
+== Known issues
+
+On Debian/Ubuntu systems <tt>httparty</tt> sometimes gives a:
+
+  no such file to load net/https
+
+To solve this
+
+  apt-get install libopenssl-ruby

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake'
 require 'echoe'
 require 'rspec/core/rake_task'
 
-Echoe.new('dnsapp', '0.0.1') do |p|
+Echoe.new('dnsapp', '0.0.2') do |p|
   p.description    = "Gem to interact with DNSapp.net Managed DNS service"
   p.url            = "http://github.com/mmriis/dnsapp"
   p.author         = "Morten Møller Riis"

data/dnsapp.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dnsapp}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten M\303\270ller Riis"]
@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   s.date = %q{2011-01-15}
   s.description = %q{Gem to interact with DNSapp.net Managed DNS service}
   s.email = %q{m _AT_ justabout.it}
-  s.extra_rdoc_files = ["lib/dnsapp.rb"]
-  s.files = ["Rakefile", "lib/dnsapp.rb", "Manifest", "dnsapp.gemspec"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/dnsapp.rb", "lib/dnsapp/auth_check_parser.rb", "lib/dnsapp/credentials.rb", "lib/dnsapp/domain.rb", "lib/dnsapp/object.rb", "lib/dnsapp/record.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "dnsapp.gemspec", "lib/dnsapp.rb", "lib/dnsapp/auth_check_parser.rb", "lib/dnsapp/credentials.rb", "lib/dnsapp/domain.rb", "lib/dnsapp/object.rb", "lib/dnsapp/record.rb", "spec/credentials.yml", "spec/domain_spec.rb", "spec/record_spec.rb"]
   s.homepage = %q{http://github.com/mmriis/dnsapp}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Dnsapp", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/lib/dnsapp/auth_check_parser.rb

@@ -0,0 +1,15 @@
+require 'httparty'
+
+module DNSApp
+
+  class Unauthorized < Exception #:nodoc:
+  end
+
+  class AuthCheckParser < HTTParty::Parser #:nodoc:
+    def parse
+      raise DNSApp::Unauthorized, "Access Denied. Maybe you supplied wrong credentials?" if body =~ /HTTP Basic: Access denied./i
+      super
+    end
+  end
+
+end

data/lib/dnsapp/credentials.rb

@@ -0,0 +1,36 @@
+module DNSApp
+
+  class Credentials
+    class << self
+  
+      # Set DNSApp username.
+      # This must be done before connecting.
+      # == Example
+      #    DNSApp::Credentials.username = 'mmr@dnsapp.net'
+      #    DNSApp::Credentials.password = 'p@ssw0rd'
+      #    DNSApp::Domain.all
+      def username=(username)
+        @username = username
+      end
+    
+      def username #:nodoc:
+        @username
+      end
+      
+      # Set DNSApp password.
+      # This must be done before connecting.
+      # == Example
+      #    DNSApp::Credentials.username = 'mmr@dnsapp.net'
+      #    DNSApp::Credentials.password = 'p@ssw0rd'
+      #    DNSApp::Domain.all
+      def password=(password)
+        @password = password
+      end
+      
+      def password #:nodoc:
+        @password
+      end
+    end
+  end
+
+end

data/lib/dnsapp/domain.rb

@@ -0,0 +1,102 @@
+require 'dnsapp/object'
+
+module DNSApp
+    
+  class Domain < DNSApp::Object
+    
+    # id for the domain
+    attr_accessor :id
+    # The domain name
+    attr_accessor :name
+    # When the domain was created
+    attr_accessor :created_at
+    # The domain handle
+    attr_accessor :handle
+    # When the domain was updated
+    attr_accessor :updated_at
+    # Whether DNSApp.net is authoritative for the domain
+    # If +false+ the domain doesn't point to the DNSApp.net nameservers
+    attr_accessor :authoritative
+    # The user_id for the domain
+    attr_accessor :user_id
+    # The AUTHID for the domain. Used for transfers.
+    attr_accessor :auth_id
+    # The status of the domain
+    attr_accessor :status
+    # Whether the domain is locked. Must be false if you wish to transfer.
+    attr_accessor :locked
+        
+    class << self
+      # Retrives all domains
+      def all        
+        response = get("/domains")["domains"]        
+        response.collect { |attributes| Domain.new attributes }
+      end
+      
+      # Find domain by +id+ or +name+
+      # == Example
+      #  DNSApp::Domain.find(10)
+      #  DNSApp::Domain.find("example.org")
+      def find(id_or_name)
+        if id_or_name.is_a?(Integer)
+          find_by_id(id_or_name)
+        else
+          find_by_name(id_or_name)
+        end
+      end
+      
+      # Find domain by +id+
+      def find_by_id(id)
+        response = get("/domains/#{id}")["domain"]
+        response or return nil
+        Domain.new response
+      end
+      
+      # Find domain by +name+
+      def find_by_name(name)
+        domain = self.all.select { |d| d.name == name }
+        return domain.blank? ? nil : domain.first
+      end
+      
+      # Creates a new domain
+      # +name+ must be without www or similar.
+      # == Example
+      #  DNSApp::Domain.create("example.org")
+      def create(name)
+        name.is_a? String or raise TypeError, "name must be string"
+        r = post("/domains", :query => {"domain[name]" => name})
+        r["errors"] and raise StandardError, r["errors"]["error"].to_a.join(", ")
+        if r.code == 201
+          Domain.new r["domain"]
+        else
+          raise StandardError, 'Could not create the domain'
+        end        
+      end
+      
+    end
+    
+    # Deletes the domain. This cannot be undone.
+    # Returns the deleted domain object.
+    # == Example
+    #   DNSApp::Domain.find(10).destroy
+    def destroy
+      r = self.class.delete("/domains/#{self.id}")
+      if r.code == 200
+        self
+      else
+        raise StandardError, 'Could not delete the domain'
+      end      
+    end
+    
+    # Get records on the domain.
+    # == Example
+    #  DNSApp::Domain.find(10).records.all
+    #  DNSApp::Domain.find(10).records.create(:name => '%d', :content => '1.2.3.4', :type => 'A', :ttl => 3600)
+    def records
+      @@parent_id = self.id
+      DNSApp::Record
+    end
+        
+  end
+  
+end

data/lib/dnsapp/object.rb

@@ -0,0 +1,59 @@
+require 'dnsapp/credentials'
+require 'dnsapp/auth_check_parser'
+
+module DNSApp
+  class Object #:nodoc: all
+    
+    @@parent_id = nil
+    def parent_id
+      @@parent_id
+    end
+    
+    def parent_id=(id)
+      @@parent_id = id
+    end
+    
+    include HTTParty
+    format :xml
+    headers 'Accept' => 'application/xml', 'Content-Type' => 'application/xml'
+    base_uri "https://dnsapp.net"
+    parser DNSApp::AuthCheckParser
+
+    class << self
+      def get(*args)
+        basic_auth DNSApp::Credentials.username, DNSApp::Credentials.password
+        super
+      end
+      
+      def post(*args)
+        basic_auth DNSApp::Credentials.username, DNSApp::Credentials.password
+        super
+      end
+      
+      def delete(*args)
+        basic_auth DNSApp::Credentials.username, DNSApp::Credentials.password
+        super
+      end
+      
+      def put(*args)
+        basic_auth DNSApp::Credentials.username, DNSApp::Credentials.password
+        super
+      end
+      
+    end
+    
+    def initialize(attributes=nil)
+      attributes and attributes.each do |key, value|
+        setter_method = "#{key}=".to_sym
+        if self.respond_to?(setter_method)
+          self.send(setter_method, value)
+        end
+      end
+    end
+    
+    def self.check_required_keys(hash, *keys)
+      hash.is_a? Hash or raise "Options must be given as a Hash"
+      keys.each { |key| raise "Missing required option #{key}" if hash[key].nil? }
+    end        
+  end
+end

data/lib/dnsapp/record.rb

@@ -0,0 +1,107 @@
+require 'dnsapp/object'
+
+module DNSApp
+    
+  class Record < DNSApp::Object
+    
+    # id for the record
+    attr_accessor :id
+    # name for the record
+    attr_accessor :name
+    # When the record was created
+    attr_accessor :created_at
+    # When the record was last updated
+    attr_accessor :updated_at
+    # time-to-live for the record
+    attr_accessor :ttl
+    # domain_id for the record
+    attr_accessor :domain_id
+    # content for the record
+    attr_accessor :content
+    # priority for the record.
+    # Only needed for MX and SRV records.
+    attr_accessor :prio
+    # type for the record
+    # Must be one of the following A AAAA NS SOA CNAME TXT SPF SRV MX PTR
+    attr_accessor :type
+                
+    class << self
+      
+      # Get all the records
+      def all 
+        response = get("/domains/#{@@parent_id}/records")["records"]        
+        response.collect { |attributes| Record.new attributes }
+      end
+      
+      # Find a specific record by +id+
+      # == Example
+      #   DNSApp::Domain.all.first.find(243)
+      #   => #<DNSApp::Record:0x101ad5e88 @name="%d", @domain_id=131, @ttl=3600, @created_at=Mon Jan 10 15:48:02 UTC 2011, @content="1.2.3.4", @type="A", @id=1821, @prio=nil, @updated_at=Mon Jan 10 15:55:29 UTC 2011> 
+      def find(id)
+        response = get("/domains/#{@@parent_id}/records/#{id}")["record"]
+        response or return nil
+        Record.new response
+      end
+      
+      # Creates a new record. +options+ must contain at least the following:
+      # :name, :content, :type, :tll
+      # For SRV and MX records :prio can also be specified.
+      # == Valid types
+      #   A AAAA NS SOA CNAME TXT SPF SRV MX PTR
+      # == Example
+      #   DNSApp::Domain.all.first.records.create :name => '%d', :content => '1.2.3.4', :type => 'A', :ttl => 3600
+      def create(options={})
+        check_required_keys options, :name, :content, :type, :ttl
+        
+        r = post("/domains/#{@@parent_id}/records", :query => { "record[name]" => options[:name],
+                                                                "record[ttl]" => options[:ttl],
+                                                                "record[content]" => options[:content],
+                                                                "record[prio]" => options[:prio],
+                                                                "record[type]" => options[:type] })
+        r["errors"] and raise StandardError, r["errors"]["error"].to_a.join(", ")
+        if r.code == 201
+          Record.new r["record"]
+        else
+          raise StandardError, 'Could not create the record'
+        end        
+      end
+      
+    end
+    
+    # Saves the record.
+    # == Example
+    #   r = DNSApp::Domain.all.first.record.first
+    #   => #<DNSApp::Record:0x101ad5e88 @name="%d", @domain_id=131, @ttl=3600, @created_at=Mon Jan 10 15:48:02 UTC 2011, @content="1.2.3.4", @type="A", @id=1821, @prio=nil, @updated_at=Mon Jan 10 15:55:29 UTC 2011> 
+    #   r.content = '9.9.9.9'
+    #   => #<DNSApp::Record:0x101ad5e88 @name="%d", @domain_id=131, @ttl=3600, @created_at=Mon Jan 10 15:48:02 UTC 2011, @content="9.9.9.9", @type="A", @id=1821, @prio=nil, @updated_at=Mon Jan 10 17:52:09 UTC 2011> 
+    def save
+      r = self.class.put("/domains/#{@@parent_id}/records/#{self.id}", :query => { "record[name]" => self.name,
+                                                                                   "record[ttl]" => self.ttl,
+                                                                                   "record[content]" => self.content,
+                                                                                   "record[prio]" => self.prio,
+                                                                                   "record[type]" => self.type })
+      r["errors"] and raise StandardError, r["errors"]["error"].to_a.join(", ")
+      if r.code == 200
+        self.class.find(self.id)
+      else
+        raise StandardError, 'Could not update the record'
+      end
+    end
+    
+    # Deletes the record.
+    # Returns the deleted record.
+    # == Example
+    #  r = DNSApp::Domain.all.first.record.first.destroy
+    #  => #<DNSApp::Record:0x101ad5e88 @name="%d", @domain_id=131, @ttl=3600, @created_at=Mon Jan 10 15:48:02 UTC 2011, @content="1.2.3.4", @type="A", @id=1821, @prio=nil, @updated_at=Mon Jan 10 15:55:29 UTC 2011>
+    def destroy
+      r = self.class.delete("/domains/#{@@parent_id}/records/#{self.id}")
+      if r.code == 200
+        self
+      else
+        raise StandardError, 'Could not delete the record'
+      end      
+    end    
+    alias_method :delete, :destroy      
+  end
+  
+end

data/spec/domain_spec.rb

@@ -0,0 +1,71 @@
+require 'lib/dnsapp'
+require 'yaml'
+require 'rspec'
+
+describe DNSApp::Domain do
+  
+  before(:all) do
+    yml = YAML::load(File.open("spec/credentials.yml"))
+    DNSApp::Credentials.username = yml["username"]
+    DNSApp::Credentials.password = yml["password"]
+
+    @domain1 = DNSApp::Domain.create("test-example-1.com")
+    @domain2 = DNSApp::Domain.create("test-example-2.com")
+  end
+  
+  after(:all) do
+    DNSApp::Domain.find("test-example-1.com").destroy
+    DNSApp::Domain.find("test-example-2.com").destroy
+  end
+  
+  describe '#all' do
+    it 'should return a list of domains' do
+      domains = DNSApp::Domain.all.collect(&:name)
+      domains.should include("test-example-1.com")
+      domains.should include("test-example-2.com")
+    end
+  end
+  
+  describe '#find' do
+    it 'should return the domain with id' do
+      DNSApp::Domain.find(@domain1.id).name.should == "test-example-1.com"
+    end
+    
+    it 'should return the domain with name' do
+      DNSApp::Domain.find(@domain2.name).name.should == "test-example-2.com"
+    end
+  end
+  
+  describe '#create' do
+    before(:all) do
+      @example_domain = DNSApp::Domain.create('some-example-domain.com')
+    end
+    
+    after(:all) do
+      @example_domain.destroy
+    end
+    
+    it 'should create a domain with the specified name' do
+      DNSApp::Domain.find(@example_domain.name).name.should == @example_domain.name
+    end
+    
+    it 'should not be possible to create duplicate domains' do
+      lambda { DNSApp::Domain.create(@example_domain.name) }.should raise_error
+    end
+  end
+  
+  describe '#destroy' do
+    it 'should destroy the domain' do
+      domain = DNSApp::Domain.create('some-example-domain-to-be-destroyed.com')
+      domain.destroy
+      DNSApp::Domain.find('some-example-domain-to-be-destroyed.com').should be_nil
+    end
+  end
+  
+  describe '#records' do
+    it 'should return the record object' do
+      @domain1.records.should == DNSApp::Record
+    end
+  end
+  
+end

data/spec/record_spec.rb

@@ -0,0 +1,73 @@
+require 'lib/dnsapp'
+require 'yaml'
+require 'rspec'
+
+describe DNSApp::Record do
+  
+  before(:all) do
+    yml = YAML::load(File.open("spec/credentials.yml"))
+    DNSApp::Credentials.username = yml["username"]
+    DNSApp::Credentials.password = yml["password"]
+
+    @domain = DNSApp::Domain.create("test-example-1.com")
+  end
+  
+  after(:all) do
+    DNSApp::Domain.find("test-example-1.com").destroy
+  end
+  
+  describe '#all' do
+    it 'should return a list of records' do
+      records = @domain.records.all.collect(&:type)
+      records.should =~ %w(SOA NS NS NS NS NS)
+    end
+  end
+  
+  describe '#find' do
+    it 'should return the record with id' do
+      record = @domain.records.find(@domain.records.all.first.id)
+      record.should_not be_nil
+      record.id.should == @domain.records.all.first.id
+    end
+  end
+  
+  describe '#create' do
+    it 'should create a record with the specified attributes' do
+      @domain.records.create :name => '%d', :content => '1.2.3.4', :type => 'A', :ttl => 300
+      record = @domain.records.all.last
+      record.name.should == '%d'
+      record.content.should == '1.2.3.4'
+      record.type.should == 'A'
+      record.ttl.should == 300
+      record.prio.should be_nil
+    end
+  end
+  
+  describe '#save' do
+    it 'should update a record with the new attributes' do
+      record = @domain.records.all.first
+      record.name = 'test1.%d'
+      record.content = 'test2'
+      record.type = 'CNAME'
+      record.ttl = 5000
+      record.prio = 10
+      record.save
+      
+      record = @domain.records.find(record.id) # reload the record
+      record.name.should == 'test1.%d'
+      record.content.should == 'test2'
+      record.type.should == 'CNAME'
+      record.ttl.should == 5000
+      record.prio.should == 10
+    end
+  end
+  
+  describe '#destroy' do
+    it 'should destroy the record' do
+      number_of_records = @domain.records.all.length
+      @domain.records.all.last.destroy
+      @domain.records.all.length.should == number_of_records - 1
+    end
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dnsapp
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Morten M\xC3\xB8ller Riis"
@@ -60,12 +60,27 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README.rdoc
 - lib/dnsapp.rb
+- lib/dnsapp/auth_check_parser.rb
+- lib/dnsapp/credentials.rb
+- lib/dnsapp/domain.rb
+- lib/dnsapp/object.rb
+- lib/dnsapp/record.rb
 files: 
-- Rakefile
-- lib/dnsapp.rb
 - Manifest
+- README.rdoc
+- Rakefile
 - dnsapp.gemspec
+- lib/dnsapp.rb
+- lib/dnsapp/auth_check_parser.rb
+- lib/dnsapp/credentials.rb
+- lib/dnsapp/domain.rb
+- lib/dnsapp/object.rb
+- lib/dnsapp/record.rb
+- spec/credentials.yml
+- spec/domain_spec.rb
+- spec/record_spec.rb
 has_rdoc: true
 homepage: http://github.com/mmriis/dnsapp
 licenses: []