osc_ruby 0.1.13 → 0.2.0

data/lib/osc_ruby/class_factory_module.rb

@@ -0,0 +1,163 @@
+require 'osc_ruby/connect'
+require 'osc_ruby/validations_module'
+require 'json'
+
+module OSCRuby
+
+	module ClassFactoryModule
+
+		class << self
+
+			def new_from_fetch(attributes,class_name)
+
+		    	ValidationsModule.check_attributes(attributes)
+
+		    	class_name.new(attributes)
+
+			end
+
+			def create(client,obj,resource_uri,return_json)
+
+				ValidationsModule::check_client(client)
+
+		    	final_json = obj.class.check_self(obj)
+
+		    	resource = URI.escape(resource_uri)
+
+		    	response = QueryModule::create(client,resource,final_json)
+
+		    	response_body = JSON.parse(response.body)
+
+		    	if response.code.to_i == 201 && return_json == false
+
+					obj.set_attributes(response_body)
+
+		    	elsif return_json == true
+
+		    		response.body
+
+		    	end
+
+			end
+
+			def find(client,id,obj_query,return_json,class_name)
+
+		    	ValidationsModule::check_client(client)
+
+		    	ValidationsModule::check_for_id(id)
+
+		    	url = "queryResults/?query=select * from #{obj_query} where id = #{id}"
+		    		
+		    	resource = URI.escape(url)
+
+		    	class_json = QueryModule::find(client,resource)
+
+				if return_json == true
+
+					class_json
+
+				else
+
+					class_json_final = JSON.parse(class_json)
+
+					ClassFactoryModule::new_from_fetch(class_json_final[0],class_name)
+
+				end
+
+			end
+
+			def all(client,obj_query,return_json,class_name)
+
+				ValidationsModule::check_client(client)
+	    	
+				resource = URI.escape("queryResults/?query=select * from #{obj_query}")
+
+				object_json = QueryModule::find(client,resource)
+
+				ClassFactoryModule::instantiate_multiple_objects(return_json, object_json, class_name)
+
+			end
+
+			def where(client,query,object_in_query,return_json,class_name)
+
+				ValidationsModule::check_client(client)
+
+				ValidationsModule::check_query(query)
+
+				@query = URI.escape("queryResults/?query=select * from #{object_in_query} where #{query}")
+
+		    	object_json = QueryModule::find(client,@query)
+
+		    	ClassFactoryModule::instantiate_multiple_objects(return_json, object_json, class_name)
+
+			end
+
+		    def update(client,obj,resource_uri,return_json)
+
+				ValidationsModule::check_client(client)
+
+		    	ValidationsModule::check_object_for_id(obj,obj.class)
+
+		    	final_json = obj.class.check_self(obj,true)
+
+		    	resource = URI.escape("#{resource_uri}/#{obj.id}")
+
+		    	response = QueryModule::update(client,resource,final_json)
+
+		    	if response.code.to_i == 200 && return_json == false
+
+		    		updated_obj = obj.class.find(client,obj.id)
+
+		    		obj.update_attributes(updated_obj)
+
+		    	elsif return_json == true
+
+		    		response.body
+
+		    	end
+
+		    end
+
+		    def destroy(client,obj,resource_uri,return_json)
+
+		    	ValidationsModule::check_client(client)
+
+		    	ValidationsModule::check_object_for_id(obj,obj.class)
+
+		    	resource = URI.escape("/#{resource_uri}/#{obj.id}")
+
+		    	response = QueryModule::destroy(client,resource)
+
+		    	if response.code.to_i == 200 && return_json == false
+
+		    		nil
+
+		    	elsif return_json == true
+
+		    		response.body
+
+		    	end
+
+		    end
+
+		    def instantiate_multiple_objects(return_json, object_json, class_name)
+
+		    	if return_json == true
+
+		    		object_json
+
+		    	else
+
+			    	object_json_final = JSON.parse(object_json)
+
+			    	object_json_final.map { |attributes| ClassFactoryModule::new_from_fetch(attributes,class_name) }
+
+			    end
+
+		    end
+
+		end
+
+	end
+	
+end

data/lib/osc_ruby/client.rb

@@ -15,6 +15,7 @@ module OSCRuby
 	    	yield(config)
 
 	    	check_config
+	    	optional_check
 		end
 
 	    def check_config
@@ -23,10 +24,18 @@ module OSCRuby
 	    	elsif config.username ==''
 	    		raise ArgumentError, "Username cannot be nil or blank"
 	    	elsif config.password ==''
-	    		raise ArgumentError, "Password cannot be nil or blank"	
+	    		raise ArgumentError, "Password cannot be nil or blank"
 	    	end
 
 	    	true
 	    end
+
+	    def optional_check
+	    	if config.no_ssl_verify.class != FalseClass && config.no_ssl_verify.class != TrueClass
+	    		raise ArgumentError, "The no SSL verification setting must be set to true or false"
+	    	elsif config.version.nil?
+	    		raise ArgumentError, "Connect version cannot be null"
+	    	end
+	    end
 	end
 end

data/lib/osc_ruby/configuration.rb

@@ -3,9 +3,11 @@ module OSCRuby
 	class Configuration
 		# A holder class that holds the configuration information for the OSCRuby::Client block
 	
-	    attr_accessor :interface,:username,:password
+	    attr_accessor :interface,:username,:password,:no_ssl_verify,:version
 
 	    def initialize
+	    	@no_ssl_verify = false
+	    	@version = 'v1.3'
 	    end
 	end
 end

data/lib/osc_ruby/connect.rb

@@ -21,7 +21,7 @@ module OSCRuby
 
 			Net::HTTP.start(@uri.host, @uri.port,
 				:use_ssl => true,
-				:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+				:verify_mode => @final_config['ssl']) do |http|
 
 				request = Net::HTTP::Get.new @uri.request_uri
 
@@ -45,7 +45,7 @@ module OSCRuby
 
 			Net::HTTP.start(@uri.host, @uri.port,
 				:use_ssl => true, 
-				:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+				:verify_mode => @final_config['ssl']) do |http|
 
 				request = Net::HTTP::Post.new @uri.request_uri
 				request.basic_auth @username, @password
@@ -71,7 +71,7 @@ module OSCRuby
 
 			Net::HTTP.start(@uri.host, @uri.port,
 			  :use_ssl => true, 
-			  :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+			  :verify_mode => @final_config['ssl']) do |http|
 
 			  request = Net::HTTP::Delete.new @uri.request_uri
 			  request.basic_auth @username, @password
@@ -91,17 +91,25 @@ module OSCRuby
 
 			@config = client.config
 
-			if !resource_url.nil?
-				@resource_url = resource_url
+			@version = @config.version
+
+			if @config.no_ssl_verify == true
+
+				@ssl_verification = OpenSSL::SSL::VERIFY_NONE
+				
+			else
+				
+				@ssl_verification = OpenSSL::SSL::VERIFY_PEER
+
 			end
 
-		  	@url = "https://" + @config.interface + ".custhelp.com/services/rest/connect/v1.3/#{resource_url}"
+		  	@url = "https://" + @config.interface + ".custhelp.com/services/rest/connect/#{@version}/#{resource_url}"
 		  	
 		  	@final_uri = URI(@url)
 
 		  	@patch_request = patch_request == true ? true : false
 		  	
-		  	@final_config = {'site_url' => @final_uri, 'username' => @config.username, 'password' => @config.password, 'patch_request' => @patch_request}
+		  	@final_config = {'site_url' => @final_uri, 'username' => @config.username, 'password' => @config.password, 'patch_request' => @patch_request, 'ssl' => @ssl_verification}
 
 		end
 

data/lib/osc_ruby/query_module.rb

@@ -1,4 +1,5 @@
 require 'osc_ruby/connect'
+require 'osc_ruby/validations_module'
 require_relative '../ext/string'
 
 require 'json'
@@ -6,79 +7,85 @@ require 'json'
 module OSCRuby
 
 	module QueryModule
-	
-		def self.find(rn_client,resource)
 
-			obj_to_find = OSCRuby::Connect.get(rn_client,resource)
+		class << self
 
-			if obj_to_find.code.to_i == 200 || obj_to_find.code.to_i == 201
+			include ValidationsModule
+		
+			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
+
+					check_obj_for_errors(obj_to_find)
 
-				check_obj_for_errors(obj_to_find)
+					normalize(obj_to_find)
+				else
 
-				normalize(obj_to_find)
-			else
+					obj_to_find.body
 
-				obj_to_find.body
+				end
 
 			end
 
-		end
+			def create(rn_client,resource,json_content)
 
-		def self.create(rn_client,resource,json_content)
+				OSCRuby::Connect.post_or_patch(rn_client,resource,json_content)
 
-			OSCRuby::Connect.post_or_patch(rn_client,resource,json_content)
+			end
 
-		end
+			def update(rn_client,resource,json_content)
 
-		def self.update(rn_client,resource,json_content)
+				OSCRuby::Connect.post_or_patch(rn_client,resource,json_content,true)
 
-			OSCRuby::Connect.post_or_patch(rn_client,resource,json_content,true)
+			end
 
-		end
+			def destroy(rn_client,resource)
 
-		def self.destroy(rn_client,resource)
+				OSCRuby::Connect.delete(rn_client,resource)
+				
+			end
 
-			OSCRuby::Connect.delete(rn_client,resource)
-			
-		end
+			def normalize(input)
 
-		def self.normalize(input)
+				if input.code.to_i == 404
 
-			if input.code.to_i == 404
+					input.body
 
-				input.body
+				else
 
-			else
+					json_input = JSON.parse(input.body)
 
-				json_input = JSON.parse(input.body)
+					final_hash = []
 
-				final_hash = []
+					json_input['items'][0]['rows'].each do |row|
 
-				json_input['items'][0]['rows'].each do |row|
+						obj_hash = {}
+						
+						json_input['items'][0]['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
+
+						final_hash.push(obj_hash)
 
-					obj_hash = {}
-					
-					json_input['items'][0]['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
 
-					final_hash.push(obj_hash)
+					final_hash.to_json
 
 				end
 
-				final_hash.to_json
-
 			end
 
-		end
+			def check_obj_for_errors(obj_to_check)
 
-		def self.check_obj_for_errors(obj_to_check)
+				json_obj = JSON.parse(obj_to_check.body)
 
-			json_obj = JSON.parse(obj_to_check.body)
+				if !json_obj.nil? && 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.'
 
-				raise ArgumentError, 'There were no objects matching your query; please try again.'
+				end
 
 			end
 

data/lib/osc_ruby/service_product.rb

@@ -1,5 +1,7 @@
 require 'osc_ruby/client'
 require 'osc_ruby/query_module'
+require 'osc_ruby/validations_module'
+require 'osc_ruby/class_factory_module'
 require 'json'
 require 'uri'
 
@@ -8,252 +10,124 @@ module OSCRuby
 	class ServiceProduct
 
 		include QueryModule
+		include ValidationsModule
+		include ClassFactoryModule
 		
-		attr_accessor :names, :parent, :displayOrder, :adminVisibleInterfaces, :endUserVisibleInterfaces, :id, :lookupName, :createdTime, :updatedTime, :name
+		attr_accessor :names,:parent,:displayOrder,:adminVisibleInterfaces,:endUserVisibleInterfaces,:id,:lookupName,:createdTime,:updatedTime,:name
 
 	    def initialize(attributes = nil)
 
     		@names = []
-
 			@adminVisibleInterfaces = []
-
 			@endUserVisibleInterfaces = []
 
 			if attributes.nil?
 
 				@parent = {}
-
 				@displayOrder = 1
 
 			else
 
 				@id = attributes["id"]
-		      
 				@lookupName = attributes["lookupName"]
-		      
 				@createdTime = attributes["createdTime"]
-		      
 				@updatedTime = attributes["updatedTime"]
-		      
 				@displayOrder = attributes["displayOrder"]
-		      
 				@name = attributes["name"]
-		      
 				@parent = attributes["parent"]
 
 			end
 
 	    end
 
+	    
 	    def create(client,return_json = false)
 
-	    	self.class.check_client(client)
-
-	    	new_product = self
-
-	    	final_json = self.class.check_self(new_product)
-
-	    	resource = URI.escape("/serviceProducts")
-
-	    	response = QueryModule::create(client,resource,final_json)
-
-	    	response_body = JSON.parse(response.body)
-
-	    	if response.code.to_i == 201 && return_json == false
-
-	    		self.id = response_body['id'].to_i
-
-	    		self.name = response_body["lookupName"]
-
-	    		self.lookupName = response_body["lookupName"]
-
-				self.displayOrder = response_body["displayOrder"]
-
-				if !response_body["parent"].nil?
-
-					self.parent = response_body["parent"]["links"][0]["href"].split('/').pop.to_i
-
-				else
-
-					self.parent = nil
-
-				end
-
-	    	elsif return_json == true
-
-	    		response.body
-
-	    	end
+	    	ClassFactoryModule.create(client,self,"/serviceProducts",return_json)
 
 	    end
 
+	    
 	    def self.find(client,id = nil,return_json = false)
 
-	    	check_client(client)
-
-	    	if id.nil? == true
-	    		raise ArgumentError, 'ID cannot be nil'
-	    	elsif id.class != Fixnum
-	    		raise ArgumentError, 'ID must be an integer'
-	    	end
-	    		
-	    	resource = URI.escape("queryResults/?query=select * from serviceproducts where id = #{id}")
-
-	    	service_product_json = QueryModule::find(client,resource)
-
-			if return_json == true
-
-				service_product_json
-
-			else
-
-				service_product_json_final = JSON.parse(service_product_json)
-
-				new_from_fetch(service_product_json_final[0])
-
-			end
+	    	ClassFactoryModule.find(client,id,'serviceproducts',return_json,OSCRuby::ServiceProduct)
 
 	    end
 
+	    
 	    def self.all(client, return_json = false)
 
-	    	check_client(client)
-	    	
-	    	resource = URI.escape("queryResults/?query=select * from serviceproducts")
-
-	    	service_product_json = QueryModule::find(client,resource)
-
-	    	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
+	    	ClassFactoryModule.all(client,'serviceproducts',return_json,OSCRuby::ServiceProduct)
 
 	    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
+			ClassFactoryModule.where(client,query,'serviceproducts',return_json,OSCRuby::ServiceProduct)
 
 	    end
 
+	    
 	    def update(client, return_json = false)
 
-	    	self.class.check_client(client)
-
-	    	product_to_update = self
-
-	    	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}")
-
-	    	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
+	    	ClassFactoryModule::update(client,self,"serviceProducts",return_json)
 
 	    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
+	    def destroy(client, return_json = false)
 
-	    	end
+	    	ClassFactoryModule.destroy(client,self,'serviceProducts',return_json)
 
 	    end
 
 
+	    
 
+	    # Convenience Methods for making the CRUD operations nicer to use
 
+		def set_attributes(response_body)
 
+			self.id = response_body["id"]
 
+    		self.name = response_body["lookupName"]
 
+    		self.lookupName = response_body["lookupName"]
 
+			self.displayOrder = response_body["displayOrder"]
 
+			if !response_body["parent"].nil?
 
+				self.parent = response_body["parent"]["links"][0]["href"].split('/').pop.to_i
 
-	    # Convenience Methods for making the CRUD operations nicer to use
-
-		def self.new_from_fetch(attributes)
+			else
 
-	    	check_attributes(attributes)
+				self.parent = nil
 
-	    	OSCRuby::ServiceProduct.new(attributes)
+			end
 
 		end
 
-		def self.check_for_id(obj)
+		def update_attributes(updated_product)
+
+			self.lookupName = updated_product.lookupName
 
-			if obj.id.nil?
+			self.createdTime = updated_product.createdTime
 
-	    		raise ArgumentError, 'OSCRuby::ServiceProduct must have a valid ID set'
+			self.updatedTime = updated_product.updatedTime
 
-	    	end
+			self.name = updated_product.name
+
+			self.parent = updated_product.parent
 
 		end
 
 		def self.check_self(obj,is_update = false)
 
-			obj_attrs = self.extract_attributes(obj)
+			obj_attrs = ValidationsModule::extract_attributes(obj)
+
+			obj_attrs = check_interfaces(obj_attrs)
 
 			if is_update == true
 			
@@ -317,21 +191,7 @@ module OSCRuby
 
 		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
+		def self.check_interfaces(empty_arr)
 
 			if empty_arr[0]['adminVisibleInterfaces'].empty?
 				
@@ -349,38 +209,6 @@ module OSCRuby
 
 		end
 
-
-
-		# Will probably extract the following into a Validations class or something
-
-		def self.check_attributes(attributes)
-
-			if attributes.class != Hash
-				
-				raise ArgumentError, "Attributes must be a hash; please use the appropriate data structure"
-		
-			end
-
-		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?
-				raise ArgumentError, "Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings"
-			end
-
-		end
-
 	end
 
 end