mixpanel_client 1.0.1 → 2.0.0.beta1

data/.gitignore

@@ -11,6 +11,7 @@ tmtags
 .\#*
 
 ## VIM
+*.swo
 *.swp
 
 ## PROJECT::GENERAL

data/README.md

@@ -7,27 +7,35 @@ Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool.
 
     gem install mixpanel_client
 
-
 ## Usage
 
     require 'rubygems'
     require 'mixpanel_client'
 
-    client = MixpanelClient.new('api_key' => 'changeme', 'api_secret' => 'changeme')
+    client = Mixpanel::Client.new('api_key' => 'changeme', 'api_secret' => 'changeme')
 
     data = client.request do
-      resource 'events/retention'
+      resource 'events/properties'
       event    '["test-event"]'
+      name     'hello'
+      values   '["uno", "dos"]'
       type     'general'
       unit     'hour'
       interval  24
-      bucket   'test'
+      limit     5
+      bucket   'kicked'
     end
 
     puts data.inspect
 
 ## Changelog
 
+### 2.0.0.beta1
+ * Reverted to namespacing via module name because it's a better practice.
+   I.e. Use `Mixpanel::Client` instead of `MixpanelClient`.
+ * Added 'values' as an optional parameter
+ * `gem install mixpanel_client --pre`
+
 ### 1.0.1
  * Minor housekeeping and organizing
  * Refactored specs

data/lib/mixpanel/client.rb

@@ -0,0 +1,81 @@
+#!/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
+  class Client
+    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, :values]
+    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
+end

data/lib/mixpanel/exceptions.rb

@@ -0,0 +1,4 @@
+# Define exceptions for this library
+module Mixpanel
+  class URI::HTTPError < StandardError; end
+end

data/lib/{mixpanel_client → mixpanel}/uri.rb

@@ -9,12 +9,9 @@
 # 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
-
+class Mixpanel::URI
   def self.mixpanel(resource, params)
-    File.join([MixpanelClient::BASE_URI, MixpanelClient::API_VERSION, resource.to_s]) + "?#{self.encode(params)}"
+    File.join([Mixpanel::Client::BASE_URI, Mixpanel::Client::API_VERSION, resource.to_s]) + "?#{self.encode(params)}"
   end
 
   def self.encode(params)

data/lib/mixpanel/version.rb

@@ -0,0 +1,6 @@
+# Set version number for mixpanel_client
+module Mixpanel
+  class Client
+    VERSION = '2.0.0.beta1'
+  end
+end

data/lib/mixpanel_client.rb

@@ -1,2 +1,3 @@
-require "#{File.dirname(__FILE__)}/mixpanel_client/mixpanel_client"
-require "#{File.dirname(__FILE__)}/mixpanel_client/uri"
+require "#{File.dirname(__FILE__)}/mixpanel/client"
+require "#{File.dirname(__FILE__)}/mixpanel/uri"
+require "#{File.dirname(__FILE__)}/mixpanel/exceptions"

data/mixpanel_client.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
-require 'mixpanel_client/version'
+require 'mixpanel/version'
 
 Gem::Specification.new do |s|
   s.name        = 'mixpanel_client'
-  s.version     = MixpanelClient::VERSION
+  s.version     = Mixpanel::Client::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Keolo Keagy']
   s.email       = ['keolo@dreampointmedia.com']
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_development_dependency('rspec', '>=2.5.0')
-  s.add_development_dependency('webmock', '>=1.6.2')
+  s.add_development_dependency('rspec',     '>=2.5.0')
+  s.add_development_dependency('webmock',   '>=1.6.2')
   s.add_development_dependency('metric_fu', '>=2.1.1')
 end

data/spec/mixpanel_client/events_externalspec.rb

@@ -6,7 +6,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 = MixpanelClient.new(config)
+    @client = Mixpanel::Client.new(config)
   end
 
   context 'when requesting events' do
@@ -16,7 +16,7 @@ describe 'External calls to mixpanel' do
           resource 'events'
         end
       }
-      data.should raise_error(MixpanelClient::URI::HTTPError)
+      data.should raise_error(Mixpanel::URI::HTTPError)
     end
 
     it 'should return events' do

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -1,10 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe MixpanelClient do
+describe Mixpanel::Client do
   before :all do
     config = {'api_key' => 'test', 'api_secret' => 'test'}
-    @client = MixpanelClient.new(config)
-    @uri = Regexp.escape(MixpanelClient::BASE_URI)
+    @client = Mixpanel::Client.new(config)
+    @uri = Regexp.escape(Mixpanel::Client::BASE_URI)
   end
 
   context 'when making an invalid request' do
@@ -86,15 +86,16 @@ describe MixpanelClient do
         event    '["test-event"]'
         funnel   'down-the-rabbit-hole'
         name     'ricky-bobby'
-        type     'tall-dark-handsome'
+        type     'A'
         unit     'hour'
         interval  24
         limit     5
         format    'csv'
         bucket    'list'
+        values    '["tiger", "blood"]'
       end
 
-      MixpanelClient::OPTIONS.each do |option|
+      Mixpanel::Client::OPTIONS.each do |option|
         @client.send(option).should_not be_nil
       end
 
@@ -102,7 +103,7 @@ describe MixpanelClient do
         resource 'events/properties/top'
       end
 
-      (MixpanelClient::OPTIONS - [:resource]).each do |option|
+      (Mixpanel::Client::OPTIONS - [:resource]).each do |option|
         @client.send(option).should be_nil
       end
     end

data/spec/mixpanel_client/properties_externalspec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+WebMock.allow_net_connect!
+
+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)
+  end
+
+  context 'when requesting event properties' do
+    it 'should raise an error for bad requests' do
+      data = lambda {
+        @client.request do
+          resource 'properties'
+        end
+      }
+      data.should raise_error(Mixpanel::URI::HTTPError)
+    end
+
+    it 'should return events' do
+      data = @client.request do
+        resource 'events/properties'
+        event    '["test-event"]'
+        name     'hello'
+        values   '["uno", "dos"]'
+        type     'general'
+        unit     'hour'
+        interval  24
+        limit     5
+        bucket   'kicked'
+      end
+      data.should_not be_a Exception
+    end
+  end
+end

data/spec/mixpanel_client/uri_spec.rb

@@ -1,29 +1,29 @@
 # coding: utf-8
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe MixpanelClient::URI do
+describe Mixpanel::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 => 'ey'}]
-      MixpanelClient::URI.mixpanel(resource, params).should == 'http://mixpanel.com/api/2.0/events?a=ey&c=see'
+      Mixpanel::URI.mixpanel(resource, params).should == 'http://mixpanel.com/api/2.0/events?a=ey&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 => 'ey'}]
-      MixpanelClient::URI.mixpanel(resource, params).should == 'http://mixpanel.com/api/2.0/events/top?a=ey&c=see'
+      Mixpanel::URI.mixpanel(resource, params).should == 'http://mixpanel.com/api/2.0/events/top?a=ey&c=see'
     end
   end
 
   describe '.encode' do
     it 'should return a string with url encoded values.' do
       params = {:hey => '!@#$%^&*()\/"Ü', :soo => "hëllö?"}
-      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'
+      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'
     end
   end
 
   describe '.get' do
     it 'should return a string response' do
       stub_request(:get, 'http://example.com').to_return(:body => 'something')
-      MixpanelClient::URI.get('http://example.com').should == 'something'
+      Mixpanel::URI.get('http://example.com').should == 'something'
     end
   end
 end

metadata

@@ -1,13 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel_client
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: 
+  hash: 62196449
+  prerelease: 6
   segments: 
-  - 1
+  - 2
+  - 0
   - 0
+  - beta
   - 1
-  version: 1.0.1
+  version: 2.0.0.beta1
 platform: ruby
 authors: 
 - Keolo Keagy
@@ -15,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-14 00:00:00 -07:00
+date: 2011-05-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,13 +86,15 @@ files:
 - README.md
 - Rakefile
 - config/mixpanel.template.yml
+- lib/mixpanel/client.rb
+- lib/mixpanel/exceptions.rb
+- lib/mixpanel/uri.rb
+- lib/mixpanel/version.rb
 - lib/mixpanel_client.rb
-- lib/mixpanel_client/mixpanel_client.rb
-- lib/mixpanel_client/uri.rb
-- lib/mixpanel_client/version.rb
 - mixpanel_client.gemspec
 - spec/mixpanel_client/events_externalspec.rb
 - spec/mixpanel_client/mixpanel_client_spec.rb
+- spec/mixpanel_client/properties_externalspec.rb
 - spec/mixpanel_client/uri_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -114,12 +118,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: mixpanel_client
@@ -130,5 +136,6 @@ summary: Ruby Mixpanel API Client Library
 test_files: 
 - spec/mixpanel_client/events_externalspec.rb
 - spec/mixpanel_client/mixpanel_client_spec.rb
+- spec/mixpanel_client/properties_externalspec.rb
 - spec/mixpanel_client/uri_spec.rb
 - spec/spec_helper.rb

data/lib/mixpanel_client/mixpanel_client.rb

@@ -1,79 +0,0 @@
-#!/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/version.rb

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