feat: add create-consumer-key.py helper, improve documentation

Signed-off-by: Jean-Tiare Le Bigot <[email protected]>

Author: yadutaf

README.rst

@@ -46,7 +46,9 @@ as required by your usage for a better security!
 
 - `OVH Europe <https://eu.api.ovh.com/createToken/index.cgi?GET=/*&POST=/*&DELETE=/*&PUT=/*>`_
 - `OVH North America <https://ca.api.ovh.com/createToken/index.cgi?GET=/*&POST=/*&DELETE=/*&PUT=/*>`_
-- `Runabove <https://api.runabove.com/createToken/index.cgi?GET=/*&POST=/*&DELETE=/*&PUT=/*>`_
+- `Runabove <https://api.runabove.com/createApp>`_
+
+For Runabove, you may use included ``create-consumer-key.py runabove-ca`` to generate your consumer key.
 
 Then you should put your credentials in ``~/.ovh.conf`` like:
 

create-consumer-key.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+'''
+Helper to generate OVH API consumer key. In a nutshell, the consumer key
+identifies a specific user in an application while application key and
+application secret identifies the application itself. In the case of ovh-cli
+each instance of the CLI must hav its own, dedicated, set of credentials.
+
+To generate application secret and application key, please visit:
+    - OVH Europe: https://eu.api.ovh.com/createApp/
+    - OVH North America: https://ca.api.ovh.com/createApp/
+    - Soyoustart Europe: https://eu.api.soyoustart.com/createApp/
+    - Soyoustart North America: https://ca.api.soyoustart.com/createApp/
+    - Kimsufi Europe: https://eu.api.kimsufi.com/createApp/
+    - Kimsufi North America: https://ca.api.kimsufi.com/createApp/
+    - Runabove North America: https://api.runabove.com/createApp/
+
+You may then request a consumer key using this tool:
+
+    $ create-consumer-key.py [endpoint]
+
+Where ``endpoint`` may be one of ``ovh-eu``, ``ovh-ca``, and so on.
+
+Once generated, your application key, application secret and consumer key
+must be set in eiter:
+    - ``./ovh.conf`` for an application specific configuration
+    - ``$HOME/.ovh.conf`` for a user wide configuration
+    - ``/etc/ovh.conf`` for a system wide / server configuration
+
+This file will look like:
+
+    [default]
+    endpoint=ovh-eu
+
+    [ovh-eu]
+    application_key=my_app_key
+    application_secret=my_application_secret
+    ;consumer_key=my_consumer_key
+
+Alternatively, at runtime, configuration may be overloaded using environment
+variables. For more informations regarding available configuration options,
+please see https://github.com/ovh/python-ovh
+'''
+
+import sys
+import ovh
+
+# Load api endpoint from command line, if any
+if len(sys.argv) == 1:
+    endpoint=None
+elif len(sys.argv) == 2:
+    endpoint=sys.argv[1]
+else:
+    print >>sys.stderr, __doc__
+    sys.exit(1)
+
+if endpoint in ['-h', '--help']:
+    print >>sys.stderr, __doc__
+    sys.exit(0)
+
+# Create a client using configuration
+try:
+    client = ovh.Client(endpoint)
+except Exception as e:
+    print e
+    print >>sys.stderr, __doc__
+    sys.exit(1)
+
+# Request full API access
+access_rules = [
+    {'method': 'GET', 'path': '/*'},
+    {'method': 'POST', 'path': '/*'},
+    {'method': 'PUT', 'path': '/*'},
+    {'method': 'DELETE', 'path': '/*'}
+]
+
+# Request token
+validation = client.request_consumerkey(access_rules)
+
+print "Please visit %s to authenticate" % validation['validationUrl']
+raw_input("and press Enter to continue...")
+
+# Print nice welcome message
+print "Welcome", client.get('/me')['firstname']
+print "Here is your Consumer Key: '%s'" % validation['consumerKey']
+

ovh-cli.py

@@ -1,15 +1,15 @@
 #!/usr/bin/env python
 # -*- encoding: utf-8 -*-
 '''
-OVH CLI. This is a convenient Command Line Interface (CLI) built on top of
+OVH CLI is a convenient Command Line Interface (CLI) built on top of
 ``python-ovh`` and OVH's ReST APIs.
 
 Available command list is generated at runtime based on automatically updated
 json schemas of the API.
 
 The name of the API to use is determined by the executable name. For instance,
-if runing program is called 'ovh-eu', it will expose european OVH's API', it
-will expose european OVH's API's. Currently supported APIs includes:
+if runing program is called 'ovh-eu', it will expose european OVH's API'.
+Currently supported APIs includes:
     - ovh-eu
     - ovh-ca
     - kimsufi-eu
@@ -18,9 +18,6 @@
     - soyoustart-ca
     - runabove-ca
 
-TODO:
- - list / complete 'enum' arguments
-
 Usage: General: {cli} [--help|--refresh|--format (pretty|json)] your command and args --param value --param2 value2
        Get help on a specific path: {cli} your command --help
        Get help on a specific action: {cli} your command (list|show|update|create|delete) --help
@@ -33,8 +30,12 @@
     --help      This message
     --refresh   Rebuild available commands list and documentation
     --format    Output format, can be 'pretty' or 'json'. (default='pretty')
+    --debug     Print verbose debugging informations. Use it when reporting a bug
 '''
 
+# TODO:
+#  - list / complete 'enum' arguments
+
 from __future__ import absolute_import
 
 import os
@@ -185,7 +186,7 @@ def do_usage():
         print >>sys.stderr, 'Calling %s %s' % (verb, method)
       formater.do_format(client, verb, method, arguments.__dict__)
     except Exception as e:
-      # print noce error message
+      # print nice error message
       print e
 
       # when in debug mode, re-raise to see the full stack-trace