Merge lp:~noise/tanuki-agent/api_example into lp:tanuki-agent

[Bret Barker]

basic api_example.py to replace curl in docs for auth'd requests.

[lp:~noise/tanuki-agent/api_example]

81. By Bret Barker on 2015-08-27

minor help text tweak

[Thomi Richards (thomir-deactivatedaccount)]

This looks OK, but I really think we shouldn't be using docopt - it's not in the standard library, it's not as powerful as argparse, and we're supposed to be trying to avoid external dependencies.

Having said that, I clearly lost that argument already with the agent, and this will feed from the same virtualenv, so.. *shrugs*.

review: Approve

[Bret Barker (noise)]

Thomi - yeah, I wouldn't have used it if we were not already piggybacking on the agent's venv.

[Facundo Batista (facundo)]

Minor inline comments...

[lp:~noise/tanuki-agent/api_example]

82. By Bret Barker on 2015-08-27

add -v, -d alias for --data, more clear json err handling

[Bret Barker (noise)]

Facundo - thanks, added -d alias, tweaked try/except to be more narrow w/comment since it's just to handle "not json" response text.

Pedronis - added -v flag for debug output

=== added file 'scripts/api_example.py'
--- scripts/api_example.py	1970-01-01 00:00:00 +0000
+++ scripts/api_example.py	2015-08-27 21:06:07 +0000
@@ -0,0 +1,101 @@
+#!/usr/bin/env python3
+"""
+SPI Api_example - example wrapper for making oauth-signed calls to SPI API endpoints
+
+Usage:
+  api_example.py [options] <configfile> <url>
+
+Options:
+  -h --help             Show this screen
+  -d, --data data       POST Data
+  -X method             HTTP Method
+  -v                    Verbose debug output
+"""
+
+import json
+import logging
+import sys
+
+from configparser import ConfigParser
+import requests_oauthlib
+
+logging.basicConfig(format='%(asctime)s %(levelname)-5.5s %(name)s %(message)s')
+logger = logging.getLogger(__name__)
+
+try:
+    import docopt
+except:
+    print('This script must be run in the virtualenv, via:')
+    print('. env/bin/activate')
+    print('./scripts/api_example.py')
+    sys.exit(0)
+
+
+class ApiExample(object):
+
+    def __init__(self, arguments):
+        self.config = ConfigParser()
+        self.confpath = arguments['<configfile>']
+        self.method = arguments.get('-X')
+        self.url = arguments.get('<url>')
+        pd = arguments.get('--data')
+        self.post_data = json.loads(pd) if pd else None
+
+        if arguments.get('-v'):
+            logger.setLevel(logging.DEBUG)
+            requests_log = logging.getLogger("requests.packages.urllib3")
+            requests_log.setLevel(logging.DEBUG)
+            requests_log.propagate = True
+            requests_oauthlib_log = logging.getLogger("requests_oauthlib")
+            requests_oauthlib_log.setLevel(logging.DEBUG)
+        else:
+            logger.setLevel(logging.INFO)
+
+        # Load config
+        if self.confpath is not None:
+            self.config.read(self.confpath)
+
+        if 'auth' in self.config:
+            # Here's the substance - we create a requests session
+            # with our oauth credentials (read from config file)
+            self.session = requests_oauthlib.OAuth1Session(
+                self.config.get('auth', 'consumer_key'),
+                client_secret=self.config.get('auth', 'consumer_secret'),
+                resource_owner_key=self.config.get('auth', 'token_key'),
+                resource_owner_secret=self.config.get('auth', 'token_secret'),
+            )
+        else:
+            logger.warning("[auth] config section not found in %s", self.confpath)
+            sys.exit(1)
+
+    def run(self):
+        if self.method is None:
+            if self.post_data is not None:
+                self.method = 'POST'
+            else:
+                self.method = 'GET'
+        logger.debug('%s %s', self.method, self.url)
+        logger.debug('with data: %s', self.post_data)
+
+        if self.method == 'POST':
+            res = self.session.post(self.url, json=self.post_data)
+        elif self.method == 'PUT':
+            res = self.session.put(self.url, json=self.post_data)
+        elif self.method == 'DELETE':
+            res = self.session.delete(self.url)
+        else:
+            res = self.session.get(self.url)
+
+        print('HTTP', res.status_code)
+        try:
+            print(json.dumps(res.json(), indent=2))
+        except ValueError:
+            # response is not json
+            print(res.text)
+            sys.exit(1)
+
+
+if __name__ == '__main__':
+    arguments = docopt.docopt(__doc__, version='SPI Api_example v1')
+    api = ApiExample(arguments)
+    api.run()