mixpanel 0.5.1

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+mixpanel*.gem

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Alvaro Gil, cuboxsa.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,25 @@
+== What is Mixpanel (the service) ?
+
+*Mixpanel* is a real-time analytics service that helps companies understand how users interact with web applications.
+http://mixpanel.com
+
+== What does this Gem?
+
+* Track events with properties directly from your backend
+
+
+== How to install?
+
+  gem install mixpanel
+
+
+== How to use?
+
+  require 'mixpanel'
+
+  mixpanel = Mixpanel.new("your_mixpanel_project_token")
+
+  mixpanel.track("Sign up", {
+    :referer => "http://example.com",
+    :ip => "4.4.4.4"
+  })

data/Rakefile

@@ -0,0 +1,9 @@
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ["-u -c -fs"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/lib/mixpanel.rb

@@ -0,0 +1,42 @@
+require "open-uri"
+require 'base64'
+require 'json'
+
+class Mixpanel
+  attr_reader :events
+
+  def initialize(token, options = {})
+    @token = token
+    @events = []
+  end
+
+  def append_event(event, properties = {})
+    @events << build_event(event, properties)
+  end
+
+  def track_event(event, properties = {})
+    params = build_event(event, properties.merge(:token => @token, :time => Time.now.utc.to_i))
+    parse_response request(params)
+  end
+
+  def clean_queue
+    @events = []
+  end
+
+  private
+
+  def parse_response(response)
+    response == "1" ? true : false
+  end
+
+  def request(params)
+    data = Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
+    url = "http://api.mixpanel.com/track/?data=#{data}"
+
+    open(url).read
+  end
+
+  def build_event(event, properties)
+    {:event => event, :properties => properties}
+  end
+end

data/mixpanel.gemspec

@@ -0,0 +1,27 @@
+spec = Gem::Specification.new do |s|
+  s.name = "mixpanel"
+  s.version = "0.5.1"
+  s.rubyforge_project = "mixpanel"
+  s.description = "Simple lib to track events in Mixpanel service."
+  s.author = "Alvaro Gil"
+  s.email = "zevarito@gmail.com"
+  s.homepage = "http://cuboxsa.com"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Supports direct request api and javascript requests."
+  s.files = %w[
+    .gitignore
+    README.rdoc
+    LICENSE
+    Rakefile
+    mixpanel.gemspec
+    lib/mixpanel.rb
+    spec/spec_helper.rb
+    spec/mixpanel/mixpanel_spec.rb
+  ]
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.add_dependency 'json'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'fakeweb'
+end

data/spec/mixpanel/mixpanel_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Mixpanel do
+  before do
+    @mixpanel = Mixpanel.new(MIX_PANEL_TOKEN)
+  end
+
+  context "Initializing object" do
+    it "should have an instance variable for token and events" do
+      @mixpanel.instance_variables.should include("@token", "@events")
+    end
+  end
+
+  context "Cleaning events" do
+    it "should clean the queue" do
+      @mixpanel.append_event("Sign up")
+      @mixpanel.events.size.should == 1
+      @mixpanel.clean_queue
+      @mixpanel.events.size.should == 0
+    end
+  end
+
+  context "Accessing Mixpanel through direct request" do
+    context "Tracking events" do
+      it "should track simple events" do
+        @mixpanel.track_event("Sign up").should == true
+      end
+
+      it "should call request method with token and time value" do
+        params = {:event => "Sign up", :properties => {:token => MIX_PANEL_TOKEN, :time => Time.now.utc.to_i}}
+
+        @mixpanel.should_receive(:request).with(params).and_return("1")
+        @mixpanel.track_event("Sign up").should == true
+      end
+    end
+  end
+
+  context "Accessing Mixpanel through javascript API" do
+    context "Appending events" do
+      it "should append simple events" do
+        @mixpanel.append_event("Sign up")
+        mixpanel_events_should_include(@mixpanel, "Sign up", {})
+      end
+
+      it "should append events with properties" do
+        @mixpanel.append_event("Sign up", {:referer => 'http://example.com'})
+        mixpanel_events_should_include(@mixpanel, "Sign up", {:referer => 'http://example.com'})
+      end
+
+      it "should give direct access to events" do
+        @mixpanel.append_event("Sign up", {:referer => 'http://example.com'})
+        @mixpanel.events.size.should == 1
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), "../lib", "mixpanel")
+require 'fakeweb'
+
+MIX_PANEL_TOKEN = "e2d8b0bea559147844ffab3d607d26a6"
+
+def mixpanel_events_should_include(mixpanel, event, properties)
+  mixpanel.events.each do |event_hash|
+    event_hash[:event].should == event
+    event_hash[:properties].should == properties if properties
+  end
+end
+
+# Fakeweb
+FakeWeb.allow_net_connect = false
+FakeWeb.register_uri(:any, /http:\/\/api\.mixpanel\.com.*/, :body => "1")

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: mixpanel
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+- Alvaro Gil
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-05 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Simple lib to track events in Mixpanel service.
+email: zevarito@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- LICENSE
+- Rakefile
+- mixpanel.gemspec
+- lib/mixpanel.rb
+- spec/spec_helper.rb
+- spec/mixpanel/mixpanel_spec.rb
+has_rdoc: true
+homepage: http://cuboxsa.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mixpanel
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Supports direct request api and javascript requests.
+test_files: []
+