rs_service_now 0.0.1 → 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWJmYzg5NDk1NTdjMjdkMzBmZmIyYWU2Zjg0YjU5ZjkyMDU1ZTlmMg==
+  data.tar.gz: !binary |-
+    YjllMTMwMjc2ZmM2ZmI2ZTg2MjRmMjhkYWM1MTk3YjhlZTgyZjkzYQ==
+SHA512:
+  metadata.gz: !binary |-
+    NjlkNjAzZTExMDNlNzZmOWQ4ZGI3ZDY5M2M4NWE4NmRlMWU5ZDQyNWZlYjg5
+    YjkzNjYzNDAzYTRkM2EzNGNiNGRmODcwMjc1ODE3MGI3NmI3OTY5YWQ4MmVi
+    OGY3MDA3NDk4NzJhMTBkMDc5NGI3MzIwZDMyY2QxZDdkMGMxNTc=
+  data.tar.gz: !binary |-
+    NmQzNzM1OWVjN2JiN2IwZjdkZTU0MDBlMTI3OGZiNzZlODg4OWMyODhjNjM5
+    YTMxMjljM2ZmMTRkZmZkNmVkNjQ2M2QzOGNhMjhhYTdiMWJkZGI2Njk0MmU0
+    ZjAyNzdhN2JiYWFjNTRiMmRkN2Q3ODM4ODkxYzcwOTA5NWRjNjI=

data/.gitignore

@@ -1,14 +1,16 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log
+/.idea

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rs_service_now.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rs_service_now.gemspec
+gemspec

data/README.md

@@ -20,17 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
+```ruby
 sn = RsServiceNow::Company.new user, password, instance
+```
 
 ### Retrieve
-# Get every field from matching records. This is a quick way to retrieve any number of records, 250 at a time.
+Get every field from matching records. This is a quick way to retrieve any number of records, 250 at a time.
 
-# Using an encodedQuery. This can be easily retrieved by conducting a search in Service-Now, right clicking the very end of the search string and selecting "Copy query"
+Using an encodedQuery. This can be easily retrieved by conducting a search in Service-Now, right clicking the very end of the search string and selecting "Copy query"
+
+```ruby
 sn.request :encoded_query => "active=true"
+```
 
 ### Export
-# Retrieve a data export from Service-Now. Should be more efficient than Retrieve as by default it can export 10000 records at a time, instead of 250.
+Retrieve a data export from Service-Now. Should be more efficient than Retrieve as by default it can export 10000 records at a time, instead of 250. This is experimental at the moment that has not been thoroughly tested.
+
+```ruby
 sn.export :encoded_query => "active=true"
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,11 @@
-require "bundler/gem_tasks"
-
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run the tests"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color', '-f d']
+  t.pattern = 'spec/*/*_spec.rb'
+end
+
+
+task :default => [:spec_prep, :spec, :spec_clean]

data/lib/rs_service_now.rb

@@ -1,7 +1,7 @@
-require "rs_service_now/version"
-require "rs_service_now/record"
-require "rs_service_now/company"
-
-module RsServiceNow
-
-end
+[ 'version', 'record', 'common', 'company', 'ci' ].each do |file|
+  require "rs_service_now/#{file}"
+end
+
+module RsServiceNow
+
+end

data/lib/rs_service_now/ci.rb

@@ -1,11 +1,3 @@
-class RsServiceNow::Ci < RsServiceNow::Record
-  TABLE = 'cmdb_ci'
-
-  def request encoded_query
-    self._request TABLE, encoded_query
-  end
-
-  def export encoded_query, max_export = 10000
-    self._export TABLE, encoded_query, max_export
-  end
+class RsServiceNow::Ci < RsServiceNow::Common
+  create_methods 'cmdb_ci'
 end

data/lib/rs_service_now/common.rb

@@ -0,0 +1,23 @@
+class RsServiceNow::Common < RsServiceNow::Record
+  def self.create_methods table
+    define_method('get') do |sys_id|
+      self._get table, sys_id
+    end
+
+    define_method('export') do |encoded_query, max_export = 10000|
+      self._export table, encoded_query, max_export
+    end
+
+    define_method('request') do |encoded_query|
+      self._request table, encoded_query
+    end
+
+    define_method('insert') do |parameters|
+      self._insert table, parameters
+    end
+
+    define_method('update') do |parameters|
+      self._update table, parameters
+    end
+  end
+end

data/lib/rs_service_now/company.rb

@@ -1,11 +1,3 @@
-class RsServiceNow::Company < RsServiceNow::Record
-  TABLE = 'core_company'
-
-  def request encoded_query
-    self._request TABLE, encoded_query
-  end
-
-  def export encoded_query, max_export = 10000
-    self._export TABLE, encoded_query, max_export
-  end
+class RsServiceNow::Company < RsServiceNow::Common
+  create_methods 'core_company'
 end

data/lib/rs_service_now/record.rb

@@ -4,10 +4,11 @@ require 'active_support/core_ext/hash/conversions'
 
 class RsServiceNow::Record
 
-  def initialize user, password, instance
+  def initialize user, password, instance, proxy = nil
     @user = user
     @password = password
     @url = "https://#{instance}.service-now.com"
+    @proxy = proxy
   end
 
   def _request table, encoded_query
@@ -67,12 +68,36 @@ class RsServiceNow::Record
     response.hash[:envelope][:body][:get_keys_response]
   end
 
+  def _get table, sys_id
+    client = setup_client table
+    response = client.call(:get, :message => {:sys_id => sys_id})
+    response.hash[:envelope][:body][:get_response]
+  end
+
   def setup_client table
     Savon.client do |globals|
       globals.wsdl "#{@url}/#{table}.do?WSDL"
       globals.basic_auth [@user, @password]
       globals.convert_request_keys_to :none
       globals.namespace_identifier :u
+      if @proxy
+        globals.proxy @proxy
+      end
+    end
+  end
+
+  def _insert table, parameters
+    client = setup_client table
+    response = client.call(:insert, :message => parameters)
+    response.hash[:envelope][:body][:insert_response][:sys_id]
+  end
+
+  def _update table, parameters
+    if parameters[:sys_id].nil?
+      raise "You must supply the sys_id of the record to update"
     end
+
+    client = setup_client table
+    client.call(:update, :message => parameters)
   end
 end

data/lib/rs_service_now/version.rb

@@ -1,3 +1,3 @@
 module RsServiceNow
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/spec/helpers.rb

@@ -0,0 +1,142 @@
+require 'nokogiri'
+
+module ServiceNowHelpers
+  def make_multiple_xml start, max_export
+    xml_doc = Nokogiri::XML(make_record_xml)
+    index_array = (start..(max_export - 1)).to_a
+    (index_array.length - 1).times do |num|
+      xml_doc.at('core_company').add_next_sibling(xml_doc.at('core_company').dup)
+    end
+
+    xml_doc.xpath('//xml/core_company/sys_id').each_with_index do |id, index|
+      id.children = "deadbeefdeadbeefdeadbeefdead#{index_array[index]}"
+    end
+
+    xml_doc.to_xml
+  end
+
+  def make_record_xml
+    <<EOF
+<xml>
+<core_company>
+<apple_icon/>
+<banner_image/>
+<banner_text></banner_text>
+<city/>
+<color_scheme/>
+<contact/>
+<country/>
+<customer>true</customer>
+<discount/>
+<fax_phone/>
+<fiscal_year/>
+<lat_long_error/>
+<latitude/>
+<longitude/>
+<manufacturer>false</manufacturer>
+<market_cap>0</market_cap>
+<name>ACME</name>
+<num_employees/>
+<parent/>
+<phone/>
+<primary>false</primary>
+<profits>0</profits>
+<publicly_traded>false</publicly_traded>
+<rank_tier/>
+<revenue_per_year>0</revenue_per_year>
+<state/>
+<stock_price/>
+<stock_symbol/>
+<street/>
+<sys_created_by>acme_administrator</sys_created_by>
+<sys_created_on>2015-02-01 22:52:00</sys_created_on>
+<sys_domain_number>3.14</sys_domain_number>
+<sys_id>deadbeefdeadbeefdeadbeefdeadbeef</sys_id>
+<sys_mod_count>28</sys_mod_count>
+<sys_updated_by>acme_administrator</sys_updated_by>
+<sys_updated_on>2015-02-01 22:52:00</sys_updated_on>
+<theme/>
+<vendor>false</vendor>
+<vendor_manager/>
+<vendor_type/>
+<website/>
+<zip/>
+</core_company>
+</xml>
+EOF
+  end
+
+  def make_record_hash suffix = "beef"
+    {
+      "apple_icon"=>nil,
+      "banner_image"=>nil,
+      "banner_text"=>nil,
+      "city"=>nil,
+      "color_scheme"=>nil,
+      "contact"=>nil,
+      "country"=>nil,
+      "customer"=>"true",
+      "discount"=>nil,
+      "fax_phone"=>nil,
+      "fiscal_year"=>nil,
+      "lat_long_error"=>nil,
+      "latitude"=>nil,
+      "longitude"=>nil,
+      "manufacturer"=>"false",
+      "market_cap"=>"0",
+      "name"=>"ACME",
+      "num_employees"=>nil,
+      "parent"=>nil,
+      "phone"=>nil,
+      "primary"=>"false",
+      "profits"=>"0",
+      "publicly_traded"=>"false",
+      "rank_tier"=>nil,
+      "revenue_per_year"=>"0",
+      "state"=>nil,
+      "stock_price"=>nil,
+      "stock_symbol"=>nil,
+      "street"=>nil,
+      "sys_created_by"=>"acme_administrator",
+      "sys_created_on"=>"2015-02-01 22:52:00",
+      "sys_domain_number"=>"3.14",
+      "sys_id"=>"deadbeefdeadbeefdeadbeefdead#{suffix}",
+      "sys_mod_count"=>"28",
+      "sys_updated_by"=>"acme_administrator",
+      "sys_updated_on"=>"2015-02-01 22:52:00",
+      "theme"=>nil,
+      "vendor"=>"false",
+      "vendor_manager"=>nil,
+      "vendor_type"=>nil,
+      "website"=>nil,
+      "zip"=>nil
+    }
+  end
+
+  def make_insert_response_xml
+    <<EOF
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inc="http://www.service-now.com/incident">
+   <soapenv:Header/>
+   <soapenv:Body>
+      <inc:insertResponse>
+         <inc:sys_id>deadbeefdeadbeefdeadbeefdeadbeef</inc:sys_id>
+         <inc:number>1</inc:number>
+      </inc:insertResponse>
+   </soapenv:Body>
+</soapenv:Envelope>
+EOF
+  end
+
+  def make_insert_response_hash
+    { 
+      :envelope => { 
+        :body => { 
+          :insert_response => {
+            :sys_id => "deadbeefdeadbeefdeadbeefdeadbeef",
+            :number => 1,
+          }
+        }
+      }
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rs_service_now'
+require 'rspec/mocks'
+require 'helpers'
+
+RSpec.configure do |config|
+  config.include ServiceNowHelpers
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

data/spec/unit/records_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+module RsServiceNow
+  describe Record do
+    let(:subject) { RsServiceNow::Record.new "user", "supersekrit", "reporting" }
+    let(:max_export) { 100 }
+    let(:single_record_hash) { make_record_hash }
+    let(:single_record_xml) { make_record_xml }
+    let(:encoded_query) { 'active=true' }
+
+    describe '#_request' do
+      let(:dummy_client) { Object.new }
+      let(:dummy_response) { Object.new }
+      let(:multi_record_hash) { (0..251).collect { single_record_hash } }
+
+      before :each do
+        allow( subject ).to receive(:setup_client).and_return(dummy_client)
+      end
+
+      context 'single result' do
+        let(:dummy_response_hash) { {:envelope => {:body => {:get_records_response => {:get_records_result => single_record_hash } } } } }
+
+        before :each do
+          allow( subject ).to receive(:get_keys).and_return({:count => "1"})
+          allow( dummy_response ).to receive(:hash).and_return(dummy_response_hash)
+          allow( dummy_client ).to receive(:call).and_return(dummy_response)
+        end
+
+        it 'should return an array with one hash' do
+          expect( subject._request 'core_company', encoded_query ).to be == [single_record_hash]
+        end
+      end
+
+      context 'multiple results' do
+        let(:dummy_response_hash) { {:envelope => {:body => {:get_records_response => {:get_records_result => multi_record_hash } } } } }
+
+        before :each do
+          allow( subject ).to receive(:get_keys).and_return({:count => "251"})
+          allow( dummy_response ).to receive(:hash).and_return(dummy_response_hash)
+          allow( dummy_client ).to receive(:call).and_return(dummy_response)
+        end
+
+        it 'should get records 250 at a time' do
+          expect( dummy_client ).to receive(:call).with(:get_records, :message => {:__encoded_query => encoded_query, :__first_row => 0, :__last_row => 250}).ordered
+          expect( dummy_client ).to receive(:call).with(:get_records, :message => {:__encoded_query => encoded_query, :__first_row => 250, :__last_row => 500}).ordered
+
+          subject._request 'core_company', encoded_query
+        end
+
+        it 'should return an array of hashes containing each entry' do
+          expect( subject._request 'core_company', encoded_query ) == [multi_record_hash]
+        end
+      end
+
+    end
+
+    describe '#_export' do
+      let(:dummy_open) { Object.new }
+      let(:multi_record_hash) { (0..251).map { |n| make_record_hash n } }
+
+      context 'single result' do
+        let(:export_url) { "https://reporting.service-now.com/core_company.do?XML&sysparm_order_by=sys_id&sysparm_query=#{CGI.escape(encoded_query + '^')}sys_id#{CGI.escape('>=') + "deadbeefdeadbeefdeadbeefdeadbeef"}&sysparm_record_count=#{max_export}" }
+
+        before :each do
+          allow( subject ).to receive(:get_keys).and_return({:count => "1", :sys_id => "deadbeefdeadbeefdeadbeefdeadbeef"})
+        end
+
+        it 'should use the first sys_id in the first query' do
+          expect( subject ).to receive(:open).with(
+                                  export_url,
+                                  :http_basic_authentication => ["user", "supersekrit"]
+                               ).and_return(dummy_open)
+          allow( dummy_open ).to receive(:read).and_return(single_record_xml)
+
+          subject._export 'core_company', encoded_query, max_export
+        end
+
+        it 'should return an array with one hash' do
+          allow( subject ).to receive(:open).and_return(dummy_open)
+          allow( dummy_open ).to receive(:read).and_return(single_record_xml)
+          expect( subject._export 'core_company', encoded_query, max_export ).to be == [single_record_hash]
+        end
+      end
+
+      context 'multiple results' do
+        let(:multi_xml_return0) { make_multiple_xml 0, 100 }
+        let(:multi_xml_return1) { make_multiple_xml 100, 200 }
+        let(:multi_xml_return2) { make_multiple_xml 200, 252 }
+        let(:sys_ids) { (0..299).map { |num| "deadbeefdeadbeefdeadbeefdead#{num}" }.join(',') }
+        let(:export_url0) { "https://reporting.service-now.com/core_company.do?XML&sysparm_order_by=sys_id&sysparm_query=#{CGI.escape(encoded_query + '^')}sys_id#{CGI.escape('>=') + "deadbeefdeadbeefdeadbeefdead0"}&sysparm_record_count=#{max_export}" }
+        let(:export_url1) { "https://reporting.service-now.com/core_company.do?XML&sysparm_order_by=sys_id&sysparm_query=#{CGI.escape(encoded_query + '^')}sys_id#{CGI.escape('>=') + "deadbeefdeadbeefdeadbeefdead100"}&sysparm_record_count=#{max_export}" }
+        let(:export_url2) { "https://reporting.service-now.com/core_company.do?XML&sysparm_order_by=sys_id&sysparm_query=#{CGI.escape(encoded_query + '^')}sys_id#{CGI.escape('>=') + "deadbeefdeadbeefdeadbeefdead200"}&sysparm_record_count=#{max_export}" }
+
+        before :each do
+          allow( subject ).to receive(:get_keys).and_return({:count => "251", :sys_id => sys_ids})
+
+        end
+
+        it 'should get records 100 at a time using sys_ids as the index' do
+          expect( subject ).to receive(:open).with(export_url0, :http_basic_authentication => ["user", "supersekrit"]).and_return(dummy_open)
+          expect( subject ).to receive(:open).with(export_url1, :http_basic_authentication => ["user", "supersekrit"]).and_return(dummy_open)
+          expect( subject ).to receive(:open).with(export_url2, :http_basic_authentication => ["user", "supersekrit"]).and_return(dummy_open)
+          allow( dummy_open ).to receive(:read).and_return(multi_xml_return0, multi_xml_return1, multi_xml_return2)
+          subject._export 'core_company', encoded_query, max_export
+        end
+
+        it 'should parse the xml and return an array of hashes' do
+          allow( subject ).to receive(:open).and_return(dummy_open)
+          allow( dummy_open ).to receive(:read).and_return(multi_xml_return0, multi_xml_return1, multi_xml_return2)
+          expect( subject._export 'core_company', encoded_query, max_export ).to be == multi_record_hash
+        end
+      end
+
+    end
+
+    describe '#get' do
+      let(:dummy_client) { Object.new }
+      let(:dummy_response) { Object.new }
+      let(:get_response) { make_record_hash }
+      let(:dummy_response_hash) { {:envelope => {:body => {:get_response => get_response } } } }
+      let(:sys_id) { "deadbeefdeadbeefdeadbeefdeadbeef" }
+
+      before :each do
+        allow( subject ).to receive(:setup_client).and_return(dummy_client)
+        allow( dummy_response ).to receive(:hash).and_return(dummy_response_hash)
+        allow( dummy_client ).to receive(:call).and_return(dummy_response)
+      end
+
+      it 'should return a hash' do
+        expect( dummy_client ).to receive(:call).with(:get, :message => {:sys_id => sys_id})
+
+        expect( subject._get("core_company", sys_id) ).to be == get_response
+      end
+    end
+
+    describe '#_insert' do
+      let(:dummy_client) { Object.new }
+      let(:dummy_response) { Object.new }
+      let(:insert_response) { make_insert_response_hash }
+      let(:insert_request) { 
+        {
+          :active => true,
+          :assigned_to => "me",
+          :cmdb_ci => "router1",
+          :severity => 1,
+          :urgency => 1,
+        }
+      }
+
+      before :each do
+        allow( subject ).to receive(:setup_client).and_return(dummy_client)
+        allow( dummy_response ).to receive(:hash).and_return(insert_response)
+        allow( dummy_client ).to receive(:call).and_return(dummy_response)
+      end
+
+      it 'should return a sys_id' do
+        expect( dummy_client ).to receive(:call).with(:insert, :message => insert_request)
+
+        expect( subject._insert("incident", insert_request) ).to be == "deadbeefdeadbeefdeadbeefdeadbeef"
+      end
+    end
+
+    describe '#_update' do
+            let(:dummy_client) { Object.new }
+      let(:dummy_response) { Object.new }
+      let(:update_response) { make_insert_response_hash }
+      let(:update_request) { 
+        {
+          :active => true,
+        }
+      }
+
+      before :each do
+        allow( subject ).to receive(:setup_client).and_return(dummy_client)
+        allow( dummy_response ).to receive(:hash).and_return(update_response)
+        allow( dummy_client ).to receive(:call).and_return(dummy_response)
+      end
+
+      it 'should update the record' do
+        expect( dummy_client ).to receive(:call).with(:insert, :message => update_request)
+        subject._insert("incident", update_request)
+      end
+    end
+
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: rs_service_now
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - nemski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -89,33 +80,40 @@ files:
 - Rakefile
 - lib/rs_service_now.rb
 - lib/rs_service_now/ci.rb
+- lib/rs_service_now/common.rb
 - lib/rs_service_now/company.rb
 - lib/rs_service_now/record.rb
 - lib/rs_service_now/version.rb
 - rs_service_now.gemspec
+- spec/helpers.rb
+- spec/spec_helper.rb
+- spec/unit/records_spec.rb
 homepage: https://github.com/nemski/rs_service_now
 licenses:
 - BSD
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.28
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby Soap ServiceNow interface.
-test_files: []
+test_files:
+- spec/helpers.rb
+- spec/spec_helper.rb
+- spec/unit/records_spec.rb
+has_rdoc: