touchstone 0.1.1 → 0.2.0

data/README.markdown

@@ -18,7 +18,7 @@ Add the following line to your Gemfile:
 
 Then run `bundle install`
 
-Copy the migrations across to your application by running `touchstone:install:migrations`. This will add a models for the 3 elements set out above.
+Copy the migrations across to your application by running `touchstone:install:migrations`. This will add models for the 3 elements set out above.
 
 You will need to mount Touchstone in your application by adding the following line to your `routes.rb` file:
 
@@ -42,7 +42,7 @@ Finally, add the following to your `application_controller.rb` file:
 ## Usage
 Usage is very simple. Assume you are running a Google Adwords campaign for 1 week at a cost of $100. Create this campaign in Touchstone and it will return a campaign ID. Make sure all your links on Adwords contain the parameter at the end `?cid={campaign_id}` where `campaign_id` is the id generated by Touchstone. Please note:
 
-* Campaigns don't need to be paid campaigns, it can be as simple as a link from your homepage or multiple links if A/B testing
+* Campaigns don't need to be paid campaigns, it can be as simple as a link on your homepage
 * You can update the campaign cost at any time. All calculations are "on the fly" so you're metrics will update automatically
 
 The installation steps described above will get you going with tracking visits from particular campaigns but you still have some work to do in linking this to your users. Touchstone only really provides a benefit when you track how much revenue your users bring in and then it will compare that to the cost of your campaigns. By way of examples only, you could adopt the following pattern to record a campaign signup:
@@ -81,4 +81,5 @@ Tracking a user's lifetime value will depend on your transactional logic but ass
 * Don't constrain Touchstone to an application that only has a Users table. Allow this as a configuration option
 * Automatically load routes and application controller content
 * Improve design
-* Add some tests
+* Add some tests
+* Allow customisation of currency (only displays dollars at moment although amounts are not stored in a particular currency)

data/app/assets/stylesheets/touchstone/touchstone.css.scss

@@ -0,0 +1,71 @@
+$iconSpritePath: asset-url('glyphicons-halflings.png',image);
+$iconWhiteSpritePath: asset-url('glyphicons-halflings-white.png',image);
+@import "bootstrap";
+body { padding-top: 60px; }
+@import "bootstrap-responsive";
+
+/* Mixins */
+
+@mixin float-right {
+	float: right;
+	margin: 0 5px;
+}
+
+/* Bootstrap Extensions */
+
+.touchstone .page-header .btn {
+	@include float-right;
+}
+
+.alert {
+	text-align: center;
+	padding-bottom: 0px;
+}
+
+/* Styles */
+
+.touchstone .navbar .brand {
+	font-weight: bold;
+}
+
+.touchstone .navbar .brand a {
+	color: rgb(0,0,0);
+	text-shadow: rgba(255,255,255,0.125) 0px 1px 0px;
+	text-decoration: none;
+}
+
+.touchstone .navbar .brand a:hover {
+	text-shadow: rgba(255,255,255,0.25) 0 0px 2px;
+}
+
+.touchstone {
+	font: 62.5% "Helvetica Neue", "Lucida Grande", "Trebuchet MS", Verdana, sans-serif;
+	font-weight: normal;
+	-webkit-text-shadow: 0px -1px 0px rgb(68,68,68);
+}
+
+.touchstone th,
+.touchstone td {
+	font-size: 1.4em;
+}
+
+.touchstone .controls select:first-child,
+.touchstone .controls select:last-child {
+	width: 60px;
+}
+
+.touchstone .controls select:nth-child(2) {
+	width: 140px;
+}
+
+.touchstone #financials {
+	margin-bottom: 10px;
+}
+
+.touchstone .stats span {
+	color: rgb(0,115,204);
+}
+
+.touchstone #visits {
+	margin-bottom: 20px;
+}

data/app/controllers/touchstone/campaigns_controller.rb

@@ -25,4 +25,19 @@ class Touchstone::CampaignsController < ApplicationController
     @campaign = Campaign.find(params[:id])
   end
   
+  def edit
+    @campaign = Campaign.find(params[:id])
+  end
+  
+  def update
+    @campaign = Campaign.find(params[:id])
+    if @campaign.update_attributes(params[:campaign]) && @campaign.save
+      flash[:notice] = "Campaign details updated"
+      redirect_to campaign_path(@campaign)
+    else
+      flash[:error] = "Could not update details at this time."
+      redirect_to campaign_path(@campaign)
+    end
+  end
+  
 end

data/app/views/layouts/touchstone/touchstone.html.erb

@@ -7,16 +7,32 @@
 	  <%= csrf_meta_tag %>
 	</head>
 	<body class="touchstone">
-		<div class="wrapper">
-			
-			<section id="flash">
-			  <% flash.each do |key, value| -%>
-			    <div id="flash_<%= key %>"><%= value.html_safe %></div>
-			  <% end -%>
-			</section>
-			
-			<%= yield %>
-			
-		</div><!-- .wrapper -->
+	 <header class="navbar navbar-fixed-top">
+	   <nav class="navbar-inner">
+	     <div class="container">
+	       <h1 class="brand"><%= link_to "Touchstone Metrics", root_url %></h1>
+	     </div>
+	   </nav>
+	 </header>
+	 <div id="main" role="main">
+	   <div class="container">
+	     <div class="content">
+	        <div class="row">
+	         	<div class="span12">
+							<% flash.each do |key, value| -%>
+								<div class="alert alert-<%= key %>">
+									<a class="close" data-dismiss="alert">×</a>
+									<p><%= value.html_safe %></p>
+								</div><!-- eo .alert -->
+							<% end -%>
+							
+							<%= yield %>
+						</div><!-- eo .span12 -->
+					</div><!-- eo .row -->
+				</div><!-- eo .content -->
+				<footer>
+				</footer>
+			</div> <!--! end of .container -->
+		</div> <!--! end of #main -->
 	</body>
 </html>

data/app/views/touchstone/campaigns/_campaign_form.html.erb

@@ -0,0 +1,42 @@
+<%= form_for @campaign, :html => {:class => "well span6"} do |f| %>
+	
+	<div class="control-group">
+		<%= f.label :name, :class => "control-label" %>
+		<div class="controls">
+			<%= f.text_field :name %>
+		</div><!-- eo .controls -->
+	</div><!-- eo .control-group -->
+	
+	<div class="control-group">
+		<%= f.label :notes, :class => "control-label" %>
+		<div class="controls">
+			<%= f.text_area :notes, :class => "span6", :rows => 5 %>
+		</div><!-- eo .controls -->
+	</div><!-- eo .control-group -->
+	
+	<div class="control-group">
+		<%= f.label :start_date, :class => "control-label" %>
+		<div class="controls">
+			<%= f.date_select :start_date, :order => [:day, :month, :year] %>
+		</div><!-- eo .controls -->
+	</div><!-- eo .control-group -->
+	
+	<div class="control-group">
+		<%= f.label :end_date, :class => "control-label" %>
+		<div class="controls">
+			<%= f.date_select :end_date, :order => [:day, :month, :year] %>
+		</div><!-- eo .controls -->
+	</div><!-- eo .control-group -->
+	
+	<div class="control-group">
+		<%= f.label :spend_amount, :class => "control-label" %>
+		<div class="controls">
+			<%= f.text_field :spend_amount %>
+		</div><!-- eo .controls -->
+	</div><!-- eo .control-group -->
+	
+	<p>
+		<%= f.submit :class => "btn btn-primary" %> or <%= link_to "cancel", campaigns_path %>
+	</p>
+	
+<% end %>

data/app/views/touchstone/campaigns/edit.html.erb

@@ -0,0 +1,3 @@
+<div class="page-header"><h1>Edit Campaign</h1></div>
+
+<%= render :partial => 'campaign_form' %>

data/app/views/touchstone/campaigns/index.html.erb

@@ -1,8 +1,9 @@
-<p id="new-campaign"><%= link_to "New campaign", new_campaign_url %></p>
+<div class="page-header">
+	<%= link_to "<i class='icon-plus icon-white'></i>&nbsp;New campaign".html_safe, new_campaign_url, :class => "btn btn-primary" %>
+	<h1>Campaigns</h1>
+</div><!-- eo .page-header -->
 
-<h1>Campaigns</h1>
-
-<table>
+<table class="table table-striped">
 	<thead>
 		<tr>
 			<th scope="col" width="15%">Campaign ID</th>

data/app/views/touchstone/campaigns/new.html.erb

@@ -1,29 +1,3 @@
-<h1>New campaign</h1>
+<div class="page-header"><h1>New campaign</h1></div>
 
-<%= form_for @campaign do |f| %>
-	
-	<p>
-		<%= f.label :name %>
-		<%= f.text_field :name %>
-	</p>
-	<p>
-		<%= f.label :notes %>
-		<%= f.text_area :notes %>
-	</p>
-	<p>
-		<%= f.label :start_date %>
-		<%= f.date_select :start_date, :order => [:day, :month, :year] %>
-	</p>
-	<p>
-		<%= f.label :end_date %>
-		<%= f.date_select :end_date, :order => [:day, :month, :year] %>
-	</p>
-	<p>
-		<%= f.label :spend_amount %>
-		<%= f.text_field :spend_amount %>
-	</p>
-	<p>
-		<%= f.submit "Create campaign" %>
-	</p>
-	
-<% end %>
+<%= render :partial => 'campaign_form' %>

data/app/views/touchstone/campaigns/show.html.erb

@@ -1,27 +1,31 @@
-<p><%= link_to "Home", campaigns_url %></p>
-
-<h1>Campaign - <%= @campaign.name %></h1>
+<div class="page-header">
+	<%= link_to "<i class='icon-pencil'></i>&nbsp;Edit".html_safe, edit_campaign_url(@campaign), :class => "btn" %>
+	<%= link_to "<i class='icon-home icon-white'></i>&nbsp;Home".html_safe, campaigns_url, :class => "btn btn-primary" %>
+	<h1>Campaign - <%= @campaign.name %>&nbsp;<small><abbr title="Append this to the end of each link used in this campaign e.g. http://yourdomain.com/?cid=1">?cid=<%= @campaign.id %></abbr></small></h1>
+</div><!-- eo .page-header -->
 
 <section id="campaign-info">
-	<p><strong>Campaign ID:</strong> <%= @campaign.id %></p>
-
-	<p><strong>Campaign dates:</strong> From <%= @campaign.start_date.strftime("%d %B %Y") %> to <%= @campaign.end_date.strftime("%d %B %Y") %></p>
+	<% if @campaign.end_date < Date.today %>
+		<p class="ended">This campaign has ended.</p>
+	<% else %>
+		<p class="running">This campaign is currently running.</p>
+	<% end %>
 </section><!-- #campaign-info -->
 
 <section id="financials" class="stats">
-	<h3><span class="financial-title">Campaign Spend:</span> $<%= sprintf("%.2f", @campaign.spend_amount) %></h3> 
-	<h3><span class="financial-title">Campaign Revenue:</span> $<%= sprintf("%.2f", @campaign.revenue) %></h3>
-	<h3><span class="financial-title">Return on investment:</span> <%= sprintf("%.2f", @campaign.roi) %>%</h3>
+	<h3>Campaign Spend: <span>$<%= sprintf("%.2f", @campaign.spend_amount) %></span></h3> 
+	<h3>Campaign Revenue: <span>$<%= sprintf("%.2f", @campaign.revenue) %></span></h3>
+	<h3>Return on investment: <span><%= sprintf("%.2f", @campaign.roi) %>%</span></h3>
 </section>
 
 <section id="visits" class="stats">
-	<h3><span class="visit-title">Unique Campaign Visits:</span> <%= @campaign.visits %></h3>
-	<h3><span class="visit-title">Conversion Rate:</span> <%= sprintf("%.2f",@campaign.conversion_rate) %>%</h3>
+	<h3>Unique Campaign Visits: <span><%= @campaign.visits %></span></h3>
+	<h3>Conversion Rate: <span><%= sprintf("%.2f",@campaign.conversion_rate) %>%</span></h3>
 </section>
 
 <h2>Signups via this campaign</h2>
 
-<table>
+<table class="table table-striped">
 	<thead>
 		<tr>
 			<th scope="col" width="25%">Name</th>

data/config/routes.rb

@@ -1,5 +1,6 @@
 Touchstone::Engine.routes.draw do
   
+  root :to => 'campaigns#index'
   resources :campaigns
   
 end

data/lib/touchstone/engine.rb

@@ -1,3 +1,7 @@
+require 'rubygems'
+require 'sass-rails'
+require 'bootstrap-sass'
+
 module Touchstone
   class Engine < ::Rails::Engine
     isolate_namespace Touchstone

data/lib/touchstone/version.rb

@@ -1,3 +1,3 @@
 module Touchstone
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: touchstone
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +85,7 @@ extra_rdoc_files: []
 files:
 - app/assets/javascripts/touchstone/application.js
 - app/assets/stylesheets/touchstone/application.css
-- app/assets/stylesheets/touchstone/touchstone.css
+- app/assets/stylesheets/touchstone/touchstone.css.scss
 - app/controllers/touchstone/application_controller.rb
 - app/controllers/touchstone/campaigns_controller.rb
 - app/helpers/touchstone/application_helper.rb
@@ -62,6 +94,8 @@ files:
 - app/models/campaign_visit.rb
 - app/views/layouts/touchstone/application.html.erb
 - app/views/layouts/touchstone/touchstone.html.erb
+- app/views/touchstone/campaigns/_campaign_form.html.erb
+- app/views/touchstone/campaigns/edit.html.erb
 - app/views/touchstone/campaigns/index.html.erb
 - app/views/touchstone/campaigns/new.html.erb
 - app/views/touchstone/campaigns/show.html.erb
@@ -122,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1247631100298585288
+      hash: 2775789728872251427
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1247631100298585288
+      hash: 2775789728872251427
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.20

data/app/assets/stylesheets/touchstone/touchstone.css

@@ -1,113 +0,0 @@
-.touchstone {
-	font: 62.5% "Helvetica Neue", "Lucida Grande", "Trebuchet MS", Verdana, sans-serif;
-	font-weight: normal;
-	-webkit-text-shadow: 0px -1px 0px rgb(68,68,68);
-}
-
-.touchstone .wrapper {
-	width: 960px;
-	margin: 10px auto;
-}
-
-.touchstone h1 {
-	font-size: 3em;
-	margin-bottom: 1em;
-}
-
-.touchstone h2 {
-	font-size: 2.4em;
-	margin-bottom: 1em;
-}
-
-.touchstone h3 {
-	font-size: 2em;
-	margin-bottom: 1em;
-}
-
-.touchstone label {
-	float: left;
-	width: 120px;
-	margin-top: 2px;
-	font-weight: bold;
-}
-
-.touchstone p {
-	font-size: 1.4em;
-	margin-bottom: 1em;
-}
-
-.touchstone table {
-	font-size: 1.4em;
-	border: 1px solid rgb(153,178,183);
-	border-spacing: 0px 0px;
-	width: 100%;
-}
-
-.touchstone thead th {
-	padding: 8px 5px;
-	vertical-align: middle;
-	text-align: left;
-	text-transform: uppercase;
-	border-bottom: 1px solid rgb(153,178,183);
-	border-right: 1px solid rgb(153,178,183);
-	background-color: rgb(213,222,217);
-}
-
-.touchstone td {
-	font-size: 1.2em;
-	padding: 5px;
-	border-bottom: 1px solid rgb(153,178,183);
-	border-right: 1px solid rgb(153,178,183);
-}
-
-.touchstone #new-campaign {
-	float: right;
-	margin-top: 10px;
-}
-
-.touchstone #flash_notice {
-	background-color: #65ce6f;
-	border: 1px solid #00cf13;
-	font-weight: bold;
-	text-align: center;
-	padding: 5px 0;
-	margin: 0 200px 10px 200px;
-}
-
-.touchstone #flash_error {
-	background-color: #ff7272;
-	border: 1px solid #ff1515;
-	font-weight: bold;
-	text-align: center;
-	padding: 5px 0;
-	margin: 0 200px 10px 200px;
-}
-
-.touchstone #campaign-info {
-	margin: -3em 0 0 0;
-	font-size: 0.8em;
-}
-
-.touchstone #campaign-info p {
-	margin-top: -1em;
-}
-
-.touchstone #financials {
-	margin-bottom: 10px;
-}
-
-.touchstone .stats h3 {
-	display: inline;
-}
-
-.touchstone .stats span {
-	color: rgb(153,178,183);
-}
-
-.touchstone .stats h3:not(:first-of-type) {
-	margin-left: 15px;
-}
-
-.touchstone #visits {
-	margin-bottom: 20px;
-}