Add Flask Helper to Error Reporting

Author: Bill Prin

docs/error-reporting-usage.rst

@@ -76,6 +76,19 @@ be used by Stackdriver Error Reporting to help group exceptions.
    >>> except Exception:
    >>>     client.report_exception(http_context=http_context, user=user))
 
+An automatic helper to build the HTTP Context from a Flask (Werkzeug) request
+object is provided.
+
+ .. code-block:: python
+
+    >>> @app.errorhandler(Exception)
+    >>> def handle_error(e):
+    >>>     client = error_reporting.Client()
+    >>>     client.report_exception(
+    >>>         http_context=build_flask_context(request))
+    >>>     # rest of error response code here
+
+
 Reporting an error without an exception
 -----------------------------------------
 

error_reporting/google/cloud/error_reporting/__init__.py

@@ -14,5 +14,32 @@
 
 """Client library for Stackdriver Error Reporting"""
 
+from google.cloud.error_reporting.client import Client, HTTPContext
 
-from google.cloud.error_reporting.client import Client
+
+def build_flask_context(request):
+    """Builds an HTTP context object from a Flask (Werkzeug) request object.
+
+     This helper method extracts the relevant HTTP context from a Flask request
+     object into an object ready to be sent to Error Reporting.
+
+     Example::
+
+        >>> @app.errorhandler(Exception)
+        >>> def handle_error(e):
+        >>>     client = error_reporting.Client()
+        >>>     client.report_exception(
+        >>>         http_context=build_flask_context(request))
+        >>>     # rest of error response code here
+
+    :type request: :class:`werkzeug.wrappers.request`
+    :param request: The Flask request object to convert.
+
+    :rtype: :class:`google.cloud.error_reporting.client.HTTPContext`
+    :returns: An HTTPContext object ready to be sent to the Stackdriver Error
+              Reporting API.
+    """
+    return HTTPContext(url=request.url, method=request.method,
+                       user_agent=str(request.user_agent),
+                       referrer=request.referrer,
+                       remote_ip=request.remote_addr)

error_reporting/unit_tests/__init__.py

@@ -11,3 +11,34 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+
+import unittest
+
+
+class TestFlaskHelper(unittest.TestCase):
+
+    def test_flask_helper(self):
+        from google.cloud.error_reporting import build_flask_context
+        request = _Request('http://google.com', 'GET',
+                           'Google Cloud Unit Tests Agent', 'http://gmail.com',
+                           '127.0.0.1')
+        context = build_flask_context(request)
+        self.assertEqual(request.url, context.url)
+        self.assertEqual(request.method, context.method)
+        self.assertEqual(request.user_agent, context.user_agent)
+        self.assertEqual(request.referrer, context.referrer)
+        self.assertEqual(request.remote_ip, context.remote_ip)
+
+
+# Fake request so no need to bring in Werkzeug as dependency
+class _Request(object):
+
+    def __init__(self, url, method, user_agent, referrer, remote_ip):
+        self.url = url
+        self.method = method
+        self.user_agent = user_agent
+        self.referrer = referrer
+        self.remote_ip = remote_ip
+
+