oeh-client 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a29637284500a08ab1cb3431a8a963e557041758
-  data.tar.gz: 542ba1977b341ec2400719a1b5da7196268383ee
+  metadata.gz: 54084e658360c3951949a193c23952f5dabca96f
+  data.tar.gz: 2757288cd34409759ca970ba100e810f6e47dac6
 SHA512:
-  metadata.gz: 7455865c7636b7380d68bb7f0427e9f0e37d7af623a5b0f409eb184c42f12974050d8e31c3d51eb2be5184971977620313541850c0f9937be96aa86284738b65
-  data.tar.gz: 494f6251c84dfa8a9bb5004867929d14f7d0678ff8d27f5efff4eb5ac6a5030cc2afb251907a8ec8d93a6eadcd00ebd462aa8d5fdf70690e3cc716bda21e866d
+  metadata.gz: 4aa2a59d7dd7137e65dc0acd8db6b789aceffb7d9507ac19f1b25fb7ed0a0df0aabe3b5a10d2b130681b54bc3d082f5c1af0762e12696c3e088504f9138d2f9a
+  data.tar.gz: 07f540d2b1f742e0d90827723ff1e2422378a1b32dc60fd84a27c2272b21cd7c0cb35904354acc545fe1dd2a173ae346fbc11f73ef57a6684382ced87750ad80

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-.DS_Store
+.DS_Store
+.gem

data/lib/oehclient/config/space.rb

@@ -3,15 +3,27 @@ require 'rest-client'
 
 class OEHClient::Config::Space
 
+	###
+	### -------------  Constants
+	###
+
+
+	###
+	### -------------  Attributes
+	###
+
 	attr_accessor 	:site_key, 			# The ONE Site KEY Value
 					: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
 					:meta_password,		# The password needed to access meta-data from the OEH server
-					:cookies			# The cookies returned from an OEH API request			
+					:cookies			# The cookies returned from an OEH API request
+
+	###
+	### -------------  Class Methods
+	###
 
-	# ---- Class Methods 
 
 	# create builds a new instance of the Site class, populats the attributes using the properties HASH provided
 	#  and returns an instance of the class.  
@@ -34,7 +46,10 @@ class OEHClient::Config::Space
 	end
 
 
-	# ---- Instance Methods
+	###
+	### -------------  Instance Methods
+	###
+
 
 	# token is the method used to generate a new OAuth::AccessToken object based on the configuration of
 	#  the related space
@@ -79,30 +94,45 @@ class OEHClient::Config::Space
 	def meta_credentials()
 		{:username => @username, :password => @meta_password, :rememberMe => "false"}
 	end # def meta_credentials
-
+	# return the URL for the posting a login request
 	def login_url()
 		"#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}#{OEHClient::Helper::Request::THUNDERHEAD_DOMAIN}/one/idm_login"
 	end # def login_url
-
+	# return the URL for posting a logout request
 	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()
+		# post the login request
 		response = OEHClient.post(login_url, nil, :payload => meta_credentials)
-		@cookies = response[:cookies]  if (@cookies.blank? && response.has_key?(:cookies))
+		# 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!(: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
 
-		puts "Logout Header: #{header}"
-
-		response = OEHClient.post(logout_url, nil, :header => header)
-		@cookies = nil
+	# 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
 	end
 
 end

data/lib/oehclient/meta/entity.rb

@@ -0,0 +1,51 @@
+class OEHClient::Meta::Entity
+
+	###
+	### -------------  Constants
+	###
+
+	###
+	### -------------  Attributes
+	###
+	attr_accessor 	:space 					# The configured OEHClient::Config::Space object that represents the OEH workspace
+
+
+	###
+	### -------------  Class Methods
+	###
+
+	def self.create()
+	end # def self.create
+
+	def self.fetch(space, entity_type)
+
+		url = "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{space.host}#{OEHClient::Helper::Request::THUNDERHEAD_DOMAIN}/one/services/api/#{entity_type.downcase.pluralize}"
+
+		header = (!space.cookies.nil? ? {:cookies => space.cookies}.merge!(OEHClient::Helper::Request.default_JSON_header()) : OEHClient::Helper::Request.default_JSON_header())
+
+		response = OEHClient.get(url, nil, :header => header)
+
+		puts "FETCH #{entity_type} response: #{response[:body]}"
+
+	end
+
+	###
+	### -------------  Instance Methods
+	###
+
+	# add_attribute dynamically creates an attr_accessor for the passed key_value pair either 
+	#  as a simple value attribute or as an instance of another Node class
+	def add_attribute(name, value)
+		
+		# generate a ruby-friendly attribute accessor based on the name of the 
+		#  structure attribute
+		accessor_name = name.underscore
+		accessor_name.gsub!(/( )/, '_') if (accessor_name.match(/\s/))
+		# create the accessor in the current class and set the value based on the type
+		#  of object that represents the value
+		self.class.send(:attr_accessor, accessor_name)
+		instance_variable_set("@#{accessor_name}", (value.kind_of?(Hash) ? OEHClient::Data::Node.new(value) : value))
+
+	end
+
+end

data/lib/oehclient/meta/workspace.rb

@@ -0,0 +1,77 @@
+class OEHClient::Meta::Workspace
+
+	###
+	### -------------  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"
+
+	###
+	### -------------  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)
+		# 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
+
+	###
+	### -------------  Instance Methods
+	###
+
+
+end

data/lib/oehclient/meta.rb

@@ -0,0 +1,11 @@
+
+module OEHClient
+
+	module Meta
+	end
+
+end
+
+require File.dirname(__FILE__) + '/meta/entity'
+require File.dirname(__FILE__) + '/meta/workspace'
+#require File.dirname(__FILE__) + '/meta/touchpoint'

data/lib/oehclient/version.rb

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

data/lib/oehclient.rb

@@ -11,6 +11,8 @@ require File.dirname(__FILE__) + '/oehclient/config'
 
 require File.dirname(__FILE__) + '/oehclient/interaction'
 require File.dirname(__FILE__) + '/oehclient/data'
+require File.dirname(__FILE__) + '/oehclient/meta'
+
 
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oeh-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jason Balliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,6 +168,9 @@ files:
 - lib/oehclient/interaction.rb
 - lib/oehclient/interaction/interaction.rb
 - lib/oehclient/interaction/optimization.rb
+- lib/oehclient/meta.rb
+- lib/oehclient/meta/entity.rb
+- lib/oehclient/meta/workspace.rb
 - lib/oehclient/version.rb
 - oeh-client.gemspec
 homepage: https://rubygems.org/gems/oeh-client