osc_ruby 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77eafd8f4bbe64489df79808e47d367d93695cdb
-  data.tar.gz: dffc51633630ea0f0f374083d28ec0276808bf4c
+  metadata.gz: fcd220980ce2649919596ac53c856ab62f7b99e0
+  data.tar.gz: 311d5a6749cf7e471413b393dda6415fb4826536
 SHA512:
-  metadata.gz: 15c211a375b94724d52da156efa20d7cc9efc5ba26e4e9081f2dcf0c9e84fec279b806d672024ed24ab9bb70a4e604e1f7b82193f1d7d2e06159699e35e9109c
-  data.tar.gz: 20caeb4cda1860cd9d77351ff5f9eda6ab34c1527a30b6c5569e000e4a4382219bcf02e8a6f49bdd6aaf8365ac62dcb6f3284a5f2c0f49d49e0c31d7641e960e
+  metadata.gz: 8382c574776ac272cbf0c92d2dff5c128dd7405341433e875df5e9923922acdb30f6b991d7c69612ceeb3ad2a356768e405b7d46c4ca7c694d0f4d9f969f6936
+  data.tar.gz: e27f0bd63323b296b7a974692827a265f4f15395d80c292f115642592e9fa71133d983a3bf25a4e6f551a30971c23f9e8b0931bdc4999313f8d224084115d6b6

data/lib/osc_ruby/{answer.rb → classes/answer.rb}

@@ -1,6 +1,9 @@
+require 'osc_ruby/modules/nested_resource_module'
+
 module OSCRuby
 	
 	class Answer < ServiceClass
+		include NestedResourceModule
 		
 		attr_accessor :answerType, :language, :summary, :id, :lookupName, :createdTime, :updatedTime, :accessLevels, :name, :adminLastAccessTime, :expiresDate, :guidedAssistance, :keywords, :lastAccessTime, :lastNotificationTime, :nextNotificationTime, :originalReferenceNumber, :positionInList,
 			:publishOnDate, :question, :solution, :updatedByAccount, :uRL, :categories

data/lib/osc_ruby/classes/incident.rb

@@ -0,0 +1,13 @@
+require 'osc_ruby/modules/nested_resource_module'
+
+module OSCRuby
+	
+	class Incident < ServiceClass
+	
+	# TODO BUILD CLASS
+	
+
+
+	end
+
+end

data/lib/osc_ruby/classes/query_results.rb

@@ -0,0 +1,61 @@
+require 'osc_ruby/connect'
+require 'osc_ruby/modules/validations_module'
+require 'osc_ruby/modules/normalize_module'
+require 'json'
+
+module OSCRuby
+
+	class QueryResults
+
+		include QueryModule
+		include ValidationsModule
+
+		def initialize; end
+
+		def query(client,query,return_json = false)
+
+			ValidationsModule::check_client(client)
+
+			ValidationsModule::check_query(query,"query")
+
+			@query = URI.escape("queryResults/?query=#{query}")
+
+	    	response = QueryModule::find(client,@query)
+
+	    	json_response = JSON.parse(response) 
+
+	    	json_response.unshift("\n")
+
+	    	if return_json == true
+	    		json_response_final = NormalizeModule::query_injection(query,json_response)
+	    		puts json_response_final
+	    	end
+
+	    	NormalizeModule::remove_new_lines(json_response)
+ 
+		end
+
+		def nested_query(client,query,return_json = false)
+
+			ValidationsModule::check_client(client)
+
+			ValidationsModule::check_query(query,"query")
+
+			@query = URI.escape("queryResults/?query=#{query}")
+
+	    	response = QueryModule::nested_find(client,@query)
+
+	    	json_response = JSON.parse(response) 
+
+	    	if return_json == true
+	    		json_response_final = NormalizeModule::query_injection(query,json_response)
+	    		puts json_response_final
+	    	end
+
+	    	NormalizeModule::remove_new_lines(json_response)
+ 
+		end
+	
+	end
+
+end

data/lib/osc_ruby/{service_class.rb → classes/service_class.rb}

@@ -1,10 +1,10 @@
 require 'osc_ruby/client'
-require 'osc_ruby/query_module'
-require 'osc_ruby/validations_module'
-require 'osc_ruby/class_factory_module'
+require 'osc_ruby/modules/query_module'
+require 'osc_ruby/modules/validations_module'
+require 'osc_ruby/modules/class_factory_module'
 require 'json'
 require 'uri'
-require_relative '../ext/string'
+require_relative '../../ext/string.rb'
 
 module OSCRuby
 	

data/lib/osc_ruby/{class_factory_module.rb → modules/class_factory_module.rb}

@@ -1,5 +1,5 @@
 require 'osc_ruby/connect'
-require 'osc_ruby/validations_module'
+require 'osc_ruby/modules/validations_module'
 require 'json'
 
 module OSCRuby
@@ -8,7 +8,7 @@ module OSCRuby
 
 		class << self
 
-			def new_from_fetch(attributes,class_name)
+			def new_from_fetch(attributes,class_name,custom_or_nested = nil)
 
 		    	ValidationsModule.check_attributes(attributes)
 
@@ -40,7 +40,7 @@ module OSCRuby
 
 			end
 
-			def find(client,id,obj_query,return_json,class_name)
+			def find(client,id,obj_query,return_json,class_name,custom_or_nested = nil)
 
 		    	ValidationsModule::check_client(client)
 
@@ -60,13 +60,13 @@ module OSCRuby
 
 					class_json_final = JSON.parse(class_json)
 
-					ClassFactoryModule::new_from_fetch(class_json_final[0],class_name)
+					ClassFactoryModule::new_from_fetch(class_json_final[0],class_name,custom_or_nested = nil)
 
 				end
 
 			end
 
-			def all(client,obj_query,return_json,class_name)
+			def all(client,obj_query,return_json,class_name,custom_or_nested = nil)
 
 				ValidationsModule::check_client(client)
 	    	
@@ -74,11 +74,11 @@ module OSCRuby
 
 				object_json = QueryModule::find(client,resource)
 
-				ClassFactoryModule::instantiate_multiple_objects(return_json, object_json, class_name)
+				ClassFactoryModule::instantiate_multiple_objects(return_json, object_json, class_name,custom_or_nested = nil)
 
 			end
 
-			def where(client,query,object_in_query,return_json,class_name)
+			def where(client,query,object_in_query,return_json,class_name,custom_or_nested = nil)
 
 				ValidationsModule::check_client(client)
 
@@ -88,7 +88,7 @@ module OSCRuby
 
 		    	object_json = QueryModule::find(client,@query)
 
-		    	ClassFactoryModule::instantiate_multiple_objects(return_json, object_json, class_name)
+		    	ClassFactoryModule::instantiate_multiple_objects(return_json, object_json, class_name,custom_or_nested = nil)
 
 			end
 
@@ -140,7 +140,7 @@ module OSCRuby
 
 		    end
 
-		    def instantiate_multiple_objects(return_json, object_json, class_name)
+		    def instantiate_multiple_objects(return_json, object_json, class_name,custom_or_nested = nil)
 
 		    	if return_json == true
 
@@ -150,7 +150,7 @@ module OSCRuby
 
 			    	object_json_final = JSON.parse(object_json)
 
-			    	object_json_final.map { |attributes| ClassFactoryModule::new_from_fetch(attributes,class_name) }
+			    	object_json_final.map { |attributes| ClassFactoryModule::new_from_fetch(attributes,class_name,custom_or_nested = nil) }
 
 			    end
 

data/lib/osc_ruby/modules/nested_resource_module.rb

@@ -0,0 +1,10 @@
+module OSCRuby
+	module NestedResourceModule
+		class << self
+			def get_resource(rn_client,originator,resource)
+				puts "#{originator.class} has an id of #{originator.id}"
+				resource.where(rn_client,"id < 100")
+			end
+		end
+	end
+end

data/lib/osc_ruby/{query_module.rb → modules/normalize_module.rb}

@@ -1,53 +1,52 @@
-require 'osc_ruby/connect'
-require 'osc_ruby/validations_module'
-require_relative '../ext/string'
-
 require 'json'
 
 module OSCRuby
 
-	module QueryModule
+	module NormalizeModule
 
 		class << self
 
-			include ValidationsModule
-		
-			def find(rn_client,resource)
-
-				obj_to_find = OSCRuby::Connect.get(rn_client,resource)
+			def normalize(input,resource)
 
-				if obj_to_find.code.to_i == 200 || obj_to_find.code.to_i == 201
+				if input.code.to_i == 404
 
-					check_obj_for_errors(obj_to_find)
+					input.body
 
-					normalize(obj_to_find,resource)
 				else
 
-					obj_to_find.body
+					json_input = JSON.parse(input.body)
+
+					final_hash = []
 
-				end
+					json_input['items'].each do |item|
 
-			end
+						item['rows'].each_with_index do |row,row_i|
 
-			def create(rn_client,resource,json_content)
+							obj_hash = {}
+							
+							item['columnNames'].each_with_index do |column,i|
+								obj_hash[column] = if !row[i].nil? && row[i].is_i? == true then row[i].to_i else row[i] end
+							end
 
-				OSCRuby::Connect.post_or_patch(rn_client,resource,json_content)
+							final_hash.push(obj_hash)
 
-			end
+							if json_input['items'].count > 1 && (item['rows'].count-1 <= row_i)
 
-			def update(rn_client,resource,json_content)
+								final_hash.push("\n")
 
-				OSCRuby::Connect.post_or_patch(rn_client,resource,json_content,true)
+							end
 
-			end
+						end
 
-			def destroy(rn_client,resource)
+					end
+
+					final_hash.to_json
+
+				end
 
-				OSCRuby::Connect.delete(rn_client,resource)
-				
 			end
 
-			def normalize(input,resource)
+			def nested_normalize(input,resource)
 
 				if input.code.to_i == 404
 
@@ -61,6 +60,8 @@ module OSCRuby
 
 					json_input['items'].each do |item|
 
+						item_array = []
+
 						item['rows'].each_with_index do |row,row_i|
 
 							obj_hash = {}
@@ -69,36 +70,22 @@ module OSCRuby
 								obj_hash[column] = if !row[i].nil? && row[i].is_i? == true then row[i].to_i else row[i] end
 							end
 
-							final_hash.push(obj_hash)
-
-							if json_input['items'].count > 1 && (item['rows'].count-1 <= row_i)
-
-								final_hash.push("\n")
-
-							end
+							item_array.push(obj_hash)
 
 						end
 
+						final_hash.push(item_array)
+
 					end
 
+					puts JSON.pretty_generate(final_hash)
+					
 					final_hash.to_json
 
 				end
 
 			end
 
-			def check_obj_for_errors(obj_to_check)
-
-				json_obj = JSON.parse(obj_to_check.body)
-
-				if !json_obj.nil? && json_obj['items'][0]['rows'].count == 0
-
-					raise ArgumentError, 'There were no objects matching your query; please try again.'
-
-				end
-
-			end
-
 			def query_injection(query,json_response)
 
 				queries = query.split(';')
@@ -131,7 +118,5 @@ module OSCRuby
 			end
 
 		end
-		
 	end
-
 end

data/lib/osc_ruby/modules/query_module.rb

@@ -0,0 +1,70 @@
+require 'osc_ruby/connect'
+require 'osc_ruby/modules/validations_module'
+require 'osc_ruby/modules/normalize_module'
+require_relative '../../ext/string.rb'
+
+module OSCRuby
+
+	module QueryModule
+
+		class << self
+
+			include ValidationsModule, NormalizeModule
+		
+			def find(rn_client,resource)
+
+				obj_to_find = OSCRuby::Connect.get(rn_client,resource)
+
+				if obj_to_find.code.to_i == 200 || obj_to_find.code.to_i == 201
+
+					ValidationsModule::check_obj_for_errors(obj_to_find)
+
+					NormalizeModule::normalize(obj_to_find,resource)
+				else
+
+					obj_to_find.body
+
+				end
+
+			end
+
+			def nested_find(rn_client,resource)
+
+				obj_to_find = OSCRuby::Connect.get(rn_client,resource)
+
+				if obj_to_find.code.to_i == 200 || obj_to_find.code.to_i == 201
+
+					ValidationsModule::check_obj_for_errors(obj_to_find)
+
+					NormalizeModule::nested_normalize(obj_to_find,resource)
+				else
+
+					obj_to_find.body
+
+				end
+
+			end
+
+			def create(rn_client,resource,json_content)
+
+				OSCRuby::Connect.post_or_patch(rn_client,resource,json_content)
+
+			end
+
+			def update(rn_client,resource,json_content)
+
+				OSCRuby::Connect.post_or_patch(rn_client,resource,json_content,true)
+
+			end
+
+			def destroy(rn_client,resource)
+
+				OSCRuby::Connect.delete(rn_client,resource)
+				
+			end
+
+		end
+		
+	end
+
+end

data/lib/osc_ruby/{validations_module.rb → modules/validations_module.rb}

@@ -139,6 +139,20 @@ module OSCRuby
 
 			end
 
+			def check_obj_for_errors(obj_to_check)
+
+				json_obj = JSON.parse(obj_to_check.body)
+
+				if !json_obj.nil? && json_obj['items'][0]['rows'].count == 0
+
+					puts obj_to_check.body
+
+					raise ArgumentError, 'There were no objects matching your query; please try again.'
+
+				end
+
+			end
+
 		end
 
 	end

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/lib/osc_ruby.rb

@@ -2,10 +2,10 @@ module OSCRuby; end
 
 require 'osc_ruby/client'
 require 'osc_ruby/connect'
-require 'osc_ruby/service_class'
-require 'osc_ruby/product_category_shared'
-require 'osc_ruby/service_product'
-require 'osc_ruby/service_category'
-require 'osc_ruby/answer'
-require 'osc_ruby/account'
-require 'osc_ruby/query_results'
+require 'osc_ruby/classes/service_class'
+require 'osc_ruby/classes/product_category_shared'
+require 'osc_ruby/classes/service_product'
+require 'osc_ruby/classes/service_category'
+require 'osc_ruby/classes/answer'
+require 'osc_ruby/classes/account'
+require 'osc_ruby/classes/query_results'

data/spec/core/answer_spec.rb

@@ -216,6 +216,17 @@ describe OSCRuby::Answer do
 
 		end
 
+		# it 'should be able to set the status of an answer', do
+
+		# 	new_answer.language['id'] = 1
+		# 	new_answer.answerType['lookupName'] = "HTML"
+
+		# 	new_answer.create(client)
+
+		# 	expect(new_answer).to be_a(OSCRuby::Answer)
+
+		# end
+
 
 		it 'should return the body object if the json_response param is set to true', :vcr do
 

data/spec/core/query_results_spec.rb

@@ -21,6 +21,38 @@ describe OSCRuby::QueryResults do
 		OSCRuby::QueryResults.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" do
 
 		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not' do
@@ -74,6 +106,28 @@ describe OSCRuby::QueryResults do
 			end 
 
 		end
+
+		context "#nested_query" do
+
+			it 'should take nested queries and return multiple objects',:vcr do
+
+				query = nested_attributes.map{|q| "select #{table}.#{q} from #{table} where ID = 2222" }.join("; ")
+
+
+				expect do
+					
+					results = query_results.nested_query(client,query,true)
+					expect(results.length).to eq(nested_attributes.length)
+
+					puts "Results : #{results.length} | Queries: #{nested_attributes.length}"
+
+				end.not_to raise_error
+
+
+				
+			end
+
+		end
 		
 	end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -141,20 +141,22 @@ files:
 - Rakefile
 - lib/ext/string.rb
 - lib/osc_ruby.rb
-- lib/osc_ruby/account.rb
-- lib/osc_ruby/answer.rb
-- lib/osc_ruby/class_factory_module.rb
+- lib/osc_ruby/classes/account.rb
+- lib/osc_ruby/classes/answer.rb
+- lib/osc_ruby/classes/incident.rb
+- lib/osc_ruby/classes/product_category_shared.rb
+- lib/osc_ruby/classes/query_results.rb
+- lib/osc_ruby/classes/service_category.rb
+- lib/osc_ruby/classes/service_class.rb
+- lib/osc_ruby/classes/service_product.rb
 - lib/osc_ruby/client.rb
 - lib/osc_ruby/configuration.rb
 - lib/osc_ruby/connect.rb
-- lib/osc_ruby/incident.rb
-- lib/osc_ruby/product_category_shared.rb
-- lib/osc_ruby/query_module.rb
-- lib/osc_ruby/query_results.rb
-- lib/osc_ruby/service_category.rb
-- lib/osc_ruby/service_class.rb
-- lib/osc_ruby/service_product.rb
-- lib/osc_ruby/validations_module.rb
+- lib/osc_ruby/modules/class_factory_module.rb
+- lib/osc_ruby/modules/nested_resource_module.rb
+- lib/osc_ruby/modules/normalize_module.rb
+- lib/osc_ruby/modules/query_module.rb
+- lib/osc_ruby/modules/validations_module.rb
 - lib/osc_ruby/version.rb
 - osc_ruby.gemspec
 - spec/core/account_spec.rb

data/lib/osc_ruby/query_results.rb

@@ -1,39 +0,0 @@
-require 'osc_ruby/connect'
-require 'osc_ruby/validations_module'
-require 'json'
-
-module OSCRuby
-
-	class QueryResults
-
-		include QueryModule
-		include ValidationsModule
-
-		def initialize; end
-
-		def query(client,query,return_json = false)
-
-			ValidationsModule::check_client(client)
-
-			ValidationsModule::check_query(query,"query")
-
-			@query = URI.escape("queryResults/?query=#{query}")
-
-	    	response = QueryModule::find(client,@query)
-
-	    	json_response = JSON.parse(response) 
-
-	    	json_response.unshift("\n")
-
-	    	if return_json == true
-	    		json_response_final = QueryModule::query_injection(query,json_response)
-	    		puts json_response_final
-	    	end
-
-	    	QueryModule::remove_new_lines(json_response)
- 
-		end
-	
-	end
-
-end