lumberg 1.0.1 → 2.0.0.pre4

data/spec/cpanel/base_spec.rb

@@ -0,0 +1,128 @@
+require "spec_helper"
+
+module Lumberg
+  describe Cpanel::Base do
+    before(:each) do
+      @login  = { :host => @whm_host, :hash => @whm_hash }
+      @server = Whm::Server.new(@login.dup)
+      @base   = Cpanel::Base.new(:server => @server, :api_username => "foodawg")
+    end
+
+    describe "::api_module" do
+      it "returns the class name (without module prefix)" do
+        described_class::api_module.should == "Base"
+      end
+
+      describe "AddonDomain subclass" do
+        class Lumberg::Cpanel::AddonDomain < Lumberg::Cpanel::Base; end
+        Lumberg::Cpanel::AddonDomain::api_module.should == "AddonDomain"
+      end
+    end
+
+    describe "#initialize" do
+      it "assigns api_username param to @api_username" do
+        @base.api_username.should == "foodawg"
+      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 = Cpanel::Base.new(:server => @login, :api_username => "foodawg")
+        base.server.should be_a(Whm::Server)
+      end
+
+    end
+
+    describe "#perform_request" do
+      let(:valid_options) {{
+        :api_username => "foodawg",
+        :api_module   => "SomeModule",
+        :api_function => "some_function"
+      }}
+
+      context "requires api_username" do
+        it "loads saved api_username if api_username not specified" do
+          @base.server.should_receive(:perform_request).with(
+            anything,
+            hash_including(
+              :cpanel_jsonapi_module   => "SomeModule",
+              :cpanel_jsonapi_func     => "some_function",
+              :cpanel_jsonapi_user     => "foodawg"
+            )
+          )
+          @base.perform_request(:api_module => "SomeModule", :api_function => "some_function")
+        end
+      end
+
+      context "optional api_version is specified" do
+        it "performs the request with specified API version" do
+          @base.server.should_receive(:perform_request).with(
+            anything,
+            hash_including(:cpanel_jsonapi_apiversion => 1234)
+          )
+          @base.perform_request(valid_options.merge(:api_version => 1234))
+        end
+      end
+
+      context "optional api_version is not specified" do
+        it "sets API version to 2" do
+          @base.server.should_receive(:perform_request).with(
+            anything,
+            hash_including(:cpanel_jsonapi_apiversion => 2)
+          )
+          @base.perform_request(valid_options)
+        end
+      end
+
+      context "optional key is specified" do
+        it "performs the request with specified key" do
+          @base.server.should_receive(:perform_request).with(
+            anything,
+            hash_including(:response_key => "some_key")
+          )
+          @base.perform_request(valid_options.merge(:response_key => "some_key"))
+        end
+      end
+
+      context "optional key is not specified" do
+        it "sets key to \"cpanelresult\"" do
+          @base.server.should_receive(:perform_request).with(
+            anything,
+            hash_including(:response_key => "cpanelresult")
+          )
+          @base.perform_request(valid_options)
+        end
+      end
+
+      it "performs the request with \"cpanel\" function" do
+        @base.server.should_receive(:perform_request).with("cpanel", anything)
+        @base.perform_request(valid_options)
+      end
+
+      it "accepts additional call parameters" do
+        @base.server.should_receive(:perform_request).with(
+          anything,
+          hash_including(:awesome => "sauce")
+        )
+        @base.perform_request(valid_options.merge({ :awesome => "sauce" }))
+      end
+
+      context "@api_username is not nil" do
+        it "uses @api_username as default for api_username param" do
+          @base.api_username = "foodawg"
+          @base.server.should_receive(:perform_request).with(
+            anything,
+            hash_including(:cpanel_jsonapi_user => "foodawg")
+          )
+
+          options = valid_options
+          options.delete(:api_username)
+          @base.perform_request(options)
+        end
+      end
+    end
+
+  end
+end

data/spec/cpanel/box_trapper_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+module Lumberg
+  describe Cpanel::BoxTrapper do
+    let(:server) { Whm::Server.new(:host => @whm_host, :hash => @whm_hash) }
+    let(:api_username) { "lumberg" }
+    let(:boxtrapper) do
+      described_class.new(
+        :server       => server,
+        :api_username => api_username
+      )
+    end
+
+    describe "#list" do
+      use_vcr_cassette("cpanel/box_trapper/list")
+
+      subject { boxtrapper.list[:params][:data] }
+
+      it { should be_an(Array) }
+    end
+  end
+end

data/spec/cpanel/branding_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+module Lumberg
+  describe Cpanel::Branding do
+    let(:server) { Whm::Server.new(:host => @whm_host, :hash => @whm_hash) }
+    let(:api_username) { "lumberg" }
+    let(:branding) do
+      described_class.new(
+        :server       => server,
+        :api_username => api_username
+      )
+    end
+
+    subject { branding }
+
+    describe "#list_pkgs" do
+      use_vcr_cassette("cpanel/branding/list_pkgs")
+
+      its(:list_pkgs) { should return_a_list }
+    end
+
+    describe "#list_sprites" do
+      use_vcr_cassette("cpanel/branding/list_sprites")
+
+      its(:list_sprites) { should return_a_list }
+    end
+
+    describe "#list_icons" do
+      use_vcr_cassette("cpanel/branding/list_icons")
+
+      its(:list_icons) { should return_a_list }
+    end
+
+    describe "#list_object_types" do
+      use_vcr_cassette("cpanel/branding/list_object_types")
+
+      its(:list_object_types) { should return_a_list }
+    end
+
+    describe "#list_image_types" do
+      use_vcr_cassette("cpanel/branding/list_image_types")
+
+      its(:list_image_types) { should return_a_list }
+    end
+  end
+end

data/spec/cpanel/contact_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+module Lumberg
+  describe Cpanel::Contact do
+    let(:server) { Whm::Server.new(:host => @whm_host, :hash => @whm_hash) }
+    let(:api_username) { "lumberg" }
+    let(:contact) do
+      described_class.new(
+        :server       => server,
+        :api_username => api_username
+      )
+    end
+
+    subject { contact }
+
+    describe "::api_module" do
+      subject { described_class::api_module }
+
+      it { should == "CustInfo" }
+    end
+
+    describe "#show" do
+      use_vcr_cassette("cpanel/contact/show", :record => :new_episodes)
+      subject { contact.show[:params][:data].first[:enabled] }
+      it { should == 1 }
+    end
+
+    describe "#update" do
+      let(:email_address) { "testing@lumberg-test.com" }
+      let(:result) { Hash.new }
+
+      use_vcr_cassette("cpanel/contact/update", :record => :new_episodes)
+
+      context "configure contact email address and enables notifications" do
+        it "should setup email address and bandwidth limit notification" do
+          res = contact.update({ :email => email_address, :bandwidth => 1 })
+
+          res[:params][:data].collect do |r|
+            if ((r[:name] == 'email') or (r[:name] == 'notify_bandwidth_limit'))
+              result[:"#{r[:name]}"] = r[:value]
+            end
+          end
+
+          result[:email].should === email_address
+          result[:notify_bandwidth_limit].should === 1
+        end
+      end
+    end
+  end
+end

data/spec/cpanel/cron_spec.rb

@@ -0,0 +1,161 @@
+require "spec_helper"
+
+module Lumberg
+  describe Cpanel::Cron do
+    let(:server) { Whm::Server.new(:host => @whm_host, :hash => @whm_hash) }
+    let(:api_username) { "lumberg" }
+    let(:cron) do
+      described_class.new(
+        :server       => server,
+        :api_username => api_username
+      )
+    end
+
+    describe "#set_email" do
+      let(:email) { "sauron@mordor.com" }
+
+      use_vcr_cassette("cpanel/cron/set_email")
+
+      it "sets cron notification email address" do
+        cron.set_email(:email => email)
+        cron.email[:params][:data][0][:email].should == email
+      end
+    end
+
+    describe "#email" do
+      let(:email) { "sauron@mordor.com" }
+
+      use_vcr_cassette("cpanel/cron/email")
+
+      before { cron.set_email(:email => email) }
+
+      it "gets cron notification email address" do
+        cron.email[:params][:data][0][:email].should == email
+      end
+    end
+
+    describe "#list" do
+      let(:command) { "hi" }
+
+      use_vcr_cassette("cpanel/cron/list")
+
+      before do
+        cron.add(
+          :command => command,
+          :minute  => 1,
+          :hour    => 1,
+          :day     => 1,
+          :month   => 1,
+          :weekday => 1
+        )
+      end
+
+      it "retrieves a list of crontab entries" do
+        cron.list[:params][:data].find {|e|
+          e[:command] == command
+        }.should include(
+          :command => command,
+          :minute  => "1",
+          :hour    => "1",
+          :day     => "1",
+          :month   => "1",
+          :weekday => "1"
+        )
+      end
+    end
+
+    describe "#add" do
+      let(:command) { "foo" }
+
+      use_vcr_cassette("cpanel/cron/add")
+
+      it "adds a crontab entry" do
+        cron.add(
+          :command => command,
+          :minute  => 1,
+          :hour    => 1,
+          :day     => 1,
+          :month   => 1,
+          :weekday => 1
+        )
+
+        cron.list[:params][:data].find {|e|
+          e[:command] == command
+        }.should include(
+          :command => command,
+          :minute  => "1",
+          :hour    => "1",
+          :day     => "1",
+          :month   => "1",
+          :weekday => "1"
+        )
+      end
+    end
+
+    describe "#remove" do
+      let(:command) { "baz" }
+      let(:linekey) do
+        cron.list[:params][:data].find {|e|
+          e[:command] == command
+        }[:linekey]
+      end
+
+      use_vcr_cassette("cpanel/cron/remove")
+
+      before do
+        cron.add(
+          :command => command,
+          :minute  => 1,
+          :hour    => 1,
+          :day     => 1,
+          :month   => 1,
+          :weekday => 1
+        )
+
+        cron.remove(:linekey => linekey)
+      end
+
+      it "removes a crontab entry" do
+        cron.list[:params][:data].find {|e|
+          e[:linekey] == linekey
+        }.should be_nil
+      end
+    end
+
+    describe "#edit" do
+      let(:command) { "whatev" }
+
+      use_vcr_cassette("cpanel/cron/edit")
+
+      before do
+        @linekey = cron.add(
+          :command => command,
+          :minute  => 1,
+          :hour    => 1,
+          :day     => 1,
+          :month   => 1,
+          :weekday => 1
+        )[:params][:data][0][:linekey]
+      end
+
+      it "edits a crontab entry" do
+        @linekey = cron.edit(
+          :linekey => @linekey,
+          :command => "taco",
+          :day     => 1,
+          :hour    => 3,
+          :minute  => 1,
+          :month   => 1,
+          :weekday => 1
+        )[:params][:data][0][:linekey]
+
+        cron.list[:params][:data].find {|e|
+          e[:linekey] == @linekey
+        }.should include(
+          :command => "taco",
+          :hour    => "3"
+        )
+      end
+    end
+  end
+end

data/spec/cpanel/dns_lookup_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+module Lumberg
+  describe Cpanel::DnsLookup do
+    let(:server) { Whm::Server.new(:host => @whm_host, :hash => @whm_hash) }
+    let(:api_username) { "lumberg" }
+    let(:dns_lookup) do
+      described_class.new(
+        :server       => server,
+        :api_username => api_username
+      )
+    end
+
+    describe "#name_to_ip" do
+      use_vcr_cassette "cpanel/dns_lookup/name_to_ip"
+
+      subject { dns_lookup.name_to_ip({ :domain => 'google.com' })[:params][:data] }
+
+      it { should be_an(Array) }
+    end
+  end
+end

data/spec/cpanel/domain_keys_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+module Lumberg
+  describe Cpanel::DomainKeys do
+    let(:server) { Whm::Server.new(:host => @whm_host, :hash => @whm_hash) }
+    let(:api_username) { "lumberg" }
+    let(:domain_keys) do
+      described_class.new(
+        :server       => server,
+        :api_username => api_username
+      )
+    end
+
+    describe "#installed" do
+      use_vcr_cassette "cpanel/domain_keys/installed"
+
+      it "checks if DomainKeys was installed for domain" do
+        domain_keys.installed[:params][:data][0][:installed].should == 1
+      end
+    end
+
+    describe "#available" do
+      use_vcr_cassette "cpanel/domain_keys/available"
+
+      it "checks if DomainKeys is available on local server" do
+        domain_keys.available[:params][:data][0][:available].should == 1
+      end
+    end
+
+    describe "#add" do
+      use_vcr_cassette "cpanel/domain_keys/add"
+
+      subject { domain_keys.add[:params][:data][0] }
+      it { should be_a(Hash) }
+    end
+
+    describe "#remove" do
+      use_vcr_cassette "cpanel/domain_keys/remove"
+
+      subject { domain_keys.add[:params][:data][0] }
+      it { should be_a(Hash) }
+    end
+
+  end
+end
+

data/spec/cpanel/domain_lookup_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+
+module Lumberg
+  describe Cpanel::DomainLookup do
+    let(:server) { Whm::Server.new(:host => @whm_host, :hash => @whm_hash) }
+    let(:api_username) { "lumberg" }
+    let(:domain_lookup) do
+      described_class.new(
+        :server       => server,
+        :api_username => api_username
+      )
+    end
+
+    let(:domain) { "lumberg-test.com" }
+    let(:document_root) { "/home/lumberg/public_html" }
+
+    describe "#list" do
+      use_vcr_cassette "cpanel/domain_lookup/list"
+
+      it "shows parked domains, addon domains and main domain" do
+        domain_lookup.list[:params][:data][0][:domain].should === domain
+      end
+    end
+
+    describe "#document_root" do
+      use_vcr_cassette "cpanel/domain_lookup/document_root"
+
+      it "gets DocumentRoot for domain" do
+        result = domain_lookup.document_root({ :domain => domain })
+
+        result[:params][:data][0][:docroot].should == document_root
+      end
+    end
+
+    describe "#docroot" do
+      use_vcr_cassette "cpanel/domain_lookup/docroot"
+
+      it "gets DocumentRoot for domain, as an alias for #document_root" do
+        result = domain_lookup.document_root({ :domain => domain })
+
+        result[:params][:data][0][:docroot].should == document_root
+      end
+    end
+
+
+    describe "#document_roots" do
+      use_vcr_cassette "cpanel/domain_lookup/document_roots"
+
+      subject { domain_lookup.document_roots[:params][:data] }
+
+      it "gets DocumentRoot for all domains" do
+        should be_an(Array)
+      end
+    end
+
+    describe "#docroots" do
+      use_vcr_cassette "cpanel/domain_lookup/docroots"
+
+      subject { domain_lookup.document_roots[:params][:data] }
+
+      it "gets DocumentRoot for all domains, as an alias for #document_roots" do
+        should be_an(Array)
+      end
+    end
+
+    describe "#count" do
+      use_vcr_cassette "cpanel/domain_lookup/count"
+
+      it "gets the total number of domains associated within a Cpanel account" do
+        result = domain_lookup.count
+
+        result[:params][:data][0][:count].should > 0
+      end
+    end
+
+  end
+end