oeh-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f692b3e09448980d130c5b6f9b031c4238211fe
-  data.tar.gz: 085a267a6504f505244e725b9081f49976f6fe35
+  metadata.gz: d9f5960ced53f58584b1935cfe270272eb42316a
+  data.tar.gz: c387e88e484567f322b38f0000e4a2b3771af84f
 SHA512:
-  metadata.gz: 92571201066617e1bc99fed7bdd627b708a91b6253d82eefc90eb399db8527aab8b7dcc4f5ccceaa24805fc6d0a075e850a0d1e7767346a3ac31483ee14c19e8
-  data.tar.gz: 3b02be0c9729a14531c489b267552ebe8f816ba66707b7c540524d918007905ae52ebf4880413c69a0a3f332c74c22af1bad412ed94ac5262364c5932711a018
+  metadata.gz: f3a11dd8fbdaa7e532b982b846f59733d781a77fcb575ee0e964eda2c48035c98222c60b6e071d768e50ce9de34ae387327dbb54ea2218286644fdecf0641392
+  data.tar.gz: e811cc449587f719b12c374f42b79e8b055b5394b1c535a1f289805dae9226e25005e9c19c48e5eba78e8b358740ef309f10cc66951b202a8ab88ca46b096514

data/README.md

@@ -1,8 +1,18 @@
 # OEHClient
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/oehclient`. To experiment with that code, run `bin/console` for an interactive prompt.
+ONE Engagement Hub (OEH) is the premier customer engagement platform offered by Thunderhead, Inc. The OEHClient ('oeh-client') gem is a series of wrapper classes that allow your ruby/rails applicaitons to easily support integration with the platform.
 
-TODO: Delete this and the text above, and describe your gem
+## Feature Description
+
+OEHClient exposes the key features of the ONE Engagement Hub (OEH) system through some simplified classes.  The client interface allows you to:
+
+* Register multiple spaces (OEH Configurations) to allow a single application to interact with each of your company configurations
+
+* Post customer and anoymous interactions to the ONE Engagement Hub (OEH) server
+
+* Manage and expose personalized assets and response handlers for optimized interactions
+
+* Fetch structure data from the ONE Engagement Hub (OEH) in realtime
 
 ## Installation
 
@@ -14,7 +24,7 @@ gem 'oeh-client'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 

data/lib/oehclient/config/space.rb

@@ -4,8 +4,8 @@ class OEHClient::Config::Space
 					:host,				# The name of the HOST machine on thunderhead.com (ONEDEMO, EU2, NA4, etc..)
 					: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
-
+					:username,			# The fully-qualified username configured for access to the space
+					:meta_password		# The password needed to access meta-data from the OEH server			
 
 	# ---- Class Methods 
 
@@ -22,6 +22,7 @@ class OEHClient::Config::Space
 		space_instance.api_key 			= properties[:api_key]			if (properties.has_key?(:api_key))
 		space_instance.shared_secret 	= properties[:shared_secret]	if (properties.has_key?(:shared_secret))
 		space_instance.username			= properties[:username]			if (properties.has_key?(:username))
+		space_instance.meta_password 	= properties[:meta_password] 	if (properties.has_key?(:meta_password))
 
 		# return the instance of the OEHClient::Site Class
 		space_instance
@@ -56,4 +57,11 @@ class OEHClient::Config::Space
 		(!@username.nil? && !@username.empty?))
 	end
 
+	# determines if the space configuration appears to be valid for access to the raw meta-data entities.
+	# The method expects the standard valid attributes from is_valid? as well as the meta_password 
+	# attribute
+	def meta_access?()
+		self.is_valid? && (!@meta_password.blank?)
+	end
+
 end

data/lib/oehclient/helper.rb

@@ -44,7 +44,6 @@ module OEHClient
 		module Response
 
 			def self.handle(api_response)
-
 				# 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")
 				

data/lib/oehclient/interaction/interaction.rb

@@ -22,7 +22,7 @@ class OEHClient::Interaction::Interaction
 	
 
 	attr_accessor 	:uri, 					# The full touchpoint/interaction URI used to post the interaction
-					:space, 				# The configured OEHClient::Config::Space object that represents the
+					:space, 				# The configured OEHClient::Config::Space object that represents the OEH workspace
 	
 					:timestamp, 			# A millisecond value representing a Time value of the interaction					
 					:customer_key, 			# The customer to which this interaction is related
@@ -51,7 +51,7 @@ class OEHClient::Interaction::Interaction
 						 }
 
 			# conditionally merge the rest of the attributes if they are passed
-			attributes.merge!(:timestamp => timestamp)		if (!timestamp.nil? && !timestamp.empty?)
+			attributes.merge!(:timestamp => timestamp)		unless (timestamp.nil?)
 			attributes.merge!(:tid => tid)					if (!tid.nil? && !tid.empty?)
 			attributes.merge!(:ck => customer_key)			if (!customer_key.nil? && !customer_key.empty?)
 
@@ -111,18 +111,21 @@ class OEHClient::Interaction::Interaction
 	# send() will post a new interaction using either the realtime (current timestamp) or the offline (historic)
 	#  API interface based on the existence of a timestamp value
 	def send(parameters={})
+		# raise the MissingParameterException when one (or more) of the miminal parameters are missing
+		raise OEHClient::Exception::MissingParameterException.new(missing_minimal_parameters) 	unless (minimal_parameters?)
 
 		# call the appropriate method based on the existance of the timestamp value
-		((minimal_parameters? && !@timestamp.nil? && @timestamp > 0) ? send_offline(@space.token) : send_realtime(@space.token, parameters))
+		((!@timestamp.nil? && @timestamp > 0) ? send_offline(@space.token) : send_realtime(@space.token, parameters))
 
 		# return the current instance interacton
 		self
-
 	end
 
 	# send_new posts a new interaction using the existing instance data, but for a different touchpoint 
 	#   URI.  The method returns a new instance of the OEHClient::Interaction::Interaction class
 	def send_new(uri, timestamp=nil, parameters={})
+		# raise the MissingParameterException when one (or more) of the miminal parameters are missing
+		raise OEHClient::Exception::MissingParameterException.new(missing_minimal_parameters) 	unless (minimal_parameters?)
 
 		# protect against NIL by creating a new Hash object if the parameters, for any reason is 
 		#  NIL
@@ -142,12 +145,13 @@ class OEHClient::Interaction::Interaction
 
 		# Send the interaction for processing and return the current instance
 		new_interaction.send(parameters)
-
 	end
 
 	# send_update allows the system to update the capture and tracking properties that are defined as 
 	#  part of the existing interaction
 	def send_update(properties={}) 
+		# raise the MissingParameterException when one (or more) of the miminal parameters are missing
+		raise OEHClient::Exception::MissingParameterException.new(missing_minimal_parameters) 	unless (minimal_parameters?)
 
 		# force the properties object to be an empty Hash if, for any reason, it is NIL
 		properties ||= Hash.new
@@ -159,7 +163,6 @@ class OEHClient::Interaction::Interaction
 														request_data(properties))) unless properties.empty?
 		# return the current object
 		self
-
 	end
 
 
@@ -228,7 +231,20 @@ class OEHClient::Interaction::Interaction
 	#  present in the current instance of the interaction class. This is a helper method that is used
 	#  before making any request
 	def minimal_parameters?()
-		!@uri.nil? && !@site_key.nil?
+		((!@uri.nil? && !@uri.empty?) && !@space.nil?)
+	end
+
+	# missing_minimal_parameters returns an array of the minimal attributes that are missing  from the current
+	#  instance of OEHClient::Interaction::Interaction class
+	def missing_minimal_parameters
+
+		missing_parameters = []
+
+		missing_parameters << "site_key"	if (!minimal_parameters? && @site_key.nil?)
+		missing_parameters << "uri"			if (!minimal_parameters? && @uri.nil?)
+
+		missing_parameters
+
 	end
 
 	# request_url returns the base of the request URL used to make either a realtime or offline request

data/lib/oehclient/interaction/optimization.rb

@@ -32,6 +32,8 @@ class OEHClient::Interaction::Optimization
 		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)}"
+
 		#return the new instance of the optimzation class
 		optimization_instance
 
@@ -43,7 +45,6 @@ class OEHClient::Interaction::Optimization
 	# decodes the Base64 encoded data and returns it raw form
 	def decode_data()
 
-
 		CGI.unescapeHTML(Base64.decode64(@data.to_json))
 
 	end

data/lib/oehclient/version.rb

@@ -1,3 +1,3 @@
 module OEHClient
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oeh-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jason Balliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler