osvc_ruby 1.5.0

data/lib/osvc_ruby/classes/analytics_report_results.rb

@@ -0,0 +1,66 @@
+require 'osvc_ruby/modules/validations_module'
+require 'osvc_ruby/modules/normalize_module'
+require 'json'
+
+module OSvCRuby
+
+	class AnalyticsReportResults
+
+		include NormalizeModule
+		include ValidationsModule
+
+		attr_accessor :lookupName,:id, :filters
+
+	    def initialize(**args)
+	    	@lookupName = args[:lookupName]
+	    	@id = args[:id]
+	    	@filters = []
+	    end
+
+
+
+		def run(client)
+
+			json_data = convert_to_json(self)
+
+			ValidationsModule::check_client(client)
+
+	    	response = OSvCRuby::Connect.post_or_patch(client,'analyticsReportResults',json_data)
+
+	    	check_and_parse_response(response)
+
+		end
+
+
+		private
+
+		def convert_to_json(s)
+			json_data = {}
+			check_for_id_and_name(s)
+			s.instance_variables.each do|iv|
+				key = iv.to_s.delete("@")
+				value = instance_variable_get iv
+				json_data[key] = value unless value.nil?
+			end
+			json_data
+		end
+
+		def check_for_id_and_name(s)
+			if s.lookupName.nil? && s.id.nil?
+				raise ArgumentError, "AnalyticsReportResults must have an id or lookupName set"
+			end
+		end
+
+		def check_and_parse_response(response)
+			if response.code.to_i != 200
+				puts JSON.pretty_generate(response.body)
+				response.body
+			else
+				body = JSON.parse(response.body)
+				NormalizeModule.iterate_through_rows(body)
+			end
+		end
+
+	end
+
+end

data/lib/osvc_ruby/classes/query_results.rb

@@ -0,0 +1,41 @@
+require 'osvc_ruby/modules/validations_module'
+require 'osvc_ruby/modules/normalize_module'
+require_relative '../../ext/string.rb'
+require 'json'
+
+module OSvCRuby
+
+	class QueryResults
+
+		include ValidationsModule, NormalizeModule
+
+		def initialize; end
+
+		def query(client,query)
+
+			ValidationsModule::check_client(client)
+
+			ValidationsModule::check_query(query,"query")
+
+			@query = URI.escape("queryResults/?query=#{query}")
+	    	
+	    	obj_to_find = OSvCRuby::Connect.get(client,@query)
+
+			if obj_to_find.code.to_i == 200 || obj_to_find.code.to_i == 201
+
+				response = NormalizeModule::normalize(obj_to_find)
+			else
+
+				response = obj_to_find.body
+
+			end
+
+	    	JSON.parse(response) 
+ 			
+		end
+
+
+	
+	end
+
+end

data/lib/osvc_ruby/classes/query_results_set.rb

@@ -0,0 +1,39 @@
+require_relative 'query_results'
+require 'osvc_ruby/modules/validations_module'
+
+module OSvCRuby
+
+	class QueryResultsSet
+
+		include ValidationsModule
+
+		def query_set(client,*args)
+
+			ValidationsModule::check_client(client)
+			
+			query_arr = []
+			
+			key_map = []
+
+			args.each do |qh|
+
+				key_map.push(qh[:key].to_sym)
+
+				query_arr.push(qh[:query])	
+			
+			end
+
+			query_results_set = Struct.new( *key_map )
+			query_search = OSvCRuby::QueryResults.new
+		
+
+			final_query_arr = query_arr.join('; ')
+			final_results = query_search.query(client,final_query_arr)
+
+			final_query_results_set = query_results_set.new( *final_results )
+			final_query_results_set
+		end
+
+	end 
+
+end

data/lib/osvc_ruby/client.rb

@@ -0,0 +1,41 @@
+require 'osvc_ruby/version'
+require 'osvc_ruby/configuration'
+
+
+module OSvCRuby
+
+	class Client
+		# The top-level class that handles configuration and connection to the Oracle Service Cloud REST API.
+		
+		attr_accessor :config
+		
+		def initialize
+	        raise ArgumentError, "block not given" unless block_given?
+	        self.config ||= OSvCRuby::Configuration.new
+	    	yield(config)
+
+	    	check_config
+	    	optional_check
+		end
+
+	    def check_config
+	    	if config.interface ==''
+	    		raise ArgumentError, "Interface cannot be nil or blank"
+	    	elsif config.username ==''
+	    		raise ArgumentError, "Username cannot be nil or blank"
+	    	elsif config.password ==''
+	    		raise ArgumentError, "Password cannot be nil or blank"
+	    	end
+
+	    	true
+	    end
+
+	    def optional_check
+	    	if config.no_ssl_verify.class != FalseClass && config.no_ssl_verify.class != TrueClass
+	    		raise ArgumentError, "The no SSL verification setting must be set to true or false"
+	    	elsif config.version.nil?
+	    		raise ArgumentError, "Connect version cannot be null"
+	    	end
+	    end
+	end
+end

data/lib/osvc_ruby/configuration.rb

@@ -0,0 +1,15 @@
+module OSvCRuby
+
+	class Configuration
+		# A holder class that holds the configuration information for the OSvCRuby::Client block
+	
+	    attr_accessor :interface,:username,:password,:no_ssl_verify,:version,:suppress_rules,:demo_site
+
+	    def initialize
+	    	@no_ssl_verify = false
+	    	@version = 'v1.3'
+	    	@suppress_rules = false
+	    	@demo_site = false
+	    end
+	end
+end

data/lib/osvc_ruby/connect.rb

@@ -0,0 +1,226 @@
+require 'osvc_ruby/client'
+require 'osvc_ruby/modules/validations_module'
+
+require 'net/http'
+require 'openssl'
+require 'uri'
+require 'cgi'
+
+module OSvCRuby
+	
+	# This class is purely to provide the underlying methods for CRUD functionality using Net::HTTP, URI, and OpenSSL
+	class Connect
+
+		include ValidationsModule
+		
+		def self.get(client,resource_url = nil)
+
+			@final_config = get_check(client,resource_url)
+
+			@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 => @final_config['ssl']) do |http|
+
+				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
+
+				http.request request # Net::HTTPResponse object
+
+			end
+
+		end
+
+		def self.post_or_patch(client,resource_url = nil, json_content = nil,patch_request = false)
+
+			@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 => @final_config['ssl']) 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
+				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
+
+			end
+
+		end
+
+		def self.post(client,resource_url = nil, json_content = nil)
+			self.post_or_patch(client,resource_url, json_content)
+		end
+
+		def self.patch(client,resource_url = nil, json_content = nil)
+			self.post_or_patch(client,resource_url, json_content,true)
+		end
+
+		def self.delete(client,resource_url = nil)
+
+			@final_config = delete_check(client,resource_url)
+
+			@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 => @final_config['ssl']) do |http|
+
+			  request = Net::HTTP::Delete.new @uri.request_uri
+			  request.basic_auth @username, @password
+
+			  http.request request # Net::HTTPResponse object
+
+			end
+		
+		end
+
+
+		## checking methods
+
+		def self.generate_url_and_config(client,resource_url = nil, patch_request = false)
+
+			check_client_config(client)
+
+			@config = client.config
+
+			@version = @config.version
+
+			@ssl_verification = ssl_check(@config)
+
+			@rule_suppression = rule_suppress_check(@config)
+
+			@cust_or_demo = demo_check(@config)
+
+		  	@url = "https://" + @config.interface + ".#{@cust_or_demo}.com/services/rest/connect/#{@version}/#{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, 
+		  					 'patch_request' => @patch_request, 
+		  					 'ssl' => @ssl_verification, 
+		  					 'suppress_rules' => @rule_suppression
+		  					}
+
+		end
+
+		def self.demo_check(config)
+			if config.demo_site == true
+				"rightnowdemo"
+			else
+				"custhelp"
+			end
+		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
+
+		def self.check_client_config(client)
+
+			@config = ValidationsModule::check_client(client).config
+
+			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
+
+		def self.get_check(client,resource_url = nil)
+
+			if client.nil?
+				raise ArgumentError, "Client must have some configuration set; please create an instance of OSvCRuby::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_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 OSvCRuby::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"
+			elsif json_content.nil?
+				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
+
+		def self.delete_check(client,resource_url = nil)
+			if client.nil?
+				raise ArgumentError, "Client must have some configuration set; please create an instance of OSvCRuby::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/osvc_ruby/modules/normalize_module.rb

@@ -0,0 +1,62 @@
+require 'json'
+
+module OSvCRuby
+
+	module NormalizeModule
+
+		class << self
+
+			def normalize(input)
+
+				if input.code.to_i == 404
+
+					input.body
+
+				else
+
+					json_input = JSON.parse(input.body)
+
+					final_hash = []
+
+					json_input['items'].each do |item|
+						results_array = iterate_through_rows(item)							
+				        final_hash.push(results_array)
+					end
+
+					if final_hash.size === 1
+						final_hash = final_hash.flatten!
+					end
+
+					final_hash.to_json
+
+				end
+
+			end
+
+			def iterate_through_rows(item)
+
+				results_array = []
+
+		        item['rows'].each_with_index do |row,_row_i|
+
+	                obj_hash = {}
+	                
+	                item['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
+
+	    			results_array.push(obj_hash)
+
+		        end
+
+		        results_array
+
+			end
+
+		end
+
+	end
+	
+end

data/lib/osvc_ruby/modules/validations_module.rb

@@ -0,0 +1,34 @@
+require 'osvc_ruby/connect'
+require 'json'
+
+module OSvCRuby
+
+	module ValidationsModule
+
+		class << self
+
+		    def check_query(query,method_name = "where")
+
+				if query.empty?
+					
+					raise ArgumentError, "A query must be specified when using the '#{method_name}' method"
+
+				end
+
+		    end
+
+			def check_client(client)
+
+				if client.class != OSvCRuby::Client || client.nil?
+
+					raise ArgumentError, "Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings"
+
+				end
+				client
+			end
+
+		end
+
+	end
+	
+end

data/lib/osvc_ruby/version.rb

@@ -0,0 +1,3 @@
+module OSvCRuby
+  VERSION = "1.5.0"
+end

data/lib/osvc_ruby.rb

@@ -0,0 +1,9 @@
+require 'convenience_methods'
+
+module OSvCRuby;end
+
+require 'osvc_ruby/client'
+require 'osvc_ruby/connect'
+require 'osvc_ruby/classes/query_results'
+require 'osvc_ruby/classes/query_results_set'
+require 'osvc_ruby/classes/analytics_report_results'

data/osvc_ruby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'osvc_ruby/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = "osvc_ruby"
+    spec.version       = OSvCRuby::VERSION
+    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 ORM on top of the Oracle Cloud Services (fka RightNow Technologies) REST API}
+    spec.homepage      = %q{https://github.com/rajangdavis/osvc_ruby}
+    spec.license       = "MIT"
+
+    spec.files         = `git ls-files -z`.split("\x0")
+    spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+    spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+    spec.require_paths = ["lib"]
+
+    spec.add_development_dependency "simplecov"   
+    spec.add_development_dependency "codeclimate-test-reporter", '~> 1.0', '>= 1.0.0'   
+    spec.add_development_dependency "bundler"
+    spec.add_development_dependency "rake", "~> 10.0"
+    spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+    spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+    spec.add_development_dependency "webmock"
+end

data/spec/core/analytics_report_results_spec.rb

@@ -0,0 +1,86 @@
+require 'core/spec_helper'
+require 'json'
+require 'uri'
+
+describe OSvCRuby::AnalyticsReportResults do
+
+	let(:client) { 
+
+		OSvCRuby::Client.new do |config|
+		
+			config.interface = ENV['OSC_SITE']
+		
+			config.username = ENV['OSC_ADMIN']
+		
+			config.password = ENV['OSC_PASSWORD']
+
+			config.demo_site = true
+		
+		end
+	}
+
+	let(:last_updated){
+		OSvCRuby::AnalyticsReportResults.new(lookupName: "Last Updated By Status")
+	}
+
+	let(:answers_search){
+		OSvCRuby::AnalyticsReportResults.new(id: 176)
+	}
+
+	let(:error_example){
+		OSvCRuby::AnalyticsReportResults.new
+	}
+
+
+	context "#initialize" do
+
+		it "should expect an id or a lookupName for a report" do
+			
+			expect(last_updated).to be_an(OSvCRuby::AnalyticsReportResults)
+
+			expect(last_updated.lookupName).to eq("Last Updated By Status")
+
+			expect(answers_search).to be_an(OSvCRuby::AnalyticsReportResults)
+
+			expect(answers_search.id).to eq(176)
+		
+		end
+
+
+				
+	end
+
+	context "#run" do
+		it 'should expect client is an instance of OSvCRuby::Client class and raise an error if does not' do
+
+			expect(client).to be_an(OSvCRuby::Client)
+
+			client = nil
+
+			expect{answers_search.run(client)}.to raise_error('Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings')
+
+		end
+
+		it 'should throw an error if there is no id or no lookupName assigned',:vcr do
+			expect{error_example.run(client)}.to raise_error('AnalyticsReportResults must have an id or lookupName set')
+			error_example.id = 176
+			expect(error_example.run(client)).to be_an(Array)
+		end
+
+		it 'should be able to take filters', :vcr do
+			keywords = arrf(name: "search_ex", values: "Maestro")
+			answers_search.filters << keywords
+
+			answers = answers_search.run(client)
+
+			answers.each do |answer|
+
+				expect(answer['Summary']).to be_a(String)
+				expect(answer['Answer ID']).to be_a(Integer)
+			end			
+
+		end
+
+	end
+
+end