scoutmetrics 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a42ad2a0f6b525d3949ea17bd03293dcb77c6210
+  data.tar.gz: a1d774b69f5805ca072fac499aae783a2ecb8b9d
+SHA512:
+  metadata.gz: aa5cc6dc3350ffcfa32d240e91bc301f218882c1eee33c954264f5151084e13a3aaa68e6f6080db4fabf5c9aeaa266014e3d33489f0f7a414ca5619e47b76a23
+  data.tar.gz: ba3314bd668fb12b4b19a1391c8eb0a307cf282af2f1555cd7fb5879b8c42c6c4b423ea780b4ed964d52ae8393610f500364120089e4ca756996a5bdeb60f560

data/lib/scoutmetrics/configuration.rb

@@ -0,0 +1,24 @@
+module ScoutMetrics
+
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+      :access_token
+    ].freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+  end
+
+end

data/lib/scoutmetrics/engagement.rb

@@ -0,0 +1,35 @@
+module ScoutMetrics
+
+  class Engagement
+
+    # Adds an "Engagement" to Scout Metrics
+    # For example "Liked us on Facebook"
+    # 
+    # @param engagement_params [Hash] Name of the engagement
+    # @engagement_params name [String] Describes the engagement
+    # @return [Json] Returns a msg for the transaction and the status of the request
+    # @return msg explanation of outcome
+    def self.create_category(name)
+      ScoutMetrics::Request.new(:post, '/engagements', { engagement: { name: name } })
+    end
+
+    # Add/Update an "EngagementInstance" on Scout Metrics
+    # This tells Scout Metrics that a user performed an "Engagement" on a given date
+    # For example: Someone "Liked us on Facebook" on Dec 12th
+    # (We do not track who performed the action)
+    #
+    # @param name [String] Describes the engagement
+    # @param date_recorded [Date] Day the engagement happened, 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(name, date_recorded=nil)
+      date_recorded ||= Time.new
+      params = { engagement: { name: name },
+                 engagement_instance: { date_recorded: date_recorded } }
+      ScoutMetrics::Request.new(:post, '/engagements/add_instance', params)
+    end
+
+  end
+
+end

data/lib/scoutmetrics/request.rb

@@ -0,0 +1,21 @@
+require 'http'
+
+module ScoutMetrics
+
+  class Request
+
+    DOMAIN = 'https://scoutmetrics.herokuapp.com/api/v1'
+
+    def initialize(method, route, params)
+      params[:token] = ScoutMetrics.access_token
+      route = "#{DOMAIN}#{route}"
+      puts "METHOD: #{method}"
+      puts "ROUTE: #{route}"
+      puts 'PARAMS'
+      puts params
+      response = HTTP.send(method, route, json: params)
+    end
+
+  end
+
+end

data/lib/scoutmetrics/user.rb

@@ -0,0 +1,58 @@
+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 })
+    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 })
+    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 })
+    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 })
+    end
+
+    private
+
+    def self.post_update(id, params)
+      ScoutMetrics::Request.new(:put, "/app_users/#{id}", { app_user: params })
+    end
+
+  end
+
+end

data/lib/scoutmetrics.rb

@@ -0,0 +1,26 @@
+require 'scoutmetrics/configuration'
+require 'scoutmetrics/engagement'
+require 'scoutmetrics/request'
+require 'scoutmetrics/user'
+
+module ScoutMetrics
+  extend Configuration
+
+end
+# Configure in your initializer as such
+#
+# ScoutMetrics.configure do |config|
+#   config.access_token = SCOUT_PROJECT_TOKEN
+# end
+#
+# Add a new User
+# ScoutMetrics::User.create({ app_id: user.id, signup_date: DateTime.current })
+# 
+# Update an existing User
+# ScoutMetrics::User.update({ app_id: user.id, return_date: DateTime.current })
+#
+# Add an engagement
+# ScoutMetrics::Engagement.create({ name: 'Liked us on Facebook' })
+#
+# Report an engagement
+# ScoutMetrics::Engagement.report({ name: 'Liked us on Facebook' }, DateTime.current)

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: scoutmetrics
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Dosty Everts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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
+email: dosty@mustwin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/scoutmetrics.rb
+- lib/scoutmetrics/configuration.rb
+- lib/scoutmetrics/engagement.rb
+- lib/scoutmetrics/request.rb
+- lib/scoutmetrics/user.rb
+homepage: https://github.com/MustWin/scoutmetrics-ruby-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Scout Metrics API
+test_files: []