oeh-client 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 523096f4e6ed912ba9438ae57ee5db4c5436a107
-  data.tar.gz: 0acd9dd22c8d6a825ff85f337425d9862e80a0b8
+  metadata.gz: a29637284500a08ab1cb3431a8a963e557041758
+  data.tar.gz: 542ba1977b341ec2400719a1b5da7196268383ee
 SHA512:
-  metadata.gz: 7c095dfd4864698e800cd3caa046c0069836b44928a57e60e73e9f8cde139c85867244585681f8ae329fd5f1b3651da17246711f8769d467eb87b82eafe73594
-  data.tar.gz: 0226d6c29edbe1e84e3fcda936f1ccac0aae561ae1074d9c77a117ebd6a7bad28d451301bca55a487fd435be084b58b4860c60ad3d06c319d04700bb456af9f5
+  metadata.gz: 7455865c7636b7380d68bb7f0427e9f0e37d7af623a5b0f409eb184c42f12974050d8e31c3d51eb2be5184971977620313541850c0f9937be96aa86284738b65
+  data.tar.gz: 494f6251c84dfa8a9bb5004867929d14f7d0678ff8d27f5efff4eb5ac6a5030cc2afb251907a8ec8d93a6eadcd00ebd462aa8d5fdf70690e3cc716bda21e866d

data/lib/oehclient/config/space.rb

@@ -1,3 +1,6 @@
+require 'erb'
+require 'rest-client'
+
 class OEHClient::Config::Space
 
 	attr_accessor 	:site_key, 			# The ONE Site KEY Value
@@ -5,7 +8,8 @@ class OEHClient::Config::Space
 					:api_key,			# The API key provided in the ONE SETTINGS interface
 					:shared_secret,		# The shared secret value provided in the ONE SETTINGS interface
 					:username,			# The fully-qualified username configured for access to the space
-					:meta_password		# The password needed to access meta-data from the OEH server			
+					:meta_password,		# The password needed to access meta-data from the OEH server
+					:cookies			# The cookies returned from an OEH API request			
 
 	# ---- Class Methods 
 
@@ -48,6 +52,13 @@ class OEHClient::Config::Space
 		return(OAuth::AccessToken.new(oauth_consumer))
 
 	end
+	# return a new instance of the OAuth::Consumer using the details of the space
+	def oauth_consumer()
+		OAuth::Consumer.new("#{@api_key}!#{@username}", 
+											@shared_secret,
+											{:site => "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}#{OEHClient::Helper::Request::THUNDERHEAD_DOMAIN}",
+												:scheme => :header})
+	end
 
 	# is_valid determines if the current class has values for all the attributes.  Each attribute is
 	# required with a non-nul / non-blank value to be considered valid
@@ -64,4 +75,34 @@ class OEHClient::Config::Space
 		self.is_valid? && (!@meta_password.blank?)
 	end
 
+	# return the hash that 
+	def meta_credentials()
+		{:username => @username, :password => @meta_password, :rememberMe => "false"}
+	end # def meta_credentials
+
+	def login_url()
+		"#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}#{OEHClient::Helper::Request::THUNDERHEAD_DOMAIN}/one/idm_login"
+	end # def login_url
+
+	def logout_url()
+		"#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}#{OEHClient::Helper::Request::THUNDERHEAD_DOMAIN}/one/logout"
+	end
+
+	# logon to the OEH thinstance with the existing credentials
+	def login()
+		response = OEHClient.post(login_url, nil, :payload => meta_credentials)
+		@cookies = response[:cookies]  if (@cookies.blank? && response.has_key?(:cookies))
+	end
+
+	def logout()
+		header = Hash.new
+		header.merge!(:cookies => @cookies)				unless (@cookies.blank?)
+		header.merge!(OEHClient::Helper::Request.default_JSON_header)
+
+		puts "Logout Header: #{header}"
+
+		response = OEHClient.post(logout_url, nil, :header => header)
+		@cookies = nil
+	end
+
 end

data/lib/oehclient/data/structure.rb

@@ -33,10 +33,11 @@ class OEHClient::Data::Structure < OEHClient::Data::Node
 
 				# Use the OEHClient object to call OEH profiles API and create an instance
 				#  of this class (OEHClient::Data::Structure) as the return value
-				response = OEHClient::Helper::Response.handle(OEHClient.get(@space.token,
-								OEHClient::Helper::Request.format_url(self.request_url(api_name), {:sk => @space.site_key, :ck => customer_key})))
+				response = OEHClient.get(self.request_url(api_name),
+											@space.oauth_consumer, 
+											:params => {:sk => @space.site_key, :ck => customer_key})
 				# dynamically map the response object to a new OEHClient::Data::Structure class
-				OEHClient::Data::Structure.new(response)
+				OEHClient::Data::Structure.new(response[:body])
 
 			else
 

data/lib/oehclient/exception.rb

@@ -2,8 +2,8 @@ module OEHClient
 
 	module Exception
 
-		# Used when an invalid OAuth token is detected as part of the client-side API calls
-		class InvalidTokenException < ::Exception
+		# Used when an invalid OAuth consumer is detected as part of the client-side API calls
+		class InvalidConsumerException < ::Exception
 
 		end
 

data/lib/oehclient/helper.rb

@@ -46,18 +46,30 @@ module OEHClient
 
 		module Response
 
-			def self.handle(api_response)
+			# determine if the string that was passed is valid JSON syntax and can be parsed by the the 
+			# ActiveSupport::JSON.decode method
+			def self.valid_json?(json)
+  				valid_indicator = true
+  				begin
+    				ActiveSupport::JSON.decode(json)
+  				rescue ActiveSupport::JSON.parse_error
+    				valid_indicator = false
+  				end
+  			end
+
+
+			def self.handle(rest_response)
+
+				valid_response_codes = [100, 200, 302]
 				# raise a generic HTTPRequestException if the the status code is not 100 (Continue) or 200 (OK)
-				raise OEHClient::Exception::HTTPRequestException.new(api_response.message, api_response.code) if (api_response.code != "200" && api_response.code != "100")
-				
-				begin
-					# Return the Body of the response for valid requests
-					ActiveSupport::JSON.decode(api_response.body)
-				rescue ActiveSupport::JSON.parse_error
-					# otherwise raise a standard processing exception
-					raise OEHClient::Exception::HTTPRequestException(api.body, 500)
-				end
+				raise OEHClient::Exception::HTTPRequestException.new("HTTP Request Exception with code #{rest_response.code}", rest_response.code) unless (valid_response_codes.include?(rest_response.code))
+
+				api_response = Hash.new
+
+				api_response[:body] 	= (OEHClient::Helper::Response.valid_json?(rest_response.body) ? ActiveSupport::JSON.decode(rest_response.body) : rest_response.body)
+				api_response[:cookies] 	= rest_response.cookies
 
+				api_response
 
 			end
 

data/lib/oehclient/interaction/interaction.rb

@@ -1,6 +1,10 @@
 
 class OEHClient::Interaction::Interaction
 
+	#
+	# -------[ CONSTANTS ]
+	#
+
 	# constants used to construct the restful API Request URL
 	API_REALTIME 				= "/interaction"
 	API_OFFLINE 				= "/offline"
@@ -21,6 +25,10 @@ class OEHClient::Interaction::Interaction
 	ONE_RESPONSE_CAPTURES		= "captures"
 	
 
+	#
+	# -------[ CLASS ATTRIBUTES ]
+	#
+
 	attr_accessor 	:uri, 					# The full touchpoint/interaction URI used to post the interaction
 					:space, 				# The configured OEHClient::Config::Space object that represents the OEH workspace
 	
@@ -33,14 +41,16 @@ class OEHClient::Interaction::Interaction
 					:trackers, 				# The collection of tracking point data that are relevant for the interaction
 					:captures, 				# The collection of capture point data that are relevant for the interactions
 
-					:errors					
+					:cookies				# The JSON object of cookies returned within a ONE Request					
+
+	#
+	# -------[ CLASS METHODS ]
+	#
 
-	###
-	### -------------  Class Methods
-	###
 	class << self
 
-		# post
+		# class-level wrapper to post a new interaction to the OEH server using either the realtime or offline 
+		# API for an anonymous or known prospects/customer
 		def post(site_key, uri, timestamp=nil, tid=nil, customer_key=nil, properties={})
 
 			# setup the baseline attributes hash with the site_key and interaction URI, which are the 
@@ -87,10 +97,11 @@ class OEHClient::Interaction::Interaction
 
 	end
 
-	###
-	### -------------  Instance Methods
-	###
+	#
+	# -------[ INSTANCE METHODS ]
+	#
 
+	# constructor that allows the passed Ruby Hash to be mapped to the 
 	def initialize(attributes=nil)
 
 		# set the instance attributes is the parameter hash is created
@@ -115,7 +126,7 @@ class OEHClient::Interaction::Interaction
 		raise OEHClient::Exception::MissingParameterException.new(missing_minimal_parameters) 	unless (minimal_parameters?)
 
 		# call the appropriate method based on the existance of the timestamp value
-		((!@timestamp.nil?) ? send_offline(@space.token, parameters) : send_realtime(@space.token, parameters))
+		((!@timestamp.nil?) ? send_offline(parameters) : send_realtime(parameters))
 
 		# return the current instance interacton
 		self
@@ -157,50 +168,47 @@ class OEHClient::Interaction::Interaction
 		properties ||= Hash.new
 
 		# Call the PUT method to update the 
-		#OEHClient::Helper::Response.handle(OEHClient.put(@space.token(), 
-		#												OEHClient::Helper::Request.format_url(realtime_url, {:sk => @space.site_key}),
-		#												nil,
-		#												request_data(properties))) unless properties.empty?
-
-		send_request(OEHClient::Helper::Request::PUT_METHOD, @space.token(), realtime_url, properties) unless properties.empty?
+		send_request(OEHClient::Helper::Request::PUT_METHOD, realtime_url, properties) unless properties.empty?
 
 		# return the current object
 		self
 	end
 
 
+	#
+	# -------[ PRIVATE METHODS ]
+	#
+
 	private
 
 
 	# send_realtime posts a new interaction occuring at the moment (in realtime).  The response attributes
 	#  are mapped to the current instance attributes for all valid requests
-	def send_realtime(token, properties={})
+	def send_realtime(properties={})
 		# POST the realtime interaction method
-		response = send_request(OEHClient::Helper::Request::POST_METHOD, token, realtime_url, properties)
+		response = send_request(OEHClient::Helper::Request::POST_METHOD, realtime_url, properties)
 		# map the response message to the current instance attributes
 		map_response(response)
 	end
 
 	# send_offline posts a historic interaction, using a specified timestamp
-	def send_offline(token, properties={})
+	def send_offline(properties={})
 		# PUT the offline interaction method
-		response = send_request(OEHClient::Helper::Request::PUT_METHOD, token, offline_url, properties)	
+		response = send_request(OEHClient::Helper::Request::PUT_METHOD, offline_url, properties)	
 		# map the response message to the current instance attributes
 		map_response(response)
 	end
 
 	# send_request acts as the wrapper to send all client requests to the ONE server in a unified manner
-	def send_request(method, token, url, properties={})
+	def send_request(method, url, properties={})
 		# set the URL parameters for the site_key and the tid, of the value exists
 		url_parameters = {:sk => @space.site_key}		
 		url_parameters.merge!({:tid => @tid})			unless (@tid.blank?)
 		# send the POST or PUT methond along with the arguments to the OEHClient class
-		OEHClient::Helper::Response.handle(OEHClient.send(method.downcase.to_sym, 
-															token,
-															OEHClient::Helper::Request.format_url(url, url_parameters),
-															nil,
-															request_data(properties)
-														))
+		OEHClient.send(method.downcase.to_sym, 
+						url,
+						@space.oauth_consumer,
+						{:params => url_parameters, :payload => ActiveSupport::JSON.encode(request_data(properties))})
 
 	end
 
@@ -208,10 +216,11 @@ class OEHClient::Interaction::Interaction
 	#  attributes in the current instance of the interaction object
 	def map_response(response)
 
+		body = response[:body]
 
 		# Save the tid and session data if they where not previously used in the request
-		@tid 			= response[ONE_PARAM_TID] 		if (@tid.nil? || (!@tid.blank? && @tid != response[ONE_PARAM_TID]))
-		@session 		= response[ONE_PARAM_SESSION] 	if @session.nil?
+		@tid 			= body[ONE_PARAM_TID] 		if (@tid.nil? || (!@tid.blank? && @tid != body[ONE_PARAM_TID]))
+		@session 		= body[ONE_PARAM_SESSION] 	if @session.nil?
 
 		# capture the optimizations returned from the request and map it to the OEHClient::Interaction::Optimization
 		#  class
@@ -219,19 +228,24 @@ class OEHClient::Interaction::Interaction
 		# initialize the optimizations collection if it is null
 		@optimizations ||= Array.new
 		# map each of the optimizations to the OEHClient::Interaction::Optmization class
-		response[ONE_RESPONSE_OPTIMIZATIONS].each do | response_optimization |
+		body[ONE_RESPONSE_OPTIMIZATIONS].each do | response_optimization |
 			@optimizations << OEHClient::Interaction::Optimization.create(response_optimization)
 		end
 
+		# store the cookies passed back by the system
+		@cookies = response[:cookies]
+
 		# capture the trackers returned from the request and mpt it to the OEHClient::Interaction::Tracker 
 		# class
 		# TODO:  Create OEHClient::Interaction::Tracker class
-		@trackers 		= response[ONE_RESPONSE_TRACKERS]
+		@trackers 		= body[ONE_RESPONSE_TRACKERS]
 
 		# capture the capture points returned from the request and map it to the OEHClient::Interaction::Capture 
 		# class
 		# TODO:  Create OEHClient::Interaction::Capture class
-		@captures 		= response[ONE_RESPONSE_CAPTURES]
+		@captures 		= body[ONE_RESPONSE_CAPTURES]
+
+
 
 	end
 

data/lib/oehclient/version.rb

@@ -1,3 +1,3 @@
 module OEHClient
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/oehclient.rb

@@ -1,4 +1,5 @@
 require 'oauth'
+require 'rest-client'
 require 'csv'
 require 'uuidtools'
 require 'json'
@@ -30,50 +31,83 @@ module OEHClient
 
 		end
 
-		# get wraps the GET method of the access token and manages the response that is returned
-		def get(token, url, header={})
+		# wraps the GET method of the RestClient::Resource and manages the response that is returned
+		def get(url, oauth_consumer=nil, *args)
+			# retrieved the passed options from the SPLAT
+			options = (args.length > 0 ? args[0] : Hash.new)
+			# if the oauth_consumer is not a proper OAuth::Consumer, then raise the Oeh::Exception::InvalidTokenException
+			#  exception to the calling method
+			raise OEHClient::Exception::InvalidConsumerException if (!oauth_consumer.nil? && !oauth_consumer.kind_of?(OAuth::Consumer))
 
-			# force the new hash.  Testing in RSPEC uncovered issue with the default not being followed
-			header ||= Hash.new
+			# reset execution processes 
+		    RestClient.reset_before_execution_procs
+			# if this request has an oauth token, sign the RestClient object
+			unless (oauth_consumer.nil?)
+		    	# add the oauth signature
+		    	RestClient.add_before_execution_proc { |req, params| oauth_consumer.sign! req }
+			end
+
+			# force the new hash for the header and params if they are NIL
+			header = (options.has_key?(:header) ? options[:header] : OEHClient::Helper::Request.default_JSON_header())
+			# merge parameters into the header if they are passed
+			header.merge!(:params => options[:params] ) if (options.has_key?(:params))
 
-			# if the token is not a proper OAuth::AccessToken, then raise the Oeh::Exception::InvalidTokenException
-			#  exception to the calling method
-			raise OEHClient::Exception::InvalidTokenException unless (token.kind_of?(OAuth::AccessToken))
 			# send the GET request, manage the returned response, and return the body of the response to the
 			#   calling method
-			token.get(url, header.empty? ? OEHClient::Helper::Request.default_JSON_header() : header)
+			RestClient.get(url, header) { | response, request, result | OEHClient::Helper::Response.handle(response)}
 
 		end
 
 		# post wraps the POST method of the access token and manages the response that is returned
-		def post(token, url, header={}, body)
+		def post(url, oauth_consumer=nil, *args)
+			# retrieved the passed options from the SPLAT
+			options = (args.length > 0 ? args[0] : Hash.new)
+			# if the oauth_consumer is not a proper OAuth::Consumer, then raise the Oeh::Exception::InvalidTokenException
+			#  exception to the calling method
+			raise OEHClient::Exception::InvalidConsumerException if (!oauth_consumer.nil? && !oauth_consumer.kind_of?(OAuth::Consumer))
 
-			# force the new hash.  Testing in RSPEC uncovered issue with the default not being followed
-			header ||= Hash.new
+			# reset execution processes 
+		    RestClient.reset_before_execution_procs
+			# if this request has an oauth token, sign the RestClient object
+			unless (oauth_consumer.nil?)
+		    	# add the oauth signature
+		    	RestClient.add_before_execution_proc { |req, params| oauth_consumer.sign! req }
+			end
+
+			# force the new hash for the header and params if they are NIL
+			header = (options.has_key?(:header) ? options[:header] : OEHClient::Helper::Request.default_JSON_header())
+			# merge parameters into the header if they are passed
+			header.merge!(:params => options[:params] ) if (options.has_key?(:params))
 
-			# if the token is not a proper OAuth::AccessToken, then raise the Oeh::Exception::InvalidTokenException
-			#  exception to the calling method
-			raise OEHClient::Exception::InvalidTokenException unless (token.kind_of?(OAuth::AccessToken))
 			# send the POST request, manage the returned response, and return the body of the response to the
 			#   calling method
-			token.post(url, ActiveSupport::JSON.encode(body), header.empty? ? OEHClient::Helper::Request.default_JSON_header() : header)
-
-
+			RestClient.post(url, options[:payload], header) { | response, request, result | OEHClient::Helper::Response.handle(response)}
 		end
 
 		# put wraps the PUT method of the access token and manages the response that is returned
-		def put(token, url, header={}, body)
+		def put(url, oauth_consumer=nil, *args)
+			# retrieved the passed options from the SPLAT
+			options = (args.length > 0 ? args[0] : Hash.new)
+			# if the oauth_consumer is not a proper OAuth::Consumer, then raise the Oeh::Exception::InvalidTokenException
+			#  exception to the calling method
+			raise OEHClient::Exception::InvalidConsumerException if (!oauth_consumer.nil? && !oauth_consumer.kind_of?(OAuth::Consumer))
 
-			# force the new hash.  Testing in RSPEC uncovered issue with the default not being followed
-			header ||= Hash.new
+			# reset execution processes 
+		    RestClient.reset_before_execution_procs
+			# if this request has an oauth token, sign the RestClient object
+			unless (oauth_consumer.nil?)
+		    	# add the oauth signature
+		    	RestClient.add_before_execution_proc { |req, params| oauth_consumer.sign! req }
+			end
 
-			# if the token is not a proper OAuth::AccessToken, then raise the Oeh::Exception::InvalidTokenException
-			#  exception to the calling method
-			raise OEHClient::Exception::InvalidTokenException unless (token.kind_of?(OAuth::AccessToken))
-			# send the PUT request, manage the returned response, and return the body of the response to the
-			#   calling method
-			token.put(url, ActiveSupport::JSON.encode(body), header.empty? ? OEHClient::Helper::Request.default_JSON_header() : header)
+			# force the new hash for the header and params if they are NIL
+			header = (options.has_key?(:header) ? options[:header] : OEHClient::Helper::Request.default_JSON_header())
+			# merge parameters into the header if they are passed
+			header.merge!(:params => options[:params] ) if (options.has_key?(:params))
 
+			# send the POST request, manage the returned response, and return the body of the response to the
+			#   calling method
+			RestClient.put(url, options[:payload], header) { | response, request, result | OEHClient::Helper::Response.handle(response)}
 		end
 	
 	end

data/oeh-client.gemspec

@@ -36,5 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency   "uuidtools"
   spec.add_dependency   "activesupport", "~> 4.2.0"
   spec.add_dependency   "railties", ">= 4.2.0"
+  spec.add_dependency   "rest-client"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oeh-client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Balliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2015-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple set of classes that allow access to Interactions, Documents,
   and Structures from within Thunderhead's ONE Enagement Hub
 email: