servicenow 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 298f78b3a26493a3777a78e81e730c8a674bdafe
-  data.tar.gz: dd1bbacad809a0442d66b4df78803b4133749519
+  metadata.gz: 00356f2950314c1456d77d963cb5828d4cc69064
+  data.tar.gz: 3b8f22017986499337f689fa139e8324779fa1b3
 SHA512:
-  metadata.gz: 99a13ad7f276f737f6a0a86496c7e3795f526af3e826a68eedf5ac69c75e69459a30fc38814f005d1cbdbd051540ebd4f98fdd347dc03495c106a893ea8fa5e3
-  data.tar.gz: 9feb14e6dc5ca1fd9fc071e869fee803a77317352e370484848f317a57229339c84d05da32e4ff5a28b809c3fee04dfc1ce94da1b05559a0924ecc5cca32cdec
+  metadata.gz: fae82088eec99a3e88b28fa4926d0dbbff263865fc9a04002a460e42b412116c7fb46844cda3a3357efc0b7526dae3f2eaef9a938d2f0d7ef73569d7e37b047c
+  data.tar.gz: a7da86f05ac070fa8c368c742e4fed7684bb8b6e3c9ab152be5dfbe07669593de4411c4c30972aa8d8380ec084afc5a9365024ba3045e58762fb44a5ea7654ee

data/.gitignore

@@ -1,3 +1,4 @@
+.ruby-version
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## 1.0.0
+
+### breaking changes
+
+* Servicenow::Client#snow_base_url is renamed
+Servicenow::Client#snow_api_base_url for consistency with other variables
+* Logger is moved from Servicenow::Client to Servicenow; passing logger to
+Client has no effect
+* renamed Servicenow::Client#submit_change to Servicenow::Client#create_change
+
+### other changes
+
+* moved configuration to the module level
+* added methods to post work notes to a Change
+* added methods to start and stop a Change
+* Servicenow.logger by default logs to STDOUT, INFO level.  A future improvement
+  will attempt to mask passwords
+* basic tests
+
+## 0.0.3
+
+## 0.0.2
+

data/Gemfile

@@ -8,6 +8,11 @@ gem 'httpi'
 gem 'json'
 
 group :development, :test do
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-minitest'
   gem 'minitest'
+  gem 'minitest-rg'
   gem 'rake'
+  gem 'yard'
 end

data/Guardfile

@@ -0,0 +1,15 @@
+guard :bundler do
+  watch 'Gemfile'
+end
+
+guard :minitest do
+  watch(%r{^test/(.*/)?test_.+\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+  
+end

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task :default => :test

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "servicenow"
+require 'bundler/setup'
+require 'servicenow'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "servicenow"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/servicenow.rb

@@ -2,4 +2,56 @@ require 'servicenow/version'
 require 'servicenow/client'
 require 'servicenow/change'
 
-module Servicenow; end
+module Servicenow
+
+  @logger = nil
+  @configuration = nil
+  
+  class BaseError < StandardError; end
+  class MissingParameterError < BaseError; end
+
+
+  # Set up Servicenow config
+  #
+  # @example Set up with username.  Password and URL would come from environemnt
+  #   Servicenow.configure do |config|
+  #     config.username = 'foo'
+  #   end
+  #
+  # @yieldparam config [Servicenow::Configuration]
+  def self.configure(&block)
+    if @configuration.nil?
+      @configuration = OpenStruct.new({})
+    end
+    yield @configuration
+  end
+
+
+  # @return [Servicenow::Configuration]
+  def self.configuration
+    if @configuration.nil?
+      @configuration = OpenStruct.new({})
+    end
+    @configuration
+  end
+
+
+  # @param [Logger] new_logger new logger for module
+  #
+  # @return [Logger]
+  def self.logger=(new_logger)
+    @logger = new_logger
+  end
+
+
+  # @todo filter password
+  #
+  # @return [Logger] the module logger
+  def self.logger
+    if @logger.nil?
+      @logger = Logger.new(STDOUT)
+    end
+    @logger
+  end
+
+end

data/lib/servicenow/change.rb

@@ -2,7 +2,93 @@ require 'ostruct'
 
 module Servicenow
 
-  class Change < OpenStruct; end
+  class Change < OpenStruct
+
+    @_client = nil
+    
+    # @param [String] notes the notes to post
+    #
+    # @return [Servicenow::Change] the change
+    def add_work_notes(notes)
+      url = format('%s/change_request/%s', client.snow_table_url, sys_id)
+
+      query = {
+        work_notes: notes
+      }
+
+      response = client.send_request(url, query, :patch)
+      change
+    end
+
+
+    #
+    # @return [Servicenow::Change] the change
+    def start
+      url = format('%s/change_request/%s', client.snow_table_url, sys_id)
+
+      query = {
+        state: states['work in progress']
+      }
+
+      response = client.send_request(url, query, :patch)
+      change
+    end
+
+    
+    # @return [Servicenow::Change] the change
+    def end_change
+      url = format('%s/change_request/%s', client.snow_table_url, sys_id)
+
+      query = {
+        state: states['work complete'],
+        u_completion_code: completion_codes['success']
+      }
+
+      response = client.send_request(url, query, :patch)
+      change
+    end
+
+
+    # This is a convenience method only.  It cannot be used to reload a Change
+    # *in place* but only to return a new copy of the same Change from the
+    # server
+    #
+    # @return [Servicenow::Change] a refreshed copy of this Change
+    def reload
+      client.get_change(number)
+    end
+
+
+    
+    private
+
+
+    def client
+      if @_client.nil?
+        @_client = Servicenow::Client.new
+      end
+      @_client
+    end
+
+
+    def states
+      {
+        'open' => 1,
+        'work in progress' => 2,
+        'work complete' => 11,
+        'work incomplete' => 4,
+        'waiting on user' => -5,
+      }
+    end
+
+
+    def completion_codes
+      {
+        'success' => 11
+      }
+    end
+
+  end
+
 
-  
 end

data/lib/servicenow/client.rb

@@ -6,29 +6,39 @@ module Servicenow
 
   class Client
 
-    @@logger = nil
-    attr_reader :snow_base_url
-
+    attr_reader :snow_api_base_url, :snow_table_url
+
+    # Initialization parameters for username, password and URL are normally
+    # set in the module configuration.  They can also be passed here, or
+    # set in the environment.  The precedence is ENV > params > module config
+    #
+    # @param [Hash] params initialization parameters
+    #
+    # @option params [String] :username ServiceNow API username
+    # @option params [String] :password ServiceNow API password
+    # @option params [String] :base_url ServiceNow API URL
+    #
+    # @return [Servicenow::Client] new client
     def initialize(params={})
-      @snow_api_username = ENV.fetch('SNOW_API_USERNAME')
-      @snow_api_password = ENV.fetch('SNOW_API_PASSWORD')
-      @snow_base_url = ENV.fetch('SNOW_API_BASE_URL')
-      @snow_table_url = format('%s/%s', @snow_base_url, 'table')
+      @snow_api_username = ENV.fetch('SNOW_API_USERNAME', params.delete(:username))
+      @snow_api_password = ENV.fetch('SNOW_API_PASSWORD', params.delete(:password))
+      @snow_api_base_url = ENV.fetch('SNOW_API_BASE_URL', params.delete(:url))
 
-      if params[:logger]
-        @@logger = params.delete(:logger)
-      else
-        @@logger = Logger.new(STDOUT)
-      end
-    end
+      @snow_api_username ||= Servicenow.configuration.username
+      @snow_api_password ||= Servicenow.configuration.password
+      @snow_api_base_url ||= Servicenow.configuration.base_url
 
+      raise MissingParameterError, 'ServiceNow API Username not set' if @snow_api_username.nil?
+      raise MissingParameterError, 'ServiceNow API Password not set' if @snow_api_password.nil?
+      raise MissingParameterError, 'ServiceNow API Base URL not set' if @snow_api_base_url.nil?
 
-    # TODO: filter password
-    def logger
-      @@logger
+      @snow_table_url = format('%s/%s', @snow_api_base_url, 'table')
     end
+    
 
-
+    # @param [String] user_id uses LIKE query to match for substring in u_cr_requester field
+    #
+    # @return [Array<Servicenow::Change>]
     def get_changes_by_user(user_id)
       url = format('%s/change_request', @snow_table_url)
       query = {
@@ -43,6 +53,11 @@ module Servicenow
     end
     
 
+    # @param [String] encodedquery a ServiceNow encoded query
+    # @param [int] limit limit results, default 10
+    # @param [int] page page of results, default 1
+    #
+    # @return [Array<Servicenow::Change>]
     def get_changes_by_query(encodedquery, limit=10, page=1)
       url = format('%s/change_request', @snow_table_url)
       query = {
@@ -52,13 +67,16 @@ module Servicenow
       }
 
       response = send_request(url, query)
-      logger.debug response
-
+      Servicenow.logger.debug response
+      
       obj = JSON.parse response.body
       obj['result'].collect{ |c| Change.new(c) }
     end
 
 
+    # @param [String] number Change number
+    #
+    # @return [Servicenow::Change]
     def get_change(number)
       url = format('%s/change_request', @snow_table_url)
       query = {
@@ -73,7 +91,10 @@ module Servicenow
     end
 
 
-    def submit_change(data={})
+    # @param [Hash] data the data to use for Change creation
+    #
+    # @return [Servicenow::Change]
+    def create_change(data={})
       url = format('%s/change_request', @snow_table_url)
       query = {}
       query.merge(data)
@@ -88,12 +109,16 @@ module Servicenow
     end
 
 
-    private
+    # protected
 
 
     def send_request(url, query, method=:get)
       request = HTTPI::Request.new(url)
-      request.query = query
+      if %i[ patch put ].include? method
+        request.body = query.to_json
+      else
+        request.query = query
+      end
       request.auth.basic(@snow_api_username, @snow_api_password)
       request.headers['Accept'] = 'application/json'
       request.headers['Content-Type'] = 'application/json'

data/lib/servicenow/configuration.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+
+module Servicenow
+
+  class Client < OpenStruct; end
+
+end

data/lib/servicenow/version.rb

@@ -1,3 +1,3 @@
 module Servicenow
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servicenow
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - rubyisbeautiful
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies: []
 description: This REST API client for ServiceNow is a work in progress
 email:
@@ -19,7 +19,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -28,6 +30,7 @@ files:
 - lib/servicenow.rb
 - lib/servicenow/change.rb
 - lib/servicenow/client.rb
+- lib/servicenow/configuration.rb
 - lib/servicenow/version.rb
 - servicenow.gemspec
 homepage: https://github.com/rubyisbeautiful/servicenow