em-service-now 0.3 → 0.3.1

data/em-service-now.gemspec

@@ -2,17 +2,17 @@ require 'date'
 Gem::Specification.new do |spec|
   
   spec.name = %q{em-service-now}
-  spec.version = '0.3'
+  spec.version = '0.3.1'
   spec.date = DateTime.now.strftime( "%Y-%m-%d" )
   spec.authors = ["Richard","","",""]
   spec.email = %q{ops@clue.co.za}
-  spec.summary = %q{Tools for interfacing with service-now.com}
+  spec.summary = %q{Tool for interfacing with service-now.com}
   spec.homepage = %q{https://github.com/cluetechnologies/em-service-now}
   spec.description = %q{}
-  spec.add_runtime_dependency 'eventmachine', '~> 1'
-  spec.add_runtime_dependency 'em-http-request', '~> 1'
+  spec.add_runtime_dependency 'eventmachine'
+  spec.add_runtime_dependency 'em-http-request'
   spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'yaml'
+  spec.add_runtime_dependency 'awesome_print'
   spec.files = [
     
     'em-service-now.gemspec',

data/lib/em-service-now.rb

@@ -3,20 +3,16 @@ require 'em-http-request'
 require 'json'
 require 'uri'
 require 'yaml'
+require 'csv'
 
-class ServiceNowException < Exception
-  
-end
-
-class ConfigException < Exception
+module ServiceNow
   
-end unless defined?( ConfigException )
+  class RuntimeException < Exception; end
+  class ConfigException < Exception; end
 
-module ServiceNow
-    
   def service_now_init( config, logger = nil )
     
-    @config = {} 
+    @config = {}
     @config = config unless config.nil?
     
     @logger = logger
@@ -33,8 +29,7 @@ module ServiceNow
     
     @service_now_running = false
     
-    
-    raise ::ConfigException.new(
+    raise ConfigException.new(
     
       "#{self.class} requires :url: and :username: and :password: configured."
     
@@ -50,32 +45,119 @@ module ServiceNow
     # Assumes already running inside an EM reactor
     # If not, call em_service_now
     # 
-    @inline = true
+    @service_now_inline = true
     
-    get_cookies
+    sn_get_cookies
         
   end
   
+  def em_service_now( type, query, records_array = nil, &block )
+
+    @service_now_inline = false
 
+    EM::run do
+
+      service_now( type, query, records_array, &block )
+      
+    end
+    
+  end
   
-  def em_service_now_query( query, &block )
+  def service_now( type, query, records_array = nil, &block )
+    
+    @service_now_running = true
+    
+    url = nil
+    
+    table = query['table']
     
-    @inline = false
+    case type
+      
+    when :getRecords, :getKeys, :getCSV
+      
+      return sn_query( type, query, &block )
+      
+    when :insert
 
-    EM::run do
+      url = "#{@url}/#{table}.do?JSON&sysparm_action=insertMultiple"
+      body = {
+
+        'records' => records_array
+
+      }
       
-      #
-      # Pass the block straight through.
-      #
-      service_now_query( query, &block )
+    when :update
+      
+      url = "#{@url}/#{table}.do?JSON" 
+      url="#{url}&sysparm_action=update"
+      url = sn_append_query( url, query )
+      body = records_array[0]
+      
+    else
+      
+      raise ServiceNow::RuntimeException.new(
+        
+        "no such query type '#{type}'"
+      
+      )
+      
+    end
+    
+    json_body = JSON.dump(body) 
+    
+    @logger.debug "ServiceNow URL:#{url}" unless @logger.nil?
+    
+    http = EventMachine::HttpRequest.new( url ).post(
+      
+        sn_generate_POST_request( json_body )
+      
+    )
+    
+    http.errback do
+      
+      sn_on_error( url, http, &block )
+      
+    end
+    
+    http.callback do
+      
+      if http.response_header.status == 401
+        
+        #
+        # Authentication failed 
+        #
+        sn_login_and_retry( url, json_body, &block )
+                
+      else
+      
+        sn_on_success( url, http, &block )
+      
+      end
       
     end
     
   end
   
-  def on_error( url, http, &block )
+  private
+  
+  #def em_sn_query( query, &block )
+  #  
+  #  @service_now_inline = false
+  #
+  #  EM::run do
+  #    
+  #    #
+  #    # Pass the block straight through.
+  #    #
+  #    sn_query( query, &block )
+  #    
+  #  end
+  #  
+  #end
+  
+  def sn_on_error( url, http, &block )
     
-    EM::stop unless @inline
+    EM::stop unless @service_now_inline
     
     error = "transport or http error #{http.error}"
     
@@ -88,11 +170,11 @@ module ServiceNow
   end
   
   
-  def on_success( url, http, &block )
+  def sn_on_success( url, http, &block )
     
-    store_cookies( http )
+    sn_store_cookies( http )
 
-    EM::stop unless @inline
+    EM::stop unless @service_now_inline
     
     unless http.response_header.status == 200
       
@@ -110,9 +192,9 @@ module ServiceNow
 
     end
     
-    if /do\?CSV\&/.match( url ) 
+    if /do\?CSV/.match( url ) 
       
-      parse_csv( http, &block )
+      sn_parse_csv( http, &block )
       
       @service_now_running = false
       
@@ -160,97 +242,7 @@ module ServiceNow
     
   end
   
-  def em_service_now( type, query, records_array = nil, &block )
-
-    @inline = false
-
-    EM::run do
-
-      service_now( type, query, records_array, &block )
-      
-    end
-    
-  end
-  
-  
-  def service_now( type, query, records_array = nil, &block )
-    
-    @service_now_running = true
-    
-    url = nil
-    
-    table = query['table']
-    
-    case type
-      
-    when :getRecords, :getKeys, :getCSV
-      
-      return service_now_query( type, query, &block )
-      
-    when :insert
-
-      url = "#{@url}/#{table}.do?JSON&sysparm_action=insertMultiple"
-      body = {
-
-        'records' => records_array
-
-      }
-      
-    when :update
-      
-      url = "#{@url}/#{table}.do?JSON" 
-      url="#{url}&sysparm_action=update"
-      url = append_query( url, query )
-      body = records_array[0]
-      
-    else
-      
-      raise ServiceNowException.new(
-        
-        "no such query type '#{type}'"
-      
-      )
-      
-    end
-    
-    json_body = JSON.dump(body) 
-    
-    @logger.debug "ServiceNow URL:#{url}" unless @logger.nil?
-    
-    http = EventMachine::HttpRequest.new( url ).post(
-      
-        generate_POST_request( json_body )
-      
-    )
-    
-    http.errback do
-      
-      on_error( url, http, &block )
-      
-    end
-    
-    http.callback do
-      
-      if http.response_header.status == 401
-        
-        #
-        # Authentication failed 
-        #
-        login_and_retry( url, json_body, &block )
-                
-      else
-      
-        on_success( url, http, &block )
-      
-      end
-      
-    end
-    
-  end
-  
-  private
-  
-  def get_cookies
+  def sn_get_cookies
     
     dir = Dir.getwd
     file = 'service_now.cookie'
@@ -298,7 +290,7 @@ module ServiceNow
     
   end
   
-  def store_cookies( http )
+  def sn_store_cookies( http )
     
     #
     # Only store cookies if JSESSIONID is in [0]'th cookie
@@ -309,6 +301,9 @@ module ServiceNow
     #
     #     Effectively making the session cookie only work once.
     #
+    # I.show http
+    
+    return if http.response_header["SET_COOKIE"].nil?
     
     return unless /^JSESSIONID/.match( http.response_header["SET_COOKIE"][0] )
     
@@ -326,9 +321,7 @@ module ServiceNow
     
   end
   
-  def parse_csv( http, &block )
-    
-    require 'csv'
+  def sn_parse_csv( http, &block )
     
     headings = nil
     
@@ -359,12 +352,22 @@ module ServiceNow
     
   end
   
-  def append_csv_query( url, query )
+  def sn_append_csv_query( url, query )
     
-    url = "#{url}&" unless query['where'].nil?
+    url = "#{url}&sysparm_query=" unless query['where'].nil?
     
     query['where'].each do |field, value|
       
+      if field == 'jvar_report_id'
+        
+        #
+        # dont specify query if fetching 
+        # a configured report
+        #
+        url.gsub!('sysparm_query=','')
+        
+      end
+      
       if /^\=/.match( value )
         url = "#{url}#{field}#{value[1..-1]}^"
 
@@ -384,7 +387,7 @@ module ServiceNow
     
   end
   
-  def append_query( url, query )
+  def sn_append_query( url, query )
     
     url = "#{url}&sysparm_query=" unless query['where'].nil?
     
@@ -410,7 +413,7 @@ module ServiceNow
     
   end
   
-  def generate_GET_request
+  def sn_generate_GET_request
     
     return \
       :connect_timeout => @connect_timeout,
@@ -434,7 +437,7 @@ module ServiceNow
     
   end
   
-  def generate_POST_request( body )
+  def sn_generate_POST_request( body )
     
     return \
       :connect_timeout => @connect_timeout,
@@ -461,14 +464,14 @@ module ServiceNow
     
   end
   
-  def service_now_query( type, query, &block )
+  def sn_query( type, query, &block )
     
     result = []
     error = nil
     
     table = query['table']
     
-    if query['where'].nil? and type == :select
+    if query['where'].nil? and type == :getRecords
     
       @logger.warn( "WARNING! No 'where' clause! - Use :selectKeys on large dataset, SNOW might return only a subset of the result" )
       
@@ -479,17 +482,17 @@ module ServiceNow
     when :getKeys
       
       url = "#{@url}/#{table}.do?JSON&sysparm_action=getKeys"
-      url = append_query( url, query )
+      url = sn_append_query( url, query )
       
     when :getRecords
       
       url = "#{@url}/#{table}.do?JSON&sysparm_action=getRecords"
-      url = append_query( url, query )
+      url = sn_append_query( url, query )
       
     when :getCSV
       
       url = "#{@url}/#{table}.do?CSV"
-      url = append_csv_query( url, query )
+      url = sn_append_csv_query( url, query )
 
     end
     
@@ -497,13 +500,13 @@ module ServiceNow
     
     http = EventMachine::HttpRequest.new( url ).get(
       
-        generate_GET_request
+        sn_generate_GET_request
       
     )
     
     http.errback do
       
-      on_error( url, http, &block )
+      sn_on_error( url, http, &block )
       
     end
     
@@ -514,11 +517,11 @@ module ServiceNow
         #
         # Authentication failed 
         #
-        login_and_retry( url, &block )
+        sn_login_and_retry( url, &block )
                 
       else
       
-        on_success( url, http, &block )
+        sn_on_success( url, http, &block )
       
       end
       
@@ -526,7 +529,7 @@ module ServiceNow
     
   end
   
-  def login_and_retry( url, body = nil, &block )
+  def sn_login_and_retry( url, body = nil, &block )
     
     @logger.warn "#{self.class} creating new session"
     
@@ -542,7 +545,7 @@ module ServiceNow
       
       http = EventMachine::HttpRequest.new( url ).get(
       
-          generate_GET_request
+          sn_generate_GET_request
       
       )
       
@@ -550,7 +553,7 @@ module ServiceNow
       
       http = EventMachine::HttpRequest.new( url ).post(
       
-          generate_POST_request( body )
+          sn_generate_POST_request( body )
       
       )
       
@@ -558,16 +561,30 @@ module ServiceNow
     
     http.errback do
       
-      on_error( url, http, &block )
+      sn_on_error( url, http, &block )
       
     end
     
     http.callback do
       
-      on_success( url, http, &block )
+      sn_on_success( url, http, &block )
       
     end
     
   end
   
 end
+
+#
+# quick hack to show variable contents
+#
+class I
+   
+  def self.show( var )
+  
+    require 'awesome_print'
+    ap var
+  
+  end
+
+end unless defined?( I )

data/lib/version.rb

@@ -1,5 +1,5 @@
 module ServiceNow
   
-  Version = VERSION = '0.3'
+  Version = VERSION = '0.3.1'
   
 end

data/spec/em-service-now_spec.rb

@@ -39,7 +39,7 @@ describe ServiceNow do
     
     }.to raise_error(
     
-      ConfigException,
+      ServiceNow::ConfigException,
       
       /requires :url: and :username: and :password: configured/
     
@@ -68,6 +68,22 @@ describe ServiceNow do
     
   end
 
+  it 'errors on invalid query type' do
+    
+    expect {
+      
+      subject.em_service_now( :noSuch, {} )
+    
+    }.to raise_error(
+    
+      ServiceNow::RuntimeException,
+      
+      /no such query type/
+    
+    )
+    
+  end
+
   context 'can query/insert/update' do
     
     before :each do
@@ -147,6 +163,111 @@ describe ServiceNow do
       
     end
     
+    it 'supports getCSV with query' do
+      
+      query = {
+        
+        'table'  => 'table',
+        'where' => {
+          
+          'column1' => 'value1',
+          'column2' => 'value2'
+          
+        }
+        
+      }
+      
+      @http_request.should_receive(
+      
+        :get
+      
+      ).with({
+      
+          :connect_timeout => 60,
+          :timeout => 120,
+          :head => { 
+            
+            "Content-Type" => "application/json",
+            "cookie" => @cookies
+            
+          },
+      
+      }).and_return(
+      
+        @http_request
+      
+      )
+      
+      EventMachine::HttpRequest.should_receive(
+      
+        :new
+      
+      ).with(
+      
+        "#{@url}/table.do?CSV&sysparm_query=column1=value1%5Ecolumn2=value2"
+      
+      ).and_return(
+      
+        @http_request
+      
+      )
+      
+      subject.service_now( :getCSV, query )
+      
+    end
+    
+    it 'supports getCSV report' do
+      
+      query = {
+        
+        'table'  => 'sys_report_template',
+        'where' => {
+          
+          'jvar_report_id' => '__REPORT_SYS_ID___'
+          
+        }
+        
+      }
+      
+      @http_request.should_receive(
+      
+        :get
+      
+      ).with({
+      
+          :connect_timeout => 60,
+          :timeout => 120,
+          :head => { 
+            
+            "Content-Type" => "application/json",
+            "cookie" => @cookies
+            
+          },
+      
+      }).and_return(
+      
+        @http_request
+      
+      )
+      
+      EventMachine::HttpRequest.should_receive(
+      
+        :new
+      
+      ).with(
+      
+        "#{@url}/sys_report_template.do?CSV&jvar_report_id=__REPORT_SYS_ID___"
+      
+      ).and_return(
+      
+        @http_request
+      
+      )
+      
+      subject.service_now( :getCSV, query )
+      
+    end  
+    
     it 'supports special query things' do
       
       query = {

data/spec/functional_spec.rb

@@ -4,21 +4,20 @@ describe ServiceNow do
   
   subject {
     
-    LOG.on
+    LOG.off
     subj = Object.extend( ServiceNow )
     subj.service_now_init( CONFIG['config'], LOG )
     subj
     
   }
   
-  pending 'can get by CSV interface' do
+  it 'can get by CSV interface' do
     
     query = CONFIG['queries']['get_specific_report']
     
     result = []
     subject.em_service_now( :getCSV, query ) do |record, error|
       
-      
       result << record unless record.nil?
       
     end
@@ -27,7 +26,24 @@ describe ServiceNow do
     
   end
   
-  pending 'can get by JSON interface' do
+  it 'can getKeys by JSON interface' do
+    
+    sys_id = nil
+    
+    query = CONFIG['queries']['get_specific_company']
+    expectation = CONFIG['queries']['get_specific_company_sys_id']
+    
+    subject.em_service_now( :getKeys, query ) do |record, status|
+    
+      sys_id = record
+    
+    end
+    
+    sys_id.should == expectation
+    
+  end
+  
+  it 'can getRecords by JSON interface' do
     
     company = nil
     
@@ -44,7 +60,7 @@ describe ServiceNow do
     
   end
   
-  pending 'errors on invalid table name' do
+  it 'errors on invalid table name' do
 
     result = nil
     
@@ -65,7 +81,7 @@ describe ServiceNow do
     
   end
   
-  pending 'can create an incident' do
+  it 'can create an incident' do
 
     query = {
       
@@ -83,7 +99,7 @@ describe ServiceNow do
     
   end
   
-  pending 'can update incidents by company, short_description and status' do
+  it 'can update incidents by company, short_description and status' do
     
     update_column = CONFIG['incident']['update']['column']
     update_value = CONFIG['incident']['update']['value']
@@ -121,7 +137,7 @@ describe ServiceNow do
   end
   
   
-  pending 'can close incidents by company, short_description and status' do
+  it 'can close incidents by company, short_description and status' do
     
     query = {
       

data/spec/spec_config.yml.tmpl

@@ -18,6 +18,7 @@ queries:
             jvar_report_id: 5896e8a30c16a00087c61678d080f220
     
     get_specific_company_expectation: COMPANY NAME
+    get_specific_company_sys_id: 5fac1edc0a0a3c1e00ccdb50799bcec1
     get_specific_company:
         table: core_company
         where:

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
 require 'em-service-now'
+# :stopdoc:
 
+#
+# service_now_init() takes a config Hash
+# (this loads it)
+# 
 SPEC_CONFIG_FILE = "#{File.dirname( __FILE__ )}/spec_config.yml"
-
 CONFIG = YAML.load_file( 
 
   SPEC_CONFIG_FILE
@@ -9,6 +13,10 @@ CONFIG = YAML.load_file(
 ) if File.file?( SPEC_CONFIG_FILE )
 CONFIG = {} unless defined?( CONFIG )
 
+#
+# service_now_init() takes a generic logger
+# (this creates a fake one)
+# 
 class FakeLogger
   
   def initialize( parameter = :noisey )
@@ -41,3 +49,5 @@ class FakeLogger
 end
 
 LOG = FakeLogger.new
+
+# :startdoc:

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: em-service-now
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  version: "0.3"
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Richard
@@ -17,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-22 00:00:00 Z
+date: 2012-06-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
@@ -25,12 +26,12 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 3
         segments: 
-        - 1
-        version: "1"
+        - 0
+        version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -39,12 +40,12 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 3
         segments: 
-        - 1
-        version: "1"
+        - 0
+        version: "0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -62,7 +63,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: yaml
+  name: awesome_print
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -123,6 +124,6 @@ rubyforge_project:
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Tools for interfacing with service-now.com
+summary: Tool for interfacing with service-now.com
 test_files: []