sysaid 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18732cc848584f877374c31ba0c9b708bbdbcbb1
-  data.tar.gz: 6bb0ebe4e8d21b2cb60a0ac088617b468fb25316
+  metadata.gz: 22a0143cf3d7e453f2e61907d52a177f46ecfb58
+  data.tar.gz: 7b271de7c2b38af6fa93a19bacfb59027e39919a
 SHA512:
-  metadata.gz: 23d8029b47b5b6ccdd50f4f206cab097034794df82de4941c51c544d451f6190b7b7e34784bb0869c627c62a79fb49c5e25f444c2d9408c48b1962db8caccc59
-  data.tar.gz: c28df645f0b57b17c5dbaa39a4b9972340d962de90aa860e1b1e8266e1d87dae1087d0ad65a324c283bc3015e4f46fa65326939aa9367179a4bfa1b7b2f0342d
+  metadata.gz: 0cd04dfef9f31101e2a388e686c38e69b3f1678f39cbd8c4611eace2d2215b1f2b38195184b48e7edf198a1d105c0d38657f0a62bc891f4c508d59d278adb8df
+  data.tar.gz: 86afd2f3ad495f74472512e045a88145e3f846c279a23fa6d2f97e1176b39f1611cbdaf38dedcf480cf6d3d2b27b53c149b1fd016f56145dee56a23c9ead3d3c

data/lib/sysaid.rb

@@ -8,19 +8,34 @@ end
 class SysAid
   @@logged_in = false
   @@server_settings = { account: nil, username: nil, password: nil, wsdl_uri: nil, debug: false }
-  
+
   # Accessor for internal SysaidApiService object.
   # Used by SysAid::Ticket
   def self.client
     @@client
   end
 
+  # Proxy for @@client.call but allows us to catch the various exceptions which may happen
+  # due to network errors, SOAP errors, etc., which otherwise would have to be caught in
+  # many different places.
+  def self.call(method, message)
+    begin
+      return @@client.call(method, message)
+    rescue SocketError => e
+        raise SysAidException, "Unable to fetch user information from SysAid server: #{e.message}"
+    rescue Errno::EHOSTUNREACH => e
+      raise SysAidException, "Unable to save user due to server being unreachable: #{e.message}"
+    rescue Savon::SOAPFault => e
+      raise SysAidException, "Unable to save user due to SOAP communications error: #{e.message}"
+    end
+  end
+
   # Accessor for session ID returned by SysAid server.
   # Used by SysAid::Ticket
   def self.session_id
     @@session_id
   end
-  
+
   # Accessor for server settings.
   # Used by SysAid::Ticket
   def self.server_settings
@@ -31,7 +46,7 @@ class SysAid
     # If they don't pass in debug, set it to false to maintain default settings
     @@server_settings[:debug] = false if server_settings[:debug].nil?
   end
-  
+
   # The SysAid API isn't clear on what creates an API timeout. It's possible to login
   # and make SOAP calls many minutes later but the API _seems_ to timeout at some point.
   # With the exception of the added delay, there's no harm in simply logging in over and
@@ -40,7 +55,7 @@ class SysAid
   def self.ensure_logged_in
     self.login unless self.logged_in?
   end
-  
+
   # Returns true if logged into SysAid server
   # Note: By design, logged_in? will try to log in if it isn't already
   #
@@ -49,44 +64,44 @@ class SysAid
   #   => true
   def self.logged_in?
     puts "SysAid.logged_in? called" if @@server_settings[:debug]
-    
+
     # Until official word comes from the company, we're going to login every time
     # to avoid a problem with undetected timeouts.
     #if @@logged_in == false
       login
     #end
-    
+
     if @@logged_in
       return true
     else
       return false
     end
   end
-  
+
   # 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 = nil)
     puts "SysAid.login" if @@server_settings[:debug]
-    
+
     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' parameter cannot default to false else it would override default, so use nil and check
       @@server_settings[:debug] = debug if debug != nil
     end
-    
+
     begin
       @@client = Savon.client(wsdl: @@server_settings[:wsdl_uri], log: @@server_settings[:debug])
-    
+
       # login
       unless @@server_settings[:account].nil?
         # Call login
-        response = @@client.call(:login, message: { accountId: @@server_settings[:account], userName: @@server_settings[:username], password: @@server_settings[:password] })
-      
+        response = self.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
     rescue Net::ReadTimeout => e

data/lib/sysaid/activity.rb

@@ -2,11 +2,11 @@ require 'date'
 
 class SysAid::Activity
   attr_accessor :ciid, :cust_int1, :cust_int2, :cust_int3, :cust_int4, :cust_list1, :cust_list2, :description, :from_time, :id, :sr_id, :to_time, :user
-  
+
   def initialize
     reset_all_attributes
   end
-  
+
   # Needed by both initialize and delete (to empty out the object when deleted)
   def reset_all_attributes
     self.ciid = nil
@@ -23,46 +23,46 @@ class SysAid::Activity
     self.to_time = Date.new
     self.user = nil
   end
-  
+
   # Returns an array of Activity IDs based on ticket_id.
   # Returns false on error.
   def self.find_by_ticket_id(ticket_id)
     SysAid.ensure_logged_in
-    
-    response = SysAid.client.call(:execute_select_query, message: sql_query(" service_req_id = #{ticket_id}"))
-    
+
+    response = SysAid.call(:execute_select_query, message: sql_query(" service_req_id = #{ticket_id}"))
+
     if response.to_hash[:execute_select_query_response][:return]
       return response.to_hash[:execute_select_query_response][:return]
     end
-    
+
     return false
   end
-  
+
   # Returns a specific Activity based on an Activity ID
   def self.find_by_id(activity_id)
     activity = SysAid::Activity.new
-    
+
     activity.id = activity_id
-    
+
     return nil unless activity.refresh
-    
+
     return activity
   end
-  
+
   # Loads the latest ticket information from the SysAid server
   def refresh
     SysAid.ensure_logged_in
-    
-    response = SysAid.client.call(:load_by_string_id, message: to_xml)
-    
+
+    response = SysAid.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
-    
+
     return false
   end
-  
+
   # Saves an activity back to the SysAid server
   #
   # Example:
@@ -70,9 +70,9 @@ class SysAid::Activity
   #   => true
   def save
     SysAid.ensure_logged_in
-    
+
     # Save it via the SOAP API
-    response = SysAid.client.call(:save, message: to_xml(false))
+    response = SysAid.call(:save, message: to_xml(false))
     if response.to_hash[:save_response][:return]
       # In the case of new activities, the SysAid response will be the assigned ID
       self.id = response.to_hash[:save_response][:return] unless self.id
@@ -92,13 +92,13 @@ class SysAid::Activity
   def delete
     SysAid.ensure_logged_in
     
-    SysAid.client.call(:delete, message: to_xml(false))
-    
+    SysAid.call(:delete, message: to_xml(false))
+
     reset_all_attributes
   end
-  
+
   private
-  
+
   def self.sql_query(query)
     builder = Builder::XmlMarkup.new
 
@@ -107,10 +107,10 @@ class SysAid::Activity
     xml = builder.condition(query)
     xml
   end
-  
+
   def to_xml(include_id = true)
     builder = Builder::XmlMarkup.new
-    
+
     builder.sessionId(SysAid.session_id)
     xml = builder.apiSysObj('xsi:type' => "tns:apiServiceRequestActivity") { |b|
       b.CIId(self.ciid, 'xsi:type' => 'xsd:int')
@@ -131,7 +131,7 @@ class SysAid::Activity
 
     xml
   end
-  
+
   # Update instance variables to match what is in response
   def set_self_from_response(response)
     self.ciid = response[:ci_id]

data/lib/sysaid/project.rb

@@ -3,47 +3,47 @@ require 'date'
 class SysAid::Project
   attr_accessor :assigned_group, :category, :company, :cust_date1, :cust_date2, :cust_int1, :cust_int2, :cust_list1,
                 :cust_list2, :cust_notes, :custom_date_fields, :custom_fields, :cust_text1, :cust_text2, :description,
-                :end_time, :id, :incident_title, :manager, :notes, :progress, :raw_estimation, :request_group, 
+                :end_time, :id, :incident_title, :manager, :notes, :progress, :raw_estimation, :request_group,
                 :start_time, :status, :title, :version
-  
+
   def initialize
     self.start_time = Date.new
     self.end_time = Date.new
   end
-  
+
   def self.find_by_id(project_id)
     project = SysAid::Project.new
-    
+
     project.id = project_id
-    
+
     return nil unless project.refresh
-    
+
     return project
   end
 
   def self.find_by_query(query)
     SysAid.ensure_logged_in
-    
-    response = SysAid.client.call(:execute_select_query, message: sql_query(query))
-    
+
+    response = SysAid.call(:execute_select_query, message: sql_query(query))
+
     if response.to_hash[:execute_select_query_response][:return]
       return response.to_hash[:execute_select_query_response][:return]
     end
-    
+
     return false
   end
-  
+
   # Loads the latest project information from the SysAid server
   def refresh
     SysAid.ensure_logged_in
-    
-    response = SysAid.client.call(:load_by_string_id, message: to_xml)
-    
+
+    response = SysAid.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
-    
+
     return false
   end
 
@@ -54,9 +54,9 @@ class SysAid::Project
   #   => true
   def save
     SysAid.ensure_logged_in
-    
+
     # Save it via the SOAP API
-    response = SysAid.client.call(:save, message: to_xml(false))
+    response = SysAid.call(:save, message: to_xml(false))
     if response.to_hash[:save_response][:return]
       return true
     else
@@ -70,14 +70,14 @@ class SysAid::Project
   #
   # Example:
   #   >> project_object.delete
-  #   => true  
+  #   => true
   def delete
     SysAid.ensure_logged_in
-    SysAid.client.call(:delete, message: to_xml(false))
+    SysAid.call(:delete, message: to_xml(false))
   end
-  
+
   private
-  
+
   def self.sql_query(query)
     builder = Builder::XmlMarkup.new
 
@@ -121,7 +121,7 @@ class SysAid::Project
 
     xml
   end
-  
+
   # Update instance variables to match what is in response
   def set_self_from_response(response)
     self.assigned_group = response[:assign_group]

data/lib/sysaid/task.rb

@@ -5,45 +5,45 @@ class SysAid::Task
                 :cust_notes, :custom_date_fields, :custom_fields, :cust_text1, :cust_text2, :description,
                 :end_time, :estimation, :id, :notes, :progress, :project_id, :start_time, :status,
                 :task_dependency, :task_dependency_type, :title, :version
-  
+
   def initialize
     self.start_time = Date.new
     self.end_time = Date.new
   end
-  
+
   def self.find_by_id(task_id)
     task = SysAid::Task.new
-    
+
     task.id = task_id
-    
+
     return nil unless task.refresh
-    
+
     return task
   end
 
   def self.find_by_project_id(project_id)
     SysAid.ensure_logged_in
-    
-    response = SysAid.client.call(:execute_select_query, message: sql_query(project_id))
-    
+
+    response = SysAid.call(:execute_select_query, message: sql_query(project_id))
+
     if response.to_hash[:execute_select_query_response][:return]
       return response.to_hash[:execute_select_query_response][:return]
     end
-    
+
     return false
   end
 
   # Loads the latest task information from the SysAid server
   def refresh
     SysAid.ensure_logged_in
-    
-    response = SysAid.client.call(:load_by_string_id, message: to_xml)
-    
+
+    response = SysAid.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
-    
+
     return false
   end
 
@@ -54,9 +54,9 @@ class SysAid::Task
   #   => true
   def save
     SysAid.ensure_logged_in
-    
+
     # Save it via the SOAP API
-    response = SysAid.client.call(:save, message: to_xml(false))
+    response = SysAid.call(:save, message: to_xml(false))
     if response.to_hash[:save_response][:return]
       return true
     else
@@ -70,13 +70,13 @@ class SysAid::Task
   #
   # Example:
   #   >> task_object.delete
-  #   => true  
+  #   => true
   def delete
     SysAid.ensure_logged_in
     
-    SysAid.client.call(:delete, message: to_xml(false))
+    SysAid.call(:delete, message: to_xml(false))
   end
-  
+
   private
 
   def self.sql_query(project_id)
@@ -124,7 +124,7 @@ class SysAid::Task
 
     xml
   end
-  
+
   # Update instance variables to match what is in response
   def set_self_from_response(response)
     self.category = response[:category]

data/lib/sysaid/ticket.rb

@@ -8,11 +8,11 @@ class SysAid::Ticket
                 :assigned_group, :cc, :change_category, :close_time, :closure_information, :computer_id,
                 :cust_notes, :cust_text1, :cust_text2, :impact, :notes, :resolution, :solution, :third_level_category,
                 :update_time, :update_user, :user_manager, :workaround, :insert_time, :followup_text, :email_account
-  
+
   def initialize
     reset_all_attributes
   end
-  
+
   # Needed by both initialize and delete (to empty out the object when deleted)
   def reset_all_attributes
     self.agreement = nil
@@ -68,37 +68,37 @@ class SysAid::Ticket
     self.version = nil
     self.workaround = nil
   end
-  
+
   def self.find_by_id(ticket_id)
     ticket = SysAid::Ticket.new
-    
+
     ticket.id = ticket_id
-    
+
     return nil unless ticket.refresh
-    
+
     return ticket
   end
-  
+
   # Loads the latest ticket information from the SysAid server
   def refresh
     SysAid.ensure_logged_in
-    
-    response = SysAid.client.call(:load_by_string_id, message: to_xml)
-    
+
+    response = SysAid.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
-    
+
     return false
   end
-  
+
   # Though the 'notes' field is merely an editable string, 'add_note'
   # mimics the behavior of the SysAid web client.
   def add_note(user, note, time = Time.now)
     # NOTE: Notes are prepended.
     new_note = "#{user} (#{time.strftime("%-m/%-d/%y %I:%M %p")}):\n   #{note}"
-    
+
     if self.notes
       self.notes = new_note + "\n=============================\n" + self.notes
     else
@@ -113,9 +113,9 @@ class SysAid::Ticket
   #   => true
   def save
     SysAid.ensure_logged_in
-    
+
     # Save it via the SOAP API
-    response = SysAid.client.call(:save, message: to_xml(false))
+    response = SysAid.call(:save, message: to_xml(false))
     if response.to_hash[:save_response][:return]
       # In the case of a new ticket, the SysAid response will be the assigned ID
       self.id = response.to_hash[:save_response][:return] unless self.id
@@ -131,17 +131,17 @@ class SysAid::Ticket
   #
   # Example:
   #   >> ticket_object.delete
-  #   => true  
+  #   => true
   def delete
     SysAid.ensure_logged_in
     
-    SysAid.client.call(:delete, message: to_xml(false))
-    
+    SysAid.call(:delete, message: to_xml(false))
+
     reset_all_attributes
   end
-  
+
   private
-  
+
   def to_xml(include_id = true)
     builder = Builder::XmlMarkup.new
 
@@ -206,7 +206,7 @@ class SysAid::Ticket
 
     xml
   end
-  
+
   # Update instance variables to match what is in response
   def set_self_from_response(response)
     self.agreement = response[:agreement]

data/lib/sysaid/user.rb

@@ -26,21 +26,15 @@ class SysAid::User
 
   # Loads the latest user information from the SysAid server
   def refresh
-    begin
-      SysAid.ensure_logged_in
-
-      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
+    SysAid.ensure_logged_in
 
-      return false
-    rescue SocketError => e
-      raise SysAidException, "Unable to fetch user information from SysAid server: #{e.message}"
-    rescue Errno::EHOSTUNREACH => e
-      raise SysAidException, "Unable to reach SysAid server, host unreachable: #{e.message}"
+    response = SysAid.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
@@ -51,16 +45,12 @@ class SysAid::User
   def save
     SysAid.ensure_logged_in
 
-    begin
-      # 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
-    rescue Savon::SOAPFault => e
-      raise SysAidException, "Unable to save user due to SOAP communications error: #{e.message}"
+    # Save it via the SOAP API
+    response = SysAid.call(:save, message: to_xml(false).to_s )
+    if response.to_hash[:save_response][:return]
+      return true
+    else
+      return false
     end
   end
 
@@ -72,7 +62,7 @@ class SysAid::User
   def delete
     SysAid.ensure_logged_in
 
-    SysAid.client.call(:delete, message: to_xml(false).to_s )
+    SysAid.call(:delete, message: to_xml(false).to_s )
   end
 
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sysaid
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Christopher Thielen
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: ruby-sysaid