service_now 0.0.2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+InstalledFiles
+coverage
+doc/
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Yale Student Technology Collaborative
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 hengchu
+
+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,34 @@
+# ServiceNow
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'service_now'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service_now
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+=======
+service_now
+===========
+
+A gem to interface with Service Now

data/Rakefile

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

data/lib/classes/configuration.rb

@@ -0,0 +1,44 @@
+module ServiceNow
+    class Configuration
+
+        def self.configure(auth_hash = {})
+            $root_url = auth_hash[:sn_url].sub(/(\/)+$/, '') #remove trailing slash if there are any
+            $username = auth_hash[:sn_username]
+            $password = auth_hash[:sn_password]
+            "SN::Success: Configuration successful"
+        end
+
+        def self.get_resource(query_hash = {}, displayvalue = false, table)
+            # to be filled in
+            RestClient::Resource.new(URI.escape($root_url + "/#{table}.do?JSON&sysparm_action=getRecords&sysparm_query=#{hash_to_query(query_hash)}&displayvalue=#{displayvalue}"), $username, $password)
+        end
+
+        def self.post_resource(table)
+            RestClient::Resource.new(URI.escape($root_url + "/#{table}.do?JSON&sysparm_action=insert"), $username, $password)
+        end
+
+        def self.update_resource(incident_number, table)
+           RestClient::Resource.new(URI.escape($root_url + "/#{table}.do?JSON&sysparm_query=number=#{incident_number}&sysparm_action=update"), $username, $password) 
+        end
+
+        private
+            def self.hash_to_query(query_hash = {})
+                if query_hash.empty?
+                    return ""
+                end
+                query_string = []
+                query_hash.each do |k, v|
+                    key_str = k.to_s
+                    value_str = v.to_s
+                    # if we are querying based on short_description or description
+                    # we use a partial match
+                    if key_str == "short_description" || key_str == "description"
+                        query_string << key_str + "LIKE" + value_str
+                    else
+                        query_string << key_str + "=" + value_str
+                    end
+                end
+                query_string.join('^')
+            end
+    end
+end

data/lib/classes/incident.rb

@@ -0,0 +1,105 @@
+module ServiceNow
+    class Incident
+
+        def inspect
+            @attributes.each do |k, v|
+                puts "#{k} => #{v}"
+            end
+        end
+
+        def initialize(attributes = {}, saved_on_sn = false, internal_call = false)
+            Incident.check_configuration
+            symbolized_attributes = Hash[attributes.map{|k, v| [k.to_sym, v]}]
+            if !symbolized_attributes[:number].nil? && !internal_call # allow setting INC number if it's called internally
+                raise "SN::ERROR: You are not allowed to set INC Number manually, the server will take care of that"
+            end
+            @attributes = symbolized_attributes
+            @saved_on_sn = saved_on_sn
+        end
+ 
+        def attributes
+            @attributes
+        end
+
+        def client # must be used only when displayvable is false
+            return User.find_by_sys_id(self.caller_id)
+        end
+
+        def method_missing(method, args = nil)
+            method_name = method.to_s
+            if match = method_name.match(/(.*)=/) # writer method
+                attribute = match[1]
+                if attribute == "number" && @saved_on_sn
+                    raise "SN::ERROR: You are not allowed to set INC Number manually, the server will take care of that"
+                end
+                @attributes[attribute.to_sym] = args
+            else # reader method
+                @attributes[method_name.to_sym]
+            end
+        end
+
+        def save!
+            # if this is a new incident (still in memory and not on SN), and the user set the Incident number
+            # we raise an exception
+            if !@attributes[:number].nil? && !@saved_on_sn
+                raise "SN::ERROR: You are not allowed to set INC Number manually, the server will take care of that"
+            end
+            # we only create new incidents if it's not saved already
+            if !@saved_on_sn
+                response = Configuration.post_resource(table = "incident").post(self.attributes.to_json)
+            else
+                response = Configuration.update_resource(self.number, table = "incident").post(self.attributes.to_json)
+            end
+            hash = JSON.parse(response, { :symbolize_names => true })
+            # this is the object
+            # and there is always only one
+            # since we're creating or updating
+            inc_object = hash[:records][0]
+            inc_object.each do |key, value|
+                key_name = key.to_s
+                eval("self.#{key_name} = value")
+            end
+            @saved_on_sn = true
+            self
+        end
+
+        def self.find(inc_number)
+            Incident.check_configuration
+            inc_string = inc_number.to_s.match(/[123456789]+\d*$/).to_s
+            if inc_string.length > 7
+                raise "SN::Error: invalid Incident number"
+            end
+            query_hash = {}
+            query_hash[:number] = "INC" + "0"*(7-inc_string.length) + inc_string
+            response = Configuration.get_resource(query_hash, table = "incident").get();
+            # returned hash
+            hash = JSON.parse(response, { :symbolize_names => true })
+            # return the Incident object
+            inc_obj = Incident.new(attributes = hash[:records][0], saved_on_sn = true, internal_call = true)
+            if inc_obj.attributes.nil?
+                "SN::Alert: No incident with incident number #{query_hash[:number]} found"
+            else
+                inc_obj
+            end
+        end
+
+        def self.where(query_hash = {})
+            Incident.check_configuration
+            response = Configuration.get_resource(query_hash, table = "incident").get();
+            hash = JSON.parse(response, { :symbolize_names => true })
+            array_of_records = hash[:records]
+            array_of_inc = []
+            array_of_records.each do |record|
+                array_of_inc << Incident.new(attributes = record, saved_on_sn = true, internal_call = true)
+            end
+            array_of_inc
+        end
+
+        private
+            def self.check_configuration
+                if $root_url.nil? || $username.nil? || $password.nil?
+                    raise "SN::Error: You have not configured yet, please run ServiceNow::Configuration.configure() first"
+                end
+            end
+    end
+end

data/lib/classes/user.rb

@@ -0,0 +1,67 @@
+module ServiceNow
+    class User
+
+        def initialize(attributes = {})
+            @attributes = attributes
+        end
+
+        def attributes
+            @attributes
+        end
+
+        def self.find(netid)
+            User.check_configuration
+            query_hash = {}
+            query_hash[:user_name] = netid
+            response = Configuration.get_resource(query_hash = query_hash, table = "sys_user").get()
+            hash = JSON.parse(response, { :symbolize_names => true })
+            # there should be only one
+            user = User.new(hash[:records][0])
+            if user.attributes.nil?
+                "SN::Alert: No user with netID: #{netid} found"
+            else
+                user
+            end
+        end
+
+        def self.find_by_sys_id(sys_id)
+            User.check_configuration
+            query_hash = {}
+            query_hash[:sys_id] = sys_id
+            response = Configuration.get_resource(query_hash = query_hash, table = "sys_user").get()
+            hash = JSON.parse(response, { :symbolize_names => true })
+            user = User.new(hash[:records][0])
+            if user.attributes.nil?
+                "SN::Alert: No user with sys_id: #{sys_id} found"
+            else
+                user
+            end
+        end
+
+        def self.find_by_name(name)
+            User.check_configuration
+            query_hash = {}
+            query_hash[:name] = name
+            response = Configuration.get_resource(query_hash = query_hash, table = "sys_user").get()
+            hash = JSON.parse(response, { :symbolize_names => true })
+            user = User.new(hash[:records][0])
+            if user.attributes.nil?
+                "SN::Alert: No user with user_name: #{name} found"
+            else
+                user
+            end
+        end
+
+        def method_missing(method, args = nil)
+            method_name = method.to_s
+            @attributes[method_name.to_sym]
+        end
+
+        private
+            def self.check_configuration
+                if $root_url.nil? || $username.nil? || $password.nil?
+                    raise "SN::Error: You have not configured yet, please run ServiceNow::Configuration.configure() first"
+                end
+            end
+    end
+end

data/lib/service_now/version.rb

@@ -0,0 +1,3 @@
+module ServiceNow
+  VERSION = "0.0.2"
+end

data/lib/service_now.rb

@@ -0,0 +1,14 @@
+require "service_now/version"
+require "classes/configuration"
+require "classes/incident"
+require "classes/user"
+require "rest_client"
+require "json"
+require "uri"
+
+
+module ServiceNow
+    $root_url = nil
+    $username = nil
+    $password = nil
+end

data/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 'service_now/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "service_now"
+  spec.version       = ServiceNow::VERSION
+  spec.authors       = ["YaleSTC::hengchu zhang"]
+  spec.email         = ["hengchu.zhang@yale.edu"]
+  spec.description   = %q{Ruby wrapper for SN API requests}
+  spec.summary       = %q{Ruby wrapper for SN API requests}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.add_dependency('rest-client')
+  spec.add_dependency('json')
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

data/specs.md

@@ -0,0 +1,51 @@
+
+The main open question in the specs below (at least right now) is how to handle associating users with incidents. That is, what are the properties used by SN to reliably identify clients for incidents, requests, etc. Do we create a class such as SN::Client that wraps the properties of an incident's client?
+
+## Configuration
+
+Ideally, users of this gem would be able to do something like:
+
+    SN::Configuration.configure auth_user: "my_user", auth_pass: "my_pass", sn_url: "http://yaletest.service-now.com"
+
+## Incidents
+
+### Creating
+    
+    incident = SN::Incident.new(client: "Adam Bray", short_description: "Computer has a virus")
+    incident.save! # submits request to SN; returns SN::Incident which wraps the newly created incident
+
+### Searching
+    
+    incidents = SN::Incident.where(description: "virus", client: "Adam Bray")
+    # returns an array of objects of class 'SN::Incident'
+    # note we need to discuss the exact names for things like 'client', 'client netid', etc
+    
+    incident = SN::Incident.find("INC0003123")
+    # same as:
+    incident = SN::Incident.find(3123)
+    # returns on SN::Incident
+    
+### Reading
+
+    incident = SN::Incident.find(3123)
+    incident.short_description
+    # "Client has a computer virus after watching lolcats"
+    incident.description
+    # Returns the full description
+    client = incident.client
+    # This should ideally return something that behaves like a user object, maybe a class SN::Client
+    client.name
+    # "Adam Bray"
+    client.email
+    # "adam.bray@example.com"
+
+### Updating
+
+    incident = SN::Incident.find(3123)
+    incident.short_description = "Client has a computer virus after watching loldogs"
+    incident.save!
+    
+### Destroying
+
+For now, I don't think we should implement destroying incidents.
+    

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: service_now
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- YaleSTC::hengchu zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70254494557040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254494557040
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70254494555560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254494555560
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70254494550320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70254494550320
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70254494549700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70254494549700
+description: Ruby wrapper for SN API requests
+email:
+- hengchu.zhang@yale.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/classes/configuration.rb
+- lib/classes/incident.rb
+- lib/classes/user.rb
+- lib/service_now.rb
+- lib/service_now/version.rb
+- service_now.gemspec
+- specs.md
+homepage: ''
+licenses:
+- MIT
+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.10
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for SN API requests
+test_files: []