osc_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf379c1f203bbe3a5a5f77bde85d2618a0115158
-  data.tar.gz: a4d27cee02b3451ce580283ad09b3a41137ac320
+  metadata.gz: e14e902577a5de33e8df4bfd1d69c10f57200397
+  data.tar.gz: f518a4aeb02c0a170fa80427aae13b8b7e43796e
 SHA512:
-  metadata.gz: 9b4a750e171d4f02b355511a9de8643314182d744ee53f4e72bf2e5b3300c4585417ee390adcf43266f392fbf84aa11652f2683ce831d25256902644d4861e15
-  data.tar.gz: 4627953fdbd006c4ace517f8239d1a1a41f4078f08e54cefd4da100039814bda45a0927ba2d5c5d5dc40d3b0a67cdde7b79bb65d85b60ba5e21564d7207cdb6f
+  metadata.gz: 338ffa1f9a35271bb9d0039e4e7f02193ac37c593032f46d6c14edc700ec1b8b35df0dc321e17116b10a32349c03b2ca76bc64b100ab1b2a787c305e66e5a980
+  data.tar.gz: 09810e30982cde2bb3edc2a67d1145d6acc1f1bd302d0662c43124f0c9e1fc43eedd2154fdb620c98db413fe5beaab53dac7e4412d97cfbb6efa148b075ccb80

data/README.md

@@ -4,27 +4,51 @@
 
 [![Test Coverage](https://codeclimate.com/github/rajangdavis/osc_ruby/badges/coverage.svg)](https://codeclimate.com/github/rajangdavis/osc_ruby/coverage)
 
+[![Build Status](https://travis-ci.org/rajangdavis/osc_ruby.svg?branch=master)](https://travis-ci.org/rajangdavis/osc_ruby)
 
+[![Gem Version](https://badge.fury.io/rb/osc_ruby.svg)](https://badge.fury.io/rb/osc_ruby)
 
-An (under development) Ruby ORM for using Oracle Service Cloud influenced by the ConnectPHP API and ActiveRecord Gem
+An (under development) Ruby ORM for using Oracle Service Cloud influenced by the [ConnectPHP API](http://documentation.custhelp.com/euf/assets/devdocs/november2016/Connect_PHP/Default.htm) and ActiveRecord Gem
 
 ## Example (still coding this out, but trying to get this pretty simple)
 
 	# Configuration is as simple as requiring the gem
 	# and adding a config block (Completed 12/2016)
 
-	require 'osc_ruby'
+		require 'osc_ruby'
 
-	rn_client = OSCRuby::Client.new do |config|
-		config.username = ENV['OSC_ADMIN']
-		config.password = ENV['OSC_PASSWORD']
-		config.interface = ENV['OSC_TEST_SITE']
-	end
+		rn_client = OSCRuby::Client.new do |config|
+			config.username = ENV['OSC_ADMIN']
+			config.password = ENV['OSC_PASSWORD']
+			config.interface = ENV['OSC_TEST_SITE']
+		end
+
+
+	# ServiceProduct Creation example (Completed 12/30/2016)
+
+		new_product = OSCRuby::ServiceProduct.new
+
+		# use Ruby hashes to set field information
+
+		new_product.names[0] = {'labelText' => 'QTH45-test', 'language' => {'id' => 1}}
+		new_product.names[1] = {'labelText' => 'QTH45-test', 'language' => {'id' => 11}}
+
+		new_product.parent = {'id' => 102}
+
+		new_product.displayOrder = 4
+
+		new_product.adminVisibleInterfaces[0] = {'id' => 1}
+
+		new_product.endUserVisibleInterfaces[0] = {'id' => 1}
+
+		new_product.create(rn_client)
+
+		# callback with JSON details
 
 
 	# ServiceProduct fetch example (Completed 12/28/2016)
 
-		product = ServiceProduct.find(rn_client,100)
+		product = OSCRuby::ServiceProduct.find(rn_client,100)
 
 		puts product
 		# => #<ServiceProduct:0x007fd0fa87e588>
@@ -53,27 +77,24 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 		# => QS Series
 		# => QT Series
 
-	# Product Creation example
+	# ServiceProduct update example
 
-		new_product = OSCRuby::ServiceProduct.new
+		product_to_update = OSCRuby::ServiceProduct.find(rn_client,100)
 
-		# use Ruby hashes to set field information
+		product_to_update.names[0] = {'labelText' => 'name-updated', 'language' => {'id' => 1}}
 
-		new_product.names[0] = {'labelText' => 'QTH45-test', 'language' => {'id' => 1}}
-		new_product.names[1] = {'labelText' => 'QTH45-test', 'language' => {'id' => 11}}
-
-		new_product.parent = {'id' => 102}
+		product_to_update.update(rn_client)
 
-		new_product.displayOrder = 4
+		# ServiceProduct updated
 
-		new_product.adminVisibleInterfaces[0] = {'id' => 1}
 
-		new_product.endUserVisibleInterfaces[0] = {'id' => 1}
+	# ServiceProduct destroy example
 
-		new_product.save(client)
+		product_to_delete = OSCRuby::ServiceProduct.find(rn_client,100)
 
-	# callback with JSON details
+		product_to_delete.destroy(rn_client)
 
+		# ServiceProduct destroyed
 
 ## To do list
 
@@ -111,35 +132,43 @@ 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 all classes:
+- [x] Build a QueryModule Module with the following query methods to be shared between most if not all classes:
 	
 - [x] find
 	
-- [ ] take
-	
-- [ ] first
-	
-- [ ] last
-	
-- [ ] order
-	
 - [ ] find_by
 	
 - [ ] where
 	
 - [ ] all
 
-- [x] QueryModel converts JSON response into a Ruby Hash => new instance of the object being queried
+- [ ] Also add the following remaining CRUD Functionality:
+
+- [ ] create
+
+- [ ] update
+
+- [ ] destroy
+
+- [x] QueryModule converts JSON response into a Ruby Hash => new instance of the object being queried
+
+- [ ] Create some validations for creating a ServiceProduct object
+
+- [ ] Make OpenSSL::SSL::VERIFY_PEER the default with OpenSSL::SSL::VERIFY_NONE option set in the config class 
+
+- [ ] Make version default to 1.3 but an option to be set in the config class
+
+- [ ] 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 Wrapper
+- [ ] Figure out how to do RDoc/Yardoc documentation or best in class documentation for using this Ruby ORM
 
 - [ ] Add in VCR and WebMock as dependencies
 
 - [ ] Figure out how to record and stub responses for a good response and bad response
 
-- [ ] Simulate these responses
+- [ ] Simulate these responses for ALL Connect HTTP methods
 
-- [ ] Follow with next Classes (ServiceCategories, Answers, Interfaces)
+- [ ] Follow with next Classes (ServiceCategories, Answers, Incidents)
 
 - [ ] Release MVP
 

data/lib/osc_ruby/query_module.rb

@@ -13,7 +13,7 @@ module OSCRuby
 
 			check_obj_for_errors(obj_to_find)
 
-			obj_info = normalize(obj_to_find)
+			normalize(obj_to_find)
 
 		end
 
@@ -33,15 +33,15 @@ module OSCRuby
 
 			else
 
-				_json = JSON.parse(input.body)
+				json_input = JSON.parse(input.body)
 
 				final_hash = []
 
-				_json['items'][0]['rows'].each do |row|
+				json_input['items'][0]['rows'].each do |row|
 
 					obj_hash = {}
 					
-					_json['items'][0]['columnNames'].each_with_index do |column,i|
+					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
 
@@ -57,9 +57,9 @@ module OSCRuby
 
 		def self.check_obj_for_errors(obj_to_check)
 
-			_json = JSON.parse(obj_to_check.body)
+			json_obj = JSON.parse(obj_to_check.body)
 
-			if _json['items'][0]['rows'].count == 0
+			if 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

@@ -15,7 +15,7 @@ module OSCRuby
 
 	    def initialize(attributes = nil)
 
-	    	if attributes.nil?
+			if attributes.nil?
 
 				@names = []
 
@@ -47,6 +47,20 @@ module OSCRuby
 
 	    end
 
+	    def create(client)
+
+	    	self.class.check_client(client)
+
+	    	new_product = self
+
+	    	final_json = self.class.check_self_for_create_method(new_product)
+
+	    	resource = URI.escape("/serviceProducts")
+
+	    	QueryModule::create(client,resource,final_json)
+
+	    end
+
 	    def self.find(client,id = nil)
 
 	    	check_client(client)
@@ -79,31 +93,38 @@ module OSCRuby
 
 	    # end
 
-	  #   def create(client)
 
-	  #   	new_product = self
+		def self.new_from_fetch(attributes)
 
-	  #   	empty_arr = []
+	    	check_attributes(attributes)
 
-	  #   	json_content = {}
+	    	OSCRuby::ServiceProduct.new(attributes)
 
-			# new_product.instance_variables.each {|var| json_content[var.to_s.delete("@")] = new_product.instance_variable_get(var)}
+		end
 
-			# empty_arr[0] = json_content
+		def self.check_self_for_create_method(obj)
 
-			# puts JSON.pretty_generate(empty_arr)
+			empty_arr = []
 
-	  #   	resource = URI.escape("/serviceProducts")
+	    	json_content = {}
 
-	  #   	service_product_json = QueryModule::create(client,resource,empty_arr[0])
+			obj.instance_variables.each {|var| json_content[var.to_s.delete("@")] = obj.instance_variable_get(var)}
+			
+			empty_arr[0] = json_content
 
-	  #   end
+			if empty_arr[0]['names'].count == 0
+				raise ArgumentError, 'ServiceProduct should at least have one name set (new_service_product.names[0] = "new product name" )'
+			end
 
-		def self.new_from_fetch(attributes)
+			if empty_arr[0]['adminVisibleInterfaces'].empty?
+				empty_arr[0].delete('adminVisibleInterfaces')
+			end
 
-	    	check_attributes(attributes)
+			if empty_arr[0]['endUserVisibleInterfaces'].empty?
+				empty_arr[0].delete('endUserVisibleInterfaces')
+			end
 
-	    	OSCRuby::ServiceProduct.new(attributes)
+			empty_arr
 
 		end
 

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/core/service_product_spec.rb

@@ -103,6 +103,38 @@ describe OSCRuby::ServiceProduct do
 		end
 	}
 
+	let(:new_service_product){
+		OSCRuby::ServiceProduct.new
+	}
+
+	context '#create' 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{new_service_product.create(client)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should check the object and make sure that it at least has a name set' do
+
+			expect{new_service_product.create(client)}.to raise_error('ServiceProduct should at least have one name set (new_service_product.names[0] = "new product name" )')
+
+		end
+
+		it 'should return the body object if it was created or not' do
+
+			new_service_product.names[0] = "new product name"
+
+			expect(new_service_product.create(client)).to be_a(String)
+
+		end
+
+	end
+
 	context '#find' do
 
 		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2016-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler