intel 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6afd8d515e1b008debd378f41f709f6a9e59b20
-  data.tar.gz: e514f5ffc47f3e45bdb1ab72b68117d50201e981
+  metadata.gz: 31879a36e725be72dc34b53afa077f6d2f31bc7b
+  data.tar.gz: 697d5bf3d20c5cc93c5d42df6ab868cb24834df8
 SHA512:
-  metadata.gz: ba504e4d707d5bdd3aa542443bb3769418bf4e13aa5d1ddef9cc855f1aeca7e99faea8034c66c12a7f0ba4dd42d57d4aa3696a890408d3d71048c4af3ca2a151
-  data.tar.gz: ba7dae63eaa56c1380733f31acde069c9e1a84be927af85dd1109abb44b358c7c1e2aeccbb2823d1c8d6062e0c63fd8dbea92ffdfbce5c5c73efb0231cffc34c
+  metadata.gz: e62375f43d6f457a653b9e45c56801620948d0b81a53e55b83a8e7ecd3aa1d69bf42c67f8498c7c994facb9ef0e292446ee5d2ddc53955db8b2437d3bf288b4f
+  data.tar.gz: 9266b4153c82fc6bf57390a5b3143401e2a483b74dbc6129dfde691d3b079aaeff189ae25a218c3f3ccc518ef98bc27061bb452ae8c25cf29e5d38635325490e

data/README.md

@@ -63,41 +63,22 @@ It’s that easy.
 
 ### Track Conversions
 
-Tracking conversions is super important.
+First, choose a conversion metric. At [Instacart](https://www.instacart.com/), an item added to the cart from the search results page counts as a conversion.
 
-First, define your conversion metric. This is specific to your application.
+Next, when a user searches, keep track of the search id. With Searchkick, you can get the id with `@results.search.id`.
 
-Next, when a user searches, keep track of the search id.
+When a user converts, find the record and call `converted`.
 
 ```ruby
-@items = Item.search "apple", track: true
-@items.search.id # returns search id
+search = Intel::Search.find params[:id]
+search.converted
 ```
 
-When a user converts, mark it.
-
-```ruby
-search = Intel::Search.find params[:search_id]
-search.converted_at = Time.now
-search.save
-```
-
-Better yet, record the result that converted.
+Better yet, record the model that converted.
 
 ```ruby
 item = Item.find params[:item_id]
-search.convertable = item
-search.save
-```
-
-The item will appear in the live stream. Add the `intel_name` method to your model to change what is displayed.
-
-```ruby
-class Item < ActiveRecord::Base
-  def intel_name
-    title # use the title method
-  end
-end
+search.converted(item)
 ```
 
 ### Authentication
@@ -139,6 +120,14 @@ Change the number of top searches shown with:
 Intel.top_searches = 500 # defaults to 100
 ```
 
+#### Live Conversions
+
+Show the conversion name in the live stream.
+
+```ruby
+Intel.conversion_name = proc{|model| model.name }
+```
+
 ## TODO
 
 - customize views

data/app/controllers/intel/searches_controller.rb

@@ -31,15 +31,8 @@ module Intel
     def stream
     end
 
-    # suspiciously similar to bootstrap 3
-    COLORS = %w[5bc0de d9534f 5cb85c f0ad4e]
-
     def recent
       @searches = Intel::Search.order("created_at desc").limit(10)
-      @color = {}
-      @search_types.each_with_index do |search_type, i|
-        @color[search_type] = COLORS[i % COLORS.size]
-      end
       render layout: false
     end
 
@@ -54,7 +47,7 @@ module Intel
     end
 
     def set_time_zone
-      @time_zone = Intel.time_zone
+      @time_zone = Intel.time_zone || Time.zone
     end
 
     def set_time_range

data/app/views/intel/searches/index.html.erb

@@ -1,6 +1,6 @@
 <h1>
   <%= @search_type %> Searches
-  <small style="color: #999; font-weight: normal;">Top <%= @limit %></small>
+  <small>Top <%= @limit %></small>
 </h1>
 
 <table>

data/app/views/intel/searches/overview.html.erb

@@ -6,7 +6,7 @@
       <thead>
         <tr>
           <th>Top Searches</th>
-          <th class="num"><%= link_to "View all", intel.searches_path(search_type: params[:search_type]) %></th>
+          <th class="num"><%= link_to "View all", intel.searches_path(search_type: @search_type) %></th>
         </tr>
       </thead>
       <tbody>
@@ -24,7 +24,7 @@
       <thead>
         <tr>
           <th>Low Conversions</th>
-          <th class="num"><%= link_to "View all", intel.searches_path(search_type: params[:search_type], sort: "conversion_rate") %></th>
+          <th class="num"><%= link_to "View all", intel.searches_path(search_type: @search_type, sort: "conversion_rate") %></th>
         </tr>
       </thead>
       <tbody>

data/app/views/intel/searches/recent.html.erb

@@ -1,20 +1,18 @@
 <% @searches.each do |search| %>
   <tr>
     <td style="width: 15%;">
-      <%= link_to search.search_type, intel.overview_searches_path(search_type: search.search_type), class: "type-link", style: "background-color: ##{@color[search.search_type]};" %>
+      <%= link_to search.search_type, intel.overview_searches_path(search_type: search.search_type), class: "type-link type-link-#{@search_types.index(search.search_type)}" %>
     </td>
     <td><%= search.query %></td>
-    <td style="width: 35%;">
+    <td style="width: 35%; color: #5cb85c;">
       <% if search.converted_at %>
-        <span style="color: #5cb85c;">
-          <span style="font-weight: bold;">✓</span>
-          <%= search.convertable ? (search.convertable.respond_to?(:intel_name) ? search.convertable.intel_name : "#{search.convertable_type} #{search.convertable_id}") : "Converted" %>
-        </span>
+        <strong>✓</strong>
+        <%= search.convertable ? (Intel.conversion_name ? Intel.conversion_name.call(search.convertable) : "#{search.convertable_type} #{search.convertable_id}") : "Converted" %>
       <% end %>
     </td>
     <td style="width: 20%;" class="num">
       <%= time_ago_in_words search.created_at %> ago
-      <div style="color: #999;"><%= pluralize search.results_count, "result" %></div>
+      <div class="text-muted"><%= pluralize search.results_count, "result" %></div>
     </td>
   </tr>
 <% end %>

data/app/views/layouts/intel/application.html.erb

@@ -40,6 +40,11 @@
         font-size: 20px;
       }
 
+      h1 small {
+         color: #999;
+         font-weight: normal;
+      }
+
       h2 {
         font-size: 16px;
       }
@@ -57,6 +62,10 @@
         border-top: solid 1px #ddd;
       }
 
+      .text-muted {
+        color: #999;
+      }
+
       #brand {
         font-size: 18px;
         line-height: 20px;
@@ -69,15 +78,29 @@
       }
 
       a.type-link {
-         color: #fff;
-         padding: 8px;
-         border-radius: 4px;
+        background-color: #f0ad4e;
+        color: #fff;
+        padding: 8px;
+        border-radius: 4px;
       }
 
       a.type-link:hover {
         text-decoration: none;
       }
 
+      /* suspiciously similar to bootstrap 3 */
+      a.type-link-0 {
+        background-color: #5bc0de;
+      }
+
+      a.type-link-1 {
+        background-color: #d9534f;
+      }
+
+      a.type-link-2 {
+        background-color: #5cb85c;
+      }
+
       #header {
         border-bottom: solid 1px #ddd;
         padding-bottom: 20px;
@@ -262,28 +285,26 @@
   </head>
   <body>
     <div class="container">
-      <% if !@skip_header %>
-        <div id="header">
-          <div class="grid">
-            <div class="col-1-2">
-              <ul class="nav">
-                <li id="brand">Intel</li>
-                <li><%= link_to "Live Stream", intel.root_path, class: ("active" if !@search_type) %></li>
-                <% @search_types.each do |search_type| %>
-                  <li><%= link_to search_type, intel.overview_searches_path(search_type: search_type), class: ("active" if @search_type == search_type) %></li>
-                <% end %>
-              </ul>
-            </div>
-
-            <div class="col-1-2" style="text-align: right;">
-              <% if %w[overview index].include?(params[:action]) and @time_range %>
-                <%= @time_range.first.strftime("%b %-e, %Y") %> to <%= @time_range.last.strftime("%b %-e, %Y") %>
-                <span style="color: #999;"><%= @time_zone.name.sub(" (US & Canada)", "") %></span>
+      <div id="header">
+        <div class="grid">
+          <div class="col-1-2">
+            <ul class="nav">
+              <li id="brand">Intel</li>
+              <li><%= link_to "Live Stream", intel.root_path, class: ("active" if !@search_type) %></li>
+              <% @search_types.each do |search_type| %>
+                <li><%= link_to search_type, intel.overview_searches_path(search_type: search_type), class: ("active" if @search_type == search_type) %></li>
               <% end %>
-            </div>
+            </ul>
+          </div>
+
+          <div class="col-1-2" style="text-align: right;">
+            <% if @time_range %>
+              <%= @time_range.first.strftime("%b %-e, %Y") %> to <%= @time_range.last.strftime("%b %-e, %Y") %>
+              <span class="text-muted"><%= @time_zone.name.sub(" (US & Canada)", "") %></span>
+            <% end %>
           </div>
         </div>
-      <% end %>
+      </div>
 
       <%= yield %>
     </div>

data/lib/intel/search.rb

@@ -4,6 +4,14 @@ module Intel
 
     before_save :set_normalized_query
 
+    def converted(convertable = nil)
+      if !converted?
+        self.converted_at = Time.now
+        self.convertable = convertable
+        save(validate: false)
+      end
+    end
+
     def converted?
       converted_at.present?
     end

data/lib/intel/version.rb

@@ -1,3 +1,3 @@
 module Intel
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/intel.rb

@@ -16,6 +16,9 @@ module Intel
   # top searches
   mattr_accessor :top_searches
   self.top_searches = 100
+
+  # conversion name
+  mattr_accessor :conversion_name
 end
 
 if defined?(Searchkick)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intel
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrew Kane