mixpanel_client 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/mixpanel_client.rb

@@ -3,7 +3,7 @@
 # Mixpanel API Ruby Client Library
 #
 # Copyright (c) 2009+ Keolo Keagy
-# MIT License http://www.opensource.org/licenses/mit-license.php
+# See LICENSE for details.
 # Open sourced by the good folks at SharesPost.com
 #
 # Inspired by the official mixpanel php and python libraries.
@@ -12,6 +12,7 @@
 require 'cgi'
 require 'digest/md5'
 require 'open-uri'
+require 'rubygems'
 require 'json'
 
 module Mixpanel
@@ -22,11 +23,11 @@ module Mixpanel
     VERSION  = '1.0'
 
     def initialize(config)
-      @api_key = config[:api_key]
+      @api_key    = config[:api_key]
       @api_secret = config[:api_secret]
     end
 
-    def request(endpoint, method, params)
+    def request(endpoint, meth, params)
       params[:api_key]  = api_key
       params[:expire]   = Time.now.to_i + 600 # Grant this request 10 minutes
       params[:format] ||= :json
@@ -34,7 +35,7 @@ module Mixpanel
 
       @format = params[:format]
 
-      response = URI.parse("#{BASE_URI}/#{endpoint}/#{VERSION}/#{method}?#{urlencode(params)}").read
+      response = URI.parse(mixpanel_uri(endpoint, meth, params)).read
       to_hash(response)
     end
 
@@ -42,15 +43,20 @@ module Mixpanel
       Digest::MD5.hexdigest(args.map{|k,v| "#{k}=#{v}"}.sort.to_s + api_secret)
     end
 
+    def mixpanel_uri(endpoint, meth, params)
+      %Q(#{BASE_URI}/#{endpoint}/#{VERSION}/#{meth}?#{urlencode(params)})
+    end
+
     def urlencode(params)
-      params.map{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
+      params.map{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.sort.join('&')
     end
 
-    def to_hash(data)
-      case @format
-      when :json
-        JSON.parse(data)
+    protected
+      def to_hash(data)
+        case @format
+        when :json
+          JSON.parse(data)
+        end
       end
-    end
   end
 end

data/mixpanel_client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mixpanel_client}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Keolo Keagy"]
-  s.date = %q{2009-11-10}
+  s.date = %q{2009-12-02}
   s.description = %q{Simple ruby client interface to the Mixpanel API.}
   s.email = %q{keolo@dreampointmedia.com}
   s.extra_rdoc_files = [

data/spec/mixpanel_client_spec.rb

@@ -1,7 +1,42 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "MixpanelClient" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe 'Mixpanel::Client' do
+  before :all do
+    config = {:api_key => 'test', :api_secret => 'test'}
+    @api = Mixpanel::Client.new(config)
+  end
+
+  describe '#request' do
+    it 'should return a valid JSON result set.' do
+      pending 'Need to setup valid Mixpanel test account.'
+      data = @api.request(:events, :general, {
+        :event    => '["test-event"]',
+        :unit     => 'hour',
+        :interval =>  24
+      })
+      data.should == {:some => 'thing'}
+    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'}
+      @api.hash_args(args).should == @api.hash_args(args_alpha_sorted)
+    end
+  end
+
+  describe '#mixpanel_uri' do
+    it 'should return a properly formatted mixpanel uri as a string' do
+      endpoint, meth, params  = [:events, :general, {:c => 'see', :a => 'aye'}]
+      @api.mixpanel_uri(endpoint, meth, params).should == 'http://mixpanel.com/api/events/1.0/general?a=aye&c=see'
+    end
+  end
+
+  describe '#urlencode' do
+    it 'should return a string with url encoded values.' do
+      params = {:hey => '!@#$%^&*()\/"Ü', :soo => "hëllö?"}
+      @api.urlencode(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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel_client
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Keolo Keagy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-10 00:00:00 -08:00
+date: 2009-12-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency