mixpanel_client 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/LICENSE +20 -0
- data/README.md +38 -0
- data/Rakefile +57 -0
- data/VERSION +1 -0
- data/features/mixpanel_client.feature +9 -0
- data/features/step_definitions/mixpanel_client_steps.rb +0 -0
- data/features/support/env.rb +4 -0
- data/lib/mixpanel_client.rb +56 -0
- data/mixpanel_client.gemspec +61 -0
- data/spec/mixpanel_client_spec.rb +7 -0
- data/spec/spec.opts +1 -0
- data/spec/spec_helper.rb +9 -0
- metadata +89 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Keolo Keagy
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# Ruby Mixpanel API Client
|
2
|
+
|
3
|
+
Ruby access to the [Mixpanel](http://mixpanel.com/) web analytics tool.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
# If you don't already have gemcutter as a rubygems source
|
7
|
+
gem install gemcutter
|
8
|
+
gem tumble
|
9
|
+
|
10
|
+
gem install mixpanel_client
|
11
|
+
|
12
|
+
## Example Usage
|
13
|
+
require 'rubygems'
|
14
|
+
require 'mixpanel_client'
|
15
|
+
|
16
|
+
config = {:api_key => 'changeme123', :api_secret => '123changeme'}
|
17
|
+
api = Mixpanel::Client.new(config)
|
18
|
+
data = api.request(:events, :general, {
|
19
|
+
:event => '["test-event"]',
|
20
|
+
:unit => 'hour',
|
21
|
+
:interval => 24
|
22
|
+
})
|
23
|
+
|
24
|
+
puts data.inspect
|
25
|
+
|
26
|
+
## Note on Patches/Pull Requests
|
27
|
+
* Fork the project.
|
28
|
+
* Make your feature addition or bug fix.
|
29
|
+
* Add tests for it. This is important so I don't break it in a
|
30
|
+
future version unintentionally.
|
31
|
+
* Commit, do not mess with rakefile, version, or history.
|
32
|
+
(if you want to have your own version, that is fine but
|
33
|
+
bump version in a commit by itself I can ignore when I pull)
|
34
|
+
* Send me a pull request. Bonus points for topic branches.
|
35
|
+
|
36
|
+
## Copyright
|
37
|
+
|
38
|
+
Copyright (c) 2009 Keolo Keagy. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,57 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "mixpanel_client"
|
8
|
+
gem.summary = 'Ruby Mixpanel API Client Library'
|
9
|
+
gem.description = 'Simple ruby client interface to the Mixpanel API.'
|
10
|
+
gem.email = "keolo@dreampointmedia.com"
|
11
|
+
gem.homepage = "http://github.com/keolo/mixpanel_client"
|
12
|
+
gem.authors = ["Keolo Keagy"]
|
13
|
+
gem.add_development_dependency "rspec", ">= 1.2.9"
|
14
|
+
gem.add_development_dependency "cucumber", ">= 0"
|
15
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
16
|
+
end
|
17
|
+
Jeweler::GemcutterTasks.new
|
18
|
+
rescue LoadError
|
19
|
+
puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
|
20
|
+
end
|
21
|
+
|
22
|
+
require 'spec/rake/spectask'
|
23
|
+
Spec::Rake::SpecTask.new(:spec) do |spec|
|
24
|
+
spec.libs << 'lib' << 'spec'
|
25
|
+
spec.spec_files = FileList['spec/**/*_spec.rb']
|
26
|
+
end
|
27
|
+
|
28
|
+
Spec::Rake::SpecTask.new(:rcov) do |spec|
|
29
|
+
spec.libs << 'lib' << 'spec'
|
30
|
+
spec.pattern = 'spec/**/*_spec.rb'
|
31
|
+
spec.rcov = true
|
32
|
+
end
|
33
|
+
|
34
|
+
task :spec => :check_dependencies
|
35
|
+
|
36
|
+
begin
|
37
|
+
require 'cucumber/rake/task'
|
38
|
+
Cucumber::Rake::Task.new(:features)
|
39
|
+
|
40
|
+
task :features => :check_dependencies
|
41
|
+
rescue LoadError
|
42
|
+
task :features do
|
43
|
+
abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
task :default => :spec
|
48
|
+
|
49
|
+
require 'rake/rdoctask'
|
50
|
+
Rake::RDocTask.new do |rdoc|
|
51
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
52
|
+
|
53
|
+
rdoc.rdoc_dir = 'rdoc'
|
54
|
+
rdoc.title = "mixpanel_client #{version}"
|
55
|
+
rdoc.rdoc_files.include('README*')
|
56
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
57
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.1.0
|
File without changes
|
@@ -0,0 +1,56 @@
|
|
1
|
+
#!/usr/bin/env ruby -Ku
|
2
|
+
|
3
|
+
# Mixpanel API Ruby Client Library
|
4
|
+
#
|
5
|
+
# Copyright (c) 2009+ Keolo Keagy
|
6
|
+
# MIT License http://www.opensource.org/licenses/mit-license.php
|
7
|
+
# Open sourced by the good folks at SharesPost.com
|
8
|
+
#
|
9
|
+
# Inspired by the official mixpanel php and python libraries.
|
10
|
+
# http://mixpanel.com/api/docs/guides/api/
|
11
|
+
|
12
|
+
require 'cgi'
|
13
|
+
require 'digest/md5'
|
14
|
+
require 'open-uri'
|
15
|
+
require 'json'
|
16
|
+
|
17
|
+
module Mixpanel
|
18
|
+
class Client
|
19
|
+
attr_accessor :api_key, :api_secret
|
20
|
+
|
21
|
+
BASE_URI = 'http://mixpanel.com/api'
|
22
|
+
VERSION = '1.0'
|
23
|
+
|
24
|
+
def initialize(config)
|
25
|
+
@api_key = config[:api_key]
|
26
|
+
@api_secret = config[:api_secret]
|
27
|
+
end
|
28
|
+
|
29
|
+
def request(endpoint, method, params)
|
30
|
+
params[:api_key] = api_key
|
31
|
+
params[:expire] = Time.now.to_i + 600 # Grant this request 10 minutes
|
32
|
+
params[:format] ||= :json
|
33
|
+
params[:sig] = hash_args(params)
|
34
|
+
|
35
|
+
@format = params[:format]
|
36
|
+
|
37
|
+
response = URI.parse("#{BASE_URI}/#{endpoint}/#{VERSION}/#{method}?#{urlencode(params)}").read
|
38
|
+
to_hash(response)
|
39
|
+
end
|
40
|
+
|
41
|
+
def hash_args(args)
|
42
|
+
Digest::MD5.hexdigest(args.map{|k,v| "#{k}=#{v}"}.sort.to_s + api_secret)
|
43
|
+
end
|
44
|
+
|
45
|
+
def urlencode(params)
|
46
|
+
params.map{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
|
47
|
+
end
|
48
|
+
|
49
|
+
def to_hash(data)
|
50
|
+
case @format
|
51
|
+
when :json
|
52
|
+
JSON.parse(data)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
@@ -0,0 +1,61 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
|
4
|
+
# -*- encoding: utf-8 -*-
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = %q{mixpanel_client}
|
8
|
+
s.version = "0.1.0"
|
9
|
+
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
|
+
s.authors = ["Keolo Keagy"]
|
12
|
+
s.date = %q{2009-11-10}
|
13
|
+
s.description = %q{Simple ruby client interface to the Mixpanel API.}
|
14
|
+
s.email = %q{keolo@dreampointmedia.com}
|
15
|
+
s.extra_rdoc_files = [
|
16
|
+
"LICENSE",
|
17
|
+
"README.md"
|
18
|
+
]
|
19
|
+
s.files = [
|
20
|
+
".document",
|
21
|
+
".gitignore",
|
22
|
+
"LICENSE",
|
23
|
+
"README.md",
|
24
|
+
"Rakefile",
|
25
|
+
"VERSION",
|
26
|
+
"features/mixpanel_client.feature",
|
27
|
+
"features/step_definitions/mixpanel_client_steps.rb",
|
28
|
+
"features/support/env.rb",
|
29
|
+
"lib/mixpanel_client.rb",
|
30
|
+
"mixpanel_client.gemspec",
|
31
|
+
"spec/mixpanel_client_spec.rb",
|
32
|
+
"spec/spec.opts",
|
33
|
+
"spec/spec_helper.rb"
|
34
|
+
]
|
35
|
+
s.homepage = %q{http://github.com/keolo/mixpanel_client}
|
36
|
+
s.rdoc_options = ["--charset=UTF-8"]
|
37
|
+
s.require_paths = ["lib"]
|
38
|
+
s.rubygems_version = %q{1.3.5}
|
39
|
+
s.summary = %q{Ruby Mixpanel API Client Library}
|
40
|
+
s.test_files = [
|
41
|
+
"spec/mixpanel_client_spec.rb",
|
42
|
+
"spec/spec_helper.rb"
|
43
|
+
]
|
44
|
+
|
45
|
+
if s.respond_to? :specification_version then
|
46
|
+
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
47
|
+
s.specification_version = 3
|
48
|
+
|
49
|
+
if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
|
50
|
+
s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
|
51
|
+
s.add_development_dependency(%q<cucumber>, [">= 0"])
|
52
|
+
else
|
53
|
+
s.add_dependency(%q<rspec>, [">= 1.2.9"])
|
54
|
+
s.add_dependency(%q<cucumber>, [">= 0"])
|
55
|
+
end
|
56
|
+
else
|
57
|
+
s.add_dependency(%q<rspec>, [">= 1.2.9"])
|
58
|
+
s.add_dependency(%q<cucumber>, [">= 0"])
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
data/spec/spec.opts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color
|
data/spec/spec_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,89 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: mixpanel_client
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Keolo Keagy
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2009-11-10 00:00:00 -08:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: rspec
|
17
|
+
type: :development
|
18
|
+
version_requirement:
|
19
|
+
version_requirements: !ruby/object:Gem::Requirement
|
20
|
+
requirements:
|
21
|
+
- - ">="
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: 1.2.9
|
24
|
+
version:
|
25
|
+
- !ruby/object:Gem::Dependency
|
26
|
+
name: cucumber
|
27
|
+
type: :development
|
28
|
+
version_requirement:
|
29
|
+
version_requirements: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: "0"
|
34
|
+
version:
|
35
|
+
description: Simple ruby client interface to the Mixpanel API.
|
36
|
+
email: keolo@dreampointmedia.com
|
37
|
+
executables: []
|
38
|
+
|
39
|
+
extensions: []
|
40
|
+
|
41
|
+
extra_rdoc_files:
|
42
|
+
- LICENSE
|
43
|
+
- README.md
|
44
|
+
files:
|
45
|
+
- .document
|
46
|
+
- .gitignore
|
47
|
+
- LICENSE
|
48
|
+
- README.md
|
49
|
+
- Rakefile
|
50
|
+
- VERSION
|
51
|
+
- features/mixpanel_client.feature
|
52
|
+
- features/step_definitions/mixpanel_client_steps.rb
|
53
|
+
- features/support/env.rb
|
54
|
+
- lib/mixpanel_client.rb
|
55
|
+
- mixpanel_client.gemspec
|
56
|
+
- spec/mixpanel_client_spec.rb
|
57
|
+
- spec/spec.opts
|
58
|
+
- spec/spec_helper.rb
|
59
|
+
has_rdoc: true
|
60
|
+
homepage: http://github.com/keolo/mixpanel_client
|
61
|
+
licenses: []
|
62
|
+
|
63
|
+
post_install_message:
|
64
|
+
rdoc_options:
|
65
|
+
- --charset=UTF-8
|
66
|
+
require_paths:
|
67
|
+
- lib
|
68
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
69
|
+
requirements:
|
70
|
+
- - ">="
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: "0"
|
73
|
+
version:
|
74
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
75
|
+
requirements:
|
76
|
+
- - ">="
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
version: "0"
|
79
|
+
version:
|
80
|
+
requirements: []
|
81
|
+
|
82
|
+
rubyforge_project:
|
83
|
+
rubygems_version: 1.3.5
|
84
|
+
signing_key:
|
85
|
+
specification_version: 3
|
86
|
+
summary: Ruby Mixpanel API Client Library
|
87
|
+
test_files:
|
88
|
+
- spec/mixpanel_client_spec.rb
|
89
|
+
- spec/spec_helper.rb
|