oeh-client 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4914d46433c089f9f961bdc39d0f58a2ed106872
-  data.tar.gz: 97248da62edaa4d7124ebf75da051ba22ecaaa59
+  metadata.gz: e329ef9084462966190cde7df9afadd941a63d63
+  data.tar.gz: 2883d18464bd912779cf8e1f45c8e9f70f9e1c01
 SHA512:
-  metadata.gz: 5279577a63e004b9f9fcac636b582c9250901bff34cc245677917f23ea8b4ec3f0a0575504a3995354b0a3dee9c76a1f002014fb9011e0a1239fd72eeeeddb6d
-  data.tar.gz: f0f3401766d11ea8d0b44ac661309cfccb38ca602d1a25a7228bdc9e7b7d11e13899a3905da884e68ea04e9d6cb64ea4d980d7dfca089d6b9ab24a3ebb92f426
+  metadata.gz: 76178d87e2ed00917e314fe83be1f86e5d59276e748a9593d5a9109bffbc67a69a10e69c7e627e860c4158de9c6c03b0e862dcda1d656096cea53c519ff04edc
+  data.tar.gz: f61c150e15dbd33c17a781e73337b7a9eff598d002df6b1dc65a80994dfcaec1cfbdd17c91e12ac5e3d30d378e1cecfead7f83e39bef334272dc9aaec78c7de5

data/lib/oehclient/helper.rb

@@ -38,7 +38,7 @@ module OEHClient
 			# default_JSON_header is the default header that is passed to any OEH Request if not provided explicitly by the 
 			#  calling methods
 			def self.default_JSON_header()
-				{'Accept' => 'application/json' , 'Content-Type' =>'application/json', 'X-Requested-With' => 'XMLHttpRequest' }
+				{'Accept' => 'application/json' , 'dataMimeType' => 'application/json','Content-Type' =>'application/json', 'X-Requested-With' => 'XMLHttpRequest' }
 			end
 
 

data/lib/oehclient/interaction/interaction.rb

@@ -1,3 +1,4 @@
+require 'base64'
 
 class OEHClient::Interaction::Interaction
 
@@ -6,23 +7,25 @@ class OEHClient::Interaction::Interaction
 	#
 
 	# constants used to construct the restful API Request URL
-	API_REALTIME 				= "/interaction"
-	API_OFFLINE 				= "/offline"
+	API_REALTIME 					= "/interaction"
+	API_OFFLINE 					= "/offline"
 	# ONE attributes that are either in the request and/or returned in the response
-	ONE_PARAM_URI 				= "uri"
-	ONE_PARAM_CK				= "customerKey"
-	ONE_PARAM_TID 				= "tid"
-	ONE_PARAM_SESSION 			= "session"
-	ONE_PARAM_SK				= "sk"
-	ONE_PARAM_TS				= "timestamp"
-	ONE_PARAM_PROPERTIES		= "properties"
+	ONE_PARAM_URI 					= "uri"
+	ONE_PARAM_CK					= "customerKey"
+	ONE_PARAM_TID 					= "tid"
+	ONE_PARAM_SESSION 				= "session"
+	ONE_PARAM_SK					= "sk"
+	ONE_PARAM_TS					= "timestamp"
+	ONE_PARAM_PROPERTIES			= "properties"
 	# Property Hash Keys
-	ONE_PROPERTIES_NAME			= "name"
-	ONE_PROPERTIES_VALUE		= "value"
+	ONE_PROPERTIES_NAME				= "name"
+	ONE_PROPERTIES_VALUE			= "value"
 	# Collection objects returned in the response
-	ONE_RESPONSE_OPTIMIZATIONS 	= "optimizations"
-	ONE_RESPONSE_TRACKERS		= "trackers"
-	ONE_RESPONSE_CAPTURES		= "captures"
+	ONE_RESPONSE_OPTIMIZATIONS 		= "optimizations"
+	ONE_RESPONSE_OPTIMIZATION_DATA 	= "data"
+	ONE_RESPONSE_ACTIONS			= "actions"
+	ONE_RESPONSE_TRACKERS			= "trackers"
+	ONE_RESPONSE_CAPTURES			= "captures"
 	
 
 	#
@@ -231,7 +234,12 @@ class OEHClient::Interaction::Interaction
 		@optimizations ||= Array.new
 		# map each of the optimizations to the OEHClient::Interaction::Optmization class
 		body[ONE_RESPONSE_OPTIMIZATIONS].each do | response_optimization |
-			@optimizations << OEHClient::Interaction::Optimization.create(response_optimization)
+			# decode the data of the optimization
+			optimization_data = ActiveSupport::JSON.decode(Base64.decode64(response_optimization[ONE_RESPONSE_OPTIMIZATION_DATA]))
+			# get the actions for each optimization
+			optimization_data[ONE_RESPONSE_ACTIONS].each do | one_action |
+				@optimizations << OEHClient::Interaction::Optimization.create(self, one_action)
+			end
 		end
 
 		# store the cookies passed back by the system

data/lib/oehclient/interaction/optimization.rb

@@ -4,36 +4,46 @@ require 'cgi'
 class OEHClient::Interaction::Optimization
 
 	# HASH keys based on the response data
-	OPT_RESPONSE_DATA 			= "data"
-	OPT_RESPONSE_PATH			= "path"
-	OPT_RESPONSE_ID 			= "responseId"
-	OPT_RESPONSE_MIME_TYPE 		= "dataMimeType"
-	OPT_RESPONSE_DIRECTIVES 	= "directives"
+	OPT_RESPONSE_NAME			= "name"
+	OPT_RESPONSE_ASSET			= "asset"
+	OPT_RESPONSE_CONTENT		= "content"
+	OPT_RESPONSE_CONTENT_URL	= "contentUrl"
+	OPT_RESPONSE_MIME_TYPE 		= "mimeType"
+	OPT_RESPONSE_PROPOSITION 	= "proposition"
+	OPT_RESPONSE_RESPONSES		= "responses"
 
 	# Localized attributes equivalent to the returned Hash object in the response
-	attr_accessor 	:data, 							# Base64 Encoded Asset returned by OEH
-					:path, 							# The path of the optimization based on the OEH Configuration
-					:response_id, 					# The Response ID of the asset based on the OEH Configuration
-					:mime_type, 					# The MIME Type of the asset based on the OEH Configuration
-					:directives
-
+	attr_accessor 	:name,							# The name of the action
+					:content,						# The decoded content of the asset
+					:content_url,					# The URL to the referential asset
+					:mime_type,						# The MIME Type of the asset based on the OEH Configuration
+					:proposition,					# The code of the proposition, related to the optimization
+					:responses,						# The collection of responses valid for this optmization
+					:interaction 					# The parent interaction object
 
 	# ---- Class Methods 
 
-	def self.create(properties={})
+	def self.create(interaction, properties={})
+
+		one_asset = properties[OPT_RESPONSE_ASSET]
 
 		# create a new instance of the OEHClient::Interaction::Optimization class
 		optimization_instance = OEHClient::Interaction::Optimization.new()
 
 		# assign all data attributes based on the properties object that is passed
-		optimization_instance.data 			= properties[OPT_RESPONSE_DATA] 		if (properties.has_key?(OPT_RESPONSE_DATA))
-		optimization_instance.path 			= properties[OPT_RESPONSE_PATH] 		if (properties.has_key?(OPT_RESPONSE_PATH))
-		optimization_instance.response_id 	= properties[OPT_RESPONSE_ID]			if (properties.has_key?(OPT_RESPONSE_ID))
-		optimization_instance.mime_type 	= properties[OPT_RESPONSE_MIME_TYPE]	if (properties.has_key?(OPT_RESPONSE_ID))
-		optimization_instance.directives 	= properties[OPT_RESPONSE_DIRECTIVES]	if (properties.has_key?(OPT_RESPONSE_DIRECTIVES))
-
-		#puts "Response ID is #{Base64.decode64(optimization_instance.response_id)}"
-
+		optimization_instance.name 			= properties[OPT_RESPONSE_NAME] 						if (properties.has_key?(OPT_RESPONSE_NAME))
+		optimization_instance.proposition	= properties[OPT_RESPONSE_PROPOSITION]					if (properties.has_key?(OPT_RESPONSE_PROPOSITION))
+		# map the asset data to the class instance variables
+		optimization_instance.content		= CGI.unescapeHTML(one_asset[OPT_RESPONSE_CONTENT])		if (one_asset.has_key?(OPT_RESPONSE_CONTENT))
+		optimization_instance.content_url	= one_asset[OPT_RESPONSE_CONTENT_URL] 					if (one_asset.has_key?(OPT_RESPONSE_CONTENT_URL))
+		optimization_instance.mime_type		= one_asset[OPT_RESPONSE_MIME_TYPE] 					if (one_asset.has_key?(OPT_RESPONSE_MIME_TYPE))
+		# map each of the respones to the response object
+		optimization_instance.responses ||= Array.new
+		one_asset[OPT_RESPONSE_RESPONSES].each do | asset_response |
+			optimization_instance.responses << OEHClient::Interaction::Response.create(optimization_instance, asset_response)
+		end
+		# set the parent interaction object
+		optimization_instance.interaction = interaction
 		#return the new instance of the optimzation class
 		optimization_instance
 
@@ -41,13 +51,5 @@ class OEHClient::Interaction::Optimization
 
 	# ---- Instance Methods 
 
-	# TODO:  Need to create a series of methods that properly decodes the object based on Mime Type
-	# decodes the Base64 encoded data and returns it raw form
-	def decode_data()
-
-		CGI.unescapeHTML(Base64.decode64(@data.to_json))
-
-	end
-
 
 end

data/lib/oehclient/interaction/response.rb

@@ -0,0 +1,74 @@
+
+class OEHClient::Interaction::Response
+
+	# HASH keys based on the response data
+	OPT_RESPONSE_CODE			= "code"
+	OPT_RESPONSE_SENTIMENT		= "sentiment"
+	OPT_RESPONSE_LABEL			= "label"
+	OPT_RESPONSE_IMAGE_URL		= "imageUrl"
+	OPT_RESPONSE_TARGET_URL 	= "targetUrl"
+	OPT_RESPONSE_TARGET			= "target"
+
+	RESPONSE_CODE_PROPERTY 		= "_RESP_CODE_"
+
+	SENTIMENT_POSITIVE			= "positive"
+	SENTIMENT_NEUTRAL			= "neutral"
+	SENTIMENT_NEGATIVE 			= "negative"
+
+	# Localized attributes equivalent to the returned Hash object in the response
+	attr_accessor 	:code,							# The response code needed for responses
+					:sentiment,						# The sentiment of the response (POSITIVE, NEUTRAL, NEGATIVE)
+					:label,							# The label used for display
+					:image_url,						# The URL to the image
+					:target_url, 					# The url to redirect to when the response is selected
+					:target, 						# The Target Type (ONE, ...)
+					:optimization
+
+	# ---- Class Methods 
+
+	def self.create(optimization, properties={})
+
+		# create a new instance of the OEHClient::Interaction::Optimization class
+		response_instance = OEHClient::Interaction::Response.new()
+
+		# assign all data attributes based on the properties object that is passed
+		response_instance.code 			= properties[OPT_RESPONSE_CODE] 		if (properties.has_key?(OPT_RESPONSE_CODE))
+		response_instance.sentiment 	= properties[OPT_RESPONSE_SENTIMENT] 	if (properties.has_key?(OPT_RESPONSE_SENTIMENT))
+		response_instance.label 		= properties[OPT_RESPONSE_LABEL] 		if (properties.has_key?(OPT_RESPONSE_LABEL))
+		response_instance.image_url 	= properties[OPT_RESPONSE_IMAGE_URL] 	if (properties.has_key?(OPT_RESPONSE_IMAGE_URL))
+		response_instance.target_url 	= properties[OPT_RESPONSE_TARGET_URL] 	if (properties.has_key?(OPT_RESPONSE_TARGET_URL))
+		response_instance.target 		= properties[OPT_RESPONSE_TARGET]		if (properties.has_key?(OPT_RESPONSE_TARGET))
+		# map the parent object
+		response_instance.optimization 	= optimization
+		#return the new instance of the optimization class
+		response_instance
+
+	end
+
+	# ---- Instance Methods 
+
+	# helper method to get the interacton object from the parent optimization
+	def interaction
+		@optimization.interaction
+	end
+
+	# wrapper for sending the response from the existing object
+	def send
+		interaction.send_update({RESPONSE_CODE_PROPERTY => @code})
+	end
+
+	# returns true if the curent response is a positive response
+	def is_positive?()
+		@sentiment.casecmp(SENTIMENT_POSITIVE)
+	end
+	# returns true if the current response is a neutral response 
+	def is_neutral?()
+		@sentiment.casecmp(SENTIMENT_NEUTRAL)
+	end
+	# returns true if the current response is a negative response
+	def is_negative?
+		@sentiment.casecmp(SENTIMENT_NEGATIVE)
+	end
+
+
+end

data/lib/oehclient/interaction.rb

@@ -7,3 +7,4 @@ end
 
 require File.dirname(__FILE__) + '/interaction/interaction'
 require File.dirname(__FILE__) + '/interaction/optimization'
+require File.dirname(__FILE__) + '/interaction/response'

data/lib/oehclient/version.rb

@@ -1,3 +1,3 @@
 module OEHClient
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oeh-client
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason Balliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-13 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,6 +168,7 @@ files:
 - lib/oehclient/interaction.rb
 - lib/oehclient/interaction/interaction.rb
 - lib/oehclient/interaction/optimization.rb
+- lib/oehclient/interaction/response.rb
 - lib/oehclient/meta.rb
 - lib/oehclient/meta/entity.rb
 - lib/oehclient/meta/workspace.rb