rs_service_now 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 nemski
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# RsServiceNow
+
+A Ruby Soap ServiceNow interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rs_service_now'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rs_service_now
+
+## Usage
+
+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.
+
+# 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"
+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.
+sn.export :encoded_query => "active=true"
+
+## Contributing
+
+1. Fork it ( https://github.com/nemski/rs_service_now/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rs_service_now.rb

@@ -0,0 +1,7 @@
+require "rs_service_now/version"
+require "rs_service_now/record"
+require "rs_service_now/company"
+
+module RsServiceNow
+
+end

data/lib/rs_service_now/ci.rb

@@ -0,0 +1,11 @@
+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
+end

data/lib/rs_service_now/company.rb

@@ -0,0 +1,11 @@
+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
+end

data/lib/rs_service_now/record.rb

@@ -0,0 +1,78 @@
+require 'savon'
+require 'open-uri'
+require 'active_support/core_ext/hash/conversions'
+
+class RsServiceNow::Record
+
+  def initialize user, password, instance
+    @user = user
+    @password = password
+    @url = "https://#{instance}.service-now.com"
+  end
+
+  def _request table, encoded_query
+    client = setup_client table
+    num_entries = get_keys(client, encoded_query)[:count].to_i
+    index = 0
+    result = []
+
+    while index < num_entries
+      response = client.call(:get_records, :message => {:__encoded_query => encoded_query, :__first_row => index, :__last_row => (index + 250)})
+      index = index + 250
+
+      records = response.hash[:envelope][:body][:get_records_response][:get_records_result]
+      if records.is_a? Array
+        result.push *records
+      else
+        result.push records
+      end
+    end
+
+    result
+  end
+
+  def _export table, encoded_query, max_export
+    client = setup_client table
+    get_keys_result = get_keys(client, encoded_query)
+    num_entries = get_keys_result[:count].to_i
+    keys = get_keys_result[:sys_id].split(/,/)
+    index = 0
+    export = []
+
+    while index < num_entries
+      # Use a URL to retrieve an XML export as documented at http://wiki.servicenow.com/index.php?title=Exporting_Data
+      xml = open("#{@url}/#{table}.do?XML&" +
+                         "sysparm_order_by=sys_id&" +
+                         "sysparm_query=#{CGI.escape(encoded_query + '^')}" +
+                         "sys_id#{CGI.escape('>=') + keys[index]}&" +
+                         "sysparm_record_count=#{max_export}",
+                     :http_basic_authentication => [@user, @password]
+        ).read
+
+      records = Hash.from_xml(xml)["xml"][table]
+      if records.is_a? Array
+        export.push *records
+      else
+        export.push records
+      end
+
+      index = index + max_export
+    end
+
+    export
+  end
+
+  def get_keys client, encoded_query
+    response = client.call(:get_keys, :message => {:__encoded_query => encoded_query, :__order_by => "sys_id"})
+    response.hash[:envelope][:body][:get_keys_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
+    end
+  end
+end

data/lib/rs_service_now/version.rb

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

data/rs_service_now.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rs_service_now/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rs_service_now"
+  spec.version       = RsServiceNow::VERSION
+  spec.authors       = ["nemski"]
+  spec.email         = ["nemski.rabbit@gmail.com"]
+  spec.summary       = %q{A Ruby Soap ServiceNow interface.}
+  spec.description   = %q{A library for exporting data from ServiceNow}
+  spec.homepage      = "https://github.com/nemski/rs_service_now"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "savon", "~> 2.0"
+  spec.add_runtime_dependency "activesupport"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rs_service_now
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- nemski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library for exporting data from ServiceNow
+email:
+- nemski.rabbit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rs_service_now.rb
+- lib/rs_service_now/ci.rb
+- lib/rs_service_now/company.rb
+- lib/rs_service_now/record.rb
+- lib/rs_service_now/version.rb
+- rs_service_now.gemspec
+homepage: https://github.com/nemski/rs_service_now
+licenses:
+- BSD
+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
+signing_key: 
+specification_version: 3
+summary: A Ruby Soap ServiceNow interface.
+test_files: []