oeh-client 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 601054d123a5f21d1cf9e288c0ba8ae8a5b0ce99
-  data.tar.gz: 7c61dab0e2546e5ac7187ec1531b0974ad83f0d1
+  metadata.gz: 4bec0ddd14a97b575b75493774289c2bba409a2d
+  data.tar.gz: 32090d1adabc23a2dffe22e92cc1f57feeaa3bcb
 SHA512:
-  metadata.gz: 4c83a259b412d5ba2c9abe5362e8180dad86683acff345604ac8b9e5c88c884cc6563ac1bcabd9e42114c9a8e3c3b1b0eb5399828b9fdb5eaa5cb171ccf3770d
-  data.tar.gz: ed2ad2b3ea4407b45a1b4e43e6b8a33ad3fcaa68ab86bbe609a9e604a5e89d587179cbe1df7cc6a5639111573341db1d9caf963faf41ed84f59cda1baabe3c07
+  metadata.gz: a477d4f83d54c24268550567fb1582060c065e30efd2e5b976e98d743c7db79522d721c4505446ff7226d2e512eff031ccf2e02c22dbd32de81ae35ea77abedd
+  data.tar.gz: 997695f476c2f872011288d98803d05a0fa93a3c45c562a49721fea33701fcb99d93602e93df32f56fc27e2e164eebdc219c5e904c2e2ff7f04da9bbb686ac30

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oeh-client
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Jason Balliet
@@ -174,40 +174,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
 - bin/console
 - bin/setup
 - lib/oeh-client.rb
 - lib/oeh_client.rb
 - lib/oehclient.rb
-- lib/oehclient/config.rb
-- lib/oehclient/config/space.rb
-- lib/oehclient/config/space_manager.rb
-- lib/oehclient/data.rb
-- lib/oehclient/data/node.rb
-- lib/oehclient/data/structure.rb
-- lib/oehclient/exception.rb
-- lib/oehclient/helper.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
 licenses:
 - MIT

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.DS_Store
-.gem

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in oeh-client.gemspec
-gemspec

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Jason Balliet
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/README.md

@@ -1,73 +0,0 @@
-# OEHClient
-
-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.
-
-## 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
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'oeh-client'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install oeh-client
-
-## Usage
-
-Each OEH instance can contain one ore more 'spaces', which contain separate application configurations.  Each space is provided a unique key that identifies it within the existing SaaS environment.  To access the space, you first need to register the space details with the space manager singleton as follows:
-
-```ruby
-
-space_parameters = {
-						:site_key 		=> "YOUR_SITE_KEY",
-						:host 			=> "YOUR_THINSTANCE_SERVER_NAME"
-						:api_key 		=> "YOUR_API_KEY",
-						:shared_secret 	=> "YOUR_SHARED_SECRET_KEY",
-						:username 		=> "CONFIGURED_USERNAME",
-						:meta_password 	=> "LOGIN_PASSWORD_FOR_USERNAME"
-
-					}
-
-OEHClient::Config::SpaceManager.instance.register_space(space_parameters)
-
-```
-
-As needed, you can register multiple spaces for the same instances to support integration with a number of spaces within your application.
-
-### Interactions
-
-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::Realtime::Interaction.post("YOUR_TARGET_SITE_KEY", "TOUCHPOINT_INTERACTION_URI")
-```
-The post method will return an instance of the OE
-
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/oeh-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test

data/lib/oehclient/config/space.rb

@@ -1,114 +0,0 @@
-require 'erb'
-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
-					:workspace 			# The ONE workspace related to the current space
-
-	###
-	### -------------  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.  
-	def self.create(properties={})
-
-		# create a new instance of the OHEClient::Space class
-		space_instance = OEHClient::Config::Space.new()
-
-		# assign all attributes from the passed properties hash
-		space_instance.site_key 		= properties[:site_key]			if (properties.has_key?(:site_key))
-		space_instance.host 			= properties[:host]				if (properties.has_key?(:host))
-		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
-
-	end
-
-
-	###
-	### -------------  Instance Methods
-	###
-
-
-	# token is the method used to generate a new OAuth::AccessToken object based on the configuration of
-	#  the related space
-	def token()
-
-		# raise the OEHClient::InvalidSpaceException the current instance is not valid
-		raise OEHClient::Exception::InvalidSpaceConfigException unless is_valid?
-		
-		# Create the consumer and access token 
-		oauth_consumer = OAuth::Consumer.new("#{@api_key}!#{@username}", 
-											@shared_secret,
-											{:site => "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}",
-												:scheme => :header})
-		# return the access token
-		return(OAuth::AccessToken.new(oauth_consumer))
-
-	end
-	# return a new instance of the OAuth::Consumer using the details of the space
-	def oauth_consumer()
-		OAuth::Consumer.new("#{@api_key}!#{@username}", 
-											@shared_secret,
-											{:site => "#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}",
-												:scheme => :header})
-	end
-
-	# is_valid determines if the current class has values for all the attributes.  Each attribute is
-	# required with a non-nul / non-blank value to be considered valid
-	def is_valid?()
-		((!@site_key.nil? && !@site_key.empty?) && (!@host.nil? && !@host.empty?) && 
-		(!@api_key.nil? && !@api_key.empty?) && (!@shared_secret.nil? && !@shared_secret.empty?) && 
-		(!@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
-
-	# return the hash that 
-	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}/one/idm_login"
-	end # def login_url
-	# return the URL for posting a logout request
-	def logout_url()
-		"#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@host}/one/logout"
-	end
-
-	# retrieve the workspace meta-data object from the thinstance in realtime
-	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/config/space_manager.rb

@@ -1,55 +0,0 @@
-require 'singleton'
-
-class OEHClient::Config::SpaceManager
-	include Singleton
-
-
-	attr_accessor :spaces
-
-	# Constructor.  Initialize the spaces collection as a new hash
-	def initialize
-		@spaces 	= Hash.new
-	end
-
-	# register_space is a wrapper method that converts the passed Hash object to an instance of the 
-	#  OEHClient::Config::Space object, which is passed to the register method
-	def register_space(space_config={})
-
-		# Pass a new instance of the space object to the register_space method
-		register(OEHClient::Config::Space.create(space_config))
-
-	end
-
-	# get_space returns the instance of the OEHClient::Config::Space
-	def get(site_key)
-
-		# raise the OEHClient::Exception::InvalidSpaceException if the space has not been registered
-		raise OEHClient::Exception::InvalidSpaceException unless (@spaces.has_key?(site_key))
-
-		# return the space configuration instance
-		@spaces[site_key]
-
-	end
-
-	private
-
-	# register adds the instance of the OEHClient::Config::Space object to the spaces hash, using the 
-	#  site_key value as the hash KEY
-	def register(space_instance)
-
-		# Raise OEHClient::Exception::InvalidSpaceException if the space instance is NOT valie
-		raise OEHClient::Exception::InvalidSpaceConfigException unless (space_instance.is_valid?)
-		# Raise the OEHClient::Exception::InvalidSpaceObjectException if the space_instance object is not
-		#  the proper type of object (OEHClient::Config::Space)
-		raise OEHClient::Exception::InvalidSpaceObjectException unless (space_instance.kind_of?(OEHClient::Config::Space))
-
-		# Assign the space instance to the spaces collection
-		@spaces[space_instance.site_key] = space_instance 
-
-	end
-
-
-
-
-
-end

data/lib/oehclient/config.rb

@@ -1,11 +0,0 @@
-
-module OEHClient
-
-	module Config
-	end
-
-end
-
-require File.dirname(__FILE__) + '/config/space'
-require File.dirname(__FILE__) + '/config/space_manager'
-

data/lib/oehclient/data/node.rb

@@ -1,66 +0,0 @@
-
-class OEHClient::Data::Node
-
-	attr_accessor :nodes
-
-	def initialize(data)
-
-		# Raise an exception if the data passed is not already a hash
-
-		# based on the type of object that is passed, create the proper attribute accessor
-		#  to allow easy access to data.  For example, a simple value in the structure called
-		#  firstName will be represented in the object as my_structure.first_name.  Simple
-		#  object are represented as related node classes.  For example a Preference node with
-		#  an attribute of nonSmokingRoom will be represented as my_structure.preference.non_smoking_room
-		data.each do | key, value |
-			(value.kind_of?(Array) ? add_collection(key, value) : add_attribute(key, value))
-		end
-
-	end
-
-	# return the names of each of the attributes of the current nodes of the structure
-	def attribute_names()
-		name_collection = Array.new
-		instance_variable_names.each do | structure_attribute | 
-			structure_attribute.slice!(0)
-			name_collection << structure_attribute
-		end
-		name_collection
-	end # def attribute_names
-
-
-	private 
-
-	# add_collection dynamically create an attr_accessor as an array of Oeh::Structure::Node
-	#  classes related to the current instance of the object. 
-	def add_collection(name, value_collection)
-
-		# initialize the array object that will act as the value of the attribute
-		node_collection = []
-
-		# for each hash in the array, add a new structure node 
-		value_collection.each do | structure_node | 
-			node_collection << OEHClient::Data::Structure.new(structure_node)
-		end
-		# add the arry of node objects to the accessor
-		add_attribute(name, node_collection)
-
-	end
-
-	# 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/data/structure.rb

@@ -1,82 +0,0 @@
-class OEHClient::Data::Structure < OEHClient::Data::Node
-
-	API_PROFILES = "/profiles"
-
-	LABEL_CUSTOMER_KEY 	= "Customer Key"
-	LABEL_SITE_KEY 		= "Site Key"
-	LABEL_API_NAME 		= "API Name"
-
-	#
-	# Class Methods
-	#
-
-	# fetch makes the request to OEH for the structure and returns an instance of the structure
-	#  based on the data in the configured structure
-	def self.fetch(parameters={})
-
-		# force the parameters empty hash if needed
-		parameters ||= Hash.new
-
-		# validate the parameters.  The implementation expects a Hash object
-		if (!parameters.empty?)
-			# implementation expects a Hash that contains the Customer Key (:ck), 
-			#  Site Key (:sk), and API Name (:api) because they are required to get 
-			#  structure from OEH
-			if ((parameters.has_key?(:ck) || parameters.has_key?(:tid)) && parameters.has_key?(:sk) && parameters.has_key?(:api))
-
-				oeh_params 		= {:sk => parameters[:sk]}
-
-				# set the values based on passed parameters
-				oeh_params.merge!({:ck => parameters[:ck]})				if (parameters.has_key?(:ck))
-				oeh_params.merge!({:keyname => parameters[:keyname]})	if (parameters.has_key?(:keyname))
-				oeh_params.merge!({:tid => parameters[:tid]})			if (parameters.has_key?(:tid))
-
-				# grab the API Name
-				api_name 		= parameters[:api]
-
-				# set the space based on the site key value that was passed
-				@space 			= OEHClient::Config::SpaceManager.instance.get(parameters[:sk])		if (parameters.has_key?(:sk))
-
-				# Use the OEHClient object to call OEH profiles API and create an instance
-				#  of this class (OEHClient::Data::Structure) as the return value
-				response = OEHClient.get(self.request_url(api_name),
-											@space.oauth_consumer, 
-											:params => oeh_params)
-				# dynamically map the response object to a new OEHClient::Data::Structure class
-				OEHClient::Data::Structure.new(response[:body])
-
-			else
-
-				# If the calling application passed a parameter Hash, but is missing key attributes,
-				#  raise the Oeh::Exception::MissingParameterException with the name of each 
-				#  parameter 
-				missing_parameters = []
-
-				missing_parameters << LABEL_CUSTOMER_KEY 	unless (parameters.has_key?(:ck))
-				missing_parameters << LABEL_SITE_KEY 		unless (parameters.has_key?(:sk))
-				missing_parameters << LABEL_API_NAME		unless (parameters.has_key?(:api))
-
-				# raise the OEHClient::Exception::MIssingParameterException using the list of missing parameter
-				# labels that have been added to the collection
-				raise OEHClient::Exception::MissingParameterException.new(missing_parameters)
-
-			end
-
-		else
-
-			# if the parameters object is NIL then raise the OEHClient::Exception::MissingParameterException,
-			#  passing the full set of expected parameter names
-			raise OEHClient::Exception::MissingParameterException.new([LABEL_CUSTOMER_KEY, LABEL_SITE_KEY, LABEL_API_NAME])
-					
-		end
-
-
-	end
-
-	# request_url returns the fully-qualified URL to return a given structure
-	def self.request_url(api_name)
-		"#{OEHClient::Helper::Request::ONE_PROTOCOL}#{@space.host}#{OEHClient::Helper::Request::ONE_URI_PART}#{OEHClient::Helper::Request::API_URI_PART}#{OEHClient::Helper::Request::API_VERSION}#{API_PROFILES}/#{api_name}"
-	end
-
-
-end

data/lib/oehclient/data.rb

@@ -1,10 +0,0 @@
-
-module OEHClient
-
-	module Data
-	end
-
-end
-
-require File.dirname(__FILE__) + '/data/node'
-require File.dirname(__FILE__) + '/data/structure'

data/lib/oehclient/exception.rb

@@ -1,64 +0,0 @@
-module OEHClient
-
-	module Exception
-
-		# Used when an invalid OAuth consumer is detected as part of the client-side API calls
-		class InvalidConsumerException < ::Exception
-
-		end
-
-		# InvalidSpaceConfigException is used when a OEHClient::Space instance is missing one or more
-		#  of the key data attributes
-		class InvalidSpaceConfigException < ::Exception
-
-		end
-
-		# InvalidSpaceException is used when a space is not configured
-		class InvalidSpaceException < ::Exception
-
-		end
-
-		# InvalideSpaceObjectException is used when a method expects a OEHClient::Config::Space object and
-		#  the object passed is not of the same type
-		class InvalidSpaceObjectException < ::Exception
-
-		end
-
-		# HTTPRequestException is used to manage any REST error code that is returned by the OEH
-		#  server
-		class HTTPRequestException < ::Exception
-
-			attr_accessor :http_code
-
-			# override the constructor to add the code value to exception class
-			def initialize(msg, code)
-				super(msg)
-				@http_code = code
-			end
-			
-		end
-
-		# Missing ParameterException is used to identify the list of parameters that are required, but missing
-		#  by a key method 
-		class MissingParameterException < ::Exception
-
-			def initialize(parameter_list)
-
-				super("Missing the required parameters #{parameter_list.join(', ')}")
-			end
-			
-		end
-
-		class IncorrectParameterTypeException < ::Exception
-
-
-			def initialize(expected_kind, passed_kind)
-
-				super("Incorrect Parameter Type.  Expected #{expected_kind} but received #{passed_kind}")
-			end
-			
-		end
-
-	end
-
-end