lumberg 0.9.5

data/spec/whm/args_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+require 'lumberg/whm/args'
+
+module Lumberg
+  describe Whm::Args do
+    context "required_parms" do
+      it "raises an error when missing" do
+        options = {:arg1 => true}
+        args = lambda { 
+          Whm::Args.new(options) do |c|
+            c.requires :arg2
+          end
+        }
+        expect { args.call }.to raise_error(WhmArgumentError, /Missing required parameter: arg2/)
+      end
+
+      it "does not raise an error with valid params" do
+        options = {:arg1 => true}
+        args =  Whm::Args.new(options) { |c|
+          c.requires :arg1
+        }
+
+        args.required_params.should have(1).value
+        args.required_params.should include(:arg1)
+      end
+
+      it "sets optional_params" do
+        options = {:arg1 => true, :arg2 => 2}
+        args =  Whm::Args.new(options) { |c|
+          c.requires :arg1, :arg2
+        }
+
+        args.optional_params.should have(2).values
+        args.required_params.should have(2).values
+
+        args.optional_params.should include(*args.required_params)
+      end
+
+      it "does not set boolean_params" do
+        options = {:arg1 => true, :arg2 => 2}
+        args =  Whm::Args.new(options) { |c|
+          c.requires :arg1, :arg2
+        }
+
+        args.boolean_params.should be_empty
+      end
+    end
+
+    context "boolean_params" do
+      it "raises an error when the param is not boolean" do
+        options = {:arg1 => 'string'}
+        args = lambda { 
+          Whm::Args.new(options) do |c|
+            c.booleans :arg1
+          end
+        }
+        expect { args.call }.to raise_error(WhmArgumentError, /Boolean parameter must be.*: arg1/)
+      end
+
+      it "raises an error with boolean params" do
+        options = {:arg1 => true}
+        args =  Whm::Args.new(options) { |c|
+          c.booleans :arg1
+        }
+
+        args.boolean_params.should have(1).value
+        args.boolean_params.should include(:arg1)
+      end
+
+      it "sets optional_params" do
+        options = {:arg1 => true, :arg2 => false}
+        args =  Whm::Args.new(options) { |c|
+          c.booleans :arg1, :arg2
+        }
+
+        args.optional_params.should have(2).values
+        args.boolean_params.should have(2).values
+
+        args.optional_params.should include(:arg1, :arg2)
+      end
+
+      it "sets required_params" do
+        options = {:arg1 => true, :arg2 => false}
+        args =  Whm::Args.new(options) { |c|
+          c.booleans :arg1, :arg2
+        }
+
+        args.required_params.should be_empty
+      end
+    end
+
+    context "optional_params" do
+      it "raises an error with unknown params" do
+        options = {:arg1 => true}
+        args = lambda { 
+          Whm::Args.new(options) do |c|
+            c.optionals :arg2
+          end
+        }
+
+        expect { args.call }.to raise_error(WhmArgumentError, /Not a valid parameter: arg1/)
+      end
+
+      it "does not raise an error with known params" do
+        options = {:arg1 => true, :arg2 => 2}
+        args =  Whm::Args.new(options) { |c|
+          c.optionals :arg1, :arg2
+        }
+
+        args.optional_params.should have(2).values
+        args.optional_params.should include(:arg1, :arg2)
+      end
+
+      it "does not set required_params" do
+        options = {:arg1 => true, :arg2 => 2}
+        args =  Whm::Args.new(options) { |c|
+          c.optionals :arg1, :arg2
+        }
+        
+        args.required_params.should be_empty
+      end
+
+      it "does not set boolean_params" do
+        options = {:arg1 => true, :arg2 => 2}
+        args =  Whm::Args.new(options) { |c|
+          c.optionals :arg1, :arg2
+        }
+        
+        args.boolean_params.should be_empty
+      end
+    end
+
+    context "one_of" do
+      it "allows one arg" do
+        options = {:arg1 => true}
+        args = lambda {
+          Whm::Args.new(options) do |c|
+            c.one_of :arg1
+          end
+        }
+
+        expect { args.call }.to raise_error(WhmArgumentError, /One of requires two or more items/)
+      end
+
+      it "allows two or more args" do
+        options = {:arg1 => true}
+
+        args = Whm::Args.new(options) do |c|
+          c.one_of :arg1, :arg2
+        end
+
+        args.one_of_params.should have(2).values
+        args.one_of_params.should include(:arg1, :arg2)
+      end
+
+      it "does not allow 0 params" do
+        options = {}
+        args = lambda {
+          Whm::Args.new(options) do |c|
+            c.one_of :arg1, :arg2
+          end
+        }
+
+        expect { args.call }.to raise_error(WhmArgumentError, /The parameters may include only one of 'arg1, arg2'/)
+      end
+
+      it "does not allow both args" do
+        options = {:arg1 => true, :arg2 => 2}
+        args = lambda {
+          Whm::Args.new(options) do |c|
+            c.one_of :arg1, :arg2
+          end
+        }
+
+        expect { args.call }.to raise_error(WhmArgumentError, /The parameters may include only one of 'arg1, arg2'/)
+      end
+    end
+  end
+end

data/spec/whm/base_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'lumberg/whm'
+
+module Lumberg
+  describe Whm::Base do
+    before(:each) do
+      @login    = { :host => @whm_host, :hash => @whm_hash }
+      @server   = Whm::Server.new(@login.dup)
+      @base = Whm::Base.new(:server => @server)
+    end
+
+    describe "#initialize" do
+      it "creates a new instance of server" do
+        expect { Whm::Base.new }.to raise_error(WhmArgumentError, /Missing required param/)
+      end
+
+      it "allows a server instance to be passed in" do
+        @base.server.should be_a(Whm::Server)
+      end
+
+      it "allows a server hash to be passed in" do
+        base = Whm::Base.new(:server => @login)
+        base.server.should be_a(Whm::Server)
+      end
+    end
+
+  end
+end

data/spec/whm/dns_spec.rb

@@ -0,0 +1,352 @@
+require 'spec_helper'
+require 'lumberg/whm'
+
+module Lumberg
+  describe Whm::Dns do
+    before(:each) do
+      @login    = { :host => @whm_host, :hash => @whm_hash }
+      @server   = Whm::Server.new(@login.dup)
+      @dns      = Whm::Dns.new(:server => @server.dup)
+    end
+
+    describe "#addzone" do
+      it "requires a domain" do
+        @dns.stub(:perform_request)
+        requires_attr('domain') { @dns.add_zone }
+      end
+
+      it "requires an ip" do
+        requires_attr('ip') { @dns.add_zone(:domain => 'example.com') } 
+      end
+
+      it "allows template" do
+        @dns.server.stub(:perform_request)
+        @dns.add_zone(:domain => 'example.com', :ip => '127.0.0.1', :template => 'something')
+      end
+
+      it "allows trueowner" do
+        @dns.server.stub(:perform_request)
+        @dns.add_zone(:domain => 'example.com', :ip => '127.0.0.1', :trueowner => 'something')
+      end
+
+      use_vcr_cassette "whm/dns/adddns"
+
+      it "creates a zone" do
+        result = @dns.add_zone(:domain => 'example.com', :ip => '192.1.2.3')
+        result[:success].should be_true
+        result[:message].should match(/added example\.com .*user root.*/i)
+      end
+
+      it "creates a zone under a user" do
+        result = @dns.add_zone(:domain => 'example.com', :ip => '192.1.2.3', :trueowner => 'something')
+        result[:success].should be_true
+        result[:message].should match(/added example\.com .*user something.*/i)
+      end
+    end
+
+    describe "#addzonerecord" do
+      it "requires a zone" do
+        requires_attr('zone') { @dns.add_zone_record }
+      end
+
+      use_vcr_cassette "whm/dns/addzonerecord"
+
+      it "adds a zone record" do
+        result = @dns.add_zone_record(:zone => 'example.com', 
+                                      :name => 'example.com.',
+                                      :address => '192.1.2.3',
+                                      :type => 'A')
+        result[:success].should be_true
+        result[:message].should match(/Bind reloading on .*example.com/i)
+      end
+
+      it "adds a zone record reverse" do
+        result = @dns.add_zone_record(:zone => 'example.com',
+                                      :name => '1',
+                                      :ptdrname => 'example.com',
+                                      :type => 'PTR')
+        result[:success].should be_true
+        result[:message].should match(/Bind reloading on .*example.com/i)
+      end
+    end
+
+    describe "#listzones" do
+      use_vcr_cassette "whm/dns/listzones"
+
+      it "lists all the zones" do
+        result = @dns.list_zones
+        params = result[:params]
+        params.size.should == 2
+        params[0][:zonefile].should == "thisisathrowawayagain22.com.db"
+        params[0][:domain].should == "thisisathrowawayagain22.com"
+      end
+    end
+
+    describe "#getzonerecord" do
+      use_vcr_cassette "whm/dns/getzonerecord"
+
+      it "requires a domain" do
+        requires_attr('domain') { @dns.get_zone_record(:Line => 1) }
+      end
+
+      it "requires a Line" do
+        requires_attr('Line') { @dns.get_zone_record(:domain => "example.com") }
+      end
+
+      it "returns the zone" do
+        result = @dns.get_zone_record(:domain => "example.com", :Line => 1)
+        result[:success].should be_true
+        result[:message].should match(/Record obtained/i)
+        result[:params][:record][:Line].should == 1
+        result[:params][:record][:raw].should == "; cPanel 11.25.0-STABLE_44718"
+      end
+
+      it "returns an error when the domain was not found" do
+        result = @dns.get_zone_record(:domain => "notexists.com", :Line => 1)
+        result[:success].should_not be_true
+        result[:message].should match(/Zone does not exist/i)
+      end
+
+      it "returns an error for a line with no data" do
+        result = @dns.get_zone_record(:domain => "example.com", :Line => 20)
+        result[:success].should be_false
+        result[:message].should match(/No record available on selected line/i)
+      end
+    end
+
+    describe "#dumpzone" do
+      use_vcr_cassette "whm/dns/dumpzone"
+
+      it "requires a domain" do
+        requires_attr('domain') { @dns.dump_zone }
+      end
+
+      it "dumps the zone" do
+        result = @dns.dump_zone(:domain => "example.com")
+        result[:success].should be_true
+        result[:message].should match(/Zone Serialized/i)
+        result[:params][:record][0][:raw].should match(/; cPanel first:11\.25\.0-STABLE_44718 latest:11\.28\.64-STABLE_51024 Cpanel::ZoneFile::VERSION:1\.3 mtime:1299509628/i)
+        result[:params][:record][20][:ttl].should == "14400"
+      end
+
+      it "returns an error when the domain is not found" do
+        result = @dns.dump_zone(:domain => "notexists.com")
+        result[:success].should be_false
+        result[:message].should match(/Zone does not exist/i)
+      end
+    end
+
+    describe "#resolvedomainname" do
+      use_vcr_cassette "whm/dns/resolvedomainname"
+
+      it "requires a domain" do
+        requires_attr('domain') { @dns.resolve_domain("api.version".to_sym => 1) }
+      end
+
+      it "requires the api version" do
+        requires_attr('api.version') { @dns.resolve_domain(:domain => "example.com") }
+      end
+
+      it "returns the ip address of the domain" do
+        result = @dns.resolve_domain(:domain => "example.com", "api.version".to_sym => 1)
+        result[:params][:ip].should == "192.1.2.3"
+      end
+
+      it "returns an error when the ip address cannot be determined" do
+        result = @dns.resolve_domain(:domain => "notexists.com", "api.version".to_sym => 1)
+        result[:params][:ip].should be_nil
+        result[:message].should match(/Unable to resolve domain name/i)
+      end
+    end
+
+    describe "#editzonerecord" do
+      use_vcr_cassette "whm/dns/editzonerecord"
+
+      it "requires a domain" do
+        requires_attr('domain') { @dns.edit_zone_record(:Line => 1) }
+      end
+
+      it "requires a Line" do
+        requires_attr('Line') { @dns.edit_zone_record(:domain => "example.com") }
+      end
+
+      it "updates the zone record" do
+        result = @dns.edit_zone_record(:domain => "example.com", :Line => 1, :ttl => "86400")
+        result[:success].should be_true
+        result[:message].should match(/Bind reloading on .* using rndc zone.*example.com/i)
+      end
+
+      it "returns an error for an unknown domain or invalid Line" do
+        result = @dns.edit_zone_record(:domain => "notexists.com", :Line => 1, :ttl => "86400")
+        result[:success].should be_false
+        result[:message].should match(/Failed to serialize record/i)
+      end
+
+      it "returns an error for an invalid Line" do
+        result = @dns.edit_zone_record(:domain => "example.com", :Line => 200, :ttl => "86400")
+        result[:success].should be_false
+        result[:message].should match(/Failed to serialize record/i)
+      end
+    end
+
+    describe "#killdns" do
+      use_vcr_cassette "whm/dns/killdns"
+
+      it "requires a domain" do
+        requires_attr('domain') { @dns.kill_dns }
+      end
+
+      it "kills the dns" do
+        result = @dns.kill_dns(:domain => "example.com")
+        result[:success].should be_true
+        result[:message].should match(/Zones Removed/i)
+      end
+
+      it "returns an error when the domain does not exist" do
+        result = @dns.kill_dns(:domain => "notexists.com")
+        result[:success].should be_false
+        result[:message].should match(/Unable to remove zone that does not exist/i)
+      end
+    end
+
+    describe "#lookupnsip" do
+      use_vcr_cassette "whm/dns/lookupnsip"
+
+      it "requires a nameserver" do
+        requires_attr('nameserver') { @dns.lookup_nameserver_ip }
+      end
+
+      it "returns the nameserver's ip" do
+        result = @dns.lookup_nameserver_ip(:nameserver => "example.com")
+        result[:params][:ip].should == "192.1.2.3"
+      end
+
+      it "returns null if the ip cannot be determined" do
+        result = @dns.lookup_nameserver_ip(:nameserver => "notexists.com")
+        result[:params][:ip].should be_nil
+      end
+    end
+
+    describe "#removezonerecord" do
+      use_vcr_cassette "whm/dns/removezonerecord"
+
+      it "requires a zone" do
+        requires_attr('zone') { @dns.remove_zone_record(:Line => 1) }
+      end
+
+      it "requires a Line" do
+        requires_attr('Line') { @dns.remove_zone_record(:zone => "example.com") }
+      end
+
+      it "removes the zone record" do
+        result = @dns.remove_zone_record(:zone => "example.com", :Line => 1)
+        result[:success].should be_true
+        result[:message].should match(/Bind reloading on .*example.com/i)
+      end
+
+      it "returns an error for an unknown zone " do
+        result = @dns.remove_zone_record(:zone => "notexists.com", :Line => 1)
+        result[:success].should be_false
+        result[:message].should match(/Unable to find a record on specified line/i)
+      end
+
+      it "returns an error for an invalid line" do
+        result = @dns.remove_zone_record(:zone => "example.com", :Line => 200)
+        result[:success].should be_false
+        result[:message].should match(/Unable to find a record on specified line/i)
+      end
+    end
+
+    describe "#resetzone" do
+      use_vcr_cassette "whm/dns/resetzone"
+
+      it "requires a domain" do
+        requires_attr('domain') { @dns.reset_zone(:zone => "example.com") }
+      end
+
+      it "requires a zone" do
+        requires_attr('zone') { @dns.reset_zone(:domain => "example.com") }
+      end
+
+      it "resets the zone" do
+        result = @dns.reset_zone(:domain => "example.com", :zone => "example.com")
+        result[:success].should be_true
+        result[:message].should match(/Bind reloading on .*example.com/i)
+      end
+
+      it "returns an error for an unknown domain" do
+        result = @dns.reset_zone(:domain => "notexists.com", :zone => "notexists.com")
+        result[:success].should be_false
+        result[:message].should match(/Unable to determine the IP address for notexists.com/i)
+      end
+    end
+
+    describe "#listmxs" do
+      use_vcr_cassette "whm/dns/listmxs"
+
+      it "requires a domain" do
+        requires_attr('domain') { @dns.list_mxs("api.version".to_sym => 1) }
+      end
+
+      it "requires the api.version" do
+        requires_attr('api.version') { @dns.list_mxs(:domain => "example.com") }
+      end
+
+      it "returns a list of mxs" do
+        result = @dns.list_mxs(:domain => "example.com", "api.version".to_sym => 1)
+        result[:params][:record].should be_a_kind_of Array
+        result[:params][:record].size.should == 1
+        result[:params][:record].first[:exchange].should == "example.com"
+        result[:params][:record].first[:name].should == "example.com."
+      end
+    end
+
+    describe "#savemxs" do
+      use_vcr_cassette "whm/dns/savemxs"
+
+      it "requires the api.version" do
+        requires_attr('api.version') { @dns.save_mx(:domain => "example.com", 
+                                                    :name => "mail.example.com", 
+                                                    :exchange => "example.com", 
+                                                    :preference => 10) }
+      end
+
+      it "requires a domain" do
+        requires_attr('domain') { @dns.save_mx("api.version".to_sym => 1, 
+                                               :name => "mail.example.com", 
+                                               :exchange => "example.com", 
+                                               :preference => 10) }
+      end
+
+      it "requires a name" do
+        requires_attr('name') { @dns.save_mx("api.version".to_sym => 1, 
+                                             :domain => "example.com", 
+                                             :exchange => "example.com", 
+                                             :preference => 10) }
+      end
+
+      it "requires an exchange" do
+        requires_attr('exchange') { @dns.save_mx("api.version".to_sym => 1, 
+                                                 :domain => "example.com", 
+                                                 :name => "mail.example.com", 
+                                                 :preference => 10) }
+      end
+
+      it "requires a preference" do
+        requires_attr('preference') { @dns.save_mx("api.version".to_sym => 1, 
+                                                   :domain => "example.com", 
+                                                   :name => "mail.example.com", 
+                                                   :exchange => "example.com") }
+      end
+
+      it "saves the mx record" do
+        result = @dns.save_mx("api.version".to_sym => 1, 
+                              :domain => "example.com", 
+                              :name => "mail.example.com", 
+                              :exchange => "example.com", 
+                              :preference => 10)
+        result[:message].should match(/Bind reloading on .*example.com/i)
+      end
+    end
+  end
+end