KayakoClient 1.0.2 → 1.1.0

data/test/test_status.rb

@@ -0,0 +1,52 @@
+#######################################################################
+#
+# 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 TestStatus < Test::Unit::TestCase
+
+    def test_status_methods
+        test = KayakoClient::TicketStatus.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_status_constants
+        assert KayakoClient::TicketStatus::STATUS_TYPES.include?(:public)
+        assert KayakoClient::TicketStatus::STATUS_TYPES.include?(:private)
+    end
+
+    def test_status_customs
+        test = KayakoClient::TicketStatus.new(
+            :staffvisibilitycustom => true,
+            :staffgroupid => [ 1, 2 ]
+        )
+
+        assert test.respond_to?(:visible_to_staff_group?)
+        assert test.visible_to_staff_group?(1)
+        assert !test.visible_to_staff_group?(3)
+    end
+
+end

data/test/test_ticket.rb

@@ -0,0 +1,152 @@
+#######################################################################
+#
+# 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 TestTicket < Test::Unit::TestCase
+
+    def test_ticket_readonly
+        test = KayakoClient::Ticket.new(
+            :contents => 'Test',
+            :auto_user_id => true,
+            :type => :default
+        )
+
+        assert_raise NoMethodError do
+            test.display_id = 'OLJ-171-16930'
+        end
+
+        assert_raise NoMethodError do
+            test.creation_time = Time.new
+        end
+
+        assert_nothing_raised do
+            test.contents = 'Test'
+            test.auto_user_id = true
+            test.type = :default
+        end
+
+        test.loaded!
+        assert_raise ArgumentError do
+            test.contents = 'Test'
+            test.auto_user_id = true
+            test.type = :default
+        end
+    end
+
+    def test_ticket_constants
+        assert_nothing_raised do
+            test = KayakoClient::Ticket::FLAG_NONE
+            test = KayakoClient::Ticket::FLAG_ORANGE
+            test = KayakoClient::Ticket::FLAG_BLUE
+        end
+    end
+
+    def test_ticket_verification
+        test = KayakoClient::Ticket.new(
+            :department_id => 1,
+            :status_id     => 1,
+            :priority_id   => 1,
+            :type_id       => 1,
+            :full_name     => 'Test Tester',
+            :email         => 'test@test.com',
+            :subject       => 'Test',
+            :contents      => 'Test'
+        )
+
+        assert_raise ArgumentError do
+            test.post
+        end
+
+        test.user_id = 1
+        test.type = :test
+
+        assert test.post == false
+        assert test.has_errors?
+    end
+
+    def test_ticket_embedded
+        test = KayakoClient::Ticket.new(
+            :work_flow => {
+                :id    => 1,
+                :title => 'Test'
+            },
+            :watcher => {
+                :staff_id => 1,
+                :name     => 'Test'
+            }
+        )
+
+        assert_instance_of KayakoClient::TicketWorkflow, test.work_flow
+        assert_instance_of Array, test.watcher
+        assert_instance_of KayakoClient::TicketWatcher, test.watcher.first
+
+        assert_equal test.work_flow.title, 'Test'
+        assert_equal test.watcher.first.name, 'Test'
+    end
+
+    def test_ticket_assign
+        test = KayakoClient::Ticket.new(
+            :id => '1',
+            :creation_time => '1310922585',
+            :is_escalated => '0'
+        )
+
+        assert_equal test.id, 1
+        assert_instance_of Time, test.creation_time
+        assert_equal test.creation_time.to_i, 1310922585
+        assert_instance_of FalseClass, test.is_escalated
+        assert test.is_escalated == false
+    end
+
+    def test_ticket_search
+        assert KayakoClient::Ticket.respond_to?(:search)
+
+        assert_equal 0x07FF,
+            KayakoClient::Ticket::SEARCH_TICKET_ID         |
+            KayakoClient::Ticket::SEARCH_CONTENTS          |
+            KayakoClient::Ticket::SEARCH_AUTHOR            |
+            KayakoClient::Ticket::SEARCH_EMAIL             |
+            KayakoClient::Ticket::SEARCH_CREATOR_EMAIL     |
+            KayakoClient::Ticket::SEARCH_FULL_NAME         |
+            KayakoClient::Ticket::SEARCH_NOTES             |
+            KayakoClient::Ticket::SEARCH_USER_GROUP        |
+            KayakoClient::Ticket::SEARCH_USER_ORGANIZATION |
+            KayakoClient::Ticket::SEARCH_USER              |
+            KayakoClient::Ticket::SEARCH_TAGS
+
+    end
+
+    def test_template_group
+        test = KayakoClient::Ticket.new(
+            :department_id       => 1,
+            :status_id           => 1,
+            :priority_id         => 1,
+            :type_id             => 1,
+            :full_name           => 'Test Tester',
+            :email               => 'test@test.com',
+            :subject             => 'Test',
+            :contents            => 'Test',
+            :staff_id            => 1,
+            :template_group_id   => 1,
+            :template_group_name => 'default'
+        )
+
+        assert_raise ArgumentError do
+            test.post
+        end
+    end
+
+end

data/test/test_ticket_custom_field.rb

@@ -0,0 +1,193 @@
+#######################################################################
+#
+# 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 TestTicketCustomField < Test::Unit::TestCase
+
+    def test_ticket_custom_field_embedded
+        test = KayakoClient::TicketCustomField.new(
+            :group => {
+                :id     => 1,
+                :title  => 'Test',
+                :fields => [ {
+                        :id       => 1,
+                        :type     => KayakoClient::CustomField::TYPE_TEXT,
+                        :title    => 'Text',
+                        :contents => 'Test'
+                    }, {
+                        :id       => 2,
+                        :type     => KayakoClient::CustomField::TYPE_TEXT_AREA,
+                        :title    => 'Text area',
+                        :contents => 'Test'
+                    }, {
+                        :id       => 3,
+                        :type     => KayakoClient::CustomField::TYPE_PASSWORD,
+                        :title    => 'Password',
+                        :contents => 'Test'
+                    }, {
+                        :id       => 4,
+                        :type     => KayakoClient::CustomField::TYPE_CHECKBOX,
+                        :title    => 'Checkbox',
+                        :contents => 'Test'
+                    }, {
+                        :id       => 5,
+                        :type     => KayakoClient::CustomField::TYPE_RADIO,
+                        :title    => 'Radio',
+                        :contents => 'Test'
+                    }, {
+                        :id       => 6,
+                        :type     => KayakoClient::CustomField::TYPE_SELECT,
+                        :title    => 'Select',
+                        :contents => 'Test'
+                    }, {
+                        :id       => 7,
+                        :type     => KayakoClient::CustomField::TYPE_MULTI_SELECT,
+                        :title    => 'Multiselect',
+                        :contents => 'Test, Item'
+                    }, {
+                        :id       => 8,
+                        :type     => KayakoClient::CustomField::TYPE_CUSTOM,
+                        :title    => 'Custom',
+                        :contents => 'Test'
+                    }, {
+                        :id       => 9,
+                        :type     => KayakoClient::CustomField::TYPE_LINKED_SELECT,
+                        :title    => 'Linked select',
+                        :contents => 'Test &gt; Test'
+                    }, {
+                        :id       => 10,
+                        :type     => KayakoClient::CustomField::TYPE_DATE,
+                        :title    => 'Date',
+                        :contents => 'May/24/2011'
+                    }, {
+                        :id       => 11,
+                        :type     => KayakoClient::CustomField::TYPE_FILE,
+                        :title    => 'File',
+                        :filename => 'test.txt',
+                        :contents => 'VTI5dFpTQjBaWE4wSUhOMGNtbHVaeTQ9' # Some test string
+                } ]
+            }
+        )
+
+        assert_instance_of Array, test.groups
+        assert_instance_of KayakoClient::TicketCustomFieldGroup, test.groups.first
+        assert_equal test.groups.size, 1
+
+        assert_equal test.groups.first.id, 1
+        assert_equal test.groups.first.title, 'Test'
+
+        assert_instance_of Array, test.groups.first.fields
+        assert_instance_of KayakoClient::TicketCustomFieldValue, test.groups.first.fields.first
+        assert_equal test.groups.first.fields.size, 11
+
+        assert_equal test.groups.first.fields.first.id, 1
+        assert_equal test.groups.first.fields.first.type, KayakoClient::CustomField::TYPE_TEXT
+        assert_equal test.groups.first.fields.first.title, 'Text'
+        assert_nil test.groups.first.fields.first.file_name
+        assert_equal test.groups.first.fields.first.contents, 'Test'
+
+        assert_instance_of Time, test.groups.first.fields[9].contents
+        assert_equal test.groups.first.fields[9].contents.strftime('%m/%d/%Y'), '05/24/2011'
+
+        assert_equal test.groups.first.fields.last.file_name, 'test.txt'
+        assert_equal test.groups.first.fields.last.contents, 'Some test string.'
+    end
+
+    def test_ticket_custom_field_file
+        test = KayakoClient::TicketCustomFieldValue.new(
+            :id       => 11,
+            :type     => KayakoClient::CustomField::TYPE_FILE,
+            :title    => 'File',
+            :filename => 'test.txt',
+            :contents => 'VTI5dFpTQjBaWE4wSUhOMGNtbHVaeTQ9' # Some test string.
+        )
+        test.loaded!
+        assert_instance_of Tempfile, test.file
+        assert_equal test.file.read, 'Some test string.'
+    end
+
+    def test_ticket_custom_field_customs
+        test = KayakoClient::TicketCustomField.new
+
+        assert test.respond_to?(:empty?)
+        assert test.empty?
+
+        test = KayakoClient::TicketCustomField.new(
+            :group => {
+                :id     => 1,
+                :title  => 'Test',
+                :fields => [ {
+                        :id       => 4,
+                        :type     => KayakoClient::CustomField::TYPE_CHECKBOX,
+                        :title    => 'Checkbox',
+                        :contents => 'Test'
+                    }, {
+                        :id       => 9,
+                        :type     => KayakoClient::CustomField::TYPE_LINKED_SELECT,
+                        :title    => 'Linked select',
+                        :contents => 'Test &gt; Test'
+                } ]
+            }
+        )
+
+        assert_equal test.custom_field(4), 'Test'
+        assert_equal test.custom_field('Linked select'), 'Test &gt; Test'
+        assert_nil test.custom_field('Does not exist')
+
+        assert_equal test[9], 'Test &gt; Test'
+        assert_equal test['Checkbox'], 'Test'
+        assert_nil test[20]
+
+        assert_instance_of Array, test['groups']
+        assert_instance_of Array, test[:groups]
+
+        assert test.respond_to?(:each)
+    end
+
+    def test_4_40_954
+        test = KayakoClient::TicketCustomFieldValue.new
+
+        assert_raise NoMethodError do
+            test.id = 1
+        end
+
+        test.contents = 'Test'
+        assert_equal test.contents, 'Test'
+
+        assert KayakoClient::TicketCustomField.support?(:post)
+
+        test = KayakoClient::TicketCustomField.new(:ticket_id => 1,
+                                                   'l8bo9bitv8s0' => 'Test')
+
+        assert test.respond_to?(:ticket_id)
+        assert test.respond_to?(:ticket_id=)
+
+        assert_equal test.ticket_id, 1
+        assert_equal test['l8bo9bitv8s0'], 'Test'
+        assert_equal test.custom_field('l8bo9bitv8s0'), 'Test'
+
+        assert !test.empty?
+
+        test['qgwj1d0r0qhc'] = 'Name'
+
+        test = KayakoClient::TicketCustomField.new
+
+        assert_raise RuntimeError do
+            test.post
+        end
+    end
+
+end

data/test/test_time_track.rb

@@ -0,0 +1,68 @@
+#######################################################################
+#
+# 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 TestTimeTrack < Test::Unit::TestCase
+
+    def test_time_track_methods
+        test = KayakoClient::TicketTimeTrack.new
+
+        assert_raise NotImplementedError do
+            test.put
+        end
+    end
+
+    def test_time_track_ticket_api
+        assert KayakoClient::TicketTimeTrack.included_modules.include?(KayakoClient::TicketAPI)
+
+        assert_raise ArgumentError do
+            KayakoClient::TicketTimeTrack.all
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::TicketTimeTrack.get(1)
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::TicketTimeTrack.delete(1)
+        end
+    end
+
+    def test_time_track_associates
+        test = KayakoClient::TicketTimeTrack.new(
+            :ticket_id => 0,
+            :worker_staff_id => 0,
+            :creator_staff_id => 0
+        )
+
+        assert test.respond_to?(:ticket)
+        assert test.respond_to?(:worker_staff)
+        assert test.respond_to?(:creator_staff)
+
+        assert_nil test.ticket
+        assert_nil test.worker_staff
+        assert_nil test.creator_staff
+    end
+
+    def test_time_track_note_colors
+        assert KayakoClient::TicketTimeTrack.options[:note_color][:range].include?(KayakoClient::TicketNote::COLOR_YELLOW)
+        assert KayakoClient::TicketTimeTrack.options[:note_color][:range].include?(KayakoClient::TicketNote::COLOR_PURPLE)
+        assert KayakoClient::TicketTimeTrack.options[:note_color][:range].include?(KayakoClient::TicketNote::COLOR_BLUE)
+        assert KayakoClient::TicketTimeTrack.options[:note_color][:range].include?(KayakoClient::TicketNote::COLOR_GREEN)
+        assert KayakoClient::TicketTimeTrack.options[:note_color][:range].include?(KayakoClient::TicketNote::COLOR_RED)
+    end
+
+end