osc_ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0262af3d710018528271b39304094ca53663c9e2
-  data.tar.gz: 1c7000c6df53b2bc4dfa45a6e65ff0356f182246
+  metadata.gz: d6f94c0e39eee367ce2ed2811ae2591a3ebe91bf
+  data.tar.gz: 3d3d0246225077d1a2089844a407d3f31dae51df
 SHA512:
-  metadata.gz: ab15d881832e339d67857eec0129bb5416b79f8822c8f5d7fad3b0b4998db89d300da41337cbf311b0432edd23949ea8caa46b90cacf2e013e96b89e419ef77c
-  data.tar.gz: be2146f1137e001348c636dab826f08c8a3d4963e0da2392a52e993394ae8958085dc6d20ed3be68f9f5968428d6c017a1f5319ecee02d9b0e3e6b24a0b976dc
+  metadata.gz: 8a7e3f17d1c8674716e8a3f8a7962d4c9d894a77da731b1b2d4765ac0682bb4ba56555e853be0fa04fcd885cdaa5754acad86b771e380bb1b4f2faadebe3d161
+  data.tar.gz: ba527034f663c100a58c42d0b97c79479ef3a9f5984c35e03ae87a3aafc574e0cb50f2f76e1789537bb23b943abf2a69b3769a9bb825a1d648b1d080709f94d0

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
 - 2.2.0
-- jruby
 addons:
   code_climate:
     repo_token:

data/README.md

@@ -14,8 +14,11 @@ The create, update, and destroy methods should work on any version of Oracle Ser
 
 Currently supporting the following objects:
 
-**ServiceProduct**
-**Answer** (only new, create, and find methods supported as of 1/11)
+	ServiceProduct
+
+	ServiceCategory
+
+	Answer
 
 At this time, subclasses such as ServiceProduct.CategoryLinks are not currently supported. 
 

data/lib/osc_ruby/service_category.rb

@@ -0,0 +1,214 @@
+require 'osc_ruby/client'
+require 'osc_ruby/query_module'
+require 'osc_ruby/validations_module'
+require 'osc_ruby/class_factory_module'
+require 'json'
+require 'uri'
+
+module OSCRuby
+	
+	class ServiceCategory
+
+		include QueryModule
+		include ValidationsModule
+		include ClassFactoryModule
+		
+		attr_accessor :names,:parent,:displayOrder,:adminVisibleInterfaces,:endUserVisibleInterfaces,:id,:lookupName,:createdTime,:updatedTime,:name
+
+	    def initialize(attributes = nil)
+
+    		@names = []
+			@adminVisibleInterfaces = []
+			@endUserVisibleInterfaces = []
+
+			if attributes.nil?
+
+				@parent = {}
+				@displayOrder = 1
+
+			else
+
+				@id = attributes["id"]
+				@lookupName = attributes["lookupName"]
+				@createdTime = attributes["createdTime"]
+				@updatedTime = attributes["updatedTime"]
+				@displayOrder = attributes["displayOrder"]
+				@name = attributes["name"]
+				@parent = attributes["parent"]
+
+			end
+
+	    end
+
+	    
+	    def create(client,return_json = false)
+
+	    	ClassFactoryModule.create(client,self,"/serviceCategories",return_json)
+
+	    end
+
+	    
+	    def self.find(client,id = nil,return_json = false)
+
+	    	ClassFactoryModule.find(client,id,'serviceCategories',return_json,OSCRuby::ServiceCategory)
+
+	    end
+
+	    
+	    def self.all(client, return_json = false)
+
+	    	ClassFactoryModule.all(client,'serviceCategories',return_json,OSCRuby::ServiceCategory)
+
+	    end
+
+	    
+	    def self.where(client, query = '', return_json = false)
+
+			ClassFactoryModule.where(client,query,'serviceCategories',return_json,OSCRuby::ServiceCategory)
+
+	    end
+
+	    
+	    def update(client, return_json = false)
+
+	    	ClassFactoryModule::update(client,self,"serviceCategories",return_json)
+
+	    end
+
+
+	    def destroy(client, return_json = false)
+
+	    	ClassFactoryModule.destroy(client,self,'serviceCategories',return_json)
+
+	    end
+
+
+	    
+
+	    # Convenience Methods for making the CRUD operations nicer to use
+
+		def set_attributes(response_body)
+
+			self.id = response_body["id"]
+
+    		self.name = response_body["lookupName"]
+
+    		self.lookupName = response_body["lookupName"]
+
+			self.displayOrder = response_body["displayOrder"]
+
+			if !response_body["parent"].nil?
+
+				self.parent = response_body["parent"]["links"][0]["href"].split('/').pop.to_i
+
+			else
+
+				self.parent = nil
+
+			end
+
+		end
+
+		def update_attributes(updated_category)
+
+			self.lookupName = updated_category.lookupName
+
+			self.createdTime = updated_category.createdTime
+
+			self.updatedTime = updated_category.updatedTime
+
+			self.name = updated_category.name
+
+			self.parent = updated_category.parent
+
+		end
+
+		def self.check_self(obj,is_update = false)
+
+			obj_attrs = ValidationsModule::extract_attributes(obj)
+
+			obj_attrs = check_interfaces(obj_attrs)
+
+			if is_update == true
+			
+				obj_attrs = remove_unused_new_attrs(obj_attrs)
+			
+			else
+
+				obj_attrs = check_for_names(obj_attrs)
+
+				obj_attrs = check_for_parents(obj_attrs)
+				
+			end
+
+			obj_attrs
+
+		end
+
+		def self.check_for_names(obj_attrs)
+
+			if obj_attrs[0]['names'].count == 0 || obj_attrs[0]['names'][0]['labelText'].nil? || obj_attrs[0]['names'][0]['language'].nil?
+				
+				raise ArgumentError, 'ServiceCategory should at least have one name set (new_service_category.names[0] = {"labelText" => "QTH45-test", "language" => {"id" => 1}} )'
+			
+			end
+
+			obj_attrs
+
+		end
+
+		def self.check_for_parents(obj_attrs)
+
+			if !obj_attrs[0]['parent'].nil? && obj_attrs[0]['parent'].is_a?(Hash) && !obj_attrs[0]['parent'].key?('id') && !obj_attrs[0]['parent'].key?('lookupName')
+			
+				obj_attrs[0].delete('parent')
+			
+			end
+
+			obj_attrs
+
+		end
+
+		def self.remove_unused_new_attrs(obj_attrs)
+
+			obj_attrs[0].delete('id')
+			
+			obj_attrs[0].delete('lookupName')
+			
+			obj_attrs[0].delete('createdTime')
+			
+			obj_attrs[0].delete('updatedTime')
+			
+			obj_attrs[0].delete('name')
+			
+			if !obj_attrs[0]['parent'].nil?
+			
+				obj_attrs[0].delete('parent')
+			
+			end
+
+			obj_attrs
+
+		end
+
+		def self.check_interfaces(empty_arr)
+
+			if empty_arr[0]['adminVisibleInterfaces'].empty?
+				
+				empty_arr[0].delete('adminVisibleInterfaces')
+			
+			end
+
+			if empty_arr[0]['endUserVisibleInterfaces'].empty?
+				
+				empty_arr[0].delete('endUserVisibleInterfaces')
+			
+			end
+
+			empty_arr
+
+		end
+
+	end
+
+end

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/osc_ruby.rb

@@ -3,4 +3,5 @@ module OSCRuby; end
 require 'osc_ruby/client'
 require 'osc_ruby/connect'
 require 'osc_ruby/service_product'
+require 'osc_ruby/service_category'
 require 'osc_ruby/answer'

data/spec/core/service_category_spec.rb

@@ -0,0 +1,441 @@
+require 'core/spec_helper'
+require 'json'
+require 'uri'
+
+describe OSCRuby::ServiceCategory do
+
+	let(:service_category){
+		
+		OSCRuby::ServiceCategory.new
+
+	}
+
+	context '#initialize' do
+
+		it 'should not throw an error when initialized' do
+
+			expect{service_category}.not_to raise_error
+
+		end
+
+		it 'should initialize with names being an array; parent is an empty hash; 
+		displayOrder is 1; adminVisibleInterfaces is an empty array; and endUserVisibleInterfaces is an empty array' do
+
+			expect(service_category.names).to eq([])
+
+			expect(service_category.parent).to eq({})
+
+			expect(service_category.displayOrder).to eq(1)
+
+			expect(service_category.adminVisibleInterfaces).to eq([])
+
+			expect(service_category.endUserVisibleInterfaces).to eq([])
+
+		end
+
+	end
+
+	# let(:attributes){
+	# 	{'id' => 1, 
+	# 	 'lookupName' => 'Test category Lookup Name',
+	# 	 'createdTime'=>nil,
+	# 	 'updatedTime'=>nil,
+	# 	 'displayOrder'=>1,
+	# 	 'name'=>'Test Product Lookup Name',
+	# 	 'parent' => nil
+	# 	}
+	# }
+
+	# context '#new_from_fetch' do
+
+	# 	it 'should accept an attributes as a hash' do
+
+	# 		expect do
+
+	# 			attributes = []
+
+	# 			OSCRuby::ServiceCategory.new_from_fetch(attributes)
+
+	# 		end.to raise_error("Attributes must be a hash; please use the appropriate data structure")
+
+	# 		expect do
+
+	# 			OSCRuby::ServiceCategory.new_from_fetch(attributes)
+
+	# 		end.not_to raise_error
+
+	# 	end
+
+	# 	it 'should instantiate an id, lookupName, createdTime, updatedTime, displayOrder, name, and parent with the correct values' do
+
+	# 		test = OSCRuby::ServiceCategory.new_from_fetch(attributes)
+
+	# 		expect(test.id).to eq(1)
+
+	# 		expect(test.lookupName).to eq('Test Product Lookup Name')
+
+	# 		expect(test.createdTime).to eq(nil)
+
+	# 		expect(test.updatedTime).to eq(nil)
+
+	# 		expect(test.displayOrder).to eq(1)
+
+	# 		expect(test.name).to eq('Test Product Lookup Name')
+
+	# 		expect(test.name).to eq(test.lookupName)
+
+	# 		expect(test.parent).to eq(nil)
+
+	# 	end
+
+	# end
+
+	let(:client) { 
+
+		OSCRuby::Client.new do |config|
+		
+			config.interface = ENV['OSC_TEST_SITE']
+		
+			config.username = ENV['OSC_ADMIN']
+		
+			config.password = ENV['OSC_PASSWORD']
+		
+		end
+	}
+
+	let(:new_service_category){
+		OSCRuby::ServiceCategory.new
+	}
+
+	context '#create' do
+
+		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not' do
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			client = nil
+
+			expect{new_service_category.create(client)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should check the object and make sure that it at least has a name set' do
+
+			expect{new_service_category.create(client)}.to raise_error('ServiceCategory should at least have one name set (new_service_category.names[0] = {"labelText" => "QTH45-test", "language" => {"id" => 1}} )')
+
+		end
+
+		it 'should expect the name in a hash as the value of the labelText key' do
+
+			new_service_category.names[0] = "new category name"
+
+			expect{new_service_category.create(client)}.to raise_error('ServiceCategory should at least have one name set (new_service_category.names[0] = {"labelText" => "QTH45-test", "language" => {"id" => 1}} )')
+
+		end
+
+		it 'should expect a language => id key pair within the hash' do
+
+			new_service_category.names[0] = {"labelText" => "New Category"}
+
+			expect{new_service_category.create(client)}.to raise_error('ServiceCategory should at least have one name set (new_service_category.names[0] = {"labelText" => "QTH45-test", "language" => {"id" => 1}} )')
+
+		end
+
+		it 'should return an instance of an OSCRuby::ServiceCategory if the json_response param is set to false (which it is by default)', :vcr do
+
+			new_service_category.names[0] = {"labelText" => "TEST-CATEGORY", "language" => {"id" => 1}}
+			new_service_category.names[1] = {"labelText" => "TEST-CATEGORY", "language" => {"id" => 11}} 	
+
+			new_service_category.parent = {'id' => 6}	
+
+			new_service_category.displayOrder = 1
+
+			new_service_category.create(client)
+
+			expect(new_service_category).to be_a(OSCRuby::ServiceCategory)
+
+			expect(new_service_category.name).to eq("TEST-CATEGORY")
+
+			expect(new_service_category.lookupName).to eq("TEST-CATEGORY")
+
+			expect(new_service_category.displayOrder).to eq(1)
+
+		end
+
+
+		it 'should return the body object if the json_response param is set to true', :vcr do
+
+			new_service_category.displayOrder = 11
+
+			new_service_category.parent = {'id' => 6}
+
+			new_service_category.names[0] = {"labelText" => "TEST-CATEGORY", "language" => {"id" => 1}}
+			new_service_category.names[1] = {'labelText' => 'TEST-CATEGORY', 'language' => {'id' => 11}} 	
+
+			expect(new_service_category.create(client,true)).to be_a(String)
+
+		end
+
+	end
+
+	context '#find' do
+
+		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not' do
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			client = nil
+
+			expect{OSCRuby::ServiceCategory.find(client,6)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should raise an error if ID is undefined' do
+
+			expect{OSCRuby::ServiceCategory.find(client)}.to raise_error('ID cannot be nil')
+
+		end
+
+		it 'should raise an error if ID is not an integer' do
+
+			expect{OSCRuby::ServiceCategory.find(client, 'a')}.to raise_error('ID must be an integer')
+
+		end
+
+		it 'should return a warning if empty/no instances of the object can be found', :vcr do
+
+			expect{OSCRuby::ServiceCategory.find(client, 1)}.to raise_error('There were no objects matching your query; please try again.')
+
+		end
+
+
+		it 'should return an instance of a new OSCRuby::ServiceCategory object with at least a name and displayOrder', :vcr do
+		
+			known_working_category = OSCRuby::ServiceCategory.find(client, 6)
+
+			expect(known_working_category).to be_an(OSCRuby::ServiceCategory)
+
+			expect(known_working_category.name).to eq('Manuals & Guides')
+
+			expect(known_working_category.displayOrder).to eq(2)
+
+		end
+
+		it 'should return the raw json response if the return_json parameter is set to true', :vcr do
+
+			known_working_category_in_json = OSCRuby::ServiceCategory.find(client, 6, true)
+
+			expect(known_working_category_in_json).to be_an(String)
+
+		end
+
+	end
+
+	context '#all' do
+
+		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not' do
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			client = nil
+
+			expect{OSCRuby::ServiceCategory.all(client)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should return multiple instances of OSCRuby::ServiceCategory', :vcr do
+
+			categories = OSCRuby::ServiceCategory.all(client)
+
+			expect(categories.size).to be > 0
+
+			# puts "Checking if OSCRuby::ServiceCategory.all produces multiple instances of categories"
+
+			categories.each_with_index do |p,i|
+
+				if i < 10
+
+					expect(p).to be_an(OSCRuby::ServiceCategory)
+
+					# puts p.name
+
+				end
+
+			end
+
+		end
+
+		it 'should just return JSON if the return_json parameter is set to true', :vcr do
+
+			expect(OSCRuby::ServiceCategory.all(client,true)).to be_a(String)
+
+		end
+
+	end
+
+	context '#where' do
+
+		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not' do
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			client = nil
+
+			expect{OSCRuby::ServiceCategory.where(client,'query')}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should raise an error if there is no query' do
+
+			expect{OSCRuby::ServiceCategory.where(client)}.to raise_error('A query must be specified when using the "where" method')
+
+		end
+
+		it 'should take a query and return results', :vcr do
+
+			categories_lvl_1 = OSCRuby::ServiceCategory.where(client,"parent is null and lookupname not like 'Unsure'")
+
+			expect(categories_lvl_1.count).to be > 0
+
+			categories_lvl_1.each_with_index do |p,i|
+
+				if i < 10
+
+					expect(p).to be_an(OSCRuby::ServiceCategory)
+
+					# puts p.name
+
+				end
+
+			end
+
+		end
+
+		it 'should raise an error if the query returns 0 results', :vcr do
+
+			expect{OSCRuby::ServiceCategory.where(client,"parent = 6546546546546")}.to raise_error('There were no objects matching your query; please try again.')
+
+		end
+
+		it 'should just return JSON if the return_json parameter is set to true', :vcr do
+
+			parents = OSCRuby::ServiceCategory.where(client,"parent is null and lookupname not like 'Unsure'",true)
+
+			expect(parents).to be_a(String)
+
+			# puts parents
+
+		end
+
+	end
+
+		
+
+	context '#update' do
+
+		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not', :vcr do
+
+			known_working_category = OSCRuby::ServiceCategory.find(client, 6)
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			client = nil
+
+			expect{known_working_category.update(client)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should expect that the Service Category is an instance of a OSCRuby::ServiceCategory', :vcr do
+
+			known_working_category = OSCRuby::ServiceCategory.find(client, 6)
+
+			expect(known_working_category).to be_an(OSCRuby::ServiceCategory)
+
+		end
+
+		it 'should expect that the category has an ID and spit out an error if it does not', :vcr do
+
+			known_working_category = OSCRuby::ServiceCategory.find(client, 6)
+
+			known_working_category.id = nil
+
+			expect{known_working_category.destroy(client)}.to raise_error('OSCRuby::ServiceCategory must have a valid ID set')
+		
+		end
+
+		it 'should update name when the names is updated', :vcr do
+
+			test_prods = OSCRuby::ServiceCategory.where(client,"name like 'TEST-CATEGORY'")
+			first_prod = test_prods[0]
+
+			first_prod.names[0] = {"labelText" => "TEST-CATEGORY-UPDATED", "language" => {"id" => 1}}
+
+			first_prod.update(client)
+
+			expect(first_prod.name).to eq('TEST-CATEGORY-UPDATED')
+
+		end
+
+		it 'should just return JSON if the return_json parameter is set to true', :vcr do
+
+			known_working_category = OSCRuby::ServiceCategory.find(client, 6)
+
+			test = known_working_category.update(client,true)
+
+			expect(test).to be_a(String)
+
+		end
+
+	end
+
+	context '#destroy' do
+
+		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not', :vcr do
+
+			test_prods = OSCRuby::ServiceCategory.where(client,"name like 'TEST-CATEGORY-UPDATED'")
+			category_to_delete = test_prods[0]
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			client = nil
+
+			expect{category_to_delete.destroy(client)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should expect that the Service Category is an instance of a OSCRuby::ServiceCategory', :vcr do
+
+			test_prods = OSCRuby::ServiceCategory.where(client,"name like 'TEST-CATEGORY-UPDATED'")
+			category_to_delete = test_prods[0]
+
+			expect(category_to_delete).to be_an(OSCRuby::ServiceCategory)
+
+		end
+
+		it 'should expect that the category has an ID and spit out an error if it does not', :vcr do
+
+			test_prods = OSCRuby::ServiceCategory.where(client,"name like 'TEST-CATEGORY-UPDATED'")
+			category_to_delete = test_prods[0]
+
+			category_to_delete.id = nil
+
+			expect{category_to_delete.destroy(client)}.to raise_error('OSCRuby::ServiceCategory must have a valid ID set')
+		
+		end
+
+		it 'should delete the category', :vcr do
+
+			test_prods = OSCRuby::ServiceCategory.where(client,"name like 'TEST-CATEGORY-UPDATED'")
+			category_to_delete = test_prods[0]
+
+			id_to_find = category_to_delete.id
+
+			category_to_delete.destroy(client)
+
+			expect{OSCRuby::ServiceCategory.find(client, id_to_find)}.to raise_error('There were no objects matching your query; please try again.')
+		
+		end
+
+	end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rajan Davis
@@ -146,7 +146,9 @@ files:
 - lib/osc_ruby/client.rb
 - lib/osc_ruby/configuration.rb
 - lib/osc_ruby/connect.rb
+- lib/osc_ruby/incident.rb
 - lib/osc_ruby/query_module.rb
+- lib/osc_ruby/service_category.rb
 - lib/osc_ruby/service_product.rb
 - lib/osc_ruby/validations_module.rb
 - lib/osc_ruby/version.rb
@@ -155,6 +157,7 @@ files:
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
+- spec/core/service_category_spec.rb
 - spec/core/service_product_spec.rb
 - spec/core/spec_helper.rb
 - tasks/rspec.rake
@@ -187,6 +190,7 @@ test_files:
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
+- spec/core/service_category_spec.rb
 - spec/core/service_product_spec.rb
 - spec/core/spec_helper.rb
 has_rdoc: