osc_ruby 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e25549e03506ed7748b7f146ef3506ac00d7c4b
-  data.tar.gz: b268f84bac949f8e89d0be3a3b4ab8c8cd7492e4
+  metadata.gz: 4b82a5d228fa182fe5a73df7f71b36b23e92ad59
+  data.tar.gz: bb5d960406ed2bf3fbddce9da64c32813ae83d38
 SHA512:
-  metadata.gz: 2bb6eda73fdaa44a97412a96e3e1e57c26fc1645faa9bca6622d96a986fb45b4c6517cb503270b9c1a664a66bc608473202f6777011652b02c6a559eee07d919
-  data.tar.gz: 9f414e2f929cae1ca474cf2467a5b354019cd119ab72bb89c28561bf1c754a4a8d70c6c2f5912a5fb43e19dd7a382f8831f6cedb24382dc84ad3b3726d00dd7d
+  metadata.gz: aedf18269daa81d4236bbe809efe35ea007abdd6561d93256968f11db9cfb03cd390d06bfd13d2ba3d41af95162903e15e78a6808d28567b1480edaae3b9c6e7
+  data.tar.gz: ae20c909f4d475ffa2b164a8b9dc861fa0e029b3327fa1c94fa9e4bece0691111c6b173fec6260bed8815abd9207f310267ad6d041edb1e58385223342b400d2

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.2p95
+  - jruby
+  - rbx-2
+script:
+  bundle exec rake spec

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in osc_ruby.gemspec
 gemspec
+
+group :test do
+	gem 'rspec'
+end

data/README.md

@@ -6,6 +6,96 @@ The basic idea is to be able to do something simple like import a csv of informa
 
 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
 
+# Example (still coding this out, but trying to get this pretty simple)
+
+	# // Product Fetch example
+
+	client = OSCRuby::Client.new do |config|	
+		config.interface = ENV['OSC_TEST_SITE']
+		config.username = ENV['OSC_ADMIN']
+		config.password = ENV['OSC_PASSWORD']
+	end
+
+	product = OSCRuby::ServiceProduct.fetch(1)
+
+	puts product.name
+
+	// puts 'Product Lookup Name'
+
+	# // Product Creation example
+
+	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}
+
+	OSCRuby::ServiceProduct.save(client, new_prod)
+
+	// callback with JSON details
+
+# TODO
+
+<!-- Create a URL generator method into the Connect Class -->
+<!-- Move tests for the get method into the URL generator method -->
+
+<!-- Move check_config method into the URL generator method so that tests pass -->
+
+<!-- Create more tests to validate the generated URL -->
+
+Put the URL generator method into the get class
+
+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
+
+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
+
+Make a Post method
+
+Add in tests for update requests
+
+Make a update method
+
+Add in tests for delete requests
+
+Make a delete method
+
+Create a OSCRuby::ServiceProduct class
+
+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
+
+Figure out how to record and stub responses for a good response and bad response
+
+Simulate these responses
+
+Add in TravisCI into workflow to run tests and push and publish gem
+
+Add in Code Climate? or something to show the percentage of covered methods for testing
+
+Follow with next Classes (ServiceCategories, Answers, Interfaces)
+
+Release MVP
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/example.rb

@@ -34,7 +34,7 @@ require 'openssl'
 require 'json'
 require 'uri'
 
-interface = 'qsee--tst' 
+interface = ENV['OSC_TEST_SITE']
 username = ENV['OSC_ADMIN'] 
 password = ENV['OSC_PASSWORD']
 

data/lib/osc_ruby/client.rb

@@ -1,7 +1,3 @@
-require 'net/http'
-require 'openssl'
-require 'json'
-
 require 'osc_ruby/version'
 require 'osc_ruby/configuration'
 
@@ -33,23 +29,5 @@ module OSCRuby
 
 	    	true
 	    end
-
-	  #   def connect
-
-	  #   	url = 'https://' + config.interface + '.custhelp.com/services/rest/connect/v1.3/'
-	  #   	uri = URI.parse(url)
-
-	  #   	Net::HTTP.start(uri.host, uri.port,
-			# 	:use_ssl => true,
-			# 	:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
-
-			# 	request = Net::HTTP::Get.new uri.request_uri
-			# 	request.basic_auth config.username, config.password
-
-			# 	response = http.request request # Net::HTTPResponse object
-
-			# 	json_response = JSON.parse(response.body)
-			# end
-	  #   end
 	end
 end

data/lib/osc_ruby/connect.rb

@@ -0,0 +1,62 @@
+require 'osc_ruby/client'
+
+require 'net/http'
+require 'openssl'
+require 'json'
+require 'uri'
+
+module OSCRuby
+	
+	class Connect
+
+		def self.get(client,resource_url = nil)
+			# Net::HTTP.start(uri.host, uri.port,
+			# 	:use_ssl => true,
+			# 	:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+			# 	request = Net::HTTP::Get.new uri.request_uri
+			# 	request.basic_auth config.username, config.password
+
+			# 	response = http.request request # Net::HTTPResponse object
+
+			# 	json_response = JSON.parse(response.body)
+			# end
+		end
+
+		private
+
+		def self.generate_url_and_config(client,resource_url = nil)
+
+			check_client_config(client)
+
+			@config = client.config
+
+		  	@url = "https://" + @config.interface + ".custhelp.com/services/rest/connect/v1.3/#{resource_url}"
+		  	@final_uri = URI(@url)
+		  	
+		  	@final_config = {'site_url' => @final_uri, 'username' => @config.username, 'password' => @config.password}
+
+		end
+
+		def self.check_client_config(client)
+
+			if client.nil?
+				raise ArgumentError, "Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings"
+			else
+				@config = client.config
+			end
+
+			if @config.nil?
+				raise ArgumentError, "Client configuration cannot be nil or blank"	
+			elsif @config.interface.nil?
+				raise ArgumentError, "The configured client interface cannot be nil or blank"	
+			elsif @config.username.nil?
+				raise ArgumentError, "The configured client username cannot be nil or blank"	
+			elsif @config.password.nil?
+				raise ArgumentError, "The configured client password cannot be nil or blank"	
+			end
+		
+		end
+
+  	end
+end

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/osc_ruby.rb

@@ -1,3 +1,4 @@
 module OSCRuby; end
 
-require 'osc_ruby/client'
+require 'osc_ruby/client'
+require 'osc_ruby/connect'

data/osc_ruby.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "rspec", "~> 3.2.0"
 end

data/spec/core/client_spec.rb

@@ -55,18 +55,4 @@ describe OSCRuby::Client do
 			end
 		end
 	end
-
-	# context '#connect' do
-	# 	it 'should produce a JSON Response' do
-	# 		expect do
-	# 			client = OSCRuby::Client.new do |config|
-	# 				config.interface = 'qsee--tst'
-	# 				config.username = ENV['OSC_ADMIN']
-	# 				config.password = ENV['OSC_PASSWORD']
-	# 			end
-
-	# 			client.connect.should_be a('String')
-	# 		end
-	# 	end
-	# end
 end

data/spec/core/connect_spec.rb

@@ -0,0 +1,120 @@
+require 'core/spec_helper'
+
+describe OSCRuby::Connect do
+	
+	subject { connect }
+	
+	let(:client) { 
+
+		OSCRuby::Client.new do |config|
+		
+			config.interface = ENV['OSC_TEST_SITE']
+		
+			config.username = ENV['OSC_ADMIN']
+		
+			config.password = ENV['OSC_PASSWORD']
+		
+		end
+	}
+
+	context '#generate_url_and_config' 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.generate_url_and_config(client)
+
+			end.not_to raise_error
+		end
+
+		it 'should raise an error if client is nil' do
+
+			expect do
+				
+				client = nil
+
+				OSCRuby::Connect.generate_url_and_config(client)
+
+			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 client.config is nil' do
+
+			expect do
+				
+				client.config = nil
+
+				OSCRuby::Connect.generate_url_and_config(client)
+
+			end.to raise_error("Client configuration cannot be nil or blank")
+
+		end
+
+		it 'should raise an error if client interface is absent' do
+
+			expect do
+				
+				client.config.interface = nil
+				
+				OSCRuby::Connect.generate_url_and_config(client)
+			
+			end.to raise_error("The configured client interface cannot be nil or blank")
+
+		end
+
+		it 'should raise an error if client username is absent' do
+
+			expect do
+
+				client.config.username = nil
+
+				OSCRuby::Connect.generate_url_and_config(client)
+
+			end.to raise_error("The configured client username cannot be nil or blank")
+
+		end
+
+		it 'should raise an error if client password is absent' do
+
+			expect do
+
+				client.config.password = nil
+
+				OSCRuby::Connect.generate_url_and_config(client)
+
+			end.to raise_error("The configured client password cannot be nil or blank")
+
+		end
+
+
+		it 'should create an Hash object with a site_url, username, password properties' do
+
+			final_config = OSCRuby::Connect.generate_url_and_config(client)
+
+			expect(final_config).to be_an(Hash)
+
+			expect(final_config['site_url']).to be_an(URI::HTTPS)
+
+			expect(final_config['username']).to eq(ENV['OSC_ADMIN'])
+
+			expect(final_config['password']).to eq(ENV['OSC_PASSWORD'])
+
+		end
+
+	end
+
+	context '#get' do
+
+		# it 'should produce a JSON Response' do
+		# 	expect do
+		
+
+		# 		client.connect.should_be a('String')
+		# 	end
+		# end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 description: An unofficial Ruby wrapper for the Oracle Cloud Services (fka RightNow
   Technologies) REST API
 email:
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -70,10 +71,12 @@ files:
 - lib/osc_ruby.rb
 - lib/osc_ruby/client.rb
 - lib/osc_ruby/configuration.rb
+- lib/osc_ruby/connect.rb
 - lib/osc_ruby/version.rb
 - osc_ruby.gemspec
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
+- spec/core/connect_spec.rb
 - spec/core/spec_helper.rb
 - tasks/rspec.rake
 homepage: https://github.com/rajangdavis/osc_ruby
@@ -103,4 +106,5 @@ summary: Making the best of opensource and enterprise technology
 test_files:
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
+- spec/core/connect_spec.rb
 - spec/core/spec_helper.rb