scoutmetrics 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97400cb658e77738d7e00283182027b338e77525
-  data.tar.gz: 53fbbb79f42b664eafa6268659cdd37b81b58360
+  metadata.gz: ffa9658c79e58bd4414e2e36b8ebdcd95fe5e53f
+  data.tar.gz: 594b1283e8f9a6144851a73923aede910cf49328
 SHA512:
-  metadata.gz: ed576c727d64fc5fb7d31ca7f72656fba5778b751e503ab3c9c4f3b5de921047ecef6c75e54340939c64ec7b1a69f96219d3c7f144266036d33ac0ef549241d9
-  data.tar.gz: c5d0aae011c11271b286877ef9dfa3eac174784093c7a2e0621f0ddb8a9d33f3d1dbf89e603248cd960feebea3729461d5af7cf5eeaf4825d657db648f385bd0
+  metadata.gz: af8243471e972dbe00c0acb0db74034c6ad276fb501044dc45bf5d8ac4c45761bd1d2e30f47e4ff429b9c6acf5440d21f9b550253623665cc7c6a7c655cf03fb
+  data.tar.gz: e375fc6ac4ff994b9b40dbfc21eac658bec8cc6aa8388500ffb293266f2bc8070751c49c0c7952d55b1e3f20e269125d264f84cc48016bf919dc114e79193204

data/README.md

@@ -13,7 +13,7 @@ Installation
   gem install scoutmetrics
 
   Or include it in your application,
-  gem 'scoutmetrics', '~> 0.0.2'
+  gem 'scoutmetrics', '~> 0.0.3'
 
 Usage
 ------------
@@ -27,17 +27,17 @@ end
 
 ### User API (found in `/lib/scoutmetrics/user.rb`)
 To tell us a user has signed up
-`ScoutMetrics::User.create(user.id)`
+`ScoutMetrics::User.find(user.id).signup`
 
 Or if you wanted to backfill signups
 ```ruby
 User.each do |user|
-  ScoutMetrics::User.create(user.id, user.created_at)
+  ScoutMetrics::User.create(id: user.id, signup_date: user.created_at, return_date: user.latest_login, active: user.active?)
 end
 ```
 
 To tell us about their latest login (so we can track retention for you)
-`ScoutMetrics::User.update(user.id)`
+`ScoutMetrics::User.find(user.id).report_login`
 
 ### Engagement API (found in `/lib/scoutmetrics/engagement.rb`)
 Tell us that one of your users commented on a post

data/lib/scoutmetrics/user.rb

@@ -2,53 +2,47 @@ module ScoutMetrics
 
   class User
 
-    # Adds an "AppUser" to Scout Metrics
-    #
-    # @param id [Integer] Uniquely identifies user
-    # @param signup_date [DateTime] Date the user signed up, defaults to now
-    #
-    # @return [Json] Returns a msg for the transaction and the status of the request
-    # @return msg explanation of outcome
-    def self.create(id, signup_date=nil)
-      signup_date ||= Time.new
-      post_update(id, { signup_date: signup_date })
+    attr_accesor :id,  :signup_date, :return_date, :active
+
+    # Create a User record with the id passed in for posting to Scout Metrics
+    def self.find(id)
+      new(id: id)
     end
 
-    # Update an "AppUser" on Scout Metrics
-    #
-    # @param id [Integer] Uniquely identifies user
-    # @param return_date [DateTime] Latest time returning to your site, defaults to now
-    #
-    # @return [Json] Returns a msg for the transaction and the status of the request
-    # @return msg explanation of outcome
-    def self.update(id, return_date=nil)
-      return_date ||= Time.new
-      post_update(id, { return_date: return_date })
+    # Override save method to post the information to Scout Metrics
+    def save
+      post_update(id, { signup_date: signup_date, return_date: return_date, active: active }))
+    end
+
+    # Posts signup date for this user (if it doesn't exist yet the "AppUser" will be created)
+    def signup(signup_date=nil)
+      self.signup_date = signup_date || Time.new
+      save
+    end
+
+    # Tells Scout Metrics the latest login date for this "AppUser"
+    def report_login(return_date=nil)
+      self.return_date = return_date || Time.new
+      save
     end
 
     # Activate an "AppUser" on Scout Metrics
     # (Should we also reset their signup_date & return_date?)
-    #
-    # @param id [Integer] Uniquely identifies user
-    #
-    # @return [Json] Returns a msg for the transaction and the status of the request
-    # @return msg explanation of outcome
-    def self.activate(id)
-      post_update(id, { active: true })
+    def activate
+      self.active = true
+      save
     end
 
     # Deactivate an "AppUser" on Scout Metrics
-    #
-    # @param id [Integer] Uniquely identifies user
-    #
-    # @return [Json] Returns a msg for the transaction and the status of the request
-    # @return msg explanation of outcome
-    def self.deactivate(id)
-      post_update(id, { active: false })
+    def deactivate
+      self.active = false
+      save
     end
 
     private
 
+    # @return [Json] Returns a msg for the transaction and the status of the request
+    # @return msg explanation of outcome
     def self.post_update(id, params)
       ScoutMetrics::Request.new(:put, "/app_users/#{id}", { app_user: params })
     end

data/scoutmetrics.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'scoutmetrics'
-  s.version = '0.0.2'
+  s.version = '0.0.3'
   s.date = '2014-10-20'
   s.summary = 'Ruby wrapper for the Scout Metrics API'
   s.description = 'Ruby wrapper for the Scout Metrics API'

data/vendor/assets/javascripts/scoutmetrics.js

@@ -2,44 +2,60 @@
   "use strict";
 
   var ScoutMetrics = {
-    accessToken: '6qPPlrlPYk5erffdy7cgig'
+    accessToken: '6qPPlrlPYk5erffdy7cgig',
     Request: {
       init: function() {
-        this.domain = 'https://scoutmetrics.com/api/v1'
+        this.api_domain = 'https://scoutmetrics.herokuapp.com/api/v1';
       },
-      send: function(method, route, data) {
+      send: function(method, route, data, callback) {
         var self = this;
+        var url = self.api_domain + route
+
         data['token'] = ScoutMetrics.accessToken;
         $.ajax({
-          url: self.domain + route,
+          url: self.api_domain + route,
           type: method,
-          data: data
+          data: data,
+          complete: function(response) {
+            callback(response, 'NOTHING');
+          }
         });
       }
     },
     User: {
-      create: function(params) {
-        params['signup_date'] || (params['signup_date'] = new Date());
-        Request.send('POST', '/app_users', { app_user: params });
+      create: function(id, signup_date, callback) {
+        signup_date || (signup_date = new Date());
+        this.postUpdate(id, { app_user: { signup_date: signup_date } }, callback);
+      },
+      update: function(id, return_date, callback) {
+        return_date || (return_date = new Date());
+        this.postUpdate(id, { app_user: { return_date: return_date } }, callback);
+      },
+      activate: function(id, callback) {
+        this.postUpdate(id, { active: true }, callback);
       },
-      update: function(params) {
-        params['return_date'] || (params['return_date'] = new Date());
-        Request.send('POST', '/app_users', { app_user: params });
+      deactivate: function(id, callback) {
+        this.postUpdate(id, { active: false }, callback);
+      },
+      postUpdate: function(id, params, callback) {
+        ScoutMetrics.Request.send('POST', '/app_users/' + id, params, callback);
       }
     },
     Engagement: {
-      create: function(params) {
-        Request.send('POST', '/engagements', { engagement: params });
+      create_category: function(name, callback) {
+        ScoutMetrics.Request.send('POST', '/engagements', { engagement: { name: name } }, callback);
       },
-      report: function(engagement_params, date_recorded) {
+      create: function(name, date_recorded, callback) {
         date_recorded || (date_recorded = new Date());
-        params = { engagement: engagement_params,
-                   engagement_instance: { date_recorded: date_recorded } };
-        Request.send('POST', '/engagements/add_instance', params);
+        var params = { engagement: { name: name },
+                       engagement_instance: { date_recorded: date_recorded } };
+        ScoutMetrics.Request.send('POST', '/engagements/add_instance', params, callback);
       }
     }
   };
 
+  ScoutMetrics.Request.init();
+
   window.ScoutMetrics = ScoutMetrics;
 
 })(jQuery,window,document);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scoutmetrics
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dosty Everts
@@ -14,28 +14,28 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.0
 description: Ruby wrapper for the Scout Metrics API
@@ -50,6 +50,7 @@ files:
 - lib/scoutmetrics/engagement.rb
 - lib/scoutmetrics/request.rb
 - lib/scoutmetrics/user.rb
+- scoutmetrics-0.0.2.gem
 - scoutmetrics.gemspec
 - vendor/assets/javascripts/scoutmetrics.js
 homepage: https://github.com/MustWin/scoutmetrics-ruby-gem
@@ -62,17 +63,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Scout Metrics API