Initial import. Still very alpha.

Author: toastdriven

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.pyc

AUTHORS

@@ -0,0 +1,7 @@
+Primary author:
+
+* Daniel Lindsley
+
+Contributors:
+
+* 

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2010, Daniel Lindsley.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, 
+       this list of conditions and the following disclaimer.
+    
+    2. Redistributions in binary form must reproduce the above copyright 
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of saved_searches nor the names of its contributors may
+       be used to endorse or promote products derived from this software without
+       specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.rst

@@ -0,0 +1,23 @@
+=============
+saved_searches
+=============
+
+Allows you to personalize search by storing a user's search history.
+
+For use with Haystack (http://haystacksearch.org/).
+
+
+Requirements
+============
+
+* Django 1.1+ (May work on 1.0.X but untested)
+* Haystack 1.X (http://github.com/toastdriven/django-haystack)
+
+
+Setup
+=====
+
+#. Add ``saved_searches`` to ``INSTALLED_APPS``.
+#. ``./manage.py syncdb``.
+#. Alter either your URLconfs to use the ``saved_searches.views.SavedSearchView``
+   or change the inheritance of your subclassed views.

TODO

@@ -0,0 +1,7 @@
+TODO
+====
+
+- Tests.
+- Add a template tag for fetching a user's searches.
+- Add aggregated views to see all activity (omitting user information).
+- Perhaps add an AJAX view that returns suggested searches?

saved_searches/__init__.py

@@ -0,0 +1,2 @@
+__author__ = 'Daniel Lindsley'
+__version__ = ('1', '0', '0', 'alpha')

saved_searches/admin.py

@@ -0,0 +1,13 @@
+from django.contrib import admin
+from saved_searches.models import SavedSearch
+
+
+class SavedSearchAdmin(admin.ModelAdmin):
+    date_hierarchy = 'created'
+    list_display = ('user_query', 'search_key', 'user', 'result_count', 'created')
+    list_filter = ('search_key',)
+    raw_id_fields = ('user',)
+    search_fields = ('user_query', 'search_key')
+
+
+site.register(SavedSearch, SavedSearchAdmin)

saved_searches/models.py

@@ -0,0 +1,18 @@
+import datetime
+from django.contrib.auth.models import User
+from django.db import models
+
+
+class SavedSearch(models.Model):
+    search_key = models.SlugField(max_length=100, help_text="A way to arbitrarily group queries. Should be a single word. Example: all-products")
+    user_query = models.CharField(max_length=1000, help_text="The text the user searched on. Useful for display.")
+    full_query = models.CharField(max_length=1000, help_text="The full query Haystack generated. Useful for searching again.")
+    result_count = models.PositiveIntegerField(default=0)
+    user = models.ForeignKey(User, blank=True, null=True, related_name='saved_searches')
+    created = models.DateTimeField(default=datetime.datetime.now)
+    
+    def __unicode__(self):
+        if self.user:
+            return u"'%s...' by %s:%s" % (self.user_query[:50], self.user.username, self.search_key)
+        
+        return u"'%s...' by Anonymous:%s" % (self.user_query[:50], self.search_key)

saved_searches/tests/__init__.py

@@ -0,0 +1 @@
+# DRL_TODO: Create aggregated views and hook them up here.

saved_searches/urls.py

@@ -0,0 +1,46 @@
+from haystack.views import SearchView
+from saved_searches.models import SavedSearch
+
+
+class SavedSearchView(SearchView):
+    search_key = 'general'
+    
+    def __init__(self, *args, **kwargs):
+        if 'search_key' in kwargs:
+            self.search_key = kwargs['search_key']
+            del(kwargs['search_key'])
+        
+        super(SavedSearchView, self).__init__(*args, **kwargs)
+    
+    def create_response(self):
+        """
+        Saves the details of a user's search and then generates the actual
+        HttpResponse to send back to the user.
+        """
+        (paginator, page) = self.build_page()
+        
+        saved_search = SavedSearch(
+            search_key=self.search_key,
+            user_query=self.query,
+            result_count=paginator.count
+        )
+        
+        query_seen = self.searchqueryset.query.build_query()
+        
+        if isinstance(query_seen, basestring):
+            saved_search.full_query = query_seen
+        
+        if request.user.is_authenticated():
+            saved_search.user = request.user
+        
+        saved_search.save()
+        
+        context = {
+            'query': self.query,
+            'form': self.form,
+            'page': page,
+            'paginator': paginator,
+        }
+        context.update(self.extra_context())
+        
+        return render_to_response(self.template, context, context_instance=self.context_class(self.request))

saved_searches/views.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from distutils.core import setup
+
+setup(
+    name='saved_searches',
+    version='1.0.0-alpha',
+    description='Saves user searches for integration with Haystack.',
+    author='Daniel Lindsley',
+    author_email='[email protected]',
+    url='http://github.com/toastdriven/saved_searches',
+    packages=[
+        'saved_searches',
+        'queued_search.templatetags',
+    ],
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Web Environment',
+        'Framework :: Django',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Utilities'
+    ],
+)