osc_ruby 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4816953d57954604bf2efef9a71e993c9e064da
-  data.tar.gz: 06cd0e61915650193c822b2b56ccb0d8e2ebb877
+  metadata.gz: addca70579faf163b99b0b41f76e84f500c3cad4
+  data.tar.gz: b945a6eb88f1c95752a9191bbaa3eaac7a0ebf4a
 SHA512:
-  metadata.gz: 17c8a7590f2f1338459fe44736a98d7309d6b12329c3925a612fd670bbbf2c4b1bd6fa832c4169ddb5ec91506619b53057dd6a2e62a3d1d94245e00263459f8b
-  data.tar.gz: 67e0b1571808aaa97b26ac5dfb5207444bac3a65ddbfe8a4cfa103adbc3394ee77f419662fabb0c5e4559496ca6c36ee0a5dc2b68c761c2e3fc96f7d73454ad4
+  metadata.gz: 97dab4e79cfbcd88c0679b8c8e482939a578192431017d6bd24cc11f00b7b743488ca325cafaf60e749e5026c0db966c93700a6a26c7e9b65b61a8646a621dd4
+  data.tar.gz: 5bef5ced6a2eb9b464ebf89e75e8bb056b64a5bf557e9216bd744ce600fef9ea912751f353b71a303d501f7ac285f2f5a5b523c4807218d271652b6b29fafe59

data/Rakefile

@@ -1,3 +1,4 @@
 require "bundler/gem_tasks"
+task :default => :spec
 
 Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/osc_ruby.rb

@@ -2,4 +2,5 @@ module OSCRuby; end
 
 require 'osc_ruby/client'
 require 'osc_ruby/connect'
-require 'osc_ruby/classes/query_results'
+require 'osc_ruby/classes/query_results'
+require 'osc_ruby/classes/query_results_set'

data/lib/osc_ruby/classes/query_results.rb

@@ -13,7 +13,7 @@ module OSCRuby
 
 		def initialize; end
 
-		def query(client,query,return_json = false)
+		def query(client,query)
 
 			ValidationsModule::check_client(client)
 
@@ -23,21 +23,11 @@ module OSCRuby
 
 	    	response = QueryModule::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
-
-	    	if return_json.class == Hash
-	    		puts json_response.body
-	    	else
-		    	json_response.unshift("\n")
-		    	NormalizeModule::remove_new_lines(json_response)
- 			end
+	    	JSON.parse(response) 
  			
 		end
+
+
 	
 	end
 

data/lib/osc_ruby/classes/query_results_set.rb

@@ -0,0 +1,40 @@
+require_relative 'query_results'
+require 'osc_ruby/modules/validations_module'
+require 'ostruct'
+
+module OSCRuby
+
+	class QueryResultsSet < OpenStruct
+
+		include ValidationsModule
+
+		def query_set(client,*args)
+
+			ValidationsModule::check_client(client)
+			
+			query_arr = []
+			
+			key_map = []
+
+			args.each do |qh|
+
+				key_map.push(qh[:key])
+
+				query_arr.push(qh[:query])	
+			
+			end
+
+			query_results_set = OpenStruct.new
+			query_search = OSCRuby::QueryResults.new
+		
+
+			final_query_arr = query_arr.join('; ')
+			final_results = query_search.query(client,final_query_arr)
+
+			key_map.each_with_index {|k,i| query_results_set[k] = final_results[i]}
+			query_results_set
+		end
+
+	end 
+
+end

data/lib/osc_ruby/modules/normalize_module.rb

@@ -16,30 +16,45 @@ module OSCRuby
 
 					json_input = JSON.parse(input.body)
 
+					# initialize an array to hold all of the objects
 					final_hash = []
 
+					# loop through the items from the returned JSON response
 					json_input['items'].each do |item|
 
-						item['rows'].each_with_index do |row,row_i|
+							results_array = []
 
-							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
+					        # loop through rows
+					        item['rows'].each_with_index do |row,row_i|
 
-							final_hash.push(obj_hash)
+					                # initialize a hash to create the object
+					                obj_hash = {}
+					                
+					                # loop through the column names from the query
+					                item['columnNames'].each_with_index do |column,i|
 
-							if json_input['items'].count > 1 && (item['rows'].count-1 <= row_i)
+					                        # set the object property to the value of the row
+					                        # where the index of the value within that row
+					                        # matches the index of the column name
+					                        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("\n")
+					    			# push the hash into the array
+					    			results_array.push(obj_hash)
 
-							end
+					        end
 
-						end
+			    			# puts "this is an array:  #{final_hash}"
+					        final_hash.push(results_array)
 
+
+					end
+
+					if final_hash.size === 1
+						final_hash = final_hash.flatten!
 					end
 
+
 					final_hash.to_json
 
 				end
@@ -55,7 +70,7 @@ module OSCRuby
 				else
 
 					json_input = JSON.parse(input.body)
-
+					
 					final_hash = []
 
 					json_input['items'].each do |item|
@@ -78,7 +93,6 @@ module OSCRuby
 
 					end
 
-					puts JSON.pretty_generate(final_hash)
 					
 					final_hash.to_json
 
@@ -86,37 +100,8 @@ module OSCRuby
 
 			end
 
-			def query_injection(query,json_response)
-
-				queries = query.split(';')
-
-				count = 0
-
-				json_response.each_with_index do |hash,i|
-					if hash == "\n" && queries.count > 1
-						json_response[i] = "\nResults for #{queries[count]}:"
-						count += 1
-					elsif hash == "\n"
-						json_response.delete_at(i)
-					elsif json_response.last == "\n" 
-						json_response.delete_at(json_response.count - 1)
-					end
-				end
-
-				json_response
-
-			end
-
-			def remove_new_lines(json_response)
-				json_response.each_with_index do |hash,i|
-					if hash == "\n"
-						json_response.delete_at(i)
-					end
-				end
-
-				json_response
-			end
-
 		end
+
 	end
+	
 end

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/spec/core/connect_spec.rb

@@ -10,13 +10,15 @@ describe OSCRuby::Connect do
 
 		OSCRuby::Client.new do |config|
 		
-			config.interface = ENV['REDBOX_TEST']
+			config.interface = ENV['OSC_SITE']
 		
-			config.username = ENV['REDBOX_ADMIN']
+			config.username = ENV['OSC_ADMIN']
 		
-			config.password = ENV['REDBOX_PASSWORD']
+			config.password = ENV['OSC_PASSWORD']
 
 			config.suppress_rules = true
+
+			config.demo_site = true
 		
 		end
 	}
@@ -128,9 +130,9 @@ describe OSCRuby::Connect do
 
 			expect(final_config['site_url']).to be_an(URI::HTTPS)
 
-			expect(final_config['username']).to eq(ENV['REDBOX_ADMIN'])
+			expect(final_config['username']).to eq(ENV['OSC_ADMIN'])
 
-			expect(final_config['password']).to eq(ENV['REDBOX_PASSWORD'])
+			expect(final_config['password']).to eq(ENV['OSC_PASSWORD'])
 
 		end
 

data/spec/core/query_results_set_spec.rb

@@ -0,0 +1,109 @@
+require 'core/spec_helper'
+require 'json'
+require 'uri'
+
+describe OSCRuby::QueryResultsSet do
+
+	let(:client) { 
+
+		OSCRuby::Client.new do |config|
+		
+			config.interface = ENV['OSC_SITE']
+		
+			config.username = ENV['OSC_ADMIN']
+		
+			config.password = ENV['OSC_PASSWORD']
+
+			config.demo_site = true
+		
+		end
+	}
+
+	let(:query_results_set){
+		OSCRuby::QueryResultsSet.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_set" 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{query_results_set.query_set(client,'describe')}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+
+		## TO DO
+
+		# it 'should expect a hash with a key and query value set' do
+
+		# 	expect(client).to be_an(OSCRuby::Client)
+
+		# 	expect{query_results_set.query_set(client,"")}.to raise_error("A query must be specified when using the 'query' method")
+
+		# end
+
+
+		it 'should return results in set of OSCRuby::QueryResults',:vcr do 
+
+			expect(query_results_set.query_set(client,{key:"answers", query:"select * from answers LIMIT 2"},
+													  {key:"incidents", query:"describe incidents"})).to be_an(OpenStruct)
+
+
+		end
+
+		it 'should be able to manipulate and assign results data',:vcr do 
+
+			test = query_results_set.query_set(client, {key:"incidents", query:"select * from incidents limit 10"},
+													   {key:"serviceCategories", query:"describe serviceCategories"})		
+				expect(test.incidents).to be_an(Array)
+				expect(test.incidents.first).to be_a(Hash)
+				expect(test.incidents.first['id']).to be_a(Fixnum)
+				expect(test.serviceCategories).to be_an(Array)
+
+
+		end
+
+		it 'should be able to take multiple queries', :vcr do
+			answer_attrs = nested_attributes.map { |attr| {key: attr, query: "SELECT #{attr} FROM #{table} WHERE ID = 1"} }
+			test = query_results_set.query_set(client,*answer_attrs)
+		end
+		
+	end
+
+end	

data/spec/core/query_results_spec.rb

@@ -8,11 +8,13 @@ describe OSCRuby::QueryResults do
 
 		OSCRuby::Client.new do |config|
 		
-			config.interface = ENV['REDBOX_TEST']
+			config.interface = ENV['OSC_SITE']
 		
-			config.username = ENV['REDBOX_ADMIN']
+			config.username = ENV['OSC_ADMIN']
 		
-			config.password = ENV['REDBOX_PASSWORD']
+			config.password = ENV['OSC_PASSWORD']
+
+			config.demo_site = true
 		
 		end
 	}
@@ -81,7 +83,7 @@ describe OSCRuby::QueryResults do
 
 			# expect(query_results.query(client,"describe answers")).not_to eq(nil)
 
-			expect(query_results.query(client,"describe answers;describe serviceproducts",true)).to be_an(Array)
+			expect(query_results.query(client,"describe answers;describe serviceproducts")).to be_an(Array)
 
 			# expect(query_results.query(client,"describe answers;describe servicecategories")).not_to eq(nil)
 

data/spec/core/spec_helper.rb

@@ -9,7 +9,7 @@ VCR.configure do |c|
 	c.allow_http_connections_when_no_cassette = true
 	c.filter_sensitive_data('<OSC_ADMIN_USERNAME>') { ENV['OSC_ADMIN'] }
 	c.filter_sensitive_data('<OSC_ADMIN_PASSWORD>') { ENV['OSC_PASSWORD'] }
-	c.filter_sensitive_data('<TEST_INTERFACE>') { ENV['OSC_TEST1_SITE'] }
+	c.filter_sensitive_data('<TEST_INTERFACE>') { ENV['OSC_SITE'] }
 	c.filter_sensitive_data('<BASIC_AUTH>') { ENV['OSC_BASIC_64'] } 
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-09 00:00:00.000000000 Z
+date: 2017-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -160,6 +160,7 @@ files:
 - lib/ext/string.rb
 - lib/osc_ruby.rb
 - lib/osc_ruby/classes/query_results.rb
+- lib/osc_ruby/classes/query_results_set.rb
 - lib/osc_ruby/client.rb
 - lib/osc_ruby/configuration.rb
 - lib/osc_ruby/connect.rb
@@ -172,6 +173,7 @@ files:
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
+- spec/core/query_results_set_spec.rb
 - spec/core/query_results_spec.rb
 - spec/core/spec_helper.rb
 - tasks/rspec.rake
@@ -203,5 +205,6 @@ test_files:
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
+- spec/core/query_results_set_spec.rb
 - spec/core/query_results_spec.rb
 - spec/core/spec_helper.rb