plesk_lib 0.0.1

data/spec/actions/create_reseller_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::CreateReseller do
+  let(:reseller_attributes) do
+    { password: 'reseller_secret', phone: '0000000000',
+      email: 'noreply@ausupport.com.au', country: 'AU',
+      person_name: 'Reseller Name', company_name: 'Reseller Company',
+      service_plan_id: 2 }
+  end
+
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+  let(:reseller) { PleskLib::Reseller.new('reseller99', reseller_attributes) }
+
+  context 'when login is available on the plesk server' do
+    it 'should create a reseller' do
+      VCR.use_cassette 'reseller/minimal', match_requests_on: [:method, :uri, :body] do
+        action = PleskLib::Actions::CreateReseller.new(reseller)
+        action.execute_on(server)
+
+        action.plesk_id.to_i.should > 0
+      end
+    end
+  end
+
+  context 'when login is already taken' do
+    it 'should raise a LoginAlreadyTaken exception' do
+      VCR.use_cassette 'reseller/minimal_exists', match_requests_on: [:method, :uri, :body] do
+        action = PleskLib::Actions::CreateReseller.new(reseller)
+        expect {
+          action.execute_on(server)
+        }.to raise_error(PleskLib::LoginAlreadyTaken)
+      end
+    end
+  end
+end

data/spec/actions/create_service_plan_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::CreateServicePlan do
+  let(:service_plan_config) { { mailboxes: 3, domains: 3, traffic: 3, storage: 3 } }
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+  let(:service_plan) { PleskLib::ServicePlan.new('An Admin Service Plan', service_plan_config) }
+
+  it 'should create a service plan' do
+    VCR.use_cassette 'service_plan/create_minimal', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::CreateServicePlan.new(service_plan)
+      action.execute_on(server)
+
+      action.plesk_id.to_i.should > 0
+      action.guid.length.should == 36 #guid is 36 characters long
+    end
+  end
+
+  context 'when a reseller is given' do
+    let(:service_plan_config) { { mailboxes: 3, domains: 3, traffic: 3,
+                                  storage: 3, external_id: 'external-3',
+                                  owner_id: 3 } }
+    let(:service_plan) { PleskLib::ServicePlan.new('A New Reseller Service Plan', service_plan_config) }
+    it 'should create a service plan for a reseller' do
+      VCR.use_cassette 'service_plan/create_minimal_with_owner', match_requests_on: [:method, :uri, :body] do
+        action = PleskLib::Actions::CreateServicePlan.new(service_plan)
+        action.execute_on(server)
+
+        action.plesk_id.to_i.should > 0
+        action.guid.length.should == 36 #guid is 36 characters long
+      end
+    end
+  end
+end

data/spec/actions/create_subscription_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::CreateSubscription do
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+  let(:subscription) { PleskLib::Subscription.new({ name: 'foo-domain.de',
+                                                    ip_address: '10.0.0.158',
+                                                    owner_id: 3,
+                                                    service_plan_id: 10,
+                                                    ftp_login: 'ftp01',
+                                                    ftp_password: 'ftpPass01' }) }
+
+  it 'should create a reseller' do
+    VCR.use_cassette 'subscription/create', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::CreateSubscription.new(subscription)
+      action.execute_on(server)
+
+      action.plesk_id.to_i.should > 0
+      action.guid.length.should == 36
+    end
+  end
+end

data/spec/actions/get_statistics_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::GetStatistics do
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+
+  it 'should return a statistics hash' do
+    VCR.use_cassette 'server/get_statistics', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::GetStatistics.new
+      action.execute_on(server)
+
+      action.statistics.should_not be_empty
+      action.statistics[:objects].should_not be_empty
+    end
+  end
+end

data/spec/actions/list_customers_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::ListCustomers do
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+
+  it 'should list all customers' do
+    VCR.use_cassette 'customer/list_customers', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::ListCustomers.new
+      action.execute_on(server)
+
+      action.customers.count.should == 4
+      action.customers.each do |customer|
+        customer.login.should_not be_empty
+        customer.status.should == 0
+      end
+    end
+  end
+
+  it 'should list customers of owner 3' do
+    VCR.use_cassette 'customer/list_customers_filtered', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::ListCustomers.new(3)
+      action.execute_on(server)
+
+      action.customers.count.should == 2
+      action.customers.each do |customer|
+        customer.login.should_not be_empty
+        customer.status.should == 0
+      end
+    end
+  end
+end

data/spec/actions/list_service_plans_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::ListServicePlans do
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+
+  it 'should list all service plans' do
+    VCR.use_cassette 'service_plan/list_all', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::ListServicePlans.new
+      action.execute_on(server)
+
+      action.service_plans.count.should == 9
+      action.service_plans.each do |service_plan|
+        service_plan.id.should be_present
+        service_plan.guid.length.should == 36
+      end
+    end
+  end
+
+  it 'should list the admin service plans' do
+    VCR.use_cassette 'service_plan/list_admin', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::ListServicePlans.new(1)
+      action.execute_on(server)
+
+      action.service_plans.count.should == 6
+      action.service_plans.each do |service_plan|
+        service_plan.id.should be_present
+        service_plan.guid.length.should == 36
+      end
+    end
+  end
+end

data/spec/actions/list_subscriptions.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::ListSubscriptions do
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+
+  it 'should list all subscriptions' do
+    VCR.use_cassette 'subscription/list_subscriptions', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::ListSubscriptions.new
+      action.execute_on(server)
+
+      action.subscriptions.count.should == 3
+      action.subscriptions.each do |subscription|
+        subscription.id.to_i.should > 0
+        subscription.guid.length.should == 36
+      end
+    end
+  end
+
+  it 'should list subscriptions of owner 4' do
+    VCR.use_cassette 'subscription/list_subscriptions_filtered', match_requests_on: [:method, :uri, :body] do
+      action = PleskLib::Actions::ListSubscriptions.new(4)
+      action.execute_on(server)
+
+      action.subscriptions.count.should == 2
+      action.subscriptions.each do |subscription|
+        subscription.id.to_i.should > 0
+        subscription.guid.length.should == 36
+      end
+    end
+  end
+end

data/spec/customer_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe PleskLib::Customer do
+  context 'with login and password given to intializer' do
+    subject { PleskLib::Customer.new('the_login', { password: 'the_password' }) }
+
+    it { should respond_to(:company_name) }
+    it { should respond_to(:person_name) }
+    it { should respond_to(:login) }
+    it { should respond_to(:password) }
+
+    its(:login) { should eql 'the_login' }
+    its(:password) { should eql 'the_password' }
+
+    it 'should be initializable with only the login' do
+      expect {
+        PleskLib::Customer.new('the_login')
+      }.not_to raise_error
+    end
+  end
+end

data/spec/reseller_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe PleskLib::Reseller do
+  context 'with login and password given to intializer' do
+    subject { PleskLib::Reseller.new('the_login', { password: 'the_password' }) }
+
+    it { should respond_to(:company_name) }
+    it { should respond_to(:person_name) }
+    it { should respond_to(:login) }
+    it { should respond_to(:password) }
+    it { should respond_to(:service_plan_id) }
+
+    its(:login) { should eql 'the_login' }
+    its(:password) { should eql 'the_password' }
+
+    it 'should be initializable with only the login' do
+      expect {
+        PleskLib::Reseller.new('the_login')
+      }.not_to raise_error
+    end
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe PleskLib::Server do
+  subject { PleskLib::Server.new('10.0.0.1', 'admin', 'secret') }
+
+  its(:host)     { should eql '10.0.0.1' }
+  its(:username) { should eql 'admin'    }
+  its(:password) { should eql 'secret'   }
+
+  describe '#create_customer' do
+    it 'uses the PleskLib::Actions::CreateCustomer action' do
+      customer = double(:customer)
+      PleskLib::Actions::CreateCustomer.should_receive(:new).with(customer).and_call_original
+      PleskLib::Actions::CreateCustomer.any_instance.should_receive(:execute_on).with(subject)
+
+      subject.create_customer(customer)
+    end
+  end
+
+  describe '#create_reseller' do
+    it 'uses the PleskLib::Actions::CreateReseller action' do
+      reseller = double(:reseller)
+      PleskLib::Actions::CreateReseller.should_receive(:new).with(reseller).and_call_original
+      PleskLib::Actions::CreateReseller.any_instance.should_receive(:execute_on).with(subject)
+
+      subject.create_reseller(reseller)
+    end
+  end
+
+  describe '#change_customer_password' do
+    it 'uses the PleskLib::Actions::ChangeCustomerPassword action' do
+      customer = double(:customer)
+      PleskLib::Actions::ChangeCustomerPassword.should_receive(:new).with(customer, 'new_password').and_call_original
+      PleskLib::Actions::ChangeCustomerPassword.any_instance.should_receive(:execute_on).with(subject)
+
+      subject.change_customer_password(customer, 'new_password')
+    end
+  end
+
+  describe '#get_statistics' do
+    it 'uses the PleskLib::Actions::GetStatistics action' do
+      PleskLib::Actions::GetStatistics.should_receive(:new).and_call_original
+      PleskLib::Actions::GetStatistics.any_instance.should_receive(:execute_on).with(subject)
+
+      subject.get_statistics
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'plesk_lib'
+require 'webmock/rspec'
+require 'vcr'
+require 'pry'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = File.expand_path('../vcr', __FILE__)
+  c.hook_into :webmock
+end

data/spec/vcr/customer/change_password_existing_user.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://10.0.0.158:8443/enterprise/control/agent.php
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><packet version="1.6.3.5"><customer><set><filter><login>user91</login></filter><values><gen_info><passwd>new_password</passwd></gen_info></values></set></customer></packet>
+    headers:
+      http_auth_login:
+      - admin
+      http_auth_passwd:
+      - ccsnDxnWy2j0
+      content-type:
+      - text/xml
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - sw-cp-server
+      date:
+      - Wed, 12 Mar 2014 20:17:26 GMT
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      p3p:
+      - CP="NON COR CURa ADMa OUR NOR UNI COM NAV STA"
+      last-modified:
+      - Wed, 12 Mar 2014 20:17:26 GMT
+      expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma:
+      - no-cache
+      set-cookie:
+      - PHPSESSID=184c4beab99b0cc115749f6e00a95e9b; path=/; secure; httponly
+      - locale=en-US; expires=Thu, 12-Mar-2015 20:17:26 GMT; path=/
+    body:
+      encoding: UTF-8
+      string: |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <packet version="1.6.3.5"><customer><set><result><status>ok</status><filter-id>user91</filter-id><id>11</id></result></set></customer></packet>
+    http_version: '1.1'
+  recorded_at: Sat, 15 Mar 2014 14:24:16 GMT
+recorded_with: VCR 2.8.0

data/spec/vcr/customer/change_password_missing_user.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://10.0.0.158:8443/enterprise/control/agent.php
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><packet version="1.6.3.5"><customer><set><filter><login>unknownuser</login></filter><values><gen_info><passwd>new_password</passwd></gen_info></values></set></customer></packet>
+    headers:
+      http_auth_login:
+      - admin
+      http_auth_passwd:
+      - ccsnDxnWy2j0
+      content-type:
+      - text/xml
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - sw-cp-server
+      date:
+      - Wed, 12 Mar 2014 20:18:10 GMT
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      p3p:
+      - CP="NON COR CURa ADMa OUR NOR UNI COM NAV STA"
+      last-modified:
+      - Wed, 12 Mar 2014 20:18:09 GMT
+      expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma:
+      - no-cache
+      set-cookie:
+      - PHPSESSID=d5e0d8ca4bc8935a16135e3642ae7175; path=/; secure; httponly
+      - locale=en-US; expires=Thu, 12-Mar-2015 20:18:09 GMT; path=/
+    body:
+      encoding: UTF-8
+      string: |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <packet version="1.6.3.5"><customer><set><result><status>error</status><errcode>1013</errcode><errtext>client does not exist</errtext><filter-id>unknownuser</filter-id></result></set></customer></packet>
+    http_version: '1.1'
+  recorded_at: Sat, 15 Mar 2014 14:24:59 GMT
+recorded_with: VCR 2.8.0