Merge pull request #30 from janrain/topic/add-customer-user-agent

Add custom user-agent string

Author: ebeesonjanrain

janrain/capture/__init__.py

@@ -1,9 +1,3 @@
 from janrain.capture.api import Api
 from janrain.capture.exceptions import *
-
-VERSION = (0, 3, 7)
-
-def get_version():
-    return "%s.%s.%s" % (VERSION[0], VERSION[1], VERSION[2])
-
-__version__ = get_version()
+from janrain.capture.version import *

janrain/capture/api.py

@@ -2,6 +2,7 @@
 # pylint: disable=E0611
 from __future__ import unicode_literals
 from janrain.capture.exceptions import ApiResponseError
+from janrain.capture.version import get_version
 from json import dumps as to_json
 from contextlib import closing
 from base64 import b64encode
@@ -151,15 +152,23 @@ class Api(object):
         api = janrain.capture.Api("https://...", defaults)
         count = api.call("entity.count", type_name="user")
     """
-    def __init__(self, api_url, defaults={}, compress=True, sign_requests=True):
+    def __init__(self, api_url, defaults={}, compress=True, sign_requests=True,
+                 user_agent=None):
+
         if api_url[0:4] == "http":
             self.api_url = api_url
         else:
             self.api_url = "https://" + api_url
+
         self.defaults = defaults
         self.sign_requests = sign_requests
         self.compress = compress
 
+        if not user_agent:
+            self.user_agent = "janrain-python-api {}".format(get_version())
+        else:
+            self.user_agent = user_agent
+
 
     def call(self, api_call, **kwargs):
         """
@@ -197,6 +206,9 @@ def call(self, api_call, **kwargs):
         else:
             headers = {}
 
+        # Custom user agent string
+        headers['User-Agent'] = self.user_agent
+
         # Print the parameters (for debugging)
         print_params = params.copy()
         if 'client_secret' in print_params:

janrain/capture/cli.py

@@ -142,6 +142,8 @@ def main():
                         help="sign HTTP requests")
     parser.add_argument('-b', '--debug', action='store_true',
                         help="log debug messages to stdout")
+    parser.add_argument('-a', '--user-agent',
+                        help="user agent to use for the API call")
     args = parser.parse_args()
 
     try:
@@ -152,6 +154,9 @@ def main():
     if args.disable_signed_requests:
         api.sign_requests = False
 
+    if args.user_agent:
+        api.user_agent = args.user_agent
+
     if args.debug:
         logging.basicConfig(level=logging.DEBUG)
 

janrain/capture/test/test_api.py

@@ -3,6 +3,7 @@
 from janrain.capture import Api, config
 from janrain.capture.api import api_encode
 from janrain.capture.exceptions import *
+from janrain.capture import version
 from os.path import exists
 from os.path import expanduser
 from os import environ
@@ -44,3 +45,12 @@ def test_api_object(self):
         # oauth/token returns 400 or 401 which should *not* be a HTTPError
         with self.assertRaises(ApiResponseError):
             self.api.call("/oauth/token")
+
+    def test_user_agent(self):
+        # default user agent string will be used if not defined when object is
+        # instantiated
+        api1 = Api("foo.janrain.com")
+        self.assertIsNotNone(api1.user_agent)
+
+        api2 = Api("foo.janrain.com", user_agent="foobar")
+        self.assertEqual(api2.user_agent, "foobar")

janrain/capture/version.py

@@ -0,0 +1,6 @@
+VERSION = (0, 4, 0)
+
+def get_version():
+    return "%s.%s.%s" % (VERSION[0], VERSION[1], VERSION[2])
+
+__version__ = get_version()