osc_ruby 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcd220980ce2649919596ac53c856ab62f7b99e0
-  data.tar.gz: 311d5a6749cf7e471413b393dda6415fb4826536
+  metadata.gz: 2829268a23dea86d4974cc5462737e1553b424cd
+  data.tar.gz: 5e6d1763a191dbdb338a93455506bc8b13e296a1
 SHA512:
-  metadata.gz: 8382c574776ac272cbf0c92d2dff5c128dd7405341433e875df5e9923922acdb30f6b991d7c69612ceeb3ad2a356768e405b7d46c4ca7c694d0f4d9f969f6936
-  data.tar.gz: e27f0bd63323b296b7a974692827a265f4f15395d80c292f115642592e9fa71133d983a3bf25a4e6f551a30971c23f9e8b0931bdc4999313f8d224084115d6b6
+  metadata.gz: c3df42fdc806d43f143160e5cf451481ca4a96826347cb4f4f74c21b6c240dff35b67cfc1d1060b46489c077a72b8170b3b4944d836fadf6d3561ca1ac4a3967
+  data.tar.gz: f0d928e74dc96d32c91d28fe405bc1decfb60574aa48d1f89d6241b7b9cee85919a6918201f207d4e28942dfadc6df84784de3528cf6dc837d732a8b9c621f9c

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
 - 2.2.0
-- jruby
 addons:
   code_climate:
     repo_token:

data/lib/osc_ruby/classes/answer.rb

@@ -13,10 +13,12 @@ module OSCRuby
 			if attributes.nil?
 
    				@answerType = {}
+   				@accessLevels = []
    				@summary = "Answer summary text"
    				@language = {}
    				@question = nil
    				@categories = []
+   				@id = 0
 
 			else
 
@@ -51,30 +53,30 @@ module OSCRuby
 
 	    # Convenience Methods for making the CRUD operations nicer to use
 
-		def set_attributes(response_body)
-	    	self.id = response_body['id'].to_i
-			self.lookupName = response_body['lookupName'].to_i
-			self.createdTime = response_body['createdTime']
-			self.updatedTime = response_body['updatedTime']
-			self.accessLevels = response_body['accessLevels']
-			self.adminLastAccessTime = response_body['adminLastAccessTime']
-			self.answerType = response_body['answerType']
-			self.expiresDate = response_body['expiresDate']
-			self.guidedAssistance = response_body['guidedAssistance']
-			self.keywords = response_body['keywords']
-			self.language = response_body['language']
-			self.lastAccessTime = response_body['lastAccessTime']
-			self.lastNotificationTime = response_body['lastNotificationTime']
-			self.name = response_body['name'].to_i
-			self.nextNotificationTime = response_body['nextNotificationTime']
-			self.originalReferenceNumber = response_body['originalReferenceNumber']
-			self.positionInList = response_body['positionInList']
-			self.publishOnDate = response_body['publishOnDate']
-			self.question = response_body['question']
-			self.solution = response_body['solution']
-			self.summary = response_body['summary']
-			self.updatedByAccount = response_body['updatedByAccount']
-			self.uRL = response_body['uRL']
+		def self.set_attributes(response_body)
+	    	id = response_body['id'].to_i
+			lookupName = response_body['lookupName'].to_i
+			createdTime = response_body['createdTime']
+			updatedTime = response_body['updatedTime']
+			accessLevels = response_body['accessLevels']
+			adminLastAccessTime = response_body['adminLastAccessTime']
+			answerType = response_body['answerType']
+			expiresDate = response_body['expiresDate']
+			guidedAssistance = response_body['guidedAssistance']
+			keywords = response_body['keywords']
+			language = response_body['language']
+			lastAccessTime = response_body['lastAccessTime']
+			lastNotificationTime = response_body['lastNotificationTime']
+			name = response_body['name'].to_i
+			nextNotificationTime = response_body['nextNotificationTime']
+			originalReferenceNumber = response_body['originalReferenceNumber']
+			positionInList = response_body['positionInList']
+			publishOnDate = response_body['publishOnDate']
+			question = response_body['question']
+			solution = response_body['solution']
+			summary = response_body['summary']
+			updatedByAccount = response_body['updatedByAccount']
+			uRL = response_body['uRL']
 		end
 
 		def self.check_self(obj,is_update = false)

data/lib/osc_ruby/configuration.rb

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

data/lib/osc_ruby/connect.rb

@@ -26,6 +26,9 @@ module OSCRuby
 				request = Net::HTTP::Get.new @uri.request_uri
 
 				request.add_field('Content-Type', 'application/x-www-form-urlencoded')
+				if @final_config['suppress_rules'] == true
+					request.add_field 'OSvC-CREST-Suppress-All',true
+				end
 
 				request.basic_auth @username, @password
 
@@ -53,6 +56,9 @@ module OSCRuby
 				if @final_config['patch_request'] == true
 					request.add_field 'X-HTTP-Method-Override','PATCH'
 				end
+				if @final_config['suppress_rules'] == true
+					request.add_field 'OSvC-CREST-Suppress-All',true
+				end
 				request.body = JSON.dump(json_content)
 
 				http.request request # Net::HTTPResponse object
@@ -93,15 +99,9 @@ module OSCRuby
 
 			@version = @config.version
 
-			if @config.no_ssl_verify == true
+			@ssl_verification = ssl_check(@config)
 
-				@ssl_verification = OpenSSL::SSL::VERIFY_NONE
-				
-			else
-				
-				@ssl_verification = OpenSSL::SSL::VERIFY_PEER
-
-			end
+			@rule_suppression = rule_suppress_check(@config)
 
 		  	@url = "https://" + @config.interface + ".custhelp.com/services/rest/connect/#{@version}/#{resource_url}"
 		  	
@@ -109,7 +109,41 @@ module OSCRuby
 
 		  	@patch_request = patch_request == true ? true : false
 		  	
-		  	@final_config = {'site_url' => @final_uri, 'username' => @config.username, 'password' => @config.password, 'patch_request' => @patch_request, 'ssl' => @ssl_verification}
+		  	@final_config = {'site_url' => @final_uri,
+		  					 'username' => @config.username, 
+		  					 'password' => @config.password, 
+		  					 'patch_request' => @patch_request, 
+		  					 'ssl' => @ssl_verification, 
+		  					 'suppress_rules' => @rule_suppression
+		  					}
+
+		end
+
+		def self.rule_suppress_check(config)
+
+			if config.suppress_rules == true || config.suppress_rules == "Yes"
+
+				true
+				
+			else
+				
+				false
+
+			end
+
+		end
+
+		def self.ssl_check(config)
+
+			if config.no_ssl_verify == true
+
+				OpenSSL::SSL::VERIFY_NONE
+				
+			else
+				
+				OpenSSL::SSL::VERIFY_PEER
+
+			end
 
 		end
 

data/lib/osc_ruby/modules/class_factory_module.rb

@@ -28,16 +28,18 @@ module OSCRuby
 
 		    	response_body = JSON.parse(response.body)
 
-		    	if response.code.to_i == 201 && return_json == false
-
-					obj.set_attributes(response_body)
-
-		    	elsif return_json == true
+		    	if return_json == true
 
-		    		response.body
+		    		puts response.body
 
 		    	end
 
+	    		if obj.class.respond_to? :set_attributes
+					obj.class.new(response_body)
+				else
+					obj.set_attributes(response_body)
+				end
+
 			end
 
 			def find(client,id,obj_query,return_json,class_name,custom_or_nested = nil)

data/lib/osc_ruby/modules/validations_module.rb

@@ -15,11 +15,18 @@ module OSCRuby
 
 				obj_vars.each do |var| 
 
-					obj_attr = var.to_s.delete("@")
+					# Make sure to get rid of the empty ID
+					# otherwise everything gets all screwed up
 
-					obj_attr_val = obj.instance_variable_get(var)
+					if var.to_s != '@id'
 
-					empty_arr[0][obj_attr] = obj_attr_val
+						obj_attr = var.to_s.delete("@")
+
+						obj_attr_val = obj.instance_variable_get(var)
+
+						empty_arr[0][obj_attr] = obj_attr_val
+
+					end
 
 				end
 

data/lib/osc_ruby/version.rb

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

data/spec/core/answer_spec.rb

@@ -206,13 +206,15 @@ describe OSCRuby::Answer do
 			new_answer.language['id'] = 1
 			new_answer.answerType['lookupName'] = "HTML"
 
-			new_answer.create(client)
+			10.times do |test| 
+				new_answer.create(client)
+			end
 
 			expect(new_answer).to be_a(OSCRuby::Answer)
 
 			expect(new_answer.summary).to eq("Answer summary text")
 
-			expect(new_answer.language).to eq({"id"=>1, "lookupName"=>"en_US"})
+			expect(new_answer.language).to eq({"id"=>1})
 
 		end
 
@@ -228,12 +230,28 @@ describe OSCRuby::Answer do
 		# end
 
 
-		it 'should return the body object if the json_response param is set to true', :vcr do
+		it 'should print the body object if the json_response param is set to true', :vcr do
+
+			new_answer.language['id'] = 1
+			new_answer.answerType['lookupName'] = "HTML"
+
+			expect(new_answer.create(client,true)).to be_a(OSCRuby::Answer)
+
+			10.times do |test| 
+				new_answer.create(client,true)
+			end
+
+		end
+
+
+		it 'should return the answer attrs and assign them to the answer object', :vcr do
 
 			new_answer.language['id'] = 1
 			new_answer.answerType['lookupName'] = "HTML"
 
-			expect(new_answer.create(client,true)).to be_a(String)
+			new_answer.create(client,true)
+
+			expect(new_answer.id).to_not be(nil)
 
 		end
 
@@ -278,15 +296,12 @@ describe OSCRuby::Answer do
 			expect(known_working_answer.id).to eq(2222)
 			expect(known_working_answer.lookupName).to eq(2222)
 			expect(known_working_answer.createdTime).to eq("2014-02-05T23:42:28Z")
-			expect(known_working_answer.updatedTime).to eq("2016-12-13T09:55:45Z")
 			expect(known_working_answer.accessLevels).to eq(3)
-			expect(known_working_answer.adminLastAccessTime).to eq("2016-11-23T22:54:26Z")
 			expect(known_working_answer.answerType).to eq(1)
 			expect(known_working_answer.expiresDate).to eq(nil)
 			expect(known_working_answer.guidedAssistance).to eq(nil)
 			expect(known_working_answer.keywords).to eq("AbCbEbAb")
 			expect(known_working_answer.language).to eq(1)
-			expect(known_working_answer.lastAccessTime).to eq("2016-12-10T07:27:37Z")
 			expect(known_working_answer.lastNotificationTime).to eq(nil)
 			expect(known_working_answer.name).to eq(2222)
 			expect(known_working_answer.nextNotificationTime).to eq(nil)
@@ -294,10 +309,14 @@ describe OSCRuby::Answer do
 			expect(known_working_answer.positionInList).to eq(1)
 			expect(known_working_answer.publishOnDate).to eq(nil)
 			expect(known_working_answer.question).to eq(nil)
-			expect(known_working_answer.solution).to eq("<p ></iframe></p>\n<ol>\n<li>\n<div class=\"MsoNormal\" >The following video will show you how to view your DVR using the QT view app or through a Browser using the Q-See Scan n View P2P technology.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step1.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >P2P equals Peer to Peer. This concept has been around for a long time.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step2.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >P2P equals Peer to Peer. In a peer to peer network, tasks (such as searching for files or streaming audio/video) are shared amongst multiple interconnected peers who each make a portion of their resources (such as processing power, Disk Storage or network bandwidth) directly available to other Network participants, without the need for centralized coordination by servers.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step3.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Q-See's application is to take the Port Forwarding process out of the hands of the End User.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step4.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Next, you will need to install your QT View app via the Apple App Store or the Google Play Store.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step5.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Once the DVR is connected and is powered up, you will go through the wizard.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step6.png\" /></p>\n<div class=\"MsoNormal\" ></div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step6a.png\" /></p>\n<div class=\"MsoNormal\" ></div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step6b.png\" /></p>\n<div class=\"MsoNormal\" ></div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step6c.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >While going through the wizard you will need to select your device to fit the the QR Code.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step6d.png\" /></p>\n<div class=\"MsoNormal\" ></div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step6e.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Then go to your QT View and tap on the QR code image.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step7.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Now, your scanner will come up, then scan the QR code.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step8.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >The MAC address will appear, then enter the DVR's user name and password.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step9.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Then Tap Login.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step10.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >After a few moments you will then be able to see the cameras without having to access the router.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step11.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >How to access it for PC/MAC.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step12.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Open Browser. Enter qtview.com, Push enter. NOTE: YOU WILL STILL NEED TO ADD IN THE ACTIVE X OR IE PLUG IN FOR YOUR BROWSER.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step13.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Enter the MAC address, User name, and Password, then click LOGIN.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step14.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Then you will be able to see your system.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step15.png\" /></p>\n</li>\n<li>\n<div class=\"MsoNormal\" >Q-See Scan n View.</div>\n<p align=\"center\"><img border=\"0\" alt=\"Image\" src=\"//q-see.s3.amazonaws.com/content/files/HowToFiles/p2pimages/Step16.png\" /></p>\n</li>\n</ol>")
 			expect(known_working_answer.summary).to eq("QT Series: (VIDEO) Scan 'N View Setup")
-			expect(known_working_answer.updatedByAccount).to eq(47)
 			expect(known_working_answer.uRL).to eq(nil)
+			
+			# not a very reliable metrics.....
+			# expect(known_working_answer.updatedByAccount).to eq(47)
+			# expect(known_working_answer.updatedTime).to eq("2016-12-13T09:55:45Z")
+			# expect(known_working_answer.adminLastAccessTime).to eq("2016-11-23T22:54:26Z")
+			# expect(known_working_answer.lastAccessTime).to eq("2016-12-10T07:27:37Z")
 
 		end
 

data/spec/core/connect_spec.rb

@@ -15,6 +15,8 @@ describe OSCRuby::Connect do
 			config.username = ENV['OSC_ADMIN']
 		
 			config.password = ENV['OSC_PASSWORD']
+
+			config.suppress_rules = true
 		
 		end
 	}

data/spec/core/service_category_spec.rb

@@ -160,10 +160,12 @@ describe OSCRuby::ServiceCategory do
 
 			expect(new_service_category.displayOrder).to eq(1)
 
+			expect(new_service_category.id).to_not eq(nil)
+
 		end
 
 
-		it 'should return the body object if the json_response param is set to true', :vcr do
+		it 'should print the body object if the json_response param is set to true', :vcr do
 
 			new_service_category.displayOrder = 11
 
@@ -172,7 +174,9 @@ describe OSCRuby::ServiceCategory do
 			new_service_category.names[0] = {"labelText" => "TEST-CATEGORY", "language" => {"id" => 1}}
 			new_service_category.names[1] = {'labelText' => 'TEST-CATEGORY', 'language' => {'id' => 11}} 	
 
-			expect(new_service_category.create(client,true)).to be_a(String)
+			new_service_category.create(client,true)
+
+			expect(new_service_category).to be_a(OSCRuby::ServiceCategory)
 
 		end
 
@@ -215,9 +219,9 @@ describe OSCRuby::ServiceCategory do
 
 			expect(known_working_category).to be_an(OSCRuby::ServiceCategory)
 
-			expect(known_working_category.name).to eq('Manuals & Guides')
+			expect(known_working_category.name).to eq('Manuals and Guides')
 
-			expect(known_working_category.displayOrder).to eq(2)
+			expect(known_working_category.displayOrder).to eq(1)
 
 		end
 

data/spec/core/service_product_spec.rb

@@ -162,15 +162,19 @@ describe OSCRuby::ServiceProduct do
 
 			expect(new_service_product.parent).to eq(102)
 
+			expect(new_service_product.id).to_not eq(nil)
+
 		end
 
 
-		it 'should return the body object if the json_response param is set to true', :vcr do
+		it 'should print the body object if the json_response param is set to true', :vcr do
 
 			new_service_product.names[0] = {"labelText" => "TEST-PRODUCT", "language" => {"id" => 1}}
 			new_service_product.names[1] = {'labelText' => 'TEST-PRODUCT', 'language' => {'id' => 11}} 	
 
-			expect(new_service_product.create(client,true)).to be_a(String)
+			new_service_product.create(client,true)
+
+			expect(new_service_product).to be_a(OSCRuby::ServiceProduct)
 
 		end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov