KayakoClient 0.0.1b

data/lib/kayako_client/mixins/post_client.rb

@@ -0,0 +1,42 @@
+module KayakoClient
+    module PostClient
+
+        def attachments(options = {})
+            values = []
+            if ticket_id && id
+                items = KayakoClient::TicketAttachment.all(ticket_id, options.merge(inherited_options))
+                items.each do |item|
+                    values << item if item.ticket_post_id == id
+                end
+            end
+            values
+        end
+
+        def get_attachment(attachment, options = {})
+            KayakoClient::TicketAttachment.get(ticket_id, attachment, options.merge(inherited_options)) if ticket_id
+        end
+
+        alias_method :find_attachment, :get_attachment
+
+        def post_attachment(options = {})
+            if ticket_id && id
+                if logger
+                    logger.warn "overwriting :ticket_id"      if options[:ticket_id] && options[:ticket_id].to_i != ticket_id
+                    logger.warn "overwriting :ticket_post_id" if options[:ticket_post_id] && options[:ticket_post_id].to_i != id
+                end
+                options[:ticket_id] = ticket_id
+                options[:ticket_post_id] = id
+                KayakoClient::TicketAttachment.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_attachment, :post_attachment
+
+        def delete_attachment(attachment, options = {})
+            KayakoClient::TicketAttachment.delete(ticket_id, attachment, options.merge(inherited_options)) if ticket_id
+        end
+
+        alias_method :destroy_attachment, :delete_attachment
+
+    end
+end

data/lib/kayako_client/mixins/staff_visibility_api.rb

@@ -0,0 +1,9 @@
+module KayakoClient
+    module StaffVisibilityAPI
+
+        def visible_to_staff_group?(group)
+            !staff_visibility_custom || (!staff_group_ids.nil? && staff_group_ids.include?(group.to_i))
+        end
+
+    end
+end

data/lib/kayako_client/mixins/ticket_api.rb

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

data/lib/kayako_client/mixins/ticket_client.rb

@@ -0,0 +1,135 @@
+module KayakoClient
+    module TicketClient
+
+        def self.included(base)
+            base.extend(ClassMethods)
+        end
+
+
+        def attachments(options = {})
+            KayakoClient::TicketAttachment.all(id, options.merge(inherited_options)) if id
+        end
+
+        def get_attachment(attachment, options = {})
+            KayakoClient::TicketAttachment.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[:ticket_id] && options[:ticket_id].to_i != id
+                    logger.warn "overwriting :ticket_id"
+                end
+                options[:ticket_id] = id
+                KayakoClient::TicketAttachment.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_attachment, :post_attachment
+
+        def delete_attachment(attachment, options = {})
+            KayakoClient::TicketAttachment.delete(id, attachment, options.merge(inherited_options)) if id
+        end
+
+        alias_method :destroy_attachment, :delete_attachment
+
+
+        def custom_fields(options = {})
+            KayakoClient::TicketCustomField.get(id, options.merge(inherited_options)) if id
+        end
+
+
+        def notes(options = {})
+            KayakoClient::TicketNote.all(id, options.merge(inherited_options)) if id
+        end
+
+        def get_note(note, options = {})
+            KayakoClient::TicketNote.get(id, note, options.merge(inherited_options)) if id
+        end
+
+        alias_method :find_note, :get_note
+
+        def post_note(options = {})
+            if id
+                if logger && options[:ticket_id] && options[:ticket_id].to_i != id
+                    logger.warn "overwriting :ticket_id"
+                end
+                options[:ticket_id] = id
+                KayakoClient::TicketNote.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_note, :post_note
+
+        def delete_note(note, options = {})
+            KayakoClient::TicketNote.delete(id, note, options.merge(inherited_options)) if id
+        end
+
+        alias_method :destroy_note, :delete_note
+
+
+        def get_post(post, options = {})
+            KayakoClient::TicketPost.get(id, post, options.merge(inherited_options)) if id
+        end
+
+        alias_method :find_post, :get_post
+
+        def post_post(options = {})
+            if id
+                if logger && options[:ticket_id] && options[:ticket_id].to_i != id
+                    logger.warn "overwriting :ticket_id"
+                end
+                options[:ticket_id] = id
+                KayakoClient::TicketPost.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_post, :post_post
+
+        def delete_post(post, options = {})
+            KayakoClient::TicketPost.delete(id, post, options.merge(inherited_options)) if id
+        end
+
+        alias_method :destroy_post, :delete_post
+
+
+        def time_tracks(options = {})
+            KayakoClient::TicketTimeTrack.all(id, options.merge(inherited_options)) if id
+        end
+
+        def get_time_track(track, options = {})
+            KayakoClient::TicketTimeTrack.get(id, track, options.merge(inherited_options)) if id
+        end
+
+        alias_method :find_time_track, :get_time_track
+
+        def post_time_track(options = {})
+            if id
+                if logger && options[:ticket_id] && options[:ticket_id].to_i != id
+                    logger.warn "overwriting :ticket_id"
+                end
+                options[:ticket_id] = id
+                KayakoClient::TicketTimeTrack.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_time_track, :post_time_track
+
+        def delete_time_track(track, options = {})
+            KayakoClient::TicketTimeTrack.delete(id, track, options.merge(inherited_options)) if id
+        end
+
+        alias_method :destroy_time_track, :delete_time_track
+
+
+        module ClassMethods
+
+            def count(options = {})
+                KayakoClient::TicketCount.get(options.merge(inherited_options(options)))
+            end
+
+        end
+
+    end
+end

data/lib/kayako_client/mixins/user_visibility_api.rb

@@ -0,0 +1,9 @@
+module KayakoClient
+    module UserVisibilityAPI
+
+        def visible_to_user_group?(group)
+            !user_visibility_custom || (!user_group_ids.nil? && user_group_ids.include?(group.to_i))
+        end
+
+    end
+end

data/lib/kayako_client/staff.rb

@@ -0,0 +1,25 @@
+require 'kayako_client/staff_group'
+
+module KayakoClient
+    class Staff < KayakoClient::Base
+
+        property :id,             :integer, :readonly => true
+        property :staff_group_id, :integer, :required => [ :put, :post ]
+        property :user_name,      :string, :required => [ :put, :post ]
+        property :password,       :string, :required => :post
+        property :first_name,     :string, :required => [ :put, :post ]
+        property :last_name,      :string, :required => [ :put, :post ]
+        property :full_name,      :string, :readonly => true
+        property :email,          :string, :required => [ :put, :post ]
+        property :designation,    :string
+        property :signature,      :string
+        property :greeting,       :string
+        property :mobile_number,  :string
+        property :is_enabled,     :boolean
+        property :time_zone,      :string
+        property :enable_dst,     :boolean
+
+        associate :staff_group,   :staff_group_id, StaffGroup
+
+    end
+end

data/lib/kayako_client/staff_group.rb

@@ -0,0 +1,9 @@
+module KayakoClient
+    class StaffGroup < KayakoClient::Base
+
+        property :id,       :integer, :readonly => true
+        property :title,    :string, :required => [ :put, :post ]
+        property :is_admin, :boolean, :required => :post
+
+    end
+end

data/lib/kayako_client/ticket.rb

@@ -0,0 +1,241 @@
+require 'kayako_client/department'
+
+require 'kayako_client/staff'
+
+require 'kayako_client/ticket_note'
+require 'kayako_client/ticket_post'
+require 'kayako_client/ticket_status'
+require 'kayako_client/ticket_priority'
+require 'kayako_client/ticket_type'
+
+require 'kayako_client/user'
+require 'kayako_client/user_organization'
+
+module KayakoClient
+
+    class TicketWorkflow < KayakoClient::Tickets
+        embedded
+
+        property :id,    :integer
+        property :title, :string
+
+    end
+
+    class TicketWatcher < KayakoClient::Tickets
+        embedded
+
+        property :staff_id, :integer
+        property :name,     :string
+
+        associate :staff,   :staff_id, Staff
+    end
+
+    class Ticket < KayakoClient::Tickets
+        include KayakoClient::TicketClient
+
+        # NOTE: department is required to be of :tickets type
+
+        FLAG_NONE   = 0
+        FLAG_PURPLE = 1
+        FLAG_ORANGE = 2
+        FLAG_GREEN  = 3
+        FLAG_YELLOW = 4
+        FLAG_RED    = 5
+        FLAG_BLUE   = 6
+
+        SEARCH_TICKET_ID         = 0x0001
+        SEARCH_CONTENTS          = 0x0002
+        SEARCH_AUTHOR            = 0x0004
+        SEARCH_EMAIL             = 0x0008
+        SEARCH_CREATOR_EMAIL     = 0x0010
+        SEARCH_FULL_NAME         = 0x0020
+        SEARCH_NOTES             = 0x0040
+        SEARCH_USER_GROUP        = 0x0080
+        SEARCH_USER_ORGANIZATION = 0x0100
+        SEARCH_USER              = 0x0200
+        SEARCH_TAGS              = 0x0400
+
+        TICKET_TYPES = [ :default, :phone ].freeze
+
+        property :id,                   :integer, :readonly => true
+        property :flag_type,            :integer, :readonly => true, :range => 0..6
+        property :display_id,           :string, :readonly => true
+        property :department_id,        :integer, :required => :post
+        property :status_id,            :integer, :required => :post, :set => :ticketstatusid
+        property :priority_id,          :integer, :required => :post, :set => :ticketpriorityid
+        property :type_id,              :integer, :required => :post, :set => :tickettypeid
+        property :user_id,              :integer
+        property :user_organization,    :string, :readonly => true
+        property :user_organization_id, :integer, :readonly => true
+        property :owner_staff_id,       :integer
+        property :owner_staff_name,     :string, :readonly => true
+        property :full_name,            :string, :required => :post
+        property :email,                :string, :required => :post
+        property :last_replier,         :string, :readonly => true
+        property :subject,              :string, :required => :post
+        property :creation_time,        :date, :readonly => true
+        property :last_activity,        :date, :readonly => true
+        property :last_staff_reply,     :date, :readonly => true
+        property :last_user_reply,      :date, :readonly => true
+        property :sla_plan_id,          :integer, :readonly => true
+        property :next_reply_due,       :date, :readonly => true
+        property :resolution_due,       :date, :readonly => true
+        property :replies,              :integer, :readonly => true
+        property :ip_address,           :string, :readonly => true
+        property :creator,              :integer, :readonly => true
+        property :creation_mode,        :integer, :readonly => true
+        property :creation_type,        :integer, :readonly => true
+        property :is_escalated,         :boolean, :readonly => true
+        property :escalation_rule_id,   :integer, :readonly => true
+        property :tags,                 :string, :readonly => true
+        property :contents,             :string, :new => true, :required => :post
+        property :auto_user_id,         :boolean, :new => true
+        property :staff_id,             :integer, :new => true
+        property :type,                 :symbol, :new => true, :in => TICKET_TYPES
+
+        property :work_flow,            :object,   :class => TicketWorkflow
+        property :watcher,            [ :object ], :class => TicketWatcher
+        property :note,               [ :object ], :class => TicketNote
+        property :posts,              [ :object ], :class => TicketPost
+
+        associate :department,          :department_id,        Department
+        associate :ticket_status,       :status_id,            TicketStatus
+        associate :ticket_priority,     :priority_id,          TicketPriority
+        associate :ticket_type,         :type_id,              TicketType
+        associate :user,                :user_id,              User
+        associate :organization,        :user_organization_id, UserOrganization
+        associate :owner_staff,         :owner_staff_id,       Staff
+
+        def posts
+            if instance_variable_defined?(:@posts)
+                instance_variable_get(:@posts)
+            elsif !new? && id && id > 0
+                logger.debug "posts are missing - trying to load" if logger
+                post = KayakoClient::TicketPost.all(id, inherited_options)
+                if post && !post.empty?
+                    instance_variable_set(:@posts, post)
+                else
+                    instance_variable_set(:@posts, nil)
+                end
+            else
+                nil
+            end
+        end
+
+        def created_by_user?
+            !user_id.nil? && user_id > 0
+        end
+
+        alias_method :has_user?, :created_by_user?
+
+        def has_user_organization?
+            !user_organization_id.nil? && user_organization_id > 0
+        end
+
+        def has_owner_staff?
+            !owner_staff_id.nil? && owner_staff_id > 0
+        end
+
+        def self.all(*args)
+            options = args.last.is_a?(Hash) ? args.pop : {}
+
+            components = []
+            args.each_index do |index|
+                break if index > 3
+                if args[index]
+                    components[index] ||= []
+                    components[index] << args[index]
+                end
+            end
+
+            options.keys.each do |option|
+                case option.to_s.gsub(%r{_}, '')
+                when 'departmentid', 'department'
+                    index = 0
+                when 'ticketstatusid', 'ticketstatus'
+                    index = 1
+                when 'ownerstaffid', 'ownerstaff'
+                    index = 2
+                when 'userid', 'user'
+                    index = 3
+                else
+                    next
+                end
+                components[index] ||= []
+                components[index] << options.delete(option)
+            end
+
+            raise ArgumentError, "missing :department_id" unless components[0]
+
+            e = path + '/ListAll' + components.inject('') do |uri, item|
+                uri << '/' + (item.nil? ? '-1' : item.flatten.uniq.join(','))
+            end
+
+            super(options.merge(:e => e))
+        end
+
+        def self.get(id = :all, options = {})
+            if id == :all
+                all(options.delete(:id), options)
+            else
+                super(options.merge(:id => id))
+            end
+        end
+
+        def self.search(query, flags = SEARCH_CONTENTS, options = {})
+            unless configured? || (options[:api_url] && options[:api_key] && options[:secret_key])
+                raise RuntimeError, "client not configured"
+            end
+
+            params = {
+                :e     => '/Tickets/TicketSearch',
+                :query => query
+            }
+
+            params[:ticketid]         = 1 unless flags & SEARCH_TICKET_ID         == 0x0000
+            params[:contents]         = 1 unless flags & SEARCH_CONTENTS          == 0x0000
+            params[:author]           = 1 unless flags & SEARCH_AUTHOR            == 0x0000
+            params[:email]            = 1 unless flags & SEARCH_EMAIL             == 0x0000
+            params[:creatoremail]     = 1 unless flags & SEARCH_CREATOR_EMAIL     == 0x0000
+            params[:fullname]         = 1 unless flags & SEARCH_FULL_NAME         == 0x0000
+            params[:notes]            = 1 unless flags & SEARCH_NOTES             == 0x0000
+            params[:usergroup]        = 1 unless flags & SEARCH_USER_GROUP        == 0x0000
+            params[:userorganization] = 1 unless flags & SEARCH_USER_ORGANIZATION == 0x0000
+            params[:user]             = 1 unless flags & SEARCH_USER              == 0x0000
+            params[:tags]             = 1 unless flags & SEARCH_TAGS              == 0x0000
+
+            response = post_request(options.merge(params))
+            log = options[:logger] || logger
+            if response.is_a?(KayakoClient::HTTPOK)
+                objects = []
+                if log
+                    log.debug "Response:"
+                    log.debug response.body
+                end
+                payload = xml_backend.new(response.body, { :logger => log })
+                payload.each do |element|
+                    object = new(payload.to_hash(element).merge(inherited_options(options)))
+                    object.loaded!
+                    objects << object
+                end
+                log.info ":post(:search, '#{params[:query]}', #{sprintf("0x%04X", flags)}) successful (#{objects.size} objects)" if log
+                objects
+            else
+                log.error "Response: #{response.status} #{response.body}" if log
+                raise StandardError, "server returned #{response.status}: #{response.body}"
+            end
+        end
+
+    private
+
+        def validate(method, params)
+            if method == :post
+                unless params[:auto_user_id] || params[:user_id] || params[:staff_id]
+                    raise ArgumentError, ":auto_user_id, :user_id or :staff_id is required"
+                end
+            end
+        end
+
+    end
+
+end