osc_ruby 0.0.14 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dee13cf76e6f6b83ce9267ad148881292dac66ac
-  data.tar.gz: 4f47c7b2a5124275da8db617e33c57d9d98efedc
+  metadata.gz: 8037699e524a610096534990ff8c2a5c6b675375
+  data.tar.gz: de4304b8f05ed89f3226d67ab8b310d6c9ce430f
 SHA512:
-  metadata.gz: 39721cd8d4fb63338a461f2f057eb38a3f80a0d69e8aaee1fd28c46ef6f07aba0edd8b262267154103b3d7f97ec44ca541241a86d54a8efa5c5d882945a0dc86
-  data.tar.gz: 02ed3894d1a86a82b803d00f08fa3ca91795f17f2df036a143fa7fb8374444f0923ee05279ef3abb62f2c40669bc9e2e1811d3bf9330e4fd257a1a9edb8c7265
+  metadata.gz: eceab49e9e22cd4965d9e386c1f78fe2dccbe1676ddf48d4a47818c4cf039d8903c67b06aaf3717bf87783f7054f1cadb118202912ae8c2acf6cf85e9b6b6b6a
+  data.tar.gz: 202c440ec8081ddce1542131e1624dd97c7b1b0229fbd8efe64f99b404558778407446d7196ab10f6a0be88680c0e9fd173cbda80bb4b00db6ccbc06ae563a7d

data/README.md

@@ -4,11 +4,7 @@
 
 [![Test Coverage](https://codeclimate.com/github/rajangdavis/osc_ruby/badges/coverage.svg)](https://codeclimate.com/github/rajangdavis/osc_ruby/coverage)
 
-Still developing this; will let ya know when this happens.
-
-The basic idea is to be able to do something simple like import a csv of information and post it into an Oracle Service Cloud site.
-
-The ultimate goal is to use this gem to make a Rails app for advanced administration/development that cannot be done with Oracle Service Cloud alone
+An (under development) Ruby ORM for using Oracle Service Cloud influenced by the ConnectPHP API and ActiveRecord Gem
 
 ## Example (still coding this out, but trying to get this pretty simple)
 
@@ -22,38 +18,45 @@ The ultimate goal is to use this gem to make a Rails app for advanced administra
 
 	product = OSCRuby::ServiceProduct.fetch(1)
 
+	# returns OSCRuby::ServiceProduct object with id of 1
+
 	puts product.name
 
-	# puts 'Product Lookup Name'
+	# =>'Product Lookup Name'
+
+	puts product.displayOrder
+
+	# => 64
+
+
+
 
 	# Product Creation example
 
-	names = []
+	new_product = OSCRuby::ServiceProduct.new
 
-	names[0] = {:labelText => 'QTH45-test', :language => {:id => 1}}
-	names[1] = {:labelText => 'QTH45-test', :language => {:id => 11}}
+	# use Ruby hashes to set field information
 
-	parent = {:id => 102}
+	new_product.names[0] = {:labelText => 'QTH45-test', :language => {:id => 1}}
+	new_product.names[1] = {:labelText => 'QTH45-test', :language => {:id => 11}}
 
-	displayOrder = {:id => 4}
+	new_product.parent = {:id => 102}
 
-	admin_user_visible_interfaces = []
-	admin_user_visible_interfaces[0] = {:id => 1}
+	new_product.displayOrder = {:id => 4}
 
-	end_user_visible_interfaces = []
-	end_user_visible_interfaces[0] = {:id => 1}
+	new_product.adminUserVisibleInterfaces[0] = {:id => 1}
 
-	new_prod = []
-	new_prod[0] = {:names => names, 
-	               :parent => parent, 
-	               :adminVisibleInterfaces => admin_user_visible_interfaces,
-	               :endUserVisibleInterfaces => end_user_visible_interfaces}
+	new_product.endUserVisibleInterfaces[0] = {:id => 1}
 
-	OSCRuby::ServiceProduct.save(client, new_prod)
+	new_product.save(client)
 
 	# callback with JSON details
 
-## TODO
+
+
+	
+
+## To do list
 
 - [x] Create a URL generator method into the Connect Class
 
@@ -79,18 +82,18 @@ The ultimate goal is to use this gem to make a Rails app for advanced administra
 
 - [x] Make a Post method
 
-- [ ] Add in tests for patch requests
+- [x] Add in tests for patch requests
 
-- [ ] Make a patch method
+- [x] Make a patch method
 
-- [ ] Add in tests for delete requests
+- [x] Add in tests for delete requests
 
-- [ ] Make a delete method
-
-- [ ] I might need to do a transformation class that converts JSON response into a Ruby Hash
+- [x] Make a delete method
 
 - [ ] Create a OSCRuby::ServiceProduct class
 
+- [ ] I might need to do a transformation class that converts JSON response into a Ruby Hash
+
 - [ ] Figure out how to do RDoc/Yardoc documentation or best in class documentation for using this Ruby Wrapper
 
 - [ ] Add in VCR and WebMock as dependencies

data/lib/osc_ruby/connect.rb

@@ -32,9 +32,35 @@ module OSCRuby
 
 		end
 
-		def self.post(client,resource_url = nil, json_content = nil)
+		def self.post_or_patch(client,resource_url = nil, json_content = nil,patch_request = false)
 
-			@final_config = post_check(client,resource_url, json_content)
+			@final_config = post_and_patch_check(client,resource_url, json_content, patch_request)
+
+			@uri = @final_config['site_url']
+			@username = @final_config['username']
+			@password = @final_config['password']
+
+			Net::HTTP.start(@uri.host, @uri.port,
+				:use_ssl => true, 
+				:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Post.new @uri.request_uri
+				request.basic_auth @username, @password
+				request.content_type = "application/json"
+				if @final_config['patch_request'] == true
+					request.add_field 'X-HTTP-Method-Override','PATCH'
+				end
+				request.body = JSON.dump(json_content)
+
+				http.request request # Net::HTTPResponse object
+
+			end
+
+		end
+
+		def self.delete(client,resource_url = nil)
+
+			@final_config = delete_check(client,resource_url)
 
 			@uri = @final_config['site_url']
 			@username = @final_config['username']
@@ -44,20 +70,19 @@ module OSCRuby
 			  :use_ssl => true, 
 			  :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
 
-			  request = Net::HTTP::Post.new @uri.request_uri
+			  request = Net::HTTP::Delete.new @uri.request_uri
 			  request.basic_auth @username, @password
-			  request.content_type = "application/json"
-			  request.body = JSON.dump(json_content)
 
 			  http.request request # Net::HTTPResponse object
 
 			end
-
+		
 		end
 
-		protected
 
-		def self.generate_url_and_config(client,resource_url = nil)
+		## checking methods
+
+		def self.generate_url_and_config(client,resource_url = nil, patch_request = false)
 
 			check_client_config(client)
 
@@ -70,8 +95,10 @@ module OSCRuby
 		  	@url = "https://" + @config.interface + ".custhelp.com/services/rest/connect/v1.3/#{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}
+		  	@final_config = {'site_url' => @final_uri, 'username' => @config.username, 'password' => @config.password, 'patch_request' => @patch_request}
 
 		end
 
@@ -107,19 +134,32 @@ module OSCRuby
 
 		end
 
-		def self.post_check(client,resource_url = nil, json_content = nil)
+		def self.post_and_patch_check(client,resource_url = nil, json_content = nil, patch_request = false)
 
 			if client.nil?
 				raise ArgumentError, "Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings"
 			elsif resource_url.nil?
-				raise ArgumentError, "There is no URL resource provided; please specify a URL resource that you would like to send a POST request to"
+				raise ArgumentError, "There is no URL resource provided; please specify a URL resource that you would like to send a POST or PATCH request to"
 			elsif json_content.nil?
-				raise ArgumentError, "There is no json content provided; please specify json content that you would like to send a POST request with"
+				raise ArgumentError, "There is no json content provided; please specify json content that you would like to send a POST or PATCH request with"
+			elsif patch_request == true
+				@final_config = generate_url_and_config(client,resource_url,true)
 			else
 				@final_config = generate_url_and_config(client,resource_url)
 			end
 
 		end
 
-  	end
+		def self.delete_check(client,resource_url = nil)
+			if client.nil?
+				raise ArgumentError, "Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings"
+			elsif resource_url.nil?
+				raise ArgumentError, "There is no URL resource provided; please specify a URL resource that you would like to send a POST or PATCH request to"
+			else
+				@final_config = generate_url_and_config(client,resource_url)
+			end
+		end
+
+	end
+
 end

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "0.0.14"
+  VERSION = "0.1.0"
 end

data/osc_ruby.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Rajan Davis"]
   spec.email         = ["rajangdavis@gmail.com"]
   spec.summary       = %q{Making the best of opensource and enterprise technology}
-  spec.description   = %q{An unofficial Ruby wrapper for the Oracle Cloud Services (fka RightNow Technologies) REST API}
+  spec.description   = %q{An unofficial Ruby ORM on top of the Oracle Cloud Services (fka RightNow Technologies) REST API}
   spec.homepage      = %q{https://github.com/rajangdavis/osc_ruby}
   spec.license       = "MIT"
 

data/spec/core/connect_spec.rb

@@ -129,6 +129,92 @@ describe OSCRuby::Connect do
 
 	end
 
+	let(:json_content){
+		{:test => 'content'}
+	}
+
+	context '#post_or_patch' do
+
+		it 'should take at least a config parameter that is an instance of an OSCRuby::Client' do
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			expect do
+
+				OSCRuby::Connect.post_or_patch(client,'serviceProducts',json_content)
+
+			end.not_to raise_error
+		end
+
+		it 'should raise an error if client is nil' do
+
+			expect do
+				
+				client = nil
+
+				OSCRuby::Connect.post_or_patch(client,'serviceProducts',json_content)
+
+			end.to raise_error("Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings")
+
+		end
+
+		it 'should raise an error if resource_url is nil' do
+
+			expect do
+
+				OSCRuby::Connect.post_or_patch(client, nil, json_content)
+
+			end.to raise_error("There is no URL resource provided; please specify a URL resource that you would like to send a POST or PATCH request to")
+
+		end
+
+		it 'should raise an error if json_content is nil' do
+
+			expect do
+
+				OSCRuby::Connect.post_or_patch(client,'serviceProducts')
+
+			end.to raise_error("There is no json content provided; please specify json content that you would like to send a POST or PATCH request with")
+
+		end
+
+		it 'should produce a Net::HTTPResponse, should produce a 201 response code, and should produce a JSON Response form the response body' do
+
+			names = []
+
+			names[0] = {:labelText => 'PRODUCT-TEST', :language => {:id => 1}}
+			names[1] = {:labelText => 'PRODUCT-TEST', :language => {:id => 11}}
+
+			parent = {:id => 102}
+
+			displayOrder = {:id => 4}
+
+			admin_user_visible_interfaces = []
+			admin_user_visible_interfaces[0] = {:id => 1}
+
+			end_user_visible_interfaces = []
+			end_user_visible_interfaces[0] = {:id => 1}
+
+			new_prod = []
+			new_prod[0] = {:names => names, 
+			               :parent => parent, 
+			               :adminVisibleInterfaces => admin_user_visible_interfaces,
+			               :endUserVisibleInterfaces => end_user_visible_interfaces}
+
+		    test = OSCRuby::Connect.post_or_patch(client,'serviceProducts',new_prod[0])
+
+			expect(test).to be_an(Net::HTTPResponse)
+
+			expect(test.code).to eq("201")
+
+			expect(test.body).to be_an(String)
+
+			expect{JSON.parse(test.body)}.not_to raise_error
+				
+		end
+
+	end
+
 	let(:test){
 		OSCRuby::Connect.get(client)
 	}
@@ -146,6 +232,7 @@ describe OSCRuby::Connect do
 			end.not_to raise_error
 		end
 
+
 		it 'should raise an error if client is nil' do
 
 			expect do
@@ -170,93 +257,112 @@ describe OSCRuby::Connect do
 				
 		end
 
-		it 'should produce a JSON Response form the response body' do
+		it 'should produce a JSON Response from the response body' do
 			
 			expect(test.body).to be_an(String)
 
 			expect{JSON.parse(test.body)}.not_to raise_error
 		end
 
-		let(:json_content){
-			{:test => 'content'}
-		}
+	end
+
+	let(:product_test_id){
+
+		resource = URI.escape("queryResults/?query=select id from serviceproducts where lookupname = 'PRODUCT-TEST';")
+
+		product_test = OSCRuby::Connect.get(client,resource)
+
+		prod_json = JSON.parse(product_test.body).to_hash
+
+		prod_json['items'][0]['rows'][0][0].to_i
+
+	}
+
+	context '#post_or_patch' do
+
+		it 'should take an optional parameter to allow PATCH request; it should produce a Net::HTTPResponse, should produce a 200 code' do
 
-		context '#post' do
+			names = []
 
-			it 'should take at least a config parameter that is an instance of an OSCRuby::Client' do
+			names[0] = {:labelText => 'PRODUCT-TEST-updated', :language => {:id => 1}}
+			names[1] = {:labelText => 'PRODUCT-TEST-updated', :language => {:id => 11}}
 
-				expect(client).to be_an(OSCRuby::Client)
+			parent = {:id => 102}
 
-				expect do
+			displayOrder = {:id => 4}
 
-					OSCRuby::Connect.post(client,'serviceProducts',json_content)
+			admin_user_visible_interfaces = []
+			admin_user_visible_interfaces[0] = {:id => 1}
 
-				end.not_to raise_error
-			end
+			end_user_visible_interfaces = []
+			end_user_visible_interfaces[0] = {:id => 1}
 
-			it 'should raise an error if client is nil' do
+			new_prod = []
+			new_prod[0] = {:names => names, 
+			               :parent => parent, 
+			               :adminVisibleInterfaces => admin_user_visible_interfaces,
+			               :endUserVisibleInterfaces => end_user_visible_interfaces}
 
-				expect do
-					
-					client = nil
+		    test = OSCRuby::Connect.post_or_patch(client,"serviceProducts/#{product_test_id}",new_prod[0],true)
 
-					OSCRuby::Connect.post(client,'serviceProducts',json_content)
+			expect(test).to be_an(Net::HTTPResponse)
 
-				end.to raise_error("Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings")
+			expect(test.body).to eq("")
 
-			end
+			expect(test.code).to eq("200")
+				
+		end
 
-			it 'should raise an error if resource_url is nil' do
+	end
 
-				expect do
+	let(:product_test_updated_id){
 
-					OSCRuby::Connect.post(client,'serviceProducts')
+		resource = URI.escape("queryResults/?query=select id from serviceproducts where lookupname = 'PRODUCT-TEST-updated';")
 
-				end.to raise_error("There is no json content provided; please specify json content that you would like to send a POST request with")
+		product_test_updated = OSCRuby::Connect.get(client,resource)
 
-			end
+		prod_json = JSON.parse(product_test_updated.body).to_hash
 
-			it 'should produce a Net::HTTPResponse, should produce a 201 response code, and should produce a JSON Response form the response body' do
+		prod_json['items'][0]['rows'][0][0].to_i
 
-				names = []
+	}
 
-				names[0] = {:labelText => 'QTH45-test', :language => {:id => 1}}
-				names[1] = {:labelText => 'QTH45-test', :language => {:id => 11}}
+	context '#delete' do
 
-				parent = {:id => 102}
+		it 'should raise an error if client is nil' do
 
-				displayOrder = {:id => 4}
+			expect do
+				
+				client = nil
 
-				admin_user_visible_interfaces = []
-				admin_user_visible_interfaces[0] = {:id => 1}
+				OSCRuby::Connect.delete(client)
 
-				end_user_visible_interfaces = []
-				end_user_visible_interfaces[0] = {:id => 1}
+			end.to raise_error("Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings")
 
-				new_prod = []
-				new_prod[0] = {:names => names, 
-				               :parent => parent, 
-				               :adminVisibleInterfaces => admin_user_visible_interfaces,
-				               :endUserVisibleInterfaces => end_user_visible_interfaces}
+		end
 
-			    test = OSCRuby::Connect.post(client,'serviceProducts',new_prod[0])
+		it 'should raise an error if the resource_url is not specified' do
 
-				expect(test).to be_an(Net::HTTPResponse)
+			expect do
+
+				OSCRuby::Connect.delete(client)
+
+			end.to raise_error("There is no URL resource provided; please specify a URL resource that you would like to send a POST or PATCH request to")
 
-				expect(test.code).to eq("201")
+		end
+
+		it 'it should produce a Net::HTTPResponse, should produce a 200 code' do
 
-				expect(test.body).to be_an(String)
+		    test = OSCRuby::Connect.delete(client,"serviceProducts/#{product_test_updated_id}")
 
-				expect{JSON.parse(test.body)}.not_to raise_error
-					
-			end
+			expect(test).to be_an(Net::HTTPResponse)
 
+			expect(test.body).to eq("")
+
+			expect(test.code).to eq("200")
+				
 		end
 
 	end
 
-	# context '#patch'
-
-			
-	# end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.1.0
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2016-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
-description: An unofficial Ruby wrapper for the Oracle Cloud Services (fka RightNow
+description: An unofficial Ruby ORM on top of the Oracle Cloud Services (fka RightNow
   Technologies) REST API
 email:
 - rajangdavis@gmail.com