snogmetrics 0.1.9 → 0.2.1

data/lib/snogmetrics.rb

@@ -1,7 +1,8 @@
 require 'snogmetrics/railtie' if defined? Rails::Railtie
+require 'snogmetrics/kissmetrics_api'
 
-# If SNOGmetrics is used as a Rails plugin, this module is automatically mixed 
-# into ActionController::Base, so that it's #km method is available in 
+# If SNOGmetrics is used as a Rails plugin, this module is automatically mixed
+# into ActionController::Base, so that it's #km method is available in
 # controllers and in views.
 #
 # If not used as a Rails plugin, make sure that the context where Snogmetrics
@@ -16,21 +17,20 @@ require 'snogmetrics/railtie' if defined? Rails::Railtie
 # The array output strategy simply logs all events in the _kmq variable.
 # The live output strategy sends calls to the async KISSmetrics JS API.
 #
-# The default implementation outputs the real API only when 
+# The default implementation outputs the real API only when
 # `Rails.env.production?` is true, and otherwise uses console.log
 module Snogmetrics
-  VERSION = '0.1.9'
+  VERSION = '0.2.1'.freeze
+
+  class << self
+    attr_accessor :kissmetrics_api_key, :output_strategy
+  end
 
   # Returns an instance of KissmetricsApi, which is an interface to the
   # KISSmetrics API. It has the methods #record and #identify, which work just
   # like the corresponding methods in the JavaScript API.
   def km
-    @km_api ||= KissmetricsApi.new(kissmetrics_api_key, session, output_strategy)
-  end
-
-  # Override this method to set the KISSmetrics API key
-  def kissmetrics_api_key
-    ''
+    @km_api ||= KissmetricsApi.new(Snogmetrics.kissmetrics_api_key, session, output_strategy)
   end
 
   # Override this method to set the output strategy.
@@ -40,135 +40,23 @@ module Snogmetrics
   # :array       store events pushed to KISSmetrics on _kmq
   # :live        send events to KISSmetrics via the async JS API
   def output_strategy
-    if use_fake_kissmetrics_api?
-      :console_log
-    else
-      :live
-    end
+    Snogmetrics.output_strategy ||
+      if use_fake_kissmetrics_api?
+        :console_log
+      else
+        :live
+      end
   end
-  
+
   # Deprecated: Prefer overriding #output_strategy to control the output strategy.
   #
   # Override this method to customize when the real API and when the stub API
   # will be outputted.
   def use_fake_kissmetrics_api?
     if defined? Rails
-      ! Rails.env.production?
+      !Rails.env.production?
     else
       false
     end
   end
-
-  
-private
-
-  class KissmetricsApi
-    # Do not instantiate KissmetricsApi yourself, instead mix in Snogmetrics
-    # and use it's #km method to get an instance of KissmetricsApi.
-    def initialize(api_key, session, output_strategy)
-      @session         = session
-      @api_key         = api_key
-      @output_strategy = output_strategy
-    end
-    
-    # The equivalent of the `KM.record` method of the JavaScript API. You can
-    # pass either an event name, an event name and a hash of properties, or only
-    # a hash of properties.
-    def record(*args)
-      raise 'Not enough arguments' if args.size == 0
-      raise 'Too many arguments' if args.size > 2
-      
-      queue << ['record', *args]
-    end
-    
-    # The equivalent of the `KM.identify` method of the JavaScript API.
-    def identify(identity)
-      unless @session[:km_identity] == identity
-        queue.delete_if { |e| e.first == 'identify' }
-        queue << ['identify', identity]
-        @session[:km_identity] = identity
-      end
-    end
-    
-    # The equivalent of the `KM.trackClick` method of the JavaScript API. The first
-    # argument should be a selector (a tag id or class name). Furthermore you can
-    # pass either an event name, an event name and a hash of properties, or only
-    # a hash of properties.
-    def trackClick(selector, *args)
-      raise 'Not enough arguments' if args.size == 0
-      raise 'Too many arguments' if args.size > 2
-
-      queue << ['trackClick', selector, *args]
-    end
-
-    # Register which variant the user saw in an A/B test.
-    def set(experiment, variant)
-      queue << ['set', { experiment => variant }]
-    end
-    
-    # Equivalent to `js(:reset => true)`, i.e. returns the JavaScript code
-    # needed to load the KISSmetrics API and send the current state, and reset
-    # the state afterwards.
-    def js!
-      js(:reset => true)
-    end
-    
-    # In most situations you want the #js! method instead of this one.
-    #
-    # Returns the JavaScript needed to send the current state to KISSmetrics.
-    # This includes the a JavaScript tag that loads the API code (or a fake API
-    # that sends events to the console or a global array if the `output_strategy`
-    # parameter to #initialize is :console_log or :array), as well as statements
-    # that push the current state onto the `_kmq` array.
-    #
-    # You can pass the option `:reset` to reset the state, this makes sure that
-    # subsequent calls to #js will not send events that have already been sent.
-    def js(options={})
-      options = {:reset => false}.merge(options)
-
-      buffer = queue.map { |item| %(_kmq.push(#{item.to_json});) }
-
-      queue.clear if options[:reset]
-
-      <<-JAVASCRIPT
-      <script type="text/javascript">
-      var _kmq = _kmq || [];
-      #{api_js}
-      #{buffer.join("\n")}
-      </script>
-      JAVASCRIPT
-    end
-  
-  private
-  
-    def queue
-      @session[:km_queue] ||= []
-    end
-    
-    def api_js
-      if @output_strategy == :console_log
-        <<-JS
-        if (window.console) {
-          _kmq = (function(queue) {
-            var printCall = function() {
-              console.dir(arguments);
-            }
-
-            for (var i = 0; i < queue.length; i++) {
-              printCall.apply(null, queue[i]);
-            }
-
-            return {push: printCall};
-          })(_kmq);
-        }
-        JS
-      elsif @output_strategy == :live
-        %((function(){function _kms(u,d){if(navigator.appName.indexOf("Microsoft")==0 && d)document.write("<scr"+"ipt defer='defer' async='true' src='"+u+"'></scr"+"ipt>");else{var s=document.createElement('script');s.type='text/javascript';s.async=true;s.src=u;(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(s);}}_kms('https://i.kissmetrics.com/i.js');_kms('http'+('https:'==document.location.protocol ? 's://s3.amazonaws.com/' : '://')+'scripts.kissmetrics.com/#{@api_key}.1.js',1);})();)
-      elsif @output_strategy == :array
-        ""
-      else
-        raise "Unknown KISSmetrics output strategy: #{@output_strategy}"
-      end
-    end
-  end
 end

data/lib/snogmetrics/kissmetrics_api.rb

@@ -0,0 +1,112 @@
+module Snogmetrics
+  class KissmetricsApi
+    # Do not instantiate KissmetricsApi yourself, instead mix in Snogmetrics
+    # and use it's #km method to get an instance of KissmetricsApi.
+    def initialize(api_key, session, output_strategy)
+      @session         = session
+      @api_key         = api_key
+      @output_strategy = output_strategy
+    end
+
+    # The equivalent of the `KM.record` method of the JavaScript API. You can
+    # pass either an event name, an event name and a hash of properties, or only
+    # a hash of properties.
+    def record(*args)
+      raise 'Not enough arguments' if args.empty?
+      raise 'Too many arguments' if args.size > 2
+
+      queue << ['record', *args]
+    end
+
+    # The equivalent of the `KM.identify` method of the JavaScript API.
+    def identify(identity)
+      unless @session[:km_identity] == identity
+        queue.delete_if { |e| e.first == 'identify' }
+        queue << ['identify', identity]
+        @session[:km_identity] = identity
+      end
+    end
+
+    # The equivalent of the `KM.trackClick` method of the JavaScript API. The first
+    # argument should be a selector (a tag id or class name). Furthermore you can
+    # pass either an event name, an event name and a hash of properties, or only
+    # a hash of properties.
+    def trackClick(selector, *args)
+      raise 'Not enough arguments' if args.empty?
+      raise 'Too many arguments' if args.size > 2
+
+      queue << ['trackClick', selector, *args]
+    end
+
+    # Register which variant the user saw in an A/B test.
+    def set(experiment, variant)
+      queue << ['set', { experiment => variant }]
+    end
+
+    # Equivalent to `js(:reset => true)`, i.e. returns the JavaScript code
+    # needed to load the KISSmetrics API and send the current state, and reset
+    # the state afterwards.
+    def js!
+      js(reset: true)
+    end
+
+    # In most situations you want the #js! method instead of this one.
+    #
+    # Returns the JavaScript needed to send the current state to KISSmetrics.
+    # This includes the a JavaScript tag that loads the API code (or a fake API
+    # that sends events to the console or a global array if the `output_strategy`
+    # parameter to #initialize is :console_log or :array), as well as statements
+    # that push the current state onto the `_kmq` array.
+    #
+    # You can pass the option `:reset` to reset the state, this makes sure that
+    # subsequent calls to #js will not send events that have already been sent.
+    def js(options = {})
+      options = { reset: false }.merge(options)
+
+      buffer = queue.map { |item| %(_kmq.push(#{item.to_json});) }
+
+      queue.clear if options[:reset]
+
+      <<-JAVASCRIPT
+      <script type="text/javascript">
+      var _kmq = _kmq || [];
+      #{api_js}
+      #{buffer.join("\n")}
+      </script>
+      JAVASCRIPT
+    end
+
+    private
+
+    def queue
+      @session[:km_queue] ||= []
+    end
+
+    def api_js
+      case @output_strategy
+      when :console_log
+        <<-JS
+        if (window.console) {
+          _kmq = (function(queue) {
+            var printCall = function() {
+              console.dir(arguments);
+            }
+
+            for (var i = 0; i < queue.length; i++) {
+              printCall.apply(null, queue[i]);
+            }
+
+            return {push: printCall};
+          })(_kmq);
+        }
+        JS
+      when :live
+        %(function _kms(e){setTimeout(function(){var s=document,t=s.getElementsByTagName("script")[0],c=s.createElement("script");c.type="text/javascript",c.async=!0,c.src=e,t.parentNode.insertBefore(c,t)},1)}_kms("//i.kissmetrics.com/i.js"),_kms("//scripts.kissmetrics.com/#{@api_key}.2.js");)
+      when :array
+        ''
+      else
+        raise "Unknown KISSmetrics output strategy: #{@output_strategy}"
+      end
+    end
+  end
+end

data/lib/snogmetrics/railtie.rb

@@ -1,7 +1,6 @@
 require 'snogmetrics'
 require 'rails'
 
-
 module Snogmetrics
   class Railtie < Rails::Railtie
     config.after_initialize do

data/snogmetrics.gemspec

@@ -1,5 +1,9 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/snogmetrics', __FILE__)
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'snogmetrics'
 
 Gem::Specification.new do |s|
   s.name        = 'snogmetrics'
@@ -10,19 +14,21 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://github.org/iconara/snogmetrics'
   s.summary     = 'SNOGmetrics is a KISSmetrics helper for Rails'
   s.description = 'SNOGmetrics gives you the best of both worlds: access to KISSmetrics\' JavaScript API through Ruby'
+  s.license     = 'MIT'
 
   s.required_rubygems_version = '>= 1.3.6'
-  s.rubyforge_project         = 'snogmetrics'
 
-  s.add_development_dependency 'bundler', '~> 1.0.0'
-  s.add_development_dependency 'rake', '~> 0.8.7'
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'BlueCloth'
-  s.add_development_dependency 'rails'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rcov'
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|example)/})
+  end
+  s.bindir        = 'bin'
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
-  s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
-  s.require_path = 'lib'
+  s.add_development_dependency 'bundler', '~> 1.14'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'yard', '~> 0.9'
+  s.add_development_dependency 'rails', '~> 4.2'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rubocop', '~> 0.49'
 end

metadata

@@ -1,173 +1,143 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: snogmetrics
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.9
+version: !ruby/object:Gem::Version
+  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Theo Hultberg
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-30 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2017-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.8.7
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: BlueCloth
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
   type: :development
-  version_requirements: *id007
-description: "SNOGmetrics gives you the best of both worlds: access to KISSmetrics' JavaScript API through Ruby"
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: 'SNOGmetrics gives you the best of both worlds: access to KISSmetrics''
+  JavaScript API through Ruby'
+email:
 - theo@iconara.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .document
-- .gitignore
+files:
+- ".document"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.mdown
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.mdown
 - Rakefile
-- example/snoggy/.gitignore
-- example/snoggy/README.mdown
-- example/snoggy/Rakefile
-- example/snoggy/app/controllers/application_controller.rb
-- example/snoggy/app/controllers/snogs_controller.rb
-- example/snoggy/app/views/layouts/application.html.erb
-- example/snoggy/app/views/snogs/new.html.erb
-- example/snoggy/app/views/snogs/thank_you.html.erb
-- example/snoggy/config/boot.rb
-- example/snoggy/config/environment.rb
-- example/snoggy/config/environments/development.rb
-- example/snoggy/config/environments/production.rb
-- example/snoggy/config/environments/test.rb
-- example/snoggy/config/initializers/snogmetrics.rb
-- example/snoggy/config/routes.rb
-- example/snoggy/script/about
-- example/snoggy/script/console
-- example/snoggy/script/dbconsole
-- example/snoggy/script/destroy
-- example/snoggy/script/generate
-- example/snoggy/script/performance/benchmarker
-- example/snoggy/script/performance/profiler
-- example/snoggy/script/plugin
-- example/snoggy/script/runner
-- example/snoggy/script/server
-- example/snoggy/vendor/plugins/snogmetrics/init.rb
 - lib/snogmetrics.rb
+- lib/snogmetrics/kissmetrics_api.rb
 - lib/snogmetrics/railtie.rb
-- rails/init.rb
 - snogmetrics.gemspec
-- spec/snogmetrics_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.org/iconara/snogmetrics
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
-rubyforge_project: snogmetrics
-rubygems_version: 1.5.2
+rubyforge_project: 
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SNOGmetrics is a KISSmetrics helper for Rails
 test_files: []
-