plesk 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,3 +1,2 @@
 source "http://rubygems.org"
 gemspec
-

data/Guardfile

@@ -1,12 +1,3 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'bundler' do
-  watch('Gemfile')
-  # Uncomment next line if Gemfile contain `gemspec' command
-  # watch(/^.+\.gemspec/)
-end
-
 guard 'rspec', :version => 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }

data/Rakefile

@@ -1,3 +1,2 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-require "pludoni-gem"

data/bin/plesk

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# for 1.8.7 compat
+unless File.respond_to? :realpath
+  class File #:nodoc:
+    def self.realpath path
+      return realpath(File.readlink(path)) if symlink?(path)
+      path
+    end
+  end
+end
+$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'plesk'
+require 'gli'
+
+include GLI
+
+program_desc 'Use ./plesk to get your api key from your plesk instance.'
+
+version Plesk::VERSION
+
+#desc 'Describe some switch here'
+#switch [:s,:switch]
+
+#desc 'Describe some flag here'
+#default_value 'the default'
+#arg_name 'The name of the argument'
+#flag [:f,:flagname]
+
+desc 'Get your api key for the IP which will use the gem, so you dont have to use your login information for future use.'
+arg_name 'You have to provide your hostname and your credentials.'
+command :key do |c|
+  c.action do |global_options,options,args|
+    if args.length < 4
+      raise 'Usage: ./plesk key <hostname> <user> <password> <ip_address>'
+    end
+    client = Plesk::Client.new(*args[0..2])
+    puts client.get_secret_for_ip args[3]
+  end
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit GLI.run(ARGV)
+

data/lib/plesk.rb

@@ -1,132 +1,11 @@
-require "net/https"
-require "nokogiri"
 module Plesk
-  class Client
-    attr_accessor :response, :uri,:http
-    def initialize path, user, password
-      @response = 0
-      @uri = URI(path)
-      http = Net::HTTP.new(@uri.host, @uri.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      @headers = {
-        'HTTP_AUTH_LOGIN' => user,
-        'HTTP_AUTH_PASSWD' => password,
-        'Accept' => '*/*',
-        'Content-Type' => 'text/xml',
-      }
-      @http = http
-    end
-    def get_domain_info
-      packet = PleskPacket.new
-      packet.domain_info
-      start_request packet.to_xml
-    end
-    def get_domain_id_for domain
-      packet = PleskPacket.new
-      packet.domain_info_for_domain domain
-      answer = start_request packet.to_xml
-      Nokogiri::XML(answer.body).at('id').text
-    end
-    def get_mailgroup_info_for mail
-      name,domain = mail.split("@")
-      domain_id = get_domain_id_for domain
-      packet = PleskPacket.new
-      packet.mailgroup_info name,domain_id
-      answer = start_request packet.to_xml
 
-      Nokogiri::XML(answer.body).search('address').map(&:text)
-    end
-
-    def set_mailgroup_for mail,mails
-      name,domain = mail.split("@")
-      domain_id = get_domain_id_for domain
-      packet = PleskPacket.new
-      packet.mailgroup_set name,domain_id,mails
-      answer = start_request packet.to_xml
-    end
-
-    def start_request(body)
-      response = http.request_post(@uri.path,body,@headers)
-      @response = response
-    end
-  end
-  class PleskPacket
-    attr_accessor :content
-    def initialize version="1.4.1.2"
-      @content = Nokogiri::XML::Builder.new do |xml|
-        xml.packet(version: version)
-      end.doc
-    end
-    def domain_info
-      doc = @content
-      Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
-        xml.domain {
-          xml.get {
-            xml.filter
-            xml.dataset {
-              xml.limits
-              xml.prefs
-            }
-          }
-        }
-      end
-    end
-    def domain_info_for_domain domain
-      doc = @content
-      @content=Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
-        xml.domain {
-          xml.get {
-            xml.filter {
-              xml.domain_name domain
-            }
-            xml.dataset {
-              xml.limits
-              xml.prefs
-            }
-          }
-        }
-      end
-    end
-    def mailgroup_info name,id
-      doc = @content
-      @content =Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
-        xml.mail {
-          xml.get_info {
-            xml.filter {
-              xml.name name
-              xml.domain_id id
-            }
-            xml.group
-          }
-        }
-      end
-    end
-    def mailgroup_set name,id,mails
-      doc = @content
-      @content =Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
-        xml.mail {
-          xml.update {
-            xml.set {
-              xml.filter {
-                xml.domain_id id
-                xml.mailname {
-                  xml.name name
-                  xml.mailgroup {
-                    xml.enabled :true
-                    mails.each do |mail|
-                      xml.address mail
-                    end
-                  }
-                }
-              }
-            }
-          }
-        }
-      end
-    end
-    def to_xml
-      @content.to_xml
-    end
+  class PleskException < Exception
   end
 end
+
+require "plesk/client"
+require "plesk/packet"
+require "plesk/version"
+
+

data/lib/plesk/client.rb

@@ -0,0 +1,83 @@
+require "net/https"
+require "nokogiri"
+require "open-uri"
+module Plesk
+  class Client
+    attr_accessor :response, :uri,:http
+    def initialize host, *credentials
+      if credentials.size == 2
+        @headers = {
+          'HTTP_AUTH_LOGIN' => credentials[0],
+          'HTTP_AUTH_PASSWD' => credentials[1],
+          'Accept' => '*/*',
+          'Content-Type' => 'text/xml',
+        }
+      elsif credentials.length == 1
+        @headers = {
+          'KEY' => credentials[0],
+          'Accept' => '*/*',
+          'Content-Type' => 'text/xml',
+        }
+      else
+        raise ArgumentError
+      end
+      @response = 0
+      @uri = URI.parse "https://example.com:8443/enterprise/control/agent.php"
+      @uri.host = host
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      @http = http
+    end
+    def get_domain_id_for domain
+      packet = Packet.new
+      packet.domain_info_for_domain domain
+      answer = start_request packet.to_xml
+      answer.at('id').text
+    end
+    def get_mailgroup_info_for mail
+      name,domain = mail.split("@")
+      domain_id = get_domain_id_for domain
+      packet = Packet.new
+      packet.mailgroup_info name,domain_id
+      answer = start_request packet.to_xml
+
+      answer.search('address').map(&:text)
+    end
+    def set_mailgroup_for mail,mails
+      name,domain = mail.split("@")
+      domain_id = get_domain_id_for domain
+      packet = Packet.new
+      packet.mailgroup_set name,domain_id,mails
+      answer = start_request packet.to_xml
+    end
+    def get_secret_for_ip ip
+      packet = Packet.new
+      packet.secret_key_for_ip ip
+      answer = start_request packet.to_xml
+      if answer.at('status').text == "ok"
+        answer.at('key').text
+      else
+        $stderr.puts answer.body
+        raise PleskException
+      end
+    end
+
+    def start_request(body)
+      response = http.request_post(@uri.path,body,@headers)
+      if (400...600).include? response.code.to_i
+        raise PleskException
+      end
+      @response = response
+      Nokogiri::XML(response.body)
+    end
+
+    private
+
+    def get_domain_info
+      packet = Packet.new
+      packet.domain_info
+      start_request packet.to_xml
+    end
+  end
+end

data/lib/plesk/packet.rb

@@ -0,0 +1,91 @@
+
+module Plesk
+  class Packet
+    attr_accessor :content
+    def initialize version="1.4.1.2"
+      @content = Nokogiri::XML::Builder.new do |xml|
+        xml.packet(version: version)
+      end.doc
+    end
+    def domain_info
+      doc = @content
+      Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
+        xml.domain {
+          xml.get {
+          xml.filter
+          xml.dataset {
+            xml.limits
+            xml.prefs
+          }
+        }
+        }
+      end
+    end
+    def domain_info_for_domain domain
+      doc = @content
+      @content=Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
+        xml.domain {
+          xml.get {
+          xml.filter {
+          xml.domain_name domain
+        }
+        xml.dataset {
+          xml.limits
+          xml.prefs
+        }
+        }
+        }
+      end
+    end
+    def mailgroup_info name,id
+      doc = @content
+      @content =Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
+        xml.mail {
+          xml.get_info {
+          xml.filter {
+          xml.name name
+          xml.domain_id id
+        }
+        xml.group
+        }
+        }
+      end
+    end
+    def mailgroup_set name,id,mails
+      doc = @content
+      @content =Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
+        xml.mail {
+          xml.update {
+          xml.set {
+          xml.filter {
+          xml.domain_id id
+          xml.mailname {
+            xml.name name
+            xml.mailgroup {
+              xml.enabled :true
+              mails.each do |mail|
+                xml.address mail
+              end
+            }
+          }
+        }
+        }
+        }
+        }
+      end
+    end
+    def secret_key_for_ip ip
+      doc = @content
+      Nokogiri::XML::Builder.with(doc.at('packet')) do |xml|
+        xml.secret_key {
+          xml.create {
+          xml.ip_address ip
+        }
+        }
+      end
+    end
+    def to_xml
+      @content.to_xml
+    end
+  end
+end

data/lib/plesk/version.rb

@@ -1,4 +1,3 @@
 module Plesk
-  VERSION = File.open("VERSION").read.strip
-
+  VERSION = "0.0.2"
 end

data/plesk.gemspec

@@ -14,5 +14,9 @@ Gem::Specification.new do |gem|
   gem.name          = "plesk"
   gem.require_paths = ["lib"]
   gem.add_dependency 'nokogiri'
+  gem.add_dependency 'gli'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
   gem.version       = Plesk::VERSION
 end

data/spec/plesk_spec.rb

@@ -1,28 +1,38 @@
 require "spec_helper"
 require "yaml"
+require "ostruct"
 include Plesk
 describe "Plesk" do
   let(:api) {
     config = YAML.load( File.open "spec/config.yml")
-    path = config["path"]
+    host = config["host"]
     user = config["user"]
     pass = config["password"]
-    Client.new(path,user,pass)
+    Client.new(host,user,pass)
+  }
+  let(:api_via_key) {
+    config = YAML.load( File.open "spec/config.yml")
+    host = config["host"]
+    key = config["key"]
+    Client.new(host,key)
   }
 
   it "should connect to the Plesk RPC" do
     api.start_request("bla")
     api.response.code.should == "200"
   end
-
-  it "should be able to get basic domain list" do
-    api.get_domain_info
-    api.response.code.should == "200"
+  it "should connect to the Plesk RPC via secret key" do
+    api_via_key.start_request("bla")
+    api_via_key.response.code.should == "200"
   end
+
+  #it "should be able to get basic domain list" do
+  #api.get_domain_info
+  #api.response.code.should == "200"
+  #end
   it "should be able to find domain id by name" do
     id = api.get_domain_id_for "itsax.de"
     id.should be_kind_of String
-
   end
   it "should get a mailgroup list for a mail" do
     mails = api.get_mailgroup_info_for "developer@pludoni.de"
@@ -31,28 +41,57 @@ describe "Plesk" do
   it "should set mailgroup for a mail" do
     mails_to_set = ["stefan.wienert@pludoni.de","akos.toth@pludoni.de","martin.schneider@pludoni.de"]
     answer = api.set_mailgroup_for "developer@pludoni.de", mails_to_set
-    Nokogiri::XML(answer.response.body).at('status').text.should == "ok"
+    answer.at('status').text.should == "ok"
+  end
+  it "should be able to retrieve the api secret" do
+    #ip = "46.4.99.113"
+    #answer = api.get_secret_for_ip ip
+    #Nokogiri::XML(answer.response.body).at('status').text.should == "ok"
+    #Nokogiri::XML(answer.response.body).at('key').text.to_s.length.should > 10
+  end
+  it "should have a convenient way to get the key" do
+    ip = "46.4.99.113"
+    answer = api.get_secret_for_ip ip
+    answer.should be_kind_of String
+    (10..50).should include answer.length
+  end
+
+  it "should raise an error when plesk" do
+    object = OpenStruct.new body: "ERROR", code: "500"
+
+    Net::HTTP.any_instance.should_receive(:request_post).and_return(object)
+    ip = "46.4.99.113"
+
+    lambda {
+    answer = api.get_secret_for_ip ip
+    }.should raise_error(PleskException)
   end
 end
 
-describe PleskPacket do
+describe Packet do
   it "should generate xml" do
-    p = PleskPacket.new
+    p = Packet.new
     Nokogiri::XML(p.to_xml).errors.should be_empty
   end
   it "should have a packet version matching the param" do
     ver = "1.0.0.0"
-    p = PleskPacket.new(ver)
+    p = Packet.new(ver)
     Nokogiri::XML(p.to_xml).at('packet').attr('version').should == ver
   end
   it "should create a packet to get a domain list" do
-    p = PleskPacket.new("1.4.1.2")
+    p = Packet.new("1.4.1.2")
     p.domain_info
     Nokogiri::XML(p.to_xml).at('get').children.count.should > 0
   end
   it "should create a packet to get the mailgroup of a mail adress" do
-    p = PleskPacket.new("1.6.0.2")
+    p = Packet.new("1.6.0.2")
     p.mailgroup_info "developer","1"
     Nokogiri::XML(p.to_xml).at('get_info').children.count.should > 0
   end
+  it "should create a packet to retrieve the secret" do
+    ip = "192.0.0.1"
+    p = Packet.new
+    p.secret_key_for_ip ip
+    Nokogiri::XML(p.to_xml).at('ip_address').text.should == ip
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plesk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-07 00:00:00.000000000 Z
+date: 2012-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &20145220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,29 +21,71 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *20145220
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: &19733340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19733340
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &19732240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19732240
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &19731200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19731200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19729460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19729460
 description: ! 'Plesk RPC API wrapper written in Ruby '
 email:
 - info@outsmartin.de
 executables:
-- template
+- plesk
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
-- bin/template
+- bin/plesk
 - lib/plesk.rb
+- lib/plesk/client.rb
+- lib/plesk/packet.rb
 - lib/plesk/version.rb
 - plesk.gemspec
 - spec/config.yml.example
@@ -61,15 +103,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2607453395036010812
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2607453395036010812
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: You can communicate with your Plesk System through the RPC API. Sends XML

data/bin/template

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-# for 1.8.7 compat
-unless File.respond_to? :realpath
-  class File #:nodoc:
-    def self.realpath path
-      return realpath(File.readlink(path)) if symlink?(path)
-      path
-    end
-  end
-end
-$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
-
-# require 'module' here