Deprecate exception/message and use captureEventTYpe instead1.3.5

5 files changed, 28 insertions, 13 deletions

diff --git a/CHANGES b/CHANGES
index f1ff345..2d255fb 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,8 @@
+1.3.5
+
+* Moved exception and message methods to capture{Exception,Message}.
+* Added captureQuery method.
+
 1.3.4
 
 * Corrected duplicate DSN behavior in Django client.
diff --git a/docs/config/django.rst b/docs/config/django.rst
index 78a43a0..dbf5580 100644
--- a/docs/config/django.rst
+++ b/docs/config/django.rst
@@ -20,7 +20,7 @@ You'll be referencing the client slightly differently in Django as well::
     from raven.contrib.django.models import get_client
 
     client = get_client()
-    client.capture(....)
+    client.captureException()
 
 Integration with ``logging``
 ----------------------------
diff --git a/raven/base.py b/raven/base.py
index 5826e35..a2effda 100644
--- a/raven/base.py
+++ b/raven/base.py
@@ -68,7 +68,7 @@ class Client(object):
     >>> try:
     >>>     1/0
     >>> except ZeroDivisionError:
-    >>>     ident = client.get_ident(client.capture('Exception'))
+    >>>     ident = client.get_ident(client.captureException())
     >>>     print "Exception caught; reference is %%s" %% ident
     """
     logger = logging.getLogger('raven')
@@ -369,28 +369,30 @@ class Client(object):
         return json.loads(base64.b64decode(data).decode('zlib'))
 
     def create_from_text(self, *args, **kwargs):
-        warnings.warn("create_from_text is deprecated. Use message() instead.", DeprecationWarning)
-        return self.message(*args, **kwargs)
+        warnings.warn("create_from_text is deprecated. Use captureMessage() instead.", DeprecationWarning)
+        return self.captureMessage(*args, **kwargs)
+    message = create_from_text
 
     def create_from_exception(self, *args, **kwargs):
-        warnings.warn("create_from_exception is deprecated. Use exception() instead.", DeprecationWarning)
-        return self.exception(*args, **kwargs)
+        warnings.warn("create_from_exception is deprecated. Use captureException() instead.", DeprecationWarning)
+        return self.captureException(*args, **kwargs)
+    exception = create_from_exception
 
-    def message(self, message, **kwargs):
+    def captureMessage(self, message, **kwargs):
         """
-        Creates an event for from ``message``.
+        Creates an event from ``message``.
 
-        >>> client.message('My event just happened!')
+        >>> client.captureMessage('My event just happened!')
         """
         return self.capture('Message', message=message, **kwargs)
 
-    def exception(self, exc_info=None, **kwargs):
+    def captureException(self, exc_info=None, **kwargs):
         """
         Creates an event from an exception.
 
         >>> try:
         >>>     exc_info = sys.exc_info()
-        >>>     client.exception(exc_info)
+        >>>     client.captureException(exc_info)
         >>> finally:
         >>>     del exc_info
 
@@ -400,6 +402,14 @@ class Client(object):
         """
         return self.capture('Exception', exc_info=exc_info, **kwargs)
 
+    def captureQuery(self, query, params=(), engine=None, **kwargs):
+        """
+        Creates an event for a SQL query.
+
+        >>> client.catureQuery('SELECT * FROM foo')
+        """
+        return self.capture('Query', query=query, params=params, engine=engine, **kwargs)
+
 
 class DummyClient(Client):
     "Sends messages into an empty void"
diff --git a/raven/scripts/runner.py b/raven/scripts/runner.py
index 200ce31..a7397e8 100644
--- a/raven/scripts/runner.py
+++ b/raven/scripts/runner.py
@@ -37,7 +37,7 @@ def main():
         sys.exit(1)
 
     print 'Sending a test message...',
-    ident = client.get_ident(client.message('This is a test message generated using ``raven test``'))
+    ident = client.get_ident(client.captureMessage('This is a test message generated using ``raven test``'))
     print 'success!'
     print
     print 'The test message can be viewed at the following URL:'
diff --git a/setup.py b/setup.py
index be6a6a2..edd76ed 100755
--- a/setup.py
+++ b/setup.py
@@ -32,7 +32,7 @@ install_requires = [
 
 setup(
     name='raven',
-    version='1.3.4',
+    version='1.3.5',
     author='David Cramer',
     author_email='dcramer@gmail.com',
     url='http://github.com/dcramer/raven',