simplekiss 0.0.0 → 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +19 -17
- data/README.rdoc +43 -12
- data/VERSION +1 -1
- data/simplekiss.gemspec +1 -1
- metadata +1 -1
data/LICENSE
CHANGED
@@ -1,20 +1,22 @@
|
|
1
|
-
Copyright (c)
|
1
|
+
Copyright (c) 2010 Jamie Lawrence. See LICENSE for details.
|
2
2
|
|
3
|
-
Permission is hereby granted, free of charge, to any person
|
4
|
-
a copy of this software and associated documentation
|
5
|
-
"Software"), to deal in the Software without
|
6
|
-
without limitation the rights to use,
|
7
|
-
distribute, sublicense, and/or sell
|
8
|
-
|
9
|
-
the following
|
3
|
+
Permission is hereby granted, free of charge, to any person
|
4
|
+
obtaining a copy of this software and associated documentation
|
5
|
+
files (the "Software"), to deal in the Software without
|
6
|
+
restriction, including without limitation the rights to use,
|
7
|
+
copy, modify, merge, publish, distribute, sublicense, and/or sell
|
8
|
+
copies of the Software, and to permit persons to whom the
|
9
|
+
Software is furnished to do so, subject to the following
|
10
|
+
conditions:
|
10
11
|
|
11
|
-
The above copyright notice and this permission notice shall be
|
12
|
-
included in all copies or substantial portions of the Software.
|
12
|
+
The above copyright notice and this permission notice shall be
|
13
|
+
included in all copies or substantial portions of the Software.
|
13
14
|
|
14
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
16
|
-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
18
|
-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
19
|
-
OF CONTRACT, TORT OR OTHERWISE, ARISING
|
20
|
-
WITH THE SOFTWARE OR THE USE OR
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
16
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
17
|
+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
18
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
19
|
+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
20
|
+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
21
|
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
22
|
+
OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
CHANGED
@@ -1,17 +1,48 @@
|
|
1
1
|
= simplekiss
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
==
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
3
|
+
This is a simple library to add KISSmetrics to your layouts. It is configured using a YAML file.
|
4
|
+
|
5
|
+
== Install
|
6
|
+
|
7
|
+
gem install simplekiss
|
8
|
+
|
9
|
+
== Configure
|
10
|
+
|
11
|
+
Create a kissmetrics.yml file in your app's config/ dir
|
12
|
+
|
13
|
+
#KISSmetrics configuration file.
|
14
|
+
---
|
15
|
+
apikey: <enter your api key here>
|
16
|
+
|
17
|
+
<controller>:
|
18
|
+
<action>: 'kissmetrics step title'
|
19
|
+
<another action>: 'kissmetrics step title'
|
20
|
+
|
21
|
+
# Example usage
|
22
|
+
user:
|
23
|
+
new: 'Visit signup page'
|
24
|
+
show: 'Viewed account page'
|
25
|
+
post:
|
26
|
+
new: 'Create a new post'
|
27
|
+
|
28
|
+
This allows you the customise the name of the action based on the controller and action being called
|
29
|
+
|
30
|
+
== Adding KISSmetrics to your layout
|
31
|
+
|
32
|
+
Simply add this to the end of your layout, preferably the last thing before <\body>
|
33
|
+
|
34
|
+
<%= kissmetrics if Rails.env == 'production' %>
|
35
|
+
|
36
|
+
By default, if an entry isn't found '<controller name>/<action name>' is sent to KISSmetrics instead.
|
37
|
+
If you want to turn off this behaviour, to stop polluting you stats with every page:
|
38
|
+
|
39
|
+
<%= kissmetrics(use_defaults=>false) if Rails.env == 'production' %>
|
40
|
+
|
41
|
+
|
42
|
+
== TODO/Feedback
|
43
|
+
* Tests: yeah, I know. Feel free to help me out here
|
44
|
+
|
14
45
|
|
15
46
|
== Copyright
|
16
47
|
|
17
|
-
Copyright (c) 2010 Jamie Lawrence. See LICENSE for details.
|
48
|
+
Copyright (c) 2010 Jamie Lawrence. See LICENSE for details (MIT licence).
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.
|
1
|
+
0.1.0
|
data/simplekiss.gemspec
CHANGED