quick_search-core 0.1.1 → 0.2.0

data/app/controllers/quick_search/logging_controller.rb

@@ -0,0 +1,165 @@
+module QuickSearch
+
+  ##
+  # This class handles QuickSearch's internal logging of queries, events (clicks & serves), and sessions
+
+  class LoggingController < ApplicationController
+
+    include QuickSearch::OnCampus
+
+    before_action :handle_session
+    protect_from_forgery except: :log_event
+
+    ##
+    # Logs a search to the database
+    #
+    # This is an API endpoint for logging a search. It requires that at least a search query and a page are 
+    # present in the query parameters. It returns a 200 OK HTTP status if the request was successful, or
+    # an 400 BAD REQUEST HTTP status if any parameters are missing.
+
+    def log_search
+      if params[:query].present? && params[:page].present?
+        @session.searches.create(query: params[:query], page: params[:page])
+        head :ok
+      else
+        head :bad_request
+      end
+    end
+
+    ##
+    # Logs an event to the database. Typically, these can be clicks or serves.
+    #
+    # This is an API endpoint for logging an event. It requires that at least a TODO are 
+    # present in the query parameters. It returns a 200 OK HTTP status if the request was successful, or
+    # an 400 BAD REQUEST HTTP status if any parameters are missing. This endpoint supports JSONP requests.
+
+    def log_event
+      if params[:category].present? && params[:event_action].present? && params[:label].present?
+        # if an action isn't passed in, assume that it is a click
+        action = params.fetch(:action_type, 'click')
+
+        # create a new event on the current session
+        @session.events.create(category: params[:category], item: params[:event_action], query: params[:label][0..250], action: action)
+
+        if params[:ga].present? and params[:ga]
+          send_event_to_ga(params[:category], params[:event_action], params[:label])
+        end
+
+        # check whether this is a jsonp request
+        if params[:callback].present?
+          render :json => { 'response': 'success' }, :callback => params[:callback]
+        else
+          render :json => { 'response': 'success' }
+        end
+      else
+        head :bad_request
+      end
+    end
+
+
+    private
+
+    ##
+    # Logs an event to Google Analytics using the Measurement Protocol API
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/
+
+    def send_event_to_ga(category, action, label)
+      # google_analytics_client_id is a UUID that identifies a particular client to the GA Measurement Protocol API
+      if QuickSearch::Engine::APP_CONFIG['google_analytics_tracking_id'].blank? or QuickSearch::Engine::APP_CONFIG['google_analytics_client_id'].blank?
+        return false
+      end
+
+      # Pass along the client user agent and IP address so it is associated
+      # with the event in Google Analytics
+      params = {
+          v: 1,
+          t: 'event',
+          tid: QuickSearch::Engine::APP_CONFIG['google_analytics_tracking_id'],
+          cid: QuickSearch::Engine::APP_CONFIG['google_analytics_client_id'],
+          ec: category,
+          ea: action,
+          el: label,
+          uip: request.remote_ip,
+          ua: request.user_agent,
+      }
+  
+      client = HTTPClient.new
+      url = "https://www.google-analytics.com/collect?" + params.to_query
+
+      # The measurement protocol API does not validate responses.
+      # The best way to test this is testing the query string against:
+      # https://ga-dev-tools.appspot.com/hit-builder/
+
+      client.post(url)
+
+    end
+
+    ##
+    # Handles creating/updating a session on every request
+
+    def handle_session
+      if is_existing_session?
+        update_session
+      else
+        new_session
+      end
+    end
+
+    ##
+    # Returns true if current request has an existing session, false otherwise
+
+    def is_existing_session?
+      cookies.has_key? :session_id and Session.find_by(session_uuid: cookies[:session_id])
+    end
+
+    ##
+    # Returns true if current request was from a mobile device
+    #
+    # Uses User-Agent from request to make the determination, which may not be all-encompassing
+    # but works for most modern devices/browsers (iOS, Android). Looks for the string "Mobi" within
+    # the user-agent, which normally contains either Mobi or Mobile if the request was from a mobile browser
+
+    def is_mobile?
+      # TODO: better test for mobile?
+      # Recommended here as simple test: https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent
+      request.user_agent.include? "Mobi"
+    end
+
+    ##
+    # Creates a new session, and logs it in the database
+    #
+    # A session is tracked by a UUID that is stored in a cookie, and has a 5 minute expiry time.
+    # Sessions are stored in the database with the time they were initiated, their expiry time (or end time),
+    # whether the request originated from a campus IP address, and whether the request originated from a mobile device
+
+    def new_session
+      on_campus = on_campus?(request.remote_ip)
+      is_mobile = is_mobile?
+      session_expiry = 5.minutes.from_now
+      session_uuid = SecureRandom.uuid
+
+      # create session in db
+      @session = Session.create(session_uuid: session_uuid, expiry: session_expiry, on_campus: on_campus, is_mobile: is_mobile)
+      # set cookie
+      cookies[:session_id] = { :value => session_uuid, :expires => session_expiry }
+    end
+
+    ##
+    # Updates a session's expiration time on cookie and in database
+    #
+    # When a request is made with a non-expired session, the expiration time is updated to 5 minutes from the current time.
+    # This update is reflected in the cookie as well as in the database entry for the session.
+
+    def update_session
+      # update session expiry in the database
+      session_id = cookies[:session_id]
+      @session = Session.find_by session_uuid: session_id
+      @session.expiry = 5.minutes.from_now
+      @session.save
+
+      # update session expiry on cookie
+      cookies[:session_id] = { :value => session_id, :expires => @session.expiry }
+    end
+
+  end
+end

data/app/controllers/quick_search/search_controller.rb

@@ -12,7 +12,6 @@ module QuickSearch
 
     before_action :doi_trap, :log_query
     after_action :realtime_message, only: [:index]
-    protect_from_forgery except: :log_event
 
     def index
       loaded_searches
@@ -114,28 +113,6 @@ module QuickSearch
       end
     end
 
-    def log_search
-      if params[:query].present? && params[:page].present?
-        Search.create(query: params[:query], page: params[:page])
-        head :ok
-      else
-        head :bad_request
-      end
-    end
-
-    def log_event
-      if params[:category].present? && params[:event_action].present? && params[:label].present?
-        Event.create(category: params[:category], action: params[:event_action], label: params[:label][0..250])
-        if params[:callback].present?
-          head :ok, content_type: 'text/javascript'
-        else
-          head :ok
-        end
-      else
-        head :bad_request
-      end
-    end
-
     private
 
     def http_search(endpoint = 'defaults', page_to_render = :index)
@@ -238,6 +215,7 @@ module QuickSearch
       result
     end
 
+    # TODO: move this --- is this necessary?
     def log_query
       if search_in_params?
         @log_query = filter_query(params_q_scrubbed)

data/app/controllers/quick_search/typeahead_controller.rb

@@ -0,0 +1,48 @@
+module QuickSearch
+  class TypeaheadController < ApplicationController
+    protect_from_forgery except: :typeahead
+
+    # This method should return a list of search suggestions for a given searcher
+    # It should return errors if there is no param called 'searcher', if the searcher does not exist
+    # or if the searcher doesn't implement the 'typeahead' method
+    # Otherwise, it should return the result of calling the 'typeahead' method as JSON
+
+    def typeahead
+      # :searcher param expected to be name of a searcher with underscores, ie: ematrix_journal
+      searcher = params[:searcher]
+      query = params[:q] or ''
+      total = params[:total] or 3
+
+      if searcher.blank?
+        logger.error "Typeahead request: no searcher param provided"
+        head :bad_request
+        return nil
+      end
+
+      searcher_string = "QuickSearch::#{searcher.camelize}Searcher"
+
+      begin 
+        klass = searcher_string.constantize
+      rescue NameError
+        logger.error "Typeahead request: searcher #{searcher} does not exist"
+        head :bad_request
+        return nil
+      end
+
+      if klass.method_defined? :typeahead
+        typeahead_result = klass.new(HTTPClient.new, query, total).typeahead
+
+        if params.has_key? 'callback'
+          render json: typeahead_result, callback: params['callback']
+        else
+          render json: typeahead_result
+        end
+      else
+        logger.error "Typeahead request: searcher #{searcher} has no typeahead method"
+        head :bad_request
+        return nil
+      end
+    end
+
+  end
+end

data/app/models/event.rb

@@ -1,2 +1,8 @@
 class Event < ApplicationRecord
+  belongs_to :session
+
+  before_create do
+    self.created_at_string = DateTime.now.strftime("%Y-%m-%d")
+  end
+
 end

data/app/models/search.rb

@@ -1,4 +1,11 @@
 class Search < ApplicationRecord
+
+  belongs_to :session
+
+  before_create do
+    self.created_at_string = DateTime.now.strftime("%Y-%m-%d")
+  end
+
   
   def self.get_most_frequent_searches
     frequent_searches = []

data/app/models/session.rb

@@ -0,0 +1,9 @@
+class Session < ApplicationRecord
+  has_many :searches
+  has_many :events
+
+  before_create do
+    self.created_at_string = DateTime.now.strftime("%Y-%m-%d")
+  end
+
+end

data/app/searchers/quick_search/best_bets_searcher.rb

@@ -56,7 +56,7 @@ module QuickSearch
         result = OpenStruct.new
         result.title = title(best_bet)
         result.link = link(best_bet)
-        result.id = ''
+        result.id = best_bet['id']
         result.description = description(best_bet)
         result.best_bets_type = 'best-bets-regular'
 

data/app/views/layouts/quick_search/_google_analytics.html.erb

@@ -1,15 +1,10 @@
 <% if Rails.env == 'production' or Rails.env == 'staging' %>
 <script>
-    // Classic Analytics
-    var _gaq = _gaq || [];
-    _gaq.push(['_setAccount', "<%= QuickSearch::Engine::APP_CONFIG['google_analytics_tracking_id'] %>"]);
-    _gaq.push(['_trackPageview']);
+// Universal analytics
+(function(i,s,o,g,r,a,m){i["GoogleAnalyticsObject"]=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,"script","//www.google-analytics.com/analytics.js","ga");
 
-    (function() {
-    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
-    })();
+ga("create", "<%= QuickSearch::Engine::APP_CONFIG['google_analytics_tracking_id'] %>", "auto");
+ga("send", "pageview");
 
 </script>
 <% end %>

data/app/views/layouts/quick_search/_search_form.html.erb

@@ -4,9 +4,9 @@
         <div class="row collapse">
             <div class="small-10 columns">
                 <% if @query  %>
-                    <input type="search" name="q" id="params-q" class="quicksearch-typeahead search-query" value="<%= @query %>" />
+                    <input type="search" name="q" id="params-q" class="search-query" value="<%= @query %>" />
                 <% else %>
-                    <input type="search" name="q" id="params-q" class="quicksearch-typeahead search-query" placeholder="<%= @search_form_placeholder %>" />
+                    <input type="search" name="q" id="params-q" class="search-query" placeholder="<%= @search_form_placeholder %>" />
                 <% end %>
             </div>
             <div class="small-2 columns">

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

@@ -12,6 +12,10 @@
     <%= javascript_include_tag 'application' %>
     <%= render '/layouts/quick_search/head' %>
     <%= render '/layouts/quick_search/google_analytics' %>
+
+    <!-- datepicker (temp) -->
+    <link rel="stylesheet" href="//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css">
+    <script src="https://code.jquery.com/ui/1.12.1/jquery-ui.js"></script>
 </head>
 <body class="<%= body_class %>" data-quicksearch-ga-query="<%= strip_tags(@log_query) %>">
 <div class="off-canvas-wrap">

data/app/views/quick_search/appstats/_date_range.html.erb

@@ -1,15 +1,16 @@
 <% title('Foo') %>
-<div class="row">
-    <div class="small-12 columns">
-        <h1><%= @page_title %></h1>
-        <div id="appstats-date-filter">
-          <%= form_tag do %>
-            <p>Start Date: <%= select_date @start_date, prefix: :start_date %></p>
-            <p>End Date: <%= select_date @end_date, prefix: :end_date %></p>
-            <p><%= submit_tag("Update") %></p>
-          <% end %>
-        </div>
-        <p><%= "#{@start_date.to_formatted_s(:long) } to #{@end_date.to_formatted_s(:long)}" %> <a id="appstats-date-showhide">(Change start/end dates)</a></p>
-        <p><%= "#{@days_in_sample} days in sample" %></p>
-    </div>
+<div class="medium-2 columns" style="position: fixed; right: 0;">
+	<div style="">
+	<label  for="from" 		class="inputLabel"> From: </label>
+    <input  id="from"		type="text" 	name="from">
+	<label  for="to" 		class="inputLabel"> To: </label>
+    <input  id="to"			type="text" 	name="to">
+	<p id="datePickerText"> Days in Sample: </p> 
+	<p id="numDays"><%= "#{@days_in_sample}" %></p>
+    <% if @page_title=='spelling-suggestion'||@page_title=='best-bets-regular'||@page_title=='Top Searches' %> 
+        <label  for="num"		class="inputLabel"> # Results: </label>
+   		<input  id="num"		type="number" 	name="num" min="0" max="200">
+    <% end %>
+    <button id="dateButton"	type="button"> Update </button>
+    <div>
 </div>

data/app/views/quick_search/appstats/_graph_best_bets.html.erb

@@ -0,0 +1,6 @@
+<h1><%= @page_title %></h1>
+<h2>Most Frequent Best-Bets</h2>
+<div class="graphGroup">
+	<div class="iconContainer" id="bbIconContainer"></div>
+	<svg id="graph_best_bets" width="840" height="240"></svg>
+</div>

data/app/views/quick_search/appstats/_graph_clicks_overview.html.erb

@@ -0,0 +1,12 @@
+<h1><%= @page_title %></h1>
+<h2>Frequency of Modules Clicked</h2>
+<div class="graphGroup">
+	<div class="iconContainer" id="moduleIconContainer"></div>
+	<svg id="graph_module_clicks" width="840" height="240"></svg>
+</div>
+
+<h2>Frequency of Result-Type Guides Clicked</h2>
+<div class="graphGroup">
+	<div class="iconContainer" id="resultIconContainer"></div>
+	<svg id="graph_result_clicks" width="840" height="240"></svg>
+</div>

data/app/views/quick_search/appstats/_graph_general_statistics.html.erb

@@ -0,0 +1,19 @@
+<h1><%= @page_title %></h1>
+<div class="graphGroup">
+    <div class="iconContainer" id="tableIconContainer"></div>
+    <svg class="graph" id="graph_general_table" width="840" height="473"></svg>
+    </svg>
+</div>
+
+<div class="graphGroup">
+    <div class="iconContainer" id="graphIconContainer"></div>
+    <svg class="graph" id="graph_general_statistics" width="840" height="473">
+    </svg>
+</div>
+
+<div style="display: inline-block; width: 1000px;">
+    <svg class="graph_mini" id="mini0" width="280" height="158" onmouseover="lighten()" onmouseout="darken()"></svg>
+    <svg class="graph_mini" id="mini1" width="280" height="158" onmouseover="lighten()" onmouseout="darken()"></svg>
+    <svg class="graph_mini" id="mini2" width="280" height="158" onmouseover="lighten()" onmouseout="darken()"></svg>
+    <div class="clearfix"></div>
+</div>

data/app/views/quick_search/appstats/_graph_sessions_details.html.erb

@@ -0,0 +1,19 @@
+<h1><%= @page_title %></h1>
+<h2> Sessions by Location </h2>
+<div class="graphGroup">
+    <div class="iconContainer" id="locationIconContainer"></div>
+    <div style="float: left; display: inline-block;">
+    	<svg id="graph_sessions_location" width="840" height="473"></svg>
+    </div>
+    <%= render partial: 'sessions_details_location_filters' %>
+</div>
+
+<div class="clearfix"></div>
+<h2> Sessions by Access Device </h2>
+<div class="graphGroup">
+    <div class="iconContainer" id="deviceIconContainer"></div>
+    <div style="float: left; display: inline-block;">
+    	<svg id="graph_sessions_device" width="840" height="473"></svg>
+    </div>
+    <%= render partial: 'sessions_details_device_filters' %>
+</div>

data/app/views/quick_search/appstats/_graph_sessions_overview.html.erb

@@ -0,0 +1,9 @@
+<h1><%= @page_title %></h1>
+<h2>Sessions Overview</h2>
+<div class="graphGroup">
+    <div class="iconContainer" id="sessIconContainer"></div>
+    <div style="float: left; display: inline-block;">
+    	<svg id="graph_sessions_overview" width="840" height="473"></svg>
+    </div>
+	<%= render partial: 'sessions_overview_graph_filters' %>
+</div>