osc_ruby 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bc50905b48d26b1698634ac20061eab7cce0419
-  data.tar.gz: 97085cc0a83a89712f99237331127003c33df28a
+  metadata.gz: c5fceb5a701385dfdf593d2018410925e3d2c631
+  data.tar.gz: a710392b55caf3ccf113c13336a0d7515732bc7a
 SHA512:
-  metadata.gz: 61715b80abd499d58a54a092ca2182fddeb7d060c2cb5d4110310a23e677d8ca33aee8cfdcb9f89019ad4b9663fdeeca4952872d2b40bac617487c78baa87347
-  data.tar.gz: 4bdadebfd21df4e8a7d9f9d5a33250f138852020b357d9e1ad0f2ce2660e9441454c993c315bc2837d8ff5b3219654d2d5cb9418a1a8f8659e1093a1bb79d0bc
+  metadata.gz: 5595b2e78e460d81cf28f7e6492c23e419c10af3fa2c3f36b9a4ee51a47d43513b11ba26a564cd16cb79ba78687557d8b98489e6217f763c1ddafb7ad3bc8dcd
+  data.tar.gz: 66147bd97652d38700723080f4c28e4760de2f4aa65cb3bfc49f80fbf623b0abfee0a239ea0f7eac074c0f440480c9df89a25d2d215a61fa78d955d8c9459085

data/README.md

@@ -83,9 +83,21 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 	# => QS Series
 	# => QT Series
 
-	# ServiceProduct where example
 
-	products_lvl_1 = OSCRuby::ServiceProduct.where(rn_client,'parent is null and lookupName!="Unsure"')
+	# ServiceProduct where example (Completed 01/05/2017) 
+
+	# NOTE: Make sure to put your queries wrapped in doublequotes("")
+	# this is because when Ruby converts the queries into a URI
+	# 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!
+
+	products_lvl_1 = OSCRuby::ServiceProduct.where(rn_client,"parent is null and lookupName!='Unsure'")
 
 	products_lvl_1.each do |p|
 
@@ -98,10 +110,7 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 	# => Accessories
 
 
-
-
-
-	# ServiceProduct update example
+	# ServiceProduct update example (Completed 01/05/2017)
 
 	product_to_update = OSCRuby::ServiceProduct.find(rn_client,100)
 
@@ -112,6 +121,8 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 	# ServiceProduct updated
 
 
+
+
 	# ServiceProduct destroy example
 
 	product_to_delete = OSCRuby::ServiceProduct.find(rn_client,100)

data/lib/osc_ruby/query_module.rb

@@ -30,6 +30,12 @@ module OSCRuby
 
 		end
 
+		def self.update(rn_client,resource,json_content)
+
+			OSCRuby::Connect.post_or_patch(rn_client,resource,json_content,true)
+
+		end
+
 		def self.normalize(input)
 
 			if input.code.to_i == 404

data/lib/osc_ruby/service_product.rb

@@ -13,17 +13,17 @@ module OSCRuby
 
 	    def initialize(attributes = nil)
 
-			if attributes.nil?
+	    		@names = []
 
-				@names = []
+				@adminVisibleInterfaces = []
 
-				@parent = {}
+				@endUserVisibleInterfaces = []
 
-				@displayOrder = 1
+			if attributes.nil?
 
-				@adminVisibleInterfaces = []
+				@parent = {}
 
-				@endUserVisibleInterfaces = []
+				@displayOrder = 1
 
 			else
 
@@ -51,7 +51,7 @@ module OSCRuby
 
 	    	new_product = self
 
-	    	final_json = self.class.check_self_for_create_method(new_product)
+	    	final_json = self.class.check_self_for_create_and_update_methods(new_product)
 
 	    	resource = URI.escape("/serviceProducts")
 
@@ -161,10 +161,41 @@ module OSCRuby
 
 	    end
 
+	    def update(client, return_json = false)
+
+	    	self.class.check_client(client)
 
+	    	product_to_update = self
 
-	    # Convenience Methods for making the CRUD operations nicer to use
+	    	final_json = self.class.check_self_for_create_and_update_methods(product_to_update,true)
+
+	    	resource = URI.escape("/serviceProducts/#{product_to_update.id}")
+
+	    	response = QueryModule::update(client,resource,final_json)
+
+	    	if response.code.to_i == 200 && return_json == false
+
+	    		updated_product = OSCRuby::ServiceProduct.find(client,product_to_update.id)
 
+	    		self.lookupName = updated_product.lookupName
+
+				self.createdTime = updated_product.createdTime
+
+				self.updatedTime = updated_product.updatedTime
+
+				self.name = updated_product.name
+
+				self.parent = updated_product.parent
+
+	    	elsif return_json == true
+
+	    		response.body
+
+	    	end
+
+	    end
+
+	    # Convenience Methods for making the CRUD operations nicer to use
 
 		def self.new_from_fetch(attributes)
 
@@ -175,27 +206,37 @@ module OSCRuby
 		end
 
 	    
-		def self.check_self_for_create_method(obj)
+		def self.check_self_for_create_and_update_methods(obj,is_update = false)
 
-			empty_arr = []
+			empty_arr = []				
 
-	    	empty_arr[0] = {}
+    		empty_arr[0] = {}
 
 			obj.instance_variables.each {|var| empty_arr[0][var.to_s.delete("@")] = obj.instance_variable_get(var)}
 
-			if empty_arr[0]['names'].count == 0 || empty_arr[0]['names'][0]['labelText'].nil? || empty_arr[0]['names'][0]['language'].nil?
+			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')
+			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?)
 				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'].empty?
+			if !empty_arr[0]['adminVisibleInterfaces'].nil? && empty_arr[0]['adminVisibleInterfaces'].empty?
 				empty_arr[0].delete('adminVisibleInterfaces')
 			end
 
-			if empty_arr[0]['endUserVisibleInterfaces'].empty?
+			if !empty_arr[0]['endUserVisibleInterfaces'].nil? && empty_arr[0]['endUserVisibleInterfaces'].empty?
 				empty_arr[0].delete('endUserVisibleInterfaces')
 			end
 
-			if !empty_arr[0]['parent'].key?('id') && !empty_arr[0]['parent'].key?('lookupName')
+			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')
 			end
 

data/lib/osc_ruby/version.rb

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

data/spec/core/service_product_spec.rb

@@ -206,10 +206,12 @@ describe OSCRuby::ServiceProduct do
 
 		end
 
+
 		let(:known_working_product){
 			OSCRuby::ServiceProduct.find(client, 100)
 		}
 
+
 		it 'should return an instance of a new OSCRuby::ServiceProduct object with at least a name and displayOrder' do
 
 			expect(known_working_product).to be_an(OSCRuby::ServiceProduct)
@@ -328,4 +330,43 @@ describe OSCRuby::ServiceProduct do
 
 	end
 
+	let(:known_working_product){
+		OSCRuby::ServiceProduct.find(client, 100)
+	}
+
+	context 'update' 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{known_working_product.update(client)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should update name when the names is updated' do
+
+			test_prods = OSCRuby::ServiceProduct.where(client,"name like 'QTH45-test'")
+			first_prod = test_prods[0]
+
+			first_prod.names[0] = {"labelText" => "QTH45-test-UPDATED", "language" => {"id" => 1}}
+
+			first_prod.update(client)
+
+			expect(first_prod.name).to eq('QTH45-test-UPDATED')
+
+		end
+
+		it 'should just return JSON if the return_json parameter is set to true' do
+
+			test = known_working_product.update(client,true)
+
+			expect(test).to be_a(String)
+
+		end
+
+	end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Rajan Davis