KayakoClient 1.0.2 → 1.1.0

data/lib/kayako_client/knowledgebase_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/knowledgebase_article'
+
+module KayakoClient
+    class KnowledgebaseComment < KayakoClient::Knowledgebase
+        include KayakoClient::CreatorAPI
+        include KayakoClient::CommentObject
+
+        path '/Knowledgebase/Comment'
+
+        property :kb_article_id, :integer, :required => :post, :set => :knowledgebasearticleid
+
+        associate :article, :kb_article_id, KnowledgebaseArticle
+
+    end
+end

data/lib/kayako_client/mixins/api.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 API
 

data/lib/kayako_client/mixins/article_client.rb

@@ -0,0 +1,76 @@
+#######################################################################
+#
+# 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 ArticleClient
+
+        def get_attachment(attachment, options = {})
+            KayakoClient::KnowledgebaseAttachment.get(kb_article_id, attachment, options.merge(inherited_options)) if kb_article_id
+        end
+
+        alias_method :find_attachment, :get_attachment
+
+        def post_attachment(options = {})
+            if kb_article_id
+                if logger && options[:kb_article_id] && options[:kb_article_id].to_i != kb_article_id
+                    logger.warn "overwriting :kb_article_id"
+                end
+                options[:kb_article_id] = kb_article_id
+                KayakoClient::KnowledgebaseAttachment.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_attachment, :post_attachment
+
+        def delete_attachment(attachment, options = {})
+            KayakoClient::KnowledgebaseAttachment.delete(kb_article_id, attachment, options.merge(inherited_options)) if kb_article_id
+        end
+
+        alias_method :destroy_attachment, :delete_attachment
+
+
+        def comments(options = {})
+            KayakoClient::KnowledgebaseComment.all(kb_article_id, options.merge(inherited_options)) if kb_article_id
+        end
+
+        def get_comment(comment, options = {})
+            if kb_article_id
+                value = KayakoClient::KnowledgebaseComment.get(comment, options.merge(inherited_options))
+                value && value.kb_article_id == kb_article_id ? value : nil
+            end
+        end
+
+        alias_method :find_comment, :get_comment
+
+        def post_comment(options = {})
+            if kb_article_id
+                if logger && options[:kb_article_id] && options[:kb_article_id].to_i != kb_article_id
+                    logger.warn "overwriting :kb_article_id"
+                end
+                options[:kb_article_id] = kb_article_id
+                KayakoClient::KnowledgebaseComment.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_comment, :post_comment
+
+        def delete_comment(comment, options = {})
+            article_comment = get_comment(comment, options.merge(inherited_options))
+            article_comment.delete if article_comment
+        end
+
+        alias_method :destroy_comment, :delete_comment
+
+    end
+end

data/lib/kayako_client/mixins/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 'tempfile'
 
 module KayakoClient
@@ -32,7 +46,7 @@ module KayakoClient
                     f.read
                 end
             else
-                raise ArgumentError, "invalid argument must be either File or path"
+                raise ArgumentError, "argument must be either File or path"
             end
             changes(:contents)
             if !self.class.options[:file_name] ||
@@ -56,6 +70,7 @@ module KayakoClient
             elsif contents
                 raise RuntimeError, "not a remote file" unless id && !new?
                 @file = Tempfile.new(file_name.split('.').first || 'kayako_attachment')
+                @file.binmode
                 @file.write(contents)
                 @file.flush
                 @file.rewind

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

data/lib/kayako_client/mixins/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
+#
+#######################################################################
+
 module KayakoClient
     module Client
 
@@ -24,6 +38,196 @@ module KayakoClient
         alias_method :destroy_department, :delete_department
 
 
+        def knowledgebase_articles(*args)
+            options = args.last.is_a?(Hash) ? args.pop : {}
+            args << options.merge(inherited_options)
+            KayakoClient::KnowledgebaseArticle.all(*args)
+        end
+
+        def get_knowledgebase_article(id = :all, options = {})
+            KayakoClient::KnowledgebaseArticle.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_knowledgebase_article, :get_knowledgebase_article
+
+        def post_knowledgebase_article(options = {})
+            KayakoClient::KnowledgebaseArticle.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_knowledgebase_article, :post_knowledgebase_article
+
+        def delete_knowledgebase_article(id, options = {})
+            KayakoClient::KnowledgebaseArticle.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_knowledgebase_article, :delete_knowledgebase_article
+
+
+        def knowledgebase_attachments(article, options = {})
+            KayakoClient::KnowledgebaseAttachment.all(article, options.merge(inherited_options))
+        end
+
+        def get_knowledgebase_attachment(article, id, options = {})
+            KayakoClient::KnowledgebaseAttachment.get(article, id, options.merge(inherited_options))
+        end
+
+        alias_method :find_knowledgebase_attachment, :get_knowledgebase_attachment
+
+        def post_knowledgebase_attachment(options = {})
+            KayakoClient::KnowledgebaseAttachment.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_knowledgebase_attachment, :post_knowledgebase_attachment
+
+        def delete_knowledgebase_attachment(article, id, options = {})
+            KayakoClient::KnowledgebaseAttachment.delete(article, id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_knowledgebase_attachment, :delete_knowledgebase_attachment
+
+
+        def knowledgebase_categories(options = {})
+            KayakoClient::KnowledgebaseCategory.all(options.merge(inherited_options))
+        end
+
+        def get_knowledgebase_category(id = :all, options = {})
+            KayakoClient::KnowledgebaseCategory.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_knowledgebase_category, :get_knowledgebase_category
+
+        def post_knowledgebase_category(options = {})
+            KayakoClient::KnowledgebaseCategory.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_knowledgebase_category, :post_knowledgebase_category
+
+        def delete_knowledgebase_category(id, options = {})
+            KayakoClient::KnowledgebaseCategory.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_knowledgebase_category, :delete_knowledgebase_category
+
+
+        def knowledgebase_comments(article, options = {})
+            KayakoClient::KnowledgebaseComment.all(article, options.merge(inherited_options))
+        end
+
+        def get_knowledgebase_comment(id = :all, options = {})
+            KayakoClient::KnowledgebaseComment.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_knowledgebase_comment, :get_knowledgebase_comment
+
+        def post_knowledgebase_comment(options = {})
+            KayakoClient::KnowledgebaseComment.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_knowledgebase_comment, :post_knowledgebase_comment
+
+        def delete_knowledgebase_comment(id, options = {})
+            KayakoClient::KnowledgebaseComment.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_knowledgebase_comment, :delete_knowledgebase_comment
+
+
+        def news_categories(options = {})
+            KayakoClient::NewsCategory.all(options.merge(inherited_options))
+        end
+
+        def get_news_category(id = :all, options = {})
+            KayakoClient::NewsCategory.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_news_category, :get_news_category
+
+        def post_news_category(options = {})
+            KayakoClient::NewsCategory.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_news_category, :post_news_category
+
+        def delete_news_category(id, options = {})
+            KayakoClient::NewsCategory.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_news_category, :delete_news_category
+
+
+        def news_comments(news, options = {})
+            KayakoClient::NewsComment.all(news, options.merge(inherited_options))
+        end
+
+        def get_news_comment(id = :all, options = {})
+            KayakoClient::NewsComment.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_news_comment, :get_news_comment
+
+        def post_news_comment(options = {})
+            KayakoClient::NewsComment.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_news_comment, :post_news_comment
+
+        def delete_news_comment(id, options = {})
+            KayakoClient::NewsComment.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_news_comment, :delete_news_comment
+
+
+        def news_items(*args)
+            options = args.last.is_a?(Hash) ? args.pop : {}
+            args << options.merge(inherited_options)
+            KayakoClient::NewsItem.all(*args)
+        end
+
+        alias_method :news, :news_items
+
+        def get_news_item(id = :all, options = {})
+            KayakoClient::NewsItem.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_news_item, :get_news_item
+
+        def post_news_item(options = {})
+            KayakoClient::NewsItem.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_news_item, :post_news_item
+
+        def delete_news_item(id, options = {})
+            KayakoClient::NewsItem.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_news_item, :delete_news_item
+
+
+        def news_subscribers(options = {})
+            KayakoClient::NewsSubscriber.all(options.merge(inherited_options))
+        end
+
+        def get_news_subscriber(id = :all, options = {})
+            KayakoClient::NewsSubscriber.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_news_subscriber, :get_news_subscriber
+
+        def post_news_subscriber(options = {})
+            KayakoClient::NewsSubscriber.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_news_subscriber, :post_news_subscriber
+
+        def delete_news_subscriber(id, options = {})
+            KayakoClient::NewsSubscriber.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_news_subscriber, :delete_news_subscriber
+
+
         def staff(options = {})
             KayakoClient::Staff.all(options.merge(inherited_options))
         end
@@ -242,6 +446,98 @@ module KayakoClient
         alias_method :find_ticket_type, :get_ticket_type
 
 
+        def troubleshooter_attachments(step, options = {})
+            KayakoClient::TroubleshooterAttachment.all(step, options.merge(inherited_options))
+        end
+
+        def get_troubleshooter_attachment(step, id, options = {})
+            KayakoClient::TroubleshooterAttachment.get(step, id, options.merge(inherited_options))
+        end
+
+        alias_method :find_troubleshooter_attachment, :get_troubleshooter_attachment
+
+        def post_troubleshooter_attachment(options = {})
+            KayakoClient::TroubleshooterAttachment.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_troubleshooter_attachment, :post_troubleshooter_attachment
+
+        def delete_troubleshooter_attachment(step, id, options = {})
+            KayakoClient::TroubleshooterAttachment.delete(step, id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_troubleshooter_attachment, :delete_troubleshooter_attachment
+
+
+        def troubleshooter_categories(options = {})
+            KayakoClient::TroubleshooterCategory.all(options.merge(inherited_options))
+        end
+
+        def get_troubleshooter_category(id = :all, options = {})
+            KayakoClient::TroubleshooterCategory.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_troubleshooter_category, :get_troubleshooter_category
+
+        def post_troubleshooter_category(options = {})
+            KayakoClient::TroubleshooterCategory.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_troubleshooter_category, :post_troubleshooter_category
+
+        def delete_troubleshooter_category(id, options = {})
+            KayakoClient::TroubleshooterCategory.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_troubleshooter_category, :delete_troubleshooter_category
+
+
+        def troubleshooter_comments(step, options = {})
+            KayakoClient::TroubleshooterComment.all(step, options.merge(inherited_options))
+        end
+
+        def get_troubleshooter_comment(id = :all, options = {})
+            KayakoClient::TroubleshooterComment.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_troubleshooter_comment, :get_troubleshooter_comment
+
+        def post_troubleshooter_comment(options = {})
+            KayakoClient::TroubleshooterComment.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_troubleshooter_comment, :post_troubleshooter_comment
+
+        def delete_troubleshooter_comment(id, options = {})
+            KayakoClient::TroubleshooterComment.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_troubleshooter_comment, :delete_troubleshooter_comment
+
+
+        def troubleshooter_steps(options = {})
+            KayakoClient::TroubleshooterStep.all(options.merge(inherited_options))
+        end
+
+        def get_troubleshooter_step(id = :all, options = {})
+            KayakoClient::TroubleshooterStep.get(id, options.merge(inherited_options))
+        end
+
+        alias_method :find_troubleshooter_step, :get_troubleshooter_step
+
+        def post_troubleshooter_step(options = {})
+            KayakoClient::TroubleshooterStep.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_troubleshooter_step, :post_troubleshooter_step
+
+        def delete_troubleshooter_step(id, options = {})
+            KayakoClient::TroubleshooterStep.delete(id, options.merge(inherited_options))
+        end
+
+        alias_method :destroy_troubleshooter_step, :delete_troubleshooter_step
+
+
         def users(marker = nil, limit = nil, options = {})
             KayakoClient::User.all(marker, limit, options.merge(inherited_options))
         end
@@ -252,6 +548,10 @@ module KayakoClient
 
         alias_method :find_user, :get_user
 
+        def user_search(query, options = {})
+            KayakoClient::User.search(query, options.merge(inherited_options))
+        end
+
         def post_user(options = {})
             KayakoClient::User.post(options.merge(inherited_options))
         end