Clean up analytics and embed pages.

Add dynamic help

Author: ericholscher

media/css/core.css

@@ -632,3 +632,54 @@ select.dropdown { display: none; }
 .badge > ul { margin-top: 3px; position:absolute; top:100%; background:#465158; padding:4px; border-radius:4px; z-index:1005; min-width:500; box-shadow: 0px 0px 8px 2px rgba(0,0,0,0.2); }
 .badge > ul > li { background: white; padding:8px 10px; border-bottom:1px solid #EEE; }
 .badge pre { font-size: 12px; }
+
+#help_container > a { float:right; }
+
+
+
+    /* CHART LISTS */
+    .chartlist { 
+      float: left; 
+      border-top: 1px solid #EEE; 
+      width: 15em;
+    }
+    .chartlist li { 
+      position: relative;
+      display: block;  
+      border-bottom: 1px solid #EEE; 
+      _zoom: 1;
+    }
+    .chartlist li a { 
+      display: block; 
+      padding: 0.4em 4.5em 0.4em 0.5em;
+      position: relative; 
+      z-index: 2; 
+    }
+    .chartlist .count { 
+      display: block; 
+      position: absolute; 
+      top: 0; 
+      right: 0; 
+      margin: 0 0.3em; 
+      text-align: right; 
+      color: #999; 
+      font-weight: bold; 
+      font-size: 0.875em; 
+      line-height: 2em; 
+      z-index: 5; 
+    }
+    .chartlist .index { 
+      display: block; 
+      position: absolute; 
+      top: 0; 
+      left: 0; 
+      height: 100%; 
+      background: #B8E4F5; 
+      text-indent: -9999px; 
+      overflow: hidden; 
+      line-height: 2em;
+      z-index: 1; 
+    }
+    .chartlist li:hover { 
+      background: #EFEFEF; 
+    }

readthedocs/core/templatetags/core_tags.py

@@ -95,3 +95,7 @@ def url_replace(request, field, value):
     dict_[field] = value
     return dict_.urlencode()
 
+
+@register.filter
+def key(d, key_name):
+    return d[key_name]

readthedocs/projects/urls/public.py

@@ -46,9 +46,13 @@
         'projects.views.public.project_versions',
         name='project_version_list'),
 
-    url(r'^(?P<project_slug>[-\w]+)/tools/$',
-        'projects.views.public.project_tools',
-        name='project_tools'),
+    url(r'^(?P<project_slug>[-\w]+)/tools/embed/$',
+        'projects.views.public.project_embed',
+        name='project_embed'),
+
+    url(r'^(?P<project_slug>[-\w]+)/tools/analytics/$',
+        'projects.views.public.project_analytics',
+        name='project_analytics'),
 
     url(r'^(?P<project_slug>[-\w]+)/search/$',
         'projects.views.public.elastic_project_search',

readthedocs/projects/views/public.py

@@ -1,10 +1,13 @@
+import collections
+import operator
 import os
 import json
 import logging
 import mimetypes
 import md5
 
 from django.core.urlresolvers import reverse
+from django.core.cache import cache
 from django.conf import settings
 from django.contrib.auth.models import User
 from django.http import HttpResponse, HttpResponseRedirect, Http404
@@ -93,7 +96,6 @@ def get_context_data(self, **kwargs):
             project.get_default_version(),
         )
 
-
         return context
 
 
@@ -385,7 +387,42 @@ def project_versions(request, project_slug):
     )
 
 
-def project_tools(request, project_slug):
+def project_analytics(request, project_slug):
+    """
+    Have a analytics API placeholder
+    """
+    project = get_object_or_404(Project.objects.protected(request.user),
+                                slug=project_slug)
+    analytics_cache = cache.get('analytics:%s' % project_slug)
+    if analytics_cache:
+        analytics = json.loads(analytics_cache)
+    else:
+        try:
+            resp = requests.get('https://api.grokthedocs.com/api/v1/index/1/heatmap/', params={'project': project.slug, 'days': 7, 'compare': True})
+            analytics = resp.json()
+        except:
+            analytics = None
+
+    if analytics:
+        page_list = reversed(sorted(analytics['page'].items(), key=operator.itemgetter(1)))
+        version_list = reversed(sorted(analytics['version'].items(), key=operator.itemgetter(1)))
+    else:
+        page_list = []
+        version_list = []
+
+    return render_to_response(
+        'projects/project_analytics.html',
+        {
+            'project': project,
+            'analytics': analytics,
+            'page_list': page_list,
+            'version_list': version_list,
+        },
+        context_instance=RequestContext(request)
+    )
+
+
+def project_embed(request, project_slug):
     """
     Have a content API placeholder
     """
@@ -394,18 +431,11 @@ def project_tools(request, project_slug):
     version = project.versions.get(slug='latest')
     files = version.imported_files.order_by('path')
 
-    try:
-        resp = requests.get('https://api.grokthedocs.com/api/v1/index/1/heatmap/', params={'project': project.slug, 'compare': True})
-        analytics = resp.json()
-    except:
-        analytics = None
-
     return render_to_response(
-        'projects/project_tools.html',
+        'projects/project_embed.html',
         {
             'project': project,
             'files': files,
-            'analytics': analytics,
         },
         context_instance=RequestContext(request)
     )

readthedocs/restapi/urls.py

@@ -13,6 +13,7 @@
 urlpatterns = patterns(
     '',
     url(r'^', include(router.urls)),
+    url(r'docurl/', 'restapi.views.core_views.docurl', name='docurl'),
     url(r'cname/', 'restapi.views.core_views.cname', name='cname'),
     url(r'footer_html/', 'restapi.views.footer_views.footer_html', name='footer_html'),
     url(r'quick_search/', 'restapi.views.search_views.quick_search', name='quick_search'),

readthedocs/restapi/views/core_views.py

@@ -2,8 +2,13 @@
 from rest_framework.renderers import JSONPRenderer, JSONRenderer, BrowsableAPIRenderer
 from rest_framework.response import Response
 
+from django.shortcuts import get_object_or_404
+
 from core.utils import clean_url, cname_to_slug
+from builds.models import Version
 from projects.models import Project
+from core.templatetags.core_tags import make_document_url
+
 
 @decorators.api_view(['GET'])
 @decorators.permission_classes((permissions.AllowAny,))
@@ -26,8 +31,31 @@ def cname(request):
     host = clean_url(host)
     slug = cname_to_slug(host)
     return Response({
-        'host': host, 
-        'slug': slug, 
+        'host': host,
+        'slug': slug,
+    })
+
+
+@decorators.api_view(['GET'])
+@decorators.permission_classes((permissions.AllowAny,))
+@decorators.renderer_classes((JSONRenderer, JSONPRenderer, BrowsableAPIRenderer))
+def docurl(request):
+    """
+    Get the url that a slug resolves to.
+
+    Example::
+
+        GET https://readthedocs.org/api/v2/docurl/?project=requests&version=latest&doc=index
+
+    """
+    project = request.GET.get('project')
+    version = request.GET.get('version', 'latest')
+    doc = request.GET.get('doc', 'index')
+
+    project = get_object_or_404(Project, slug=project)
+    version = get_object_or_404(Version.objects.public(request.user, project=project, only_active=False), slug=version)
+    return Response({
+        'url': make_document_url(project=project, version=version.slug, page=doc)
     })
 
 

readthedocs/templates/core/project_bar_base.html

@@ -45,7 +45,7 @@ <h1>
 
         <li class="{{ versions_active }}"><a href="{% url "project_version_list" project.slug %}">{% trans "Versions" %}</a></li>
 
-        <li class="{{ tools_active }}"><a href="{% url "project_tools" project.slug %}">{% trans "Tools" %}</a></li>
+        <li class="{{ tools_active }}"><a href="{% url 'project_embed' project.slug %}">{% trans "Tools" %}</a></li>
 
         {% if request.user|is_admin:project %}
           <li class="{{ edit_active }} project-admin"><a href="{% url "projects_edit" project.slug %}"><i class="gear"></i>{% trans "Admin" %}</a></li>

readthedocs/templates/projects/project_analytics.html

@@ -0,0 +1,84 @@
+{% extends "projects/base_project.html" %}
+{% load i18n %}
+{% load privacy_tags %}
+{% load core_tags highlight  %}
+
+{% block title %}
+Tools
+{% endblock title %}
+
+{% block project_editing %}
+{% with tools_active="active" %}
+{% include "core/project_bar.html" %}
+{% endwith %}
+{% endblock %}
+
+{% block extra_scripts %}
+<link rel="stylesheet" href="http://localhost:5555/static/css/public.css">
+<script type="text/javascript">
+  var READTHEDOCS_EMBED = {
+    'project': 'docs',
+    'version': 'latest',
+    'doc': 'business/analytics',
+    'section': 'viewing'
+  }
+</script>
+<script type="text/javascript" src="http://localhost:5555/static/javascript/bundle-public.js"></script>
+{% endblock %}
+
+{% block content %}
+
+<div class="navigable">
+
+  <ul>
+    <li class="active">
+      <a href="{% url 'project_analytics' project.slug %}">Analytics</a>
+    </li>
+    <li>
+      <a href="{% url 'project_embed' project.slug %}">Embed</a>
+    </li>
+  </ul>
+
+
+  <div>
+    <div id="help_container">
+      <a href="#" class="quiet readthedocs-help-embed">(Help)</a>
+    </div>
+
+    <h1> {% trans "Analytics" %} </h1>
+
+
+    <p class="help_text">
+      {% trans "This shows the last 7 days of data from your project." %}
+    </p>
+
+    <h3> {% trans "Pages" %} </h3>
+    <ul class="chartlist">
+      {% for page, count in page_list %}
+      <li>
+        <a href="{% doc_url project project.default_version page %}">{{ page }}</a> 
+        <span class="count">{{ count }}</span>
+        <span class="index" style="width: {{ analytics.scaled_page|key:page }}%">({{ analytics.scaled_page|key:page }}%)</span>
+      </li>
+      {% endfor %}
+    </ul>
+  </div>  
+
+
+  <div style="float: right;">
+    <h3> {% trans "Versions" %} </h3>
+    <ul class="chartlist">
+      {% for version, count in version_list %}
+      <li>
+        <a href="{% doc_url project version %}">{{ version }}</a> 
+        <span class="count">{{ count }}</span>
+        <span class="index" style="width: {{ analytics.scaled_version|key:version }}%">({{ analytics.scaled_version|key:version }}%)</span>
+      </li>
+      {% endfor %}
+    </ul>
+
+  </div>
+
+</div>
+
+{% endblock %}