osc_ruby 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5fceb5a701385dfdf593d2018410925e3d2c631
-  data.tar.gz: a710392b55caf3ccf113c13336a0d7515732bc7a
+  metadata.gz: 3886686a1a45880611a4e06689c3c4ae573a3f30
+  data.tar.gz: 276a472588a6495a688103ac8756184c03b60904
 SHA512:
-  metadata.gz: 5595b2e78e460d81cf28f7e6492c23e419c10af3fa2c3f36b9a4ee51a47d43513b11ba26a564cd16cb79ba78687557d8b98489e6217f763c1ddafb7ad3bc8dcd
-  data.tar.gz: 66147bd97652d38700723080f4c28e4760de2f4aa65cb3bfc49f80fbf623b0abfee0a239ea0f7eac074c0f440480c9df89a25d2d215a61fa78d955d8c9459085
+  metadata.gz: f9cd46f98226b08627060983f4d16bd722a05048bb06f9c0bb135a16743c4e68c6e5dfc2a6538e703d8fee299158a7694b256388ab78ad309931684d7cd3103b
+  data.tar.gz: a940df9e72dda18074ab014b1be6b490044bfe3a6aa141fe142e5a1af8206fc33fd5f69428b6a4d1dfd733d30d81ee59bf39b634a474d70d71d18db15815238c

data/README.md

@@ -43,7 +43,7 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 
 
 	# NOTE: Make sure that in a production environment
-	# that the following methods are wrapped in a try/catch block.
+	# that the following methods are wrapped in a begin/rescue block.
 
 	# If a null set is returned by your query
 	# an exception will be raised
@@ -91,11 +91,10 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 	# the REST API does not like it when the queries are wrapped in single quotes ('')
 	# with strings escaped by double quotes
 
-	# Just a weird little quirk I noticed :laughing:
-
 	# For example
 	# "parent is null and lookupName!='Unsure'" => great!
-	# 'parent is null and lookupName!="Unsure"' => don't do this, it will spit back an error from the REST API!
+	# 'parent is null and lookupName!="Unsure"' => don't do this
+	# it will spit back an error from the REST API!
 
 	products_lvl_1 = OSCRuby::ServiceProduct.where(rn_client,"parent is null and lookupName!='Unsure'")
 
@@ -178,7 +177,7 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 	
 - [x] all
 
-- [ ] update
+- [x] update
 
 - [ ] destroy
 

data/lib/osc_ruby/query_module.rb

@@ -36,6 +36,12 @@ module OSCRuby
 
 		end
 
+		def self.destroy(rn_client,resource)
+
+			OSCRuby::Connect.delete(rn_client,resource)
+			
+		end
+
 		def self.normalize(input)
 
 			if input.code.to_i == 404

data/lib/osc_ruby/service_product.rb

@@ -13,11 +13,11 @@ module OSCRuby
 
 	    def initialize(attributes = nil)
 
-	    		@names = []
+    		@names = []
 
-				@adminVisibleInterfaces = []
+			@adminVisibleInterfaces = []
 
-				@endUserVisibleInterfaces = []
+			@endUserVisibleInterfaces = []
 
 			if attributes.nil?
 
@@ -51,7 +51,7 @@ module OSCRuby
 
 	    	new_product = self
 
-	    	final_json = self.class.check_self_for_create_and_update_methods(new_product)
+	    	final_json = self.class.check_self(new_product)
 
 	    	resource = URI.escape("/serviceProducts")
 
@@ -101,15 +101,15 @@ module OSCRuby
 
 	    	service_product_json = QueryModule::find(client,resource)
 
-	    	if return_json == true
+			if return_json == true
 
-	    		service_product_json
+				service_product_json
 
-	    	else
+			else
 
-		    	service_product_json_final = JSON.parse(service_product_json)
+				service_product_json_final = JSON.parse(service_product_json)
 
-		      	new_from_fetch(service_product_json_final[0])
+				new_from_fetch(service_product_json_final[0])
 
 			end
 
@@ -167,7 +167,9 @@ module OSCRuby
 
 	    	product_to_update = self
 
-	    	final_json = self.class.check_self_for_create_and_update_methods(product_to_update,true)
+	    	self.class.check_for_id(product_to_update)
+
+	    	final_json = self.class.check_self(product_to_update,true)
 
 	    	resource = URI.escape("/serviceProducts/#{product_to_update.id}")
 
@@ -195,6 +197,40 @@ module OSCRuby
 
 	    end
 
+	    def destroy(client, return_json = false)
+
+	    	self.class.check_client(client)
+
+	    	product_to_destroy = self
+
+	    	self.class.check_for_id(product_to_destroy)
+
+	    	resource = URI.escape("/serviceProducts/#{product_to_destroy.id}")
+
+	    	response = QueryModule::destroy(client,resource)
+
+	    	if response.code.to_i == 200 && return_json == false
+
+	    		nil
+
+	    	elsif return_json == true
+
+	    		response.body
+
+	    	end
+
+	    end
+
+
+
+
+
+
+
+
+
+
+
 	    # Convenience Methods for making the CRUD operations nicer to use
 
 		def self.new_from_fetch(attributes)
@@ -205,45 +241,118 @@ module OSCRuby
 
 		end
 
-	    
-		def self.check_self_for_create_and_update_methods(obj,is_update = false)
+		def self.check_for_id(obj)
+
+			if obj.id.nil?
 
-			empty_arr = []				
+	    		raise ArgumentError, 'OSCRuby::ServiceProduct must have a valid ID set'
+
+	    	end
+
+		end
 
-    		empty_arr[0] = {}
+		def self.check_self(obj,is_update = false)
 
-			obj.instance_variables.each {|var| empty_arr[0][var.to_s.delete("@")] = obj.instance_variable_get(var)}
+			obj_attrs = self.extract_attributes(obj)
 
 			if is_update == true
-				empty_arr[0].delete('id')
-				empty_arr[0].delete('lookupName')
-				empty_arr[0].delete('createdTime')
-				empty_arr[0].delete('updatedTime')
-				empty_arr[0].delete('name')
+			
+				obj_attrs = remove_unused_new_attrs(obj_attrs)
+			
+			else
+
+				obj_attrs = check_for_names(obj_attrs)
+
+				obj_attrs = check_for_parents(obj_attrs)
+				
 			end
 
-			if is_update == false && (empty_arr[0]['names'].count == 0 || empty_arr[0]['names'][0]['labelText'].nil? || empty_arr[0]['names'][0]['language'].nil?)
+			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, 'ServiceProduct should at least have one name set (new_service_product.names[0] = {"labelText" => "QTH45-test", "language" => {"id" => 1}} )'
+			
 			end
 
-			if !empty_arr[0]['adminVisibleInterfaces'].nil? && empty_arr[0]['adminVisibleInterfaces'].empty?
-				empty_arr[0].delete('adminVisibleInterfaces')
+			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
 
-			if !empty_arr[0]['endUserVisibleInterfaces'].nil? && empty_arr[0]['endUserVisibleInterfaces'].empty?
-				empty_arr[0].delete('endUserVisibleInterfaces')
+			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
 
-			if !empty_arr[0]['parent'].nil? && empty_arr[0]['parent'].is_a?(Hash) && !empty_arr[0]['parent'].key?('id') && !empty_arr[0]['parent'].key?('lookupName')
-				empty_arr[0].delete('parent')
-			elsif is_update == true && !empty_arr[0]['parent'].nil?
-				empty_arr[0].delete('parent')
+			obj_attrs
+
+		end
+
+		def self.extract_attributes(obj)
+
+			empty_arr = [{}]
+
+			obj_vars = obj.instance_variables
+
+			obj_vars.each do |var| 
+
+				obj_attr = var.to_s.delete("@")
+
+				obj_attr_val = obj.instance_variable_get(var)
+
+				empty_arr[0][obj_attr] = obj_attr_val
+
+			end
+
+			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
 
+
+
+		# Will probably extract the following into a Validations class or something
+
 		def self.check_attributes(attributes)
 
 			if attributes.class != Hash
@@ -256,7 +365,7 @@ module OSCRuby
 
 	    def self.check_query(query)
 
-	    	if query.empty?
+			if query.empty?
 				
 				raise ArgumentError, 'A query must be specified when using the "where" method'
 

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

data/spec/core/service_product_spec.rb

@@ -143,8 +143,8 @@ describe OSCRuby::ServiceProduct do
 
 		it 'should return an instance of an OSCRuby::ServiceProduct if the json_response param is set to false (which it is by default)' do
 
-			new_service_product.names[0] = {"labelText" => "QTH45", "language" => {"id" => 1}}
-			new_service_product.names[1] = {"labelText" => "QTH45", "language" => {"id" => 11}} 		
+			new_service_product.names[0] = {"labelText" => "TEST-PRODUCT", "language" => {"id" => 1}}
+			new_service_product.names[1] = {"labelText" => "TEST-PRODUCT", "language" => {"id" => 11}} 		
 
 			new_service_product.parent = {'id' => 102}
 
@@ -154,9 +154,9 @@ describe OSCRuby::ServiceProduct do
 
 			expect(new_service_product).to be_a(OSCRuby::ServiceProduct)
 
-			expect(new_service_product.name).to eq("QTH45")
+			expect(new_service_product.name).to eq("TEST-PRODUCT")
 
-			expect(new_service_product.lookupName).to eq("QTH45")
+			expect(new_service_product.lookupName).to eq("TEST-PRODUCT")
 
 			expect(new_service_product.displayOrder).to eq(4)
 
@@ -167,8 +167,8 @@ describe OSCRuby::ServiceProduct do
 
 		it 'should return the body object if the json_response param is set to true' do
 
-			new_service_product.names[0] = {"labelText" => "QTH45-test", "language" => {"id" => 1}}
-			new_service_product.names[1] = {'labelText' => 'QTH45-test', 'language' => {'id' => 11}} 	
+			new_service_product.names[0] = {"labelText" => "TEST-PRODUCT", "language" => {"id" => 1}}
+			new_service_product.names[1] = {'labelText' => 'TEST-PRODUCT', 'language' => {'id' => 11}} 	
 
 			expect(new_service_product.create(client,true)).to be_a(String)
 
@@ -334,7 +334,7 @@ describe OSCRuby::ServiceProduct do
 		OSCRuby::ServiceProduct.find(client, 100)
 	}
 
-	context 'update' do
+	context '#update' do
 
 		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not' do
 
@@ -346,6 +346,20 @@ describe OSCRuby::ServiceProduct do
 
 		end
 
+		it 'should expect that the Service Product is an instance of a OSCRuby::ServiceProduct' do
+
+			expect(known_working_product).to be_an(OSCRuby::ServiceProduct)
+
+		end
+
+		it 'should expect that the product has an ID and spit out an error if it does not' do
+
+			known_working_product.id = nil
+
+			expect{known_working_product.destroy(client)}.to raise_error('OSCRuby::ServiceProduct must have a valid ID set')
+		
+		end
+
 		it 'should update name when the names is updated' do
 
 			test_prods = OSCRuby::ServiceProduct.where(client,"name like 'QTH45-test'")
@@ -369,4 +383,49 @@ describe OSCRuby::ServiceProduct do
 
 	end
 
+	let(:product_to_delete){
+
+		test_prods = OSCRuby::ServiceProduct.where(client,"name like 'TEST-PRODUCT'")
+		test_prods[0]
+
+	}
+
+	context '#destroy' 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{product_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 Product is an instance of a OSCRuby::ServiceProduct' do
+
+			expect(product_to_delete).to be_an(OSCRuby::ServiceProduct)
+
+		end
+
+		it 'should expect that the product has an ID and spit out an error if it does not' do
+
+			product_to_delete.id = nil
+
+			expect{product_to_delete.destroy(client)}.to raise_error('OSCRuby::ServiceProduct must have a valid ID set')
+		
+		end
+
+		it 'should delete the product' do
+
+			id_to_find = product_to_delete.id
+
+			product_to_delete.destroy(client)
+
+			expect{OSCRuby::ServiceProduct.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.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Rajan Davis