KayakoClient 1.0.2 → 1.1.0

data/lib/kayako_client.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/http/http_response'
 require 'kayako_client/http/http_backend'
 require 'kayako_client/http/http'
@@ -10,6 +24,11 @@ require 'kayako_client/mixins/object'
 require 'kayako_client/mixins/client'
 require 'kayako_client/mixins/ticket_client'
 require 'kayako_client/mixins/post_client'
+require 'kayako_client/mixins/article_client'
+require 'kayako_client/mixins/knowledgebase_category_client'
+require 'kayako_client/mixins/news_category_client'
+require 'kayako_client/mixins/news_client'
+require 'kayako_client/mixins/troubleshooter_step_client'
 require 'kayako_client/mixins/logger'
 require 'kayako_client/mixins/authentication'
 require 'kayako_client/mixins/attachment'
@@ -20,6 +39,14 @@ require 'kayako_client/mixins/staff_visibility_api'
 require 'kayako_client/base'
 require 'kayako_client/custom_field'
 require 'kayako_client/department'
+require 'kayako_client/knowledgebase_article'
+require 'kayako_client/knowledgebase_attachment'
+require 'kayako_client/knowledgebase_category'
+require 'kayako_client/knowledgebase_comment'
+require 'kayako_client/news_category'
+require 'kayako_client/news_comment'
+require 'kayako_client/news_item'
+require 'kayako_client/news_subscriber'
 require 'kayako_client/staff'
 require 'kayako_client/staff_group'
 require 'kayako_client/ticket'
@@ -32,6 +59,10 @@ require 'kayako_client/ticket_status'
 require 'kayako_client/ticket_time_track'
 require 'kayako_client/ticket_type'
 require 'kayako_client/ticket_count'
+require 'kayako_client/troubleshooter_attachment'
+require 'kayako_client/troubleshooter_category'
+require 'kayako_client/troubleshooter_comment'
+require 'kayako_client/troubleshooter_step'
 require 'kayako_client/user'
 require 'kayako_client/user_group'
 require 'kayako_client/user_organization'

data/lib/kayako_client/base.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 Base
@@ -95,4 +109,13 @@ module KayakoClient
     class Tickets < Base
     end
 
+    class Knowledgebase < Base
+    end
+
+    class News < Base
+    end
+
+    class Troubleshooter < Base
+    end
+
 end

data/lib/kayako_client/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
+#
+#######################################################################
+
 module KayakoClient
 
     class CustomFieldOption < KayakoClient::Base

data/lib/kayako_client/department.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/user_group'
@@ -7,14 +21,15 @@ module KayakoClient
         include KayakoClient::UserVisibilityAPI
 
         DEPARTMENT_TYPES   = [ :public, :private ].freeze
-        DEPARTMENT_MODULES = [ :tickets, :livechat ].freeze
+        DEPARTMENT_APPS = [ :tickets, :livechat ].freeze
 
-        # NOTE: if :parent_department_id is set :module should have the same value
+        # NOTE: if :parent_department_id is set :app should have the corresponding value
 
         property :id,                     :integer, :readonly => true
         property :title,                  :string, :required => [ :put, :post ]
         property :type,                   :symbol, :in => DEPARTMENT_TYPES, :required => :post
-        property :module,                 :symbol, :in => DEPARTMENT_MODULES, :required => :post, :new => true
+        property :module,                 :symbol, :in => DEPARTMENT_APPS, :readonly => true
+        property :app,                    :symbol, :in => DEPARTMENT_APPS, :required => :post, :new => true
         property :display_order,          :integer
         property :parent_department_id,   :integer
         property :user_visibility_custom, :boolean

data/lib/kayako_client/http/http.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 HTTP
 

data/lib/kayako_client/http/http_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
+#
+#######################################################################
+
 require 'uri'
 
 module KayakoClient

data/lib/kayako_client/http/http_client.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 'httpclient'
 
 module KayakoClient

data/lib/kayako_client/http/http_response.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 HTTPResponse

data/lib/kayako_client/http/net_http.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 'net/https'
 
 module KayakoClient

data/lib/kayako_client/knowledgebase_article.rb

@@ -0,0 +1,131 @@
+#######################################################################
+#
+# 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/mixins/creator_api'
+
+require 'kayako_client/knowledgebase_category'
+
+require 'kayako_client/staff'
+require 'kayako_client/user'
+
+module KayakoClient
+
+    class KnowledgebaseAttachment < KayakoClient::Knowledgebase
+    end
+
+    class KnowledgebaseArticle < KayakoClient::Knowledgebase
+        include KayakoClient::ConvertAPI
+        include KayakoClient::CreatorAPI
+        include KayakoClient::ArticleClient
+
+        path '/Knowledgebase/Article'
+
+        CREATOR_USER  = 1
+        CREATOR_STAFF = 2
+
+        STATUS_PUBLISHED       = 1
+        STATUS_DRAFT           = 2
+        STATUS_PENDINGAPPROVAL = 3
+
+        property :kb_article_id,    :integer, :readonly => true
+        property :contents,         :string,  :required => [ :put, :post ]
+        property :contents_text,    :string,  :readonly => true
+        property :category_ids,   [ :integer ], :get => :categories, :set => :categoryid
+        property :creator_type,     :integer, :readonly => true, :get => :creator, :range => 1..2
+        property :creator_id,       :integer, :required => :post
+        property :is_edited,        :boolean, :readonly => true
+        property :subject,          :string,  :required => [ :put, :post ]
+        property :edited_date_line, :date,    :readonly => true
+        property :edited_staff_id,  :integer, :required => :put
+        property :views,            :integer, :readonly => true
+        property :is_featured,      :boolean
+        property :allow_comments,   :boolean
+        property :total_comments,   :integer, :readonly => true
+        property :has_attachments,  :boolean, :readonly => true
+        property :date_line,        :date,    :readonly => true
+        property :article_status,   :integer, :range => 1..3
+        property :article_rating,   :float,   :readonly => true
+        property :rating_hits,      :integer, :readonly => true
+        property :rating_count,     :integer, :readonly => true
+
+        property :attachments,    [ :object ], :class => KnowledgebaseAttachment
+
+        associate :categories,      :category_ids,    KnowledgebaseCategory
+        associate :edited_staff,    :edited_staff_id, Staff
+
+        alias_method :id, :kb_article_id
+
+        def in_root_category?
+            !category_ids.nil? && category_ids.include?(0)
+        end
+
+        def in_category?(category)
+            category.respond_to?(:to_i) && !category_ids.nil? && category_ids.include?(category.to_i)
+        end
+
+        if method_defined?(:categories)
+            remove_method(:categories)
+        end
+
+        def categories
+            if @associated.has_key?(:category_ids)
+                @associated[:category_ids]
+            elsif instance_variable_defined?(:@category_ids)
+                category_ids = instance_variable_get(:@category_ids)
+                if category_ids.is_a?(Array)
+                    @associated[:category_ids] = category_ids.inject([]) do |array, i|
+                        array << KnowledgebaseCategory.get(i.to_i, inherited_options) unless i.to_i == 0
+                        array
+                    end
+                else
+                    @associated[:category_ids] = nil
+                end
+            else
+                @associated[:category_ids] = nil
+            end
+        end
+
+        def self.all(*args)
+            options = args.last.is_a?(Hash) ? args.pop : {}
+            if args.size > 0
+                if args.size == 1
+                    options.merge!(:e => "#{path}/ListAll/#{args.first.to_i}")
+                else
+                    raise ArgumentError, "too many arguments"
+                end
+            end
+            super(options)
+        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
+
+        def assign_value(type, value, options = {})
+            if type == :object && value.is_a?(Hash) && options[:class] == KnowledgebaseAttachment
+                value[:kb_article_id] = kb_article_id unless value.has_key?(:kbarticleid)
+            end
+            super(type, value, options)
+        end
+
+    end
+
+end

data/lib/kayako_client/knowledgebase_attachment.rb

@@ -0,0 +1,59 @@
+#######################################################################
+#
+# 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/knowledgebase_article_api'
+
+require 'kayako_client/knowledgebase_article'
+
+module KayakoClient
+    class KnowledgebaseAttachment < KayakoClient::Knowledgebase
+        include KayakoClient::KnowledgebaseArticleAPI
+        include KayakoClient::Attachment
+
+        path '/Knowledgebase/Attachment'
+
+        supports :all, :get, :post, :delete
+
+        property :id,            :integer, :readonly => true
+        property :kb_article_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 :article,      :kb_article_id, KnowledgebaseArticle
+
+        if method_defined?(:contents)
+            remove_method(:contents)
+        end
+
+        def contents
+            if instance_variable_defined?(:@contents)
+                instance_variable_get(:@contents)
+            elsif !new? && id && kb_article_id && id > 0 && kb_article_id > 0
+                logger.debug "contents are missing - trying to reload" if logger
+                if reload!(:e => "#{self.class.path}/#{kb_article_id.to_i}/#{id.to_i}") && instance_variable_defined?(:@contents)
+                    instance_variable_get(:@contents)
+                else
+                    instance_variable_set(:@contents, nil)
+                end
+            else
+                nil
+            end
+        end
+
+    end
+end

data/lib/kayako_client/knowledgebase_category.rb

@@ -0,0 +1,71 @@
+#######################################################################
+#
+# 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 KnowledgebaseCategory < KayakoClient::Knowledgebase
+        include KayakoClient::ConvertAPI
+        include KayakoClient::UserVisibilityAPI
+        include KayakoClient::StaffVisibilityAPI
+        include KayakoClient::KnowledgebaseCategoryClient
+
+        path '/Knowledgebase/Category'
+
+        TYPE_GLOBAL  = 1
+        TYPE_PUBLIC  = 2
+        TYPE_PRIVATE = 3
+        TYPE_INHERIT = 4
+
+        SORT_INHERIT      = 1
+        SORT_TITLE        = 2
+        SORT_RATING       = 3
+        SORT_CREATIONDATE = 4
+        SORT_DISPLAYORDER = 5
+
+        property :id,                      :integer, :readonly => true
+        property :parent_kb_category_id,   :integer
+        property :staff_id,                :integer, :new => true
+        property :title,                   :string,  :required => [ :put, :post ]
+        property :total_articles,          :integer, :readonly => true
+        property :category_type,           :integer, :required => :post, :range => 1..4
+        property :display_order,           :integer
+        property :allow_comments,          :boolean
+        property :allow_rating,            :boolean
+        property :is_published,            :boolean
+        property :article_sort_order,      :integer, :range => 1..5
+        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 :parent_category,        :parent_kb_category_id, KnowledgebaseCategory
+        associate :staff,                  :staff_id,              Staff
+        associate :user_groups,            :user_group_ids,        UserGroup
+        associate :staff_groups,           :staff_group_ids,       StaffGroup
+
+        def has_parent_category?
+            !parent_kb_category_id.nil? && parent_kb_category_id > 0
+        end
+
+        def parent_is_root?
+            !parent_kb_category_id.nil? && parent_kb_category_id == 0
+        end
+
+    end
+end