ab_panel 0.0.2 → 0.0.3

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.
Files changed (75) hide show
  1. data/README.md +1 -1
  2. data/ab_panel.gemspec +2 -1
  3. data/example/.gitignore +15 -0
  4. data/example/Gemfile +40 -0
  5. data/example/README.rdoc +261 -0
  6. data/example/Rakefile +7 -0
  7. data/example/app/assets/images/rails.png +0 -0
  8. data/example/app/assets/javascripts/application.js +15 -0
  9. data/example/app/assets/javascripts/posts.js.coffee +3 -0
  10. data/example/app/assets/stylesheets/application.css +13 -0
  11. data/example/app/assets/stylesheets/posts.css.scss +3 -0
  12. data/example/app/assets/stylesheets/scaffolds.css.scss +69 -0
  13. data/example/app/controllers/application_controller.rb +15 -0
  14. data/example/app/controllers/posts_controller.rb +85 -0
  15. data/example/app/helpers/application_helper.rb +2 -0
  16. data/example/app/helpers/posts_helper.rb +2 -0
  17. data/example/app/mailers/.gitkeep +0 -0
  18. data/example/app/models/.gitkeep +0 -0
  19. data/example/app/models/post.rb +3 -0
  20. data/example/app/views/layouts/application.html.erb +14 -0
  21. data/example/app/views/posts/_form.html.erb +25 -0
  22. data/example/app/views/posts/edit.html.erb +6 -0
  23. data/example/app/views/posts/index.html.erb +25 -0
  24. data/example/app/views/posts/new.html.erb +5 -0
  25. data/example/app/views/posts/show.html.erb +15 -0
  26. data/example/config/ab_panel.yml +10 -0
  27. data/example/config/application.rb +62 -0
  28. data/example/config/boot.rb +6 -0
  29. data/example/config/database.yml +25 -0
  30. data/example/config/environment.rb +5 -0
  31. data/example/config/environments/development.rb +37 -0
  32. data/example/config/environments/production.rb +67 -0
  33. data/example/config/environments/test.rb +37 -0
  34. data/example/config/initializers/backtrace_silencers.rb +7 -0
  35. data/example/config/initializers/inflections.rb +15 -0
  36. data/example/config/initializers/mime_types.rb +5 -0
  37. data/example/config/initializers/mixpanel_middleware.rb +2 -0
  38. data/example/config/initializers/secret_token.rb +7 -0
  39. data/example/config/initializers/session_store.rb +8 -0
  40. data/example/config/initializers/wrap_parameters.rb +14 -0
  41. data/example/config/locales/en.yml +5 -0
  42. data/example/config/mixpanel.yml +3 -0
  43. data/example/config/routes.rb +60 -0
  44. data/example/config.ru +4 -0
  45. data/example/db/migrate/20130909131957_create_posts.rb +10 -0
  46. data/example/db/schema.rb +23 -0
  47. data/example/db/seeds.rb +7 -0
  48. data/example/lib/assets/.gitkeep +0 -0
  49. data/example/lib/tasks/.gitkeep +0 -0
  50. data/example/log/.gitkeep +0 -0
  51. data/example/public/404.html +26 -0
  52. data/example/public/422.html +26 -0
  53. data/example/public/500.html +25 -0
  54. data/example/public/favicon.ico +0 -0
  55. data/example/public/index.html +241 -0
  56. data/example/public/robots.txt +5 -0
  57. data/example/script/rails +6 -0
  58. data/example/test/fixtures/.gitkeep +0 -0
  59. data/example/test/fixtures/posts.yml +9 -0
  60. data/example/test/functional/.gitkeep +0 -0
  61. data/example/test/functional/posts_controller_test.rb +49 -0
  62. data/example/test/integration/.gitkeep +0 -0
  63. data/example/test/performance/browsing_test.rb +12 -0
  64. data/example/test/test_helper.rb +13 -0
  65. data/example/test/unit/.gitkeep +0 -0
  66. data/example/test/unit/helpers/posts_helper_test.rb +4 -0
  67. data/example/test/unit/post_test.rb +7 -0
  68. data/example/vendor/assets/javascripts/.gitkeep +0 -0
  69. data/example/vendor/assets/stylesheets/.gitkeep +0 -0
  70. data/example/vendor/plugins/.gitkeep +0 -0
  71. data/lib/ab_panel/controller_additions.rb +21 -10
  72. data/lib/ab_panel/mixpanel.rb +6 -13
  73. data/lib/ab_panel/version.rb +1 -1
  74. data/lib/ab_panel.rb +17 -9
  75. metadata +156 -4
@@ -0,0 +1,241 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Ruby on Rails: Welcome aboard</title>
5
+ <style type="text/css" media="screen">
6
+ body {
7
+ margin: 0;
8
+ margin-bottom: 25px;
9
+ padding: 0;
10
+ background-color: #f0f0f0;
11
+ font-family: "Lucida Grande", "Bitstream Vera Sans", "Verdana";
12
+ font-size: 13px;
13
+ color: #333;
14
+ }
15
+
16
+ h1 {
17
+ font-size: 28px;
18
+ color: #000;
19
+ }
20
+
21
+ a {color: #03c}
22
+ a:hover {
23
+ background-color: #03c;
24
+ color: white;
25
+ text-decoration: none;
26
+ }
27
+
28
+
29
+ #page {
30
+ background-color: #f0f0f0;
31
+ width: 750px;
32
+ margin: 0;
33
+ margin-left: auto;
34
+ margin-right: auto;
35
+ }
36
+
37
+ #content {
38
+ float: left;
39
+ background-color: white;
40
+ border: 3px solid #aaa;
41
+ border-top: none;
42
+ padding: 25px;
43
+ width: 500px;
44
+ }
45
+
46
+ #sidebar {
47
+ float: right;
48
+ width: 175px;
49
+ }
50
+
51
+ #footer {
52
+ clear: both;
53
+ }
54
+
55
+ #header, #about, #getting-started {
56
+ padding-left: 75px;
57
+ padding-right: 30px;
58
+ }
59
+
60
+
61
+ #header {
62
+ background-image: url("assets/rails.png");
63
+ background-repeat: no-repeat;
64
+ background-position: top left;
65
+ height: 64px;
66
+ }
67
+ #header h1, #header h2 {margin: 0}
68
+ #header h2 {
69
+ color: #888;
70
+ font-weight: normal;
71
+ font-size: 16px;
72
+ }
73
+
74
+
75
+ #about h3 {
76
+ margin: 0;
77
+ margin-bottom: 10px;
78
+ font-size: 14px;
79
+ }
80
+
81
+ #about-content {
82
+ background-color: #ffd;
83
+ border: 1px solid #fc0;
84
+ margin-left: -55px;
85
+ margin-right: -10px;
86
+ }
87
+ #about-content table {
88
+ margin-top: 10px;
89
+ margin-bottom: 10px;
90
+ font-size: 11px;
91
+ border-collapse: collapse;
92
+ }
93
+ #about-content td {
94
+ padding: 10px;
95
+ padding-top: 3px;
96
+ padding-bottom: 3px;
97
+ }
98
+ #about-content td.name {color: #555}
99
+ #about-content td.value {color: #000}
100
+
101
+ #about-content ul {
102
+ padding: 0;
103
+ list-style-type: none;
104
+ }
105
+
106
+ #about-content.failure {
107
+ background-color: #fcc;
108
+ border: 1px solid #f00;
109
+ }
110
+ #about-content.failure p {
111
+ margin: 0;
112
+ padding: 10px;
113
+ }
114
+
115
+
116
+ #getting-started {
117
+ border-top: 1px solid #ccc;
118
+ margin-top: 25px;
119
+ padding-top: 15px;
120
+ }
121
+ #getting-started h1 {
122
+ margin: 0;
123
+ font-size: 20px;
124
+ }
125
+ #getting-started h2 {
126
+ margin: 0;
127
+ font-size: 14px;
128
+ font-weight: normal;
129
+ color: #333;
130
+ margin-bottom: 25px;
131
+ }
132
+ #getting-started ol {
133
+ margin-left: 0;
134
+ padding-left: 0;
135
+ }
136
+ #getting-started li {
137
+ font-size: 18px;
138
+ color: #888;
139
+ margin-bottom: 25px;
140
+ }
141
+ #getting-started li h2 {
142
+ margin: 0;
143
+ font-weight: normal;
144
+ font-size: 18px;
145
+ color: #333;
146
+ }
147
+ #getting-started li p {
148
+ color: #555;
149
+ font-size: 13px;
150
+ }
151
+
152
+
153
+ #sidebar ul {
154
+ margin-left: 0;
155
+ padding-left: 0;
156
+ }
157
+ #sidebar ul h3 {
158
+ margin-top: 25px;
159
+ font-size: 16px;
160
+ padding-bottom: 10px;
161
+ border-bottom: 1px solid #ccc;
162
+ }
163
+ #sidebar li {
164
+ list-style-type: none;
165
+ }
166
+ #sidebar ul.links li {
167
+ margin-bottom: 5px;
168
+ }
169
+
170
+ .filename {
171
+ font-style: italic;
172
+ }
173
+ </style>
174
+ <script type="text/javascript">
175
+ function about() {
176
+ info = document.getElementById('about-content');
177
+ if (window.XMLHttpRequest)
178
+ { xhr = new XMLHttpRequest(); }
179
+ else
180
+ { xhr = new ActiveXObject("Microsoft.XMLHTTP"); }
181
+ xhr.open("GET","rails/info/properties",false);
182
+ xhr.send("");
183
+ info.innerHTML = xhr.responseText;
184
+ info.style.display = 'block'
185
+ }
186
+ </script>
187
+ </head>
188
+ <body>
189
+ <div id="page">
190
+ <div id="sidebar">
191
+ <ul id="sidebar-items">
192
+ <li>
193
+ <h3>Browse the documentation</h3>
194
+ <ul class="links">
195
+ <li><a href="http://guides.rubyonrails.org/">Rails Guides</a></li>
196
+ <li><a href="http://api.rubyonrails.org/">Rails API</a></li>
197
+ <li><a href="http://www.ruby-doc.org/core/">Ruby core</a></li>
198
+ <li><a href="http://www.ruby-doc.org/stdlib/">Ruby standard library</a></li>
199
+ </ul>
200
+ </li>
201
+ </ul>
202
+ </div>
203
+
204
+ <div id="content">
205
+ <div id="header">
206
+ <h1>Welcome aboard</h1>
207
+ <h2>You&rsquo;re riding Ruby on Rails!</h2>
208
+ </div>
209
+
210
+ <div id="about">
211
+ <h3><a href="rails/info/properties" onclick="about(); return false">About your application&rsquo;s environment</a></h3>
212
+ <div id="about-content" style="display: none"></div>
213
+ </div>
214
+
215
+ <div id="getting-started">
216
+ <h1>Getting started</h1>
217
+ <h2>Here&rsquo;s how to get rolling:</h2>
218
+
219
+ <ol>
220
+ <li>
221
+ <h2>Use <code>rails generate</code> to create your models and controllers</h2>
222
+ <p>To see all available options, run it without parameters.</p>
223
+ </li>
224
+
225
+ <li>
226
+ <h2>Set up a default route and remove <span class="filename">public/index.html</span></h2>
227
+ <p>Routes are set up in <span class="filename">config/routes.rb</span>.</p>
228
+ </li>
229
+
230
+ <li>
231
+ <h2>Create your database</h2>
232
+ <p>Run <code>rake db:create</code> to create your database. If you're not using SQLite (the default), edit <span class="filename">config/database.yml</span> with your username and password.</p>
233
+ </li>
234
+ </ol>
235
+ </div>
236
+ </div>
237
+
238
+ <div id="footer">&nbsp;</div>
239
+ </div>
240
+ </body>
241
+ </html>
@@ -0,0 +1,5 @@
1
+ # See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
2
+ #
3
+ # To ban all spiders from the entire site uncomment the next two lines:
4
+ # User-Agent: *
5
+ # Disallow: /
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
3
+
4
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
5
+ require File.expand_path('../../config/boot', __FILE__)
6
+ require 'rails/commands'
File without changes
@@ -0,0 +1,9 @@
1
+ # Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
2
+
3
+ one:
4
+ title: MyString
5
+ content: MyText
6
+
7
+ two:
8
+ title: MyString
9
+ content: MyText
File without changes
@@ -0,0 +1,49 @@
1
+ require 'test_helper'
2
+
3
+ class PostsControllerTest < ActionController::TestCase
4
+ setup do
5
+ @post = posts(:one)
6
+ end
7
+
8
+ test "should get index" do
9
+ get :index
10
+ assert_response :success
11
+ assert_not_nil assigns(:posts)
12
+ end
13
+
14
+ test "should get new" do
15
+ get :new
16
+ assert_response :success
17
+ end
18
+
19
+ test "should create post" do
20
+ assert_difference('Post.count') do
21
+ post :create, post: { content: @post.content, title: @post.title }
22
+ end
23
+
24
+ assert_redirected_to post_path(assigns(:post))
25
+ end
26
+
27
+ test "should show post" do
28
+ get :show, id: @post
29
+ assert_response :success
30
+ end
31
+
32
+ test "should get edit" do
33
+ get :edit, id: @post
34
+ assert_response :success
35
+ end
36
+
37
+ test "should update post" do
38
+ put :update, id: @post, post: { content: @post.content, title: @post.title }
39
+ assert_redirected_to post_path(assigns(:post))
40
+ end
41
+
42
+ test "should destroy post" do
43
+ assert_difference('Post.count', -1) do
44
+ delete :destroy, id: @post
45
+ end
46
+
47
+ assert_redirected_to posts_path
48
+ end
49
+ end
File without changes
@@ -0,0 +1,12 @@
1
+ require 'test_helper'
2
+ require 'rails/performance_test_help'
3
+
4
+ class BrowsingTest < ActionDispatch::PerformanceTest
5
+ # Refer to the documentation for all available options
6
+ # self.profile_options = { :runs => 5, :metrics => [:wall_time, :memory]
7
+ # :output => 'tmp/performance', :formats => [:flat] }
8
+
9
+ def test_homepage
10
+ get '/'
11
+ end
12
+ end
@@ -0,0 +1,13 @@
1
+ ENV["RAILS_ENV"] = "test"
2
+ require File.expand_path('../../config/environment', __FILE__)
3
+ require 'rails/test_help'
4
+
5
+ class ActiveSupport::TestCase
6
+ # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
7
+ #
8
+ # Note: You'll currently still have to declare fixtures explicitly in integration tests
9
+ # -- they do not yet inherit this setting
10
+ fixtures :all
11
+
12
+ # Add more helper methods to be used by all tests here...
13
+ end
File without changes
@@ -0,0 +1,4 @@
1
+ require 'test_helper'
2
+
3
+ class PostsHelperTest < ActionView::TestCase
4
+ end
@@ -0,0 +1,7 @@
1
+ require 'test_helper'
2
+
3
+ class PostTest < ActiveSupport::TestCase
4
+ # test "the truth" do
5
+ # assert true
6
+ # end
7
+ end
File without changes
File without changes
File without changes
@@ -9,7 +9,7 @@ module AbPanel
9
9
  #
10
10
  # `current_user.id` for logged in users.
11
11
  def ab_panel_id
12
- session[:ab_panel_id] ||=
12
+ session['ab_panel_id'] ||=
13
13
  (0..4).map { |i| i.even? ? ('A'..'Z').to_a[rand(26)] : rand(10) }.join
14
14
  end
15
15
 
@@ -24,7 +24,8 @@ module AbPanel
24
24
  'REMOTE_ADDR' => request['REMOTE_ADDR'],
25
25
  'HTTP_X_FORWARDED_FOR' => request['HTTP_X_FORWARDED_FOR'],
26
26
  'rack.session' => request['rack.session'],
27
- 'rails.env' => Rails.env
27
+ 'rails.env' => Rails.env,
28
+ 'ip' => request.remote_ip,
28
29
  }
29
30
  end
30
31
 
@@ -44,9 +45,9 @@ module AbPanel
44
45
  self.before_filter(options.slice(:only, :except)) do |controller|
45
46
  # Persist the conditions.
46
47
  AbPanel.conditions = controller.session['ab_panel_conditions']
48
+ controller.session['ab_panel_conditions'] = AbPanel.conditions
47
49
 
48
50
  {
49
- 'mixpanel_events' => controller.request['mixpanel_events'],
50
51
  'ab_panel_id' => controller.ab_panel_id
51
52
  }.merge(controller.ab_panel_env).each do |key, val|
52
53
  AbPanel.env_set key, val
@@ -61,20 +62,26 @@ module AbPanel
61
62
  #
62
63
  # Example:
63
64
  #
64
- # track_visit '[visits] Booking form', { :only => :book_now, :course => :id }
65
+ # track_action '[visits] Booking form', { :only => :book_now, :course => :id }
65
66
  #
66
67
  # This will track the event with the given name on CoursesController#book_now
67
68
  # and assign an options hash:
68
69
  #
69
70
  # { 'course_id' => @course.id }
70
- def track_visit(name, properties={})
71
+ def track_action(name, options={})
71
72
  self.after_filter(options.slice(:only, :except)) do |controller|
73
+ properties = options.slice! :only, :except
74
+
72
75
  options = {
73
- distinct_id: ab_panel_id,
74
- time: Time.now,
75
- time_utc: Time.now.utc
76
+ distinct_id: controller.ab_panel_id,
77
+ ip: controller.request.remote_ip,
78
+ time: Time.now.utc,
76
79
  }
77
80
 
81
+ AbPanel.experiments.each do |exp|
82
+ options[exp] = AbPanel.conditions.send(exp).condition rescue nil
83
+ end
84
+
78
85
  properties.each do |key, val|
79
86
  if controller.respond_to?(key)
80
87
  inst = controller.send(key)
@@ -91,9 +98,13 @@ module AbPanel
91
98
  options["#{key}_#{m}"] = inst.send(m)
92
99
  end
93
100
  end
94
- end
95
101
 
96
- AbPanel.track name, options
102
+ AbPanel.identify(controller.ab_panel_id)
103
+ AbPanel.track name, options
104
+
105
+ controller.session['mixpanel_events'] ||= AbPanel.env['rack.session']['mixpanel_events'] rescue []
106
+
107
+ end
97
108
  end
98
109
  end
99
110
  end
@@ -10,24 +10,17 @@ module AbPanel
10
10
  def ab_panel_options
11
11
  {
12
12
  api_key: Config.api_key,
13
- env: AbPanel.env
13
+ env: AbPanel.env,
14
+ persist: true
14
15
  }
15
16
  end
16
17
 
17
- def track(event_name, properties, options={})
18
- if defined?(Resque)
19
- Resque.enqueue ResqueTracker, event_name, properties, options
20
- else
21
- @tracker.track event_name, properties, options
22
- end
18
+ def track(event_name, properties)
19
+ @tracker.append_track event_name, properties
23
20
  end
24
- end
25
-
26
- class ResqueTracker
27
- @queue = :ab_panel
28
21
 
29
- def self.perform(event_name, properties, options={})
30
- Tracker.new.track(event_name, properties, options)
22
+ def identify(distinct_id)
23
+ @tracker.append_identify distinct_id
31
24
  end
32
25
  end
33
26
 
@@ -1,3 +1,3 @@
1
1
  module AbPanel
2
- VERSION = "0.0.2"
2
+ VERSION = "0.0.3"
3
3
  end
data/lib/ab_panel.rb CHANGED
@@ -1,5 +1,3 @@
1
- puts "Ab Panel."
2
-
3
1
  Dir[File.expand_path(File.join(
4
2
  File.dirname(__FILE__),'ab_panel','**','*.rb'))]
5
3
  .each {|f| require f}
@@ -8,8 +6,13 @@ module AbPanel
8
6
  class << self
9
7
 
10
8
  # Track event in Mixpanel backend.
11
- def track(event_name, properties, options={})
12
- tracker.track event_name, properties, options
9
+ def track(event_name, properties)
10
+ tracker.track event_name, properties
11
+ end
12
+
13
+ # Identify
14
+ def identify(ab_panel_id)
15
+ tracker.identify ab_panel_id
13
16
  end
14
17
 
15
18
  def conditions
@@ -21,7 +24,8 @@ module AbPanel
21
24
  # This is used to persist conditions from
22
25
  # the session.
23
26
  def conditions=(custom_conditions)
24
- @conditions = custom_conditions || conditions
27
+ return conditions unless custom_conditions
28
+ @conditions = assign_conditions! custom_conditions
25
29
  end
26
30
 
27
31
  def experiments
@@ -38,13 +42,13 @@ module AbPanel
38
42
 
39
43
  def env
40
44
  @env ||= {
41
- 'conditions' => conditions
45
+ 'conditions' => conditions
42
46
  }
43
47
  end
44
48
 
45
49
  private # ----------------------------------------------------------------------------
46
50
 
47
- def assign_conditions!
51
+ def assign_conditions!(already_assigned=nil)
48
52
  cs = {}
49
53
 
50
54
  experiments.each do |experiment|
@@ -54,7 +58,11 @@ module AbPanel
54
58
  cs[experiment]["#{scenario}?"] = false
55
59
  end
56
60
 
57
- selected = scenarios(experiment)[rand(scenarios(experiment).size)]
61
+ selected = begin
62
+ already_assigned.send(experiment).condition
63
+ rescue
64
+ scenarios(experiment)[rand(scenarios(experiment).size)]
65
+ end
58
66
 
59
67
  cs[experiment]["#{selected}?"] = true
60
68
 
@@ -67,7 +75,7 @@ module AbPanel
67
75
  end
68
76
 
69
77
  def tracker
70
- @tracker ||= Mixpanel::Tracker.new
78
+ Mixpanel::Tracker.new
71
79
  end
72
80
 
73
81
  def config