osc_ruby 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca63de8b887f3fd7a4f053fa2169013a9ec0121a
-  data.tar.gz: d51fe8fd736021ed2bcd74cf68b758e92ba0f25e
+  metadata.gz: 4bc50905b48d26b1698634ac20061eab7cce0419
+  data.tar.gz: 97085cc0a83a89712f99237331127003c33df28a
 SHA512:
-  metadata.gz: c907042c7cbad989ae25e304bfc85182b92295fd55c07eeb3159ff1af9695f93577383c68c27dd0a693bfb28b609e388b60efd805aaab044100d627fa50d7f41
-  data.tar.gz: e6340ed3dc8cf652e92cbfcac44abc7b184ef42c509e22c2f39c19144e6d358f04ebba1d8e6815348aca1a285313db841e54e0bdfa254b97e036c27501ebe757
+  metadata.gz: 61715b80abd499d58a54a092ca2182fddeb7d060c2cb5d4110310a23e677d8ca33aee8cfdcb9f89019ad4b9663fdeeca4952872d2b40bac617487c78baa87347
+  data.tar.gz: 4bdadebfd21df4e8a7d9f9d5a33250f138852020b357d9e1ad0f2ce2660e9441454c993c315bc2837d8ff5b3219654d2d5cb9418a1a8f8659e1093a1bb79d0bc

data/README.md

@@ -40,6 +40,18 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 	# callback with JSON details
 
 
+
+
+	# NOTE: Make sure that in a production environment
+	# that the following methods are wrapped in a try/catch block.
+
+	# If a null set is returned by your query
+	# an exception will be raised
+	# this is to ensure that you 
+	# handle your errors explicitly
+	# when writing scripts
+
+
 	# ServiceProduct fetch example (Completed 12/28/2016)
 
 	product = OSCRuby::ServiceProduct.find(rn_client,100)
@@ -53,7 +65,7 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 	puts product.displayOrder
 	# => 3
 
-	# ServiceProduct fetch all example
+	# ServiceProduct fetch all example (Completed 01/05/2017)
 
 	products = OSCRuby::ServiceProduct.all(rn_client)
 
@@ -71,6 +83,24 @@ 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"')
+
+	products_lvl_1.each do |p|
+
+		puts p.name
+
+	end
+
+	# => DVR/NVR
+	# => Cameras
+	# => Accessories
+
+
+
+
+
 	# ServiceProduct update example
 
 	product_to_update = OSCRuby::ServiceProduct.find(rn_client,100)
@@ -128,18 +158,14 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 - [x] Create a OSCRuby::ServiceProduct class
 
 - [x] Build a QueryModule Module with the following query methods to be shared between most if not all classes:
+
+- [x] create
 	
 - [x] find
+		
+- [x] where
 	
-- [ ] find_by
-	
-- [ ] where
-	
-- [ ] all
-
-- [ ] Also add the following remaining CRUD Functionality:
-
-- [x] create
+- [x] all
 
 - [ ] update
 
@@ -153,6 +179,8 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 
 - [ ] Make version default to 1.3 but an option to be set in the config class
 
+- [ ] Allow for the prefer:exclude-null-properties header => update config and connect class, update tests
+
 - [ ] Allow for Session Authorization => update config class and connect classes, update tests
 
 - [ ] Figure out how to do RDoc/Yardoc documentation or best in class documentation for using this Ruby ORM

data/lib/osc_ruby/connect.rb

@@ -3,6 +3,7 @@ require 'osc_ruby/client'
 require 'net/http'
 require 'openssl'
 require 'uri'
+require 'cgi'
 
 module OSCRuby
 	
@@ -14,6 +15,7 @@ module OSCRuby
 			@final_config = get_check(client,resource_url)
 
 			@uri = @final_config['site_url']
+
 			@username = @final_config['username']
 			@password = @final_config['password']
 

data/lib/osc_ruby/query_module.rb

@@ -11,9 +11,16 @@ module OSCRuby
 
 			obj_to_find = OSCRuby::Connect.get(rn_client,resource)
 
-			check_obj_for_errors(obj_to_find)
+			if obj_to_find.code.to_i == 200 || obj_to_find.code.to_i == 201
 
-			normalize(obj_to_find)
+				check_obj_for_errors(obj_to_find)
+
+				normalize(obj_to_find)
+			else
+
+				obj_to_find.body
+
+			end
 
 		end
 
@@ -57,7 +64,7 @@ module OSCRuby
 
 			json_obj = JSON.parse(obj_to_check.body)
 
-			if json_obj['items'][0]['rows'].count == 0
+			if !json_obj.nil? && json_obj['items'][0]['rows'].count == 0
 
 				raise ArgumentError, 'There were no objects matching your query; please try again.'
 

data/lib/osc_ruby/service_product.rb

@@ -116,6 +116,8 @@ module OSCRuby
 	    end
 
 	    def self.all(client, return_json = false)
+
+	    	check_client(client)
 	    	
 	    	resource = URI.escape("queryResults/?query=select * from serviceproducts")
 
@@ -135,6 +137,35 @@ module OSCRuby
 
 	    end
 
+	    def self.where(client, query = '', return_json = false)
+
+	    	check_client(client)
+
+	    	check_query(query)
+
+	    	@query = URI.escape("queryResults/?query=select * from serviceproducts where #{query}")
+
+	    	service_product_json = QueryModule::find(client,@query)
+
+	    	if return_json == true
+
+	    		service_product_json
+
+	    	else
+
+		    	service_product_json_final = JSON.parse(service_product_json)
+
+		    	service_product_json_final.map { |attributes| new_from_fetch(attributes) }
+
+		    end
+
+	    end
+
+
+
+	    # Convenience Methods for making the CRUD operations nicer to use
+
+
 		def self.new_from_fetch(attributes)
 
 	    	check_attributes(attributes)
@@ -143,6 +174,7 @@ module OSCRuby
 
 		end
 
+	    
 		def self.check_self_for_create_method(obj)
 
 			empty_arr = []
@@ -181,6 +213,16 @@ module OSCRuby
 
 		end
 
+	    def self.check_query(query)
+
+	    	if query.empty?
+				
+				raise ArgumentError, 'A query must be specified when using the "where" method'
+
+			end
+
+	    end
+
 		def self.check_client(client)
 
 			if client.class != OSCRuby::Client || client.nil?

data/lib/osc_ruby/version.rb

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

data/spec/core/service_product_spec.rb

@@ -232,13 +232,23 @@ describe OSCRuby::ServiceProduct do
 
 	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::ServiceProduct.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::ServiceProduct' do
 
 			products = OSCRuby::ServiceProduct.all(client)
 
 			expect(products.size).to be > 0
 
-			puts "Checking if OSCRuby::ServiceProduct.all produces multiple instances of products"
+			# puts "Checking if OSCRuby::ServiceProduct.all produces multiple instances of products"
 
 			products.each_with_index do |p,i|
 
@@ -246,6 +256,8 @@ describe OSCRuby::ServiceProduct do
 
 					expect(p).to be_an(OSCRuby::ServiceProduct)
 
+					# puts p.name
+
 				end
 
 			end
@@ -260,7 +272,59 @@ describe OSCRuby::ServiceProduct do
 
 	end
 
-	contect '#where' do
+	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::ServiceProduct.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::ServiceProduct.where(client)}.to raise_error('A query must be specified when using the "where" method')
+
+		end
+
+		it 'should take a query and return results' do
+
+			products_lvl_1 = OSCRuby::ServiceProduct.where(client,"parent is null and lookupname not like 'Unsure'")
+
+			expect(products_lvl_1.count).to be > 0
+
+			products_lvl_1.each_with_index do |p,i|
+
+				if i < 10
+
+					expect(p).to be_an(OSCRuby::ServiceProduct)
+
+					# puts p.name
+
+				end
+
+			end
+
+		end
+
+		it 'should raise an error if the query returns 0 results' do
+
+			expect{OSCRuby::ServiceProduct.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' do
+
+			parents = OSCRuby::ServiceProduct.where(client,"parent is null and lookupname not like 'Unsure'",true)
+
+			expect(parents).to be_a(String)
+
+			# puts parents
+
+		end
 
 	end
 

metadata

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