lumberg 2.0.0.pre12 → 2.0.0.pre15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc0111d920bd8ab37348ad04a2790e78de603643
-  data.tar.gz: 6d5b5a3f897dd167db9c4c5c0bac45430fe9ec30
+  metadata.gz: d1058732139bcd1b3944f3db58e83fd31fe20ae6
+  data.tar.gz: b2c22aa8a40684b4c94bd3fe05b1567f77dc8133
 SHA512:
-  metadata.gz: 2efa9329e069727d7dceb376b4aa65bb3ee6ddbcb63e880b40ed0112a8c697afb47322f6be722e2a6456f97b0c96ce93bb116e2b5c2e061f1d799d657ce3c9e6
-  data.tar.gz: f65a390f02fa51ea81c31fc2a907382ba55eac4f997ae0883e1cf66ac4a8f2ea74e23fcce1e53c1b9e63803caf23ca3eba9f6ffbc9266da7fdcde4cf449374ae
+  metadata.gz: b059b3b57831808727e710316de9e3c9207a75cab47f7d31ce495383f165f30de1bca88e0aba73010fe7c4120a8b24abc0a8a79deb6959dc0ff90f0348a4ce6a
+  data.tar.gz: 232cec8379afc5d0aba63577d538a2aeec35fd647db9fda07898d703b13d0e780dfcab3c4ce63a0c73413379a5206621b4b384100f5e3acf6585816e37be3ff3

data/README.md

@@ -321,6 +321,7 @@ email.add_forwarder(
      end
    end
    ```
+
    - In many cases, you'll name your methods to match up
      with the documented cPanel API methods. However, the documented method
      names are sometimes a bit lengthy, confusing, or otherwise unwiedly; feel

data/lib/lumberg/cpanel.rb

@@ -27,5 +27,6 @@ module Lumberg
     require "lumberg/cpanel/mysql"
     require "lumberg/cpanel/domain_keys"
     require "lumberg/cpanel/ftp"
+    require "lumberg/cpanel/mysql_db"
   end
 end

data/lib/lumberg/cpanel/mysql_db.rb

@@ -0,0 +1,190 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows you to manage MySQL Databases, users and other related settings.
+    class MysqlDb < Base
+      def self.api_module; "Mysql"; end
+
+      # Public: Add a new MySQL database to a cPanel account.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :dbname - String name of the MySQL database to add.
+      #
+      # Returns Hash API response.
+      def add_db(options = {})
+        perform_request({
+          api_function: 'adddb',
+          'arg-0' => options.delete(:dbname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Create a new MySQL user.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :username - String MySQL user to create.
+      #   :password - String password for the new MySQL user.
+      #
+      # Returns Hash API respone.
+      def add_user(options = {})
+        perform_request({
+          api_function: 'adduser',
+          'arg-0' => options.delete(:username),
+          'arg-1' => options.delete(:password)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Grant a user permission to access a cPanel account's database.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :dbname - String name of the database to allow the user to access.
+      #   :dbuser - String MySQL user who should be given access to the database.
+      #   :perms_list - A space-separated String containing a list of permissions
+      #                 to grant to the user
+      #                 (e.g. "all" or "alter drop create delete insert update lock" )
+      #
+      # Returns Hash API respone.
+      def add_user_db(options = {})
+        perform_request({
+          api_function: 'adduserdb',
+          'arg-0' => options.delete(:dbname),
+          'arg-1' => options.delete(:dbuser),
+          'arg-2' => options.delete(:perms_list)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Retrieve the number of database users an account has created.
+      #
+      # Returns Hash API response.
+      def number_of_dbs(options = {})
+        perform_request({
+          api_function: 'number_of_dbs'
+        }.merge(default_options(options)))
+      end
+
+      # Public: Run a MySQL database check.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :dbname - String name of the MySQL database to check.
+      #
+      # Returns Hash API response.
+      def check_db(options = {})
+        perform_request({
+          api_function: 'checkdb',
+          'arg-0' => options.delete(:dbname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Run a MySQL database repair.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :dbname - String name of the MySQL database to repair.
+      #
+      # Returns Hash API response.
+      def repair_db(options = {})
+        perform_request({
+          api_function: 'repairdb',
+          'arg-0' => options.delete(:dbname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Force an update of MySQL privileges and passwords.
+      #
+      # options - Hash options for API call params (default: {})
+      #
+      # Returns Hash API response.
+      def update_privs(options = {})
+        perform_request({
+          api_function: 'updateprivs'
+        }.merge(default_options(options)))
+      end
+
+      # Public: Refresh the cache of MySQL information. This includes users,
+      #         databases, routines and other related information.
+      #
+      # options - Hash options for API call params (default: {})
+      #
+      # Returns Hash API response.
+      def init_cache(options = {})
+        perform_request({
+          api_function: 'initcache'
+        }.merge(default_options(options)))
+      end
+
+      # Public: Disallow a MySQL user from accessing a database.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :dbname - String MySQL database from which to remove the user's permissions.
+      #   :dbuser - String name of the MySQL user to remove.
+      #
+      # Returns Hash API response.
+      def del_user_db(options = {})
+        perform_request({
+          api_function: 'deluserdb',
+          'arg-0' => options.delete(:dbname),
+          'arg-1' => options.delete(:dbuser)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Remove a user from MySQL.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :dbuser - String name of the MySQL user to remove.
+      #             This value must be prefixed with the cPanel username.
+      #             (e.g. cpuser_dbuser)
+      #
+      # Returns Hash API response.
+      def del_user(options = {})
+        perform_request({
+          api_function: 'deluser',
+          'arg-0' => options.delete(:dbuser)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Remove a database from MySQL.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :dbname - String name of the MySQL database to remove.
+      #            This value must be prefixed with the cPanel username
+      #            (e.g., cpuser_dbname).
+      #
+      # Returns Hash API response.
+      def del_db(options = {})
+        perform_request({
+          api_function: 'deldb',
+          'arg-0' => options.delete(:dbname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Authorize a remote host to access a cPanel account's MySQL users.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :hostname - String IP address or hostname that should be provided access.
+      #
+      # Returns Hash API response.
+      def add_host(options = {})
+        perform_request({
+         api_function: 'addhost',
+         'arg-0' => options.delete(:hostname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Remove host access permissions from MySQL.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :host - String IP address or hostname that should be provided access.
+      #
+      # Returns Hash API response.
+      def del_host(options = {})
+        perform_request({
+          api_function: 'delhost',
+          'arg-0' => options.delete(:host)
+        }.merge(default_options(options)))
+      end
+
+      private
+
+      def default_options(options)
+        { api_version: 1, response_key: 'data' }.merge(options)
+      end
+    end
+  end
+end

data/lib/lumberg/version.rb

@@ -1,3 +1,3 @@
 module Lumberg
-  VERSION = '2.0.0.pre12'
+  VERSION = '2.0.0.pre15'
 end

data/lib/lumberg/whm/server.rb

@@ -1,4 +1,4 @@
-Faraday.register_middleware :response, format_whm: Lumberg::FormatWhm
+Faraday::Response.register_middleware format_whm: Lumberg::FormatWhm
 
 module Lumberg
   module Whm
@@ -170,6 +170,26 @@ module Lumberg
         perform_request('reboot', {response_key: "reboot"})
       end
 
+      def list_hooks
+        request = perform_request('list_hooks',
+                                  response_key: 'data',
+                                  :'api.version' => 1)
+
+        request[:success] = request.has_key?(:params)
+
+        request
+      end
+
+      def edit_hook(options = {})
+        request = perform_request('edit_hook',
+                                  options.merge(:'api.version' => 1,
+                                                response_key: 'metadata'))
+
+        request[:success] = request[:params][:reason] == 'OK'
+
+        request
+      end
+
       def account
         @account ||= Account.new(server: self)
       end

data/spec/cpanel/contact_spec.rb

@@ -29,7 +29,7 @@ module Lumberg
       let(:email_address) { "testing@lumberg-test.com" }
       let(:result) { Hash.new }
 
-      use_vcr_cassette("cpanel/contact/update", record: :new_episodes)
+      use_vcr_cassette("cpanel/contact/update")
 
       context "configure contact email address and enables notifications" do
         it "should setup email address and bandwidth limit notification" do

data/spec/cpanel/mysql_db_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+module Lumberg
+  describe Cpanel::MysqlDb do
+    let(:server) { Whm::Server.new(host: @whm_host, hash: @whm_hash) }
+    let(:api_username) { "lumberg" }
+    let(:mysql_db) do
+      described_class.new(
+        server: server,
+        api_username: api_username
+      )
+    end
+
+    describe "#add_db" do
+      use_vcr_cassette("cpanel/mysql_db/add_db")
+
+      it "adds a db" do
+        mysql_db.add_db(dbname: 'cpanel')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#add_user" do
+      use_vcr_cassette("cpanel/mysql_db/add_user")
+
+      it "adds a user" do
+        mysql_db.add_user(username: 'first', password: 'first_pass')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#add_user_db" do
+      use_vcr_cassette("cpanel/mysql_db/add_user_db")
+
+      it "adds a user to a db" do
+        mysql_db.add_user_db(dbname: 'lumberg_cpanel', dbuser: 'lumberg_first',
+                             perms_list: 'all')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#number_of_dbs" do
+      use_vcr_cassette("cpanel/mysql_db/number_of_dbs")
+
+      it "gets number of dbs" do
+        mysql_db.number_of_dbs[:params][:result].should eq("1")
+      end
+    end
+
+    describe "#check_db" do
+      use_vcr_cassette("cpanel/mysql_db/check_db")
+
+      it "checks db" do
+        mysql_db.check_db(dbname: 'lumberg_cpanel')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#repair_db" do
+      use_vcr_cassette("cpanel/mysql_db/repair_db")
+
+      it "repairs the db" do
+        mysql_db.repair_db(dbname: 'lumberg_cpanel')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#update_privs" do
+      use_vcr_cassette("cpanel/mysql_db/update_privs")
+
+      it "updates privileges" do
+        mysql_db.update_privs[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#init_cache" do
+      use_vcr_cassette("cpanel/mysql_db/init_cache")
+
+      it "refreshes the cache of MySQL information" do
+        mysql_db.init_cache[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#del_user_db" do
+      use_vcr_cassette("cpanel/mysql_db/del_user_db")
+
+      it "disallows a user from accessing a db" do
+        mysql_db.del_user_db(dbname: 'lumberg_cpanel', dbuser: 'lumberg_first')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#del_user" do
+      use_vcr_cassette("cpanel/mysql_db/del_user")
+
+      it "deletes a user" do
+        mysql_db.del_user(dbuser: 'lumberg_first')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#del_db" do
+      use_vcr_cassette("cpanel/mysql_db/del_db")
+
+      it "deletes a db" do
+        mysql_db.del_db(dbname: 'lumberg_cpanel')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#add_host" do
+      use_vcr_cassette("cpanel/mysql_db/add_host")
+
+      it "adds a host" do
+        mysql_db.add_host(hostname: 'cpanel_test.com')[:params][:result].should_not be_nil
+      end
+    end
+
+    describe "#del_host" do
+      use_vcr_cassette("cpanel/mysql_db/del_host")
+
+      it "deletes a host" do
+        mysql_db.del_host(host: 'cpanel_test.com')[:params][:result].should_not be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 require 'rspec'
 require 'lumberg'
 require 'lumberg/exceptions'
+require 'webmock/rspec'
 require 'vcr'
 require 'timeout'
 
@@ -36,4 +37,3 @@ RSpec.configure do |c|
     end
   end
 end
-

data/spec/vcr_cassettes/cpanel/contact/update.yml

@@ -1,40 +1,40 @@
---- 
-http_interactions: 
-- request: 
+---
+http_interactions:
+- request:
     method: get
-    uri: https://myhost.com:2087/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_func=savecontactinfo&cpanel_jsonapi_module=CustInfo&cpanel_jsonapi_user=lumberg&email=testing@lumberg-test.com&notify_bandwidth_limit=1&notify_disk_limit&notify_email_quota_limit
-    body: 
+    uri: https://myhost.com:2087/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_func=savecontactinfo&cpanel_jsonapi_module=CustInfo&cpanel_jsonapi_user=lumberg&email=testing@lumberg-test.com&notify_bandwidth_limit=1&notify_disk_limit=&notify_email_quota_limit=
+    body:
       string: ""
-    headers: 
-      Authorization: 
+    headers:
+      Authorization:
       - WHM root:iscool
-      Accept: 
+      Accept:
       - "*/*"
-      User-Agent: 
+      User-Agent:
       - Faraday v0.8.7
-  response: 
-    status: 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      Date: 
+    headers:
+      Date:
       - Thu, 16 May 2013 06:22:30 GMT
-      Server: 
+      Server:
       - cpsrvd/11.36.0.4
-      Content-Length: 
+      Content-Length:
       - "1008"
-      Connection: 
+      Connection:
       - Keep-Alive
-      X-Keep-Alive-Count: 
+      X-Keep-Alive-Count:
       - "1"
-      Keep-Alive: 
+      Keep-Alive:
       - timeout=70, max=200
-      Content-Type: 
+      Content-Type:
       - application/json; charset="utf-8"
-    body: 
+    body:
       string: |
         {"cpanelresult":{"event":{"result":1},"module":"CustInfo","apiversion":2,"data":[{"display_value":"off","descp":"Send notifications to your contact email address when you are reaching your disk quota.","value":0,"name":"notify_disk_limit"},{"display_value":"testing@lumberg-test.com","descp":"Email address that you can be contacted at.  This should be an email address that is not on your account if you have one.","value":"testing@lumberg-test.com","name":"email"},{"display_value":"off","descp":"Send notifications to your contact email address when one of your email accounts approaches or is over quota.","value":0,"name":"notify_email_quota_limit"},{"display_value":"","descp":"If you wish to provide a second email address to receive notifications, enter it here.","value":"","name":"second_email"},{"display_value":"on","descp":"Send notifications to your contact email address when you are reaching your bandwidth usage limit.","value":1,"name":"notify_bandwidth_limit"}],"func":"savecontactinfo"}}
 
-    http_version: 
+    http_version:
   recorded_at: Thu, 16 May 2013 06:17:43 GMT
 recorded_with: VCR 2.0.1