Fix Indexable.refresh_index and es args

pyelasticsearch refresh doesn't take a timeout, so nixing that.

Additionally, it's more flexible if Indexable had its own get_es()
class method that it defaults to using that can be easily overridden.
So I tweaked that code a little.

CHANGELOG

@@ -122,6 +122,16 @@ Version 0.7: in development
   hood, we added a separate `bulk_index()` method and now you control
   how many items get indexed in bulk in one pass.
 
+* **Django: Indexable.refresh_index no longer takes a timeout argument.**
+
+  pyelasticsearch `ElasticSearch.refresh` doesn't take a timesleep
+  argument, so we don't need that anymore.
+
+* **Django: Indexable `es` argument defaults to Indexable.get_es() now.**
+
+  Previously it defaulted to `elasticsearch.contrib.django.get_es()`. Now
+  it defaults to `Indexable.get_es()` class method making it more flexible.
+
 * **pyes -> pyelasticsearch changes.**
 
   If you called ``.get_es()`` and got a pyes `ES` object and did

elasticutils/contrib/django/models.py

@@ -83,6 +83,16 @@ class Indexable(object):
 
     """
 
+    @classmethod
+    def get_es(cls):
+        """Returns an ElasticSearch object
+
+        Override this if you need special functionality.
+        :returns: a pyelasticsearch `ElasticSearch` instance
+
+        """
+        return get_es()
+
     @classmethod
     def get_mapping(cls):
         """Returns the mapping for this mapping type.
@@ -155,8 +165,7 @@ class Indexable(object):
         :arg force_insert: TODO
 
         :arg es: The `ElasticSearch` to use. If you don't specify an
-            `ElasticSearch`, it'll use
-            `elasticutils.contrib.django.get_es()`.
+            `ElasticSearch`, it'll use `cls.get_es()`.
 
         .. Note::
 
@@ -166,7 +175,7 @@ class Indexable(object):
 
         """
         if es is None:
-            es = get_es()
+            es = cls.get_es()
 
         es.index(
             cls.get_index(),
@@ -190,8 +199,7 @@ class Indexable(object):
             id. This defaults to 'id'.
 
         :arg es: The `ElasticSearch` to use. If you don't specify an
-            `ElasticSearch`, it'll use
-            `elasticutils.contrib.django.get_es()`.
+            `ElasticSearch`, it'll use `cls.get_es()`.
 
         .. Note::
 
@@ -201,7 +209,7 @@ class Indexable(object):
 
         """
         if es is None:
-            es = get_es()
+            es = cls.get_es()
 
         es.bulk_index(cls.get_index(),
                       cls.get_mapping_type_name(),
@@ -212,22 +220,32 @@ class Indexable(object):
     def unindex(cls, id_, es=None):
         """Removes a particular item from the search index.
 
-        TODO: document this better.
+        :arg id_: The ElasticSearch id for the document to remove from
+            the index.
+
+        :arg es: The `ElasticSearch` to use. If you don't specify an
+            `ElasticSearch`, it'll use `cls.get_es()`.
 
         """
         if es is None:
-            es = get_es()
+            es = cls.get_es()
 
         es.delete(cls.get_index(), cls.get_mapping_type_name(), id_)
 
     @classmethod
-    def refresh_index(cls, timesleep=0, es=None):
+    def refresh_index(cls, es=None):
         """Refreshes the index.
 
-        TODO: document this better.
+        ElasticSearch will update the index periodically automatically. If you
+        need to see the documents you just indexed in your search results
+        right now, you should call `refresh_index` as soon as you're done
+        indexing. This is particularly helpful for unit tests.
+
+        :arg es: The `ElasticSearch` to use. If you don't specify an
+            `ElasticSearch`, it'll use `cls.get_es()`.
 
         """
         if es is None:
-            es = get_es()
+            es = cls.get_es()
 
-        es.refresh(cls.get_index(), timesleep=timesleep)
+        es.refresh(cls.get_index())

elasticutils/tests/test_django.py

@@ -274,6 +274,10 @@ class IndexableTest(DjangoElasticTestCase):
             return
         IndexableTest.cleanup_index()
 
+    @require_django_or_skip
+    def test_refresh(self):
+        FakeDjangoMappingType.refresh_index()
+
     @require_django_or_skip
     def test_index(self):
         document = {'id': 1, 'name': 'odin skullcrusher'}