virtengine / whmcs-ruby

Ruby bindings for the WHMCS API

whmcs-ruby

whmcs-ruby provides Ruby bindings for the WHMCS API.

This WHMCS repo contains pullrequests from

1. https://github.com/timrogers/whmcs-ruby
2. https://github.com/fcoury/whmcs-ruby
3. https://github.com/anvyst/whmcs-ruby
4. https://github.com/coderhs/whmcs-ruby

that are hidden inside or not merged into dotblock/whmcs-ruby

Several nice contributions haven't gone upstream or merged :(

megamsys/whmcs-ruby descends from timrogers/whmcs-ruby

Here are those.

Fix from timrogers/whmcs-ruby

1. Adds getproducts

Fix from anvyst/whmcs-ruby

1. API key access

Fix from fcoury/whmcs-ruby

1. Fixed breakage of hash, incases of special characters
2. Added WHMCS::Response as an easier wrapper for the respose
3. Attributes is now HashWithIndifferentAccess and added Response#key?
4. Added Order#upgrade_product method
5. Add cancel request though client
6. Fixed comments on Client#add_cancel_request to match overall
7. Moved add_credit from Invoice to Client

Usage

require 'whmcs'

WHMCS.configure do |config|
  config.api_url      = 'http://example.com/includes/api.php'
  config.api_username = 'someusername'
  config.api_password = 'c4ca4238a0b923820dcc509a6f75849b' # md5 hash
end

WHMCS::Client.get_clients_details(:clientid => '1')

API Access Key

Recently, WHMCS offered another type of authenticating API requests. Using API Access Key might be useful for mobile devices and/or IPv6 bug WHMCS whitelists currently have.

require 'whmcs'

WHMCS.configure do |config|
  config.api_url      = 'http://example.com/includes/api.php'
  config.api_username = 'someusername'
  config.api_password = 'c4ca4238a0b923820dcc509a6f75849b' # md5 hash
  config.api_access_key = 'YetAnotherAPIAccessKeyForWHMCS'
end

WHMCS::Client.get_clients_details(:clientid => '1')

See the documentation for more details.

Installation

Caveat: gem install whmcs-ruby will not work as this isn't pushed yet.

gem 'whmcs-ruby', :git => 'https://github.com/timrogers/whmcs-ruby.git'

Copyright

Copyright (c) 2011 DotBlock.com, see LICENSE in this repo for details.