otrs_connector 1.0.0 → 1.0.1

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/otrs_connector/otrs/change.rb

@@ -18,27 +18,11 @@ class OTRS::Change < OTRS
   :change_free_text13, :change_free_key31, :accounted_time, :priority_id,
   :change_free_key40, :change_free_text4, :change_free_key4, :change_free_key26,
   :change_free_key42, :change_free_key23, :change_free_key30, :change_free_key36,
-  :planned_end_time,
-  :change_free_key49,
-  :change_free_key32,
-  :change_free_text48,
-  :change_free_text28,
-  :work_order_i_ds,
-  :change_free_key20,
-  :change_free_text14,
-  :change_free_key29,
-  :change_free_text7,
-  :change_free_text27,
-  :change_free_text18,
-  :change_number,
-  :planned_effort,
-  :change_free_key37,
-  :change_free_text11,
-  :justification,
-  :impact,
-  :change_free_key41,
-  :change_free_text22,
-  :change_free_key10,
+  :planned_end_time, :change_free_key49, :change_free_key32, :change_free_text48,
+  :change_free_text28, :work_order_i_ds, :change_free_key20, :change_free_text14,
+  :change_free_key29, :change_free_text7, :change_free_text27, :change_free_text18,
+  :change_number, :planned_effort, :change_free_key37, :change_free_text11, :justification,
+  :impact, :change_free_key41, :change_free_text22, :change_free_key10,
   :change_free_key19,
   :create_by,
   :change_free_text50,
@@ -82,11 +66,6 @@ class OTRS::Change < OTRS
   :change_free_text32,
   :description
   
-  
-  #def self.set_accessor(key)
-  #  attr_accessor key.to_sym
-  #end
-  
   def persisted?
     false
   end
@@ -98,14 +77,6 @@ class OTRS::Change < OTRS
     end
   end
   
-  def attributes
-    attributes = {}
-    self.instance_variables.each do |v|
-      attributes[v.to_s.gsub('@','').to_sym] = self.instance_variable_get(v)
-    end
-    attributes
-  end
-  
   def save
     self.create(self.attributes)
   end

data/lib/otrs_connector/otrs/config_item.rb

@@ -1,5 +1,7 @@
 class OTRS::ConfigItem < OTRS
+  # I did not convert fields in this classes to underscores because of the wide range of names possible in the OTRS's custom fields for ConfigItems.  In attempting to do so I kept running into issues, even in just our setup, so to KISS I'm just pulling in the fields directly
   
+  # Field Names that are part of all ConfigItem objects, not stored in XMLData table
   @@builtin_fields = [:Name,:DeplStateID,:InciStateID,:DefinitionID,
       :CreateTime,:ChangeBy,:ChangeTime,:Class,:ClassID,:ConfigItemID,:CreateBy,:CreateTime,
       :CurDeplState,:CurDeplStateID,:CurDeplStateType,:CurInciState,:CurInciStateID,:CurInciStateType,
@@ -28,14 +30,6 @@ class OTRS::ConfigItem < OTRS
     end
   end
   
-  def attributes
-    attributes = {}
-    self.instance_variables.each do |v|
-      attributes[v.to_s.gsub('@','').to_sym] = self.instance_variable_get(v)
-    end
-    attributes
-  end
-  
   def save
     self.create
   end
@@ -59,6 +53,7 @@ class OTRS::ConfigItem < OTRS
     config_item
   end
   
+  # Converts search hash for search itmes that ar enot the in @@builtin_fields to OTRS XMLData searches
   def self.xml_search(attributes)
     what = []
     attributes.each do |key,value|
@@ -69,6 +64,7 @@ class OTRS::ConfigItem < OTRS
     what
   end
   
+  # Custom object processor because of XMLData
   def self.object_preprocessor(object)
     unless object.nil? or object.empty?
       xml = self.from_otrs_xml(object['XMLData'])
@@ -78,12 +74,14 @@ class OTRS::ConfigItem < OTRS
     end
   end
   
+  # Find by ConfigItemID
   def self.find(id)
     data = { 'ConfigItemID' => id, 'XMLDataGet' => 1 }
     params = { :object => 'ConfigItemObjectCustom', :method => 'VersionGet', :data => data }
     self.object_preprocessor (connect(params).first)
   end
   
+  # Find by Version ID
   def self.find_version(id)
     data = { 'VersionID' => id, 'XMLDataGet' => 1 }
     params = { :object => 'ConfigItemObject', :method => 'VersionGet', :data => data }
@@ -110,6 +108,7 @@ class OTRS::ConfigItem < OTRS
     results
   end
   
+  # Get history of CI object, returns as CI's... may want to create a new class, subclassed from this one called ConfigItemHistoryEntry, or some such, but this works for now.
   def get_history
     data = { :ConfigItemID => self.id, 'XMLDataGet' => 1 }
     params = { :object => 'ConfigItemObjectCustom', :method => 'VersionList', :data => data }
@@ -121,6 +120,8 @@ class OTRS::ConfigItem < OTRS
     return b
   end
   
+  
+  # Convert non-builtin fields to OTRS's XMLData structure
   def self.to_otrs_xml(attributes)
     xml = attributes.except(:Name,:DeplStateID,:InciStateID,:DefinitionID,
       :CreateTime,:ChangeBy,:ChangeTime,:Class,:ClassID,:ConfigItemID,:CreateBy,:CreateTime,
@@ -136,6 +137,7 @@ class OTRS::ConfigItem < OTRS
     # Order keys properly so they are parsed in the correct order
     tmp.sort! { |x,y| x <=> y }
     tmp.each do |key|
+      # In some cases we created special field names because there were multiple fields with the same name.  Fields with the "__" are these special fields and need to be handled specially
       keys = key.split(/__/)
       xml_key = keys[0]
       unless keys[1].nil? then tag_key = keys[1].gsub(/^0/,'').to_i + 1 end
@@ -192,7 +194,10 @@ class OTRS::ConfigItem < OTRS
     config_item
   end
   
+  
+  # Convert OTRS XMLData structure to our object structure
   def self.from_otrs_xml(xml)
+    # OTRS Allows multiples of the same field name.  To handle this, and to make sure we pull all the fields these fields are being handled specially.  Fields with __keyname__count are these fields
     xml = xml[1].flatten[1][1].except("TagKey")
     data = {}
     xml.each do |key,value|
@@ -235,10 +240,4 @@ class OTRS::ConfigItem < OTRS
     data
   end
   
-  #def self.from_otrs_xml(xml)
-  #  data = { :XMLHash => xml }
-  #  params = { :object => 'XMLObject', :method => 'XMLHash2D', :data => data }
-  #  a = Hash[*(self.connect(params))]
-  #end
-  
 end

data/lib/otrs_connector/otrs/general_catalog.rb

@@ -1,4 +1,6 @@
 class OTRS::GeneralCatalog < OTRS
+  # Really recommend reading OTRS API Documentation for the GeneralCatalog
+  
   attr_accessor :name, :change_time, :change_by, :valid_id, :create_time, :item_id, :comment, :create_by
   def self.set_accessor(key)
     attr_accessor key.to_sym

data/lib/otrs_connector/otrs/link.rb

@@ -14,15 +14,7 @@ class OTRS::Link < OTRS
       send("#{name.to_s.underscore.to_sym}=", value)
     end
   end
-  
-  def attributes
-    attributes = {}
-    self.instance_variables.each do |v|
-      attributes[v.to_s.gsub('@','').to_sym] = self.instance_variable_get(v)
-    end
-    attributes
-  end
-  
+
   def save
     self.class.create(self.attributes)
   end
@@ -51,9 +43,10 @@ class OTRS::Link < OTRS
     end
   end
   
+  
+  # Returns list of link objects as Source => Target
+  # Haven't decided if I want this to return the link object or what is being linked to
   def self.where(attributes)
-    # Returns list of link objects as Source => Target
-    # Haven't decided if I want this to return the link object or what is being linked to
     attributes[:state] ||= 'Valid'
     tmp = {}
     attributes.each do |key,value|

data/lib/otrs_connector/otrs/relation.rb

@@ -1,4 +1,8 @@
 class OTRS::Relation < Array
+  # OTRS::Relation is my attempt at making something similar to ActiveRecord::Relation
+  # There is still a lot to do here.
+  # Right now where chains don't work as AR does, the first in the chain connects to OTRS, the rest of the chained items are parsing through the returned objects... somtimes this is faster, but the more objects get returned the slower it will be.
+  
   require 'will_paginate/array'
   
   #attr_accessor :where_hash, :connect_params
@@ -26,6 +30,7 @@ class OTRS::Relation < Array
   #  a.collect { |b| b.collect {|c| OTRS.object_preprocessor c }}
   #end
   
+  # Allows chaining where methods, this method only parses the already returned objects from OTRS, currently.  In the future I hope to have this grouping the where chains together into one OTRS request for all in the chain
   def where(attributes)
     relation = self.class.new
     attributes.each do |lookup_key,lookup_value|
@@ -44,6 +49,7 @@ class OTRS::Relation < Array
     self[0...int]
   end
   
+  # This is hit and miss for some reason... sometimes the order works correctly, sometimes it's backwards (desc/asc)
   def order(field='id',order='desc')
     case order.downcase.to_s
     when 'asc'
@@ -53,6 +59,7 @@ class OTRS::Relation < Array
     end
   end
   
+  # Removes duplicate records
   def uniqify
     ids = []
     results = self.class.new

data/lib/otrs_connector/otrs/service.rb

@@ -3,10 +3,6 @@ class OTRS::Service < OTRS
     :cur_inci_state, :create_by, :cur_inci_state_type_from_c_is, :change_time, :change_by, :create_time,
     :criticality, :comment, :criticality, :name_short, :type_id, :name, :parent_id, :cur_inci_state_id,
     :criticality_id
-
-  #def self.set_accessor(key)
-  #  attr_accessor key.to_sym
-  #end
   
   def persisted?
     false
@@ -14,7 +10,6 @@ class OTRS::Service < OTRS
   
   def initialize(attributes = {})
     attributes.each do |name, value|
-      #self.class.set_accessor(name.to_s.underscore)
       send("#{name.to_s.underscore.to_sym}=", value)
     end
   end
@@ -24,14 +19,6 @@ class OTRS::Service < OTRS
     params = { :object => 'ServiceObject', :method => 'ServiceGet', :data => data }
     self.object_preprocessor self.connect(params)
   end
-    
-  def attributes
-    attributes = {}
-    self.instance_variables.each do |v|
-      attributes[v.to_s.gsub('@','').to_sym] = self.instance_variable_get(v)
-    end
-    attributes
-  end
   
   def save
     self.create(self.attributes)

data/lib/otrs_connector/otrs/ticket/article.rb

@@ -10,15 +10,6 @@ class OTRS::Ticket::Article < OTRS::Ticket
       send("#{name.to_s.underscore.to_sym}=", value)
     end
   end
-  
-  def attributes
-    attributes = {}
-    self.instance_variables.each do |v|
-      attributes[v.to_s.gsub('@','').to_sym] = self.instance_variable_get(v)
-    end
-    attributes
-  end
-  
   def save
     self.create(self.attributes)
   end

data/lib/otrs_connector/otrs/ticket.rb

@@ -26,17 +26,12 @@ class OTRS::Ticket < OTRS
     self.ticket_id
   end
   
-  #def self.set_accessor(key)
-  #  attr_accessor key.to_sym
-  #end
-  
   def persisted?
     false
   end
   
   def initialize(attributes = {})
     attributes.each do |name, value|
-      #OTRS::Ticket.set_accessor(name.to_s.underscore)
       send("#{name.to_s.underscore.to_sym}=", value)
     end
   end
@@ -47,14 +42,6 @@ class OTRS::Ticket < OTRS
     connect(params).first
   end
   
-  def attributes
-    attributes = {}
-    self.instance_variables.each do |v|
-      attributes[v.to_s.gsub('@','').to_sym] = self.instance_variable_get(v)
-    end
-    attributes
-  end
-  
   def save
     self.create(self.attributes)
   end

data/lib/otrs_connector/otrs.rb

@@ -1,16 +1,21 @@
 class OTRS
+  # This class is mostly used for inheritance purposes
+  # All subclasses will be able to directly connect to OTRS
+  # All subclasses have active_record style callbacks
+  
+  # Include stuff for calbacks, validations
   include ActiveModel::Conversion
   include ActiveModel::Naming
   include ActiveModel::Validations
   extend ActiveModel::Callbacks
 
+  # Create callbacks on before/after create/save/update
   define_model_callbacks :create, :update, :save
 
-  # @@otrs_host is the address where the OTRS server presides
   # api_url is the base URL used to connect to the json api of OTRS, this will be the custom json.pl as the standard doesn't include ITSM module
   @@otrs_api_url ||= "https://loalhost/otrs/json.pl"
+  
   # Username / password combo should be an actual OTRS agent defined on the OTRS server
-  # I have not tested this with other forms of OTRS authentication
   @@otrs_user ||= 'rails'
   @@otrs_pass ||= 'rails'
 
@@ -35,6 +40,7 @@ class OTRS
     @@otrs_api_url = url
   end
 
+  # Convert object's instance variables to a hash
   def attributes
     attributes = {}
     self.instance_variables.each do |v|
@@ -43,17 +49,22 @@ class OTRS
     attributes
   end
 
+  # Handles communication with OTRS
   def self.connect(params)
     require 'net/https'
     base_url = self.api_url
+    
+    # Build request URL
     logon = URI.encode("User=#{self.user}&Password=#{self.password}")
     object = URI.encode(params[:object])
     method = URI.encode(params[:method])
     data = params[:data].to_json
     data = URI.encode(data)
+    # Had some issues with certain characters not being escaped properly and causing JSON issues
     data = URI.escape(data, '=\',\\/+-&?#.;')
     uri = URI.parse("#{base_url}?#{logon}&Object=#{object}&Method=#{method}&Data=#{data}")
-  
+    
+    # Connect to OTRS
     http = Net::HTTP.new(uri.host, uri.port)
     http.use_ssl = true
     http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -67,6 +78,8 @@ class OTRS
     end
   end
 
+  # Base method for processing objects returned by OTRS into Ruby objects
+  # This works in most cases, but not all, namely with OTRS::ConfigItem due to extra attributes
   def self.object_preprocessor(object)
     unless object.empty? or object.nil?
       a = Hash[*object]
@@ -76,9 +89,8 @@ class OTRS
     end
   end
 
-
+  # Not sure why this is here
   def connect(params)
     self.class.connect(params)
   end
 end
-#require_rel 'otrs'

data/otrs_connector.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "otrs_connector"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Goff"]
-  s.date = "2012-05-14"
+  s.date = "2012-05-15"
   s.description = "Connect your RAILS app to OTRS/ITSM"
   s.email = "cpuguy83@gmail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: otrs_connector
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -155,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3376265551325201422
+      hash: -3777876175560197454
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: