KayakoClient 1.0.2 → 1.1.0

data/test/test_count.rb

@@ -0,0 +1,162 @@
+#######################################################################
+#
+# 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 TestCount < Test::Unit::TestCase
+
+    def test_count_embedded
+        test = KayakoClient::TicketCount.new(
+            :departments => {
+                :department => [ {
+                        :id                   => 1,
+                        :lastactivity         => 1311888965,
+                        :totalitems           => 100,
+                        :totalunresolveditems => 50,
+                        :ticketstatus         => {
+                            :id               => 1,
+                            :lastactivity     => 1311888965,
+                            :totalitems       => 100
+                        },
+                        :tickettype           => [ {
+                                :id                   => 0,
+                                :lastactivity         => 1311888965,
+                                :totalitems           => 50,
+                                :totalunresolveditems => 25
+                            }, {
+                                :id                   => 1,
+                                :lastactivity         => 1311887337,
+                                :totalitems           => 50,
+                                :totalunresolveditems => 25
+                            }
+                        ],
+                        :ownerstaff               => {
+                            :id                   => 1,
+                            :lastactivity         => 1311888965,
+                            :totalitems           => 15,
+                            :totalunresolveditems => 10
+                        }
+                    }, {
+                        :id                   => 2,
+                        :lastactivity         => 75,
+                        :totalunresolveditems => 25
+                    }
+                ]
+            },
+            :statuses => {
+                :id               => 1,
+                :lastactivity     => 1311888965,
+                :totalitems       => 100
+            },
+            :owners => [ {
+                    :id                   => 1,
+                    :lastactivity         => 1311888965,
+                    :totalitems           => 15,
+                    :totalunresolveditems => 10
+                }, {
+                    :id                   => 2,
+                    :lastactivity         => 1311888396,
+                    :totalitems           => 80,
+                    :totalunresolveditems => 30
+                }
+            ],
+            :unassigned  => {
+                :id                   => 1,
+                :lastactivity         => 1311888965,
+                :totalitems           => 15,
+                :totalunresolveditems => 10
+            }
+        )
+
+        assert_instance_of Array, test.departments
+        assert_instance_of KayakoClient::TicketCountDepartment, test.departments.first
+        assert_equal test.departments.size, 2
+
+        assert_equal test.departments.first.id, 1
+        assert_instance_of Time, test.departments.first.last_activity
+        assert_equal test.departments.first.last_activity.to_i, 1311888965
+        assert_equal test.departments.first.total_items, 100
+        assert_equal test.departments.first.total_unresolved_items, 50
+
+        assert_instance_of Array, test.departments.first.statuses
+        assert_instance_of Array, test.departments.first.types
+        assert_instance_of Array, test.departments.first.owners
+
+        assert_instance_of KayakoClient::TicketCountStatus, test.departments.first.statuses.first
+        assert_instance_of KayakoClient::TicketCountType, test.departments.first.types.first
+        assert_instance_of KayakoClient::TicketCountOwner, test.departments.first.owners.first
+
+        assert_equal test.departments.first.statuses.size, 1
+        assert_equal test.departments.first.types.size, 2
+        assert_equal test.departments.first.owners.size, 1
+
+        assert_instance_of Array, test.statuses
+        assert_instance_of KayakoClient::TicketCountStatus, test.statuses.first
+        assert_equal test.statuses.size, 1
+
+        assert_equal test.statuses.first.id, 1
+        assert_equal test.statuses.first.last_activity.to_i, 1311888965
+        assert_equal test.statuses.first.total_items, 100
+
+        assert_instance_of Array, test.owners
+        assert_instance_of KayakoClient::TicketCountOwner, test.owners.first
+        assert_equal test.owners.size, 2
+
+        assert_equal test.owners.first.id, 1
+        assert_equal test.owners.first.last_activity.to_i, 1311888965
+        assert_equal test.owners.first.total_items, 15
+        assert_equal test.owners.first.total_unresolved_items, 10
+
+        assert_instance_of Array, test.unassigned
+        assert_instance_of KayakoClient::TicketCountUnassigned, test.unassigned.first
+        assert_equal test.unassigned.size, 1
+
+        assert test.departments.first.respond_to?(:department)
+        assert test.departments.first.types.first.respond_to?(:ticket_type)
+        assert test.statuses.first.respond_to?(:ticket_status)
+        assert test.owners.first.respond_to?(:owner_staff)
+    end
+
+    def test_count_methods
+        assert_raise NotImplementedError do
+            KayakoClient::TicketCount.all
+        end
+
+        test = KayakoClient::TicketCount.new(
+            :unassigned  => {
+                :id                   => 1,
+                :lastactivity         => 1311888965,
+                :totalitems           => 15,
+                :totalunresolveditems => 10
+            }
+        )
+        assert_raise NotImplementedError do
+            test.put
+        end
+
+        assert_raise NotImplementedError do
+            KayakoClient::TicketCount.post
+        end
+
+        assert_raise NotImplementedError do
+            test.delete
+        end
+
+        assert_raise NotImplementedError do
+            KayakoClient::TicketCount.delete(1)
+        end
+    end
+
+end

data/test/test_custom_field.rb

@@ -0,0 +1,86 @@
+#######################################################################
+#
+# 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 TestCustomField < Test::Unit::TestCase
+
+    def test_custom_field
+        test = KayakoClient::CustomField.new(
+            :custom_field_id => 1,
+            :field_name      => 'Test',
+            :title           => 'Test title',
+            :description     => 'Test description',
+            :field_type      => 1,
+            :is_required     => true,
+            :default_value   => 'Test',
+            :regexp_validate => '/test/',
+            :encrypt_in_db   => false,
+            :display_order   => 1,
+            :user_editable   => false,
+            :staff_editable  => true
+        )
+
+        assert_equal test.custom_field_id, 1
+        assert_equal test.field_name, 'Test'
+        assert_equal test.title, 'Test title'
+        assert_equal test.description, 'Test description'
+        assert_equal test.field_type, KayakoClient::CustomField::TYPE_TEXT
+        assert_equal test.default_value, 'Test'
+        assert_equal test.regexp_validate, '/test/'
+        assert_equal test.display_order, 1
+
+        assert test.is_required?
+        assert test.staff_editable?
+
+        assert !test.encrypt_in_db?
+        assert !test.user_editable?
+
+        assert test.respond_to?(:options)
+    end
+
+    def test_custom_field_types
+        assert_equal KayakoClient::CustomField::TYPE_TEXT, KayakoClient::TicketCustomField::TYPE_TEXT
+        assert_equal KayakoClient::CustomField::TYPE_TEXT_AREA, KayakoClient::TicketCustomField::TYPE_TEXT_AREA
+        assert_equal KayakoClient::CustomField::TYPE_PASSWORD, KayakoClient::TicketCustomField::TYPE_PASSWORD
+        assert_equal KayakoClient::CustomField::TYPE_CHECKBOX, KayakoClient::TicketCustomField::TYPE_CHECKBOX
+        assert_equal KayakoClient::CustomField::TYPE_RADIO, KayakoClient::TicketCustomField::TYPE_RADIO
+        assert_equal KayakoClient::CustomField::TYPE_SELECT, KayakoClient::TicketCustomField::TYPE_SELECT
+        assert_equal KayakoClient::CustomField::TYPE_MULTI_SELECT, KayakoClient::TicketCustomField::TYPE_MULTI_SELECT
+        assert_equal KayakoClient::CustomField::TYPE_CUSTOM, KayakoClient::TicketCustomField::TYPE_CUSTOM
+        assert_equal KayakoClient::CustomField::TYPE_LINKED_SELECT, KayakoClient::TicketCustomField::TYPE_LINKED_SELECT
+        assert_equal KayakoClient::CustomField::TYPE_DATE, KayakoClient::TicketCustomField::TYPE_DATE
+        assert_equal KayakoClient::CustomField::TYPE_FILE, KayakoClient::TicketCustomField::TYPE_FILE
+    end
+
+    def test_custom_field_option
+        test = KayakoClient::CustomFieldOption.new(
+            :custom_field_option_id => 1,
+            :custom_field_id        => 1,
+            :option_value           => 'Test',
+            :display_order          => 1,
+            :is_selected            => true
+        )
+
+        assert_equal test.custom_field_option_id, 1
+        assert_equal test.custom_field_id, 1
+        assert_equal test.option_value, 'Test'
+        assert_equal test.display_order, 1
+
+        assert test.is_selected?
+        assert !test.has_parent_custom_field_option?
+    end
+
+end

data/test/test_department.rb

@@ -0,0 +1,136 @@
+#######################################################################
+#
+# 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 TestDepartment < Test::Unit::TestCase
+
+    def test_department_readonly
+        test = KayakoClient::Department.new(
+            :id     => 1,
+            :title  => 'Test',
+            :type   => :public,
+            :app => :tickets
+        )
+        assert_raise NoMethodError do
+            test.id = 2
+        end
+
+        assert_nothing_raised do
+            test.app = :livechat
+        end
+
+        test.loaded!
+        assert_raise ArgumentError do
+            test.app = :livechat
+        end
+    end
+
+    def test_department_assign
+        test = KayakoClient::Department.new
+
+        test.type = "public"
+        assert_equal test.type, :public
+
+        test.app = "tickets"
+        assert_equal test.app, :tickets
+
+        test.display_order = "nan"
+        assert_equal test.display_order, 0
+
+        parent = KayakoClient::Department.new(
+            :id => 1
+        )
+
+        test.parent_department_id = parent
+        assert_equal test.parent_department_id, 1
+
+        test.user_visibility_custom = 1
+        assert_equal test.user_visibility_custom, true
+    end
+
+    def test_department_required
+        test = KayakoClient::Department.new(
+            :id => 1,
+            :display_order => 1
+        )
+        assert_raise ArgumentError do
+            test.put
+        end
+
+        test = KayakoClient::Department.new(
+            :title => "Test"
+        )
+        assert_raise ArgumentError do
+            test.post
+        end
+    end
+
+    def test_department_validate
+        test = KayakoClient::Department.new(
+            :id    => 1,
+            :title => "Test",
+            :type => :test
+        )
+        assert_equal test.put, false
+        assert test.has_errors?
+    end
+
+    def test_department_customs
+        test = KayakoClient::Department.new(
+            :id                   => 1,
+            :title                => 'Test',
+            :type                 => :public,
+            :app                  => :tickets
+        )
+        assert_equal test.has_parent_department?, false
+
+        test.parent_department_id = 2
+        assert test.has_parent_department?
+
+        assert test.visible_to_user_group?(1)
+
+        test.user_visibility_custom = true
+        assert test.visible_to_user_group?(1) == false
+
+        test.user_group_ids = [ 1 ]
+        assert test.visible_to_user_group?(1)
+    end
+
+    def test_department_aliases
+        test = KayakoClient::Department.new
+
+        assert_nothing_raised do
+            test.parentdepartmentid = 1
+        end
+
+        assert_nothing_raised do
+            test.parentdepartmentid
+        end
+        assert_equal test.parentdepartmentid, 1
+
+        assert_nothing_raised do
+            test.usergroupid = [ 1 ]
+        end
+
+        assert_nothing_raised do
+            test.usergroups
+        end
+        assert_instance_of Array, test.usergroups
+        assert_equal test.usergroups.size, 1
+        assert_equal test.usergroups[0], 1
+    end
+
+end

data/test/test_http.rb

@@ -0,0 +1,34 @@
+#######################################################################
+#
+# 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 TestHTTP < Test::Unit::TestCase
+
+    def test_response
+        test = KayakoClient::HTTPResponse.new(303, 'Test')
+        assert_equal test.status, 303
+        assert_equal test.body, 'Test'
+
+        test = KayakoClient::HTTPOK.new
+        assert_equal test.status, 200
+        assert_equal test.body, ''
+
+        test = KayakoClient::HTTPForbidden.new('Test')
+        assert_equal test.status, 403
+        assert_equal test.body, 'Test'
+    end
+
+end

data/test/test_knowledgebase.rb

@@ -0,0 +1,155 @@
+#######################################################################
+#
+# 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 TestKnowledgebase < Test::Unit::TestCase
+
+    def test_knowledgebase_api
+        assert_equal KayakoClient::KnowledgebaseArticle.path,    '/Knowledgebase/Article'
+        assert_equal KayakoClient::KnowledgebaseAttachment.path, '/Knowledgebase/Attachment'
+        assert_equal KayakoClient::KnowledgebaseCategory.path,   '/Knowledgebase/Category'
+        assert_equal KayakoClient::KnowledgebaseComment.path,    '/Knowledgebase/Comment'
+    end
+
+    def test_creator_api
+        test = KayakoClient::KnowledgebaseArticle.new
+
+        assert !test.created_by_user?
+        assert !test.created_by_staff?
+
+        test = KayakoClient::KnowledgebaseArticle.new(
+            :creator_type => KayakoClient::KnowledgebaseArticle::CREATOR_USER
+        )
+
+        assert test.created_by_user?
+
+        test = KayakoClient::KnowledgebaseArticle.new(
+            :creator_type => KayakoClient::KnowledgebaseArticle::CREATOR_STAFF
+        )
+
+        assert test.created_by_staff?
+    end
+
+    def test_article
+        test = KayakoClient::KnowledgebaseArticle.new(
+            :kbarticleid => 1,
+            :categories => [ 0 ]
+        )
+
+        assert test.respond_to?(:id)
+        assert_equal test.id, test.kb_article_id
+
+        assert_raise ArgumentError do
+            KayakoClient::KnowledgebaseArticle.all(1, 2)
+        end
+
+        assert test.in_root_category?
+    end
+
+    def test_article_api
+        assert_raise ArgumentError do
+            KayakoClient::KnowledgebaseAttachment.all
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::KnowledgebaseAttachment.all(0)
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::KnowledgebaseAttachment.get(1)
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::KnowledgebaseAttachment.delete(1)
+        end
+
+        test = KayakoClient::KnowledgebaseAttachment.new(
+            :id => 1
+        )
+        test.loaded!
+
+        assert_raise RuntimeError do
+            test.delete
+        end
+    end
+
+    def test_attachment
+        test = KayakoClient::KnowledgebaseAttachment.new
+
+        assert_raise NotImplementedError do
+            test.put
+        end
+
+        assert test.respond_to?(:file)
+        assert test.respond_to?(:file=)
+    end
+
+    def test_category
+        test = KayakoClient::KnowledgebaseCategory.new(
+            :parent_kb_category_id => 0,
+            :user_visibility_custom => true,
+            :usergroupidlist => [ 1 ],
+            :staff_visibility_custom => true,
+            :staffgroupidlist => [ 1 ]
+        )
+
+        assert !test.has_parent_category?
+        assert test.parent_is_root?
+
+        assert test.visible_to_user_group?(1)
+        assert test.visible_to_staff_group?(1)
+
+        assert !test.visible_to_user_group?(2)
+        assert !test.visible_to_staff_group?(2)
+    end
+
+    def test_comment
+        test = KayakoClient::KnowledgebaseComment.new(
+            :parent_comment_id => 1
+        )
+
+        assert test.respond_to?(:creator=)
+
+        staff = KayakoClient::Staff.new(
+            :id => 1,
+            :full_name => 'Test Test',
+            :email => 'test@test.com'
+        )
+
+        test.creator = staff
+
+        assert_equal test.creator_type, KayakoClient::KnowledgebaseComment::CREATOR_STAFF
+        assert_equal test.creator_id, 1
+        assert_equal test.full_name, 'Test Test'
+        assert_equal test.email, 'test@test.com'
+
+        user = KayakoClient::User.new(
+            :id => 2,
+            :full_name => 'Test2 Test2',
+            :emails => [ 'test2@test2.com' ]
+        )
+
+        test.creator = user
+
+        assert_equal test.creator_type, KayakoClient::KnowledgebaseComment::CREATOR_USER
+        assert_equal test.creator_id, 2
+        assert_equal test.full_name, 'Test2 Test2'
+        assert_equal test.email, 'test2@test2.com'
+
+        assert test.has_parent_comment?
+    end
+
+end