mole 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/README.txt +65 -7
- data/lib/mole/version.rb +1 -1
- metadata +1 -1
data/README.txt
CHANGED
@@ -5,7 +5,9 @@ The MOle
|
|
5
5
|
== DESCRIPTION:
|
6
6
|
|
7
7
|
The MOle allows you to track user's interactions with your ruby application and closely monitors
|
8
|
-
how your customers are using your application.
|
8
|
+
how your customers are using your application. This is a must cheaper way than to hire a monitoring
|
9
|
+
service and produces much more detailed information on your application behavior and usage. To boot
|
10
|
+
your managers will love you !
|
9
11
|
|
10
12
|
Whether you are releasing a new application or improving on an old one, it is always a good thing
|
11
13
|
to know if anyone is using your application and if they are, how they are using it.
|
@@ -13,6 +15,16 @@ What features are your users most fond of and which features find their way into
|
|
13
15
|
Using the MOle you'll be able to rapidly assess whether or not your application is a hit and if
|
14
16
|
your coolest features are thought as such by your users. You will be able to elegantly record user
|
15
17
|
interactions and leverage these findings for the next iteration of your application.
|
18
|
+
|
19
|
+
The MOle was initialy released as a Rails plugin, but we found the behavior usefull in other types
|
20
|
+
of projects such as Merb or straight up ruby applications, and decided to re-release it as a gem
|
21
|
+
instead.
|
22
|
+
|
23
|
+
== PROJECT INFORMATION
|
24
|
+
|
25
|
+
* Developer: Fernand Galiana [liquidrail.com]
|
26
|
+
* Forum: http://groups.google.com/group/mole-plugin
|
27
|
+
* Home: mole.rubyforge.org
|
16
28
|
|
17
29
|
== FEATURES:
|
18
30
|
|
@@ -39,9 +51,24 @@ The MOle allows you to easily
|
|
39
51
|
|
40
52
|
== INSTALL:
|
41
53
|
|
42
|
-
* sudo gem install mole
|
43
|
-
|
54
|
+
* sudo gem install mole
|
55
|
+
|
44
56
|
== SYNOPSIS:
|
57
|
+
|
58
|
+
* The MOle can operate in 2 different modes: transient or persistent. The transient mode will
|
59
|
+
simply record MOle interactions within your log file. If you opt to use the
|
60
|
+
persistent mode (recommanded!) which will allow to leverage the Snitch Application
|
61
|
+
and also draw out MOle usage reports from you database, you will need to install the 2 MOle tables in your database.
|
62
|
+
This is achived via the 'molify' command. In order to 'MOle' an application using the persistent
|
63
|
+
mode, you will need to issue the following commands:
|
64
|
+
|
65
|
+
> cd my_non_moled_application
|
66
|
+
> molify --up --config config/database.yml --env test
|
67
|
+
|
68
|
+
This command will update your test database and create the MOle tables required when
|
69
|
+
the MOle is in a persistent mode. Namely, these tables are mole_features and mole_logs.
|
70
|
+
|
71
|
+
You can use molify --help to see usage information.
|
45
72
|
|
46
73
|
* Mole initialization. This must be specified during your application initialization code.
|
47
74
|
In a rails app, this can be set in you application controller class or environment.rb. In
|
@@ -49,13 +76,13 @@ The MOle allows you to easily
|
|
49
76
|
|
50
77
|
require 'mole'
|
51
78
|
Mole.initialize( :moleable => true,
|
52
|
-
:
|
53
|
-
:
|
79
|
+
:application => "Smf",
|
80
|
+
:emole_from => "MoleBeatch@liquidrail.com",
|
81
|
+
:emole_recipients => ['fernand@liquidrail.com'],
|
54
82
|
:mode => :persistent,
|
55
83
|
:log_file => $stdout,
|
56
84
|
:log_level => :debug,
|
57
85
|
:perf_threshold => 2,
|
58
|
-
:application => "Smf",
|
59
86
|
:mole_config => File.join( File.dirname(__FILE__), %w[mole.rb] ) )
|
60
87
|
|
61
88
|
* Now you'll need to create a mole.rb specification file to specify the various aspects you'll want
|
@@ -115,7 +142,38 @@ The MOle allows you to easily
|
|
115
142
|
:boom => boom,
|
116
143
|
:email => true )
|
117
144
|
end
|
118
|
-
|
145
|
+
|
146
|
+
== Snitch
|
147
|
+
|
148
|
+
To view MOle interaction simply, we've created the "Snitch" a rails console application that
|
149
|
+
allows you to see the results of your MOled application. The Snitch is a Rails 2.0 application.
|
150
|
+
It is available at http://mole.rubyforge.org/svn/snitch/trunk/.
|
151
|
+
|
152
|
+
In order to start using the Snitch you will have to perform the following steps:
|
153
|
+
|
154
|
+
* Download the Snitch
|
155
|
+
svn co http://mole.rubyforge.org/svn/snitch/trunk/
|
156
|
+
|
157
|
+
* The Snitch needs to access your user table to provide user related log information. So
|
158
|
+
you will need to run the following rake task and provide your users table description.
|
159
|
+
|
160
|
+
> rake setup
|
161
|
+
|
162
|
+
* Edit the Snitch database.yml to point to your application database.
|
163
|
+
|
164
|
+
* Out of the box the Snitch will monitor and application named "Default". You will want
|
165
|
+
to match the application name that you've used in the Mole.initialize call. So you
|
166
|
+
should now be able to specify the following commands:
|
167
|
+
|
168
|
+
> script/server
|
169
|
+
|
170
|
+
Then in your browser
|
171
|
+
|
172
|
+
http://localhost:3000?app_name=my_moled_application_name
|
173
|
+
|
174
|
+
* NOTE: You will keep enhancing the Snitch to provide capistrano deployment scripts,
|
175
|
+
auto application name detection and many other enhancements...
|
176
|
+
|
119
177
|
== LICENSE:
|
120
178
|
|
121
179
|
MIT Copyright (c) 2008
|
data/lib/mole/version.rb
CHANGED
metadata
CHANGED
@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
|
|
3
3
|
specification_version: 1
|
4
4
|
name: mole
|
5
5
|
version: !ruby/object:Gem::Version
|
6
|
-
version: 1.0.
|
6
|
+
version: 1.0.1
|
7
7
|
date: 2008-03-02 00:00:00 -07:00
|
8
8
|
summary: A flexible way to track user's interactions within your ruby web applications
|
9
9
|
require_paths:
|