mixpanel_client 2.2.3 → 3.0.0

data/README.md

@@ -17,27 +17,27 @@ or if you use a Gemfile
     require 'rubygems'
     require 'mixpanel_client'
 
-    config = {'api_key' => 'changeme', 'api_secret' => 'changeme'}
+    config = {api_key: 'changeme', api_secret: 'changeme'}
     client = Mixpanel::Client.new(config)
 
-    data = client.request do
+    data = client.request('events/properties', {
       # Available options
-      resource  'events/properties'
-      event     '["test-event"]'
-      name      'hello'
-      values    '["uno", "dos"]'
-      timezone  '-8'
-      type      'general'
-      unit      'hour'
-      interval   24
-      limit      5
-      bucket    'contents'
-      from_date '2011-08-11'
-      to_date   '2011-08-12'
-      on        'properties["product_id"]'
-      where     '1 in properties["product_id"]'
-      buckets   '5'
-    end
+      event:     '["test-event"]',
+      name:      'hello',
+      values:    '["uno", "dos"]',
+      timezone:  '-8',
+      type:      'general',
+      unit:      'hour',
+      interval:   24,
+      limit:      5,
+      bucket:    'contents',
+      from_date: '2011-08-11',
+      to_date:   '2011-08-12',
+      on:        'properties["product_id"]',
+      where:     '1 in properties["product_id"]',
+      buckets:   '5',
+      # etc.
+    })
 
     puts data.inspect
 
@@ -74,6 +74,10 @@ Create tag v2.0.2 and build and push mixpanel_client-2.0.2.gem to Rubygems
 
 ## Changelog
 
+### v.3.0.0
+ * NOTE: This version breaks backwards compatibility.
+ * Use a regular ruby hash instead of metaprogramming for mixpanel options.
+
 ### v.2.2.3
  * 	Added some more options.
 

data/lib/mixpanel/client.rb

@@ -15,20 +15,6 @@ module Mixpanel
     attr_reader   :uri
     attr_accessor :api_key, :api_secret
 
-    # Available options for a Mixpanel API request
-    OPTIONS = [:resource, :event, :events, :funnel_id, :name, :type, :unit, :interval, :length, :limit,
-               :format, :bucket, :values, :from_date, :to_date, :on, :where, :buckets, :timezone,
-               :retention_type, :interval_count, :born_event, :born_where]
-
-    # Dynamically define accessor methods for each option
-    OPTIONS.each do |option|
-      class_eval "
-        def #{option}(arg=nil)
-          arg ? @#{option} = arg : @#{option}
-        end
-      "
-    end
-
     # Configure the client
     #
     # @example
@@ -37,31 +23,30 @@ module Mixpanel
     #
     # @param [Hash] config consisting of an 'api_key' and an 'api_secret'
     def initialize(config)
-      @api_key    = config['api_key']
-      @api_secret = config['api_secret']
+      @api_key    = config[:api_key]
+      @api_secret = config[:api_secret]
     end
 
     # Return mixpanel data as a JSON object or CSV string
     #
     # @example
-    #   data = client.request do
-    #     resource 'events/properties'
-    #     event    '["test-event"]'
-    #     name     'hello'
-    #     values   '["uno", "dos"]'
-    #     type     'general'
-    #     unit     'hour'
-    #     interval  24
-    #     limit     5
-    #     bucket   'contents'
-    #   end
+    #   data = client.request('events/properties', {
+    #     event:    '["test-event"]',
+    #     name:     'hello',
+    #     values:   '["uno", "dos"]',
+    #     type:     'general',
+    #     unit:     'hour',
+    #     interval:  24,
+    #     limit:     5,
+    #     bucket:   'contents'
+    #   })
     #
-    # @param  [Block] options variables used to make a specific request for mixpanel data
-    # @return [JSON, String] mixpanel response as a JSON object or CSV string
-    def request(&options)
-      reset_options
-      instance_eval(&options)
-      @uri = URI.mixpanel(resource, normalize_params(params))
+    # @resource [String] mixpanel api resource endpoint
+    # @options  [Hash] options variables used to make a specific request for mixpanel data
+    # @return   [JSON, String] mixpanel response as a JSON object or CSV string
+    def request(resource, options)
+      @format = options[:format] || :json
+      @uri = URI.mixpanel(resource, normalize_options(options))
       response = URI.get(@uri)
       response = %Q|[#{response.split("\n").join(',')}]| if resource == 'export'
       Utils.to_hash(response, @format)
@@ -69,33 +54,15 @@ module Mixpanel
 
     private
 
-    # Reset options so we can reuse the Mixpanel::Client object without the options persisting
-    # between requests
-    def reset_options
-      (OPTIONS - [:resource]).each do |option|
-        eval "remove_instance_variable(:@#{option}) if defined?(@#{option})"
-      end
-    end
-
-    # Return a hash of options for a given request
-    #
-    # @return [Hash] collection of options passed in from the request method
-    def params
-      OPTIONS.inject({}) do |params, param|
-        option = send(param)
-        params.merge!(param => option) if param != :resource && !option.nil?
-        params
-      end
-    end
-
     # Return a hash of options along with defaults and a generated signature
     #
     # @return [Hash] collection of options including defaults and generated signature
-    def normalize_params(params)
-      params.merge!(
+    def normalize_options(options)
+      options.merge!(
+        :format  => @format,
         :api_key => @api_key,
         :expire  => Time.now.to_i + 600 # Grant this request 10 minutes
-      ).merge!(:sig => Utils.generate_signature(params, @api_secret))
+      ).merge!(:sig => Utils.generate_signature(options, @api_secret))
     end
 
     def self.base_uri_for_resource(resource)

data/lib/mixpanel/version.rb

@@ -10,6 +10,6 @@ module Mixpanel
   # Return metrics from Mixpanel Data API
   class Client
     # Mixpanel::Client library version
-    VERSION = '2.2.3'
+    VERSION = '3.0.0'
   end
 end

data/mixpanel_client.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency('json', '~> 1.6') if RUBY_VERSION < '1.9'
-  s.add_development_dependency('bundler', '>=1.0.21')
+  s.add_development_dependency('bundler', '>=1.2')
   s.add_development_dependency('rake',    '>=0.9.2.2')
   s.add_development_dependency('rdoc',    '>=3.11')
   s.add_development_dependency('rspec',   '>=2.5.0')

data/spec/mixpanel_client/events_externalspec.rb

@@ -12,90 +12,81 @@ describe 'External calls to mixpanel' do
   context 'when requesting events' do
     it 'should raise an error for bad requests' do
       data = lambda {
-        @client.request do
-          resource 'events'
-        end
+        @client.request('events', {})
       }
       data.should raise_error(Mixpanel::HTTPError)
     end
 
     it 'should return events' do
-      data = @client.request do
-        resource 'events'
-        event    '["test-event"]'
-        type     'general'
-        unit     'hour'
-        interval  24
-      end
+      data = @client.request('events', {
+        :event    => '["test-event"]',
+        :type     => 'general',
+        :unit     => 'hour',
+        :interval =>  24
+      })
       data.should_not be_a Exception
     end
 
     it 'should return events in csv format' do
-      data = @client.request do
-        resource 'events'
-        event    '["test-event"]'
-        type     'general'
-        unit     'hour'
-        interval  24
-        format   'csv'
-      end
+      data = @client.request('events', {
+        :event    => '["test-event"]',
+        :type     => 'general',
+        :unit     => 'hour',
+        :interval =>  24,
+        :format   => 'csv'
+      })
       data.should_not be_a Exception
     end
 
     it 'should return events with optional bucket' do
-      data = @client.request do
-        resource 'events'
-        event    '["test-event"]'
-        type     'general'
-        unit     'hour'
-        interval  24
-        bucket   'test'
-      end
+      data = @client.request('events', {
+        :event    => '["test-event"]',
+        :type     => 'general',
+        :unit     => 'hour',
+        :interval =>  24,
+        :bucket   => 'test'
+      })
       data.should_not be_a Exception
     end
 
     it 'should return top events' do
-      data = @client.request do
-        resource 'events/top'
-        type     'general'
-        limit    10
-      end
+      data = @client.request('events/top', {
+        :type     => 'general',
+        :limit    => 10
+      })
       data.should_not be_a Exception
     end
 
     it 'should return names' do
-      data = @client.request do
-        resource 'events/names'
-        type     'general'
-        unit     'hour'
-        interval  24
-        limit    10
-      end
+      data = @client.request('events/names', {
+        :type     => 'general',
+        :unit     => 'hour',
+        :interval =>  24,
+        :limit    => 10
+      })
       data.should_not be_a Exception
     end
 
     it 'should return retention' do
       pending 'Retention now has its own endpoint.'
-      data = @client.request do
-        resource 'events/retention'
-        event    '["test-event"]'
-        type     'general'
-        unit     'hour'
-        interval  24
-      end
+      data = @client.request('events/retention', {
+        :event    => '["test-event"]',
+        :type     => 'general',
+        :unit     => 'hour',
+        :interval =>  24
+      })
       data.should_not be_a Exception
     end
 
     it 'should return retention in csv format' do
       pending 'Retention now has its own endpoint.'
-      data = @client.request do
-        resource 'events/retention'
-        event    '["test-event"]'
-        type     'general'
-        unit     'hour'
-        interval  24
-        format   'csv'
-      end
+      data = @client.request('events/retention', {
+        :event    => '["test-event"]',
+        :type     => 'general',
+        :unit     => 'hour',
+        :interval =>  24,
+        :format   => 'csv'
+      })
       data.should_not be_a Exception
     end
   end

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Mixpanel::Client do
   before :all do
-    @client = Mixpanel::Client.new('api_key' => 'test_key', 'api_secret' => 'test_secret')
+    @client = Mixpanel::Client.new(:api_key => 'test_key', :api_secret => 'test_secret')
     @uri = Regexp.escape(Mixpanel::Client::BASE_URI)
   end
 
@@ -32,12 +32,11 @@ describe Mixpanel::Client do
       stub_request(:get, /^#{@uri}.*/).to_return(:body => '{"legend_size": 0, "data": {"series": [], "values": {}}}')
 
       # No endpoint
-      data = @client.request do
-        resource 'events'
-        event    '["test-event"]'
-        unit     'hour'
-        interval  24
-      end
+      data = @client.request('events', {
+        :event    => '["test-event"]',
+        :unit     => 'hour',
+        :interval => 24
+      })
       data.should == {"data"=>{"series"=>[], "values"=>{}}, "legend_size"=>0}
     end
 
@@ -46,25 +45,11 @@ describe Mixpanel::Client do
       stub_request(:get, /^#{@uri}.*/).to_return(:body => '{"events": [], "type": "general"}')
 
       # With endpoint
-      data = @client.request do
-        resource 'events/top'
-        type     'general'
-      end
+      data = @client.request('events/top', {
+        :type => 'general'
+      })
       data.should == {"events"=>[], "type"=>"general"}
     end
-
-    it 'should create getter methods for given options' do
-      @client.resource.should == 'events/top'
-      @client.type.should     == 'general'
-    end
-
-    it 'should create setter methods for given options' do
-      @client.resource 'hi'
-      @client.resource.should == 'hi'
-
-      @client.type 'ok'
-      @client.type.should == 'ok'
-    end
   end
 
   describe '#hash_args' do
@@ -77,53 +62,7 @@ describe Mixpanel::Client do
 
   describe '#to_hash' do
     it 'should return a ruby hash given json as a string' do
-      Mixpanel::Client::Utils.to_hash('{"a" : "ey", "b" : "bee"}', @client.format).should == {'a' => 'ey', 'b' => 'bee'}
-    end
-  end
-
-  context 'when resetting options for each request' do
-    it 'should reset options before each request' do
-      # Stub Mixpanel request
-      stub_request(:get, /^#{@uri}.*/).to_return(:body => '{"events": [], "type": "general"}')
-
-      @client.request do
-        # This is not a real request. It just lists all possible options.
-        resource       'events'
-        event          '["test-event"]'
-        funnel_id      'down-the-rabbit-hole'
-        name           'ricky-bobby'
-        type           'A'
-        unit           'hour'
-        interval       24
-        length         1
-        limit          5
-        format         'csv'
-        bucket         'list'
-        values         '["tiger", "blood"]'
-				timezone	     '-8'
-        from_date      '2011-08-11'
-        to_date        '2011-08-12'
-        on             'properties["product_id"]'
-        where          '1 in properties["product_id"]'
-        buckets        '5'
-        events         [{"event" => "page:view"}, {"event" => "button:click"}].to_json
-        retention_type 'abc'
-        born_event     'test-event'
-        born_where     '1 in properties["product_id"]'
-        interval_count 'def'
-      end
-
-      Mixpanel::Client::OPTIONS.each do |option|
-        @client.send(option).should_not be_nil, "#{option} option was nil"
-      end
-
-      @client.request do
-        resource 'events/properties/top'
-      end
-
-      (Mixpanel::Client::OPTIONS - [:resource]).each do |option|
-        @client.send(option).should be_nil
-      end
+      Mixpanel::Client::Utils.to_hash('{"a" : "ey", "b" : "bee"}', :json).should == {'a' => 'ey', 'b' => 'bee'}
     end
   end
 end

data/spec/mixpanel_client/properties_externalspec.rb

@@ -12,25 +12,22 @@ describe 'External calls to mixpanel' do
   context 'when requesting event properties' do
     it 'should raise an error for bad requests' do
       data = lambda {
-        @client.request do
-          resource 'properties'
-        end
+        @client.request('properties', {})
       }
       data.should raise_error(Mixpanel::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 = @client.request('events/properties', {
+        :event    => '["test-event"]',
+        :name     => 'hello',
+        :values   => '["uno", "dos"]',
+        :type     => 'general',
+        :unit     => 'hour',
+        :interval =>  24,
+        :limit    =>  5,
+        :bucket   => 'kicked'
+      })
       data.should_not be_a Exception
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel_client
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
-  - 2
-  - 2
   - 3
-  version: 2.2.3
+  - 0
+  - 0
+  version: 3.0.0
 platform: ruby
 authors: 
 - Keolo Keagy
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-20 00:00:00 -07:00
-default_executable: 
+date: 2012-09-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -41,12 +40,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 61
+        hash: 11
         segments: 
         - 1
-        - 0
-        - 21
-        version: 1.0.21
+        - 2
+        version: "1.2"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -144,7 +142,6 @@ files:
 - spec/mixpanel_client/properties_externalspec.rb
 - spec/mixpanel_client/uri_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/keolo/mixpanel_client
 licenses: []
 
@@ -174,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: mixpanel_client
-rubygems_version: 1.6.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby Mixpanel API Client Library