dopaminekit 4.0.0.beta2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfa9bb69b04240c0e7d7df6ca455cfedd084e868
-  data.tar.gz: 986835950fdb8a08480ae23bb5115c30bfa44398
+  metadata.gz: 61687937283304b91056745b3f2d421383581f84
+  data.tar.gz: 71223e1a02792beed15c2f8a243fe753b9dd713a
 SHA512:
-  metadata.gz: 8308afdcdc4e20db698d2cb86000d889de9c85a1fa6a17b8391540126bb97fa9dc39aa585412050d6bc9befbd0639f908c7cc2fcc2293a06fc0e1a50784c8b75
-  data.tar.gz: 3dc54a13ebdef0ae3cff7526fb08f8424eadb4770a4ecedc29db5ebdf068c3d1871ec614ce5a461fa4e5fe4f6b0e4709962461584d5089de90155def3f89db25
+  metadata.gz: 434e16e3415129ae773a09e4d69aaca024d2d35c9e2bf914f594b99d94e078080b4837c1d805f2a51c41b7e4ec1f4bc36464ea884b3c1e39b19eb27a720f73e1
+  data.tar.gz: 65d01ec40a63bfcf1ae5f9af270ccc22990860106fe4c9785c47756c3634655634009c529b77dd6f8a52fad569f322b425a42520a85600a7fad0de192cb6772a

data/README.md

@@ -18,13 +18,13 @@ Learn more at [http://usedopamine.com](http://usedopamine.com).
  1. Add this line to your application's Gemfile:
 
     ```ruby
-    gem 'dopaminekit'
+    gem 'dopaminekit', '~> 4.0.0'
     ```
 
  2. And then in terminal execute:
 
     ```
-    $ bundle
+    $ bundle install
     ```
 
 Or 
@@ -50,157 +50,27 @@ Or
   3. Create a DopamineKit object with your credentials passed in as Strings
 
 	```
-	## Credentials for your Dopamine account
-	appID = "generated from dashboard.usedopamine.com"
-	developmentSecret = "generated from dashboard.usedopamine.com"
-	productionSecret = "generated from dashboard.usedopamine.com"
-	versionID = "testing"
-	inProduction = false
-	debugMode = true
+   	## Credentials for your Dopamine account
+	@appID = "generated from dashboard.usedopamine.com"
+	@developmentSecret = "generated from dashboard.usedopamine.com"
+	@productionSecret = "generated from dashboard.usedopamine.com"
+	@versionID = "testing"
+	@inProduction = false
+	@debugMode = true
 		
-	## Create a DopamineKit object
-	dopaminekit = DopamineKit.new(appID, developmentSecret, productionSecret, versionID, inProduction, debugMode)
-		
-	...
-	## Reinforcement Call
-	responseFunction = dopaminekit.reinforce("action1", "ken@hotmail.com")
-		
-	...
-	## Tracking Call
-	dopaminekit.track("trackedAction", "ken@hotmail.com")
+	@dopaminekit = DopamineKit.new(appID, developmentSecret, productionSecret, versionID, inProduction, debugMode)
+	
+   ## Track
+   response = dopaminekit.track( jsonAsHash )
+	
+   ## Report
+   response = dopaminekit.report( jsonAsHash )
+	
+   ## Refresh
+   response = dopaminekit.refresh( jsonAsHash )
+   
 	```
-    
-  4. Start using Dopamine! The main features of DopamineAPI are the `reinforce()` and `track()` functions. These should be added into the response functions of any _action_ to be reinforced or tracked. 
-     
-     There is also the `addPersistentMetaData(key, value)` to add metadata that is persistent throughout calls, and is cleared with the `clearPersistentMetaData()`.
-  
-
-### Actions that represent Habits
-
-Reinforce your apps ​_essential_​ actions; what users come to your app to do. Three actions is definitely enough, and one is often best. 
-
-## Super Users
-
-There are additional parameters for the `track()` and `reinforce()` functions that are used to gather rich information from your app and better create a user story of better engagement.
-
-========
-
-####Object Initialization
-
-The object initialization takes in the API credentials (appID, development and production secrets, and the versionID). There are also the options inProduction, which selects between the development and billed production mode, and debugmode, which prints out the sent and received API calls when set to True.
-
-######General syntax
-
-```
-dopaminekit = DopamineKit.new(appID, developmentSecret, productionSecret, versionID, inProduction, debugMode=false)
-```
-
-######Parameters:
- - `appID: String` - Uniquely identifies your app, get this from your [developer dashboard](http://dev.usedopamine.com).
-
- - `developmentSecret : String` - secret key for development
-
- - `productionSecret : String` - secret key for production
-
- - `versionID : String` -  this is a unique identifier that you choose that marks this implementation as unique in our system. This could be something like 'summer2015Implementation' or 'ClinicalTrial4'. Your `versionID` is what we use to keep track of what users are exposed to what reinforcement and how to best optimize that.
-
- - `inProduction : Boolean` - indicates whether app is in production or development mode, when you're happy with how you're integrating Dopamine and ready to launch set this argument to `true`. This will activate optimized reinforcement and start your billing cycle. While set to `false` your app will receive dummy reinforcement, new users will not be registered with our system, and no billing occurs.
-
- - `debugMode : Boolean=false` - Enables debug mode, where the sent and received data are printed. Can be updated with `enableDebugMode(Boolean)`.
-
-
-========
-
-####Tracking Calls
-
-A tracking call should be used to record and communicate to DopamineAPI that a particular action has been performed by the user, each of these calls will be used to improve the reinforcement model used for the particular user. The tracking call itself is asynchronous and non-blocking. Failed tracking calls will not return errors, but will be noted in the log.
-
-######General syntax
-
-```
-Dopamine.track(actionID, identity, metaData=nil)
-```
-
-######Parameters:
- - `actionID : String` - A descriptive name for action that the user has performed
-
- - `identity : String` - A string used to identify a particular user, such as an email or username or UUID.
-
- - `metaData : Hash=nil` - An optional hash containing extra data about the user or environment to generate better results.
-
-========
-
-####Reinforcement Calls
-
-A reinforcement call should be used when the user has performed a particular action that you wish to become a 'habit', the reinforcement call will return the name of the feedback function that should be called to inform, delight or congratulate the user. The names of the reinforcement functions, the feedback functions and their respective pairings may be found and configured on the developer dashboard.
-
-######General syntax
-
-```
-Dopamine.(actionID, identity, metaData=nil)
-```
-
-######Parameters:
-
- - `actionID : String` - A descriptive name for action that the user has performed
-
- - `identity : String` - A string used to identify a particular user, such as an email or username or UUID.
-
- - `metaData : Hash=nil` - An optional hash containing extra data about the user or environment to generate better results.
-
-========
-
-####Persistent MetaData
-The DopamineKit object can hold some metaData that is stored and sent with all calls. This can be used in place of, or in addition to the `metaData` parameter for the `reinforce()` and `track()` calls.
-
-
-#####Add or Update PersistentMetaData
-Add or update some metaData that you want to include multiple reinforce/tracking calls.
-
-######General syntax
-```
-dopaminekit.addPersistentMetaData(key, value)
-```
-
-######Parameters:
- - `key : String` - A descriptive name for the metaData
-
- - `value : var` - A JSON compliant variable. For example, an Int, Float, String, array, or another Hash.
-
-#####Get PersistentMetaData
-Retrieve a copy of the persistentMetaData Hash. Can be modified and then put back using `setPersistentMetaData()`
-
-######General syntax
-```
-dopaminekit.getPersistentMetaData()
-```
-
-######Returns:
- - `Hash` - A copy of the persistentMetaData Hash.
-
-
-
-#####Set PersistentMetaData
-Replace all contents within the persistentMetaData Hash, and replace them with the Hash passed in.
 	
-######General syntax
-```
-dopaminekit.setPersistentMetaData(hash)
-```
-
-######Parameters:
- - `hash : Hash` - A Hash of JSON compliant key-value pairs. For example, Ints, Floats, Strings, arrays, or other Hashes.
-
-
-
-#####Clear PersistentMetaData
-Clear all entries in the persistentMetaData Hash.
-
-######General syntax
-```
-dopaminekit.clearPersistentMetaData()
-```
-
 ========
 
 ## Development

data/lib/dopaminekit.rb

@@ -18,7 +18,7 @@ class DopamineKit
   	# +debugMode+:: boolean=false - Enables debug mode, where the sent and received data are printed. Can be updated with `enableDebugMode(bool)`.
   	#
 	def initialize(appID, developmentSecret, productionSecret, versionID, inProduction, debugMode=false)
-		@clientSDKVersion = '3.0.0'
+		@clientSDKVersion = '4.0.0'
 		@persistentMetaData = Hash.new
 		@debugMode = debugMode
 
@@ -41,12 +41,10 @@ class DopamineKit
 	end
 
 	##
-	# Used to send tracking calls to the DopamineAPI.
+	# Used to send track calls to the DopamineAPI.
 	#
 	# Params:
-	# +actionID+:: String - A descriptive name for action that the user has performed
-	# +identity+:: String - A string used to identify a particular user, such as an email or username or UUID.
-	# +metaData+:: Hash=nil - A hash containing extra data about the user or environment to generate better results.
+	# +payload+:: Hash - Contains the keys :utc, :timezoneOffset, :primaryIdentity, and :actions
 	#
 	# Return:
 	# +response+:: String - a JSON string containing the key 'status', and if 'status' != 200 also another key 'errors'
@@ -55,10 +53,28 @@ class DopamineKit
 		return send(:track, payload)
 	end
 
+	##
+	# Used to send report calls to the DopamineAPI.
+	#
+	# Params:
+	# +payload+:: Hash - Contains the keys :utc, :timezoneOffset, :primaryIdentity, and :actions
+	#
+	# Return:
+	# +response+:: String - a JSON string containing the key 'status', and if 'status' != 200 also another key 'errors'
+	# 
 	def report(payload)
 		return send(:report, payload)
 	end
 
+	##
+	# Used to send refresh calls to the DopamineAPI.
+	#
+	# Params:
+	# +payload+:: Hash - Contains the keys :utc, :timezoneOffset, :primaryIdentity, and :actionID
+	#
+	# Return:
+	# +response+:: String - a JSON string containing the key 'status', and possibly 'reinforcementCartridge' and 'expiresIn'
+	# 
 	def refresh(payload)
 		return send(:refresh, payload)
 	end
@@ -74,7 +90,7 @@ class DopamineKit
 	##
 	# Privately used function to get POST data with basic information and time
 	# 
-	def getBasePostData()
+	private def getBasePostData()
 		postData = {
 			:clientOS => "Ruby",
 			:clientOSVersion => "#{RUBY_VERSION}",
@@ -88,7 +104,7 @@ class DopamineKit
 	##
 	# Privately used function to send an HTTP POST
 	# 
-	def send(type, data)
+	private def send(type, data)
 		if !data.is_a? Hash
 			puts "[DopamineKit] - Invalid data for api call:#{data} -- needs to be a Hash"
 			return

data/lib/dopaminekit/version.rb

@@ -1,3 +1,3 @@
 class Dopaminekit
-  VERSION = "4.0.0.beta2"
+  VERSION = "4.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dopaminekit
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta2
+  version: 4.0.0
 platform: ruby
 authors:
 - Akash Desai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,9 +119,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1