KayakoClient 1.0.1 → 1.0.2

data/lib/kayako_client.rb

@@ -18,6 +18,7 @@ require 'kayako_client/mixins/user_visibility_api'
 require 'kayako_client/mixins/staff_visibility_api'
 
 require 'kayako_client/base'
+require 'kayako_client/custom_field'
 require 'kayako_client/department'
 require 'kayako_client/staff'
 require 'kayako_client/staff_group'

data/lib/kayako_client/custom_field.rb

@@ -0,0 +1,73 @@
+module KayakoClient
+
+    class CustomFieldOption < KayakoClient::Base
+        supports :all
+
+        property :custom_field_option_id,        :integer
+        property :custom_field_id,               :integer
+        property :option_value,                  :string
+        property :display_order,                 :integer
+        property :is_selected,                   :boolean
+        property :parent_custom_field_option_id, :integer
+
+        def has_parent_custom_field_option?
+            !parent_custom_field_option_id.nil? && parent_custom_field_option_id > 0
+        end
+
+        def self.all(custom_field_id, options = {})
+            unless custom_field_id.to_i > 0
+                logger.error "invalid :custom_field_id - #{custom_field_id}" if logger
+                raise ArgumentError, "invalid custom field ID"
+            end
+            super(options.merge(:e => "/#{self.superclass.name.split('::').last}/CustomField/ListOptions/#{custom_field_id.to_i}"))
+        end
+
+    end
+
+    class CustomField < KayakoClient::Base
+        supports :all
+
+        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 :custom_field_id,       :integer
+        property :field_name,            :string
+        property :title,                 :string
+        property :description,           :string
+        property :field_type,            :integer, :range => 1..11
+        property :is_required,           :boolean
+        property :default_value,         :string
+        property :regexp_validate,       :string
+        property :custom_field_group_id, :integer
+        property :encrypt_in_db,         :boolean
+        property :display_order,         :integer
+        property :user_editable,         :boolean
+        property :staff_editable,        :boolean
+
+        def options
+            if instance_variable_defined?(:@options)
+                instance_variable_get(:@options)
+            elsif !new? && custom_field_id && custom_field_id > 0
+                options = KayakoClient::CustomFieldOption.all(custom_field_id, inherited_options)
+                if options && !options.empty?
+                    instance_variable_set(:@options, options)
+                else
+                    instance_variable_set(:@options, nil)
+                end
+            else
+                nil
+            end
+        end
+
+    end
+
+end

data/lib/kayako_client/http/http_client.rb

@@ -7,6 +7,7 @@ module KayakoClient
 
         def initialize(options = {})
             @client = ::HTTPClient.new
+            @client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
             if options[:host]
                 @client.proxy = "http://#{options[:host]}:#{options[:port] || 80}"
                 @client.set_proxy_auth(options[:user], options[:pass])

data/lib/kayako_client/http/net_http.rb

@@ -1,4 +1,4 @@
-require 'net/http'
+require 'net/https'
 
 module KayakoClient
     class NetHTTP
@@ -13,8 +13,9 @@ module KayakoClient
         def get(base, params = {})
             uri = URI.parse(base)
             log = params.delete(:logger) || logger
-            @client.use_ssl = true if uri.is_a?(URI::HTTPS)
-            resp = @client.start(uri.host, uri.port) do |request|
+            session = @client.new(uri.host, uri.port)
+            session.use_ssl = true if uri.is_a?(URI::HTTPS)
+            resp = session.start do |request|
                 query = url(uri.path, params)
                 log.debug ":get => #{query}" if log
                 request.get(query)
@@ -26,8 +27,9 @@ module KayakoClient
             uri = URI.parse(base)
             e = params.delete(:e)
             log = params.delete(:logger) || logger
-            @client.use_ssl = true if uri.is_a?(URI::HTTPS)
-            resp = @client.start(uri.host, uri.port) do |request|
+            session = @client.new(uri.host, uri.port)
+            session.use_ssl = true if uri.is_a?(URI::HTTPS)
+            resp = session.start do |request|
                 query = url(uri.path, { :e => e })
                 data = form_data(params)
                 if log
@@ -43,8 +45,9 @@ module KayakoClient
             uri = URI.parse(base)
             e = params.delete(:e)
             log = params.delete(:logger) || logger
-            @client.use_ssl = true if uri.is_a?(URI::HTTPS)
-            resp = @client.start(uri.host, uri.port) do |request|
+            session = @client.new(uri.host, uri.port)
+            session.use_ssl = true if uri.is_a?(URI::HTTPS)
+            resp = session.start do |request|
                 query = url(uri.path, { :e => e })
                 data = form_data(params)
                 if log
@@ -59,8 +62,9 @@ module KayakoClient
         def delete(base, params = {})
             uri = URI.parse(base)
             log = params.delete(:logger) || logger
-            @client.use_ssl = true if uri.is_a?(URI::HTTPS)
-            resp = @client.start(uri.host, uri.port) do |request|
+            session = @client.new(uri.host, uri.port)
+            session.use_ssl = true if uri.is_a?(URI::HTTPS)
+            resp = session.start do |request|
                 query = url(uri.path, params)
                 log.debug ":delete => #{query}" if log
                 request.delete(query)

data/lib/kayako_client/mixins/client.rb

@@ -133,6 +133,12 @@ module KayakoClient
             KayakoClient::TicketCustomField.get(ticket, options.merge(inherited_options))
         end
 
+        def post_ticket_custom_fields(options = {})
+            KayakoClient::TicketCustomField.post(options.merge(inherited_options))
+        end
+
+        alias_method :create_ticket_custom_fields, :post_ticket_custom_fields
+
 
         def ticket_notes(ticket, options = {})
             KayakoClient::TicketNote.all(ticket, options.merge(inherited_options))
@@ -304,5 +310,14 @@ module KayakoClient
 
         alias_method :destroy_user_organization, :delete_user_organization
 
+
+        def custom_fields(options = {})
+            KayakoClient::CustomField.all(options.merge(inherited_options))
+        end
+
+        def custom_field_options(custom_field_id, options = {})
+            KayakoClient::CustomFieldOption.all(custom_field_id, options.merge(inherited_options))
+        end
+
     end
 end

data/lib/kayako_client/mixins/object.rb

@@ -27,6 +27,10 @@ module KayakoClient
             base.extend(ClassMethods)
         end
 
+        def id
+            nil
+        end
+
         def to_i
             instance_variable_defined?(:@id) ? instance_variable_get(:@id).to_i : 0
         end

data/lib/kayako_client/mixins/ticket_client.rb

@@ -39,6 +39,18 @@ module KayakoClient
             KayakoClient::TicketCustomField.get(id, options.merge(inherited_options)) if id
         end
 
+        def post_custom_fields(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::TicketCustomField.post(options.merge(inherited_options))
+            end
+        end
+
+        alias_method :create_custom_fields, :post_custom_fields
+
 
         def notes(options = {})
             KayakoClient::TicketNote.all(id, options.merge(inherited_options)) if id

data/lib/kayako_client/ticket.rb

@@ -92,6 +92,7 @@ module KayakoClient
         property :auto_user_id,         :boolean, :new => true
         property :staff_id,             :integer, :new => true
         property :type,                 :symbol, :new => true, :in => TICKET_TYPES
+        property :template_group_id,    :integer
 
         property :work_flow,            :object,   :class => TicketWorkflow
         property :watcher,            [ :object ], :class => TicketWatcher

data/lib/kayako_client/ticket_custom_field.rb

@@ -4,25 +4,25 @@ 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 :id,        :integer, :readonly => true
+        property :type,      :integer, :readonly => true, :range => 1..11
+        property :title,     :string, :readonly => true
+        property :name,      :string, :readonly => true
+        property :file_name, :string, :readonly => true
         property :contents,  :string
 
         def initialize(*args)
             super(*args)
             if defined?(@type)
-                if @type == KayakoClient::TicketCustomField::TYPE_FILE
+                if @type == KayakoClient::CustomField::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
+                elsif @type == KayakoClient::CustomField::TYPE_DATE
                     @contents = Time.parse(@contents) if defined?(@contents)
                 end
             end
@@ -31,36 +31,64 @@ module KayakoClient
     end
 
     class TicketCustomFieldGroup < KayakoClient::Tickets
-        embedded
 
-        property :id,       :integer
-        property :title,    :string
+        property :id,       :integer, :readonly => true
+        property :title,    :string, :readonly => true
+
         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
+        supports :get, :post
+
+        TYPE_TEXT          = KayakoClient::CustomField::TYPE_TEXT
+        TYPE_TEXT_AREA     = KayakoClient::CustomField::TYPE_TEXT_AREA
+        TYPE_PASSWORD      = KayakoClient::CustomField::TYPE_PASSWORD
+        TYPE_CHECKBOX      = KayakoClient::CustomField::TYPE_CHECKBOX
+        TYPE_RADIO         = KayakoClient::CustomField::TYPE_RADIO
+        TYPE_SELECT        = KayakoClient::CustomField::TYPE_SELECT
+        TYPE_MULTI_SELECT  = KayakoClient::CustomField::TYPE_MULTI_SELECT
+        TYPE_CUSTOM        = KayakoClient::CustomField::TYPE_CUSTOM
+        TYPE_LINKED_SELECT = KayakoClient::CustomField::TYPE_LINKED_SELECT
+        TYPE_DATE          = KayakoClient::CustomField::TYPE_DATE
+        TYPE_FILE          = KayakoClient::CustomField::TYPE_FILE
+
+        attr_accessor :ticket_id
 
         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 initialize(*args)
+            properties = {}
+            if args.last.is_a?(Hash)
+                args.last.keys.each do |property|
+                    if property.is_a?(String)
+                        properties[property] = args.last.delete(property)
+                    end
+                end
+                if args.last.has_key?(:ticket_id)
+                    self.ticket_id = args.last.delete(:ticket_id)
+                end
+            end
+            super
+            if properties.size > 0
+                properties.each do |property, value|
+                    self[property] = value
+                end
+            end
+        end
+
         def empty?
-            !(groups && groups.size > 0)
+            if groups && groups.size > 0
+                false
+            elsif defined?(@new_group) && @new_group.size > 0
+                false
+            else
+                true
+            end
         end
 
         def custom_field(name)
@@ -85,8 +113,27 @@ module KayakoClient
                             end
                         end
                     end
+                    @groups.each do |group|
+                        next unless group.fields && !group.fields.empty?
+                        group.fields.each do |field|
+                            if field.name == name
+                                return field.contents
+                            end
+                        end
+                    end
                 end
             end
+
+            if defined?(@new_group) && @new_group.size > 0
+                if name.is_a?(String)
+                    @new_group.each do |field|
+                        if field.name == name
+                            return field.contents
+                        end
+                    end
+                end
+            end
+
             nil
         end
 
@@ -97,12 +144,104 @@ module KayakoClient
 
         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
+                @groups.each do |group|
+                    group.fields.each(&block)
+                end
+            end
+
+            if defined?(@new_group) && @new_group.size > 0
+                @new_group.each(&block)
+            end
+        end
+
+        def []=(name, value)
+            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
+                                    field.contents = value.to_s
+                                    return field.contents
+                                end
+                            end
+                        end
+                        raise ArgumentError, "use custom field name"
+                    else
+                        raise ArgumentError, "invalid custom field ID"
+                    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
+                                field.contents = value.to_s
+                                return field.contents
+                            end
+                        end
+                    end
+                    @groups.each do |group|
+                        next unless group.fields && !group.fields.empty?
+                        group.fields.each do |field|
+                            if field.name == name
+                                field.contents = value.to_s
+                                return field.contents
+                            end
+                        end
+                    end
                 end
-                @custom_fields.each(&block) unless @custom_fields.empty?
             end
+
+            if name =~ %r{^[a-z0-9]{12}$}
+                @new_group ||= []
+                @new_group << TicketCustomFieldValue.new(:name => name.to_s, :contents => value.to_s)
+                return value.to_s
+            end
+
+            super
+        end
+
+        def post
+            raise RuntimeError, "client not configured" unless configured?
+            raise RuntimeError, "missing ticket ID" unless ticket_id.to_i > 0
+            params = {}
+            each do |field|
+                params[field.name] = field.contents
+            end
+            random = self.class.salt
+            e = "#{self.class.path}/#{ticket_id.to_i}"
+            response = client.post(api_url, params.merge(:e         => e,
+                                                         :apikey    => api_key,
+                                                         :salt      => random,
+                                                         :signature => self.class.signature(random, secret_key)))
+            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 ":post successful" if logger
+                true
+            else
+                unless response.is_a?(Hash)
+                    logger.error "Response: #{response.status} #{response.body}" if logger
+                    raise StandardError, "server returned #{response.status}: #{response.body}"
+                end
+                false
+            end
+        end
+
+        def self.get(*args)
+            object = super
+            if object && object.respond_to?(:ticket_id=)
+                object.ticket_id = args[0]
+                object.loaded!
+            end
+            object
         end
 
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: KayakoClient
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Kayako
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-26 00:00:00 Z
+date: 2012-03-16 00:00:00 Z
 dependencies: []
 
 description: Kayako's official Ruby interface library for the REST API.
@@ -65,6 +65,7 @@ files:
 - lib/kayako_client/user.rb
 - lib/kayako_client/user_group.rb
 - lib/kayako_client/user_organization.rb
+- lib/kayako_client/custom_field.rb
 homepage: http://forge.kayako.com/projects/kayako-ruby-api-library
 licenses: []
 
@@ -94,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Kayako official Ruby REST API library.