KayakoClient 1.0.2 → 1.1.0

data/lib/kayako_client/mixins/comment_object.rb

@@ -0,0 +1,102 @@
+#######################################################################
+#
+# 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/staff'
+require 'kayako_client/user'
+
+module KayakoClient
+    module CommentObject
+
+        CREATOR_STAFF = 1
+        CREATOR_USER  = 2
+
+        STATUS_PENDING  = 1
+        STATUS_APPROVED = 2
+        STATUS_SPAM     = 3
+
+        def self.included(base)
+            base.extend(ClassMethods)
+            base.class_eval do
+
+                supports :all, :get, :post, :delete
+
+                property :id,                :integer, :readonly => true
+                property :creator_type,      :integer, :required => :post, :range => 1..2
+                property :creator_id,        :integer
+                property :full_name,         :string
+                property :email,             :string
+                property :ip_address,        :string,  :readonly => true
+                property :date_line,         :date,    :readonly => true
+                property :parent_comment_id, :integer
+                property :comment_status,    :integer, :range => 1..3
+                property :user_agent,        :string,  :readonly => true
+                property :referrer,          :string,  :readonly => true
+                property :parent_url,        :string,  :readonly => true
+                property :contents,          :string,  :required => :post
+
+                associate :parent_comment,   :parent_comment_id, base
+
+            end
+        end
+
+        def creator=(creator)
+            if creator.is_a?(Staff)
+                self.creator_type = self.class::CREATOR_STAFF
+                self.creator_id = creator.id
+                self.full_name = creator.full_name
+                self.email = creator.email
+            elsif creator.is_a?(User)
+                self.creator_type = self.class::CREATOR_USER
+                self.creator_id = creator.id
+                self.full_name = creator.full_name
+                self.email = creator.emails.first
+            else
+                raise ArgumentError, "creator must be a User or Staff"
+            end
+        end
+
+        def has_parent_comment?
+            !parent_comment_id.nil? && parent_comment_id > 0
+        end
+
+        alias_method :is_reply?, :has_parent_comment?
+
+        module ClassMethods
+
+            def all(object, options = {})
+                unless object.to_i > 0
+                    logger.error "invalid commented object :id - #{object}" if logger
+                    raise ArgumentError, "invalid commented object ID"
+                end
+                super(options.merge(:e => "#{path}/ListAll/#{object.to_i}"))
+            end
+
+        end
+
+    private
+
+        def validate(method, params)
+            if method == :post
+                if params[:creator_type] == self.class::CREATOR_STAFF
+                    raise ArgumentError, ":creator_id is required for staff" unless params[:creator_id]
+                elsif params[:creator_type] == self.class::CREATOR_USER
+                    raise ArgumentError, ":full_name is required for user" unless params[:full_name]
+                end
+            end
+        end
+
+    end
+end

data/lib/kayako_client/mixins/convert_api.rb

@@ -0,0 +1,39 @@
+#######################################################################
+#
+# 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 ConvertAPI
+
+        def self.included(base)
+            base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+
+            def convert(type, value, options = {})
+                value = super(type, value, options)
+                value = value.join(',') if type.is_a?(Array)
+                value
+            end
+
+            def convert_value(type, value, options = {})
+                result = super(type, value, options = {})
+                result = Time.at(value).strftime('%m/%d/%Y') if type == :date
+                result
+            end
+
+        end
+
+    end
+end

data/lib/kayako_client/mixins/creator_api.rb

@@ -0,0 +1,44 @@
+#######################################################################
+#
+# 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 CreatorAPI
+
+        def created_by_staff?
+            !creator_type.nil? && creator_type == self.class::CREATOR_STAFF
+        end
+
+        def created_by_user?
+            !creator_type.nil? && creator_type == self.class::CREATOR_USER
+        end
+
+        def creator
+            if @associated.has_key?(:creator)
+                @associated[:creator]
+            elsif instance_variable_defined?(:@creator_id)
+                creator_id = instance_variable_get(:@creator_id)
+                if created_by_staff?
+                    @associated[:creator] = Staff.get(creator_id.to_i, inherited_options)
+                elsif created_by_user?
+                    @associated[:creator] = User.get(creator_id.to_i, inherited_options)
+                else
+                    @associated[:creator] = nil
+                end
+            else
+                @associated[:creator] = nil
+            end
+        end
+
+    end
+end

data/lib/kayako_client/mixins/knowledgebase_article_api.rb

@@ -0,0 +1,69 @@
+#######################################################################
+#
+# 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 KnowledgebaseArticleAPI
+
+        def self.included(base)
+            base.extend(ClassMethods)
+        end
+
+        def delete_request(options = {})
+            raise RuntimeError, "undefined article ID" unless kb_article_id
+            raise RuntimeError, "undefined ID" unless id
+            super(options.merge(:e => "#{self.class.path}/#{kb_article_id}/#{id}"))
+        end
+
+        module ClassMethods
+
+            def all(article, options = {})
+                unless article.to_i > 0
+                    logger.error "invalid :kb_article_id - #{article}" if logger
+                    raise ArgumentError, "invalid article ID"
+                end
+                super(options.merge(:e => "#{path}/ListAll/#{article.to_i}"))
+            end
+
+            def get(article, id, options = {})
+                unless article.to_i > 0
+                    logger.error "invalid :kb_article_id - #{article}" if logger
+                    raise ArgumentError, "invalid article ID"
+                end
+                if id == :all
+                    all(article, options)
+                else
+                    unless id.to_i > 0
+                        logger.error "invalid :id - #{id}" if logger
+                        raise ArgumentError, "invalid ID"
+                    end
+                    super(id, options.merge(:e => "#{path}/#{article.to_i}/#{id.to_i}"))
+                end
+            end
+
+            def delete(article, id, options = {})
+                unless article.to_i > 0
+                    logger.error "invalid :kb_article_id - #{article}" if logger
+                    raise ArgumentError, "invalid article ID"
+                end
+                unless id.to_i > 0
+                    logger.error "invalid :id - #{id}" if logger
+                    raise ArgumentError, "invalid ID"
+                end
+                super(id, options.merge(:e => "#{path}/#{article.to_i}/#{id.to_i}"))
+            end
+
+        end
+
+    end
+end

data/lib/kayako_client/mixins/knowledgebase_category_client.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
+#
+#######################################################################
+
+module KayakoClient
+    module KnowledgebaseCategoryClient
+
+        def articles(options = {})
+            KayakoClient::KnowledgebaseArticle.all(id, options.merge(inherited_options)) if id
+        end
+
+        def get_article(article, options = {})
+            if id
+                value = KayakoClient::KnowledgebaseArticle.get(article, options.merge(inherited_options))
+                value && value.in_category?(id) ? value : nil
+            end
+        end
+
+        alias_method :find_article, :get_article
+
+        def post_article(options = {})
+            if id
+                if logger && options[:id] && options[:id].to_i != id
+                    logger.warn "overwriting :id"
+                end
+                options[:id] = id
+                KayakoClient::KnowledgebaseArticle.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_article, :post_article
+
+        def delete_article(article, options = {})
+            category_article = get_article(article, options.merge(inherited_options))
+            category_article.delete if category_article
+        end
+
+        alias_method :destroy_article, :delete_article
+
+    end
+end

data/lib/kayako_client/mixins/logger.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 Logger
 

data/lib/kayako_client/mixins/news_category_client.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
+#
+#######################################################################
+
+module KayakoClient
+    module NewsCategoryClient
+
+        def news(options = {})
+            KayakoClient::NewsItem.all(id, options.merge(inherited_options)) if id
+        end
+
+        def get_news(news, options = {})
+            if id
+                value = KayakoClient::NewsItem.get(news, options.merge(inherited_options))
+                value && value.in_category?(id) ? value : nil
+            end
+        end
+
+        alias_method :find_news, :get_news
+
+        def post_news(options = {})
+            if id
+                if logger && options[:id] && options[:id].to_i != id
+                    logger.warn "overwriting :id"
+                end
+                options[:id] = id
+                KayakoClient::NewsItem.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_news, :post_news
+
+        def delete_news(news, options = {})
+            category_news = get_news(news, options.merge(inherited_options))
+            category_news.delete if category_news
+        end
+
+        alias_method :destroy_news, :delete_news
+
+    end
+end

data/lib/kayako_client/mixins/news_client.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
+#
+#######################################################################
+
+module KayakoClient
+    module NewsClient
+
+        def comments(options = {})
+            KayakoClient::NewsComment.all(id, options.merge(inherited_options)) if id
+        end
+
+        def get_comment(comment, options = {})
+            if id
+                value = KayakoClient::NewsComment.get(comment, options.merge(inherited_options))
+                value && value.news_item_id == id ? value : nil
+            end
+        end
+
+        alias_method :find_comment, :get_comment
+
+        def post_comment(options = {})
+            if id
+                if logger && options[:news_item_id] && options[:news_item_id].to_i != id
+                    logger.warn "overwriting :news_item_id"
+                end
+                options[:news_item_id] = id
+                KayakoClient::NewsComment.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_comment, :post_comment
+
+        def delete_comment(comment, options = {})
+            news_comment = get_comment(comment, options.merge(inherited_options))
+            news_comment.delete if news_comment
+        end
+
+        alias_method :destroy_comment, :delete_comment
+
+    end
+end

data/lib/kayako_client/mixins/object.rb

@@ -1,9 +1,24 @@
+#######################################################################
+#
+# 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
     module Object
 
         PROPERTY_TYPES = [ :integer,
+                           :float,
                            :string,
                            :symbol,
                            :boolean,
@@ -52,7 +67,7 @@ module KayakoClient
         end
 
         def [](name)
-            if self.class.properties.include?(name.to_sym)
+            if name.respond_to?(:to_sym) && self.class.properties.include?(name.to_sym)
                 send("#{name}")
             else
                 nil
@@ -197,7 +212,7 @@ module KayakoClient
                                 array << klass.get(i.to_i, inherited_options)
                                 array
                             end
-                        elsif id.respond_to?('to_i') && id.to_i > 0
+                        elsif id.respond_to?(:to_i) && id.to_i > 0
                             @associated[property] = klass.get(id.to_i, inherited_options)
                         else
                             @associated[property] = nil
@@ -295,19 +310,19 @@ module KayakoClient
             end
 
             def properties
-                @properties
+                @properties ||= {}
             end
 
             def aliases
-                @aliases
+                @aliases ||= {}
             end
 
             def options
-                @options
+                @options ||= {}
             end
 
             def map
-                @map
+                @map ||= {}
             end
 
         private
@@ -416,12 +431,14 @@ module KayakoClient
             case type
             when :integer
                 value.to_i
+            when :float
+                value.to_f
             when :string
                 value.to_s
             when :symbol
                 value.to_sym
             when :boolean
-                if value.respond_to?('to_i')
+                if value.respond_to?(:to_i)
                     value.to_i == 0 ? false : true
                 else
                     case value