KayakoClient 1.0.2 → 1.1.0

data/lib/kayako_client/mixins/post_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 PostClient
 

data/lib/kayako_client/mixins/staff_visibility_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 StaffVisibilityAPI
 

data/lib/kayako_client/mixins/ticket_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 TicketAPI
 

data/lib/kayako_client/mixins/ticket_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 TicketClient
 

data/lib/kayako_client/mixins/troubleshooter_step_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 TroubleshooterStepAPI
+
+        def self.included(base)
+            base.extend(ClassMethods)
+        end
+
+        def delete_request(options = {})
+            raise RuntimeError, "undefined troubleshooter step ID" unless troubleshooter_step_id
+            raise RuntimeError, "undefined ID" unless id
+            super(options.merge(:e => "#{self.class.path}/#{troubleshooter_step_id}/#{id}"))
+        end
+
+        module ClassMethods
+
+            def all(step, options = {})
+                unless step.to_i > 0
+                    logger.error "invalid :troubleshooter_step_id - #{step}" if logger
+                    raise ArgumentError, "invalid troubleshooter step ID"
+                end
+                super(options.merge(:e => "#{path}/ListAll/#{step.to_i}"))
+            end
+
+            def get(step, id, options = {})
+                unless step.to_i > 0
+                    logger.error "invalid :troubleshooter_step_id - #{step}" if logger
+                    raise ArgumentError, "invalid troubleshooter step ID"
+                end
+                if id == :all
+                    all(step, 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}/#{step.to_i}/#{id.to_i}"))
+                end
+            end
+
+            def delete(step, id, options = {})
+                unless step.to_i > 0
+                    logger.error "invalid :troubleshooter_step_id - #{step}" if logger
+                    raise ArgumentError, "invalid troubleshooter step 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}/#{step.to_i}/#{id.to_i}"))
+            end
+
+        end
+
+    end
+end

data/lib/kayako_client/mixins/troubleshooter_step_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 TroubleshooterStepClient
+
+        def get_attachment(attachment, options = {})
+            KayakoClient::TroubleshooterAttachment.get(id, attachment, options.merge(inherited_options)) if id
+        end
+
+        alias_method :find_attachment, :get_attachment
+
+        def post_attachment(options = {})
+            if id
+                if logger && options[:troubleshooter_step_id] && options[:troubleshooter_step_id].to_i != id
+                    logger.warn "overwriting :troubleshooter_step_id"
+                end
+                options[:troubleshooter_step_id] = id
+                KayakoClient::TroubleshooterAttachment.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_attachment, :post_attachment
+
+        def delete_attachment(attachment, options = {})
+            KayakoClient::TroubleshooterAttachment.delete(id, attachment, options.merge(inherited_options)) if id
+        end
+
+        alias_method :destroy_attachment, :delete_attachment
+
+
+        def comments(options = {})
+            KayakoClient::TroubleshooterComment.all(id, options.merge(inherited_options)) if id
+        end
+
+        def get_comment(comment, options = {})
+            if id
+                value = KayakoClient::TroubleshooterComment.get(comment, options.merge(inherited_options))
+                value && value.troubleshooter_step_id == id ? value : nil
+            end
+        end
+
+        alias_method :find_comment, :get_comment
+
+        def post_comment(options = {})
+            if id
+                if logger && options[:troubleshooter_step_id] && options[:troubleshooter_step_id].to_i != id
+                    logger.warn "overwriting :troubleshooter_step_id"
+                end
+                options[:troubleshooter_step_id] = id
+                KayakoClient::TroubleshooterComment.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_comment, :post_comment
+
+        def delete_comment(comment, options = {})
+            step_comment = get_comment(comment, options.merge(inherited_options))
+            step_comment.delete if step_comment
+        end
+
+        alias_method :destroy_comment, :delete_comment
+
+    end
+end

data/lib/kayako_client/mixins/user_visibility_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 UserVisibilityAPI
 

data/lib/kayako_client/news_category.rb

@@ -0,0 +1,29 @@
+#######################################################################
+#
+# 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 NewsCategory < KayakoClient::News
+        include KayakoClient::NewsCategoryClient
+
+        path '/News/Category'
+
+        VISIBILITY_TYPES = [ :public, :private ].freeze
+
+        property :id,              :integer, :readonly => true
+        property :title,           :string,  :required => [ :put, :post ]
+        property :news_item_count, :integer, :readonly => true
+        property :visibility_type, :symbol,  :required => [ :put, :post ], :in => VISIBILITY_TYPES
+
+    end
+end

data/lib/kayako_client/news_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/news_item'
+
+module KayakoClient
+    class NewsComment < KayakoClient::News
+        include KayakoClient::CreatorAPI
+        include KayakoClient::CommentObject
+
+        path '/News/Comment'
+
+        property :news_item_id, :integer, :required => :post
+
+        associate :news_item, :news_item_id, NewsItem
+
+    end
+end

data/lib/kayako_client/news_item.rb

@@ -0,0 +1,81 @@
+#######################################################################
+#
+# 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/news_category'
+
+require 'kayako_client/staff'
+
+module KayakoClient
+    class NewsItem < KayakoClient::News
+        include KayakoClient::ConvertAPI
+        include KayakoClient::NewsClient
+        include KayakoClient::UserVisibilityAPI
+        include KayakoClient::StaffVisibilityAPI
+
+        TYPE_GLOBAL  = 1
+        TYPE_PUBLIC  = 2
+        TYPE_PRIVATE = 3
+
+        STATUS_DRAFT     = 1
+        STATUS_PUBLISHED = 2
+
+        property :id,                      :integer, :readonly => true
+        property :staff_id,                :integer, :required => :post
+        property :news_type,               :integer, :range => 1..3, :new => true
+        property :news_status,             :integer, :range => 1..2
+        property :author,                  :string,  :readonly => true
+        property :email,                   :string
+        property :subject,                 :string, :required => [ :put, :post ]
+        property :date_line,               :date,   :readonly => true
+        property :expiry,                  :date
+        property :is_synced,               :boolean, :readonly => true
+        property :total_comments,          :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 }
+        property :allow_comments,          :boolean
+        property :contents,                :string, :required => [ :put, :post ]
+        property :category_ids,          [ :integer ], :get => :categories, :set => :newscategoryidlist
+        property :from_name,               :string
+        property :custom_email_subject,    :string
+        property :send_email,              :boolean
+        property :edited_staff_id,         :integer, :required => :put
+
+        associate :staff,                  :staff_id,        Staff
+        associate :user_groups,            :user_group_ids,  UserGroup
+        associate :staff_groups,           :staff_group_ids, StaffGroup
+        associate :categories,             :category_ids,    NewsCategory
+        associate :edited_staff,           :edited_staff_id, Staff
+
+        def in_category?(category)
+            category.respond_to?(:to_i) && !category_ids.nil? && category_ids.include?(category.to_i)
+        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
+
+    end
+end

data/lib/kayako_client/news_subscriber.rb

@@ -0,0 +1,33 @@
+#######################################################################
+#
+# 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'
+require 'kayako_client/user_group'
+
+module KayakoClient
+    class NewsSubscriber < KayakoClient::News
+        path '/News/Subscriber'
+
+        property :id,                :integer, :readonly => true
+        property :template_group_id, :integer, :readonly => true, :get => :tgroupid
+        property :user_id,           :integer, :readonly => true
+        property :email,             :string,  :required => [ :put, :post ]
+        property :is_validated,      :boolean, :new => true
+        property :user_group_id,     :integer, :readonly => true
+
+        associate :user,             :user_id,       User
+        associate :user_group,       :user_group_id, UserGroup
+
+    end
+end

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

data/lib/kayako_client/staff_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 StaffGroup < KayakoClient::Base