mixpanel_client 0.5.0 → 0.5.1

data/README.md

@@ -8,61 +8,24 @@ Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool.
     gem install mixpanel_client
 
 
-## New Usage
+## Usage
 
     require 'rubygems'
     require 'mixpanel_client'
 
-    config = {'api_key' => 'changeme', 'api_secret' => 'changeme'}
+    client = Mixpanel::Client.new('api_key' => 'changeme', 'api_secret' => 'changeme')
 
-    client = Mixpanel::Client.new(config)
-
-    # Get all results for 'test-event' in the last 24 hours from the test bucket
     data = client.request do
-      resource 'events'
+      resource 'events/retention'
       event    '["test-event"]'
       type     'general'
       unit     'hour'
       interval  24
       bucket   'test'
     end
-    puts data.inspect
 
-    # Get the top property names for 'test-event'
-    data = client.request do
-      resource 'events/properties/top'
-      event    '["test-event"]'
-      type     'general'
-    end
     puts data.inspect
 
-
-## Old Usage (versions prior to 0.5.0)
-
-__NOTE: This old usage is deprecated and will be removed in future versions.__
-
-    require 'rubygems'
-    require 'mixpanel_client'
-
-    config = {:api_key => 'changeme', :api_secret => 'changeme'}
-
-    api = Mixpanel::Client.new(config)
-
-    # Example without an endpoint
-    data = api.request(nil, :events, {
-      :event    => '["test-event"]',
-      :unit     => 'hour',
-      :interval =>  24
-    })
-    puts data.inspect
-
-    # Example with an endpoint and method
-    data = api.request(:events, :top, {
-      :type    => 'general'
-    })
-    puts data.inspect
-
-
 ## Copyright
 
 Copyright (c) 2009+ Keolo Keagy. See LICENSE for details.

data/Rakefile

@@ -11,9 +11,8 @@ begin
     gem.email = 'keolo@dreampointmedia.com'
     gem.homepage = 'http://github.com/keolo/mixpanel_client'
     gem.authors = ['Keolo Keagy']
-    gem.add_development_dependency 'rspec', '>= 1.2.9'
-    gem.add_development_dependency 'cucumber', '>= 0'
-    gem.add_development_dependency 'webmock', '>= 1.3.5'
+    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
@@ -21,21 +20,21 @@ rescue LoadError
   puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color']
 end
 
 namespace :spec do
   desc 'Run all tests that depend on external dependencies'
-  Spec::Rake::SpecTask.new(:externals) do |t|
-    t.spec_files = FileList['spec/**/*_externalspec.rb']
+  RSpec::Core::RakeTask.new(:externals) do |t|
+    t.pattern = 'spec/**/*_externalspec.rb'
+    t.rspec_opts = ['--color']
   end
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
 end

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/mixpanel_client.rb

@@ -39,34 +39,28 @@ module Mixpanel
 
     def params
       OPTIONS.inject({}) do |params, param|
-        params.merge!(param => send(param)) if param != :resource && !send(param).nil?
+        option = send(param)
+        params.merge!(param => option) if param != :resource && !option.nil?
         params
       end
     end
 
-    def request(deprecated_endpoint=nil, deprecated_meth=nil, deprecated_params=nil, &options)
+    def request(&options)
       reset_options
-      if block_given?
-        instance_eval &options
-        @uri = URI.mixpanel(resource, normalize_params(params))
-        response = URI.get(@uri)
-        to_hash(response)
-      else
-        warn 'This usage is deprecated. Please use the new block form (see README).'
-        @uri = URI.deprecated_mixpanel(deprecated_endpoint, deprecated_meth, normalize_params(deprecated_params))
-        response = URI.get(@uri)
-        to_hash(response)
-      end
+      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 => hash_args(params))
+      ).merge!(:sig => generate_signature(params))
     end
 
-    def hash_args(args)
+    def generate_signature(args)
       Digest::MD5.hexdigest(args.map{|key,val| "#{key}=#{val}"}.sort.join + api_secret)
     end
 
@@ -87,12 +81,9 @@ module Mixpanel
 
   # URI related helpers
   class URI
+    # Create an http error class for us to use
     class HTTPError < StandardError; end
 
-    def self.deprecated_mixpanel(endpoint, meth, params)
-      File.join([BASE_URI, VERSION, endpoint.to_s, meth.to_s].reject(&:empty?)) + "?#{self.encode(params)}"
-    end
-
     def self.mixpanel(resource, params)
       File.join([BASE_URI, VERSION, resource.to_s]) + "?#{self.encode(params)}"
     end

data/mixpanel_client.gemspec

@@ -1,50 +1,44 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{mixpanel_client}
-  s.version = "0.5.0"
+  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{2010-10-14}
+  s.date = %q{2011-01-26}
   s.description = %q{Simple ruby client interface to the Mixpanel API.}
   s.email = %q{keolo@dreampointmedia.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md"
+    "README.md"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "config/mixpanel.template.yml",
-     "features/mixpanel_client.feature",
-     "features/step_definitions/mixpanel_client_steps.rb",
-     "features/support/env.rb",
-     "lib/mixpanel_client.rb",
-     "mixpanel_client.gemspec",
-     "spec/events_externalspec.rb",
-     "spec/mixpanel_client_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+    "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.rdoc_options = ["--charset=UTF-8"]
   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"
+    "spec/mixpanel_client_spec.rb",
+    "spec/spec_helper.rb",
+    "test/manual.rb",
+    "test/test.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -52,18 +46,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_development_dependency(%q<cucumber>, [">= 0"])
-      s.add_development_dependency(%q<webmock>, [">= 1.3.5"])
+      s.add_development_dependency(%q<rspec>, [">= 2.4.0"])
+      s.add_development_dependency(%q<webmock>, [">= 1.6.2"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<cucumber>, [">= 0"])
-      s.add_dependency(%q<webmock>, [">= 1.3.5"])
+      s.add_dependency(%q<rspec>, [">= 2.4.0"])
+      s.add_dependency(%q<webmock>, [">= 1.6.2"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<cucumber>, [">= 0"])
-    s.add_dependency(%q<webmock>, [">= 1.3.5"])
+    s.add_dependency(%q<rspec>, [">= 2.4.0"])
+    s.add_dependency(%q<webmock>, [">= 1.6.2"])
   end
 end
 

data/spec/mixpanel_client_spec.rb

@@ -9,17 +9,17 @@ describe Mixpanel::Client do
   end
 
   describe '#request' do
-    it 'should return json and convert to a ruby hash' do
+    it 'should return an argument error "Wrong number of arguments" if using the deprecated usage' do
       # Stub Mixpanel request
       stub_request(:get, /^#{@uri}.*/).to_return(:body => '{"legend_size": 0, "data": {"series": [], "values": {}}}')
 
-      data = @client.request(nil, :events, {
+      data = lambda{@client.request(nil, :events, {
         :event    => '["test-event"]',
         :unit     => 'hour',
         :interval =>  24
-      })
+      })}
 
-      data.should == {"data"=>{"series"=>[], "values"=>{}}, "legend_size"=>0}
+      data.should raise_error(ArgumentError)
     end
   end
 
@@ -49,13 +49,26 @@ describe Mixpanel::Client do
       end
       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
     it 'should return a hashed string alpha sorted by key names.' do
       args              = {:c => 'see', :a => 'aye', :d => 'dee', :b => 'bee'}
       args_alpha_sorted = {:a => 'aye', :b => 'bee', :c => 'see', :d => 'dee'}
-      @client.hash_args(args).should == @client.hash_args(args_alpha_sorted)
+      @client.generate_signature(args).should == @client.generate_signature(args_alpha_sorted)
     end
   end
 
@@ -99,17 +112,6 @@ describe Mixpanel::Client do
 end
 
 describe Mixpanel::URI do
-  describe '.deprecated_mixpanel' do
-    it 'should return a properly formatted mixpanel uri as a string (without an endpoint)' do
-      endpoint, meth, params  = [:events, nil, {:c => 'see', :a => 'aye'}]
-      Mixpanel::URI.deprecated_mixpanel(endpoint, meth, 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
-      endpoint, meth, params  = [:events, :top, {:c => 'see', :a => 'aye'}]
-      Mixpanel::URI.deprecated_mixpanel(endpoint, meth, params).should == 'http://mixpanel.com/api/2.0/events/top?a=aye&c=see'
-    end
-  end
-
   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'}]

data/spec/spec_helper.rb

@@ -1,10 +1,8 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'mixpanel_client'
-require 'spec'
-require 'spec/autorun'
 require 'webmock/rspec'
 
-Spec::Runner.configure do |config|
-  config.include WebMock
+RSpec.configure do |config|
+  config.include WebMock::API
 end

data/test/manual.rb

@@ -11,7 +11,6 @@
 
 require 'rubygems'
 require "#{File.dirname(__FILE__)}/../lib/mixpanel_client"
-#require 'mixpanel_client'
 
 config = {'api_key' => 'e81de686c96261747fdc443d4809c297', 'api_secret' => '201ff82db5f1e8766b0004f0acf8d82e'}
 
@@ -31,18 +30,6 @@ puts client.inspect
 puts data.inspect
 puts
 
-# Argument form
-data = client.request(nil, :events, {
-  :event    => '["test-event"]',
-  :unit     => 'hour',
-  :interval =>  24,
-})
-
-puts
-puts client.inspect
-puts data.inspect
-puts
-
 # Block form
 data = client.request do
   resource 'events/properties/top'
@@ -55,17 +42,6 @@ puts client.inspect
 puts data.inspect
 puts
 
-# Argument form
-data = client.request(:events, :top, {
-  :type => 'general',
-  #:format => :csv
-})
-
-puts
-puts client.inspect
-puts data.inspect
-puts
-
 # Bucket
 data = client.request do
   resource 'events'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Keolo Keagy
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-14 00:00:00 -07:00
+date: 2011-01-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,38 +25,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
         - 2
-        - 9
-        version: 1.2.9
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: cucumber
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
+        - 4
         - 0
-        version: "0"
+        version: 2.4.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 1
-        - 3
-        - 5
-        version: 1.3.5
+        - 6
+        - 2
+        version: 1.6.2
   type: :development
-  version_requirements: *id003
+  version_requirements: *id002
 description: Simple ruby client interface to the Mixpanel API.
 email: keolo@dreampointmedia.com
 executables: []
@@ -68,28 +56,23 @@ extra_rdoc_files:
 - README.md
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - config/mixpanel.template.yml
-- features/mixpanel_client.feature
-- features/step_definitions/mixpanel_client_steps.rb
-- features/support/env.rb
 - lib/mixpanel_client.rb
 - mixpanel_client.gemspec
 - spec/events_externalspec.rb
 - spec/mixpanel_client_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/keolo/mixpanel_client
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

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

data/features/mixpanel_client.feature

@@ -1,9 +0,0 @@
-Feature: something something
-  In order to something something
-  A user something something
-  something something something
-
-  Scenario: something something
-    Given inspiration
-    When I create a sweet new gem
-    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -1,4 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'mixpanel_client'
-
-require 'spec/expectations'

data/spec/spec.opts

@@ -1 +0,0 @@
---color