KayakoClient 1.0.2 → 1.1.0

data/test/test_troubleshooter.rb

@@ -0,0 +1,106 @@
+#######################################################################
+#
+# Kayako Ruby REST API library
+# _____________________________________________________________________
+#
+# @author      Andriy Lesyuk
+#
+# @package     KayakoClient
+# @copyright   Copyright (c) 2011-2013, Kayako
+# @license     FreeBSD
+# @link        http://forge.kayako.com/projects/kayako-ruby-api-library
+#
+#######################################################################
+
+require 'test/unit'
+require 'kayako_client'
+
+class TestTroubleshooter < Test::Unit::TestCase
+
+    def test_path
+        assert_equal KayakoClient::TroubleshooterAttachment.path, '/Troubleshooter/Attachment'
+        assert_equal KayakoClient::TroubleshooterCategory.path,   '/Troubleshooter/Category'
+        assert_equal KayakoClient::TroubleshooterComment.path,    '/Troubleshooter/Comment'
+        assert_equal KayakoClient::TroubleshooterStep.path,       '/Troubleshooter/Step'
+    end
+
+    def test_step_api
+        assert_raise ArgumentError do
+            KayakoClient::TroubleshooterAttachment.all
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::TroubleshooterAttachment.get(1)
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::TroubleshooterAttachment.delete(1)
+        end
+
+        test = KayakoClient::TroubleshooterAttachment.new(
+            :id => 1
+        )
+        test.loaded!
+
+        assert_raise RuntimeError do
+            test.delete
+        end
+    end
+
+    def test_step
+        test = KayakoClient::TroubleshooterStep.new(
+            :parent_step_ids => [ 1 ],
+            :child_step_ids => [ 2 ]
+        )
+
+        assert test.respond_to?(:get_attachment)
+        assert test.respond_to?(:get_comment)
+
+        assert test.has_parent_steps?
+        assert test.in_step?(1)
+        assert !test.in_step?(2)
+
+        assert test.has_child_steps?
+        assert test.has_step?(2)
+        assert !test.has_step?(1)
+    end
+
+    def test_attachment
+        test = KayakoClient::TroubleshooterAttachment.new
+
+        assert test.respond_to?(:file=)
+        assert test.respond_to?(:file)
+
+        assert test.respond_to?(:troubleshooter_step_id)
+        assert test.respond_to?(:troubleshooter_step)
+    end
+
+    def test_category
+        assert KayakoClient::TroubleshooterCategory.included_modules.include?(KayakoClient::ConvertAPI)
+
+        test = KayakoClient::TroubleshooterCategory.new
+
+        test.respond_to?(:visible_to_user_group?)
+        test.respond_to?(:visible_to_staff_group?)
+    end
+
+    def test_comment
+        test = KayakoClient::TroubleshooterComment.new
+
+        assert test.respond_to?(:creator=)
+
+        assert test.respond_to?(:troubleshooter_step_id)
+        assert test.respond_to?(:troubleshooter_step)
+
+        assert_raise NotImplementedError do
+            test.put
+        end
+
+        assert test.respond_to?(:creator_type=)
+        assert test.respond_to?(:creator_id=)
+
+        assert test.respond_to?(:user_agent)
+        assert test.respond_to?(:referrer)
+    end
+
+end

data/test/test_type.rb

@@ -0,0 +1,65 @@
+#######################################################################
+#
+# Kayako Ruby REST API library
+# _____________________________________________________________________
+#
+# @author      Andriy Lesyuk
+#
+# @package     KayakoClient
+# @copyright   Copyright (c) 2011-2013, Kayako
+# @license     FreeBSD
+# @link        http://forge.kayako.com/projects/kayako-ruby-api-library
+#
+#######################################################################
+
+require 'test/unit'
+require 'kayako_client'
+
+class TestType < Test::Unit::TestCase
+
+    def test_type_mixin
+        assert KayakoClient::TicketType.included_modules.include?(KayakoClient::UserVisibilityAPI)
+
+        test = KayakoClient::TicketType.new
+        assert test.respond_to?(:visible_to_user_group?)
+        assert test.respond_to?(:user_visibility_custom)
+        assert test.respond_to?(:user_group_ids)
+    end
+
+    def test_type_methods
+        test = KayakoClient::TicketType.new
+
+        assert_raise NotImplementedError do
+            test.put
+        end
+
+        assert_raise NotImplementedError do
+            test.post
+        end
+
+        assert_raise NotImplementedError do
+            test.delete
+        end
+    end
+
+    def test_type_constants
+        assert KayakoClient::TicketType::TYPE_TYPES.include?(:public)
+        assert KayakoClient::TicketType::TYPE_TYPES.include?(:private)
+    end
+
+    def test_type_visibility
+        test = KayakoClient::TicketType.new(
+            :uservisibilitycustom => true,
+            :usergroupid => [ 1, 2 ]
+        )
+
+        assert test.visible_to_user_group?(1)
+        assert !test.visible_to_user_group?(3)
+    end
+
+    def test_type_associates
+        test = KayakoClient::TicketType.new
+        test.respond_to?(:department)
+    end
+
+end

data/test/test_user.rb

@@ -0,0 +1,95 @@
+#######################################################################
+#
+# Kayako Ruby REST API library
+# _____________________________________________________________________
+#
+# @author      Andriy Lesyuk
+#
+# @package     KayakoClient
+# @copyright   Copyright (c) 2011-2013, Kayako
+# @license     FreeBSD
+# @link        http://forge.kayako.com/projects/kayako-ruby-api-library
+#
+#######################################################################
+
+require 'test/unit'
+require 'kayako_client'
+
+class TestUser < Test::Unit::TestCase
+
+    def test_user_customs
+        assert_raise ArgumentError do
+            KayakoClient::User.all(0)
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::User.all(1, 0)
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::User.all(nil, 1)
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::User.all(0, 1)
+        end
+    end
+
+    def test_user_validate
+        test = KayakoClient::User.new(
+            :user_group_id => 1,
+            :user_role     => :tester,
+            :salutation    => 'Sir',
+            :full_name     => 'Test',
+            :emails        => 'test@test.com',
+            :password      => 'test'
+        )
+
+        assert !test.save
+        assert test.errors.has_key?(:user_role)
+        assert test.errors.has_key?(:salutation)
+    end
+
+    def test_user_required
+        test = KayakoClient::User.new(
+            :full_name     => 'Test',
+            :emails        => 'test@test.com',
+            :password      => 'test'
+        )
+        assert_raise ArgumentError do
+            test.save
+        end
+
+        test = KayakoClient::User.new(
+            :user_group_id => 1,
+            :emails        => 'test@test.com',
+            :password      => 'test'
+        )
+        assert_raise ArgumentError do
+            test.save
+        end
+
+        test = KayakoClient::User.new(
+            :user_group_id => 1,
+            :full_name     => 'Test',
+            :password      => 'test'
+        )
+        assert_raise ArgumentError do
+            test.save
+        end
+
+        test = KayakoClient::User.new(
+            :user_group_id => 1,
+            :full_name     => 'Test',
+            :emails        => 'test@test.com'
+        )
+        assert_raise ArgumentError do
+            test.save
+        end
+    end
+
+    def test_user_search
+        assert KayakoClient::User.respond_to?(:search)
+    end
+
+end

data/test/test_xml.rb

@@ -0,0 +1,183 @@
+#######################################################################
+#
+# Kayako Ruby REST API library
+# _____________________________________________________________________
+#
+# @author      Andriy Lesyuk
+#
+# @package     KayakoClient
+# @copyright   Copyright (c) 2011-2013, Kayako
+# @license     FreeBSD
+# @link        http://forge.kayako.com/projects/kayako-ruby-api-library
+#
+#######################################################################
+
+require 'test/unit'
+require 'kayako_client'
+
+class TestXML < Test::Unit::TestCase
+
+    PHP_ERROR = '<div style="BACKGROUND: #f8ebeb; FONT: 13px Trebuchet MS, Verdana, Helvetica, Arial; BORDER: 1px SOLID #751616; PADDING: 10px; MARGIN: 5px;">' +
+                '<font color="red">' +
+                '[Warning]: Missing argument 2 for Controller_TicketAttachment::Get() (api/class.Controller_TicketAttachment.php:172)' +
+                '</font>' +
+                '</div>'
+
+    def test_xml_php_error
+        xml = KayakoClient::REXMLDocument.new(PHP_ERROR)
+
+        assert xml.error?
+        assert_equal xml.error, '[Warning]: Missing argument 2 for Controller_TicketAttachment::Get() (api/class.Controller_TicketAttachment.php:172)'
+        assert_equal xml.count, 0
+        assert_nil xml.to_hash
+
+        xml = KayakoClient::LibXML.new(PHP_ERROR)
+
+        assert xml.error?
+        assert_equal xml.error, '[Warning]: Missing argument 2 for Controller_TicketAttachment::Get() (api/class.Controller_TicketAttachment.php:172)'
+        assert_equal xml.count, 0
+        assert_nil xml.to_hash
+    end
+
+    STAFF_GROUPS = '<?xml version="1.0" encoding="UTF-8"?>' +
+                   '<staffgroups>' +
+                   '<staffgroup>' +
+                   '<id><![CDATA[1]]></id>' +
+                   '<title><![CDATA[Administrators]]></title>' +
+                   '<isadmin><![CDATA[1]]></isadmin>' +
+                   '</staffgroup>' +
+                   '<staffgroup>' +
+                   '<id><![CDATA[2]]></id>' +
+                   '<title><![CDATA[Employees]]></title>' +
+                   '<isadmin><![CDATA[0]]></isadmin>' +
+                   '</staffgroup>' +
+                   '<staffgroup>' +
+                   '<id><![CDATA[3]]></id>' +
+                   '<title><![CDATA[Users]]></title>' +
+                   '<isadmin><![CDATA[0]]></isadmin>' +
+                   '</staffgroup>' +
+                   '<staffgroup>' +
+                   '<id><![CDATA[5]]></id>' +
+                   '<title><![CDATA[Testers]]></title>' +
+                   '<isadmin><![CDATA[0]]></isadmin>' +
+                   '</staffgroup>' +
+                   '</staffgroups>'
+
+    def test_xml_staff_groups
+        xml = KayakoClient::REXMLDocument.new(STAFF_GROUPS)
+        test = xml.to_hash
+
+        assert_equal xml.count, 4
+        assert_instance_of Array, test[:staffgroup]
+        assert_equal test[:staffgroup].size, 4
+        assert_instance_of Hash, test[:staffgroup].first
+        assert_equal test[:staffgroup].first[:id], 1.to_s
+        assert_equal test[:staffgroup].first[:title], 'Administrators'
+
+        xml = KayakoClient::LibXML.new(STAFF_GROUPS)
+        test = xml.to_hash
+
+        assert_equal xml.count, 4
+        assert_instance_of Array, test[:staffgroup]
+        assert_equal test[:staffgroup].size, 4
+        assert_instance_of Hash, test[:staffgroup].first
+        assert_equal test[:staffgroup].first[:id], 1.to_s
+        assert_equal test[:staffgroup].first[:title], 'Administrators'
+    end
+
+    TICKET_COUNT = '<?xml version="1.0" encoding="UTF-8"?>' +
+                   '<ticketcount>' +
+                   '<departments>' +
+                   '<department id="3">' +
+                   '<totalitems><![CDATA[5]]></totalitems>' +
+                   '<lastactivity><![CDATA[1311888965]]></lastactivity>' +
+                   '<totalunresolveditems><![CDATA[5]]></totalunresolveditems>' +
+                   '<ticketstatus id="1" lastactivity="1311888965" totalitems="5" />' +
+                   '<tickettype id="0" lastactivity="1311888965" totalitems="5" totalunresolveditems="5" />' +
+                   '<ownerstaff id="0" lastactivity="1311888396" totalitems="1" totalunresolveditems="1" />' +
+                   '<ownerstaff id="1" lastactivity="1311887337" totalitems="2" totalunresolveditems="2" />' +
+                   '<ownerstaff id="3" lastactivity="1311888965" totalitems="2" totalunresolveditems="2" />' +
+                   '</department>' +
+                   '<department id="5">' +
+                   '<totalitems><![CDATA[1]]></totalitems>' +
+                   '<lastactivity><![CDATA[1313153933]]></lastactivity>' +
+                   '<totalunresolveditems><![CDATA[1]]></totalunresolveditems>' +
+                   '<ticketstatus id="1" lastactivity="1313153933" totalitems="1" />' +
+                   '<tickettype id="0" lastactivity="1313153933" totalitems="1" totalunresolveditems="1" />' +
+                   '<ownerstaff id="3" lastactivity="1313153933" totalitems="1" totalunresolveditems="1" />' +
+                   '</department>' +
+                   '</departments>' +
+                   '<!-- Ticket Count grouped by Status -->' +
+                   '<statuses>' +
+                   '<ticketstatus id="1" lastactivity="1313153933" totalitems="6" />' +
+                   '</statuses>' +
+                   '<!-- Ticket Count grouped by Owner Staff -->' +
+                   '<owners>' +
+                   '<ownerstaff id="0" lastactivity="1311888396" totalitems="1" totalunresolveditems="1" />' +
+                   '<ownerstaff id="1" lastactivity="1311887337" totalitems="2" totalunresolveditems="2" />' +
+                   '<ownerstaff id="3" lastactivity="1311888965" totalitems="2" totalunresolveditems="2" />' +
+                   '</owners>' +
+                   '<!-- Unassigned Ticket Count grouped by Department -->' +
+                   '<unassigned>' +
+                   '<department id="1" lastactivity="1311888396" totalitems="1" totalunresolveditems="1" />' +
+                   '<department id="2" lastactivity="1311888396" totalitems="1" totalunresolveditems="1" />' +
+                   '<department id="4" lastactivity="1311888396" totalitems="1" totalunresolveditems="1" />' +
+                   '<department id="3" lastactivity="1311888396" totalitems="1" totalunresolveditems="1" />' +
+                   '</unassigned>' +
+                   '</ticketcount>'
+
+    def test_xml_ticket_count
+        xml = KayakoClient::REXMLDocument.new(TICKET_COUNT)
+        test = xml.to_hash
+
+        assert test.has_key?(:departments)
+        assert test.has_key?(:statuses)
+        assert test.has_key?(:owners)
+        assert test.has_key?(:unassigned)
+
+        assert_equal test[:departments].size, 1
+        assert_equal test[:statuses].size, 1
+        assert_equal test[:owners].size, 1
+        assert_equal test[:unassigned].size, 1
+
+        assert_instance_of Array, test[:departments][:department]
+        assert_instance_of Hash, test[:statuses][:ticketstatus]
+        assert_instance_of Array, test[:owners][:ownerstaff]
+        assert_instance_of Array, test[:unassigned][:department]
+
+        assert_equal test[:departments][:department].size, 2
+        assert_equal test[:owners][:ownerstaff].size, 3
+        assert_equal test[:unassigned][:department].size, 4
+
+        assert_equal test[:departments][:department][0][:id], 3.to_s
+        assert_equal test[:owners][:ownerstaff][1][:id], 1.to_s
+        assert_equal test[:unassigned][:department][2][:id], 4.to_s
+
+        xml = KayakoClient::LibXML.new(TICKET_COUNT)
+        test = xml.to_hash
+
+        assert test.has_key?(:departments)
+        assert test.has_key?(:statuses)
+        assert test.has_key?(:owners)
+        assert test.has_key?(:unassigned)
+
+        assert_equal test[:departments].size, 1
+        assert_equal test[:statuses].size, 1
+        assert_equal test[:owners].size, 1
+        assert_equal test[:unassigned].size, 1
+
+        assert_instance_of Array, test[:departments][:department]
+        assert_instance_of Hash, test[:statuses][:ticketstatus]
+        assert_instance_of Array, test[:owners][:ownerstaff]
+        assert_instance_of Array, test[:unassigned][:department]
+
+        assert_equal test[:departments][:department].size, 2
+        assert_equal test[:owners][:ownerstaff].size, 3
+        assert_equal test[:unassigned][:department].size, 4
+
+        assert_equal test[:departments][:department][0][:id], 3.to_s
+        assert_equal test[:owners][:ownerstaff][1][:id], 1.to_s
+        assert_equal test[:unassigned][:department][2][:id], 4.to_s
+    end
+
+end