oeh-client 0.3.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c1becb519a0be3ffdb8cd3f9845292c91a826cd
-  data.tar.gz: 9fb57347bea09ff50996e298b46b7a0638a99d37
+  metadata.gz: 8d5b67302ac27817b6fe0c224cff58885a9b1e9b
+  data.tar.gz: ddbcca89c7b88e49e4a328275dfdcd2a5689f0bd
 SHA512:
-  metadata.gz: 3af352f19d4faeaaaac88662428ccd2d36ea85f54bd1e8640cac522ebe03a6ea7dfa40686e1c5037ee4091bf4def9cabef8ce59d7696232fdfa23b2465707779
-  data.tar.gz: 47786c288281f258a234f4b31a9f38f8f2d0ff2f8e61f972b6c58c8c24268a9b10fb4e5b080df6560eec8017a5fe3c9cbfa48fae805ad89d99e16ed9a6280b03
+  metadata.gz: 0489e56ed2006b20e92bc242a7adccb3f5503391e0096926e11e0e45af79a14f7879559024b3a135b8fd1afdb2f799f140fee26bbd4e97c48f0077f6025370c4
+  data.tar.gz: 5d4b72a0ab88bca1e7c9be7db538afb42954c953db0f30135f4868d67795471bc296bfa5375c9c8b1e7c193bf06216a0084efd0b39120fa01334fa750972ad75

data/README.md

@@ -57,7 +57,7 @@ As needed, you can register multiple spaces for the same instances to support in
 Interactions are the key elements of the customer experience. Interactions represent the back-and-forth between the customer and your organization.  You can post an interaction simply:
 
 ```ruby
-customer_interaction = OEHClient::Interaction::Interaction.post("YOUR_TARGET_SITE_KEY", "TOUCHPOINT_INTERACTION_URI")
+customer_interaction = OEHClient::Realtime::Interaction.post("YOUR_TARGET_SITE_KEY", "TOUCHPOINT_INTERACTION_URI")
 ```
 The post method will return an instance of the OE
 

data/lib/oehclient/config/space.rb

@@ -18,7 +18,7 @@ class OEHClient::Config::Space
 					: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
-					:cookies			# The cookies returned from an OEH API request
+					:workspace 			# The ONE workspace related to the current space
 
 	###
 	### -------------  Class Methods
@@ -103,36 +103,12 @@ class OEHClient::Config::Space
 		"#{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()
-		# post the login request
-		response = OEHClient.post(login_url, nil, :payload => meta_credentials)
-		# store the cookies if they are returned in the response
-		@cookies = response[:cookies]  if (response.has_key?(:cookies))
-	end
-
-	# logout of the OEH thinstance and remove the current cookie references
-	def logout()
-		# construct a header object, merging cookies (if present) wit the default JSON header
-		header = Hash.new
-		header.merge!(:cookies => @cookies)								unless (@cookies.blank?)
-		header.merge!(OEHClient::Helper::Request.default_JSON_header)
-		# post the logout request
-		OEHClient.post(logout_url, nil, :header => header)
-		# remove the cookies if the logout is posted successfully
-		@cookies = nil	
-	end
-
 	# retrieve the workspace meta-data object from the thinstance in realtime
-	def workspace()
-		# if the cookies are currently NIL then login using the existing credentials
-		login() if (@cookies.nil?)
-		# get the workspace object using the site key, the host value, and the exisitng cookies 
-		workspace_instance = OEHClient::Meta::Workspace.fetch(@site_key, @host, :cookies => @cookies)
-		# assign the current space to the workspace instance
-		workspace_instance.space = self
-		# return the workspace instance object
-		workspace_instance
+	def get_workspace()
+		# create an active session with ONE 
+		workspace = OEHClient::Meta::Session.attach(self).workspace(site_key) 	if (workspace.nil?)
+		# return the active workspace object
+		workspace
 	end
 
 end

data/lib/oehclient/meta/entity.rb

@@ -1,44 +1,88 @@
-class OEHClient::Meta::Entity
+module OEHClient::Meta::Entity
 
 	###
 	### -------------  Constants
 	###
 
-	###
-	### -------------  Attributes
-	###
-	attr_accessor 	:space 					# The configured OEHClient::Config::Space object that represents the OEH workspace
+	ONE_PARAM_DATA 				= "data"
+	ONE_PARAM_SUCCESS			= "success"
+	ONE_PARAM_ID				= "id"
+	ONE_PARAM_NAME				= "name"
+	ONE_PARAM_CREATED_ON		= "createdDate"
+	ONE_PARAM_CREATED_BY 		= "createdBy"
 
+	ONE_PARAM_ITEMS				= "items"
 
 	###
-	### -------------  Class Methods
+	### -------------  Class Attributes 
 	###
 
-	def self.create()
-	end # def self.create
-
-	def self.find(*args)
+	def entity_uri_stem=(uri_stem)
+		@entity_stem = uri_stem
+	end
 
-		options = args.extract_options!
+	def entity_uri_stem
+		@entity_stem
+	end
 
-		case args.first
-			 when :first then 	find_initial(options)
-			 when :last then 	find_last(options)
-			 when :all then 	find_every(options)
-			 else 				find_from_id(args, options)
-		end
+	def session=(session_instance)
+		@session = session_instance
+	end
 
+	def session
+		@session
 	end
 
-	def self.fetch(space, entity_type)
+	###
+	### -------------  Helper Class Methods
+	###
 
-		url = "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{space.host}#{OEHClient::Helper::Request::THUNDERHEAD_DOMAIN}/one/services/api/#{entity_type.downcase.pluralize}"
+	def create()
+	end # def self.create
 
-		header = (!space.cookies.nil? ? {:cookies => space.cookies}.merge!(OEHClient::Helper::Request.default_JSON_header()) : OEHClient::Helper::Request.default_JSON_header())
+	def find_by_name(active_session, name,  **args)
+		get(active_session, {:name => ONE_PARAM_NAME, :value => name}, args)
+	end
 
-		response = OEHClient.get(url, nil, :header => header)
+	###
+	### -------------  Core Class Methods
+	###
 
-	end
+	def get_collection(active_session, **args)
+		# store the active session object for future use
+		self.session = active_session 	if (session.nil?)
+		# get the list of args
+		entity_uri = (args.has_key?(:space)) ? "workspaces/#{args[:space]}/#{entity_uri_stem}" : "#{entity_uri_stem}" 
+		# construct the URL for retrieving the entity
+		url = "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{self.session.space.host}#{OEHClient::Helper::Request::THUNDERHEAD_DOMAIN}/one/services/api/#{entity_uri}"
+		# set the header information
+		header = (!self.session.cookies.nil? ? {:cookies => self.session.cookies}.merge!(OEHClient::Helper::Request.default_JSON_header()) : OEHClient::Helper::Request.default_JSON_header())
+		# construct the request params using the header and params (if passed)
+		request_params = {:header => header}
+		request_params.merge!({:params => args[:params]}) 		if (args.has_key?(:params))
+		# GET the data
+		collection_response = OEHClient.get(url, nil, request_params)
+		# return the data object for valid requests or a blank array otherwise
+		((collection_response.has_key?(:body) && collection_response[:body][ONE_PARAM_SUCCESS]) ? (collection_response[:body][ONE_PARAM_DATA].is_a?(Hash) ? collection_response[:body][ONE_PARAM_DATA][ONE_PARAM_ITEMS] : collection_response[:body][ONE_PARAM_DATA]) : [] )
+	end # def get_collection
+
+	def get(active_session, attribute_nvp, **args)
+		# store the active session object for future use
+		session = active_session 	if (session.nil?)
+		# initialize the entity instance as a blank hash
+		entity_instance = Hash.new
+		# Get the collection of objects requested
+		get_collection(session, **args).each do | collection_instance |
+			# find the matching entry and assign the entity instance
+			entity_instance = collection_instance if (collection_instance[attribute_nvp[:name]].casecmp(attribute_nvp[:value]) == 0)
+		end # Each OEHClient::Meta::Entity.get_collection
+		# return the copy of the entity instance data
+		entity_instance
+	end # def get
+
+	###
+	### -------------  Instance Attributes
+	###
 
 	###
 	### -------------  Instance Methods
@@ -50,21 +94,4 @@ class OEHClient::Meta::Entity
 
 	protected 
 
-
-	def self.find_initial(options)
-
-	end
-
-	def self.find_last(options)
-
-	end
-
-	def self_find_every(options)
-	end
-
-	def self.find_from_id(args, options)
-
-	end
-
-
 end

data/lib/oehclient/meta/interaction.rb

@@ -0,0 +1,14 @@
+class OEHClient::Meta::Interaction < OEHClient::Data::Node
+	include OEHClient::Meta::WorkspaceEntity
+
+	self.entity_uri_stem 	= "pageCfg/pages"
+
+
+	def self.create(workspace, data)
+		interaction_instance	 			= OEHClient::Meta::Interaction.new(data)
+		interaction_instance.workspace 	= workspace
+
+		interaction_instance
+	end
+
+end

data/lib/oehclient/meta/session.rb

@@ -0,0 +1,36 @@
+class OEHClient::Meta::Session
+
+	attr_accessor :cookies, :space
+
+	def self.attach(space)
+		# post the login request
+		response = OEHClient.post(space.login_url, nil, :payload => space.meta_credentials)
+		# create a new session object
+		session_instance = OEHClient::Meta::Session.new()
+		# assign the space object
+		session_instance.space 		= space
+		# store the cookies if they are returned in the response
+		session_instance.cookies 	= response[:cookies]  if (response.has_key?(:cookies))
+		# return the session instance
+		session_instance
+	end
+
+	def detach()
+		# construct a header object, merging cookies (if present) wit the default JSON header
+		header = Hash.new
+		header.merge!(:cookies => @cookies)								unless (@cookies.blank?)
+		header.merge!(OEHClient::Helper::Request.default_JSON_header)
+		# post the logout request
+		OEHClient.post(@space.logout_url, nil, :header => header)
+		# remove the cookies if the logout is posted successfully
+		@cookies = nil	
+	end
+
+	# retrieve the workspace meta-data object from the thinstance in realtime
+	def workspace(site_key)
+		# get the workspace object using the site key, the host value, and the exisitng cookies 
+		OEHClient::Meta::Workspace.find_by_key(self, site_key)
+	end
+
+
+end

data/lib/oehclient/meta/touchpoint.rb

@@ -0,0 +1,36 @@
+class OEHClient::Meta::Touchpoint < OEHClient::Data::Node
+	include OEHClient::Meta::WorkspaceEntity
+
+	# tell the workspace entity module how to reference within ONE
+	self.entity_uri_stem 	= "touchpoints"
+
+	# create a new instance of the class using the data set and assig the workspace
+	def self.create(workspace, data)
+		# create from the past data structure
+		touchpoint_instance	 			= OEHClient::Meta::Touchpoint.new(data)
+		# assign the local workspace object
+		touchpoint_instance.workspace 	= workspace
+		# return the instance
+		touchpoint_instance
+	end # self.create
+
+	# retrieve the full collection of touchpoints from the curent workspace
+	def interactions()
+		# initialize the collection array
+		interaction_collection 	= Array.new
+		# retrieve the collection from ONE using the workspace reference and current touchpoint
+		OEHClient::Meta::Interaction.get_collection(self.class.session, space: workspace.id, params: {:site => id}).each do | interaction_item |
+			# create the instance of the interaction and add it to the collection
+			interaction_collection << OEHClient::Meta::Interaction.create(workspace, interaction_item)
+		end
+		# return the collection to calling process
+		interaction_collection
+	end # end def interactions
+
+	# retrieve a single touchpoint from the current workspace based on the name
+	def interaction(interaction_name)
+		# create and return the instance of an interaction based on the name, current workspace, and current touchpoint
+		OEHClient::Meta::Interaction.create(workspace, OEHClient::Meta::Interaction.find_by_name(self.class.session, interaction_name, space: workspace.id, params: {:site => id}))
+	end # def interaction
+
+end # class OEHClient::Meta::Touchpoint

data/lib/oehclient/meta/workspace.rb

@@ -1,82 +1,58 @@
-class OEHClient::Meta::Workspace
+class OEHClient::Meta::Workspace < OEHClient::Data::Node
+	extend OEHClient::Meta::Entity
+
+	# set the ONE entity URI Stem for workspace requests
+	self.entity_uri_stem 			= "workspaces"
 
 	###
 	### -------------  Constants
 	###
 
-	ONE_PARAM_DATA 				= "data"
-	ONE_PARAM_NAME				= "name"
-	ONE_PARAM_SITE_KEY			= "siteKey"
-	ONE_PARAM_ID				= "id"
-	ONE_PARAM_CREATED_ON		= "createdDate"
-	ONE_PARAM_CREATED_BY 		= "createdBy"
-	ONE_PARAM_CONTROL_GROUP		= "controlGroup"
-	ONE_PARAM_ADMIN_ROLE 		= "adminRole"
+	ONE_WORKSPACE_SITE_KEY			= "siteKey"
+
 
 	###
 	### -------------  Attributes
 	###
-	attr_accessor 	:name,							# The name of the workspace
-					:id,							# The internal ID of the workspace
-					:created_on, 					# The date and time the workspace was created
-					:created_by,					# The user that created the workspace
-					:control_group,					# The percentage of the control groupd setting
-					:admin_role,					# boolean value that determins if the current user is identified
-													#   as an admin of the workspace
-					:space							# The related OEHClient::Config::Space object
-
-
+					
 	###
 	### -------------  Class Methods
 	###
 
-	def self.create()
-	end # def self.create
-
-	def self.fetch(site_key, host, *args)
-		# retrieved the passed options from the SPLAT
-		options = (args.length > 0 ? args[0] : Hash.new)
+	def self.find_by_key(active_session, site_key, **args)
 		# default the workspace instance NIL
 		workspace_instance = nil
-		# construnct the URL for getting the workspaces from the current thinstance
-		url = "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{host}#{OEHClient::Helper::Request::THUNDERHEAD_DOMAIN}/one/services/api/workspaces"
-		# construct a header using the space cookies or just with the default JSON header
-		header = (options.has_key?(:cookies) ? {:cookies => options[:cookies]}.merge!(OEHClient::Helper::Request.default_JSON_header()) : OEHClient::Helper::Request.default_JSON_header())
 		# get the list of workspaces from the thinstance
-		response = OEHClient.get(url, nil, :header => header)
-		# constinue only if we have a :body component of the resposne
-		if (response.has_key?(:body))
-			# for each fo the workspaces, grab the individual data
-			response[:body][ONE_PARAM_DATA].each do | workspace_data |
-				# look for workspace that maches the passed site key
-				unless (workspace_data[ONE_PARAM_SITE_KEY].casecmp(site_key) == 0)
-					# convert the the workspace instance into a NEW instance of the OEHClient::Meta::Workspace class
-					workspace_instance = OEHClient::Meta::Workspace.new
-					# map all the attributes of the workspace data to the new OEHClient::Meta::Workspace 
-					# object
-					workspace_instance.name 			= workspace_data[ONE_PARAM_NAME]
-					workspace_instance.id 				= workspace_data[ONE_PARAM_ID]
-					workspace_instance.created_on 		= Time.at(workspace_data[ONE_PARAM_CREATED_ON]/1000)
-					workspace_instance.created_by 		= workspace_data[ONE_PARAM_CREATED_BY][ONE_PARAM_NAME]
-					workspace_instance.control_group 	= workspace_data[ONE_PARAM_CONTROL_GROUP]
-					workspace_instance.admin_role 		= workspace_data[ONE_PARAM_ADMIN_ROLE]
-					# break out of the look since we found our workspace data
-					break
-				end # unless 
-			end # do each data element
-		end # if response has body
-		# return the workspace instance 
-		workspace_instance
-	end # def self.fetch
+		workspace_data = get(active_session, {:name => ONE_WORKSPACE_SITE_KEY, :value => site_key}, **args)
+		unless (workspace_data.blank?)
+			# convert the the workspace instance into a NEW instance of the OEHClient::Meta::Workspace instance
+			workspace_instance = OEHClient::Meta::Workspace.new(workspace_data)
+			# set the session object
+		#	workspace_instance.session = session
+			# return the workspace instance 
+			workspace_instance
+		end # unless workspace_data.blank?
+	end # def self.find_by_key
 
 
 	###
 	### -------------  Instance Methods
 	###
 
+	# retrieve the full collection of touchpoints from the curent workspace
 	def touchpoints()
-
+		touchpoint_collection 	= Array.new
+		OEHClient::Meta::Touchpoint.get_collection(self.class.session, space: id).each do | touchpoint_item |
+			touchpoint_collection << OEHClient::Meta::Touchpoint.create(self, touchpoint_item)
+		end
+		touchpoint_collection
+	end
+
+	# retrieve a single touchpoint from the current workspace based on the name
+	def touchpoint(touchpoint_name)
+		OEHClient::Meta::Touchpoint.create(self, OEHClient::Meta::Touchpoint.find_by_name(self.class.session, touchpoint_name, space: id))
 	end 
 
 
+
 end

data/lib/oehclient/meta/workspace_entity.rb

@@ -0,0 +1,13 @@
+module OEHClient::Meta::WorkspaceEntity
+	
+	def self.included base
+		base.send :include, InstanceMethods
+		base.send :extend, OEHClient::Meta::Entity
+	end
+
+	module InstanceMethods
+		
+		attr_accessor :workspace
+	end
+
+end

data/lib/oehclient/meta.rb

@@ -7,5 +7,8 @@ module OEHClient
 end
 
 require File.dirname(__FILE__) + '/meta/entity'
+require File.dirname(__FILE__) + '/meta/workspace_entity'
+require File.dirname(__FILE__) + '/meta/session'
 require File.dirname(__FILE__) + '/meta/workspace'
-#require File.dirname(__FILE__) + '/meta/touchpoint'
+require File.dirname(__FILE__) + '/meta/touchpoint'
+require File.dirname(__FILE__) + '/meta/interaction'

data/lib/oehclient/{interaction → realtime}/interaction.rb

@@ -1,6 +1,6 @@
 require 'base64'
 
-class OEHClient::Interaction::Interaction
+class OEHClient::Realtime::Interaction
 
 	#
 	# -------[ CONSTANTS ]
@@ -70,13 +70,13 @@ class OEHClient::Interaction::Interaction
 
 
 			# create a new interaction using all attributes pass
-			new_interaction = OEHClient::Interaction::Interaction.new(attributes)
+			new_interaction = OEHClient::Realtime::Interaction.new(attributes)
 			# Send the interaction for processing and return the instance of the interaction class
 			new_interaction.send(properties)
 
 		end
 
-		# class-level wrapper to create a new instance of the OEHClient::Interaction::Interaction class, call the
+		# class-level wrapper to create a new instance of the OEHClient::Realtime::Interaction class, call the
 		#  send_update method, and return the resulting instance of the same class
 		def update(site_key, uri, properties={}, tid=nil, customer_key=nil)
 
@@ -92,7 +92,7 @@ class OEHClient::Interaction::Interaction
 			attributes.merge!(:ck => customer_key)			if (!customer_key.nil? && !customer_key.empty?)
 
 			# create a new interaction using all parameters pass
-			new_interaction = OEHClient::Interaction::Interaction.new(attributes)
+			new_interaction = OEHClient::Realtime::Interaction.new(attributes)
 			# send the update and return the current object
 			new_interaction.send_update(properties)
 
@@ -136,7 +136,7 @@ class OEHClient::Interaction::Interaction
 	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
+	#   URI.  The method returns a new instance of the OEHClient::Realtime::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?)
@@ -148,7 +148,7 @@ class OEHClient::Interaction::Interaction
 		# create a new interaction using all parameters from the existing other than the new touchpoint
 		#  URI and timestamp of the current Interaction instance.  The method can be used to submit new
 		#  requests for the same customer, tid, & session
-		new_interaction = OEHClient::Interaction::Interaction.new({
+		new_interaction = OEHClient::Realtime::Interaction.new({
 														:uri => uri,
 														:ck => @customer_key,
 														:tid => @tid,
@@ -188,6 +188,8 @@ class OEHClient::Interaction::Interaction
 	# 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(properties={})
+		# Put timestamp in the header if it has been provides
+		properties[:header] = {'X-ONE-Timestamp' => @timestamp}.merge!(OEHClient::Helper::Request.default_JSON_header()) unless (@timestamp.nil?)
 		# POST the realtime interaction method
 		response = send_request(OEHClient::Helper::Request::POST_METHOD, realtime_url, properties)
 		# map the response message to the current instance attributes
@@ -207,12 +209,16 @@ class OEHClient::Interaction::Interaction
 		# 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?)
-		url_parameters.merge!({:timestamp => @timestamp})	unless (@timestamp.nil?)
+		#url_parameters.merge!({:timestamp => @timestamp})	unless (@timestamp.nil?)
+
+		send_args 			= {:params => url_parameters, :payload => ActiveSupport::JSON.encode(request_data(properties))}
+		send_args[:header] 	= properties[:header]  if (!properties.nil? && properties.has_key?(:header))
+
 		# send the POST or PUT methond along with the arguments to the OEHClient class
 		OEHClient.send(method.downcase.to_sym, 
 						url,
 						@space.oauth_consumer,
-						{:params => url_parameters, :payload => ActiveSupport::JSON.encode(request_data(properties))})
+						send_args)
 
 	end
 
@@ -226,32 +232,32 @@ class OEHClient::Interaction::Interaction
 		@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
+		# capture the optimizations returned from the request and map it to the OEHClient::Realtime::Optimization
 		#  class
 
 		# initialize the optimizations collection if it is null
 		@optimizations ||= Array.new
-		# map each of the optimizations to the OEHClient::Interaction::Optmization class
+		# map each of the optimizations to the OEHClient::Realtime::Optmization class
 		body[ONE_RESPONSE_OPTIMIZATIONS].each do | 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)
+				@optimizations << OEHClient::Realtime::Optimization.create(self, one_action)
 			end
 		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 
+		# capture the trackers returned from the request and mpt it to the OEHClient::Realtime::Tracker 
 		# class
-		# TODO:  Create OEHClient::Interaction::Tracker class
+		# TODO:  Create OEHClient::Realtime::Tracker class
 		@trackers 		= body[ONE_RESPONSE_TRACKERS]
 
-		# capture the capture points returned from the request and map it to the OEHClient::Interaction::Capture 
+		# capture the capture points returned from the request and map it to the OEHClient::Realtime::Capture 
 		# class
-		# TODO:  Create OEHClient::Interaction::Capture class
+		# TODO:  Create OEHClient::Realtime::Capture class
 		@captures 		= body[ONE_RESPONSE_CAPTURES]
 
 
@@ -266,7 +272,7 @@ class OEHClient::Interaction::Interaction
 	end
 
 	# missing_minimal_parameters returns an array of the minimal attributes that are missing  from the current
-	#  instance of OEHClient::Interaction::Interaction class
+	#  instance of OEHClient::Realtime::Interaction class
 	def missing_minimal_parameters
 
 		missing_parameters = []
@@ -306,17 +312,19 @@ class OEHClient::Interaction::Interaction
 
 		# merge in the different parts of the request data if the values currently exist within
 		#  the instance of the class
-		parameters.merge!({ONE_PARAM_URI => @uri}) 			if (!@uri.nil? && @uri.length > 0)
+		parameters.merge!({ONE_PARAM_URI => @uri}) 				if (!@uri.nil? && @uri.length > 0)
+
+		#parameters.merge!({"customerKeyName" => "customerkey", ONE_PARAM_CK => @customer_key}) 	if (!@customer_key.nil? && @customer_key.length > 0)
+		parameters.merge!({"customerKey" => @customer_key}) 	if (!@customer_key.nil? && @customer_key.length > 0)
 
-		parameters.merge!({ONE_PARAM_CK => @customer_key}) 	if (!@customer_key.nil? && @customer_key.length > 0)
 
-		parameters.merge!({ONE_PARAM_SESSION => @session}) 	if (!@session.nil? && @session.length > 0)
-		parameters.merge!({ONE_PARAM_TS => @timestamp}) 	if (!@timestamp.nil?)
+		parameters.merge!({ONE_PARAM_SESSION => @session}) 		if (!@session.nil? && @session.length > 0)
+		#parameters.merge!({ONE_PARAM_TS => @timestamp}) 	if (!@timestamp.nil?)
 
 		# for each of the properties hash entry, build a name/value pair in the properties collection
 		properties = Array.new
 		passed_properties.each do | key, value |
-			properties << {ONE_PROPERTIES_NAME => key.to_s, ONE_PROPERTIES_VALUE => value}
+			properties << {ONE_PROPERTIES_NAME => key.to_s, ONE_PROPERTIES_VALUE => value} unless (key == :header)
 		end
 		# merge the properties (name / value) connections if there are additonal values to pass
 		parameters.merge!({ONE_PARAM_PROPERTIES => properties})		if (properties.length > 0)

data/lib/oehclient/{interaction → realtime}/optimization.rb

@@ -1,7 +1,7 @@
 require 'base64'
 require 'cgi'
 
-class OEHClient::Interaction::Optimization
+class OEHClient::Realtime::Optimization
 
 	# HASH keys based on the response data
 	OPT_RESPONSE_NAME			= "name"
@@ -27,8 +27,8 @@ class OEHClient::Interaction::Optimization
 
 		one_asset = properties[OPT_RESPONSE_ASSET]
 
-		# create a new instance of the OEHClient::Interaction::Optimization class
-		optimization_instance = OEHClient::Interaction::Optimization.new()
+		# create a new instance of the OEHClient::Realtime::Optimization class
+		optimization_instance = OEHClient::Realtime::Optimization.new()
 
 		# assign all data attributes based on the properties object that is passed
 		optimization_instance.name 			= properties[OPT_RESPONSE_NAME] 						if (properties.has_key?(OPT_RESPONSE_NAME))
@@ -40,7 +40,7 @@ class OEHClient::Interaction::Optimization
 		# 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)
+			optimization_instance.responses << OEHClient::Realtime::Response.create(optimization_instance, asset_response)
 		end
 		# set the parent interaction object
 		optimization_instance.interaction = interaction

data/lib/oehclient/{interaction → realtime}/response.rb

@@ -1,5 +1,5 @@
 
-class OEHClient::Interaction::Response
+class OEHClient::Realtime::Response
 
 	# HASH keys based on the response data
 	OPT_RESPONSE_CODE			= "code"
@@ -28,8 +28,8 @@ class OEHClient::Interaction::Response
 
 	def self.create(optimization, properties={})
 
-		# create a new instance of the OEHClient::Interaction::Optimization class
-		response_instance = OEHClient::Interaction::Response.new()
+		# create a new instance of the OEHClient::Realtime::Optimization class
+		response_instance = OEHClient::Realtime::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))

data/lib/oehclient/realtime.rb

@@ -0,0 +1,10 @@
+module OEHClient
+
+	module Realtime
+	end
+
+end
+
+require File.dirname(__FILE__) + '/realtime/interaction'
+require File.dirname(__FILE__) + '/realtime/optimization'
+require File.dirname(__FILE__) + '/realtime/response'

data/lib/oehclient/version.rb

@@ -1,3 +1,3 @@
 module OEHClient
-  VERSION = "0.3.4"
+  VERSION = "1.1.0"
 end

data/lib/oehclient.rb

@@ -9,7 +9,7 @@ require File.dirname(__FILE__) + '/oehclient/helper'
 require File.dirname(__FILE__) + '/oehclient/exception'
 require File.dirname(__FILE__) + '/oehclient/config'
 
-require File.dirname(__FILE__) + '/oehclient/interaction'
+require File.dirname(__FILE__) + '/oehclient/realtime'
 require File.dirname(__FILE__) + '/oehclient/data'
 require File.dirname(__FILE__) + '/oehclient/meta'
 
@@ -53,7 +53,7 @@ module OEHClient
 			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))
-
+			#puts("URL: #{url} ; Header: #{header}")
 			# send the GET request, manage the returned response, and return the body of the response to the
 			#   calling method
 			RestClient.get(url, header) { | response, request, result | OEHClient::Helper::Response.handle(response)}

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: oeh-client
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Jason Balliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: oauth
   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'
 - !ruby/object:Gem::Dependency
   name: json
   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'
 - !ruby/object:Gem::Dependency
   name: uuidtools
   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'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !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,
@@ -144,9 +144,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -165,13 +165,17 @@ files:
 - lib/oehclient/data/structure.rb
 - lib/oehclient/exception.rb
 - lib/oehclient/helper.rb
-- 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/interaction.rb
+- lib/oehclient/meta/session.rb
+- lib/oehclient/meta/touchpoint.rb
 - lib/oehclient/meta/workspace.rb
+- lib/oehclient/meta/workspace_entity.rb
+- lib/oehclient/realtime.rb
+- lib/oehclient/realtime/interaction.rb
+- lib/oehclient/realtime/optimization.rb
+- lib/oehclient/realtime/response.rb
 - lib/oehclient/version.rb
 - oeh-client.gemspec
 homepage: https://rubygems.org/gems/oeh-client
@@ -184,17 +188,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Simple class-based client for integration to ONE Engagement Hub

data/lib/oehclient/interaction.rb

@@ -1,10 +0,0 @@
-module OEHClient
-
-	module Interaction
-	end
-
-end
-
-require File.dirname(__FILE__) + '/interaction/interaction'
-require File.dirname(__FILE__) + '/interaction/optimization'
-require File.dirname(__FILE__) + '/interaction/response'