sysaid 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0519d826d111724b463a1f8cbb69929c01af2445
+  data.tar.gz: 688d94e4230f20f817a2bfe3286544fdc11ffdeb
+SHA512:
+  metadata.gz: 477e368c753ae59ce4bc1f43f16232c33d6a9b488d399e679a992bc46abe9916f66894b08fef546f0525a619834947ab56becf24ddf9e558cbf369b98d41ad30
+  data.tar.gz: 1e9b146eef9d2be2b83063e4bb42096f76ee9244cfde39839a02daf6872ff16b8969c2d437138aa14fe4f43793ed20c176b47bc196163e1e6384e072bd692f56

data/lib/sysaid.rb

@@ -1,63 +1,14 @@
+require 'savon'
+
 # The main SysAid class
 class SysAid
   @@logged_in = false
   @@server_settings = {}
   
-  # Implements find_by_* methods, e.g. find_by_id, find_by_responsibility, etc.
-  def self.method_missing(meth, *args, &block)
-    if meth.to_s =~ /^find_by_(.+)$/
-      run_find_by_method($1, *args, &block)
-    else
-      super
-    end
-  end
-
-  # Find tickets by ID, responsibility, status, etc.
-  # Note: run_find_by_method is called from self.method_missing
-  #
-  # Example:
-  #   >> SysAid.find_by_id(34)
-  #   => hola mundo
-  #
-  # Arguments:
-  #   argument: (String or Integer)
-  def self.run_find_by_method(attrs, *args, &block)
-    # Make a key/value hash of attributes
-    attrs = attrs.split('_and_')
-    attrs_with_args = [attrs, args].transpose
-    conditions = Hash[attrs_with_args]
-    
-    if self.logged_in? == false
-      self.login
-    end
-
-    sr = ApiServiceRequest.new
-    if conditions.keys[0] == "id"
-      # ID requires we use loadById, not executeSelectQuery
-      result = @@service.loadByStringId({:sessionId => @@session_id, :apiSysObj => sr, :id => conditions.values[0]})
-    else
-      result = @@service.executeSelectQuery({:sessionId => @@session_id, :apiSysObj => sr, :condition => "#{conditions.keys[0]} = '#{conditions.values[0]}'"})
-    end
-    
-    if result.instance_variables.include?(:@v_return)
-      return SysAid::Ticket.new(result.v_return)
-    else
-      return nil # ticket not found
-    end
-  end
-  
-  def self.respond_to?(meth)
-    if meth.to_s =~ /^find_by_.*$/
-      true
-    else
-      super
-    end
-  end
-  
   # Accessor for internal SysaidApiService object.
   # Used by SysAid::Ticket
-  def self.service
-    @@service
+  def self.client
+    @@client
   end
 
   # Accessor for session ID returned by SysAid server.
@@ -74,8 +25,7 @@ class SysAid
   #   => true
   def self.logged_in?
     # Until official word comes from the company, we're going to login every time
-    # to avoid a problem with undetected timeouts
-    
+    # to avoid a problem with undetected timeouts.
     #if @@logged_in == false
       login
     #end
@@ -87,32 +37,29 @@ class SysAid
     end
   end
   
-  def self.server_settings
-    @@server_settings
-  end
-  
-  def self.server_settings=(server_settings)
-    @@server_settings = server_settings
-  end
-  
-  private
-  def self.login
-    @@service = SysaidApiService.new(@@server_settings[:endpoint])
-
-    # see SOAP wiredumps (for debugging)
-    unless @@server_settings[:debug].nil?
-      @@service.wiredump_dev = @@server_settings[:debug]
+  # self.login does not require credentials be passed every time.
+  # SysAid sometimes times out the session and we can simply call 'login' again with the
+  # saved credentials to get around the timeout.
+  def self.login(account = nil, username = nil, password = nil, wsdl_uri = nil, debug = false)
+    if account and username and password and wsdl_uri
+      # Save server settings in case we need to log in again later
+      @@server_settings = { :account => account, :username => username, :password => password, :wsdl_uri => wsdl_uri, :debug => debug }
     end
-
+    
+    @@client = Savon.client(wsdl: @@server_settings[:wsdl_uri], log: @@server_settings[:debug])
+    
     # login
     unless @@server_settings[:account].nil?
-      result = @@service.login({:accountId => @@server_settings[:account], :userName => @@server_settings[:username], :password => @@server_settings[:password]})
-      @@session_id = result.v_return
-    
+      # Call login
+      response = @@client.call(:login, message: { accountId: @@server_settings[:account], userName: @@server_settings[:username], password: @@server_settings[:password] })
+      
+      # Retrieve response
+      @@session_id = response.to_hash[:login_response][:return]
+      
       @@logged_in = true
     end
   end
 end
 
-require 'sysaid/driver/SysaidApiServiceServiceDriver'
 require 'sysaid/ticket'
+require 'sysaid/user'

data/lib/sysaid/ticket.rb

@@ -1,20 +1,39 @@
+require 'date'
+
 class SysAid::Ticket
-  # Creates a SysAid::Ticket object
-  #
-  # Example:
-  #   >> SysAid::Ticket.new
-  #   => SysAid::Ticket
-  #
-  # Arguments:
-  #   service_request: (ApiServiceRequest object, optional)
-  def initialize(service_request = nil)
-    @sr = service_request
+  attr_accessor :agreement, :assignCounter, :assignedTo, :ciid, :category, :currentSupportLevel, :custInt1,
+                :custInt2, :custList1, :custList2, :description, :escalation, :id, :location, :maxSupportLevel,
+                :parentLink, :priority, :projectID, :reopenCounter, :requestUser, :source, :srSubType, :srType,
+                :status, :subCategory, :submitUser, :successRating, :taskID, :title, :urgency, :version, :archive,
+                :assignedGroup, :assignedTo, :cc, :changeCategory, :closeTime, :closureInformation, :computerID,
+                :custNotes, :custText1, :custText2, :impact, :notes, :resolution, :solution, :thirdLevelCategory,
+                :updateTime, :updateUser, :userManager, :workaround
+  
+  def initialize
+    self.closeTime = Date.new
+    self.updateTime = Date.new
+  end
+  
+  def self.find_by_id(ticket_id)
+    ticket = SysAid::Ticket.new
     
-    if service_request.nil?
-      @sr = ApiServiceRequest.new
+    ticket.id = ticket_id
+    
+    return nil unless ticket.refresh
+    
+    return ticket
+  end
+  
+  # Loads the latest user information from the SysAid server
+  def refresh
+    response = SysAid.client.call(:load_by_string_id, message: to_xml)
+    
+    if response.to_hash[:load_by_string_id_response][:return]
+      set_self_from_response(response.to_hash[:load_by_string_id_response][:return])
+      return true
     end
     
-    set_self_from_sr
+    return false
   end
 
   # Saves a ticket back to the SysAid server
@@ -24,17 +43,12 @@ class SysAid::Ticket
   #   => true
   def save
     if SysAid.logged_in? == false
-      raise "You must create a SysAid instance and log in before attempting to create a ticket."
+      raise "You must log in before creating or saving a ticket."
     end
     
-    # Save public variables back to the ApiServiceRequest (@sr) variable
-    set_sr_from_self
-    
     # Save it via the SOAP API
-    result = SysAid.service.save({:sessionId => SysAid.session_id, :apiSysObj => @sr})
-    if result.v_return.to_i > 0
-      self.instance_variable_set(:@id, result.v_return.to_i)
-      @sr.instance_variable_set(:@id, result.v_return.to_i)
+    response = SysAid.client.call(:save, message: to_xml(false))
+    if response.to_hash[:save_response][:return]
       return true
     else
       return false
@@ -43,54 +57,133 @@ class SysAid::Ticket
 
   # Deletes a ticket from the SysAid server
   #
+  # No return value as SysAid's 'delete' call returns void. No idea why.
+  #
   # Example:
   #   >> ticket_object.delete
   #   => true  
   def delete
-    unless @sr.instance_variable_get(:@id).nil?
-      SysAid.service.delete({:sessionId => SysAid.session_id, :apiSysObj => @sr})
-      
-      return true
-    end
-    
-    false
-  end
-  
-  # For dynamically creating attr_accessors
-  # (from http://stackoverflow.com/questions/4082665/dynamically-create-class-attributes-with-attr-accessor)
-  def create_method( name, &block )
-      self.class.send( :define_method, name, &block )
-  end
-
-  def create_attr( name )
-      create_method( "#{name}=".to_sym ) { |val| 
-          instance_variable_set( "@" + name, val)
-      }
-
-      create_method( name.to_sym ) { 
-          instance_variable_get( "@" + name ) 
-      }
+    SysAid.client.call(:delete, message: to_xml(false))
   end
   
   private
-  # Note: We sync between @sr and our instance variables for API convenience, i.e.
-  #       so one can say, ticket.title = "something" instead of
-  #       ticket.instance_variable_get(:@sr).instance_variable_set(:@title, "something").
   
-  # Updates instance variables to match what is in @sr
-  def set_self_from_sr
-    @sr_symbols = []
-    @sr.instance_variables.each do |field|
-      @sr_symbols << field
-      self.create_attr(field.to_s[1..-1])
-      self.instance_variable_set(field, @sr.instance_variable_get(field.to_sym))
-    end
+  def to_xml(include_id = true)
+    builder = Builder::XmlMarkup.new
+
+    builder.sessionId(SysAid.session_id)
+    xml = builder.apiSysObj('xsi:type' => "tns:apiServiceRequest") { |b|
+      b.agreement(self.agreement, 'xsi:type' => 'xsd:int')
+      b.archive(self.archive, 'xsi:type' => 'xsd:boolean')
+      b.assignCounter(self.assignCounter, 'xsi:type' => 'xsd:int')
+      b.assignedGroup(self.assignedGroup, 'xsi:type' => 'xsd:string')
+      b.assignedTo(self.assignedTo, 'xsi:type' => 'xsd:string')
+      b.CIId(self.ciid, 'xsi:type' => 'xsd:int')
+      b.category(self.category, 'xsi:type' => 'xsd:string')
+      b.cc(self.cc, 'xsi:type' => 'xsd:string')
+      b.changeCategory(self.changeCategory, 'xsi:type' => 'xsd:int')
+      b.closeTime(self.closeTime.rfc3339, 'xsi:type' => 'xsd:dateTime')
+      b.closureInformation(self.closureInformation, 'xsi:type' => 'xsd:int')
+      b.computerID(self.computerID, 'xsi:type' => 'xsd:string')
+      b.currentSupportLevel(self.currentSupportLevel, 'xsi:type' => 'xsd:int')
+      b.custInt1(self.custInt1, 'xsi:type' => 'xsd:int')
+      b.custInt2(self.custInt2, 'xsi:type' => 'xsd:int')
+      b.custList1(self.custList1, 'xsi:type' => 'xsd:int')
+      b.custList2(self.custList2, 'xsi:type' => 'xsd:int')
+      b.custNotes(self.custNotes, 'xsi:type' => 'xsd:string')
+      b.custText1(self.custText1, 'xsi:type' => 'xsd:string')
+      b.custText2(self.custText2, 'xsi:type' => 'xsd:string')
+      b.customDateFields
+      #b.customFields
+      b.description(self.description, 'xsi:type' => 'xsd:string')
+      # <emailAccount xsi:type="xsd:string"></emailAccount>
+      b.escalation(self.escalation, 'xsi:type' => 'xsd:int')
+      # <followupText xsi:type="xsd:string"></followupText>
+      b.id(self.id, 'xsi:type' => 'xsd:int')
+      b.impact(self.impact, 'xsi:type' => 'xsd:int')
+      # <insertTime xsi:type="xsd:dateTime">
+      # 2012-06-13T17:42:03.053Z</insertTime>
+      b.location(self.location, 'xsi:type' => 'xsd:int')
+      b.maxSupportLevel(self.maxSupportLevel, 'xsi:type' => 'xsd:int')
+      b.notes(self.notes, 'xsi:type' => 'xsd:string')
+      b.parentLink(self.parentLink, 'xsi:type' => 'xsd:int')
+      b.priority(self.priority, 'xsi:type' => 'xsd:int')
+      b.projectID(self.projectID, 'xsi:type' => 'xsd:int')
+      b.reopenCounter(self.reopenCounter, 'xsi:type' => 'xsd:int')
+      b.requestUser(self.requestUser, 'xsi:type' => 'xsd:string')
+      b.resolution(self.resolution, 'xsi:type' => 'xsd:string')
+      b.solution(self.solution, 'xsi:type' => 'xsd:string')
+      b.source(self.source, 'xsi:type' => 'xsd:int')
+      b.srSubType(self.srSubType, 'xsi:type' => 'xsd:int')
+      b.srType(self.srType, 'xsi:type' => 'xsd:int')
+      b.status(self.status, 'xsi:type' => 'xsd:int')
+      b.subCategory(self.subCategory, 'xsi:type' => 'xsd:string')
+      b.successRating(self.successRating, 'xsi:type' => 'xsd:int')
+      b.taskID(self.taskID, 'xsi:type' => 'xsd:int')
+      b.thirdLevelCategory(self.thirdLevelCategory, 'xsi:type' => 'xsd:string')
+      b.title(self.title, 'xsi:type' => 'xsd:string')
+      b.updateTime(self.updateTime.rfc3339, 'xsi:type' => 'xsd:dateTime')
+      b.updateUser(self.updateUser, 'xsi:type' => 'xsd:string')
+      b.urgency(self.urgency, 'xsi:type' => 'xsd:int')
+      b.userManager(self.userManager, 'xsi:type' => 'xsd:string')
+      b.version(self.version, 'xsi:type' => 'xsd:int')
+      b.workaround(self.workaround, 'xsi:type' => 'xsd:string')
+    }
+    xml = builder.id(self.id) if include_id
+
+    xml
   end
   
-  # Updates @sr to match what is in our instance variables
-  def set_sr_from_self
-    @sr_symbols.each do |symbol|
-      @sr.instance_variable_set(symbol, self.instance_variable_get(symbol))
-    end
+  # Update instance variables to match what is in response
+  def set_self_from_response(response)
+    self.agreement = response[:agreement]
+    self.archive = response[:archive]
+    self.assignCounter = response[:assignCounter]
+    self.assignedGroup = response[:assignGroup]
+    self.assignedTo = response[:assignTo]
+    self.ciid = response[:CIId]
+    self.category = response[:category]
+    self.cc = response[:cc]
+    self.changeCategory = response[:changeCategory]
+    self.closeTime = Date.parse(response[:closeTime]) if response[:closeTime]
+    self.closureInformation = response[:closureInformation]
+    self.computerID = response[:computerID]
+    self.currentSupportLevel = response[:currentSupportLevel]
+    self.custInt1 = response[:custInt1]
+    self.custInt2 = response[:custInt2]
+    self.custList1 = response[:custList1]
+    self.custList2 = response[:custList2]
+    self.custNotes = response[:custNotes]
+    self.custText1 = response[:custText1]
+    self.custText2 = response[:custText2]
+    self.description = response[:description]
+    self.escalation = response[:escalation]
+    self.id = response[:id]
+    self.impact = response[:impact]
+    self.location = response[:location]
+    self.maxSupportLevel = response[:maxSupportLevel]
+    self.notes = response[:notes]
+    self.parentLink = response[:parentLink]
+    self.priority = response[:priority]
+    self.projectID = response[:projectID]
+    self.reopenCounter = response[:reopenCounter]
+    self.requestUser = response[:requestUser]
+    self.resolution = response[:resolution]
+    self.solution = response[:solution]
+    self.source = response[:source]
+    self.srSubType = response[:srSubType]
+    self.srType = response[:srType]
+    self.status = response[:status]
+    self.subCategory = response[:subCategory]
+    self.successRating = response[:successRating]
+    self.taskID = response[:taskID]
+    self.thirdLevelCategory = response[:thirdLevelCategory]
+    self.title = response[:title]
+    self.updateTime = Date.parse(response[:updateTime]) if response[:updateTime]
+    self.updateUser = response[:updateUser]
+    self.urgency = response[:urgency]
+    self.userManager = response[:userManager]
+    self.version = response[:version]
+    self.workaround = response[:workaround]
   end
 end

data/lib/sysaid/user.rb

@@ -0,0 +1,155 @@
+class SysAid::User
+  attr_accessor :username, :display_name, :email, :phone, :first_name, :last_name, :admin, :agreement, :building,
+                :car_number, :cellphone, :company, :cubic, :custInt1, :custInt2, :custList1, :custList2, :custNotes,
+                :custText1, :custText2, :department, :disable, :emailNotifications, :enableLoginToEup, :floor, :location,
+                :manager, :notes, :sms, :userManagerName, :loginDomain, :loginUser, :secondaryEmail
+  
+  # Creates a SysAid::User object
+  #
+  # Example:
+  #   >> SysAid::User.new
+  #   => SysAid::User
+  #
+  # Arguments:
+  #   username: (SysAid username, optional)
+  def initialize(username = nil)
+    self.username = username
+  end
+  
+  def self.find_by_username(username)
+    user = SysAid::User.new(username)
+    
+    return nil unless user.refresh
+    
+    return user
+  end
+  
+  # Loads the latest user information from the SysAid server
+  def refresh
+    response = SysAid.client.call(:load_by_string_id, message: to_xml.to_s )
+    if response.to_hash[:load_by_string_id_response][:return]
+      set_self_from_response(response.to_hash[:load_by_string_id_response][:return])
+      return true
+    end
+    
+    return false
+  end
+
+  # Saves a user back to the SysAid server
+  #
+  # Example:
+  #   >> user_object.save
+  #   => true
+  def save
+    if SysAid.logged_in? == false
+      raise "You must log in before creating or saving a user."
+    end
+    
+    # Save it via the SOAP API
+    response = SysAid.client.call(:save, message: to_xml(false).to_s )
+    if response.to_hash[:save_response][:return]
+      return true
+    else
+      return false
+    end
+  end
+
+  # Deletes a ticket from the SysAid server
+  #
+  # Example:
+  #   >> ticket_object.delete
+  #   => true  
+  def delete
+    response = SysAid.client.call(:delete, message: to_xml(false).to_s )
+    
+    #response.to_hash[:delete_response]
+    
+    # The SysAid API doesn't return anything on delete.
+    # Think about that for a minute.
+  end
+  
+  private
+  
+  def to_xml(include_id = true)
+    builder = Builder::XmlMarkup.new
+
+    builder.sessionId(SysAid.session_id)
+    xml = builder.apiSysObj('xsi:type' => "tns:apiSysAidUser") { |b|
+      b.admin(self.admin, 'xsi:type' => 'xsd:boolean')
+      b.agreement(self.agreement, 'xsi:type' => 'xsd:int')
+      b.building(self.building, 'xsi:type' => 'xsd:string')
+      b.carNumber(self.car_number, 'xsi:type' => 'xsd:string')
+      b.cellphone(self.cellphone, 'xsi:type' => 'xsd:string')
+      b.company(self.company, 'xsi:type' => 'xsd:int')
+      b.cubic(self.cubic, 'xsi:type' => 'xsd:string')
+      b.custInt1(self.custInt1, 'xsi:type' => 'xsd:int')
+      b.custInt2(self.custInt2, 'xsi:type' => 'xsd:int')
+      b.custList1(self.custList1, 'xsi:type' => 'xsd:int')
+      b.custList2(self.custList2, 'xsi:type' => 'xsd:int')
+      b.custNotes(self.custNotes, 'xsi:type' => 'xsd:string')
+      b.custText1(self.custText1, 'xsi:type' => 'xsd:string')
+      b.custText2(self.custText2, 'xsi:type' => 'xsd:string')
+      b.customDateFields
+      b.customFields
+      b.department(self.department, 'xsi:type' => 'xsd:int')
+      b.disable(self.disable, 'xsi:type' => 'xsd:boolean')
+      b.displayName(self.display_name, 'xsi:type' => 'xsd:string')
+      b.email(self.email, 'xsi:type' => 'xsd:string')
+      b.emailNotifications(self.emailNotifications, 'xsi:type' => 'xsd:boolean')
+      b.enableLoginToEup(self.enableLoginToEup, 'xsi:type' => 'xsd:boolean')
+      b.firstName(self.first_name, 'xsi:type' => 'xsd:string')
+      b.floor(self.floor, 'xsi:type' => 'xsd:string')
+      b.lastName(self.last_name, 'xsi:type' => 'xsd:string')
+      b.location(self.location, 'xsi:type' => 'xsd:int')
+      b.loginDomain(self.loginDomain, 'xsi:type' => 'xsd:string')
+      b.loginUser(self.loginUser, 'xsi:type' => 'xsd:string')
+      b.manager(self.manager, 'xsi:type' => 'xsd:boolean')
+      b.notes(self.notes, 'xsi:type' => 'xsd:string')
+      b.phone(self.phone, 'xsi:type' => 'xsd:string')
+      b.secondaryEmail(self.secondaryEmail, 'xsi:type' => 'xsd:string')
+      b.sms(self.sms, 'xsi:type' => 'xsd:string')
+      b.userManagerName(self.userManagerName, 'xsi:type' => 'xsd:string')      
+      b.userName(self.username, 'xsi:type' => 'xsd:string')
+    }
+    xml = builder.id(self.username) if include_id
+
+    xml
+  end
+  
+  # Update instance variables to match what is in response
+  def set_self_from_response(response)
+    self.username = response[:user_name]
+    self.display_name = response[:display_name]
+    self.email = response[:email]
+    self.phone = response[:phone]
+    self.first_name = response[:first_name]
+    self.last_name = response[:last_name]
+    self.admin = response[:admin]
+    self.agreement = response[:agreement]
+    self.building = response[:building]
+    self.car_number = response[:carNumber]
+    self.cellphone = response[:cellphone]
+    self.company = response[:company]
+    self.cubic = response[:cubic]
+    self.custInt1 = response[:custInt1]
+    self.custInt2 = response[:custInt2]
+    self.custList1 = response[:custList1]
+    self.custList2 = response[:custList2]
+    self.custNotes = response[:custNotes]
+    self.custText1 = response[:custText1]
+    self.custText2 = response[:custText2]
+    self.department = response[:department]
+    self.disable = response[:disable]
+    self.emailNotifications = response[:emailNotifications]
+    self.enableLoginToEup = response[:enableLoginToEup]
+    self.floor = response[:floor]
+    self.location = response[:location]
+    self.manager = response[:manager]
+    self.notes = response[:notes]
+    self.sms = response[:sms]
+    self.userManagerName = response[:userManagerName]
+    self.loginDomain = response[:loginDomain]
+    self.loginUser = response[:loginUser]
+    self.secondaryEmail = response[:secondaryEmail]
+  end
+end