mixpanel_test-rails 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mixpanel_test-rails.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/mixpanel_test.rb

@@ -0,0 +1,2 @@
+module MixpanelTest
+end

data/lib/generators/mixpanel_test/cucumber/cucumber_generator.rb

@@ -0,0 +1,14 @@
+module MixpanelTest
+  class CucumberGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_cucumber
+      copy_file "mixpanel_steps.rb", "features/step_definitions/mixpanel_steps.rb"
+      copy_file "mixpanel_test_service.rb", "features/support/mixpanel_test_service.rb"
+      puts "(1a) If you're using the mixpanel gem, then set the config parameter :url to \"localhost:3001\" and the :test_service_hostname to \"localhost:3001\" (the johncant/mixpanel fork definitely contains these options)"
+      puts "(1b) If you're not using the mixpanel gem, then replace the hostname in the Mixpanel javascript file url with \"localhost:3001\"."
+      puts "PROFIT!!!!!! mixpanel_test_service will then hijack all the API data for the purpose of testing."
+      puts "If that didn't work, please change this gem or mixpanel_test_service or mixpanel and submit a pull request."
+    end
+  end
+end

data/lib/generators/mixpanel_test/cucumber/templates/mixpanel_steps.rb

@@ -0,0 +1,57 @@
+#When
+
+# Ignore a mixpanel event
+When /^I discard that Mixpanel "([^\"]*)" event$/ do |event_name|
+  step "Mixpanel should receive a \"#{event_name}\" event"
+end
+
+# Check that Mixpanel received a specific event
+Then /^(?:|Mixpanel )should receive (?:|a|an) "([^\"]*)" event$/ do |event_name|
+  @last_mixpanel_event = mixpanel_synchronize_until do
+
+    mixpanel_test_service.transaction do
+      matching_events = mixpanel_test_service.events.find_all do |ev|
+        ev["event"] == event_name
+      end
+      assert matching_events.count <= 1, "More than one \"#{event_name}\" events were received"
+
+      if matching_events.count == 1
+        next mixpanel_test_service.events.delete(matching_events.first)
+      else
+        next false
+      end
+    end
+  end
+
+  assert_not_nil @last_mixpanel_event, "Mixpanel did not receive any \"#{event_name}\" events"
+end
+
+# Check that a page visit was recorded
+Then /^(?:|Mixpanel )should track (?:|the |a )page(?:| visit| view| hit)$/ do
+  step "Mixpanel should receive a \"mp_page_view\" event" # TODO - find out the exact event name
+end
+
+Then /^(?:|Mixpanel )should see "([^\"]*)" (?:|as |for )the "([^\"]*)" property$/ do |value, key|
+  assert_equal value, @last_mixpanel_event["properties"][key]
+end
+
+# Check that Mixpanel will show something up in the stream
+Then /^(?:|Mixpanel )should show "([^\"]*)" in the stream(?: and (?:|as |for )the "([^\"]*)" property)?$/ do |value, key|
+  step "Mixpanel should see \"#{value}\" as the \"mp_note\" property"
+  step "Mixpanel should see \"#{value}\" as the \"#{key}\" property" if key
+end
+
+# Check that a url is used as a Mixpanel property
+Then /^(?:|Mixpanel )should see the url for (.+?) (?:|as |for )the "([^\"]*)" property$/ do |path, key|
+  step "Mixpanel should see \"#{path_to(path)}\" as the \"#{key}\" property"
+end
+
+Then /^the Mixpanel stream should contain "([^\"]*)"$/ do |text|
+  notes = @last_mixpanel_event["properties"]["mp_note"]
+  assert notes.include?(text), "Expected property mp_note (\"#{notes}\") to contain \"#{text}\""
+end
+
+Then /^the Mixpanel stream should contain the word "([^\"]*)"$/ do |test|
+  notes = @last_mixpanel_event["properties"]["mp_note"]
+  assert notes.match(Regexp.new(/(\W|^)#{Regexp.escape(test)}(\W|$)/)), 
+end

data/lib/generators/mixpanel_test/cucumber/templates/mixpanel_test_service.rb

@@ -0,0 +1,40 @@
+# Mixpanel test service.
+# Use this with my Mixpanel gem fork (johncant/mixpanel) or replace the mixpanel javascript file url hostname with localhost:3001. This will proxy the Mixpanel javascript file through the Mixpanel test service, which will edit it slightly. Then, all Mixpanel API calls will go to the Mixpanel test service instead, where you can run tests on them.
+require "mixpanel_test/service"
+require "test/unit"
+
+module MixpanelTestHelpers
+  mattr_accessor :mixpanel_test_service
+
+  def mixpanel_synchronize_until(secs = 2)
+    start_time = Time.now
+
+    until (res=yield) || Time.now >= start_time+2.seconds
+      sleep 0.05
+    end
+
+    res || nil
+  end
+
+end
+
+World(MixpanelTestHelpers)
+
+Before "@mixpanel" do
+  begin
+    MixpanelTestHelpers.mixpanel_test_service ||= MixpanelTest::Service.new(:port => 3001) # Don't shut this down until the end of the process. There are likely to be so many mixpanel tests that the overhead would really slow down the tests.
+    MixpanelTestHelpers.mixpanel_test_service.transaction do
+      MixpanelTestHelpers.mixpanel_test_service.events.clear
+    end
+  rescue
+    MixpanelTestHelpers.mixpanel_test_service = nil
+  end
+end
+
+at_exit do
+  if MixpanelTestHelpers.mixpanel_test_service
+    MixpanelTestHelpers.mixpanel_test_service.stop
+    Thread.pass until MixpanelTestHelpers.mixpanel_test_service.stopped?
+  end
+end
+

data/lib/mixpanel_test/rails.rb

@@ -0,0 +1,7 @@
+require "mixpanel_test-rails/version"
+
+module MixpanelTest
+  module Rails
+    # Your code goes here...
+  end
+end

data/lib/mixpanel_test/version.rb

@@ -0,0 +1,3 @@
+module MixpanelTest
+  VERSION = "0.0.2"
+end

data/mixpanel_test-rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mixpanel_test/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mixpanel_test-rails"
+  s.version     = MixpanelTest::VERSION
+  s.authors     = ["John Cant"]
+  s.email       = ["a.johncant@gmail.com"]
+  s.homepage    = "https://github.com/johncant/mixpanel_test-rails"
+  s.summary     = %q{Cucumber steps for testing mixpanel integration}
+  s.description = %q{Cucumber steps for testing mixpanel integration}
+
+  s.rubyforge_project = "mixpanel_test-rails"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "mixpanel_test_service"
+  s.add_runtime_dependency "rails", ">= 3.0.0"
+end

data/readme.md

@@ -0,0 +1,15 @@
+<h1>Purpose</h1>
+<p>This gem provides some cucumber steps for use with <a href="https://github.com/johncant/mixpanel_test_service">mixpanel_test_service.</p>
+<p>Feel free to add other types of test helpers</p>
+<h2>Usage</h2>
+<pre>
+# Add this to your Gemfile
+gem "mixpanel_test-rails"
+
+# Run this
+rails g mixpanel_test:cucumber # Generates cucumber steps and tells you how to set up the rest
+</pre>
+
+<h2>Limitations</h2>
+
+<p>This gem has no tests. However, version 0.0.1 is being used to test <a href="http://behiring.com">BeHiring</a></p>

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: mixpanel_test-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- John Cant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixpanel_test_service
+  requirement: &22835080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22835080
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &22834460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *22834460
+description: Cucumber steps for testing mixpanel integration
+email:
+- a.johncant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/generators/mixpanel_test.rb
+- lib/generators/mixpanel_test/cucumber/cucumber_generator.rb
+- lib/generators/mixpanel_test/cucumber/templates/mixpanel_steps.rb
+- lib/generators/mixpanel_test/cucumber/templates/mixpanel_test_service.rb
+- lib/mixpanel_test/rails.rb
+- lib/mixpanel_test/version.rb
+- mixpanel_test-rails.gemspec
+- readme.md
+homepage: https://github.com/johncant/mixpanel_test-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mixpanel_test-rails
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Cucumber steps for testing mixpanel integration
+test_files: []