osc_ruby 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c7dd0579b731eb4a3d8ce7fbaac6a305a202e00
-  data.tar.gz: 545781e8fca36fa6824b5ad2857387ed4239a1a9
+  metadata.gz: bb6373870e5f1ee93e5a0de7320a8aeec19d3306
+  data.tar.gz: d2cad823e12b8f1d983062520835a07a860f3a98
 SHA512:
-  metadata.gz: 057334b04a1f44cec42354b230da28f9f2e826a61d20aaf657ee60789ab7046ef7f1c7a43f3020c80796448e24380a192aa823b85374a3a281a57e2865c9fea0
-  data.tar.gz: 45b2fefa8a5581fa216458bc965de4d270488c8c73e578d55b1653395c8ed8b99e3d33495b17dd60e4190e132e9ab8533b0231608f1c318dc152600f59891584
+  metadata.gz: deca4bb2bf62f3ceae093392f92177eafd80eded0380d7a14921938e28466d911a64120b42a82223f8e763539d4f3f4569fd42519fd48a1d9bd5e08cd5b34971
+  data.tar.gz: d978e17cd42c61420e1d8c764271b29fdddce3151de81dd099513fc70026794e1e86969749778b6cc230f830c3ca2f3d6807f21ea9a4fd23a0c245d8cb40eabf

data/README.md

@@ -30,8 +30,8 @@ The ultimate goal is to use this gem to make a Rails app for advanced administra
 
 	names = []
 
-	names[0] = {:labelText => 'QTH45', :language => {:id => 1}}
-	names[1] = {:labelText => 'QTH45', :language => {:id => 11}}
+	names[0] = {:labelText => 'QTH45-test', :language => {:id => 1}}
+	names[1] = {:labelText => 'QTH45-test', :language => {:id => 11}}
 
 	parent = {:id => 102}
 
@@ -67,21 +67,21 @@ The ultimate goal is to use this gem to make a Rails app for advanced administra
 
 - [x] Add in Code Climate or something to show the percentage of covered methods for testing
 
-- [ ] Put the URL generator method into the get class
+- [x] Put the URL generator method into the get class
 
-- [ ] Have the get method make a get request using the Net::HTTP class
+- [x] Have the get method make a get request using the Net::HTTP class
 
-- [ ] Need to add tests for passing resources, query/id/other param into the URL generator class
+- [x] Need to add tests for passing resources, query/id/other param into the URL generator class
 
-- [ ] Need to figure out how to pass resources and some sort of query/id/other param into the URL generator class
+- [x] Need to figure out how to pass resources and some sort of query/id/other param into the URL generator class
 
-- [ ] Add in tests for Post requests
+- [x] Add in tests for Post requests
 
-- [ ] Make a Post method
+- [x] Make a Post method
 
-- [ ] Add in tests for update requests
+- [ ] Add in tests for patch requests
 
-- [ ] Make a update method
+- [ ] Make a patch method
 
 - [ ] Add in tests for delete requests
 

data/lib/osc_ruby/connect.rb

@@ -2,7 +2,6 @@ require 'osc_ruby/client'
 
 require 'net/http'
 require 'openssl'
-require 'json'
 require 'uri'
 
 module OSCRuby
@@ -11,13 +10,7 @@ module OSCRuby
 
 		def self.get(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?
-				@final_config = generate_url_and_config(client,resource_url)
-			else
-				@final_config = generate_url_and_config(client,nil)
-			end
+			@final_config = get_check(client,resource_url)
 
 			@uri = @final_config['site_url']
 			@username = @final_config['username']
@@ -28,10 +21,38 @@ module OSCRuby
 				:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
 
 				request = Net::HTTP::Get.new @uri.request_uri
+
+				request.add_field('Content-Type', 'application/x-www-form-urlencoded')
+
 				request.basic_auth @username, @password
 
 				response = http.request request # Net::HTTPResponse object
+
+			end
+
+		end
+
+		def self.post(client,resource_url = nil, json_content = nil)
+
+			@final_config = post_check(client,resource_url, json_content)
+
+			@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"
+			  request.body = JSON.dump(json_content)
+
+			  response = http.request request # Net::HTTPResponse object
+
 			end
+			
 		end
 
 		private
@@ -74,5 +95,31 @@ module OSCRuby
 		
 		end
 
+		def self.get_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?
+				@final_config = generate_url_and_config(client,resource_url)
+			else
+				@final_config = generate_url_and_config(client,nil)
+			end
+
+		end
+
+		def self.post_check(client,resource_url = nil, json_content = 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 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"
+			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.12"
+  VERSION = "0.0.13"
 end

data/spec/core/connect_spec.rb

@@ -36,18 +36,18 @@ describe OSCRuby::Connect do
 
 			expect do
 
-				OSCRuby::Connect.generate_url_and_config(client, 'accounts')
+				OSCRuby::Connect.generate_url_and_config(client, 'serviceProducts')
 
 			end.not_to raise_error
 		end
 
 		it 'should change the final configured url if the resource_url parameter is specified' do
 
-			test = OSCRuby::Connect.generate_url_and_config(client, 'accounts')
+			test = OSCRuby::Connect.generate_url_and_config(client, 'serviceProducts')
 
 			interface = client.config.interface
 
-			expect(test['site_url']).to eq(URI("https://#{interface}.custhelp.com/services/rest/connect/v1.3/accounts"))
+			expect(test['site_url']).to eq(URI("https://#{interface}.custhelp.com/services/rest/connect/v1.3/serviceProducts"))
 
 			expect(test['site_url']).to be_an(URI::HTTPS)
 		end
@@ -172,11 +172,90 @@ describe OSCRuby::Connect do
 
 		it 'should produce a JSON Response form the response body' do
 			
-			expect do
-				test.body.should_be a('String')
-			end
+			expect(test.body).to be_an(String)
 
 			expect{JSON.parse(test.body)}.not_to raise_error
 		end
+
+		let(:json_content){
+			{:test => 'content'}
+		}
+
+		context '#post' 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(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(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(client,'serviceProducts')
+
+				end.to raise_error("There is no json content provided; please specify json content that you would like to send a POST 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 => 'QTH45-test', :language => {:id => 1}}
+				names[1] = {:labelText => 'QTH45-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(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
+
+		context '#patch'
+
+			
+		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,7 +69,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- example.rb
 - lib/osc_ruby.rb
 - lib/osc_ruby/client.rb
 - lib/osc_ruby/configuration.rb

data/example.rb

@@ -1,102 +0,0 @@
-# Client class to initiate generic requests
-
-# => hosts Net::HTTP Class
-# => returns the response
-
-  # => CREATE
-
-    # => POST to end point
-
-  # => READ
-    # => SHOW Example
-    # Net::HTTP.start(uri.host, uri.port,
-    #   :use_ssl => uri.scheme == 'https', 
-    #   :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
-
-    #   request = Net::HTTP::Get.new uri.request_uri
-    #   request.basic_auth username, password
-
-    #   response = http.request request # Net::HTTPResponse object
-
-    #   json_response = JSON.parse(response.body)
-
-    # end
-
-# Configuration class to collect client values
-  # => username
-  # => password  
-  # => interface
-
-# ServiceProduct class
-
-require 'net/http'
-require 'openssl'
-require 'json'
-require 'uri'
-
-interface = ENV['OSC_TEST_SITE']
-username = ENV['OSC_ADMIN'] 
-password = ENV['OSC_PASSWORD']
-
-
-
-products_query = 'select id,lookupname,parent.id,displayorder from serviceproducts'
-interface_query = 'select id,name,language from siteinterfaces'
-final_query = products_query+';'+interface_query
-uri = URI.encode("https://#{interface}.custhelp.com/services/rest/connect/v1.3/queryResults?query=#{final_query};")
-uri = URI.parse(uri)
-puts uri
-
-
-Net::HTTP.start(uri.host, uri.port,
-  :use_ssl => uri.scheme == 'https', 
-  :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
-
-  request = Net::HTTP::Get.new uri.request_uri
-  request.add_field('Content-Type', 'application/x-www-form-urlencoded')
-  request.basic_auth username, password
-
-  response = http.request request # Net::HTTPResponse object
-
-  json_response = JSON.parse(response.body)
-
-  puts JSON.pretty_generate(json_response)
-
-end
-
-# names = []
-
-# names[0] = {:labelText => 'QTH45', :language => {:id => 1}}
-# names[1] = {:labelText => 'QTH45', :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}
-
-# Net::HTTP.start(uri.host, uri.port,
-#   :use_ssl => uri.scheme == 'https', 
-#   :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"
-#   request.body = JSON.dump(new_prod)
-
-#   response = http.request request # Net::HTTPResponse object
-
-#   json_response = JSON.parse(response.body)
-
-#   puts JSON.pretty_generate(json_response)
-# end