plesk_lib 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a0e0b6ced984f3e95d746d026204ecf9872a4c7
+  data.tar.gz: 474bde6cfbd52d9a6dffabec99fa99e4df4f5dca
+SHA512:
+  metadata.gz: 395d8768bc0427db578f00e57a41f5310e454e338addbf33ecd8154b67d1c3b89f748d68d86cb4b502c0a3eda9f3f9dd714b05d33124950579065ae77e9be1e5
+  data.tar.gz: f78dd5be4f9dbeab6943d38b2fa7d9125965ab3ce64b24b1ee62d2e99de607ed1c632d855da3edcefd49b281c22efd18e6e660039c60194656dff3ce38f85083

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plesk_lib.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# PleskLib [![Gem Version](https://badge.fury.io/rb/plesk_lib.png)](http://badge.fury.io/rb/plesk_lib)
+
+Under heavy development, but usable. Tested against Plesk for Linux 11.5
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'plesk_lib'
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Everything can be done through the server object:
+
+```
+server = PleskLib::Server.new('192.168.0.1', 'admin', 'yourPleskPassword')
+response = server.get_statistics
+response.statistics
+```
+
+### Customers:
+
+```
+
+# Create customer accounts (add it to a reseller by adding owner_id: [x] to the options hash):
+customer = PleskLib::Customer.new('user92', {password: 'foobar', person_name: 'foo'}) 
+response = server.create_customer(customer)
+puts 'Plesk id:   ' + response.plesk_id
+puts 'Plesk GUID: ' + response.guid
+
+# List all customer accounts:
+response = server.list_customers
+response.customers.each { |customer| puts customer.company_name, customer.login }
+
+# or just the customers of an owner by id:
+response = server.list_customers(3)
+```
+
+### Resellers:
+
+```
+reseller_account = PleskLib::Reseller.new('reseller01', {password: 'foobar', person_name: 'foo'})  
+server.create_reseller(reseller)
+```
+
+### Service Plans:
+
+``` 
+# Create a service plan:
+
+service_plan = PleskLib::ServicePlan.new("My Plan", {mailboxes: 10, storage: 2.gigabytes, domains: 1, traffic: 30.gigabytes})
+server.create_service_plan(service_plan)
+```
+
+### Subscriptions:
+
+To create a new subscription for a customer in Plesk:
+
+```
+subscription_settings = { name: 'foo-domain.de', ip_address: '10.0.0.158',
+                          owner_id: 3, service_plan_id: 10, ftp_login: 'ftp01',
+                          ftp_password: 'ftpPass01' }
+subscription = PleskLib::Subscription.new(subscription_settings)
+server.create_subscription(subscription)
+```
+
+## How it works: 
+
+Every operation on the server is implemented in an action class inside `lib/plesk_lib/actions`. Please refer to the action class for usage and/or inner workings and add or modify actions as you like.
+
+## Contributing 
+
+1. Fork it
+2. Please test what you do:
+    - Create your feature branch (`git checkout -b my-new-feature`)
+    - **Test your changes and record a test with VCR**
+3. Commit your changes (`git commit -am 'Add some feature'`) 
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Thanks
+
+Special thanks to the `plesk_kit` gem by tresacton.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/plesk_lib.rb

@@ -0,0 +1,29 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/numeric/bytes'
+require 'builder'
+require 'bigdecimal'
+require 'ox'
+require 'plesk_lib/version'
+require 'plesk_lib/account'
+require 'plesk_lib/customer'
+require 'plesk_lib/reseller'
+require 'plesk_lib/server'
+require 'plesk_lib/service_plan'
+require 'plesk_lib/subscription'
+require 'plesk_lib/actions/base'
+require 'plesk_lib/actions/create_account'
+require 'plesk_lib/actions/create_customer'
+require 'plesk_lib/actions/create_reseller'
+require 'plesk_lib/actions/create_service_plan'
+require 'plesk_lib/actions/create_subscription'
+require 'plesk_lib/actions/change_customer_password'
+require 'plesk_lib/actions/list_customers'
+require 'plesk_lib/actions/list_service_plans'
+require 'plesk_lib/actions/list_subscriptions'
+require 'plesk_lib/actions/get_statistics'
+
+module PleskLib
+  class LoginAlreadyTaken < RuntimeError ; end
+  class AccountNotFound < RuntimeError ; end
+end

data/lib/plesk_lib/account.rb

@@ -0,0 +1,14 @@
+module PleskLib
+  class Account
+    attr_accessor :company_name, :login, :password, :person_name, :status,
+                  :phone, :fax, :address, :city, :state, :email, :country,
+                  :postal_code, :external_id, :owner_id
+
+    def initialize(login, other_attributes = {})
+      @login = login
+      other_attributes.each_pair do |key, value|
+        send("#{key}=", value)
+      end if other_attributes.present?
+    end
+  end
+end

data/lib/plesk_lib/actions/base.rb

@@ -0,0 +1,61 @@
+require 'net/http'
+require 'openssl'
+
+module PleskLib::Actions
+  class Base
+      # executes the current method on a server
+    def execute_on(server)
+      request_xml = build_xml
+      response_xml = send_xml_to_server(server, request_xml)
+      response_document = Ox.parse(response_xml)
+      parse_errors(response_document)
+      analyse(response_document)
+      return true
+    end
+
+    protected
+
+    def parse_errors(xml_document)
+      status = xml_document.root.locate('*/status').first.text
+      return unless status == "error"
+      code = xml_document.root.locate('*/errcode').first.text.to_i
+      message = xml_document.root.locate('*/errtext').first.text
+
+      # this catches the duplicate account error for resellers
+      if code == 1019 and message.include?('already exists')
+        raise PleskLib::LoginAlreadyTaken, message
+      end
+
+      case code
+      when 1007 then
+        raise PleskLib::LoginAlreadyTaken, message
+      when 1013 then
+        raise PleskLib::AccountNotFound, message
+      else
+        raise "#{code}: #{message}"
+      end
+    end
+
+    def analyse(xml_document)
+      return true
+    end
+
+    # Sends packet to plesk
+    def send_xml_to_server(server, xml)
+      http = Net::HTTP.new(server.host, 8443)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      headers = {
+          'HTTP_AUTH_LOGIN' => server.username,
+          'HTTP_AUTH_PASSWD' => server.password,
+          'Content-Type' => 'text/xml',
+      }
+
+      path = "/enterprise/control/agent.php"
+      res, data = http.post2(path, xml, headers)
+      return res.body
+    end
+  end
+end
+

data/lib/plesk_lib/actions/change_customer_password.rb

@@ -0,0 +1,27 @@
+class PleskLib::Actions::ChangeCustomerPassword < PleskLib::Actions::Base
+  attr_reader :customer, :new_password
+
+  def initialize(customer, new_password)
+    @customer = customer
+    @new_password = new_password
+  end
+
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.packet(:version => '1.6.3.5') {
+      xml.customer {
+        xml.set{
+          xml.filter{
+            xml.login(@customer.login)
+          }
+          xml.values{
+            xml.gen_info{
+              xml.passwd(@new_password)
+            }
+          }
+        }
+      }
+    }
+  end
+end

data/lib/plesk_lib/actions/create_account.rb

@@ -0,0 +1,23 @@
+class PleskLib::Actions::CreateAccount < PleskLib::Actions::Base
+  def build_gen_info(xml, account, tag_name = 'gen_info')
+    xml.tag!(tag_name) {
+      xml.cname(account.company_name)
+      xml.pname(account.person_name)
+      xml.login(account.login) if account.login.present?
+      xml.passwd(account.password) if account.password.present?
+      xml.pcode(account.pcode) if account.postal_code.present?
+      %w(status phone fax address city state email country).each do |attribute|
+        value = account.send(attribute)
+        xml.tag!(attribute, value) if value.present?
+      end
+      xml.tag!('owner-id', account.owner_id) if account.owner_id.present?
+    }
+    return 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/create_customer.rb

@@ -0,0 +1,21 @@
+class PleskLib::Actions::CreateCustomer < PleskLib::Actions::CreateAccount
+  attr_reader :customer, :plesk_id
+
+  def initialize(customer)
+    @customer = customer
+  end
+
+  #  Creates Object & Packet
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.packet(:version => '1.6.3.5') {
+      xml.customer {
+        xml.add{
+          build_gen_info(xml, @customer)
+        }
+      }
+    }
+    return xml.target!
+  end
+end

data/lib/plesk_lib/actions/create_reseller.rb

@@ -0,0 +1,22 @@
+class PleskLib::Actions::CreateReseller < PleskLib::Actions::CreateAccount
+  attr_reader :reseller, :plesk_id
+
+  def initialize(reseller)
+    @reseller = reseller
+  end
+
+  #  Creates Object & Packet
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+    xml.packet(:version => '1.6.3.5') {
+      xml.reseller {
+        xml.add{
+          build_gen_info(xml, @reseller, 'gen-info')
+          xml.tag!('plan-id', @reseller.service_plan_id)
+        }
+      }
+    }
+    return xml.target!
+  end
+end

data/lib/plesk_lib/actions/create_service_plan.rb

@@ -0,0 +1,327 @@
+class PleskLib::Actions::CreateServicePlan < PleskLib::Actions::Base
+  attr_reader :service_plan, :guid, :plesk_id
+
+  def initialize(service_plan)
+    @service_plan = service_plan
+  end
+
+  def build_xml
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+      xml.packet(:version => '1.6.3.0') {
+        xml.tag!("service-plan")  {
+          xml.add {
+            xml.name("#{service_plan.name}")
+            if service_plan.owner_id.present?
+              xml.tag!('owner-id', service_plan.owner_id)
+            end
+            xml.mail{
+              xml.webmail('horde')
+            }
+            xml.limits{
+              xml.overuse('block')
+
+              xml.limit{
+                xml.name('max_site')
+                xml.value("#{service_plan.domains.to_s}")
+              }
+              xml.limit{
+                xml.name('max_subdom')
+                xml.value('-1')
+              }
+              xml.limit{
+                xml.name('max_dom_aliases')
+                xml.value('-1')
+              }
+              xml.limit{
+                xml.name('disk_space')
+                xml.value("#{service_plan.storage.to_s}") #10gb
+              }
+              xml.limit{
+                xml.name('disk_space_soft')
+                xml.value('0')
+              }
+              xml.limit{
+                xml.name('max_traffic')
+                xml.value("#{service_plan.traffic.to_s}") # unlimited
+              }
+              xml.limit{
+                xml.name('max_traffic_soft')
+                xml.value('0')
+              }
+              xml.limit{
+                xml.name('max_wu')
+                xml.value('-1')
+              }
+              xml.limit{
+                xml.name('max_subftp_users')
+                xml.value('-1')
+              }
+              xml.limit{
+                xml.name('max_db')
+                xml.value('-1')
+              }
+              xml.limit{
+                xml.name('max_box')
+                xml.value("#{service_plan.mailboxes.to_s}") # mailboxes
+              }
+              xml.limit{
+                xml.name('mbox_quota')
+                xml.value('1073741824')
+              }
+              xml.limit{
+                xml.name('max_maillists')
+                xml.value('100')
+              }
+              xml.limit{
+                xml.name('max_webapps')
+                xml.value('0')
+              }
+              xml.limit{
+                xml.name('max_site_builder')
+                xml.value('1')
+              }
+              xml.limit{
+                xml.name('max_unity_mobile_sites')
+                xml.value('0')
+              }
+              xml.limit{
+                xml.name('expiration')
+                xml.value('-1')
+              }
+              # xml.limit{
+              #   xml.name('upsell_site_builder')
+              #   xml.value('0')
+              # }
+
+            }
+            xml.tag!("log-rotation"){
+            xml.on{
+                xml.tag!("log-condition"){
+                  xml.tag!("log-bysize", "10485760")
+                }
+                xml.tag!("log-max-num-files", "10")
+                xml.tag!("log-compress", "true")
+              }
+            }
+            xml.preferences{
+              xml.stat('3')
+              xml.maillists('false')
+              xml.dns_zone_type('master')
+            }
+            xml.hosting{
+              xml.property{
+                xml.name('ssl')
+                xml.value('false')
+              }
+              xml.property{
+                xml.name('fp')
+                xml.value('false')
+              }
+              xml.property{
+                xml.name('fp_ssl')
+                xml.value('false')
+              }
+              xml.property{
+                xml.name('fp_auth')
+                xml.value('false')
+              }
+              xml.property{
+                xml.name('webstat')
+                xml.value('awstats')
+              }
+              xml.property{
+                xml.name('webstat_protected')
+                xml.value('true')
+              }
+              xml.property{
+                xml.name('wu_script')
+                xml.value('true')
+              }
+              xml.property{
+                xml.name('shell')
+                xml.value('/bin/false')
+              }
+              xml.property{
+                xml.name('ftp_quota')
+                xml.value('-1')
+              }
+              xml.property{
+                xml.name('php_handler_type')
+                xml.value('fastcgi')
+              }
+              xml.property{
+                xml.name('asp')
+                xml.value('false')
+              }
+              xml.property{
+                xml.name('ssi')
+                xml.value('false')
+              }
+              xml.property{
+                xml.name('php')
+                xml.value('true')
+              }
+              xml.property{
+                xml.name('cgi')
+                xml.value('true')
+              }
+              xml.property{
+                xml.name('perl')
+                xml.value('true')
+              }
+              xml.property{
+                xml.name('python')
+                xml.value('true')
+              }
+              xml.property{
+                xml.name('fastcgi')
+                xml.value('true')
+              }
+              xml.property{
+                xml.name('miva')
+                xml.value('false')
+              }
+              xml.property{
+                xml.name('coldfusion')
+                xml.value('false')
+              }
+            }
+            xml.performance{
+              xml.bandwidth('-1')
+              xml.max_connections('-1')
+            }
+            xml.permissions{
+              xml.permission{
+                xml.name('create_domains')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_phosting')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_php_settings')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_sh_access')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_not_chroot_shell')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_quota')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_subdomains')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_domain_aliases')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_log')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_anonftp')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_subftp')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_crontab')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_dns')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_webapps')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('manage_webstat')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_mail_settings')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_maillists')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_spamfilter')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_virusfilter')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('allow_local_backups')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('allow_ftp_backups')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_performance')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('select_db_server')
+                xml.value('false')
+              }
+              xml.permission{
+                xml.name('access_appcatalog')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('allow_insecure_sites')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_website_maintenance')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('manage_protected_dirs')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('access_service_users')
+                xml.value('true')
+              }
+              xml.permission{
+                xml.name('allow_license_stubs')
+                xml.value('false')
+              }
+            }
+
+            if service_plan.external_id.present?
+              xml.tag!('external-id', service_plan.external_id)
+            end
+          }
+        }
+      }
+      return 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