whmcs_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f2bc65a8ff5dd9ea70567790aa507ed77c01060
+  data.tar.gz: 8c39f3ad2f7c0cf0e6d0c0d9b8ab95550f27af69
+SHA512:
+  metadata.gz: d85ef8cc744fc624291864e23f3547d1853332c0036c4bfec044ba39cbdf3633e85c98bf53ec43c2d5c011d7c6fd9889554a03e0c07d0dabbdc9966269ee7865
+  data.tar.gz: 72d414fbc9f96d2765691130f460038ad41db0e1b9920596f0332abb0c6e34072dada5eba9ca20ca24d592855c1ff63bef71aecb1907b3325008fdc9f4a036e8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,93 @@
+= Whmcs API
+
+Ruby library for the WHMCS API ({API Reference}[http://docs.whmcs.com/API]).
+
+== Instalation
+
+WHMCS API library requires Ruby 1.9.3 or later. To install, add this line to your
++Gemfile+ and run <tt>bundle install</tt>:
+
+  gem 'whmcs_api', require: 'whmcs'
+
+You need use <tt>require: 'whmcs'</tt> parameter to automatically include the library. It's need, becouse
+the gem and the library have different names.
+
+
+== Configuration
+
+By default module uses configuration from <tt>config/whmcs.yml</tt> file. To generate it run:
+
+  rake whmcs:install
+
+This command generates file <tt>config/whmcs.yml</tt> which contains configuration for each environment
+
+  default: &default
+    api_user: xxxxxxxxx
+    api_password: xxxxxxxxx
+    api_url: https://your.domain.com/includes/api.php
+    http_auth_user: xxx
+    http_auth_password: xxx
+
+  production:
+    <<: *default
+
+  development:
+    <<: *default
+
+  test:
+    <<: *default
+
+Fill in +api_user+, +api_password+ and +api_url+ for each environment or use +default+ template. If your
+WHMCS installation uses Basic HTTP Auth, use +http_auth_user+ and +http_auth_password+ options.
+
+You can configure module at runtime if you need:
+
+  Whmcs.configure do |config|
+    config.api_user = 'xxxxx'
+    config.api_password = 'xxxxxx'
+    config.api_url = 'https://your.domain.com/includes/api.php'
+  end
+
+or set each configuration option separately:
+
+  Whmcs.config.api_user = 'xxxxxx'
+
+== Usage
+
+To use library you need to create an instance of Whmcs::Api class and call it methods:
+
+  @api = Whmcs::Api.new
+  @api.execute_command(:getclientsdetails, clientid: 2803)
+
+Last line returns a result hash:
+  {:result=>"success", 
+    :userid=>"2803", 
+    :id=>"2803", 
+    :firstname=>"Bogdan", 
+    :lastname=>"Guban", 
+    :fullname=>"Bogdan Guban"
+    ...
+
+or +false+ if an error was occurred. All error messages stores in an +errors+ method.
++errors+ method is a functionality of <tt>ActiveModel::Validations</tt> module.
+
+  @api.errors.messages
+
+returns:
+
+  {:base=>["Client Not Found"]}
+
+If you prefer to work with exceptions you can use functions with <tt>!</tt> suffix. For example:
+
+  begin
+    @api = Whmcs::Api.new
+    @api.execute_command!(:getclientsdetails, clientid: 10000)
+  rescue Exception => e
+    puts e.message  # => Client Not Found
+  end
+
+
+====== TODO
+
+- Write tests
+- Write documentation

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Whmcs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/tasks/config/whmcs.yml

@@ -0,0 +1,15 @@
+default: &default
+  api_user: xxxxxxxxx
+  api_password: xxxxxxxxx
+  api_url: https://your.domain.com/includes/api.php
+  http_auth_user: xxx
+  http_auth_password: xxx
+
+production:
+  <<: *default
+
+development:
+  <<: *default
+
+test:
+  <<: *default

data/lib/tasks/whmcs_tasks.rake

@@ -0,0 +1,10 @@
+namespace :whmcs do
+
+  desc 'Configure environment to use whmcs plugin'
+  task :install do
+    # copy configuration file template to config directory
+    FileUtils.cp(File.expand_path('../config/whmcs.yml', __FILE__), File.expand_path('config', Rails.root))
+    puts 'Copied file whmcs.yml to config path'
+  end
+
+end

data/lib/whmcs.rb

@@ -0,0 +1,20 @@
+require 'whmcs/railtie'
+require 'whmcs/configuration'
+require 'curb'
+require 'php_serialize'
+
+module Whmcs
+  autoload :Api, 'whmcs/api'
+
+  # Gives access to the current configuration
+  def self.config
+    @configuration ||= Configuration.new
+  end
+
+  # Allows easy setting of multiple configuration options. See Configuration
+  # for all available options.
+  def self.configure
+    config = self.config
+    yield(config)
+  end
+end

data/lib/whmcs/api.rb

@@ -0,0 +1,86 @@
+module Whmcs
+
+  class Api
+    include ActiveModel::Validations
+
+    def execute_command!(command, params={})
+      # Clear errors from previous request
+      errors.clear
+
+      # Set local variables
+      @command = command.to_s
+      @params = process_params(params)
+
+
+      # Assemble request_options
+      request_options = {
+          action: @command,
+          username: Whmcs.config.api_user,
+          password: Digest::MD5.hexdigest(Whmcs.config.api_password),
+          responsetype: 'json'
+      }
+      request_options.merge! @params
+
+      begin
+        # send curl request to the Whmcs server
+        curl = Curl::Easy.new(Whmcs.config.api_url)
+        curl.ssl_verify_peer = false
+        curl.ssl_verify_host=0
+        if Whmcs.config.http_auth_user.present?
+          curl.http_auth_types = :basic
+          curl.username = Whmcs.config.http_auth_user
+          curl.password = Whmcs.config.http_auth_password
+        end
+        curl.http_post(request_options.to_query)
+        curl.perform
+
+        # handle response
+        result = JSON.parse(curl.body_str, symbolize_names: true)
+      rescue Exception => e
+        # If error occurs, it adds to instance errors
+        errors.add(:base, e.message)
+        raise e
+      end
+
+      # check if error occurred
+      if result[:result] == 'error'
+        errors.add(:base, result[:message])
+        raise StandardError, result[:message]
+      end
+
+      # If all pass success, returns a result hash
+      result
+    end
+
+    # Method provides the same functionality as #execute_command! except
+    # it does not raises exceptions. When error occurs, it just returns +false+.
+    # So if method returns +false+, errors message should be in #errors
+    #
+    # == Example
+    #
+    #   @api = Whmcs::Api.new
+    #   @api.execute_command('some command', some_param: 'some value')   # => false
+    #   @api.errors.messages # => {:command=>["'some command' is invalid command"]}
+    #
+
+    def execute_command(command, options={})
+      begin
+        return execute_command!(command, options)
+      rescue
+        return false
+      end
+    end
+
+    protected
+
+    # converts params keys to symbols, joins array values and encodes hashes
+    def process_params(options)
+      options = options.clone
+      options.each do |key, value|
+        options[key] = value.join(',') if value.is_a?(Array)
+        options[key] = Base64.encode64(PHP.serialize(value)) if value.is_a?(Hash)
+      end
+    end
+
+  end
+end

data/lib/whmcs/configuration.rb

@@ -0,0 +1,26 @@
+module Whmcs
+
+  class Configuration
+
+    attr_accessor :api_user,
+                  :api_password,
+                  :api_url,
+                  :http_auth_user,
+                  :http_auth_password
+
+    def initialize
+      if defined?(Rails) and File.exist?(File.expand_path('config/whmcs.yml', Rails.root))
+        config = YAML.load_file(File.expand_path('config/whmcs.yml', Rails.root))[Rails.env]
+
+        @api_user = config['api_user'] if config['api_user'].present?
+        @api_password = config['api_password'] if config['api_password'].present?
+        @api_url = config['api_url'] if config['api_url'].present?
+
+        @http_auth_user = config['http_auth_user'] if config['http_auth_user'].present?
+        @http_auth_password = config['http_auth_password'] if config['http_auth_password'].present?
+      end
+    end
+
+  end
+end
+

data/lib/whmcs/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails'
+module Whmcs
+  class Railtie < ::Rails::Railtie
+    railtie_name :whmcs
+
+    rake_tasks do
+      load 'tasks/whmcs_tasks.rake'
+    end
+  end
+end

data/lib/whmcs/version.rb

@@ -0,0 +1,3 @@
+module Whmcs
+  VERSION = '1.0.0'
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')