KayakoClient 1.0.2 → 1.1.0

data/lib/kayako_client/user.rb

@@ -1,3 +1,17 @@
+#######################################################################
+#
+# 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 'kayako_client/user_group'
 require 'kayako_client/user_organization'
 
@@ -57,5 +71,33 @@ module KayakoClient
             super(options.merge(:e => e))
         end
 
+        def self.search(query, options = {})
+            unless configured? || (options[:api_url] && options[:api_key] && options[:secret_key])
+                raise RuntimeError, "client not configured"
+            end
+            raise ArgumentError, "query can't be empty" if query.empty?
+
+            response = post_request(options.merge(:e => '/Base/UserSearch', :query => query))
+            log = options[:logger] || logger
+            if response.is_a?(KayakoClient::HTTPOK)
+                objects = []
+                if log
+                    log.debug "Response:"
+                    log.debug response.body
+                end
+                payload = xml_backend.new(response.body, { :logger => log })
+                payload.each do |element|
+                    object = new(payload.to_hash(element).merge(inherited_options(options)))
+                    object.loaded!
+                    objects << object
+                end
+                log.info ":post(:search, '#{query}') successful (#{objects.size} objects)" if log
+                objects
+            else
+                log.error "Response: #{response.status} #{response.body}" if log
+                raise StandardError, "server returned #{response.status}: #{response.body}"
+            end
+        end
+
     end
 end

data/lib/kayako_client/user_group.rb

@@ -1,3 +1,17 @@
+#######################################################################
+#
+# 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
+#
+#######################################################################
+
 module KayakoClient
     class UserGroup < KayakoClient::Base
 

data/lib/kayako_client/user_organization.rb

@@ -1,3 +1,17 @@
+#######################################################################
+#
+# 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
+#
+#######################################################################
+
 module KayakoClient
     class UserOrganization < KayakoClient::Base
 

data/lib/kayako_client/xml/lib_xml.rb

@@ -1,3 +1,17 @@
+#######################################################################
+#
+# 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 'libxml'
 
 module KayakoClient

data/lib/kayako_client/xml/rexml_document.rb

@@ -1,3 +1,17 @@
+#######################################################################
+#
+# 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 'rexml/document'
 
 module KayakoClient

data/lib/kayako_client/xml/xml.rb

@@ -1,3 +1,17 @@
+#######################################################################
+#
+# 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
+#
+#######################################################################
+
 module KayakoClient
     module XML
 

data/lib/kayako_client/xml/xml_backend.rb

@@ -1,3 +1,17 @@
+#######################################################################
+#
+# 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
+#
+#######################################################################
+
 module KayakoClient
 
     module XMLBackend

data/test/test_attachment.rb

@@ -0,0 +1,77 @@
+#######################################################################
+#
+# 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 TestAttachment < Test::Unit::TestCase
+
+    def test_attachment_put
+        test = KayakoClient::TicketAttachment.new
+        assert_raise NotImplementedError do
+            test.put
+        end
+    end
+
+    def test_attachment_file
+        test = KayakoClient::TicketAttachment.new(
+            :file => __FILE__
+        )
+        assert_equal test.file_name, File.basename(__FILE__)
+        assert_equal test.contents.size, File.size?(__FILE__)
+
+        assert_raise RuntimeError do
+            test.file
+        end
+
+        test = KayakoClient::TicketAttachment.new(
+            :id        => 1,
+            :file_name => 'test.txt',
+            :contents  => 'Test file content.'
+        )
+        test.loaded!
+        assert_instance_of Tempfile, test.file
+
+        assert_equal test.file_name, 'test.txt'
+        assert_equal test.contents, 'Test file content.'
+    end
+
+    def test_attachment_api
+        test = KayakoClient::TicketAttachment.new(
+            :id             => 1,
+            :ticket_id      => 1,
+            :ticket_post_id => 1,
+            :file_name      => 'test.txt'
+        )
+        assert_nil test.contents
+
+        test.loaded!
+        assert_raise RuntimeError do
+            test.contents
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::TicketAttachment.all
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::TicketAttachment.get(1)
+        end
+
+        assert_raise ArgumentError do
+            KayakoClient::TicketAttachment.delete(1)
+        end
+    end
+
+end

data/test/test_client.rb

@@ -0,0 +1,191 @@
+#######################################################################
+#
+# 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 TestClient < Test::Unit::TestCase
+
+    def test_client_base
+        test = KayakoClient::Base.new
+
+        assert test.respond_to?(:departments)
+        assert test.respond_to?(:get_department)
+        assert test.respond_to?(:post_department)
+        assert test.respond_to?(:delete_department)
+        assert test.respond_to?(:staff)
+        assert test.respond_to?(:get_staff)
+        assert test.respond_to?(:post_staff)
+        assert test.respond_to?(:delete_staff)
+        assert test.respond_to?(:staff_groups)
+        assert test.respond_to?(:get_staff_group)
+        assert test.respond_to?(:post_staff_group)
+        assert test.respond_to?(:delete_staff_group)
+        assert test.respond_to?(:tickets)
+        assert test.respond_to?(:get_ticket)
+        assert test.respond_to?(:ticket_search)
+        assert test.respond_to?(:post_ticket)
+        assert test.respond_to?(:delete_ticket)
+        assert test.respond_to?(:ticket_attachments)
+        assert test.respond_to?(:get_ticket_attachment)
+        assert test.respond_to?(:post_ticket_attachment)
+        assert test.respond_to?(:delete_ticket_attachment)
+        assert test.respond_to?(:ticket_count)
+        assert test.respond_to?(:ticket_custom_fields)
+        assert test.respond_to?(:ticket_notes)
+        assert test.respond_to?(:get_ticket_note)
+        assert test.respond_to?(:post_ticket_note)
+        assert test.respond_to?(:delete_ticket_note)
+        assert test.respond_to?(:ticket_posts)
+        assert test.respond_to?(:get_ticket_post)
+        assert test.respond_to?(:post_ticket_post)
+        assert test.respond_to?(:delete_ticket_post)
+        assert test.respond_to?(:ticket_priorities)
+        assert test.respond_to?(:get_ticket_priority)
+        assert test.respond_to?(:ticket_statuses)
+        assert test.respond_to?(:get_ticket_status)
+        assert test.respond_to?(:ticket_time_tracks)
+        assert test.respond_to?(:get_ticket_time_track)
+        assert test.respond_to?(:post_ticket_time_track)
+        assert test.respond_to?(:delete_ticket_time_track)
+        assert test.respond_to?(:ticket_types)
+        assert test.respond_to?(:get_ticket_type)
+        assert test.respond_to?(:users)
+        assert test.respond_to?(:get_user)
+        assert test.respond_to?(:user_search)
+        assert test.respond_to?(:post_user)
+        assert test.respond_to?(:delete_user)
+        assert test.respond_to?(:user_groups)
+        assert test.respond_to?(:get_user_group)
+        assert test.respond_to?(:post_user_group)
+        assert test.respond_to?(:delete_user_group)
+        assert test.respond_to?(:user_organizations)
+        assert test.respond_to?(:get_user_organization)
+        assert test.respond_to?(:post_user_organization)
+        assert test.respond_to?(:delete_user_organization)
+
+        assert test.respond_to?(:find_department)
+        assert test.respond_to?(:create_department)
+        assert test.respond_to?(:destroy_department)
+        assert test.respond_to?(:staff_users)
+        assert test.respond_to?(:find_staff)
+        assert test.respond_to?(:create_staff)
+        assert test.respond_to?(:destroy_staff)
+        assert test.respond_to?(:find_staff_group)
+        assert test.respond_to?(:create_staff_group)
+        assert test.respond_to?(:destroy_staff_group)
+        assert test.respond_to?(:find_ticket)
+        assert test.respond_to?(:create_ticket)
+        assert test.respond_to?(:destroy_ticket)
+        assert test.respond_to?(:find_ticket_attachment)
+        assert test.respond_to?(:create_ticket_attachment)
+        assert test.respond_to?(:destroy_ticket_attachment)
+        assert test.respond_to?(:find_ticket_note)
+        assert test.respond_to?(:create_ticket_note)
+        assert test.respond_to?(:destroy_ticket_note)
+        assert test.respond_to?(:find_ticket_post)
+        assert test.respond_to?(:create_ticket_post)
+        assert test.respond_to?(:destroy_ticket_post)
+        assert test.respond_to?(:find_ticket_priority)
+        assert test.respond_to?(:find_ticket_status)
+        assert test.respond_to?(:find_ticket_time_track)
+        assert test.respond_to?(:create_ticket_time_track)
+        assert test.respond_to?(:destroy_ticket_time_track)
+        assert test.respond_to?(:find_ticket_type)
+        assert test.respond_to?(:find_user)
+        assert test.respond_to?(:create_user)
+        assert test.respond_to?(:destroy_user)
+        assert test.respond_to?(:find_user_group)
+        assert test.respond_to?(:create_user_group)
+        assert test.respond_to?(:destroy_user_group)
+        assert test.respond_to?(:find_user_organization)
+        assert test.respond_to?(:create_user_organization)
+        assert test.respond_to?(:destroy_user_organization)
+        assert test.respond_to?(:custom_fields)
+        assert test.respond_to?(:custom_field_options)
+
+        test = KayakoClient::Ticket.new
+
+        assert !test.respond_to?(:get_ticket)
+        assert !test.respond_to?(:get_ticket_post)
+        assert !test.respond_to?(:user_organizations)
+        assert !test.respond_to?(:find_staff_group)
+        assert !test.respond_to?(:find_user_group)
+    end
+
+    def test_client_ticket
+        assert KayakoClient::Ticket.respond_to?(:count)
+
+        test = KayakoClient::Ticket.new
+
+        assert test.respond_to?(:attachments)
+        assert test.respond_to?(:get_attachment)
+        assert test.respond_to?(:post_attachment)
+        assert test.respond_to?(:delete_attachment)
+        assert test.respond_to?(:custom_fields)
+        assert test.respond_to?(:notes)
+        assert test.respond_to?(:get_note)
+        assert test.respond_to?(:post_note)
+        assert test.respond_to?(:delete_note)
+        assert test.respond_to?(:get_post)
+        assert test.respond_to?(:post_post)
+        assert test.respond_to?(:delete_post)
+        assert test.respond_to?(:time_tracks)
+        assert test.respond_to?(:get_time_track)
+        assert test.respond_to?(:post_time_track)
+        assert test.respond_to?(:delete_time_track)
+
+        assert test.respond_to?(:find_attachment)
+        assert test.respond_to?(:create_attachment)
+        assert test.respond_to?(:destroy_attachment)
+        assert test.respond_to?(:find_note)
+        assert test.respond_to?(:create_note)
+        assert test.respond_to?(:destroy_note)
+        assert test.respond_to?(:find_post)
+        assert test.respond_to?(:create_post)
+        assert test.respond_to?(:destroy_post)
+        assert test.respond_to?(:find_time_track)
+        assert test.respond_to?(:create_time_track)
+        assert test.respond_to?(:destroy_time_track)
+
+        test = KayakoClient::Base.new
+
+        assert !test.respond_to?(:attachments)
+        assert !test.respond_to?(:delete_post)
+        assert !test.respond_to?(:notes)
+        assert !test.respond_to?(:create_attachment)
+        assert !test.respond_to?(:find_post)
+    end
+
+    def test_client_inheritance
+        require 'kayako_client/http/http_client'
+        require 'kayako_client/http/net_http'
+
+        nethttp = KayakoClient::NetHTTP.new
+        httpclient = KayakoClient::HTTPClient.new
+
+        KayakoClient::Base.http_backend = nethttp
+        assert_equal nethttp.object_id, KayakoClient::Base.client.object_id
+
+        instance = KayakoClient::User.new
+        assert_equal nethttp.object_id, instance.client.object_id
+
+        client = KayakoClient::Base.new
+        client.http_backend = httpclient
+
+        assert_equal httpclient.object_id, client.client.object_id
+        assert_not_equal client.client.object_id, nethttp.object_id
+    end
+
+end

data/test/test_configuration.rb

@@ -0,0 +1,110 @@
+#######################################################################
+#
+# 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 TestConfiguration < Test::Unit::TestCase
+
+    API_URL    = 'http://restapi.kayako.com/api/index.php?'
+    API_KEY    = '2fa87390-7160-54c4-e9ce-bec638a5a153'
+    SECRET_KEY = 'Yzg3M2E3OWQtODM5MS1jNmY0LThkZjgtODJjZTU1MGE4MzcyYWY4NjQ2MTUtNDkxZS1lNDE0LTgxYzQtYWNjZmM5MzVjMmIz'
+
+    def test_001_no_configuration
+        assert_equal KayakoClient::Base.api_url, ''
+        assert_equal KayakoClient::Base.api_key, ''
+        assert_equal KayakoClient::Base.secret_key, ''
+
+        assert_raise RuntimeError do
+            KayakoClient::StaffGroup.get(1)
+        end
+        assert_raise RuntimeError do
+            KayakoClient::StaffGroup.post(
+                :title    => 'Test',
+                :is_admin => true
+            )
+        end
+
+        test = KayakoClient::StaffGroup.new
+        assert_raise RuntimeError do
+            test.post
+        end
+    end
+
+    def test_002_instance_configuration
+        instance1 = KayakoClient::Base.new(API_URL, API_KEY, SECRET_KEY)
+        instance2 = KayakoClient::Base.new
+
+        assert_equal instance1.api_url, API_URL
+        assert_equal instance1.api_key, API_KEY
+        assert_equal instance1.secret_key, SECRET_KEY
+
+        assert_equal instance2.api_url, ''
+        assert_equal instance2.api_key, ''
+        assert_equal instance2.secret_key, ''
+    end
+
+    def test_003_global_configuration
+        KayakoClient::Base.configure do |config|
+            config.api_url = API_URL
+            config.api_key = API_KEY
+        end
+        assert_equal KayakoClient::Base.api_url, API_URL
+        assert_equal KayakoClient::Base.api_key, API_KEY
+
+        KayakoClient::Base.secret_key = SECRET_KEY
+        assert_equal KayakoClient::Base.secret_key, SECRET_KEY
+
+        assert_equal KayakoClient::StaffGroup.new.api_key, API_KEY
+    end
+
+    def test_004_http_backend
+        assert_raise ArgumentError do
+            KayakoClient::Base.http_backend = 'This should be a class name!'
+        end
+
+        assert_raise LoadError do
+            KayakoClient::Base.http_backend = 'NotExistingHTTPBackendClass'
+        end
+
+        assert_nothing_raised do
+            KayakoClient::Base.http_backend = 'NetHTTP'
+        end
+    end
+
+    def test_005_xml_backend
+        assert_raise ArgumentError do
+            KayakoClient::Base.xml_backend = 'This should be a class name!'
+        end
+
+        assert_raise LoadError do
+            KayakoClient::Base.xml_backend = 'NotExistingXMLBackendClass'
+        end
+
+        assert_nothing_raised do
+            KayakoClient::Base.xml_backend = 'REXMLDocument'
+        end
+
+        assert_nothing_raised do
+            KayakoClient::Base.xml_backend = 'LibXML'
+        end
+    end
+
+    def test_006_http_configuration
+        KayakoClient::Base.proxy = { :host => '127.0.0.1', :port => 3128 }
+        assert_equal KayakoClient::Base.proxy[:host], '127.0.0.1'
+        assert_equal KayakoClient::Base.proxy[:port], 3128
+    end
+
+end