osvc_ruby 1.5.0

data/spec/core/client_spec.rb

@@ -0,0 +1,97 @@
+require 'core/spec_helper'
+
+describe OSvCRuby::Client do
+	subject { client }
+
+	context '#initialize' do
+		
+		it 'should require a block' do
+			expect { OSvCRuby::Client.new }.to raise_error(ArgumentError)
+		end
+
+		it 'should raise exception if interface is blank' do
+			expect do
+				OSvCRuby::Client.new do |config|
+					config.interface = ''
+				end
+			end.to raise_error("Interface cannot be nil or blank")
+		end
+
+		it 'should raise exception if username is blank' do
+			expect do
+				OSvCRuby::Client.new do |config|
+					config.interface = 'test'
+					config.username = ''
+				end
+			end.to raise_error("Username cannot be nil or blank")
+		end
+
+		it 'should raise exception if password is blank' do
+			expect do
+				OSvCRuby::Client.new do |config|
+					config.interface = 'test'
+					config.username = 'test_username'
+					config.password = ''
+				end
+			end.to raise_error("Password cannot be nil or blank")
+		end
+
+		it 'should raise exception if no_ssl_verify not a TrueClass nor a FalseClass' do
+			expect do
+				OSvCRuby::Client.new do |config|
+					config.interface = 'test'
+					config.username = 'test_username'
+					config.password = 'password'
+					config.no_ssl_verify = 'true'
+				end
+			end.to raise_error("The no SSL verification setting must be set to true or false")
+		end
+
+		it 'should raise exception if Connect Version is null' do
+			expect do
+				OSvCRuby::Client.new do |config|
+					config.interface = 'test'
+					config.username = 'test_username'
+					config.password = 'password'
+					config.version = nil
+				end
+			end.to raise_error("Connect version cannot be null")
+		end
+
+		let(:client){
+			OSvCRuby::Client.new do |config|
+				config.interface = 'test'
+				config.username = 'test_username'
+				config.password = 'test_password'
+				config.no_ssl_verify = true
+			end
+		}
+
+		it 'should create a configuration object' do
+
+			expect{client}.to_not raise_error
+
+		end
+
+		it 'should have interface set to "test" and not "test1"' do
+			expect(client.config.interface).to eq('test')
+			expect(client.config.interface).not_to eq('test1')
+		end
+
+		it 'should have username set to "test_username" and not "test1_username"' do
+			expect(client.config.username).to eq('test_username')
+			expect(client.config.username).not_to eq('test1_username')
+		end
+
+		it 'should have password set to "test_password" and not "test1_password"' do
+			expect(client.config.password).to eq('test_password')
+			expect(client.config.password).not_to eq('test1_password')
+		end
+
+		it 'should have no_ssl set to true and not false' do
+			expect(client.config.no_ssl_verify).to eq(true)
+			expect(client.config.no_ssl_verify).not_to eq(false)
+		end
+
+	end
+end

data/spec/core/configuration_spec.rb

@@ -0,0 +1,5 @@
+require 'core/spec_helper'
+
+describe OSvCRuby::Configuration do
+	subject { OSvCRuby::Configuration.new }
+end

data/spec/core/connect_spec.rb

@@ -0,0 +1,463 @@
+require 'core/spec_helper'
+require 'json'
+require 'uri'
+
+describe OSvCRuby::Connect do
+	
+	subject { connect }
+	
+	let(:client) { 
+
+		OSvCRuby::Client.new do |config|
+		
+			config.interface = ENV['OSC_SITE']
+		
+			config.username = ENV['OSC_ADMIN']
+		
+			config.password = ENV['OSC_PASSWORD']
+
+			config.suppress_rules = true
+
+			config.demo_site = true
+		
+		end
+	}
+
+
+	context '#generate_url_and_config' do
+
+		it 'should take at least a config parameter that is an instance of an OSvCRuby::Client' do
+
+			expect(client).to be_an(OSvCRuby::Client)
+
+			expect do
+
+				OSvCRuby::Connect.generate_url_and_config(client)
+
+			end.not_to raise_error
+		end
+
+		it 'should take an optional resource_url parameter' do
+
+			expect do
+
+				OSvCRuby::Connect.generate_url_and_config(client, 'serviceProducts')
+
+			end.not_to raise_error
+		end
+
+		it 'should change the final configured url if the resource_url parameter is specified' do
+
+			test = OSvCRuby::Connect.generate_url_and_config(client, 'serviceProducts')
+
+			interface = client.config.interface
+			if test['site_url'].to_s.match(/custhelp/)
+				demo_or_cust = "custhelp"
+			else
+				demo_or_cust = "rightnowdemo"
+			end
+			expect(test['site_url']).to eq(URI("https://#{interface}.#{demo_or_cust}.com/services/rest/connect/v1.3/serviceProducts"))
+
+			expect(test['site_url']).to be_an(URI::HTTPS)
+		end
+
+		it 'should raise an error if client is nil' do
+
+			expect do
+				
+				client = nil
+
+				OSvCRuby::Connect.generate_url_and_config(client)
+
+			end.to raise_error("Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings")
+
+		end
+
+		it 'should raise an error if client.config is nil' do
+
+			expect do
+				
+				client.config = nil
+
+				OSvCRuby::Connect.generate_url_and_config(client)
+
+			end.to raise_error("Client configuration cannot be nil or blank")
+
+		end
+
+		it 'should raise an error if client interface is absent' do
+
+			expect do
+				
+				client.config.interface = nil
+				
+				OSvCRuby::Connect.generate_url_and_config(client)
+			
+			end.to raise_error("The configured client interface cannot be nil or blank")
+
+		end
+
+		it 'should raise an error if client username is absent' do
+
+			expect do
+
+				client.config.username = nil
+
+				OSvCRuby::Connect.generate_url_and_config(client)
+
+			end.to raise_error("The configured client username cannot be nil or blank")
+
+		end
+
+		it 'should raise an error if client password is absent' do
+
+			expect do
+
+				client.config.password = nil
+
+				OSvCRuby::Connect.generate_url_and_config(client)
+
+			end.to raise_error("The configured client password cannot be nil or blank")
+
+		end
+
+
+		it 'should create an Hash object with a site_url, username, password properties' do
+
+			final_config = OSvCRuby::Connect.generate_url_and_config(client)
+
+			expect(final_config).to be_an(Hash)
+
+			expect(final_config['site_url']).to be_an(URI::HTTPS)
+
+			expect(final_config['username']).to eq(ENV['OSC_ADMIN'])
+
+			expect(final_config['password']).to eq(ENV['OSC_PASSWORD'])
+
+		end
+
+	end
+
+	let(:json_content){
+		{:test => 'content'}
+	}
+
+	context '#post_or_patch' do
+
+		it 'should take at least a config parameter that is an instance of an OSvCRuby::Client', :vcr do
+
+			expect(client).to be_an(OSvCRuby::Client)
+
+			expect do
+
+				OSvCRuby::Connect.post_or_patch(client,'serviceProducts',json_content)
+
+			end.not_to raise_error
+		end
+
+		it 'should raise an error if client is nil' do
+
+			expect do
+				
+				client = nil
+
+				OSvCRuby::Connect.post_or_patch(client,'serviceProducts',json_content)
+
+			end.to raise_error("Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings")
+
+		end
+
+		it 'should raise an error if resource_url is nil' do
+
+			expect do
+
+				OSvCRuby::Connect.post_or_patch(client, nil, json_content)
+
+			end.to raise_error("There is no URL resource provided; please specify a URL resource that you would like to send a POST or PATCH request to")
+
+		end
+
+		it 'should raise an error if json_content is nil' do
+
+			expect do
+
+				OSvCRuby::Connect.post_or_patch(client,'serviceProducts')
+
+			end.to raise_error("There is no json content provided; please specify json content that you would like to send a POST or PATCH request with")
+
+		end
+
+		it 'should produce a Net::HTTPResponse, should produce a 201 response code, and should produce a JSON Response form the response body', :vcr do
+
+			names = []
+
+			names[0] = {:labelText => 'PRODUCT-TEST', :language => {:id => 1}}
+			# names[1] = {:labelText => 'PRODUCT-TEST', :language => {:id => 11}}
+
+			# parent = {:id => 102}
+
+			displayOrder = {:id => 4}
+
+			admin_user_visible_interfaces = []
+			admin_user_visible_interfaces[0] = {:id => 1}
+
+			end_user_visible_interfaces = []
+			end_user_visible_interfaces[0] = {:id => 1}
+
+			new_prod = []
+			new_prod[0] = {:names => names,
+			               :adminVisibleInterfaces => admin_user_visible_interfaces,
+			               :endUserVisibleInterfaces => end_user_visible_interfaces}
+
+		    test = OSvCRuby::Connect.post_or_patch(client,'serviceProducts',new_prod[0])
+
+			expect(test).to be_an(Net::HTTPResponse)
+
+			expect(test.code).to eq("201")
+
+			expect(test.body).to be_an(String)
+
+			expect{JSON.parse(test.body)}.not_to raise_error
+				
+		end
+
+	end
+
+	context '#post' do
+
+		it 'should produce a Net::HTTPResponse, should produce a 201 response code, and should produce a JSON Response form the response body', :vcr do
+
+			names = []
+
+			names[0] = {:labelText => 'PRODUCT-TEST', :language => {:id => 1}}
+			# names[1] = {:labelText => 'PRODUCT-TEST', :language => {:id => 11}}
+
+			# parent = {:id => 102}
+
+			displayOrder = {:id => 4}
+
+			admin_user_visible_interfaces = []
+			admin_user_visible_interfaces[0] = {:id => 1}
+
+			end_user_visible_interfaces = []
+			end_user_visible_interfaces[0] = {:id => 1}
+
+			new_prod = []
+			new_prod[0] = {:names => names,
+			               :adminVisibleInterfaces => admin_user_visible_interfaces,
+			               :endUserVisibleInterfaces => end_user_visible_interfaces}
+
+		    test = OSvCRuby::Connect.post(client,'serviceProducts',new_prod[0])
+
+			expect(test).to be_an(Net::HTTPResponse)
+
+			expect(test.code).to eq("201")
+
+			expect(test.body).to be_an(String)
+
+			expect{JSON.parse(test.body)}.not_to raise_error
+				
+		end
+
+	end	
+
+	context '#patch' do
+
+		it 'should make a patch request', :vcr do
+
+			resource = URI.escape("queryResults/?query=select id from serviceproducts where lookupname = 'PRODUCT-TEST';")
+
+			product_test = OSvCRuby::Connect.get(client,resource)
+
+			prod_json = JSON.parse(product_test.body).to_hash
+
+			product_test_id = prod_json['items'][0]['rows'][0][0].to_i
+
+			names = []
+
+			names[0] = {:labelText => 'PRODUCT-TEST-updated', :language => {:id => 1}}
+			# names[1] = {:labelText => 'PRODUCT-TEST-updated', :language => {:id => 11}}
+
+			# parent = {:id => 102}
+
+			displayOrder = {:id => 4}
+
+			admin_user_visible_interfaces = []
+			admin_user_visible_interfaces[0] = {:id => 1}
+
+			end_user_visible_interfaces = []
+			end_user_visible_interfaces[0] = {:id => 1}
+
+			new_prod = []
+			new_prod[0] = {:names => names, 
+			               # :parent => parent, 
+			               :adminVisibleInterfaces => admin_user_visible_interfaces,
+			               :endUserVisibleInterfaces => end_user_visible_interfaces}
+
+		    test = OSvCRuby::Connect.patch(client,"serviceProducts/#{product_test_id}",new_prod[0])
+
+			expect(test).to be_an(Net::HTTPResponse)
+
+			expect(test.body).to eq("")
+
+			expect(test.code).to eq("200")
+				
+		end
+
+	end	
+
+
+
+
+	context '#get' do
+
+		it 'should take at least a config parameter that is an instance of an OSvCRuby::Client', :vcr do
+
+			expect(client).to be_an(OSvCRuby::Client)
+
+			expect do
+
+				OSvCRuby::Connect.get(client)
+
+			end.not_to raise_error
+		end
+
+
+		it 'should raise an error if client is nil' do
+
+			expect do
+				
+				client = nil
+
+				OSvCRuby::Connect.get(client)
+
+			end.to raise_error("Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings")
+
+		end
+
+		it 'should produce a Net::HTTPResponse', :vcr do
+
+			test = OSvCRuby::Connect.get(client)
+
+			expect(test).to be_an(Net::HTTPResponse)
+				
+		end
+
+		it 'should produce a 200 response code', :vcr do
+
+			test = OSvCRuby::Connect.get(client)
+
+			expect(test.code).to eq("200")
+				
+		end
+
+		it 'should produce a JSON Response from the response body', :vcr do
+
+			test = OSvCRuby::Connect.get(client)
+			
+			expect(test.body).to be_an(String)
+
+			expect{JSON.parse(test.body)}.not_to raise_error
+		end
+
+		it 'should bring back a list of service products when specified',:vcr do
+			res = OSvCRuby::Connect.get(client,'/serviceProducts?limit=3')
+			
+			expect(res.body).to be_an(String)
+		end
+
+	end
+
+
+	context '#post_or_patch' do
+
+		it 'should take an optional parameter to allow PATCH request; it should produce a Net::HTTPResponse, should produce a 200 code', :vcr do
+
+			resource = URI.escape("queryResults/?query=select id from serviceproducts where lookupname = 'PRODUCT-TEST';")
+
+			product_test = OSvCRuby::Connect.get(client,resource)
+
+			prod_json = JSON.parse(product_test.body).to_hash
+
+			product_test_id = prod_json['items'][0]['rows'][0][0].to_i
+
+			names = []
+
+			names[0] = {:labelText => 'PRODUCT-TEST-updated', :language => {:id => 1}}
+			# names[1] = {:labelText => 'PRODUCT-TEST-updated', :language => {:id => 11}}
+
+			# parent = {:id => 102}
+
+			displayOrder = {:id => 4}
+
+			admin_user_visible_interfaces = []
+			admin_user_visible_interfaces[0] = {:id => 1}
+
+			end_user_visible_interfaces = []
+			end_user_visible_interfaces[0] = {:id => 1}
+
+			new_prod = []
+			new_prod[0] = {:names => names, 
+			               # :parent => parent, 
+			               :adminVisibleInterfaces => admin_user_visible_interfaces,
+			               :endUserVisibleInterfaces => end_user_visible_interfaces}
+
+		    test = OSvCRuby::Connect.post_or_patch(client,"serviceProducts/#{product_test_id}",new_prod[0],true)
+
+			expect(test).to be_an(Net::HTTPResponse)
+
+			expect(test.body).to eq("")
+
+			expect(test.code).to eq("200")
+
+				
+		end
+
+	end
+
+	context '#delete' do
+
+		it 'should raise an error if client is nil' do
+
+			expect do
+				
+				client = nil
+
+				OSvCRuby::Connect.delete(client)
+
+			end.to raise_error("Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings")
+
+		end
+
+		it 'should raise an error if the resource_url is not specified' do
+
+			expect do
+
+				OSvCRuby::Connect.delete(client)
+
+			end.to raise_error("There is no URL resource provided; please specify a URL resource that you would like to send a POST or PATCH request to")
+
+		end
+
+		it 'it should produce a Net::HTTPResponse, should produce a 200 code', :vcr do
+
+			q = OSvCRuby::QueryResults.new
+		    query = "select id from serviceproducts where lookupname = 'PRODUCT-TEST-updated';"
+
+			product_test_updated = q.query(client,query)
+
+		    test = OSvCRuby::Connect.delete(client,"serviceProducts/#{product_test_updated[0]['id']}")
+
+			expect(test).to be_an(Net::HTTPResponse)
+
+			expect(test.body).to eq("")
+
+			expect(test.code).to eq("200")
+				
+		end
+
+
+
+	end
+
+end

data/spec/core/query_results_set_spec.rb

@@ -0,0 +1,107 @@
+require 'core/spec_helper'
+require 'json'
+require 'uri'
+
+describe OSvCRuby::QueryResultsSet do
+
+	let(:client) { 
+
+		OSvCRuby::Client.new do |config|
+		
+			config.interface = ENV['OSC_SITE']
+		
+			config.username = ENV['OSC_ADMIN']
+		
+			config.password = ENV['OSC_PASSWORD']
+
+			config.demo_site = true
+		
+		end
+	}
+
+	let(:query_results_set){
+		OSvCRuby::QueryResultsSet.new
+	}
+
+	let(:table){ "answers" } 
+	let(:nested_attributes){
+ 		[ 
+		  "accessLevels.namedIDList.*",
+		  "answerType.*",
+		  "assignedTo.account.*",
+		  "assignedTo.staffGroup.*",
+		  "banner.*",
+		  "banner.importanceFlag.*",
+		  "banner.updatedByAccount.*",
+		  "categories.categoriesList.*",
+		  "commonAttachments.fileAttachmentList.*",
+		  "commonAttachments.fileAttachmentList.names.labelList.labelText",
+		  "commonAttachments.fileAttachmentList.names.labelList.language.*",
+		  "fileAttachments.fileAttachmentList.*",
+		  "guidedAssistance.*",
+		  "language.*",
+		  "notes.noteList.*",
+		  "positionInList.*",
+		  "products.productsList.*",
+		  "relatedAnswers.answerRelatedAnswerList.*",
+		  "relatedAnswers.answerRelatedAnswerList.toAnswer.*",
+		  "siblingAnswers.*",
+		  "statusWithType.statusType.*",
+		  "updatedByAccount.*",
+		  "customFields.c.*"
+		]
+	}
+
+
+	context "#query_set" do
+
+		it 'should expect client is an instance of OSvCRuby::Client class and raise an error if does not' do
+
+			expect(client).to be_an(OSvCRuby::Client)
+
+			client = nil
+
+			expect{query_results_set.query_set(client,'describe')}.to raise_error('Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings')
+
+		end
+
+
+		## TO DO
+
+		# it 'should expect a hash with a key and query value set' do
+
+		# 	expect(client).to be_an(OSvCRuby::Client)
+
+		# 	expect{query_results_set.query_set(client,"")}.to raise_error("A query must be specified when using the 'query' method")
+
+		# end
+
+
+		it 'should return results in set of OSvCRuby::QueryResults',:vcr do 
+
+			expect(query_results_set.query_set(client,{key:"answers", query:"select * from answers LIMIT 2"},
+													  {key:"incidents", query:"describe incidents"})).to be_a(Struct)
+
+
+		end
+
+		it 'should be able to manipulate and assign results data',:vcr do 
+
+			test = query_results_set.query_set(client, {key:"incidents", query:"select * from incidents limit 10"},
+													   {key:"serviceCategories", query:"describe serviceCategories"})		
+				expect(test.incidents).to be_an(Array)
+				expect(test.incidents.first).to be_a(Hash)
+				expect(test.incidents.first['id']).to be_a(Integer)
+				expect(test.serviceCategories).to be_an(Array)
+
+
+		end
+
+		it 'should be able to take multiple queries', :vcr do
+			answer_attrs = nested_attributes.map { |attr| {key: attr, query: "SELECT #{attr} FROM #{table} WHERE ID = 1"} }
+			test = query_results_set.query_set(client,*answer_attrs)
+		end
+		
+	end
+
+end