KayakoClient 0.0.1b

data/lib/kayako_client/ticket_attachment.rb

@@ -0,0 +1,42 @@
+require 'kayako_client/mixins/ticket_api'
+require 'kayako_client/mixins/attachment'
+
+require 'kayako_client/ticket'
+require 'kayako_client/ticket_post'
+
+module KayakoClient
+    class TicketAttachment < KayakoClient::Tickets
+        include KayakoClient::TicketAPI
+        include KayakoClient::Attachment
+
+        supports :all, :get, :post, :delete
+
+        property :id,             :integer, :readonly => true
+        property :ticket_id,      :integer, :required => :post
+        property :ticket_post_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
+
+        associate :ticket,        :ticket_id,      Ticket
+        associate :ticket_post,   :ticket_post_id, TicketPost
+
+        def contents
+            if instance_variable_defined?(:@contents)
+                instance_variable_get(:@contents)
+            elsif !new? && id && ticket_id && id > 0 && ticket_id > 0
+                logger.debug "contents are missing - trying to reload" if logger
+                if reload!(:e => "#{self.class.path}/#{ticket_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/ticket_count.rb

@@ -0,0 +1,135 @@
+require 'kayako_client/ticket_status'
+require 'kayako_client/ticket_type'
+require 'kayako_client/staff'
+require 'kayako_client/department'
+
+module KayakoClient
+
+    class TicketCountStatus < KayakoClient::Tickets
+        embedded
+
+        property :id,             :integer
+        property :last_activity,  :date
+        property :total_items,    :integer
+
+        associate :ticket_status, :id, TicketStatus
+
+    end
+
+    class TicketCountType < KayakoClient::Tickets
+        embedded
+
+        property :id,                     :integer
+        property :last_activity,          :date
+        property :total_items,            :integer
+        property :total_unresolved_items, :integer
+
+        associate :ticket_type,           :id, TicketType
+
+        def has_ticket_type?
+            !id.nil? && id > 0
+        end
+
+    end
+
+    class TicketCountOwner < KayakoClient::Tickets
+        embedded
+
+        property :id,                     :integer
+        property :last_activity,          :date
+        property :total_items,            :integer
+        property :total_unresolved_items, :integer
+
+        associate :owner_staff,           :id, Staff
+
+        def has_owner_staff?
+            !id.nil? && id > 0
+        end
+
+    end
+
+    class TicketCountDepartment < KayakoClient::Tickets
+        embedded
+
+        property :id,                     :integer
+        property :total_items,            :integer
+        property :last_activity,          :date
+        property :total_unresolved_items, :integer
+        property :statuses,             [ :object ], :class => TicketCountStatus, :get => :ticketstatus
+        property :types,                [ :object ], :class => TicketCountType, :get => :tickettype
+        property :owners,               [ :object ], :class => TicketCountOwner, :get => :ownerstaff
+
+        associate :department,            :id, Department
+
+    end
+
+    class TicketCountUnassigned < KayakoClient::Tickets
+        embedded
+
+        property :id,                     :integer
+        property :last_activity,          :date
+        property :total_items,            :integer
+        property :total_unresolved_items, :integer
+
+        # NOTE: :id is not a department id
+        #associate :department, :id, Department
+
+    end
+
+    class TicketCount < KayakoClient::Tickets
+        supports :get
+
+        property :departments, [ :object ], :class => TicketCountDepartment
+        property :statuses,    [ :object ], :class => TicketCountStatus
+        property :owners,      [ :object ], :class => TicketCountOwner
+        property :unassigned,  [ :object ], :class => TicketCountUnassigned
+
+        def initialize(*args)
+            options = args.last.is_a?(Hash) ? args.last : {}
+            super(*args)
+            if !caller[1].match(%r{/ticket_count\.rb:[0-9]+:in `[^']+'}) &&
+                !options[:departments] && !options[:statuses] && !options[:owners] && !options[:unassigned]
+                raise RuntimeError, "client not configured" unless configured?
+                response = self.class.get_request(options.merge(inherited_options))
+                if response.is_a?(KayakoClient::HTTPOK)
+                    if logger
+                        logger.debug "Response:"
+                        logger.debug response.body
+                    end
+                    payload = xml_backend.new(response.body, { :logger => logger })
+                    clean
+                    import(payload.to_hash)
+                    loaded!
+                    logger.info ":get) successful" if logger
+                else
+                    logger.error "Response: #{response.status} #{response.body}" if logger
+                    raise StandardError, "server returned #{response.status}: #{response.body}"
+                end
+            end
+        end
+
+        def self.get(options = {})
+            unless configured? || (options[:api_url] && options[:api_key] && options[:secret_key])
+                raise RuntimeError, "client not configured"
+            end
+            log = options[:logger] || logger
+            response = get_request(options)
+            if response.is_a?(KayakoClient::HTTPOK)
+                if log
+                    log.debug "Response:"
+                    log.debug response.body
+                end
+                payload = xml_backend.new(response.body, { :logger => log })
+                object = new(payload.to_hash.merge(inherited_options(options)))
+                object.loaded!
+                log.info ":get successful" if log
+                object
+            else
+                log.error "Response: #{response.status} #{response.body}" if log
+                raise StandardError, "server returned #{response.status}: #{response.body}"
+            end
+        end
+
+    end
+
+end

data/lib/kayako_client/ticket_custom_field.rb

@@ -0,0 +1,110 @@
+require 'base64'
+require 'time'
+
+module KayakoClient
+
+    class TicketCustomFieldValue < KayakoClient::Tickets
+        embedded
+
+        property :id,        :integer
+        property :type,      :integer, :range => 1..11
+        property :title,     :string
+        property :file_name, :string
+        property :contents,  :string
+
+        def initialize(*args)
+            super(*args)
+            if defined?(@type)
+                if @type == KayakoClient::TicketCustomField::TYPE_FILE
+                    self.class.send(:include, KayakoClient::Attachment)
+                    if defined?(@contents)
+                        logger.debug "decoding base64 :contents" if logger
+                        @contents = Base64.decode64(@contents)
+                        @contents = Base64.decode64(@contents)
+                    end
+                elsif @type == KayakoClient::TicketCustomField::TYPE_DATE
+                    @contents = Time.parse(@contents) if defined?(@contents)
+                end
+            end
+        end
+
+    end
+
+    class TicketCustomFieldGroup < KayakoClient::Tickets
+        embedded
+
+        property :id,       :integer
+        property :title,    :string
+        property :fields, [ :object ], :class => TicketCustomFieldValue, :get => :field
+
+    end
+
+    class TicketCustomField < KayakoClient::Tickets
+        supports :get
+
+        TYPE_TEXT          = 1
+        TYPE_TEXT_AREA     = 2
+        TYPE_PASSWORD      = 3
+        TYPE_CHECKBOX      = 4
+        TYPE_RADIO         = 5
+        TYPE_SELECT        = 6
+        TYPE_MULTI_SELECT  = 7
+        TYPE_CUSTOM        = 8
+        TYPE_LINKED_SELECT = 9
+        TYPE_DATE          = 10
+        TYPE_FILE          = 11
+
+        property :groups, [ :object ], :class => TicketCustomFieldGroup, :get => :group
+
+        # NOTE: when a new field is added returns (for old tickets):
+        # [Notice]: Undefined offset: 11 (api/class.Controller_TicketCustomField.php:279)
+
+        def empty?
+            !(groups && groups.size > 0)
+        end
+
+        def custom_field(name)
+            if defined?(@groups) && @groups.size > 0
+                if name.is_a?(Numeric)
+                    if name.to_i > 0
+                        @groups.each do |group|
+                            next unless group.fields && !group.fields.empty?
+                            group.fields.each do |field|
+                                if field.id == name.to_i
+                                    return field.contents
+                                end
+                            end
+                        end
+                    end
+                elsif name.is_a?(String)
+                    @groups.each do |group|
+                        next unless group.fields && !group.fields.empty?
+                        group.fields.each do |field|
+                            if field.title == name
+                                return field.contents
+                            end
+                        end
+                    end
+                end
+            end
+            nil
+        end
+
+        def [](name)
+            value = custom_field(name) unless name.is_a?(Symbol)
+            value || super
+        end
+
+        def each(&block)
+            if defined?(@groups) && @groups.size > 0
+                @custom_fields ||= @groups.inject([]) do |array, group|
+                    array.concat(group.fields) if group.fields && group.fields.size > 0
+                    array
+                end
+                @custom_fields.each(&block) unless @custom_fields.empty?
+            end
+        end
+
+    end
+
+end

data/lib/kayako_client/ticket_note.rb

@@ -0,0 +1,105 @@
+require 'kayako_client/mixins/ticket_api'
+
+require 'kayako_client/staff'
+require 'kayako_client/ticket'
+require 'kayako_client/user'
+require 'kayako_client/user_organization'
+
+module KayakoClient
+
+    class Ticket < KayakoClient::Tickets
+    end
+
+    class TicketNote < KayakoClient::Tickets
+        include KayakoClient::TicketAPI
+
+        supports :all, :get, :post, :delete
+
+        NOTE_TYPES = [ :ticket, :user, :userorganization, :timetrack ].freeze
+
+        COLOR_YELLOW = 1
+        COLOR_PURPLE = 2
+        COLOR_BLUE   = 3
+        COLOR_GREEN  = 4
+        COLOR_RED    = 5
+
+        property :id,                   :integer, :readonly => true
+        property :type,                 :symbol,  :readonly => true, :in => NOTE_TYPES
+        property :ticket_id,            :integer, :new => true, :required => :post
+        property :note_color,           :integer, :new => true, :range => 1..5
+        property :creator_staff_id,     :integer, :readonly => true
+        property :creator_staff_name,   :string,  :readonly => true
+        property :for_staff_id,         :integer, :new => true
+        property :creation_date,        :date,    :readonly => true
+        property :contents,             :string,  :new => true, :required => :post
+        property :user_id,              :integer, :readonly => true # :type = :user
+        property :user_organization_id, :integer, :readonly => true # :type = :userorganization
+        property :time_worked,          :integer, :readonly => true # :type = :timetrack
+        property :time_billable,        :integer, :readonly => true # :type = :timetrack
+        property :bill_date,            :date,    :readonly => true # :type = :timetrack
+        property :work_date,            :date,    :readonly => true # :type = :timetrack
+        property :worker_staff_id,      :integer, :readonly => true # :type = :timetrack
+        property :worker_staff_name,    :string,  :readonly => true # :type = :timetrack
+        property :staff_id,             :integer, :new => true
+        property :full_name,            :string,  :new => true
+
+        associate :ticket,              :ticket_id,            Ticket
+        associate :creator_staff,       :creator_staff_id,     Staff
+        associate :for_staff,           :for_staff_id,         Staff
+        associate :user,                :user_id,              User
+        associate :user_organization,   :user_organization_id, UserOrganization
+        associate :worker_staff,        :worker_staff_id,      Staff
+
+        # NOTE: :all returns only notes of :ticket type
+
+        def is_ticket_note?
+            !type.nil? && type == :ticket
+        end
+
+        def is_user_note?
+            !type.nil? && type == :user
+        end
+
+        def is_user_organization_note?
+            !type.nil? && type == :userorganization
+        end
+
+        def is_time_track_note?
+            !type.nil? && type == :timetrack
+        end
+
+        def has_creator_staff?
+            !creator_staff_id.nil? && creator_staff_id > 0
+        end
+
+        def has_for_staff?
+            !for_staff_id.nil? && for_staff_id > 0
+        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_worker_staff?
+            !worker_staff_id.nil? && worker_staff_id > 0
+        end
+
+    private
+
+        def validate(method, params)
+            if method == :post
+                unless params[:staff_id] || params[:full_name]
+                    raise ArgumentError, ":staff_id or :full_name is required"
+                end
+            end
+        end
+
+    end
+
+end

data/lib/kayako_client/ticket_post.rb

@@ -0,0 +1,61 @@
+require 'kayako_client/mixins/ticket_api'
+
+require 'kayako_client/staff'
+require 'kayako_client/user'
+
+module KayakoClient
+    class TicketPost < KayakoClient::Tickets
+        include KayakoClient::TicketAPI
+        include KayakoClient::PostClient
+
+        supports :all, :get, :post, :delete
+
+        CREATOR_STAFF = 1
+        CREATOR_USER  = 2
+
+        property :id,                :integer, :readonly => true
+        property :date_line,         :date,    :readonly => true
+        property :user_id,           :integer, :new => true
+        property :full_name,         :string,  :readonly => true
+        property :email,             :string,  :readonly => true
+        property :email_to,          :string,  :readonly => true
+        property :ip_address,        :string,  :readonly => true
+        property :has_attachments,   :boolean, :readonly => true
+        property :creator,           :integer, :readonly => true, :range => 1..2
+        property :is_third_party,    :boolean, :readonly => true
+        property :is_html,           :boolean, :readonly => true
+        property :is_emailed,        :boolean, :readonly => true
+        property :staff_id,          :integer, :new => true
+        property :is_survey_comment, :boolean, :readonly => true
+        property :contents,          :string,  :new => true, :required => :post
+        property :ticket_id,         :integer, :new => true, :required => :post
+        property :subject,           :string,  :new => true, :required => :post
+        property :ticket_post_id,    :integer, :readonly => true
+
+        associate :user,             :user_id,  User
+        associate :staff,            :staff_id, Staff
+
+        def created_by_staff?
+            !creator.nil? && creator == CREATOR_STAFF
+        end
+
+        alias_method :has_staff?, :created_by_staff?
+
+        def created_by_user?
+            !creator.nil? && creator == CREATOR_USER
+        end
+
+        alias_method :has_user?, :created_by_user?
+
+    private
+
+        def validate(method, params)
+            if method == :post
+                unless params[:user_id] || params[:staff_id]
+                    raise ArgumentError, ":user_id or :staff_id is required"
+                end
+            end
+        end
+
+    end
+end