mixpanel_client 0.5.1 → 1.0.0

data/.gitignore

@@ -0,0 +1,30 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+config/mixpanel.yml
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test/
+tmp/
+
+## Bundler/Gems
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,14 @@
+# Create the gemset if it does not exist
+rvm_gemset_create_on_use_flag=1
+
+# Switch to default ruby version when exiting directory
+rvm_project_rvmrc_default=1
+
+# Use rvm with a specific version of ruby and gemset
+if [[ `ruby -v` =~ '1.8.7' ]]; then
+  rvm use ruby-1.8.7
+  rvm gemset use mixpanel_client_1.8.7
+else
+  rvm use ruby-1.9.2
+  rvm gemset use mixpanel_client_1.9.2
+fi

data/Gemfile

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

data/README.md

@@ -13,7 +13,7 @@ Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool.
     require 'rubygems'
     require 'mixpanel_client'
 
-    client = Mixpanel::Client.new('api_key' => 'changeme', 'api_secret' => 'changeme')
+    client = MixpanelClient.new('api_key' => 'changeme', 'api_secret' => 'changeme')
 
     data = client.request do
       resource 'events/retention'
@@ -26,6 +26,17 @@ Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool.
 
     puts data.inspect
 
+## Changelog
+
+### 1.0.0
+ * Changed "Mixpanel" class name to "MixpanelClient" to prevent naming collision in other libraries. [a710a84e8ba4b6f018b7](https://github.com/keolo/mixpanel_client/commit/a710a84e8ba4b6f018b7404ab9fabc8f08b4a4f3)
+
+## Collaborators and Maintainers
+[Keolo Keagy](http://github.com/keolo) (Author)  
+[Nathan Chong](http://github.com/paramaw)  
+[Paul McMahon](http://github.com/pwim)  
+[Chad Etzel](http://github.com/jazzychad)
+
 ## Copyright
 
 Copyright (c) 2009+ Keolo Keagy. See LICENSE for details.

data/Rakefile

@@ -2,23 +2,8 @@ require 'rubygems'
 require 'rake'
 require 'metric_fu'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = 'mixpanel_client'
-    gem.summary = 'Ruby Mixpanel API Client Library'
-    gem.description = 'Simple ruby client interface to the Mixpanel API.'
-    gem.email = 'keolo@dreampointmedia.com'
-    gem.homepage = 'http://github.com/keolo/mixpanel_client'
-    gem.authors = ['Keolo Keagy']
-    gem.add_development_dependency 'rspec', '>= 2.4.0'
-    gem.add_development_dependency 'webmock', '>= 1.6.2'
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
@@ -39,13 +24,13 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
+task :spec #=> :check_dependencies
 
 begin
   require 'cucumber/rake/task'
   Cucumber::Rake::Task.new(:features)
 
-  task :features => :check_dependencies
+  task :features #=> :check_dependencies
 rescue LoadError
   task :features do
     abort 'Cucumber is not available. In order to run features, you must: sudo gem install cucumber'

data/lib/mixpanel_client/mixpanel_client.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby -Ku
+
+# Mixpanel API Ruby Client Library
+#
+# Copyright (c) 2009+ Keolo Keagy
+# See LICENSE for details.
+#
+# Inspired by the official mixpanel php and python libraries.
+# http://mixpanel.com/api/docs/guides/api/
+
+require 'cgi'
+require 'digest/md5'
+require 'open-uri'
+require 'json' unless defined?(JSON)
+
+# Ruby library for the mixpanel.com web service
+class MixpanelClient
+  BASE_URI = 'http://mixpanel.com/api'
+  API_VERSION  = '2.0'
+
+  # The mixpanel client can be used to easily consume data through the mixpanel API
+  OPTIONS = [:resource, :event, :funnel, :name, :type, :unit, :interval, :limit, :format, :bucket]
+  attr_reader :uri
+  attr_accessor :api_key, :api_secret
+
+  OPTIONS.each do |option|
+    class_eval "
+      def #{option}(arg=nil)
+        arg ? @#{option} = arg : @#{option}
+      end
+    "
+  end
+
+  def initialize(config)
+    @api_key    = config['api_key']
+    @api_secret = config['api_secret']
+  end
+
+  def params
+    OPTIONS.inject({}) do |params, param|
+      option = send(param)
+      params.merge!(param => option) if param != :resource && !option.nil?
+      params
+    end
+  end
+
+  def request(&options)
+    reset_options
+    instance_eval(&options)
+    @uri = URI.mixpanel(resource, normalize_params(params))
+    response = URI.get(@uri)
+    to_hash(response)
+  end
+
+  def normalize_params(params)
+    params.merge!(
+      :api_key => @api_key,
+      :expire  => Time.now.to_i + 600 # Grant this request 10 minutes
+    ).merge!(:sig => generate_signature(params))
+  end
+
+  def generate_signature(args)
+    Digest::MD5.hexdigest(args.map{|key,val| "#{key}=#{val}"}.sort.join + api_secret)
+  end
+
+  def to_hash(data)
+    if @format == 'csv'
+      data
+    else
+      JSON.parse(data)
+    end
+  end
+
+  def reset_options
+    (OPTIONS - [:resource]).each do |option|
+      eval "remove_instance_variable(:@#{option}) if defined?(@#{option})"
+    end
+  end
+end

data/lib/mixpanel_client/mixpanel_client_uri.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby -Ku
+
+# Mixpanel API Ruby Client Library
+#
+# Copyright (c) 2009+ Keolo Keagy
+# See LICENSE for details.
+#
+# Inspired by the official mixpanel php and python libraries.
+# http://mixpanel.com/api/docs/guides/api/
+
+# URI related helpers
+class MixpanelClient::URI
+  # Create an http error class for us to use
+  class HTTPError < StandardError; end
+
+  def self.mixpanel(resource, params)
+    File.join([MixpanelClient::BASE_URI, MixpanelClient::API_VERSION, resource.to_s]) + "?#{self.encode(params)}"
+  end
+
+  def self.encode(params)
+    params.map{|key,val| "#{key}=#{CGI.escape(val.to_s)}"}.sort.join('&')
+  end
+
+  def self.get(uri)
+    ::URI.parse(uri).read
+  rescue OpenURI::HTTPError => error
+    raise HTTPError, JSON.parse(error.io.read)['error']
+  end
+end

data/lib/mixpanel_client/version.rb

@@ -0,0 +1,3 @@
+class MixpanelClient
+  VERSION = '1.0.0'
+end

data/lib/mixpanel_client.rb

@@ -1,101 +1,2 @@
-#!/usr/bin/env ruby -Ku
-
-# Mixpanel API Ruby Client Library
-#
-# Copyright (c) 2009+ Keolo Keagy
-# See LICENSE for details.
-#
-# Inspired by the official mixpanel php and python libraries.
-# http://mixpanel.com/api/docs/guides/api/
-
-require 'cgi'
-require 'digest/md5'
-require 'open-uri'
-require 'json' unless defined?(JSON)
-
-# Ruby library for the mixpanel.com web service
-module Mixpanel
-  BASE_URI = 'http://mixpanel.com/api'
-  VERSION  = '2.0'
-
-  # The mixpanel client can be used to easily consume data through the mixpanel API
-  class Client
-    OPTIONS = [:resource, :event, :funnel, :name, :type, :unit, :interval, :limit, :format, :bucket]
-    attr_reader :uri
-    attr_accessor :api_key, :api_secret
-
-    OPTIONS.each do |option|
-      class_eval "
-        def #{option}(arg=nil)
-          arg ? @#{option} = arg : @#{option}
-        end
-      "
-    end
-
-    def initialize(config)
-      @api_key    = config['api_key']
-      @api_secret = config['api_secret']
-    end
-
-    def params
-      OPTIONS.inject({}) do |params, param|
-        option = send(param)
-        params.merge!(param => option) if param != :resource && !option.nil?
-        params
-      end
-    end
-
-    def request(&options)
-      reset_options
-      instance_eval(&options)
-      @uri = URI.mixpanel(resource, normalize_params(params))
-      response = URI.get(@uri)
-      to_hash(response)
-    end
-
-    def normalize_params(params)
-      params.merge!(
-        :api_key => @api_key,
-        :expire  => Time.now.to_i + 600 # Grant this request 10 minutes
-      ).merge!(:sig => generate_signature(params))
-    end
-
-    def generate_signature(args)
-      Digest::MD5.hexdigest(args.map{|key,val| "#{key}=#{val}"}.sort.join + api_secret)
-    end
-
-    def to_hash(data)
-      if @format == 'csv'
-        data
-      else
-        JSON.parse(data)
-      end
-    end
-
-    def reset_options
-      (OPTIONS - [:resource]).each do |option|
-        eval "remove_instance_variable(:@#{option}) if defined?(@#{option})"
-      end
-    end
-  end
-
-  # URI related helpers
-  class URI
-    # Create an http error class for us to use
-    class HTTPError < StandardError; end
-
-    def self.mixpanel(resource, params)
-      File.join([BASE_URI, VERSION, resource.to_s]) + "?#{self.encode(params)}"
-    end
-
-    def self.encode(params)
-      params.map{|key,val| "#{key}=#{CGI.escape(val.to_s)}"}.sort.join('&')
-    end
-
-    def self.get(uri)
-      ::URI.parse(uri).read
-    rescue OpenURI::HTTPError => error
-      raise HTTPError, JSON.parse(error.io.read)['error']
-    end
-  end
-end
+require "#{File.dirname(__FILE__)}/mixpanel_client/mixpanel_client"
+require "#{File.dirname(__FILE__)}/mixpanel_client/mixpanel_client_uri"

data/mixpanel_client.gemspec

@@ -1,60 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'mixpanel_client/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{mixpanel_client}
-  s.version = "0.5.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Keolo Keagy"]
-  s.date = %q{2011-01-26}
+  s.name        = 'mixpanel_client'
+  s.version     = MixpanelClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Keolo Keagy']
+  s.email       = ['keolo@dreampointmedia.com']
+  s.homepage    = 'http://github.com/keolo/mixpanel_client' 
+  s.summary     = %q{Ruby Mixpanel API Client Library}
   s.description = %q{Simple ruby client interface to the Mixpanel API.}
-  s.email = %q{keolo@dreampointmedia.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "config/mixpanel.template.yml",
-    "lib/mixpanel_client.rb",
-    "mixpanel_client.gemspec",
-    "spec/events_externalspec.rb",
-    "spec/mixpanel_client_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/keolo/mixpanel_client}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Ruby Mixpanel API Client Library}
-  s.test_files = [
-    "spec/events_externalspec.rb",
-    "spec/mixpanel_client_spec.rb",
-    "spec/spec_helper.rb",
-    "test/manual.rb",
-    "test/test.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.rubyforge_project = 'mixpanel_client'
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 2.4.0"])
-      s.add_development_dependency(%q<webmock>, [">= 1.6.2"])
-    else
-      s.add_dependency(%q<rspec>, [">= 2.4.0"])
-      s.add_dependency(%q<webmock>, [">= 1.6.2"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 2.4.0"])
-    s.add_dependency(%q<webmock>, [">= 1.6.2"])
-  end
-end
+  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']
 
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('webmock')
+  s.add_development_dependency('metric_fu')
+end

data/spec/events_externalspec.rb

@@ -7,7 +7,7 @@ describe 'External calls to mixpanel' do
   before :all do
     config = YAML.load_file(File.dirname(__FILE__) + '/../config/mixpanel.yml')
     config.should_not be_nil
-    @client = Mixpanel::Client.new(config)
+    @client = MixpanelClient.new(config)
   end
 
   describe 'Events' do
@@ -17,7 +17,7 @@ describe 'External calls to mixpanel' do
           resource 'events'
         end
       }
-      data.should raise_error(Mixpanel::URI::HTTPError)
+      data.should raise_error(MixpanelClient::URI::HTTPError)
     end
 
     it 'should return events' do

data/spec/mixpanel_client_spec.rb

@@ -1,11 +1,12 @@
+# coding: utf-8
 require 'rubygems'
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe Mixpanel::Client do
+describe MixpanelClient do
   before :all do
     config = {'api_key' => 'test', 'api_secret' => 'test'}
-    @client = Mixpanel::Client.new(config)
-    @uri = Regexp.escape(Mixpanel::BASE_URI)
+    @client = MixpanelClient.new(config)
+    @uri = Regexp.escape(MixpanelClient::BASE_URI)
   end
 
   describe '#request' do
@@ -96,7 +97,7 @@ describe Mixpanel::Client do
         bucket    'list'
       end
 
-      Mixpanel::Client::OPTIONS.each do |option|
+      MixpanelClient::OPTIONS.each do |option|
         @client.send(option).should_not be_nil
       end
 
@@ -104,36 +105,36 @@ describe Mixpanel::Client do
         resource 'events/properties/top'
       end
 
-      (Mixpanel::Client::OPTIONS - [:resource]).each do |option|
+      (MixpanelClient::OPTIONS - [:resource]).each do |option|
         @client.send(option).should be_nil
       end
     end
   end
 end
 
-describe Mixpanel::URI do
+describe MixpanelClient::URI do
   describe '.mixpanel' do
     it 'should return a properly formatted mixpanel uri as a string (without an endpoint)' do
       resource, params  = ['events', {:c => 'see', :a => 'aye'}]
-      Mixpanel::URI.mixpanel(resource, params).should == 'http://mixpanel.com/api/2.0/events?a=aye&c=see'
+      MixpanelClient::URI.mixpanel(resource, params).should == 'http://mixpanel.com/api/2.0/events?a=aye&c=see'
     end
     it 'should return a properly formatted mixpanel uri as a string (with an endpoint)' do
       resource, params  = ['events/top', {:c => 'see', :a => 'aye'}]
-      Mixpanel::URI.mixpanel(resource, params).should == 'http://mixpanel.com/api/2.0/events/top?a=aye&c=see'
+      MixpanelClient::URI.mixpanel(resource, params).should == 'http://mixpanel.com/api/2.0/events/top?a=aye&c=see'
     end
   end
 
   describe '.encode' do
     it 'should return a string with url encoded values.' do
       params = {:hey => '!@#$%^&*()\/"Ü', :soo => "hëllö?"}
-      Mixpanel::URI.encode(params).should == 'hey=%21%40%23%24%25%5E%26%2A%28%29%5C%2F%22%C3%9C&soo=h%C3%ABll%C3%B6%3F'
+      MixpanelClient::URI.encode(params).should == 'hey=%21%40%23%24%25%5E%26%2A%28%29%5C%2F%22%C3%9C&soo=h%C3%ABll%C3%B6%3F'
     end
   end
 
   describe '.get' do
     it 'should return a string response' do
       stub_request(:get, 'http://example.com').to_return(:body => 'something')
-      Mixpanel::URI.get('http://example.com').should == 'something'
+      MixpanelClient::URI.get('http://example.com').should == 'something'
     end
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel_client
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
-  - 0
-  - 5
   - 1
-  version: 0.5.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Keolo Keagy
@@ -14,54 +15,73 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 -08:00
+date: 2011-03-12 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
-        - 2
-        - 4
         - 0
-        version: 2.4.0
+        version: "0"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
-        - 1
-        - 6
-        - 2
-        version: 1.6.2
+        - 0
+        version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: metric_fu
+  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 ruby client interface to the Mixpanel API.
-email: keolo@dreampointmedia.com
+email: 
+- keolo@dreampointmedia.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.md
+extra_rdoc_files: []
+
 files: 
 - .document
+- .gitignore
+- .rvmrc
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
 - config/mixpanel.template.yml
 - lib/mixpanel_client.rb
+- lib/mixpanel_client/mixpanel_client.rb
+- lib/mixpanel_client/mixpanel_client_uri.rb
+- lib/mixpanel_client/version.rb
 - mixpanel_client.gemspec
 - spec/events_externalspec.rb
 - spec/mixpanel_client_spec.rb
@@ -76,23 +96,27 @@ 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: 
-rubygems_version: 1.3.6
+rubyforge_project: mixpanel_client
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ruby Mixpanel API Client Library
@@ -100,5 +124,3 @@ test_files:
 - spec/events_externalspec.rb
 - spec/mixpanel_client_spec.rb
 - spec/spec_helper.rb
-- test/manual.rb
-- test/test.rb

data/VERSION

@@ -1 +0,0 @@
-0.5.1

data/test/manual.rb

@@ -1,58 +0,0 @@
-#!/usr/bin/env ruby
-
-# Notes:
-# Test URI.mixpanel in browser to see response and error codes.
-#
-# Pushing to rubygems.org
-# rake version:bump:patch
-# git commit ...
-# git push
-# rake release
-
-require 'rubygems'
-require "#{File.dirname(__FILE__)}/../lib/mixpanel_client"
-
-config = {'api_key' => 'e81de686c96261747fdc443d4809c297', 'api_secret' => '201ff82db5f1e8766b0004f0acf8d82e'}
-
-client = Mixpanel::Client.new(config)
-
-# Block form
-data = client.request do
-  resource 'events'
-  event    '["test-event"]'
-  unit     'hour'
-  interval  24
-  format   'csv'
-end
-
-puts
-puts client.inspect
-puts data.inspect
-puts
-
-# Block form
-data = client.request do
-  resource 'events/properties/top'
-  type     'general'
-  event    '["test-event"]'
-end
-
-puts
-puts client.inspect
-puts data.inspect
-puts
-
-# Bucket
-data = client.request do
-  resource 'events'
-  event    '["test-event"]'
-  type     'general'
-  unit     'hour'
-  interval  24
-  bucket   'test'
-end
-
-puts
-puts client.inspect
-puts data.inspect
-puts

data/test/test.rb

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-# Notes:
-# Test URI.mixpanel in browser to see response and error codes.
-#
-# Pushing to rubygems.org
-# rake version:bump:patch
-# git commit ...
-# git push
-# rake release
-
-require 'rubygems'
-require "#{File.dirname(__FILE__)}/../lib/mixpanel_client"
-
-config = YAML.load_file "#{File.dirname(__FILE__)}/../config/mixpanel.yml"
-client = Mixpanel::Client.new(config)
-
-data = client.request do
-  resource 'events'
-  event    '["test-event"]'
-  unit     'hour'
-  interval  24
-  format   'csv'
-end
-
-puts client.inspect
-puts data.inspect
-
-
-data = client.request do
-  resource 'events/top'
-  type     'general'
-end
-
-puts client.inspect
-puts data.inspect