oeh-client 2.2.1 → 2.2.2

data/lib/oehclient/helper.rb

@@ -1,97 +0,0 @@
-require 'erb'
-
-module OEHClient
-
-	module Helper
-
-		module Request
-
-			ONE_PROTOCOL 			= "https://"
-			THUNDERHEAD_DOMAIN 		= ".thunderhead.com"
-			ONE_URI_PART 			= "/one/oauth1"
-
-			API_URI_PART 			= "/rt/api"
-			API_VERSION 			= "/2.0"
-
-			POST_METHOD				= "post"
-			PUT_METHOD				= "put"
-
-			# request_url builds the target request URL with the passed parameters, URL encoding the parameters
-			#  as necessary to create a valid request
-			def self.format_url(url, params)
-
-				# for each of the parameters, build a single query parameter string
-				parameter_part = ""
-				params.each do |key, value|
-					# if there is more than one argument, add the apppropriate separator (&) between 
-					#  query parameters
-					parameter_part << "&" if (parameter_part.length > 0)
-					# URL Encode the value of the property
-					parameter_part << "#{key.to_s}=#{ERB::Util.url_encode(value)}"
-
-				end
-				# return the fully-qualified URL with parameters (if passsed)
-				(parameter_part.length > 0 ? "#{url}?#{parameter_part}" : "#{url}")
-
-			end
-
-			# 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' , 'dataMimeType' => 'application/json','Content-Type' =>'application/json', 'X-Requested-With' => 'XMLHttpRequest' }
-			end
-
-
-		end  # module Request
-
-		module 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, 204, 302]
-				# raise a generic HTTPRequestException if the the status code is not 100 (Continue) or 200 (OK)
-				raise OEHClient::Exception::HTTPRequestException.new("HTTP Request Exception with code #{rest_response.code} -- details: #{rest_response.body}", rest_response.code) unless (valid_response_codes.include?(rest_response.code))
-
-				api_response = Hash.new
-
-				api_response[:body] 	= (rest_response.code == 204 ? {} : (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
-
-		end # module Response
-
-
-		module Timestamp
-
-			# convert the time value from a Time, DateTime, String, or Integer to a proper ONE timestamp value
-			# format (UTC Milliseconds)
-			def self.to_one_timestamp(timevalue)
-
-				one_timestamp = timevalue												if (timevalue.is_a?(Integer))
-				one_timestamp = timevalue.utc.strftime("%s%L").to_i 					if (timevalue.is_a?(Time) || timevalue.is_a?(DateTime))
-				one_timestamp = Time.parse(timevalue).utc.strftime("%s%L").to_i 		if (timevalue.is_a?(String))
-
-				one_timestamp
-
-			end
-
-		end
-
-	end
-
-end

data/lib/oehclient/meta/entity.rb

@@ -1,97 +0,0 @@
-module OEHClient::Meta::Entity
-
-	###
-	### -------------  Constants
-	###
-
-	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 Attributes 
-	###
-
-	def entity_uri_stem=(uri_stem)
-		@entity_stem = uri_stem
-	end
-
-	def entity_uri_stem
-		@entity_stem
-	end
-
-	def session=(session_instance)
-		@session = session_instance
-	end
-
-	def session
-		@session
-	end
-
-	###
-	### -------------  Helper Class Methods
-	###
-
-	def create()
-	end # def self.create
-
-	def find_by_name(active_session, name,  **args)
-		get(active_session, {:name => ONE_PARAM_NAME, :value => name}, args)
-	end
-
-	###
-	### -------------  Core Class Methods
-	###
-
-	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}/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
-	###
-
-	###
-	### -------------  Protected Class Methods
-	###
-
-	protected 
-
-end

data/lib/oehclient/meta/interaction.rb

@@ -1,14 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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,58 +0,0 @@
-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_WORKSPACE_SITE_KEY			= "siteKey"
-
-
-	###
-	### -------------  Attributes
-	###
-					
-	###
-	### -------------  Class Methods
-	###
-
-	def self.find_by_key(active_session, site_key, **args)
-		# default the workspace instance NIL
-		workspace_instance = nil
-		# get the list of workspaces from the thinstance
-		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

@@ -1,13 +0,0 @@
-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

@@ -1,14 +0,0 @@
-
-module OEHClient
-
-	module Meta
-	end
-
-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/interaction'