whmcs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fbacb82a4243ea53460f437de45574b17e8cb0d
+  data.tar.gz: 5694b362cb8d253393d3d9275442614a886c5b6d
+SHA512:
+  metadata.gz: 1952b45aac539b64481f312f9777be7fc365ce1eba21c75021709e73a16b292907a6774a9faa3a1cf7677ba51c6aa9147557eee94f5feb2743e7583ac950e3cc
+  data.tar.gz: b313326186bbf7bc146facb2dfff4e02b4c101df0585cdc2a17e177a656b1baf029da8b924eb8fdc2bf4dc5fefe1e69b1c10a3ee6c94fc3d66a2e92e59ec5fa7

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+[*.rb]
+indent_size = 2

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "crack", "= 0.1.8"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Matthew J.W. Basterfield
+
+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,19 @@
+= whmcs
+
+Description goes here.
+
+== Contributing to whmcs
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2015 Matthew J.W. Basterfield. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "whmcs"
+  gem.homepage = "http://github.com/mjwb/whmcs"
+  gem.license = "MIT"
+  gem.summary = %Q{whmcs: A Ruby wrapper for the WHMCS API.}
+  gem.description = %Q{whmcs: A ruby wrapper for the WHMCS API - a port of the whmcs-ruby gem (https://github.com/dotblock/whmcs-ruby)}
+  gem.email = "mjwb@flexbox.co.za"
+  gem.authors = ["Matthew J.W. Basterfield"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "whmcs #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/whmcs/base.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'net/https'
+require 'crack'
+
+module WHMCS
+  # WHMCS::Base is the main class used to subclass WHMCS API resources
+  class Base
+
+    # Sends an API request to the WHMCS API
+    #
+    # Parameters:
+    # * <tt>:action</tt> - The API action to perform
+    #
+    # All other paramters are passed along as HTTP POST variables
+    def self.send_request(params = {})
+      if params[:action].blank?
+        raise "No API action set"
+      end
+
+      params.merge!(
+        :username => WHMCS.config.api_username,
+        :password => WHMCS.config.api_password
+      )
+
+      url = URI.parse(WHMCS.config.api_url)
+
+      http = Net::HTTP.new(url.host, url.port)
+
+      if url.port == 443
+        http.use_ssl = true
+      end
+
+      req = Net::HTTP::Post.new(url.path)
+      req.set_form_data(params)
+
+      res = http.start { |http| http.request(req) }
+      parse_response(res.body)
+    end
+
+    # Converts the API response to a Hash
+    def self.parse_response(raw)
+      return {} if raw.to_s.blank?
+
+      if raw.match(/xml version/)
+        Crack::XML.parse(raw)
+      else
+        Hash[raw.split(';').map { |line| line.split('=') }]
+      end
+    end
+  end
+end
+
+# Fix Net::HTTP so we dont get
+# warning: peer certificate won't be verified in this SSL session
+#
+# See:
+#
+# http://www.5dollarwhitebox.org/drupal/node/64
+module Net #:nodoc:all
+  class HTTP
+    alias_method :old_initialize, :initialize
+
+    def initialize(*args)
+      old_initialize(*args)
+      @ssl_context = OpenSSL::SSL::SSLContext.new
+      @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+  end
+end

data/lib/whmcs/client.rb

@@ -0,0 +1,326 @@
+module WHMCS
+  # WHMCS::Client is the class for managing clients
+  class Client < Base
+
+    # Create a new client
+    #
+    # Parameters:
+    #
+    # * <tt>:firstname</tt>
+    # * <tt>:lastname</tt>
+    # * <tt>:companyname</tt> - optional
+    # * <tt>:email</tt>
+    # * <tt>:address1</tt>
+    # * <tt>:address2</tt> - optional
+    # * <tt>:city</tt>
+    # * <tt>:state</tt>
+    # * <tt>:postcode</tt>
+    # * <tt>:country</tt> - two letter ISO country code
+    # * <tt>:phonenumber</tt>
+    # * <tt>:password2</tt> - password for the new user account
+    # * <tt>:currency</tt> - the ID of the currency to set the user to
+    # * <tt>:groupid</tt> - used to assign the client to a client group
+    # * <tt>:notes</tt>
+    # * <tt>:cctype</tt> - Visa, Mastercard, etc...
+    # * <tt>:cardnum</tt>
+    # * <tt>:expdate</tt> - in the format MMYY
+    # * <tt>:startdate</tt>
+    # * <tt>:issuenumber</tt>
+    # * <tt>:customfields</tt> - a base64 encoded serialized array of custom field values
+    # * <tt>:noemail</tt> - pass as true to surpress the client signup welcome email sending
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Add_Client
+    def self.add_client(params = {})
+      params.merge!(:action => 'addclient')
+      send_request(params)
+    end
+
+    # Update a client's info
+    #
+    # Parameters:
+    #
+    # * <tt>:firstname</tt>
+    # * <tt>:lastname</tt>
+    # * <tt>:companyname</tt>
+    # * <tt>:email</tt>
+    # * <tt>:address1</tt>
+    # * <tt>:address2</tt>
+    # * <tt>:city</tt>
+    # * <tt>:state</tt>
+    # * <tt>:postcode</tt>
+    # * <tt>:country</tt> - two letter ISO country code
+    # * <tt>:phonenumber</tt>
+    # * <tt>:password2</tt>
+    # * <tt>:credit</tt> - credit balance
+    # * <tt>:taxexempt</tt> - true to enable
+    # * <tt>:notes</tt>
+    # * <tt>:cardtype</tt> - visa, mastercard, etc...
+    # * <tt>:cardnum</tt> - cc number
+    # * <tt>:expdate</tt> - cc expiry date
+    # * <tt>:startdate</tt> - cc start date
+    # * <tt>:issuenumber</tt> - cc issue number
+    # * <tt>:language</tt> - default language
+    # * <tt>:status</tt> - active or inactive
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Update_Client
+    def self.update_client(params = {})
+      params.merge!(:action => 'updateclient')
+      send_request(params)
+    end
+
+    # Delete a client
+    #
+    # Parameters:
+    #
+    # * <tt>:clientid</tt> - ID Number of the client to delete
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Delete_Client
+    def self.delete_client(params = {})
+      params.merge!(:action => 'deleteclient')
+      send_request(params)
+    end
+
+    # Get multiple clients
+    #
+    # Parameters:
+    #
+    # * <tt>:limitstart</tt> - Record to start at (default = 0)
+    # * <tt>:limitnum</tt> - Number of records to return (default = 25)
+    # * <tt>:search</tt> - Can be passed to filter for clients with a name/email matching the term entered
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Clients
+    def self.get_clients(params = {})
+      params.merge!(:action => 'getclients')
+      send_request(params)
+    end
+
+    # Get a client's info
+    #
+    # Parameters:
+    #
+    # * <tt>:clientid</tt> - the id number of the client
+    # * <tt>:email</tt> - the email address of the client
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Clients_Details
+    def self.get_clients_details(params = {})
+      params.merge!(:action => 'getclientsdetails')
+      send_request(params)
+    end
+
+    # Get a hash of a client's password
+    #
+    # Parameters:
+    #
+    # * <tt>:userid</tt> - should contain the user id of the client you wish to get the password for
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Clients_Password
+    def self.get_clients_password(params = {})
+      params.merge!(:action => 'getclientpassword')
+      send_request(params)
+    end
+
+    # Add a client contact
+    #
+    # Parameters:
+    #
+    # * <tt>:clientid</tt> - the client ID to add the contact to
+    # * <tt>:firstname</tt>
+    # * <tt>:lastname</tt>
+    # * <tt>:companyname</tt>
+    # * <tt>:email</tt>
+    # * <tt>:address1</tt>
+    # * <tt>:address2</tt>
+    # * <tt>:city</tt>
+    # * <tt>:state</tt>
+    # * <tt>:postcode</tt>
+    # * <tt>:country</tt> - two letter ISO country code
+    # * <tt>:phonenumber</tt>
+    # * <tt>:password2</tt> - if creating a sub-account
+    # * <tt>:permissions</tt> - can specify sub-account permissions eg manageproducts,managedomains
+    # * <tt>:generalemails</tt> - set true to receive general email types
+    # * <tt>:productemails</tt> - set true to receive product related emails
+    # * <tt>:domainemails</tt> - set true to receive domain related emails
+    # * <tt>:invoiceemails</tt> - set true to receive billing related emails
+    # * <tt>:supportemails</tt> - set true to receive support ticket related emails
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Add_Contact
+    def self.add_contact(params = {})
+      params.merge!(:action => 'addcontact')
+      send_request(params)
+    end
+
+    # Get client's contacts
+    #
+    # Parameters:
+    #
+    # * <tt>:limitstart</tt> - Record to start at (default = 0)
+    # * <tt>:limitnum</tt> - Number of records to return (default = 25)
+    # * <tt>:userid</tt>
+    # * <tt>:firstname</tt>
+    # * <tt>:lastname</tt>
+    # * <tt>:companyname</tt>
+    # * <tt>:email</tt>
+    # * <tt>:address1</tt>
+    # * <tt>:address2</tt>
+    # * <tt>:city</tt>
+    # * <tt>:state</tt>
+    # * <tt>:postcode</tt>
+    # * <tt>:country</tt>
+    # * <tt>:phonenumber</tt>
+    # * <tt>:subaccount</tt> - true/false
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Contacts
+    def self.get_contacts(params = {})
+      params.merge!(:action => 'getcontacts')
+      send_request(params)
+    end
+
+    # Update a client's contact
+    #
+    # Parameters:
+    #
+    # * <tt>:contactid</tt> - The ID of the contact to delete
+    # * <tt>:generalemails</tt> - set to true to receive general emails
+    # * <tt>:productemails</tt> - set to true to receive product emails
+    # * <tt>:domainemails</tt> - set to true to receive domain emails
+    # * <tt>:invoiceemails</tt> - set to true to receive invoice emails
+    # * <tt>:supportemails</tt> - set to true to receive support emails
+    # * <tt>:firstname</tt> - change the firstname
+    # * <tt>:lastname</tt> - change the lastname
+    # * <tt>:companyname</tt> - change the companyname
+    # * <tt>:email</tt> - change the email address
+    # * <tt>:address1</tt> - change address1
+    # * <tt>:address2</tt> - change address2
+    # * <tt>:city</tt> - change city
+    # * <tt>:state</tt> - change state
+    # * <tt>:postcode</tt> - change postcode
+    # * <tt>:country</tt> - change country
+    # * <tt>:phonenumber</tt> - change phonenumber
+    # * <tt>:subaccount</tt> - enable subaccount
+    # * <tt>:password</tt> - change the password
+    # * <tt>:permissions</tt> - set permissions eg manageproducts,managedomains
+    #
+    # Only send fields you wish to update
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Update_Contact
+    def self.update_contact(params = {})
+      params.merge!(:action => 'updatecontact')
+      send_request(params)
+    end
+
+    # Delete a client's contact
+    #
+    # Parameters:
+    #
+    # * <tt>:contactid</tt> - The ID of the contact to delete
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Delete_Contact
+    def self.delete_contact(params = {})
+      params.merge!(:action => 'deletecontact')
+      send_request(params)
+    end
+
+    # Get client's products
+    #
+    # Parameters:
+    #
+    # * <tt>:clientid</tt> - the ID of the client to retrieve products for
+    # * <tt>:serviceid</tt> - the ID of the service to retrieve details for
+    # * <tt>:domain</tt> - the domain of the service to retrieve details for
+    # * <tt>:pid</tt> - the product ID of the services to retrieve products for
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Clients_Products
+    def self.get_clients_products(params = {})
+      params.merge!(:action => 'getclientsproducts')
+      send_request(params)
+    end
+
+    # Update client's product
+    #
+    # Parameters:
+    #
+    # * <tt>:serviceid</tt> - the ID of the service to be updated
+    # * <tt>:pid</tt>
+    # * <tt>:serverid</tt>
+    # * <tt>:regdate</tt> - Format: YYYY-MM-DD
+    # * <tt>:nextduedate</tt> - Format: YYYY-MM-DD
+    # * <tt>:domain</tt>
+    # * <tt>:firstpaymentamount</tt>
+    # * <tt>:recurringamount</tt>
+    # * <tt>:billingcycle</tt>
+    # * <tt>:paymentmethod</tt>
+    # * <tt>:status</tt>
+    # * <tt>:serviceusername</tt>
+    # * <tt>:servicepassword</tt>
+    # * <tt>:subscriptionid</tt>
+    # * <tt>:promoid</tt>
+    # * <tt>:overideautosuspend</tt> - on/off
+    # * <tt>:overidesuspenduntil</tt> - Format: YYYY-MM-DD
+    # * <tt>:ns1</tt>
+    # * <tt>:ns2</tt>
+    # * <tt>:dedicatedip</tt>
+    # * <tt>:assignedips</tt>
+    # * <tt>:notes</tt>
+    # * <tt>:autorecalc</tt> - pass true to auto set price based on product ID or billing cycle change
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Update_Client_Product
+    def self.update_client_product(params = {})
+      params.merge!(:action => 'updateclientproduct')
+      send_request(params)
+    end
+
+    # Validate client login info
+    #
+    # Parameters:
+    #
+    # * <tt>:email</tt> - the email address of the user trying to login
+    # * <tt>:password2</tt> - the password they supply for authentication
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Validate_Login
+    def self.validate_login(params = {})
+      params.merge!(:action => 'validatelogin')
+      send_request(params)
+    end
+
+    # Send email to client
+    #
+    # Parameters:
+    #
+    # * <tt>:messagename</tt> - unique name of the email template to send from WHMCS
+    # * <tt>:id</tt> - related ID number to send message for
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Send_Email
+    def self.send_email(params = {})
+      params.merge!(:action => 'sendemail')
+      send_request(params)
+    end
+  end
+end

data/lib/whmcs/config.rb

@@ -0,0 +1,20 @@
+module WHMCS
+  # WHMCS::Config stores configuration data for connecting to the WHMCS API
+  class Config
+    # The WHMCS API username
+    attr_accessor :api_username
+
+    # The WHMCS API password
+    attr_accessor :api_password
+
+    # The WHMCS API URL
+    attr_accessor :api_url
+
+    # Create a new config object
+    def initialize
+      @api_username = 'example_api_user'
+      @api_password = 'example_api_pass'
+      @api_url      = 'http://example.com/api.php'
+    end
+  end
+end