scoutmetrics 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a42ad2a0f6b525d3949ea17bd03293dcb77c6210
-  data.tar.gz: a1d774b69f5805ca072fac499aae783a2ecb8b9d
+  metadata.gz: edc0c2543c456835f55f1db27b1856b997958d9b
+  data.tar.gz: af28af4e278a6d3977fc9490fb69c232cab15444
 SHA512:
-  metadata.gz: aa5cc6dc3350ffcfa32d240e91bc301f218882c1eee33c954264f5151084e13a3aaa68e6f6080db4fabf5c9aeaa266014e3d33489f0f7a414ca5619e47b76a23
-  data.tar.gz: ba3314bd668fb12b4b19a1391c8eb0a307cf282af2f1555cd7fb5879b8c42c6c4b423ea780b4ed964d52ae8393610f500364120089e4ca756996a5bdeb60f560
+  metadata.gz: 4a0f2ee33e9d8785b2e5a04f959310a54c20682c9f744f7756412f262062bb91645638f3e6fb7baafae37742cdc7ce134ad582718ebf31eec34037a2370ed13d
+  data.tar.gz: ac56ec549ae382b44251cd17ffbadb77594db17fe3992b19fa56e9f85303422fe385eecf4d065a27822b653e18e649d63c61b202a474b02b7363f0ffd6513ff4

data/README.md

@@ -0,0 +1,46 @@
+The Scout Metrics Ruby Gem
+====================
+A Ruby wrapper for the Scout Metrics
+
+Overview
+------------
+Scout Metrics is an application that tracks engagement on your website, as well as culminates data from the following sources into actionable statistics: Facebook, Twitter, Instagram, and Google Analytics.
+
+This gem is used to help users of Scout Metrics give us data when their users engage in an action (such as commenting on a post, if you're hosting a blog), or when a new user signs up for their service.
+
+Installation
+------------
+  gem install scoutmetrics
+
+  Or include it in your application,
+  gem 'scoutmetrics', '~> 0.0.0'
+
+Usage
+------------
+
+When you sign up on Scout Metrics your site will be assigned a token, configure this gem to use that token as follows
+```ruby
+ScoutMetrics.configure do |config|
+  config.access_token = MY_ACCESS_TOKEN
+end```
+
+### User API (found in `/lib/scoutmetrics/user.rb`)
+To tell us a user has signed up
+`ScoutMetrics::User.create(user.id)`
+
+Or if you wanted to backfill signups
+```ruby
+User.each do |user|
+  ScoutMetrics::User.create(user.id, user.created_at)
+end```
+
+To tell us about their latest login (so we can track retention for you)
+`ScoutMetrics::User.update(user.id)`
+
+### Engagement API (found in `/lib/scoutmetrics/engagement.rb`)
+Tell us that one of your users commented on a post
+`ScoutMetrics::Engagement.create("Commented on Post")`
+
+Developers
+------------------------------
+This gem is developed by Must Win, LLC [http://mustwin.com]

data/scoutmetrics.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+#require File.expand_path('../lib/instagram/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'scoutmetrics'
+  s.version = '0.0.1'
+  s.date = '2014-10-20'
+  s.summary = 'Ruby wrapper for the Scout Metrics API'
+  s.description = 'Ruby wrapper for the Scout Metrics API'
+  s.authors = ['Dosty Everts']
+  s.email = 'dosty@mustwin.com'
+  #s.files = %w(lib/scoutmetrics.rb lib/scoutmetrics/configuration.rb lib/scoutmetrics/engagement.rb lib/scoutmetrics/request.rb lib/scoutmetrics/user.rb)
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/MustWin/scoutmetrics-ruby-gem'
+  s.license = 'MIT'
+  #s.add_development_dependency('rake', '~> 0.9.2.2')
+  s.add_dependency 'http', '~> 0.6.0'
+  s.add_dependency 'http_parser.rb', '~> 0.6.0'
+  
+  
+  
+  #s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  #s.files = `git ls-files`.split("\n")
+  
+  
+  
+  #s.platform = Gem::Platform::RUBY
+  #s.require_paths = ['lib']
+  #s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  #s.rubyforge_project = s.name
+  
+  
+end

data/vendor/assets/javascripts/scoutmetrics.js

@@ -0,0 +1,45 @@
+;(function ($, window, document, undefined ) {
+  "use strict";
+
+  var ScoutMetrics = {
+    accessToken: '6qPPlrlPYk5erffdy7cgig'
+    Request: {
+      init: function() {
+        this.domain = 'https://scoutmetrics.com/api/v1'
+      },
+      send: function(method, route, data) {
+        var self = this;
+        data['token'] = ScoutMetrics.accessToken;
+        $.ajax({
+          url: self.domain + route,
+          type: method,
+          data: data
+        });
+      }
+    },
+    User: {
+      create: function(params) {
+        params['signup_date'] || (params['signup_date'] = new Date());
+        Request.send('POST', '/app_users', { app_user: params });
+      },
+      update: function(params) {
+        params['return_date'] || (params['return_date'] = new Date());
+        Request.send('POST', '/app_users', { app_user: params });
+      }
+    },
+    Engagement: {
+      create: function(params) {
+        Request.send('POST', '/engagements', { engagement: params });
+      },
+      report: function(engagement_params, date_recorded) {
+        date_recorded || (date_recorded = new Date());
+        params = { engagement: engagement_params,
+                   engagement_instance: { date_recorded: date_recorded } };
+        Request.send('POST', '/engagements/add_instance', params);
+      }
+    }
+  };
+
+  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.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Dosty Everts
@@ -44,11 +44,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/scoutmetrics.rb
 - lib/scoutmetrics/configuration.rb
 - lib/scoutmetrics/engagement.rb
 - lib/scoutmetrics/request.rb
 - lib/scoutmetrics/user.rb
+- scoutmetrics.gemspec
+- vendor/assets/javascripts/scoutmetrics.js
 homepage: https://github.com/MustWin/scoutmetrics-ruby-gem
 licenses:
 - MIT