KayakoClient 0.0.1b

data/lib/kayako_client/ticket_priority.rb

@@ -0,0 +1,24 @@
+require 'kayako_client/mixins/user_visibility_api'
+
+module KayakoClient
+    class TicketPriority < KayakoClient::Tickets
+        include KayakoClient::UserVisibilityAPI
+
+        supports :all, :get
+
+        PRIORITY_TYPES = [ :public, :private ].freeze
+
+        property :id,                     :integer
+        property :title,                  :string
+        property :display_order,          :integer
+        property :fr_color_code,          :string
+        property :bg_color_code,          :string
+        property :display_icon,           :string
+        property :type,                   :symbol, :in => PRIORITY_TYPES
+        property :user_visibility_custom, :boolean
+        property :user_group_ids,       [ :integer ], :get => :usergroupid, :condition => { :user_visibility_custom => true }
+
+        associate :user_groups,           :user_group_ids, UserGroup
+
+    end
+end

data/lib/kayako_client/ticket_status.rb

@@ -0,0 +1,31 @@
+require 'kayako_client/department'
+
+module KayakoClient
+    class TicketStatus < KayakoClient::Tickets
+        include KayakoClient::StaffVisibilityAPI
+
+        supports :all, :get
+
+        STATUS_TYPES = [ :public, :private ].freeze
+
+        property :id,                      :integer
+        property :title,                   :string
+        property :display_order,           :integer
+        property :department_id,           :integer
+        property :display_icon,            :string
+        property :type,                    :symbol, :in => STATUS_TYPES
+        property :display_in_main_list,    :boolean
+        property :mark_as_resolved,        :boolean
+        property :display_count,           :integer
+        property :status_color,            :string
+        property :status_bg_color,         :string
+        property :reset_due_time,          :boolean
+        property :trigger_survey,          :boolean
+        property :staff_visibility_custom, :boolean
+        property :staff_group_ids,       [ :integer ], :get => :staffgroupid, :condition => { :staff_visibility_custom => true }
+
+        associate :department,             :department_id,   Department
+        associate :staff_groups,           :staff_group_ids, StaffGroup
+
+    end
+end

data/lib/kayako_client/ticket_time_track.rb

@@ -0,0 +1,27 @@
+require 'kayako_client/mixins/ticket_api'
+
+module KayakoClient
+    class TicketTimeTrack < KayakoClient::Tickets
+        include KayakoClient::TicketAPI
+
+        supports :all, :get, :post, :delete
+
+        property :id,                 :integer, :readonly => true
+        property :ticket_id,          :integer, :required => :post
+        property :time_worked,        :integer, :required => :post, :set => :timespent
+        property :time_billable,      :integer, :required => :post
+        property :bill_date,          :date,    :required => :post, :set => :billtimeline
+        property :work_date,          :date,    :required => :post, :set => :worktimeline
+        property :worker_staff_id,    :integer
+        property :worker_staff_name,  :string,  :readonly => true
+        property :creator_staff_id,   :integer, :required => :post, :set => :staffid
+        property :creator_staff_name, :string,  :readonly => true
+        property :note_color,         :integer, :range => 1..5
+        property :contents,           :string,  :required => :post
+
+        associate :ticket,            :ticket_id,        Ticket
+        associate :worker_staff,      :worker_staff_id,  Staff
+        associate :creator_staff,     :creator_staff_id, Staff
+
+    end
+end

data/lib/kayako_client/ticket_type.rb

@@ -0,0 +1,26 @@
+require 'kayako_client/mixins/user_visibility_api'
+
+require 'kayako_client/department'
+
+module KayakoClient
+    class TicketType < KayakoClient::Tickets
+        include KayakoClient::UserVisibilityAPI
+
+        supports :all, :get
+
+        TYPE_TYPES = [ :public, :private ].freeze
+
+        property :id,                     :integer
+        property :title,                  :string
+        property :display_order,          :integer
+        property :department_id,          :integer
+        property :display_icon,           :string
+        property :type,                   :symbol, :in => TYPE_TYPES
+        property :user_visibility_custom, :boolean
+        property :user_group_ids,       [ :integer ], :get => :usergroupid, :condition => { :user_visibility_custom => true }
+
+        associate :department,            :department_id, Department
+        associate :user_groups,           :user_group_ids, UserGroup
+
+    end
+end

data/lib/kayako_client/user.rb

@@ -0,0 +1,61 @@
+require 'kayako_client/user_group'
+require 'kayako_client/user_organization'
+
+module KayakoClient
+    class User < KayakoClient::Base
+
+        USER_ROLES       = [ :user, :manager ].freeze
+        USER_SALUTATIONS = [ 'Mr.', 'Ms.', 'Mrs.', 'Dr.' ].freeze
+
+        # NOTE: if :user_group_id is set the group should be of :registered type
+
+        property :id,                   :integer, :readonly => true
+        property :user_group_id,        :integer, :required => :post
+        property :user_role,            :symbol, :in => USER_ROLES
+        property :user_organization_id, :integer
+        property :salutation,           :string, :in => USER_SALUTATIONS
+        property :user_expiry,          :date
+        property :full_name,            :string, :required => [ :put, :post ]
+        property :emails,             [ :string ], :required => :post, :get => :email, :set => :email
+        property :designation,          :string
+        property :phone,                :string
+        property :date_line,            :date, :readonly => true
+        property :last_visit,           :date, :readonly => true
+        property :is_enabled,           :boolean
+        property :time_zone,            :string
+        property :enable_dst,           :boolean
+        property :sla_plan_id,          :integer
+        property :sla_plan_expiry,      :date
+        property :password,             :string, :new => true, :required => :post
+        property :send_welcome_email,   :boolean, :new => true
+
+        associate :user_group,          :user_group_id,        UserGroup
+        associate :user_organization,   :user_organization_id, UserOrganization
+
+        def self.all(marker = nil, limit = nil, options = {})
+            unless marker.nil?
+                unless marker.to_i > 0
+                    logger.error "invalid :marker - #{marker}" if logger
+                    raise ArgumentError, "invalid marker"
+                end
+                unless limit.nil? || limit.to_i > 0
+                    logger.error "invalid :limit (:maxitems) - #{limit}" if logger
+                    raise ArgumentError, "invalid limit"
+                end
+            else
+                if limit && limit.to_i > 0
+                    logger.error "invalid :marker" if logger
+                    raise ArgumentError, "missing marker"
+                end
+            end
+
+            e = path + '/Filter'
+            if marker
+                e << "/#{marker.to_i}"
+                e << "/#{limit.to_i}" if limit
+            end
+            super(options.merge(:e => e))
+        end
+
+    end
+end

data/lib/kayako_client/user_group.rb

@@ -0,0 +1,12 @@
+module KayakoClient
+    class UserGroup < KayakoClient::Base
+
+        USER_GROUP_TYPES = [ :guest, :registered ].freeze
+
+        property :id,         :integer, :readonly => true
+        property :title,      :string, :required => [ :put, :post ]
+        property :group_type, :symbol, :required => :post, :new => true
+        property :is_master,  :boolean, :readonly => true
+
+    end
+end

data/lib/kayako_client/user_organization.rb

@@ -0,0 +1,23 @@
+module KayakoClient
+    class UserOrganization < KayakoClient::Base
+
+        USER_ORGANIZATION_TYPES = [ :restricted, :shared ].freeze
+
+        property :id,                :integer, :readonly => true
+        property :name,              :string, :required => [ :put, :post ]
+        property :organization_type, :symbol, :required => :post, :in => USER_ORGANIZATION_TYPES
+        property :address,           :string
+        property :city,              :string
+        property :state,             :string
+        property :postal_code,       :integer
+        property :country,           :string
+        property :phone,             :string
+        property :fax,               :string
+        property :website,           :string
+        property :date_line,         :date, :readonly => true
+        property :last_update,       :date, :readonly => true
+        property :sla_plan_id,       :integer
+        property :sla_plan_expiry,   :date
+
+    end
+end

data/lib/kayako_client/xml/lib_xml.rb

@@ -0,0 +1,86 @@
+require 'libxml'
+
+module KayakoClient
+
+    class LibXML
+        include KayakoClient::Logger
+        include KayakoClient::XMLBackend
+
+        def initialize(document, options = {})
+            logger = options[:logger] if options[:logger]
+            if (document.start_with?('<?xml '))
+                @xml = ::LibXML::XML::Parser.string(document).parse
+            else
+                start = document.index('<?xml version="1.0" encoding="UTF-8"?>')
+                if start && start > 0
+                    @notice = document.slice(0..start-1).gsub(%r{</?[A-Z0-9]+(?: +[A-Z]+="[^">]*")?>}i, '')
+                    @xml = ::LibXML::XML::Parser.string(document.slice(start..document.size)).parse
+                else
+                    @error = document.gsub(%r{</?[A-Z0-9]+(?: +[A-Z]+="[^">]*")?>}i, '')
+                end
+            end
+        rescue ::LibXML::XML::Parser::ParseError => error
+            error.extend(::KayakoClient::XMLException)
+            raise
+        end
+
+        def count
+            if !error? && @xml.root
+                @xml.root.children.inject(0) do |count, node|
+                    count += 1 if node.element?
+                    count
+                end
+            else
+                0
+            end
+        end
+
+        def each(&block)
+            @xml.root.each_element(&block) if !error? && @xml.root
+        end
+
+        def to_hash(root = nil)
+            hash = {}
+            if !error? && @xml.root
+                root ||= @xml.root
+                root.each_attr do |attribute|
+                    hash[attribute.name.to_sym] = attribute.value
+                end
+                root.each_element do |property|
+                    name = property.name.to_sym
+                    elements = property.children.inject(0) do |count, node|
+                        count += 1 if node.element?
+                        count
+                    end
+                    if elements > 0 || property.attributes?
+                        value = to_hash(property)
+                        if property.children.size == 1 && (property.first.text? || property.first.cdata?)
+                            text = property.content.strip
+                            unless text.empty?
+                                value ||= {}
+                                value[:contents] = text
+                            end
+                        end
+                    elsif property.children.size == 1 && (property.first.text? || property.first.cdata?)
+                        value = property.content.strip
+                    end
+                    unless value.nil? || value.empty?
+                        if hash.include?(name)
+                            hash[name] = [ hash[name] ] unless hash[name].is_a?(Array)
+                            hash[name].push(value)
+                        else
+                            hash[name] = value
+                        end
+                    end
+                end
+                if root.children.size == 1 && (root.first.text? || root.first.cdata?)
+                    text = root.content.strip
+                    hash[:contents] = text unless text.empty?
+                end
+            end
+            hash.empty? ? nil : hash
+        end
+
+    end
+
+end

data/lib/kayako_client/xml/rexml_document.rb

@@ -0,0 +1,77 @@
+require 'rexml/document'
+
+module KayakoClient
+    class REXMLDocument
+        include KayakoClient::Logger
+        include KayakoClient::XMLBackend
+
+        def initialize(document, options = {})
+            logger = options[:logger] if options[:logger]
+            if (document.start_with?('<?xml '))
+                @xml = REXML::Document.new(document)
+            else
+                start = document.index('<?xml version="1.0" encoding="UTF-8"?>')
+                if start && start > 0
+                    @notice = document.slice(0..start-1).gsub(%r{</?[A-Z0-9]+(?: +[A-Z]+="[^">]*")?>}i, '')
+                    @xml = REXML::Document.new(document.slice(start..document.size))
+                else
+                    @error = document.gsub(%r{</?[A-Z0-9]+(?: +[A-Z]+="[^">]*")?>}i, '')
+                end
+            end
+        rescue REXML::ParseException => error
+            error.extend(::KayakoClient::XMLException)
+            raise
+        end
+
+        def count
+            if !error? && @xml.root
+                @xml.root.elements.count
+            else
+                0
+            end
+        end
+
+        def each(&block)
+            @xml.root.elements.each(&block) if !error? && @xml.root
+        end
+
+        def to_hash(root = nil)
+            hash = {}
+            if !error? && @xml.root
+                root ||= @xml.root
+                root.attributes.each do |attribute, value|
+                    hash[attribute.to_sym] = value
+                end
+                root.elements.each do |property|
+                    name = property.name.to_sym
+                    if property.has_elements? || property.has_attributes?
+                        value = to_hash(property)
+                        if property.has_text?
+                            text = property.text.strip
+                            unless text.empty?
+                                value ||= {}
+                                value[:contents] = text
+                            end
+                        end
+                    elsif property.has_text?
+                        value = property.text.strip
+                    end
+                    unless value.nil? || value.empty?
+                        if hash.include?(name)
+                            hash[name] = [ hash[name] ] unless hash[name].is_a?(Array)
+                            hash[name].push(value)
+                        else
+                            hash[name] = value
+                        end
+                    end
+                end
+                if root.has_text?
+                    text = root.text.strip
+                    hash[:contents] = text unless text.empty?
+                end
+            end
+            hash.empty? ? nil : hash
+        end
+
+    end
+end

data/lib/kayako_client/xml/xml.rb

@@ -0,0 +1,63 @@
+module KayakoClient
+    module XML
+
+        def self.included(base)
+            base.extend(ClassMethods)
+        end
+
+        def xml_backend=(backend)
+            if backend.is_a?(String)
+                raise ArgumentError, "invalid XML backend: #{backend}" unless backend =~ /^[A-Za-z_]+$/
+                file = backend.gsub(/([a-z])([A-Z])/, '\1_\2').gsub(/([A-Z])([A-Z][a-z])/, '\1_\2').downcase
+                require "kayako_client/xml/#{file}"
+                backend = KayakoClient.const_get(backend)
+            end
+            if backend.is_a?(Class)
+                if backend.included_modules.include?(KayakoClient::XMLBackend)
+                    @xml_backend = backend
+                else
+                    raise ArgumentError, "invalid XML backend: #{backend.name}"
+                end
+            else
+                raise ArgumentError, "unsupported XML backend"
+            end
+        end
+
+        def xml_backend
+            @xml_backend ||= self.class.xml_backend
+        end
+
+        module ClassMethods
+
+            def xml_backend=(backend)
+                if backend.is_a?(String)
+                    raise ArgumentError, "invalid XML backend: #{backend}" unless backend =~ /^[A-Za-z_]+$/
+                    file = backend.gsub(/([a-z])([A-Z])/, '\1_\2').gsub(/([A-Z])([A-Z][a-z])/, '\1_\2').downcase
+                    require "kayako_client/xml/#{file}"
+                    backend = KayakoClient.const_get(backend)
+                end
+                if backend.is_a?(Class)
+                    if backend.included_modules.include?(KayakoClient::XMLBackend)
+                        @@xml_backend = backend
+                    else
+                        raise ArgumentError, "invalid XML backend: #{backend.name}"
+                    end
+                else
+                    raise ArgumentError, "unsupported XML backend"
+                end
+            end
+
+            def xml_backend
+                begin
+                    require 'kayako_client/xml/lib_xml'
+                    @@xml_backend ||= KayakoClient::LibXML
+                rescue LoadError
+                    require 'kayako_client/xml/rexml_document'
+                    @@xml_backend ||= KayakoClient::REXMLDocument
+                end
+            end
+
+        end
+
+    end
+end

data/lib/kayako_client/xml/xml_backend.rb

@@ -0,0 +1,42 @@
+module KayakoClient
+
+    module XMLBackend
+
+        def initialize(document)
+            raise NotImplementedError, "not implemented"
+        end
+
+        def count
+            raise NotImplementedError, "not implemented"
+        end
+
+        def each(&block)
+            raise NotImplementedError, "not implemented"
+        end
+
+        def to_hash(root = nil)
+            raise NotImplementedError, "not implemented"
+        end
+
+        def notice?
+            defined?(@notice)
+        end
+
+        def error?
+            defined?(@error)
+        end
+
+        def notice
+            @notice || nil
+        end
+
+        def error
+            @error || nil
+        end
+
+    end
+
+    module XMLException
+    end
+
+end