whmcsor 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52c90daef743f65b7db99fcf29dda73557970540
+  data.tar.gz: e9c0a6cf38dd6d1f99cff6c3b4eb3d2068f4643f
+SHA512:
+  metadata.gz: f5dfcb327f57a055e5686680b58a29a4e6adad63019c7b12470b7ed6d15221cc6864aff9401b254a491e0ee894aa12aec45658c6e9f09044bf5577393609616d
+  data.tar.gz: a67ac5475c4ca7714acbbfa38581f7b2eb99d2a0b8dbe34c308e761dfcf106e8b8c018f9af16a6afa7f73c9c40c431cc869363fc20a53a79758b81753ab8df41

data/.gitignore

@@ -0,0 +1,19 @@
+bin/
+*.swp
+*.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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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,21 @@
+# Whmcsor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'whmcsor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whmcsor
+
+## Usage
+
+TODO: Write usage instructions here

data/Rakefile

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

data/lib/whmcsor/base.rb

@@ -0,0 +1,94 @@
+module Whmcsor
+  # Whmcsor:Base class is the main class used to extend WHMCS API subclasses
+  class Base
+
+    # Public - Send request to the WHMCS API
+    def send_request(params = {})
+      if params[:action].nil?
+        raise ArgumentError, "No API action set"
+      end
+      check_config
+      check_whmcs_details
+
+      params.merge!(
+        username: Whmcsor.config[:whmcs_user],
+        password: Digest::MD5.new.hexdigest(Whmcsor.config[:whmcs_pass]),
+        responsetype: 'json'
+      )
+
+      agent = Mechanize.new
+
+      # Set User-Agent
+      agent.user_agent_alias = select_user_agent
+
+      #
+      # Use Proxy to connect instead of a direct connection
+      #
+      unless Whmcsor.config[:proxy_ip].nil? &&
+        Whmcsor.config[:proxy_port].nil?
+        agent.set_proxy(Whmcsor.config[:proxy_ip],
+                        Whmcsor.config[:proxy_port].to_i)
+      end
+
+      #
+      # Set HTTP Authentication block
+      #
+      unless Whmcsor.config[:auth_user].nil?
+        agent.add_auth(Whmcsor.config[:whmcs_url],
+                       Whmcsor.config[:auth_user],
+                       Whmcsor.config[:auth_pass] )
+      end
+
+      #
+      # Send request
+      #
+      page = agent.post(Whmcsor.config[:whmcs_url], params)
+      res = JSON.parse(page.content)
+      if res['result'] == 'error'
+        puts "Error ocurred: #{res['message']}"
+      else
+        res
+      end
+    end
+
+    # Public - Check if WHMCS settings have been set
+    #
+    # Returns nil
+    def check_whmcs_details
+      begin
+        Whmcsor.config[:whmcs_user]
+        Whmcsor.config[:whmcs_pass]
+      rescue NoMethodError
+        raise ArgumentError, 'Missing WHMCS login details'
+      end
+    end
+
+    # Public - Check config entries
+    #
+    # Returns nil
+    def check_config
+      if Whmcsor.config.empty?
+        fail ArgumentError, 'Whmcsor configuration must be provided'
+      end
+    end
+
+    # Public - Pick random user agent
+    #
+    # Returns String
+    def select_user_agent
+      ua = ['Linux Firefox (3.6.1)', 'Linux Konqueror (3)', 'Linux Mozilla',
+        'Mac Firefox (3.6)', 'Mac Mozilla', 'Mac Safari (5)', 'Mac Safari 4',
+        'Windows IE 6', 'Windows IE 7', 'Windows IE 8', 'Windows IE 9',
+        'Windows Mozilla', 'iPhone (3.0)', 'iPad', 'Android (Motorola Xoom)']
+
+      case Whmcsor.config[:user_agent]
+      when nil
+        'Mac Safari'
+      when 'random'
+        ua.sample
+      else
+        Whmcsor.config[:user_agent]
+      end
+    end
+  end
+end

data/lib/whmcsor/client.rb

@@ -0,0 +1,191 @@
+module Whmcsor
+  # Provides WHMCS client API integration
+  class Client < Base
+
+    # Public - Add client
+    #
+    # params - Hash parameters:
+    #           :firstname
+    #           :lastname
+    #           :email
+    #           :address1
+    #           :city
+    #           :state
+    #           :postcode
+    #           :country - two letter ISO country code
+    #           :phonenumber
+    #           :password2 - password for the new user account
+    #
+    #           :companyname - optional
+    #           :address2 - optional
+    #           :currency - the ID of the currency to set the user to
+    #           :clientip - Pass the client IP address
+    #           :language - the language to assign to the client
+    #           :groupid - used to assign the client to a client group
+    #           :securityqid - the ID of the security question for the user
+    #           :securityqans - the answer to the client security question
+    #           :notes
+    #           :cctype - Visa, Mastercard, etc...
+    #           :cardnum
+    #           :expdate - in the format MMYY
+    #           :startdate
+    #           :issuenumber
+    #           :customfields - a base64 encoded serialized array of custom
+    #                           field values
+    #           :noemail - pass as true to surpress the client signup welcome
+    #                       email sending
+    #           :skipvalidation - set true to not validate or check required
+    #                              fields
+    #
+    # Example:
+    #   params = { :firstname: 'John',
+    #   :lastname 'Doe',
+    #   :email 'john@doe.com',
+    #   :address1 'Silent Hill 12',
+    #   :city 'Silent Hill',
+    #   :state 'Silent Hill',
+    #   :postcode '12919',
+    #   :country 'SH',
+    #   :phonenumber '001224221221',
+    #   :password2 'RANDOM-PW-HER'
+    #   }
+    #
+    #   client = Whmcsor::Client.new
+    #   client.add_client(params)
+    #   # => { 'result' => 'success', 'clientid' => '99' )
+    #
+    # Returns JSON value
+    def add_client( params = {} )
+      params.merge!(
+        action: 'addclient'
+      )
+
+      send_request(params)
+    end
+
+    # Public - Get clients list
+    #
+    # params - Hash parameters:
+    #           :limitstart - Record to start at (default = 0)
+    #           :limitnum - Number of records to return (default = 25)
+    #           :search - Can be passed to filter for clients with a name/email
+    #             matching the term entered
+    #
+    # Returns JSON
+    def get_clients( params = {} )
+      params.merge!(
+        action: 'getclients'
+      )
+
+      send_request(params)
+    end
+
+    # Public - Get Client details from WHMCS API
+    #
+    # params - Hash parameters:
+    #               :clientid - the id number of the client
+    #               :email - the email address of the client
+    #
+    # Example:
+    #   client = Whmcsor::Client.new
+    #   client.get_client_details( { clientid: 1 } )
+    #   client.get_client_details( { email: 'john@doe.com' } )
+    #
+    #
+    # Returns Hash
+    def get_client_details(params = {})
+      params.merge!( action: 'getclientsdetails')
+      send_request(params)
+    end
+
+    # Public - Delete client from the WHMCS installation
+    #
+    # params - Hash parameters
+    #           :clientid - the id number of the client
+    #
+    # Example:
+    #
+    #   client = Whmcsor::Client.new
+    #   client.delete_client( { clientid: 1 })
+    #   # => { 'result' => 'success', 'clientid' => 'id' }
+    #
+    # Returns Hash
+    def delete_client(params = {})
+      params.merge!( action: 'deleteclient' )
+      send_request(params)
+    end
+
+
+    # Public - Close a client account, terminates all products and canceles all
+    # invoices.
+    #
+    # params - Hash parameters
+    #           :clientid - the id number of the client
+    #
+    # Returns Hash
+    def close_client(params = {})
+      params.merge!( action: 'closeclient')
+      send_request(params)
+    end
+
+    # Public - Get quotes
+    #
+    # params - Hash parameters
+    #         :quoteid - specific quote to obtain
+    #         :userid - obtain quotes for a specific user
+    #         :datecreated - Format YYYYMMDD
+    #         :lastmodified - Format YYYYMMDD
+    #         :validuntil - Format YYYYMMDD
+    #         :stage - Specific stage to retrieve quotes for
+    #         :subject - to obtain quotes with a specific subject
+    #         :limitstart - for pagination, specify an ID to start at
+    #         :limitnum - to restrict the number of results returned
+    #
+    # Returns Hash
+    def get_quotes(params = {})
+      params.merge!( action: 'getquotes' )
+      send_request(params)
+    end
+
+    # Public - Create a new contact under the clients account
+    #
+    # params - Hash paramters
+    #         :clientid - the id number of the client
+    #
+    #         Optional fields:
+    #             firstname
+    #             lastname
+    #             companyname
+    #             email - must be unique if creating a sub-account
+    #             address1
+    #             address2
+    #             city
+    #             state
+    #             postcode
+    #             country - two letter ISO country code
+    #             phonenumber
+    #             password2 - if creating a sub-account
+    #             permissions - can specify sub-account permissions
+    #             generalemails - set true to receive general email types
+    #             productemails - set true to receive product related emails
+    #             domainemails - set true to receive domain related emails
+    #             invoiceemails - set true to receive billing related emails
+    #             supportemails - set true to receive support ticket related emails
+    # Returns Hash
+    def add_contact(params = {} )
+      params.merge!(action: 'addcontact')
+      send_requst(params)
+    end
+
+    # Public - Delete the contact inside the system
+    #
+    # params - Hash parameters
+    #         :contactid - the id number of the client
+    #
+    # Returns Hash
+    def delete_contact(params = {})
+      params.merge!(action: 'deletecontact')
+      send_request(params)
+    end
+  end
+end

data/lib/whmcsor/config.rb

@@ -0,0 +1,103 @@
+module Whmcsor
+  # Configuration class for Whmcsor
+  class Config
+
+    # Public: A Hash that stores configuration info.
+    attr_accessor :config
+
+    def initialize
+      @config = {}
+    end
+
+    # Public: Hash accessor, delegates to `@config`.
+    #
+    # Returns the value from `@config`
+    def [](v)
+      @config[v]
+    end
+
+    # Public: Sets the IP address of your proxy server.
+    #
+    # value - String URL
+    #
+    # Returns value
+    def proxy_ip(value)
+      @config[:proxy_ip] = value
+    end
+
+    # Public: Sets the port of your proxy server.
+    #
+    # port - String port
+    #
+    # Returns value
+    def proxy_port(port)
+      @config[:proxy_port] = port
+    end
+
+    # Public: Sets the WHMCS API URL
+    #
+    # value - The String URL
+    #
+    # Returns value.
+    def whmcs_url(value)
+      @config[:whmcs_url] = value
+    end
+
+    # Public: Sets the WHMCS API username
+    #
+    # value - The String username
+    #
+    # Returns value
+    def whmcs_user(value)
+      @config[:whmcs_user] = value
+    end
+
+    # Public: Sets the WHMCS API password
+    #
+    # value - The String password
+    #
+    # Returns value
+    def whmcs_pass(value)
+      @config[:whmcs_pass] = value
+    end
+
+    # Public: Sets the WHMCS API Key for access from undefined IP addresses.
+    # More information on the subject: http://docs.whmcs.com/API:Access_Keys
+    #
+    # value - The String API key
+    #
+    # Returns value
+    def whmcs_api_key(value)
+      @config[:whmcs_api_key] = value
+    end
+
+    # Public: Sets the HTTP Auth information, if the WHMCS API page is password
+    # protected
+    #
+    # value - String HTTP Auth username
+    #
+    # Returns value
+    def auth_user(value)
+      @config[:auth_user] = value
+    end
+
+    # Public: Sets the HTTP Auth password for the WHMCS API access
+    #
+    # value - String HTTP Auth password
+    #
+    # Returns value
+    def auth_pass(value)
+      @config[:auth_pass] = value
+    end
+
+    # Public: Sets the User Agent shortcut used by Mechanize
+    #
+    # value - String User Agent
+    #
+    # Returns value
+    def user_agent(value)
+      @config[:user_agent] = value
+    end
+
+  end
+end

data/lib/whmcsor/orders.rb

@@ -0,0 +1,119 @@
+module Whmcsor
+  # WHMCS API Orders class
+  class Orders < Base
+
+    # Public - Add new order trough WHMCS API
+    #
+    # params - Hash parameters
+    #
+    # Returns Hash
+    def add_order(params = {})
+      params.merge!(action: 'addorder')
+      send_request(params)
+    end
+
+    # Public - Retrieve the lilst of orders from WHMCS API
+    #
+    # params - Hash parameters
+    #
+    # Return Hash
+    def get_orders(params = {})
+      params.merge!(action: 'getorders')
+      send_request(params)
+    end
+
+    # Public - Get order statuses and their count
+    #
+    # params - hash parameters
+    #
+    # Returns Hash
+    def get_order_statuses(params = {})
+      params.merge!(action: 'getorderstatuses')
+      send_request(params)
+    end
+
+    # Public - Retrieve product details
+    #
+    # params - Hash parameters
+    #     :pid - Product ID
+    #     :gid - Product Group ID
+    #     :module - retrieve products assigned to a sepcific module
+    #
+    # Returns Hash
+    def get_products(params = {})
+      params.merge!(action: 'getproducts')
+      send_request(params)
+    end
+
+    # Public - Accept a pendingo order inside the system
+    #
+    # params - hash parameters
+    #     :orderid - Order ID which will be accepted
+    #
+    #     Optional parameters:
+    #         :serverid - the Server ID to provision any hosting products in the
+    #         order to, overrides default
+    #         :serviceusername - the Username to assign for provisioning,
+    #         overrides default
+    #         :servicepassword - the Password to assign for products being
+    #         provisioned, overrides auto generation
+    #         :registrar - the domain registrar module to assign any domains to
+    #         :autosetup - true/false - determines whether product provisioning
+    #         is performed
+    #         :sendregistrar - true/false determines whether domain automation
+    #         is performed
+    #         :sendemail - true/false - sets if welcome emails for products and
+    #         registration confirmation emails for domains should be sent
+    #
+    # Returns Hash
+    def accept_order(params = {})
+      params.merge!(action: 'acceptorder')
+      send_request(params)
+    end
+
+    # Public - Change order status to pending
+    #
+    # params - Hash parameters
+    #       :orderid
+    #
+    # Returns Hash
+    def pending_order(params = {})
+      params.merge!(action: 'pendingorder')
+      send_request(params)
+    end
+
+    # Public - Cancel a pendingo order inside the WHMCS system
+    #
+    # params - Hash parameters
+    #     :orderid - ID of the order :)
+    #
+    # Returns Hash
+    def cancel_order(params = {})
+      params.merge!(action: 'cancelorder')
+      send_request(params)
+    end
+
+    # Public - Set order as Fraud in the system
+    #
+    # params - Hash parameters
+    #   :orderid - ID of the order inside WHMCS
+    #
+    # Returns Hash
+    def fraud_order(params = {})
+      params.merge!(action: 'fraudorder')
+      send_request(params)
+    end
+
+    # Public - Delete order from WHMCS
+    #
+    # params - Hash parameters
+    #   :orderid - ID of the order
+    #
+    # Returns Hash
+    def delete_order(params = {})
+      params.merge!(action: 'deleteorder')
+      send_request(params)
+    end
+
+  end
+end

data/lib/whmcsor/payment.rb

@@ -0,0 +1,240 @@
+module Whmcsor
+  class Payment < Base
+
+    # Public - Retrieve invoices for a specific client or in specific status
+    #
+    # params - Hash parameters
+    #
+    #         :userid - ID of the client/user
+    #         :status - Paid, Unpaid, Cancelled, Overdue
+    #         :limitstart - offset number to start when returning results
+    #         (default: 0)
+    #         :limitnum - number of records to return (default: 25)
+    #
+    # Returns Hash
+    def get_invoices(params = {})
+      params.merge!( action: 'getinvoices')
+      send_request(params)
+    end
+
+    # Public - Obtain invoice for a client
+    #
+    # params - Hash parameters
+    #         :invoiceid - ID of the invoice
+    #
+    # Returns Hash
+    def get_invoice(params = {})
+      params.merge!(action: 'getinvoice')
+      send_request(params)
+    end
+
+    # Public - Create a new invoice for client
+    #
+    # params - Hash parameters
+    #       :userid - should contain the user ID of the client
+    #       :date - The date the invoice is created in the format YYYYMMDD
+    #       :duedate - The date that the invoice is due in the format YYYYMMDD
+    #       :paymentmethod - The payment method for the invoice
+    #       :ithemdescription1 - item1 description
+    #       :itemamount1 - item 1 amount
+    #       :itemtaxed1 - if set to true the item will be taxed
+    #
+    # Optional arguments:
+    #       :taxrate - the rate of the tax that should be charged
+    #       :taxrate2 - the 2nd tax rate that should be charged
+    #       :notes - any additional notes the invoice should contain
+    #       :sendinvoice - set to true to send the "Invoice Created" email to
+    #       the customer
+    #       :autoapplycredit - pass as true to auto apply any credit from the
+    #       clients credit balance
+    #       :itemdescription2 - item 2 description
+    #       :itemamount2 - item 2 amount
+    #       :itemtaxed2 - set to true if the 2nd item should be taxed.
+    #
+    # Returns Hash
+    def create_invoice(params = {})
+      params.merge!(action: 'createinvoice')
+      send_request(params)
+    end
+
+    # Public - Update the invoice inside the WHMCS system
+    #
+    # params - Hash parameters
+    #         :invoiceid - ID of the invoice that needs to be updated
+    #
+    # Optional arguments:
+    #         :itemdescription - Array of existing line item descriptions to
+    #         update. Line ID from database needed. itemamount and itemtaxed
+    #         should be passed when updating the description.
+    #         :itemamount - Array of existing line item amounts to update
+    #         :itemtaxed - Array of existing line items taxed or not
+    #         :newitemdescription - Array of new line item descriptipons to add
+    #         :newitemamount - Array of new line item amounts
+    #         :newitemtaxed - Array of new line items taxed or not
+    #         :date - date of invoice format yyyymmdd
+    #         :duedate - duedate of invoice in format YYYYMMDD
+    #         :datepaid - date invoice was paid format YYYYMMDD
+    #         :status - Status of the invoice - Unpaid, Paid, Cancelled,
+    #         Collection, Refunded
+    #         :paymentmethod - payment method of invoice eg paypal, banktransfer
+    #         :notes - Invoice notes
+    #         :deletelineids - an array of line IDs for the current invoice to
+    #         remove (tblinvoiceitems.id)
+    #
+    # Returns Hash
+    def update_invoice(params = {})
+      params.merge!(action: 'updateinvoice')
+      send_request(params)
+    end
+
+    # Public - This API call is used to add payment to the invoice
+    #
+    # params - Hash parameters
+    #         :invoiceid - ID of the invoice
+    #         :transid - transaction number for the payment
+    #         :gateway - gateway used in system name format, eg. paypal,
+    #         authorize, etc...
+    #
+    # Optional arguments:
+    #         :amount - should contact the amount paid, can be left blank to
+    #         take full amount of invoice
+    #         :fees -  if set defines how much fees were involved in the
+    #         transaction
+    #         :noemail - set to true to not send an email for the invoice
+    #         payment
+    #         :date -  if set defines the date the payment was made Format:
+    #         YYYY-MM-DD HH:mm:ss
+    #
+    # Returns Hash
+    def add_invoice_payment(params = {})
+      params.merge!(action: 'addinvoicepayment')
+      send_request(params)
+    end
+
+    # Public - Attempt to capture payment when an invoice is set to a merchant
+    # gateway module .
+    #
+    # params - Hash parameters
+    #         :invoiceid - the ID of the invoice the capture is to be attempted
+    #         for
+    #
+    # Optional arguments:
+    #         :cvv - an be used to pass the cards verification value in the
+    #         payment request
+    #
+    # Returns Hash
+    def capture_payment(params = {})
+      params.merge!(action: 'capturepayment')
+      send_request(params)
+    end
+
+    # Public - Apply credit from clients credit balance to an invoice inside
+    # WHMCS
+    #
+    # params - Hash parameters
+    #         :invoiceid - the ID of the invoice to apply credit to
+    #         :amount - the amount of credit to apply (must be less than or
+    #         equal to clients available credit balance)
+    #
+    # Returns Hash
+    def apply_credit(params = {})
+      params.merge!(action: 'applycredit')
+      send_request(params)
+    end
+
+    # Public - Add new bilable item to the system
+    #
+    # params - Hash parameters
+    #         :clientid - Used ID to apply the change to
+    #         :description - Description shown to client when invoiced
+    #         :hours - number of hours/quantity (not required for single
+    #         quantity)
+    #         :amount - Total amount to invoice for
+    #         :invoiceaction - noinvoice, nextcron, nextinvoice, duedate, recur
+    #
+    # Optional arguments:
+    #         :duedate - date the invoice should be due (only required for
+    #         duedate & recur invoice actions)
+    #         :recur - frequency to recur - 1,2,3,etc...
+    #         :recurcycle - Days, Weeks, Months or Years
+    #         :recurfor - number of times to repeat
+    #
+    # Returns Hash
+    def add_billable_item(params = {})
+      params.merge!(action: 'addbillableitem')
+      send_request(params)
+    end
+
+    # Public - Add credit to the client
+    #
+    # params - Hash parameters
+    #         :clientid - D of the client the credit is to be added to
+    #         :description - reason for credit being added (stored in admin
+    #         credit log)
+    #         :amount - the amount to be added
+    #
+    # Returns Hash
+    def add_credit(params = {})
+      params.merge!(action: 'addcredit')
+      send_request(params)
+    end
+
+    # Public - Add transaction
+    #
+    # params - Hash parameters
+    #         :amountin - amount to add to the account
+    #         :amountout - if an outgoing enter this
+    #         :paymentmethod - gateway used in WHMCS
+    #         :date - date of transaction (same format as your WHMCS eg
+    #         DD/MM/YYYY)
+    #
+    # Optional arguments:
+    #         :userid - Add Transaction to a user
+    #         :invoiceid - Add transaction to a particular invoice
+    #         :description - Description of the transaction
+    #         :fees - transaction fee you were charged
+    #         :transid - Transaction ID you wish to assign
+    #         :credit - set to true to add the transaction as credit to the
+    #         client
+    #
+    # Return Hash
+    def add_transaction(params = {})
+      params.merge!(action: 'addtransaction')
+      send_request(params)
+    end
+
+    # Public - Update transaction
+    #
+    # params - Hash parameters
+    #         :transcationid - he Transaction ID to update. tblaccounts.id. This
+    #         is not the transid from the gateway
+    #
+    # Optional arguments:
+    #         :userid - Add Transaction to a user
+    #         :currency - Currency ID for a transaction
+    #         :gateway - Gateway to assign transaction to
+    #         :date - date of transaction YYYYMMDD
+    #         :description - Description of the transaction
+    #         :amountin - amountto add to the account
+    #         :fees - transaction fee you were charged
+    #         :rate - exchange rate based on master currency
+    #         :transid - Transcation ID you wish to assign
+    #         :invoiceid - Add transcation to the particular invoice
+    #         :refundid - Add a refund ID if this is a refund transaction
+    #
+    # Returns Hash
+    def update_transaction(params = {})
+      params.merge!(action: 'updatetransaction')
+      send_request(params)
+    end
+
+    # Public - Get a list of payment methods available
+    #
+    # Returns Hash
+    def get_payment_methods
+      params = { action: 'getpaymentmethods'}
+      send_request(params)
+    end
+
+  end
+end

data/lib/whmcsor/version.rb

@@ -0,0 +1,3 @@
+module Whmcsor
+  VERSION = "0.0.2"
+end

data/lib/whmcsor.rb

@@ -0,0 +1,70 @@
+require 'mechanize'
+require 'net/http'
+require 'json'
+require 'crack'
+require 'digest'
+
+require "whmcsor/version"
+
+module Whmcsor
+  autoload :Config, 'whmcsor/config'
+  autoload :Base, 'whmcsor/base'
+  autoload :Client, 'whmcsor/client'
+  autoload :Orders, 'whmcsor/orders'
+  autoload :Payment, 'whmcsor/payment'
+
+  extend self
+
+  # Config
+  attr_accessor :configuration
+
+  # Config
+  attr_accessor :configuration_file
+
+  self.configuration ||= Whmcsor::Config.new
+
+  # Public - Configures Whmcsor
+  #
+  # Example
+  #
+  #   Whmcsor.config do |c|
+  #     c.proxy_ip '127.0.0.1'
+  #     c.proxy_port '8118
+  #     c.whmcs_url 'http://whmcs.url.com/api.php'
+  #     c.whmcs_user 'username'
+  #     c.whmcs_pass 'password
+  #     c.whmcs_api_key 'xxxxx'
+  #   end
+  # Returns Hash
+  def config
+    yield self.configuration if block_given?
+    self.configuration.config
+  end
+
+  # Public - Load the configuration out of a YAML file
+  #
+  # file - Path to the YAML file, default '~/.whmcsor.yaml'
+  #
+  # Raises ArgumentError if the config file does not exist
+  #
+  # Example
+  #
+  #   # Load default configuration file from '~/.whmcsor.yaml'
+  #   Whmcsor.config_file
+  #
+  #   # Load custom configuration file
+  #   Whmcsor.config_file '/path/to/.whmcsor.yaml'
+  #
+  # Returns nothing
+  def config_file( file = File.expand_path('~/.whmcsor.yaml'))
+    if File.exists?(file)
+      self.configuration_file = file
+    else
+      raise ArgumentError, "Configuration file doesn't exist '#{file}'"
+    end
+
+    config do |c|
+      YAML::load_file(file).each { |k, v| c.send(k, v) }
+    end
+  end
+end

data/whmcsor.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whmcsor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whmcsor"
+  spec.version       = Whmcsor::VERSION
+  spec.authors       = ["v0x.Osho"]
+  spec.email         = ["osho@v0x.pw"]
+  spec.description   = %q{WHMCS API gem}
+  spec.summary       = %q{Connect to WHMCS API}
+  spec.homepage      = "http://dev.v0x.pw/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency 'mechanize'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: whmcsor
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- v0x.Osho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: WHMCS API gem
+email:
+- osho@v0x.pw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/whmcsor.rb
+- lib/whmcsor/base.rb
+- lib/whmcsor/client.rb
+- lib/whmcsor/config.rb
+- lib/whmcsor/orders.rb
+- lib/whmcsor/payment.rb
+- lib/whmcsor/version.rb
+- whmcsor.gemspec
+homepage: http://dev.v0x.pw/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Connect to WHMCS API
+test_files: []