plesk_lib 0.0.1

data/lib/plesk_lib/actions/create_subscription.rb

@@ -0,0 +1,55 @@
+class PleskLib::Actions::CreateSubscription < PleskLib::Actions::Base
+  attr_reader :subscription, :plesk_id, :guid
+
+  def initialize(subscription)
+    @subscription = subscription
+  end
+
+  #  Creates Object & Packet
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.packet(:version => '1.6.3.5') {
+      xml.webspace {
+        xml.add {
+          xml.gen_setup{
+            xml.name(subscription.name)
+            if subscription.owner_id.present?
+              xml.tag!('owner-id', subscription.owner_id)
+            end
+            if subscription.owner_login.present?
+              xml.tag!('owner-login', subscription.owner_login)
+            end
+            xml.ip_address(subscription.ip_address)
+          }
+          xml.hosting{
+            xml.vrt_hst{
+              xml.property{
+                xml.name('ftp_login')
+                xml.value(subscription.ftp_login)
+              }
+              xml.property{
+                xml.name('ftp_password')
+                xml.value(subscription.ftp_password)
+              }
+              xml.ip_address(subscription.ip_address)
+            }
+          }
+          if subscription.service_plan_id.present?
+            xml.tag!('plan-id', subscription.service_plan_id)
+          end
+          if subscription.service_plan_name.present?
+            xml.tag!('plan-name', subscription.service_plan_name)
+          end
+        }
+      }
+    }
+    xml.target!
+  end
+
+  def analyse(xml_document)
+    add_node = xml_document.root.locate('*/result').first
+    @plesk_id = add_node.id.text.to_i
+    @guid = add_node.guid.text
+  end
+end

data/lib/plesk_lib/actions/get_statistics.rb

@@ -0,0 +1,61 @@
+class PleskLib::Actions::GetStatistics < PleskLib::Actions::Base
+  attr_reader :statistics
+
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.packet(:version => '1.6.3.5') {
+      xml.server{
+        xml.get{
+          xml.stat()
+        }
+      }
+    }
+    return xml.target!
+  end
+
+  def analyse(xml_document)
+    status_root = xml_document.root.server.get.result.stat
+    @statistics = {}
+    object_stats = {}
+    device_stats = {}
+
+    status_root.objects.nodes.each do |node|
+      object_stats[node.name] = node.text.to_i
+    end
+
+    status_root.load_avg.nodes.each do |node|
+      @statistics[node.name] = node.text.to_f / 100
+    end
+
+    status_root.mem.nodes.each do |node|
+      @statistics['mem_' + node.name] = BigDecimal.new(node.text)
+    end
+
+    status_root.swap.nodes.each do |node|
+      @statistics['swap_' + node.name] = BigDecimal.new(node.text)
+    end
+
+    status_root.diskspace.nodes.each do |device_node|
+      device_name = nil, device_attrs = {}
+      device_node.nodes.each do |attr_node|
+        if attr_node.name == 'name'
+          device_name = attr_node.text
+        else
+          device_attrs[attr_node.name] = BigDecimal.new(attr_node.text)
+        end
+      end
+      device_stats[device_name] = device_attrs
+    end
+
+    status_root.version.nodes.each do |node|
+      @statistics[node.name] = node.text
+    end
+
+    status_root.other.nodes.each do |node|
+      @statistics[node.name] = node.name == 'uptime' ? node.text.to_i : node.text
+    end
+
+    @statistics.merge!({objects: object_stats, devices: device_stats})
+  end
+end

data/lib/plesk_lib/actions/list_customers.rb

@@ -0,0 +1,51 @@
+class PleskLib::Actions::ListCustomers < PleskLib::Actions::Base
+  attr_reader :customers
+
+  MAPPING = {
+    'cr_date' => 'created_at', 'cname' => 'company_name', 'pname' => 'person_name',
+    'login' => 'login', 'status' => 'status', 'phone' => 'phone', 'fax' => 'fax',
+    'email' => 'email', 'address' => 'address', 'city' => 'city', 'state' => 'state',
+    'pcode' => 'postal_code', 'country' => 'country', 'locale' => 'locale',
+    'guid' => 'guid', 'owner-id' => 'owner_id', 'vendor-guid' => 'vendor_guid',
+    'external-id' => 'external_id', 'password' => 'password',
+    'password_type' => 'password_type'
+  }
+
+  def initialize(owner_id = nil)
+    @owner_id = owner_id
+  end
+
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.packet(:version => '1.6.3.5') {
+      xml.customer {
+        xml.get {
+          xml.filter {
+            xml.tag!('owner-id', @owner_id) if @owner_id.present?
+          }
+          xml.dataset {
+            xml.gen_info
+            xml.stat
+          }
+        }
+      }
+    }
+    return xml.target!
+  end
+
+  def analyse(xml_document)
+    @customers = []
+    xml_document.root.customer.get.nodes.each do |customer_node|
+      customer = PleskLib::Customer.new(nil)
+      customer_node.data.gen_info.nodes.each do |attribute_node|
+        customer_attribute = MAPPING[attribute_node.name]
+        next if customer_attribute.blank? || !customer.respond_to?(customer_attribute) ||
+                attribute_node.text.blank?
+        customer.send("#{customer_attribute}=", attribute_node.text)
+      end
+      customer.status = customer.status.to_i
+      @customers << customer
+    end
+  end
+end

data/lib/plesk_lib/actions/list_service_plans.rb

@@ -0,0 +1,60 @@
+class PleskLib::Actions::ListServicePlans < PleskLib::Actions::Base
+  attr_reader :service_plans
+
+  def initialize(owner_id = nil)
+    @owner_id = owner_id
+  end
+
+  MAPPING = {
+    'cr_date' => 'created_at', 'cname' => 'company_name', 'pname' => 'person_name',
+    'login' => 'login', 'status' => 'status', 'phone' => 'phone', 'fax' => 'fax',
+    'email' => 'email', 'address' => 'address', 'city' => 'city', 'state' => 'state',
+    'pcode' => 'postal_code', 'country' => 'country', 'locale' => 'locale',
+    'guid' => 'guid', 'owner-id' => 'owner_id', 'vendor-guid' => 'vendor_guid',
+    'external-id' => 'external_id', 'password' => 'password',
+    'password_type' => 'password_type'
+  }
+
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.packet(:version => '1.6.3.5') {
+      xml.tag!('service-plan') {
+        xml.get {
+          xml.filter
+          if @owner_id.present?
+            xml.tag!('owner-id', @owner_id)
+          else
+            xml.tag!('owner-all')
+          end
+        }
+      }
+    }
+    return xml.target!
+  end
+
+  def analyse(xml_document)
+    @service_plans = []
+    xml_document.root.send('service-plan').get.nodes.each do |plan_el|
+      service_plan = PleskLib::ServicePlan.new(plan_el.locate('name').first.text)
+      # binding.pry
+      service_plan.id = plan_el.send('id').text.to_i
+      service_plan.external_id = plan_el.send('external-id').text
+      service_plan.guid = plan_el.send('guid').text
+
+      owner_id_nodes = plan_el.locate('owner-id')
+      if owner_id_nodes.first.present?
+        service_plan.owner_id = owner_id_nodes.first.text.to_i
+      end
+
+      # plan_el.elements['data//gen_info'].each_element do |attribute|
+      #   service_plan_attribute = MAPPING[attribute.name]
+      #   next if service_plan_attribute.blank? || !service_plan.respond_to?(service_plan_attribute) ||
+      #           attribute.text.blank?
+      #   service_plan.send("#{service_plan_attribute}=", attribute.text)
+      # end
+      # service_plan.status = service_plan.status.to_i
+      @service_plans << service_plan
+    end
+  end
+end

data/lib/plesk_lib/actions/list_subscriptions.rb

@@ -0,0 +1,42 @@
+class PleskLib::Actions::ListSubscriptions < PleskLib::Actions::Base
+  attr_reader :subscriptions
+
+  def initialize(owner_id = nil)
+    @owner_id = owner_id
+  end
+
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.packet(:version => '1.6.3.5') {
+      xml.webspace {
+        xml.get {
+          xml.filter {
+            xml.tag!('owner-id', @owner_id) if @owner_id.present?
+          }
+          xml.dataset {
+            xml.gen_info
+            xml.hosting
+          }
+        }
+      }
+    }
+    return xml.target!
+  end
+
+  def analyse(xml_document)
+    @subscriptions = []
+    xml_document.root.webspace.get.nodes.each do |webspace_node|
+      subscription = PleskLib::Subscription.new
+      # binding.pry
+      webspace_node.data.gen_info.nodes.each do |attribute_node|
+        subscription_attribute = attribute_node.name.underscore
+        next if !subscription.respond_to?(subscription_attribute) ||
+                attribute_node.text.blank?
+        subscription.send("#{subscription_attribute}=", attribute_node.text)
+      end
+      subscription.id = webspace_node.id.text.to_i
+      @subscriptions << subscription
+    end
+  end
+end

data/lib/plesk_lib/customer.rb

@@ -0,0 +1,4 @@
+module PleskLib
+  class Customer < Account
+  end
+end

data/lib/plesk_lib/reseller.rb

@@ -0,0 +1,5 @@
+module PleskLib
+  class Reseller < Account
+    attr_accessor :service_plan_id
+  end
+end

data/lib/plesk_lib/server.rb

@@ -0,0 +1,23 @@
+module PleskLib
+  class Server
+    attr_accessor :host, :password, :username
+
+    def initialize(host, username, password)
+      @host = host
+      @username = username
+      @password = password
+    end
+
+    def method_missing(method_name, *args)
+      begin
+        action_class = "PleskLib::Actions::#{method_name.to_s.camelize}".constantize
+      rescue NameError => e
+        raise NoMethodError, "The Action #{e.name} is not available. Please check the action docs."
+      else
+        action = action_class.new(*args)
+        action.execute_on(self)
+        return action
+      end
+    end
+  end
+end

data/lib/plesk_lib/service_plan.rb

@@ -0,0 +1,17 @@
+module PleskLib
+  class ServicePlan
+    attr_accessor :name, :mailboxes, :domains, :traffic, :storage, :external_id,
+                  :owner_id, :id, :guid
+
+    def initialize(name, attributes = {})
+      @name = name
+      attributes.each_pair do |key, value|
+        send("#{key}=", value)
+      end if attributes.present?
+    end
+
+    def to_s
+      "#<#{self.class}: id=#{self.id} name=#{self.name}, guid: #{self.guid}>"
+    end
+  end
+end

data/lib/plesk_lib/subscription.rb

@@ -0,0 +1,14 @@
+module PleskLib
+  class Subscription
+    attr_accessor :id, :ip_address, :name, :owner_id, :owner_login,
+                  :service_plan_name, :service_plan_id, :customer_account_id,
+                  :reseller_account_id, :external_id, :guid, :vendor_guid,
+                  :ftp_login, :ftp_password
+
+    def initialize(attributes = {})
+      attributes.each_pair do |key, value|
+        send("#{key}=", value)
+      end if attributes.present?
+    end
+  end
+end

data/lib/plesk_lib/version.rb

@@ -0,0 +1,3 @@
+module PleskLib
+  VERSION = "0.0.1"
+end

data/plesk_lib.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plesk_lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "plesk_lib"
+  spec.version       = PleskLib::VERSION
+  spec.authors       = ["Phillipp Röll"]
+  spec.email         = ["phillipp.roell@trafficplex.de"]
+  spec.summary       = %q{Plesk 11 provisioning library. Extracted out of plesk_kit}
+  spec.description   = %q{Add customers, resellers, service plans and subscriptions to plesk via the XML RPC API}
+  spec.homepage      = "https://github.com/phillipp/plesk_lib"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 3.0.0"
+  spec.add_runtime_dependency "ox", "~> 2.1.1"
+  spec.add_runtime_dependency "builder", "~> 3.2.2"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "vcr", "~> 2.8.0"
+  spec.add_development_dependency "webmock", "~> 1.17.4"
+  spec.add_development_dependency "pry", "~> 0.9.12.6"
+end

data/spec/actions/change_customer_password_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::ChangeCustomerPassword do
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+
+  context 'when user exists on the server' do
+    let(:customer) { PleskLib::Customer.new('user91') }
+
+    it 'should reset the customers password' do
+      VCR.use_cassette 'customer/change_password_existing_user', match_requests_on: [:method, :uri, :body] do
+        action = PleskLib::Actions::ChangeCustomerPassword.new(customer, 'new_password')
+        action.execute_on(server)
+      end
+    end
+  end
+
+  context 'when user is missing' do
+    let(:customer) { PleskLib::Customer.new('unknownuser') }
+
+    it 'should raise a AccountNotFound exception' do
+      VCR.use_cassette 'customer/change_password_missing_user', match_requests_on: [:method, :uri, :body] do
+        action = PleskLib::Actions::ChangeCustomerPassword.new(customer, 'new_password')
+        expect {
+          action.execute_on(server)
+        }.to raise_error(PleskLib::AccountNotFound)
+      end
+    end
+  end
+end

data/spec/actions/create_customer_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe PleskLib::Actions::CreateCustomer do
+  let(:customer_attributes) do
+    { password: 'customer_secret', phone: '0000000000',
+      email: 'noreply@ausupport.com.au', country: 'AU',
+      person_name: 'FirstName LastName', company_name: 'My Company' }
+  end
+
+  let(:server) { PleskLib::Server.new('10.0.0.158', 'admin', 'ccsnDxnWy2j0') }
+  let(:customer) { PleskLib::Customer.new('cust91', customer_attributes) }
+
+  context 'when login is available on the plesk server' do
+    it 'should create a customer' do
+      VCR.use_cassette 'customer/minimal', match_requests_on: [:method, :uri, :body] do
+        action = PleskLib::Actions::CreateCustomer.new(customer)
+        action.execute_on(server)
+        action.plesk_id.to_i.should > 0
+      end
+    end
+  end
+
+  context 'when an owner id is set' do
+    let(:customer) { PleskLib::Customer.new('cust8891', customer_attributes) }
+    let(:customer_attributes) do
+      { password: 'customer_secret', phone: '0000000000',
+        email: 'noreply@ausupport.com.au', country: 'AU',
+        person_name: 'FirstName LastName', company_name: 'My Company',
+        owner_id: 3 }
+    end
+    it 'should create a customer' do
+      VCR.use_cassette 'customer/minimal_with_owner', match_requests_on: [:method, :uri, :body] do
+        action = PleskLib::Actions::CreateCustomer.new(customer)
+        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 'customer/minimal_exists', match_requests_on: [:method, :uri, :body] do
+        action = PleskLib::Actions::CreateCustomer.new(customer)
+        expect {
+          action.execute_on(server)
+        }.to raise_error(PleskLib::LoginAlreadyTaken)
+      end
+    end
+  end
+end