whmcs-api 0.0.2

data/lib/whmcs/quote.rb

@@ -0,0 +1,127 @@
+module WHMCS
+  # WHMCS::Quote is the class for managing quotes
+  class Quote < Base
+
+    # Create a new quote
+    #
+    # Parameters:
+    # * <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>: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
+    # 
+		# Optional attributes:
+    # * <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>: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
+    #
+    # See:
+    #
+		# http://docs.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://docs.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://docs.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://docs.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://docs.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,227 @@
+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>:deptid</tt> - the ID of the ticket department
+    # * <tt>:subject</tt>
+    # * <tt>:message</tt>
+		#
+		# Optional attributes:
+    # * <tt>:priority</tt> - can be "Low", "Medium" or "High" (Default = Low)
+		# * <tt>:contactid</tt> - the ID of the contact that you wish to associate the ticket with
+    # * <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>:serviceid</tt> - the ID if the ticket relates to a specific product
+    # * <tt>:customfields</tt> - a base 64 serialized array of field IDs => values
+		# * <tt>:domainid</tt> - the ID if the ticket relates to a specific domain
+		# * <tt>:noemail</tt> - true/false - set to stop the Ticket Opened mail being sent to the user
+    #
+    # See:
+    #
+		# http://docs.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>:message</tt>
+		#
+		# Optional attributes:
+    # * <tt>:clientid</tt> - if adding reply as a client
+		# * <tt>:contactid</tt> - to be used along with clientid. contactid should be a contact within the 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>:status</tt> - specify if you want to set the status to On Hold or In Progress after reply
+    # * <tt>:customfields</tt> - base64_encoded serialized array of custom fields associated with the ticket.
+		#
+    # See:
+    #
+		# http://docs.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>:email</tt> - filter for tickets only from a specific email address
+    # * <tt>:deptid</tt> - Optional search in a particular department
+    # * <tt>:status</tt> - filter for a particular status - in addition to any individual status options, this can also take the values "Awaiting Reply", "All
+		# Active Tickets" or "My Flagged Tickets" to return those preset status groups
+    # * <tt>:subject</tt> - Optional search for a word in the subject
+		# * <tt>:ignore_dept_assignments</tt> - Pass this to ignore the departments the admin user belongs to. Otherwise just the tickets for the departments the API
+		# user belongs to are returned
+    #
+    # See:
+    #
+		# http://docs.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
+		# * <tt>:ticketnum</tt> - Ticket Num to retrieve (client ticket number)
+    #
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Ticket
+    def self.get_ticket(params = {})
+      params.merge!(:action => 'getticket')
+      send_request(params)
+    end
+
+
+		# Get Ticket Notes
+		#
+		# Parameters:
+		# * <tt>:ticketid</tt> - Ticket ID to obtain the notes for
+		#
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Get_Ticket_Notes
+		def self.get_ticket_notes(params = {})
+			params.merge!(:action => 'getticketnotes')
+			send_request(params)
+		end
+
+    # Update an existing ticket
+    #
+    # Parameters:
+    #
+    # * <tt>:ticketid</tt> - Ticket ID to be updated
+		#
+		# Optional attributes:
+		# * <tt>:deptid</tt> - update the assigned department
+    # * <tt>:subject</tt>
+    # * <tt>:priority</tt> - Low, Medium or High
+    # * <tt>:status</tt> - Open, Answered, Closed, etc...
+		# * <tt>:userid</tt> - change the user that the ticket is assigned to
+		# * <tt>:email</tt> - change the email address that opened the ticket (only when userid is not used)
+		# * <tt>:cc</tt> - add CC emails to the ticket
+		# * <tt>:flag</tt> - flag to an adminid
+    #
+    # See:
+    #
+		# http://docs.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>:ticketnum</tt> - The Ticket number of the note. Please note that you can only use either ticketnum or ticketid and not both.
+    # * <tt>:message</tt> - The not to add
+    #
+    # See:
+    #
+		# http://docs.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://docs.whmcs.com/API:Delete_Ticket
+    def self.delete_ticket(params = {})
+      params.merge!(:action => 'deleteticket')
+      send_request(params)
+    end
+
+		# Delete Ticket Note
+		#
+		# Parameters:
+		# * <tt>:noteid</tt> - Note ID to be removed [See: Get Ticket Notes](http://docs.whmcs.com/API:Get_Ticket_Notes)
+		#
+		# See:
+		#
+		# http://docs.whmcs.com/API:Delete_Ticket_Note
+		def self.delete_ticket_note(params = {})
+			params.merge!(:action => 'deleteticketnote')
+			send_request(params)
+		end
+
+    # Get support departments
+    # This command is used to retrieve an XML list of Support Departments and counts of tickets Open and Awaiting reply.
+		#
+		# Optional attributes:
+		# * <tt>:ignore_dept_assignments</tt> - send as true to ignore the departments that the API user is assigned to
+		#
+    # See:
+    #
+		# http://docs.whmcs.com/API:Get_Support_Departments
+    def self.get_support_departments
+      send_request(:action => 'getsupportdepartments')
+    end
+
+    # Get support statuses
+    #
+    # Optional attributes:
+    #
+    # * <tt>:deptid</tt> - Optional - Send a Department ID to limit results
+    #
+    # See:
+    #
+		# http://docs.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://docs.whmcs.com/API:Get_Ticket_Predefined_Cats
+    def self.get_ticket_predefined_cats
+			params.merge!(:action => 'getticketpredefinedcats')
+			send_request(params)
+		end
+
+    # Get ticket predefined replies
+    #
+    # Optional attributes:
+    #
+    # * <tt>:catid</tt> - Optional Select category to browse
+    #
+    # See:
+    #
+		# http://docs.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.2'
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'test/unit'
+
+require 'simplecov'
+require 'coveralls'
+
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+    add_filter '/_test.rb/'
+end
+
+#Coveralls.wear!
+
+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"
+  config.api_key = ENV['WHMCS_KEY'] or raise "There must be a present key for WHMCS_KEY"  
+end

data/test/whmcs_announcement_test.rb

@@ -0,0 +1,29 @@
+require_relative 'test_helper'
+
+class WHMCSAnnouncementTest < Test::Unit::TestCase
+  # dummy testing of announcement functionality
+  def test__basic_announcement_crud__passingValidData
+    passing_data = {
+      :date => '2014-04-01',
+      :title => 'Test Announcement1',
+      :announcement => 'Test Hello World announcement',
+      :published    => 'off'
+    }
+
+    resulted_announce = WHMCS::Announcement.get_announcements()
+
+    resulted = WHMCS::Announcement.add_announcement( passing_data )
+    
+    updated_announcement = WHMCS::Announcement.update_announcement(
+      :announcementid => resulted['announcementid'],
+      :title          => 'Test Hello World announcement 2'
+    )
+    
+    deleted_announcement = WHMCS::Announcement.delete_announcement(:announcementid => resulted['announcementid'])
+
+    assert_equal('success', updated_announcement['result'])
+    assert_equal(resulted['announcementid'], deleted_announcement['announcementid'])
+    assert_equal('success', deleted_announcement['result'])
+    assert_equal('success', resulted['result'])
+  end
+end

data/test/whmcs_test.rb

@@ -0,0 +1,16 @@
+require_relative 'test_helper'
+
+class WHMCSTest < Test::Unit::TestCase
+  # in certain occasions encrypt call returns hash that includes '='
+  def test__parse_response__parsedCorrectlyHashesWithEqSign
+    expected = "result=succes;password=12lkjdfosifusdlfsdfmlasdof==;"
+    parsed = WHMCS::Base.parse_response(expected)
+    assert_equal('12lkjdfosifusdlfsdfmlasdof==', parsed['password'])
+  end
+
+  def test__send_request__returningHash
+    resulted = WHMCS::Base.send_request(:action => 'do_me_a_favor')
+    assert resulted.is_a?(Hash)
+    assert_equal('Command Not Found', resulted['message'])
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: whmcs-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andrey Vystavkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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'
+description: 'whmcs-api: Ruby bindings for the WHMCS API'
+email: jujav4ik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Rakefile
+- README.md
+- lib/whmcs/announcement.rb
+- lib/whmcs/base.rb
+- lib/whmcs/client.rb
+- lib/whmcs/config.rb
+- lib/whmcs/domain.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_announcement_test.rb
+- test/whmcs_test.rb
+homepage: https://github.com/jujav4ik/whmcs-api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.6
+signing_key: 
+specification_version: 4
+summary: 'whmcs-api: Ruby bindings for the WHMCS API'
+test_files: []