KayakoClient 1.0.2 → 1.1.0

data/lib/kayako_client/ticket.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/department'
 
 require 'kayako_client/staff'
@@ -92,7 +106,9 @@ module KayakoClient
         property :auto_user_id,         :boolean, :new => true
         property :staff_id,             :integer, :new => true
         property :type,                 :symbol, :new => true, :in => TICKET_TYPES
-        property :template_group_id,    :integer
+        property :template_group_id,    :integer, :set => :templategroup
+        property :template_group_name,  :string,  :set => :templategroup
+        property :ignore_autoresponder, :boolean, :new => true
 
         property :work_flow,            :object,   :class => TicketWorkflow
         property :watcher,            [ :object ], :class => TicketWatcher
@@ -107,6 +123,10 @@ module KayakoClient
         associate :organization,        :user_organization_id, UserOrganization
         associate :owner_staff,         :owner_staff_id,       Staff
 
+        if method_defined?(:posts)
+            remove_method(:posts)
+        end
+
         def posts
             if instance_variable_defined?(:@posts)
                 instance_variable_get(:@posts)
@@ -235,6 +255,9 @@ module KayakoClient
                     raise ArgumentError, ":auto_user_id, :user_id or :staff_id is required"
                 end
             end
+            if params.has_key?(:template_group_id) && params.has_key?(:template_group_name)
+                raise ArgumentError, "Only one of :template_group_id or :template_group_name should be used"
+            end
         end
 
     end

data/lib/kayako_client/ticket_attachment.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/mixins/ticket_api'
 require 'kayako_client/mixins/attachment'
 
@@ -23,6 +37,10 @@ module KayakoClient
         associate :ticket,        :ticket_id,      Ticket
         associate :ticket_post,   :ticket_post_id, TicketPost
 
+        if method_defined?(:contents)
+            remove_method(:contents)
+        end
+
         def contents
             if instance_variable_defined?(:@contents)
                 instance_variable_get(:@contents)

data/lib/kayako_client/ticket_count.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/ticket_status'
 require 'kayako_client/ticket_type'
 require 'kayako_client/staff'

data/lib/kayako_client/ticket_custom_field.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 'base64'
 require 'time'
 

data/lib/kayako_client/ticket_note.rb

@@ -1,7 +1,20 @@
+#######################################################################
+#
+# 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/mixins/ticket_api'
 
 require 'kayako_client/staff'
-require 'kayako_client/ticket'
 require 'kayako_client/user'
 require 'kayako_client/user_organization'
 

data/lib/kayako_client/ticket_post.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/mixins/ticket_api'
 
 require 'kayako_client/staff'
@@ -31,6 +45,7 @@ module KayakoClient
         property :ticket_id,         :integer, :new => true, :required => :post
         property :subject,           :string,  :new => true, :required => :post
         property :ticket_post_id,    :integer, :readonly => true
+        property :is_private,        :boolean, :new => true, :required => :post
 
         associate :user,             :user_id,  User
         associate :staff,            :staff_id, Staff

data/lib/kayako_client/ticket_priority.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/mixins/user_visibility_api'
 
 module KayakoClient

data/lib/kayako_client/ticket_status.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/department'
 
 module KayakoClient

data/lib/kayako_client/ticket_time_track.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/mixins/ticket_api'
 
 module KayakoClient

data/lib/kayako_client/ticket_type.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/mixins/user_visibility_api'
 
 require 'kayako_client/department'

data/lib/kayako_client/troubleshooter_attachment.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 'kayako_client/mixins/troubleshooter_step_api'
+
+require 'kayako_client/troubleshooter_step'
+
+module KayakoClient
+    class TroubleshooterAttachment < KayakoClient::Troubleshooter
+        include KayakoClient::TroubleshooterStepAPI
+        include KayakoClient::Attachment
+
+        path '/Troubleshooter/Attachment'
+
+        supports :all, :get, :post, :delete
+
+        property :id,                     :integer, :readonly => true
+        property :troubleshooter_step_id, :integer, :required => :post
+        property :file_name,              :string,  :required => :post
+        property :file_size,              :integer, :readonly => true
+        property :file_type,              :string,  :readonly => true
+        property :date_line,              :date,    :readonly => true
+        property :contents,               :binary,  :required => :post, :new => true
+        property :link,                   :string,  :readonly => true
+
+        associate :troubleshooter_step,   :troubleshooter_step_id, TroubleshooterStep
+
+        if method_defined?(:contents)
+            remove_method(:contents)
+        end
+
+        def contents
+            if instance_variable_defined?(:@contents)
+                instance_variable_get(:@contents)
+            else
+                if !new? && id && id > 0
+                    if troubleshooter_step_id.nil? && !link.nil? && link.match(%r{/[0-9]+/([0-9]+)/([0-9]+)/?$}) && $2.to_i == id
+                        troubleshooter_step_id = $1.to_i
+                    end
+                    if troubleshooter_step_id && troubleshooter_step_id > 0
+                        logger.debug "contents are missing - trying to reload" if logger
+                        if reload!(:e => "#{self.class.path}/#{troubleshooter_step_id.to_i}/#{id.to_i}") && instance_variable_defined?(:@contents)
+                            instance_variable_get(:@contents)
+                        else
+                            instance_variable_set(:@contents, nil)
+                        end
+                    else
+                        nil
+                    end
+                else
+                    nil
+                end
+            end
+        end
+
+    end
+end

data/lib/kayako_client/troubleshooter_category.rb

@@ -0,0 +1,51 @@
+#######################################################################
+#
+# 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/mixins/convert_api'
+
+require 'kayako_client/staff'
+require 'kayako_client/user_group'
+require 'kayako_client/staff_group'
+
+module KayakoClient
+    class TroubleshooterCategory < KayakoClient::Troubleshooter
+        include KayakoClient::ConvertAPI
+        include KayakoClient::UserVisibilityAPI
+        include KayakoClient::StaffVisibilityAPI
+
+        path '/Troubleshooter/Category'
+
+        TYPE_GLOBAL  = 1
+        TYPE_PUBLIC  = 2
+        TYPE_PRIVATE = 3
+
+        property :id,                      :integer, :readonly => true
+        property :staff_id,                :integer, :required => :post, :new => true
+        property :staff_name,              :string,  :readonly => true
+        property :title,                   :string,  :required => :post
+        property :description,             :string
+        property :category_type,           :integer, :required => :post, :range => 1..3
+        property :display_order,           :integer
+        property :views,                   :integer, :readonly => true
+        property :user_visibility_custom,  :boolean
+        property :user_group_ids,        [ :integer ], :get => :usergroupidlist, :set => :usergroupidlist, :condition => { :user_visibility_custom => true }
+        property :staff_visibility_custom, :boolean
+        property :staff_group_ids,       [ :integer ], :get => :staffgroupidlist, :set => :staffgroupidlist, :condition => { :staff_visibility_custom => true }
+
+        associate :staff,                  :staff_id,        Staff
+        associate :user_groups,            :user_group_ids,  UserGroup
+        associate :staff_groups,           :staff_group_ids, StaffGroup
+
+    end
+end

data/lib/kayako_client/troubleshooter_comment.rb

@@ -0,0 +1,32 @@
+#######################################################################
+#
+# 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/mixins/creator_api'
+require 'kayako_client/mixins/comment_object'
+
+require 'kayako_client/troubleshooter_step'
+
+module KayakoClient
+    class TroubleshooterComment < KayakoClient::Troubleshooter
+        include KayakoClient::CreatorAPI
+        include KayakoClient::CommentObject
+
+        path '/Troubleshooter/Comment'
+
+        property :troubleshooter_step_id, :integer, :required => :post
+
+        associate :troubleshooter_step, :troubleshooter_step_id, TroubleshooterStep
+
+    end
+end

data/lib/kayako_client/troubleshooter_step.rb

@@ -0,0 +1,100 @@
+#######################################################################
+#
+# 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/mixins/convert_api'
+
+require 'kayako_client/troubleshooter_category'
+
+require 'kayako_client/staff'
+require 'kayako_client/department'
+require 'kayako_client/ticket_type'
+require 'kayako_client/ticket_priority'
+
+module KayakoClient
+
+    class TroubleshooterAttachment < KayakoClient::Troubleshooter
+    end
+
+    class TroubleshooterStep < KayakoClient::Troubleshooter
+        include KayakoClient::ConvertAPI
+        include KayakoClient::TroubleshooterStepClient
+
+        path '/Troubleshooter/Step'
+
+        STATUS_PUBLISHED = 1
+        STATUS_DRAFT     = 2
+
+        property :id,                        :integer, :readonly => true
+        property :category_id,               :integer, :required => :post, :new => true
+        property :staff_id,                  :integer, :required => :post, :new => true
+        property :staff_name,                :string,  :readonly => true
+        property :subject,                   :string,  :required => :post
+        property :edited,                    :boolean, :readonly => true
+        property :edited_staff_id,           :integer, :required => :put
+        property :edited_staff_name,         :string,  :readonly => true
+        property :display_order,             :integer
+        property :views,                     :integer, :readonly => true
+        property :allow_comments,            :boolean
+        property :has_attachments,           :boolean, :readonly => true
+        property :parent_step_ids,         [ :integer ], :get => :parentsteps, :set => :parentstepidlist
+        property :child_step_ids,          [ :integer ], :readonly => true, :get => :childsteps
+        property :redirect_tickets,          :boolean, :readonly => true
+        property :ticket_subject,            :string
+        property :redirect_department_id,    :integer
+        property :ticket_type_id,            :integer
+        property :ticket_priority_id,        :integer, :get => :priorityid
+        property :contents,                  :string, :required => :post
+        property :enable_ticket_redirection, :boolean
+        property :step_status,               :integer, :range => 1..2
+
+        property :attachments,             [ :object ], :class => TroubleshooterAttachment
+
+        associate :category,                 :category_id,            TroubleshooterCategory
+        associate :staff,                    :staff_id,               Staff
+        associate :edited_staff,             :edited_staff_id,        Staff
+        associate :parent_steps,             :parent_step_ids,        TroubleshooterStep
+        associate :child_steps,              :child_step_ids,         TroubleshooterStep
+        associate :redirect_department,      :redirect_department_id, Department
+        associate :ticket_type,              :ticket_type_id,         TicketType
+        associate :priority,                 :ticket_priority_id,     TicketPriority
+
+        def has_parent_steps?
+            !parent_step_ids.nil? && parent_step_ids.size > 0
+        end
+
+        def has_child_steps?
+            !child_step_ids.nil? && child_step_ids.size > 0
+        end
+
+        def in_step?(step)
+            step.respond_to?(:to_i) && !parent_step_ids.nil? && parent_step_ids.include?(step.to_i)
+        end
+
+        def has_step?(step)
+            step.respond_to?(:to_i) && !child_step_ids.nil? && child_step_ids.include?(step.to_i)
+        end
+
+    private
+
+        def validate(method, params)
+            if method == :put
+                unless changes.include?(:edited_staff_id) && params[:edited_staff_id].to_i > 0
+                    raise ArgumentError, ":edited_staff_id is required"
+                end
+            end
+        end
+
+    end
+
+end