dopaminekit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f504dd5873c880945b85bf2fc19430f2977b95d7
-  data.tar.gz: e5f0da456485a9279a3d39f3289682e2f58cf799
+  metadata.gz: e964622f0840d37642bde997f71d22196cf86be6
+  data.tar.gz: 974a1e996f8e9894bff8a3fecef2b742bcb5c1d7
 SHA512:
-  metadata.gz: f9ef363f29ccef0f6beee399eb3fddb5342b2a3b97fc509852d6c2deee8d9e4c4e16bc02226203cf26b93d224ecc83524bb5523d910fd38f760654b17693813c
-  data.tar.gz: d31d960b9287c6229da881e2534623a5388d4d5fddea829c595592784a64014001a712ca00cf39b26eb8ed9b76cd3204e0493f033c5d7eff610c2716e4360ba9
+  metadata.gz: acb3d13fabcdae3553833533ae8776845142d2b715f6cf7ce2a9790bad466751d49ca05c1ee4c67e58920892336e5b9d29e913f120d1e42d39a766c2fe9b3c2e
+  data.tar.gz: b6e70384f77a0b4de032549709bcb114240745e9108f6a4c9cddc0de0a0ab70a6c9635ae0996cabc8357e44b81c33a0a279aa3d625ab509908c447fdc62f4b68

data/README.md

@@ -1,4 +1,4 @@
-# Dopaminekit
+# DopamineKit
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dopaminekit`. To experiment with that code, run `bin/console` for an interactive prompt.
 

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"

data/dopaminekit.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["kash650@gmail.com"]
 
   spec.summary       = %q{"A class to use DopamineLabs machine learning API"}
-  spec.description   = %q{This gem provides a class for interacting with the DopamineAPI from ruby. After you have received your API key and configured the actions and reinforcements relevant to your app on the Dopamine Developer Dashboard, you may use this gem to place 'tracking', and 'reinforcement' calls from inside your app that will communicate directly with the DopamineAPI.}
+  spec.description   = %q{This gem provides a class for interacting with the DopamineAPI from ruby. After you have received your API key and configured the actions and reinforcements relevant to your app on the [Dopamine Developer Dashboard](dashboard.usedopamine.com), you may use this gem to place 'tracking', and 'reinforcement' calls from inside your app that will communicate directly with the DopamineAPI.}
   spec.homepage      = "https://github.com/DopamineLabs/DopamineKit-Ruby"
   spec.license       = "MIT"
 
@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
 
   spec.add_development_dependency "rspec", "~> 3.4.0"
-  spec.add_dependency "json", "~> 1.7.7"
+  spec.add_dependency "json", "~> 1.8.2"
 end

data/lib/dopaminekit.rb

@@ -2,8 +2,15 @@ require 'dopaminekit/version'
 require 'net/https'
 require 'json'
 
+# The main driver for the DopamineAPI
 class DopamineKit
+
+	##
+	# Get your credentials from dashboard.usedopamine.com and enter them during initilization
+	# 
 	def initialize(appID, productionSecret, developmentSecret, inProduction, versionID)
+		@clientSDKVersion = '3.0.0'
+		@persistentMetaData = Hash.new
 		@debugMode = true
 
 		@credentials = {
@@ -11,39 +18,18 @@ class DopamineKit
 			:secret => inProduction ? productionSecret : developmentSecret,
 			:versionID => versionID
 		}
-
-		@persistentMetadata = Hash.new
-	end
-
-	def addPersistentMetadata(key, value)
-		@persistentMetadata[key.to_sym] = value
-	end
-
-	def setPersistentMetadata(hash)
-		if hash.is_a? Hash
-			@persistentMetadata = hash.clone
-		end
-	end
-
-	def clearPersistentMetadata()
-		@persistentMetadata.clear
-	end
-
-	def getPersistentMetadata()
-		return @persistentMetadata.clone
-	end
-
-	def getBasePostData()
-		postData = {
-			:clientOS => "Ruby",
-			:clientOSVersion => "#{RUBY_VERSION}",
-			:clientSDKVersion => "2.9.9",
-			:UTC => Time.now.utc.to_i,
-			:localTime => Time.now.utc.to_i,
-		}
-		return postData.merge(@credentials)
 	end
 
+	##
+	# Used to send tracking calls to the DopamineAPI.
+	# actionID - a descriptive name for an action or behavior to be tracked
+	# identity - a string used an identifier for anonymized experiments
+	# metaData - a hash of metadata to get better experiment results. 
+	# 			 Can be set to 'nil' 
+	#
+	# Returns a JSON object containing a key 'status', and
+	# if 'status' != 200 the object contains another key 'errors'
+	# 
 	def track(actionID, identity, metaData)
 		if !actionID.is_a? String
 			puts "[DopamineKit] - Invalid actionID #{actionID}"
@@ -57,8 +43,10 @@ class DopamineKit
 		postData = getBasePostData()
 		postData[:actionID] = actionID
 		postData[:primaryIdentity] = identity
-		if(metaData != nil)
-			postData[:metaData] = metaData.merge(@persistentMetadata){|key, meta, persistentmeta| meta}
+		if(metaData.is_a? Hash and metaData != nil)
+			postData[:metaData] = metaData.merge(@persistentMetaData){|key, meta, persistentmeta| meta}
+		else
+			postData[:metaData] = @persistentMetaData
 		end
 
 		response = JSON.parse( send(:tracking, postData) )
@@ -66,6 +54,16 @@ class DopamineKit
 		return response
 	end
 
+	##
+	# Used to send reinforcement calls to the DopamineAPI.
+	# actionID - registered string from the Dopamine Developer Dashboard
+	# identity - a string used an identifier for anonymized experiments
+	# metaData - a hash of metadata to get better experiment results. 
+	# 			 Can be set to 'nil' 
+	# 
+	# Returns a string that is the reinforcement decision, 
+	# picked from a set declared on the Dopamine Developer Dashboard
+	# 
 	def reinforce(actionID, identity, metaData)
 		if !actionID.is_a? String
 			puts "[DopamineKit] - Invalid actionID #{actionID}"
@@ -80,8 +78,10 @@ class DopamineKit
 		postData = getBasePostData()
 		postData[:actionID] = actionID
 		postData[:primaryIdentity] = identity
-		if(metaData != nil)
-			postData[:metaData] = metaData.merge(@persistentMetadata){|key, meta, persistentmeta| meta}
+		if(metaData.is_a? Hash and metaData != nil)
+			postData[:metaData] = metaData.merge(@persistentMetaData){|key, meta, persistentmeta| meta}
+		else
+			postData[:metaData] = @persistentMetaData
 		end
 
 		response = JSON.parse( send(:reinforcement, postData) )
@@ -93,6 +93,65 @@ class DopamineKit
 		end
 	end
 
+
+	##
+	# Add some metaData that you want to include multiple reinforce/tracking calls.
+	# Use setPersistentMetaData() to replace the entire persistentMetaData hashtable,
+	# and use clearPersistentMetaData() to clear it.
+	# 
+	def addPersistentMetaData(key, value)
+		@persistentMetaData[key.to_sym] = value
+	end
+
+	##
+	# Replace all contents within the persistentMetaData hash,
+	# and replace them with the hash passed in
+	# 
+	def setPersistentMetaData(hash)
+		if hash.is_a? Hash
+			@persistentMetaData = hash.clone
+		end
+	end
+
+	##
+	# Clear all entries into the persistentMetaData hash.
+	# 
+	def clearPersistentMetaData()
+		@persistentMetaData.clear
+	end
+
+	##
+	# Retreive a copy of the persistentMetaData hash.
+	# 
+	def getPersistentMetaData()
+		return @persistentMetaData.clone
+	end
+
+
+############################################
+##
+## Internal functions
+##
+############################################
+
+
+	##
+	# Privately used function to get POST data with basic information and time
+	# 
+	def getBasePostData()
+		postData = {
+			:clientOS => "Ruby",
+			:clientOSVersion => "#{RUBY_VERSION}",
+			:clientSDKVersion => @clientSDKVersion,
+			:UTC => Time.now.utc.to_i,
+			:localTime => Time.now.utc.to_i,
+		}
+		return postData.merge(@credentials)
+	end
+
+	##
+	# Privately used function to send an HTTP POST
+	# 
 	def send(type, data)
 		url = "https://api.usedopamine.com/v3/app/"
 		case type

data/lib/dopaminekit/version.rb

@@ -1,3 +1,3 @@
-module Dopaminekit
-  VERSION = "0.1.0"
+class Dopaminekit
+  VERSION = "0.2.0"
 end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dopaminekit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Akash Desai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,19 +72,19 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.8.2
 description: This gem provides a class for interacting with the DopamineAPI from ruby.
   After you have received your API key and configured the actions and reinforcements
-  relevant to your app on the Dopamine Developer Dashboard, you may use this gem to
-  place 'tracking', and 'reinforcement' calls from inside your app that will communicate
-  directly with the DopamineAPI.
+  relevant to your app on the [Dopamine Developer Dashboard](dashboard.usedopamine.com),
+  you may use this gem to place 'tracking', and 'reinforcement' calls from inside
+  your app that will communicate directly with the DopamineAPI.
 email:
 - kash650@gmail.com
 executables: []
@@ -103,6 +103,7 @@ files:
 - dopaminekit.gemspec
 - lib/dopaminekit.rb
 - lib/dopaminekit/version.rb
+- tasks/rspec.rake
 homepage: https://github.com/DopamineLabs/DopamineKit-Ruby
 licenses:
 - MIT