oeh-client 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06e39f3001a36c1994e02be62d2eb89523dbd03f
-  data.tar.gz: 6e3b581b5928a4d110eb75bb3d7c5379ef61d836
+  metadata.gz: 7b7c11334e6329e4cb2e3742c5dfc026e85eb63b
+  data.tar.gz: ec01649af390e9f5663fea23afbc2113a04505bc
 SHA512:
-  metadata.gz: d2f35633fc7ea252dea8e75a9f82cc90bf8c1317dcf722c9befc299826379d0c243c28ffb36f2e48b6f4973d5433070f1188a36131dfdb76894d4934c0e65ecb
-  data.tar.gz: 6ed445491c403421b489bf2e95474641f5172ddbcd83638716cdc6a8e76b02fe100ed024a8fd1dba1a2b74b89cfd955a6ae1c4bc0e95918b7d9e180801fcf8f6
+  metadata.gz: aa9b2d77a89babbb98587024d1d15c8491ff6d548f6f580249d6e42f5310111f065d1a4715264be2db0229acff2debd3d975bcba239925d04b571d7d766f4830
+  data.tar.gz: 811069af84a9d4968852a607bbb136876876d55d7428895ff0e572364999e41ba4e5d705334bc96c593e3d679ca83b9c681f23f44816f65fff478063867d2196

data/README.md

@@ -32,13 +32,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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:
 
-## Development
+```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)
+
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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::Interaction::Interaction.post("YOUR_TARGET_SITE_KEY", "TOUCHPOINT_INTERACTION_URI")
+```
+The post method will return an instance of the OE
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/oehclient/helper.rb

@@ -60,13 +60,13 @@ module OEHClient
 
 			def self.handle(rest_response)
 
-				valid_response_codes = [100, 200, 302]
+				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}", rest_response.code) unless (valid_response_codes.include?(rest_response.code))
 
 				api_response = Hash.new
 
-				api_response[:body] 	= (OEHClient::Helper::Response.valid_json?(rest_response.body) ? ActiveSupport::JSON.decode(rest_response.body) : rest_response.body)
+				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

data/lib/oehclient/meta/entity.rb

@@ -17,6 +17,19 @@ class OEHClient::Meta::Entity
 	def self.create()
 	end # def self.create
 
+	def self.find(*args)
+
+		options = args.extract_options!
+
+		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
+
+	end
+
 	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}"
@@ -31,19 +44,27 @@ class OEHClient::Meta::Entity
 	### -------------  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))
+	###
+	### -------------  Protected Class Methods
+	###
+
+	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/workspace.rb

@@ -69,9 +69,14 @@ class OEHClient::Meta::Workspace
 		workspace_instance
 	end # def self.fetch
 
+
 	###
 	### -------------  Instance Methods
 	###
 
+	def touchpoints()
+
+	end 
+
 
 end

data/lib/oehclient/version.rb

@@ -1,3 +1,3 @@
 module OEHClient
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

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