gandirb 2.0.0 → 2.1.0

data/CHANGELOG

@@ -1,7 +1,10 @@
+== 2.1.0
+
+* Zone classes and methods
+
 == 2.0.0
 
 * Full rewrite to support API version 2.0
-* Tests are now using rspec
 * Moved git repository to https://github.com/pickabee/gandi
 
 == 1.1.1

data/README.rdoc

@@ -22,12 +22,12 @@ Detailed RDoc documentation for each method is available using `rake rdoc`.
 
 == TODO
 
-* More tests
+* Add missing methods and classes (packmail, webredir...)
+* Abstract the multiple fetches (with the 'pending' states) for Domain.available
 * Refactor the Operation object creation from the other classes
-* Add attributes getters to Domain/Operation/Mailbox/Host classes
-* Refactor the Contact class to match the other classes behaviour (instances of the class should only match existing records)
-* Make the Domain/Contact/etc. classes more ActiveModel-like
+* Refactor the object classes to ensure consistent behaviour (starting with the Contact class) : use hashes with class method and object with instance methods
 * Better handling of failures and server exceptions, and overall stricter params checking
+* More tests
 
 == Copyright
 

data/lib/gandi/domain/zone/record.rb

@@ -0,0 +1,41 @@
+module Gandi
+  class Domain
+    class Zone
+      class Record
+        extend Gandi::Connector
+        
+        class << self
+          #Add a new record to zone/version.
+          #Return a Record hash.
+          def add(zone_id, version_id, record)
+            call('domain.zone.record.add', zone_id, version_id, record)
+          end
+          
+          #Count number of records for a given zone/version.
+          def count(zone_id, version_id)
+            call('domain.zone.record.count', zone_id, version_id)
+          end
+          
+          #Remove some records from a zone/version, filters are the same as for list.
+          #Return the number of records deleted.
+          def delete(zone_id, version_id, filters = {})
+            call('domain.zone.record.delete', zone_id, version_id, filters)
+          end
+          
+          #List a zone’s records, with an optional filter.
+          #Return an array of record hashes.
+          def list(zone_id, version_id, filters = {})
+            call('domain.zone.record.list', zone_id, version_id, filters = {})
+          end
+          
+          #Sets the records for a zone/version.
+          #Return an array of record hashes.
+          def set(zone_id, version_id, records)
+            call('domain.zone.record.set', zone_id, version_id, records)
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/gandi/domain/zone/version.rb

@@ -0,0 +1,32 @@
+module Gandi
+  class Domain
+    class Zone
+      class Version
+        extend Gandi::Connector
+        
+        class << self
+          #Delete a specific version.
+          #Return true.
+          def delete(zone_id, version_id)
+            call('domain.zone.version.delete', zone_id, version_id)
+          end
+          
+          #New version from another version. This will duplicate the version’s records.
+          #Note that cloned records will have new identifiers.
+          #Return the created version number.
+          #NOTE: This method is called new in the XML-RPC, API, and has been named create here to avoid conflicts with Ruby's initialize method
+          def create(zone_id, version_id = 0)
+            call('domain.zone.version.new', zone_id, version_id)
+          end
+          
+          #Sets the active zone version.
+          #Return true.
+          def set(zone_id, version_id)
+            call('domain.zone.version.set', zone_id, version_id)
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/gandi/domain/zone.rb

@@ -0,0 +1,100 @@
+require 'gandi/domain/zone/record'
+require 'gandi/domain/zone/version'
+
+module Gandi
+  class Domain
+    class Zone
+      include Gandi::GandiObjectMethods
+      
+      #The zone_id of the Zone
+      attr_reader :id
+      
+      def initialize(attributes)
+        set_attributes attributes
+      end
+      
+      #Clone a zone and its records from a given version.
+      #Return the created Gandi::Domain::Zone object.
+      def clone(version_id = 0, params = {})
+        self.class.new(self.class.clone(@id, version_id, params))
+      end
+      
+      #Delete the zone.
+      #Return true.
+      def delete
+        self.class.delete(@id)
+      end
+      
+      #Update a zone.
+      #Return self.
+      def update(params)
+        set_attributes self.class.update(@id, params)
+        self
+      end
+      
+      class << self
+        #Create a zone.
+        #Return a Gandi::Domain::Zone object.
+        def create(params)
+          new(call('domain.zone.create', params))
+        end
+        
+        #Return the zone identified by its zone_id
+        def find(zone_id)
+          new(call('domain.zone.info', zone_id))
+        end
+        
+        #Fetch the zone information for the zone identified by its zone_id.
+        #Return a hash.
+        def info(zone_id)
+          call('domain.zone.info', zone_id)
+        end
+        
+        #Count the zones.
+        def count(opts = {})
+          call('domain.zone.count', opts)
+        end
+        
+        #List zones.
+        #Return an array of hashes.
+        def list(opts = {})
+          call('domain.zone.list', opts)
+        end
+        
+        #Clone a zone and its records from a given version.
+        #This create a new zone that will only contain this version.
+        #Note that cloned records will have new identifiers.
+        #Return a hash with the new zone information.
+        def clone(zone_id, version_id = 0, params = {})
+          call('domain.zone.clone', zone_id, version_id, params)
+        end
+        
+        #Deletes a zone if not linked to any domain
+        #Warning: this also deletes all versions and records.
+        #Return true.
+        def delete(zone_id)
+          call('domain.zone.delete', zone_id)
+        end
+        
+        #Change the current zone of a domain.
+        #Return a hash with the modified domain
+        def set(domain, zone_id)
+          call('domain.zone.set', domain, zone_id)
+        end
+        
+        #Update an existing zone.
+        #Return the updated information hash.
+        def update(zone_id, params)
+          call('domain.zone.update', zone_id, params)
+        end
+      end
+      
+      private
+      
+      def set_attributes(attributes)
+        @attributes = attributes
+        @id = attributes['id']
+      end
+    end
+  end
+end

data/lib/gandi/domain.rb

@@ -8,6 +8,7 @@ require 'gandi/domain/nameservers'
 require 'gandi/domain/host'
 require 'gandi/domain/mailbox'
 require 'gandi/domain/forward'
+require 'gandi/domain/zone'
 
 module Gandi
   class Domain
@@ -56,7 +57,7 @@ module Gandi
       end
       
       #Create a domain with the given information.
-      #Returns a Gandi::Domain object.
+      #Returns a Gandi::Operation object.
       def create(fqdn, params)
         operation_hash = call('domain.create', fqdn, params)
         Gandi::Operation.new(operation_hash['id'], operation_hash)

data/lib/gandi/operation.rb

@@ -16,6 +16,14 @@ module Gandi
       self.class.call('operation.info', @id)
     end
     
+    ##TODO utility method to check if the operation has finished running
+    #def finished?
+    #end
+    
+    ##TODO use ActiveSupport::StringInquirer
+    #def step
+    #end
+    
     #Set the step of an operation to CANCEL.
     def cancel
       result = self.class.call('operation.cancel', @id)

data/lib/gandi/version.rb

@@ -1,3 +1,3 @@
 module Gandi
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/gandi/domain/zone/record_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'gandi'
+
+describe Gandi::Domain::Zone::Record do
+  let(:zone_id) { 42 }
+  let(:version_id) { 7 }
+  
+  before do
+    @connection_mock = double()
+    ::Gandi.connection = @connection_mock
+  end
+  
+  describe '.add' do
+    let(:record_creation_attributes) { domain_zone_record_creation_attributes }
+    let(:record_attributes) { record_creation_attributes.merge('id' => 42) }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.record.add', zone_id, version_id, record_creation_attributes).and_return(record_attributes)
+    end
+    
+    it "returns a record hash" do
+      record = Gandi::Domain::Zone::Record.add(zone_id, version_id, record_creation_attributes)
+      record.should == record_attributes
+    end
+  end
+  
+  describe '.count' do
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.record.count', zone_id, version_id).and_return(55)
+    end
+    
+    it "returns an integer" do
+      Gandi::Domain::Zone::Record.count(zone_id, version_id).should == 55
+    end
+  end
+  
+  describe '.delete' do
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.record.delete', zone_id, version_id, {}).and_return(12)
+    end
+    
+    it "returns an integer" do
+      Gandi::Domain::Zone::Record.delete(zone_id, version_id).should == 12
+    end
+  end
+  
+  describe '.list' do
+    let(:records_list) { [domain_zone_record_attributes, domain_zone_record_attributes('id' => 2), domain_zone_record_attributes('id' => 3)] }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.record.list', zone_id, version_id, {}).and_return(records_list)
+    end
+    
+    it "returns an array of hashes" do
+      Gandi::Domain::Zone::Record.list(zone_id, version_id).should == records_list
+    end
+  end
+  
+  describe '.set' do
+    let(:records_creation_list) { [domain_zone_record_creation_attributes, domain_zone_record_creation_attributes] }
+    let(:records_list) { [domain_zone_record_attributes, domain_zone_record_attributes('id' => 2)] }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.record.set', zone_id, version_id, records_creation_list).and_return(records_list)
+    end
+    
+    it "returns a domain hash" do
+      records_hash = Gandi::Domain::Zone::Record.set(zone_id, version_id, records_creation_list)
+      records_hash.should == records_list
+    end
+  end
+  
+end

data/spec/gandi/domain/zone/version_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'gandi'
+
+describe Gandi::Domain::Zone::Version do
+  let(:zone_id) { 42 }
+  
+  before do
+    @connection_mock = double()
+    ::Gandi.connection = @connection_mock
+  end
+  
+  describe '.delete' do
+    let(:version_id) { 42 }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.version.delete', zone_id, version_id).and_return(true)
+    end
+    
+    it "returns true" do
+      Gandi::Domain::Zone::Version.delete(zone_id, version_id).should be_true
+    end
+  end
+  
+  describe '.create' do
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.version.new', zone_id, 0).and_return(11)
+    end
+    
+    it "returns the new version" do
+      Gandi::Domain::Zone::Version.create(zone_id).should == 11
+    end
+  end
+  
+  describe '.set' do
+    let(:version_id) { 23 }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.version.set', zone_id, version_id).and_return(true)
+    end
+    
+    it "returns true" do
+      Gandi::Domain::Zone::Version.set(zone_id, version_id).should be_true
+    end
+  end
+  
+end

data/spec/gandi/domain/zone_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+require 'gandi'
+
+describe Gandi::Domain::Zone do
+  let(:fqdn) { 'domain1.tld' }
+  
+  before do
+    @connection_mock = double()
+    ::Gandi.connection = @connection_mock
+  end
+  
+  describe '.list' do
+    let(:domain_zones_list) { [domain_zone_list_attributes, domain_zone_list_attributes('name' => '2nd zone', 'id' => 2)] }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.list', {}).and_return(domain_zones_list)
+    end
+    
+    it "returns an array of hashes" do
+      Gandi::Domain::Zone.list.should == domain_zones_list
+    end
+  end
+  
+  describe '.count' do
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.count', {}).and_return(42)
+    end
+    
+    it "returns an integer" do
+      Gandi::Domain::Zone.count.should == 42
+    end
+  end
+  
+  describe '.create' do
+    let(:zone_name) { "My new Zone" }
+    let(:domain_zone_attributes) { domain_zone_info_attributes }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.create', zone_name).and_return(domain_zone_attributes)
+    end
+    
+    it "returns a Zone object" do
+      zone = Gandi::Domain::Zone.create(zone_name)
+      zone.should be_a(Gandi::Domain::Zone)
+      zone.id.should == domain_zone_attributes['id']
+      zone.to_hash.should == domain_zone_attributes
+    end
+  end
+  
+  describe '.info' do
+    let(:zone_id) { 42 }
+    let(:domain_zone_attributes) { domain_zone_info_attributes('id' => zone_id) }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.info', zone_id).and_return(domain_zone_attributes)
+    end
+    
+    it "returns a hash" do
+      Gandi::Domain::Zone.info(zone_id).should == domain_zone_attributes
+    end
+  end
+  
+  describe '.find' do
+    let(:zone_id) { 42 }
+    let(:domain_zone_attributes) { domain_zone_info_attributes('id' => zone_id) }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.info', zone_id).and_return(domain_zone_attributes)
+    end
+    
+    it "returns a Zone object" do
+      zone = Gandi::Domain::Zone.find(zone_id)
+      zone.should be_a(Gandi::Domain::Zone)
+      zone.id.should == domain_zone_attributes['id']
+    end
+  end
+  
+  describe '.clone' do
+    let(:zone_id) { 42 }
+    let(:new_zone_id) { 43 }
+    let(:zone_attributes) { domain_zone_info_attributes('id' => new_zone_id) }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.clone', zone_id, 0, {}).and_return(zone_attributes)
+    end
+    
+    it "returns a hash" do
+      zone = Gandi::Domain::Zone.clone(zone_id)
+      zone['id'].should == new_zone_id
+    end
+  end
+  
+  describe '.delete' do
+    let(:zone_id) { 42 }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.delete', zone_id).and_return(true)
+    end
+    
+    it "returns an integer" do
+      Gandi::Domain::Zone.delete(zone_id).should be_true
+    end
+  end
+  
+  describe '.set' do
+    let(:zone_id) { 42 }
+    let(:domain_attributes) { domain_information_attributes_hash('fqdn' => fqdn, zone_id => zone_id) }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.set', fqdn, zone_id).and_return(domain_attributes)
+    end
+    
+    it "returns a domain hash" do
+      domain_hash = Gandi::Domain::Zone.set(fqdn, zone_id)
+      domain_hash.should == domain_attributes
+    end
+  end
+  
+  describe '.update' do
+    let(:zone_id) { 42 }
+    let(:zone_attributes) { domain_zone_info_attributes('id' => zone_id) }
+    let(:zone_params) { {'name' => "New Name"} }
+    
+    before do
+      @connection_mock.should_receive(:call).with('domain.zone.update', zone_id, zone_params).and_return(zone_attributes.merge(zone_params))
+    end
+    
+    it "returns a Zone hash" do
+      zone_hash = Gandi::Domain::Zone.update(zone_id, zone_params)
+      zone_hash['name'].should == "New Name"
+    end
+  end
+  
+  context 'given an instance' do
+    let(:zone_id) { 42 }
+    let(:zone_attributes) { domain_zone_info_attributes('id' => zone_id) }
+    let(:zone) { Gandi::Domain::Zone.new(zone_attributes) }
+    
+    subject { zone }
+    
+    it "can read its attributes" do
+      subject.to_hash.should == zone_attributes
+      subject['id'].should == zone_attributes['id']
+    end
+    
+    describe '#delete' do
+      before do
+        @connection_mock.should_receive(:call).with('domain.zone.delete', zone_id).and_return(true)
+      end
+      
+      it "returns true" do
+        subject.delete.should be_true
+      end
+    end
+    
+    describe '#update' do
+      let(:zone_update_params) { {'name' => "New Name"} }
+      
+      before do
+        @connection_mock.should_receive(:call).with('domain.zone.update', zone_id, zone_update_params).and_return(zone_attributes.merge(zone_update_params))
+      end
+      
+      it "returns self" do
+        subject.update(zone_update_params).should == subject
+      end
+      
+      it "updates its attributes" do
+        subject.update(zone_update_params)
+        subject['name'].should == zone_update_params['name']
+      end
+    end
+    
+    describe '#clone' do
+      before do
+        @connection_mock.should_receive(:call).with('domain.zone.clone', zone_id, 0, {}).and_return(zone_attributes.merge('id' => 44, 'name' => "Gandi Zone (1)"))
+      end
+      
+      it "returns a Zone object" do
+        cloned_zone = subject.clone
+        cloned_zone.should be_a(Gandi::Domain::Zone)
+        cloned_zone['name'].should == "Gandi Zone (1)"
+      end
+    end
+    
+  end
+end

data/spec/support/domain_macros.rb

@@ -96,6 +96,39 @@ module DomainMacros
   def domain_forward_attributes(source, destinations = ['john.doe@domain.tld', 'jane.doe@domain2.tld'])
     {'source' => source, 'destinations' => destinations}
   end
+  
+  def domain_zone_list_attributes(ext_attrs = {})
+    year, month, day, hour, min, sec = 1970, 1, 1, 1, 1, 1
+    {
+      "date_updated"=> XMLRPC::DateTime.new(year, month, day, hour, min, sec), 
+      "version"=>1, 
+      "id"=>1, 
+      "name"=>"Gandi Zone"
+    }.merge(ext_attrs)
+  end
+  
+  def domain_zone_info_attributes(ext_attrs = {})
+    year, month, day, hour, min, sec = 1970, 1, 1, 1, 1, 1
+    {
+      "date_updated"=> XMLRPC::DateTime.new(year, month, day, hour, min, sec), 
+      "versions"=>[1],
+      "version"=>1,
+      "domains" => 0,
+      "id"=>1, 
+      "owner" => "BACKEND1-GANDI",
+      "name"=>"Gandi Zone"
+    }.merge(ext_attrs)
+  end
+  
+  def domain_zone_record_creation_attributes(ext_attrs = {})
+    {
+      "name"=>"@", "type"=>"A", "value"=>"127.0.0.1", "ttl"=>10800
+    }.merge(ext_attrs)
+  end
+  
+  def domain_zone_record_attributes(ext_attrs = {})
+    domain_zone_record_creation_attributes('id' => 1).merge(ext_attrs)
+  end
 end
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gandirb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000Z
+date: 2012-02-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70245430 !ruby/object:Gem::Requirement
+  requirement: &74003420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70245430
+  version_requirements: *74003420
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70245170 !ruby/object:Gem::Requirement
+  requirement: &74003150 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70245170
+  version_requirements: *74003150
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70244870 !ruby/object:Gem::Requirement
+  requirement: &74002840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70244870
+  version_requirements: *74002840
 description: ! "  A Ruby library for using the Gandi XML-RPC API.\n  At the moment
   support is planned for the Domain, Contact and Operation APIs only, but Hosting
   and Catalog APIs support may be added in the future.\n"
@@ -63,8 +63,11 @@ files:
 - Rakefile
 - gandirb.gemspec
 - lib/gandi/contact.rb
+- lib/gandi/domain/zone/record.rb
+- lib/gandi/domain/zone/version.rb
 - lib/gandi/domain/forward.rb
 - lib/gandi/domain/nameservers.rb
+- lib/gandi/domain/zone.rb
 - lib/gandi/domain/transferin.rb
 - lib/gandi/domain/tld.rb
 - lib/gandi/domain/mailbox.rb
@@ -82,7 +85,10 @@ files:
 - spec/gandi/gandi_spec.rb
 - spec/gandi/connection_spec.rb
 - spec/gandi/operation_spec.rb
+- spec/gandi/domain/zone/version_spec.rb
+- spec/gandi/domain/zone/record_spec.rb
 - spec/gandi/domain/mailbox_spec.rb
+- spec/gandi/domain/zone_spec.rb
 - spec/gandi/domain/forward_spec.rb
 - spec/gandi/domain/host_spec.rb
 - spec/gandi/domain/tld_spec.rb
@@ -127,7 +133,10 @@ test_files:
 - spec/gandi/gandi_spec.rb
 - spec/gandi/connection_spec.rb
 - spec/gandi/operation_spec.rb
+- spec/gandi/domain/zone/version_spec.rb
+- spec/gandi/domain/zone/record_spec.rb
 - spec/gandi/domain/mailbox_spec.rb
+- spec/gandi/domain/zone_spec.rb
 - spec/gandi/domain/forward_spec.rb
 - spec/gandi/domain/host_spec.rb
 - spec/gandi/domain/tld_spec.rb