whmcs-ruby 0.0.1

data/lib/whmcs/quote.rb

@@ -0,0 +1,125 @@
+module WHMCS
+  # WHMCS::Quote is the class for managing quotes
+  class Quote < Base
+
+    # Create a new quote
+    #
+    # Parameters:
+    #
+    # * <tt>:userid</tt> - the unique id number of the client in the tblclients table
+    # * <tt>:firstname</tt> - optional - only required if userid is not specified
+    # * <tt>:lastname</tt> - optional - only required if userid is not specified
+    # * <tt>:companyname</tt> - optional - only required if userid is not specified
+    # * <tt>:email</tt> - optional - only required if userid is not specified
+    # * <tt>:address1</tt> - optional - only required if userid is not specified
+    # * <tt>:address2</tt> - optional - only required if userid is not specified
+    # * <tt>:city</tt> - optional - only required if userid is not specified
+    # * <tt>:state</tt> - optional - only required if userid is not specified
+    # * <tt>:postcode</tt> - optional - only required if userid is not specified
+    # * <tt>:country</tt> - optional - only required if userid is not specified
+    # * <tt>:phonenumber</tt> - optional - only required if userid is not specified
+    # * <tt>:currency</tt> - optional - only required if userid is not specified
+    # * <tt>:subject</tt> - Subject of the quote
+    # * <tt>:stage</tt> - Draft,Delivered,On Hold,Accepted,Lost,Dead
+    # * <tt>:validuntil</tt> - In format set in Localisation
+    # * <tt>:datecreated</tt> - Optional - In format set in Localisation
+    # * <tt>:customernotes</tt> - notes that are viewable by the client
+    # * <tt>:adminnotes</tt> - notes that are admin only
+    # * <tt>:lineitems</tt> - a base64 encoded serialized array containing:
+    # * <tt>:desc</tt> - The line description
+    # * <tt>:qty</tt> - The quantity being quoted
+    # * <tt>:up</tt> - unit price
+    # * <tt>:discount</tt> - discount amount in %
+    # * <tt>:taxable</tt> - true or false
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Create_Quote
+    def self.create_quote(params = {})
+      params.merge!(:action => 'createquote')
+      send_request(params)
+    end
+
+    # Update an existing quote
+    #
+    # Parameters:
+    #
+    # * <tt>:quoteid</tt> - the id number of the quote in tblquotes
+    # * <tt>:userid</tt> - the unique id number of the client in the tblclients table
+    # * <tt>:firstname</tt> - optional - only required if userid is not specified
+    # * <tt>:lastname</tt> - optional - only required if userid is not specified
+    # * <tt>:companyname</tt> - optional - only required if userid is not specified
+    # * <tt>:email</tt> - optional - only required if userid is not specified
+    # * <tt>:address1</tt> - optional - only required if userid is not specified
+    # * <tt>:address2</tt> - optional - only required if userid is not specified
+    # * <tt>:city</tt> - optional - only required if userid is not specified
+    # * <tt>:state</tt> - optional - only required if userid is not specified
+    # * <tt>:postcode</tt> - optional - only required if userid is not specified
+    # * <tt>:country</tt> - optional - only required if userid is not specified
+    # * <tt>:phonenumber</tt> - optional - only required if userid is not specified
+    # * <tt>:currency</tt> - optional - only required if userid is not specified
+    # * <tt>:subject</tt> - Subject of the quote
+    # * <tt>:stage</tt> - Draft,Delivered,On Hold,Accepted,Lost,Dead
+    # * <tt>:validuntil</tt> - In format set in Localisation
+    # * <tt>:datecreated</tt> - Optional - In format set in Localisation
+    # * <tt>:customernotes</tt> - notes that are viewable by the client
+    # * <tt>:adminnotes</tt> - notes that are admin only
+    # * <tt>:lineitems</tt> - a base64 encoded serialized array containing:
+    # * <tt>:id</tt> - existing lineid only required to update existing lines
+    # * <tt>:desc</tt> - The line description
+    # * <tt>:qty</tt> - The quantity being quoted
+    # * <tt>:up</tt> - unit price
+    # * <tt>:discount</tt> - discount amount in %
+    # * <tt>:taxable</tt> - true or false
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Update_Quote
+    def self.update_quote(params = {})
+      params.merge!(:action => 'updatequote')
+      send_request(params)
+    end
+
+    # Delete a quote
+    #
+    # Parameters:
+    #
+    # * <tt>:quoteid</tt> - the id number of the quote in tblquotes
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Delete_Quote
+    def self.delete_quote(params = {})
+      params.merge!(:action => 'deletequote')
+      send_request(params)
+    end
+
+    # Send a quote to client
+    #
+    # Parameters:
+    #
+    # * <tt>:quoteid</tt> - the id number of the quote in tblquotes
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Send_Quote
+    def self.send_quote(params = {})
+      params.merge!(:action => 'sendquote')
+      send_request(params)
+    end
+
+    # Accept a quote
+    #
+    # Parameters:
+    #
+    # * <tt>:quoteid</tt> - the id number of the quote in tblquotes
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Accept_Quote
+    def self.accept_quote(params = {})
+      params.merge!(:action => 'acceptquote')
+      send_request(params)
+    end
+  end
+end

data/lib/whmcs/ticket.rb

@@ -0,0 +1,172 @@
+module WHMCS
+  # WHMCS::Ticket is the class for managing support tickets
+  class Ticket < Base
+
+    # Open a new ticket
+    #
+    # Parameters:
+    #
+    # * <tt>:clientid</tt> - the ID of the client the ticket belongs to
+    # * <tt>:name</tt> - only required if not a registered client (clientid must be sent as 0)
+    # * <tt>:email</tt> - only required if not a registered client
+    # * <tt>:deptid</tt> - the ID of the ticket department
+    # * <tt>:subject</tt>
+    # * <tt>:message</tt>
+    # * <tt>:priority</tt> - can be "Low", "Medium" or "High"
+    # * <tt>:serviceid</tt> - the ID if the ticket relates to a specific product
+    # * <tt>:customfields</tt> - a base 64 serialized array of field IDs => values
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Open_Ticket
+    def self.open_ticket(params = {})
+      params.merge!(:action => 'openticket')
+      send_request(params)
+    end
+
+    # Reply to ticket
+    #
+    # Parameters:
+    #
+    # * <tt>:ticketid</tt> - the ID of the ticket to add the reply to
+    # * <tt>:clientid</tt> - if adding reply as a client
+    # * <tt>:name</tt> - only required if not a registered client (clientid must be sent as 0)
+    # * <tt>:email</tt> - only required if not a registered client
+    # * <tt>:adminusername</tt> - if adding reply as an admin, name to show
+    # * <tt>:message</tt>
+    # * <tt>:status</tt> - specify if you want to set the status to On Hold or In Progress after reply
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Reply_Ticket
+    def self.reply_ticket(params = {})
+      params.merge!(:action => 'addticketreply')
+      send_request(params)
+    end
+
+    # Get tickets
+    #
+    # Parameters:
+    #
+    # * <tt>:limitstart</tt> - Optional start at which result (default 0)
+    # * <tt>:limitnum</tt> - Optional limit at how many results (default 25)
+    # * <tt>:clientid</tt> - Optional search for a particular client's tickets
+    # * <tt>:deptid</tt> - Optional search in a particular department
+    # * <tt>:status</tt> - Optional search a particular status
+    # * <tt>:subject</tt> - Optional search for a word in the subject
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Tickets
+    def self.get_tickets(params = {})
+      params.merge!(:action => 'gettickets')
+      send_request(params)
+    end
+
+    # Get a ticket
+    #
+    # Parameters:
+    #
+    # * <tt>:ticketid</tt> - Ticket id to retrieve
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Ticket
+    def self.get_ticket(params = {})
+      params.merge!(:action => 'getticket')
+      send_request(params)
+    end
+
+    # Update an existing ticket
+    #
+    # Parameters:
+    #
+    # * <tt>:ticketid</tt> - Ticket ID to be updated
+    # * <tt>:subject</tt>
+    # * <tt>:priority</tt> - Low, Medium or High
+    # * <tt>:status</tt> - Open, Answered, Closed, etc...
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Update_Ticket
+    def self.update_ticket(params = {})
+      params.merge!(:action => 'updateticket')
+      send_request(params)
+    end
+
+    # Add a note to an existing ticket
+    #
+    # Parameters:
+    #
+    # * <tt>:ticketid</tt> - Ticket ID the note is to be added
+    # * <tt>:message</tt> - The not to add
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Add_Ticket_Note
+    def self.add_ticket_note(params = {})
+      params.merge!(:action => 'addticketnote')
+      send_request(params)
+    end
+
+    # Delete an existing ticket
+    #
+    # Parameters:
+    #
+    # * <tt>:ticketid</tt> - Ticket ID to be deleted
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Delete_Ticket
+    def self.delete_ticket(params = {})
+      params.merge!(:action => 'deleteticket')
+      send_request(params)
+    end
+
+    # Get support departments
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Support_Departments
+    def self.get_support_departments
+      send_request(:action => 'getsupportdepartments')
+    end
+
+    # Get support statuses
+    #
+    # Parameters:
+    #
+    # * <tt>:deptid</tt> - Optional - Send a Department ID to limit results
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Support_Statuses
+    def self.get_support_statuses(params = {})
+      params.merge!(:action => 'getsupportstatuses')
+      send_request(params)
+    end
+
+    # Get ticket predefined categories
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Ticket_Predefined_Cats
+    def self.get_ticket_predefined_cats
+      send_request(:action => 'getticketpredefinedcats')
+    end
+
+    # Get ticket predefined replies
+    #
+    # Parameters:
+    #
+    # * <tt>:catid</tt> - Optional Select category to browse
+    #
+    # See:
+    #
+    # http://wiki.whmcs.com/API:Get_Ticket_Predefined_Replies
+    def self.get_ticket_predefined_repies(params = {})
+      params.merge!(:action => 'getsupportstatuses')
+      send_request(params)
+    end
+  end
+end

data/lib/whmcs/version.rb

@@ -0,0 +1,3 @@
+module WHMCS #:nodoc:
+  VERSION = Version = '0.0.1'
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+begin
+  require 'turn'
+rescue LoadError
+end
+
+require 'whmcs'
+
+WHMCS.configure do |config|
+  config.api_username = ENV['WHMCS_USER'] or raise "You must set the env variable WHMCS_USER"
+  config.api_password = ENV['WHMCS_PASS'] or raise "You must set the env variable WHMCS_PASS"
+  config.api_url      = ENV['WHMCS_URL']  or raise "You must set the env variable WHMCS_URL"
+end

data/test/whmcs_test.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class WHMCSTest < Test::Unit::TestCase
+  context "WHMCS::Base.send_request" do
+
+    should "raise an error if params[:action] is not set" do
+      assert_raise RuntimeError do
+        WHMCS::Base.send_request
+      end
+    end
+
+    should "return a hash" do
+      res = WHMCS::Client.get_clients_details(:clientid => '1')
+      assert res.is_a?(Hash)
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: whmcs-ruby
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Priddle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 1
+        - 8
+        version: 0.1.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "    whmcs-ruby: Ruby bindings for the WHMCS API\n"
+email: jpriddle@nevercraft.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- Rakefile
+- README.markdown
+- lib/whmcs/base.rb
+- lib/whmcs/client.rb
+- lib/whmcs/config.rb
+- lib/whmcs/invoice.rb
+- lib/whmcs/misc.rb
+- lib/whmcs/module.rb
+- lib/whmcs/order.rb
+- lib/whmcs/quote.rb
+- lib/whmcs/ticket.rb
+- lib/whmcs/version.rb
+- lib/whmcs.rb
+- test/test_helper.rb
+- test/whmcs_test.rb
+has_rdoc: true
+homepage: https://github.com/dotblock/whmcs-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: "whmcs-ruby: Ruby bindings for the WHMCS API"
+test_files: []
+