New enpoints and updated functionality

.gitignore

@@ -4,6 +4,8 @@ cover/
 __pycache__/
 *.py[cod]
 
+*.swp
+
 # C extensions
 *.so
 

.travis.yml

@@ -8,14 +8,24 @@ addons:
 services:
     - postgresql
 before_install:
+    - sudo [ $(ip addr show | grep "inet6 ::1" | wc -l) -lt "1" ] && sudo sed -i '/^::1/d' /etc/hosts && sudo sed -i '/^127.0.1.1/d' /etc/hosts
     - sudo mkdir /etc/dbod
     - sudo mkdir /var/log/dbod
     - sudo chown travis /var/log/dbod
     - sudo cp static/api.cfg /etc/dbod
+    - wget https://github.com/begriffs/postgrest/releases/download/v0.3.1.1/postgrest-0.3.1.1-ubuntu.tar.xz
+    - tar xf postgrest-0.3.1.1-ubuntu.tar.xz
 install:
     - pip install -r requirements.txt
     - pip install coveralls
+    - python setup.py install
+before_script:
+    - psql -c 'CREATE DATABASE dbod;' -U postgres
+    - psql -d dbod -f dbod/tests/db_test.sql -U postgres
+    - ./postgrest postgres://postgres@localhost/dbod -a postgres -s api &
+    - sleep 5
 script:
-    - nosetests --with-coverage --cover-package=dbod --cover-html
+    - curl -g http://localhost:3000
+    - nosetests --with-coverage --cover-package=dbod --cover-html -s
 after_success:
     coveralls 

bin/dbod-api

@@ -12,49 +12,8 @@
 DB On Demand metadata REST API server
 """
 
-import ConfigParser
-import sys, traceback
-from tornado.options import parse_command_line, options
-from tornado.httpserver import HTTPServer
-from tornado.ioloop import IOLoop
-from dbod.api.handlers import *
-from dbod.config import config
-
-import logging
-
-def main():
-    """ Main body """
-
-    # Set up log file and level.
-    options.log_file_prefix = config.get('logging','path')
-    options.logging = 'debug'
-    options.log_to_stderr = False
-
-    # Parse server command line and set up logging defaults, if necessary
-    parse_command_line()
-
-    logging.info("Defining application (url, handler) pairs")
-    application = tornado.web.Application([
-            (r"/", DocHandler),
-            (r"/api/v1/entity/([^/]+)", EntityHandler),
-            (r"/api/v1/entity/alias/([^/]+)", FunctionalAliasHandler),
-            (r"/api/v1/host/([^/]+)", HostHandler),
-            (r"/api/v1/host/aliases/([^/]+)", HostAliases),
-            (r"/api/v1/metadata/(?P<class>[^\/]+)/?(?P<name>[^\/]+)?", Metadata),
-            (r"/api/v1/rundeck/resources.xml", RundeckResources),
-            ], debug=True)
-
-    logging.info("Configuring HTTP server")
-    http_server = HTTPServer(application,
-            ssl_options = {
-                "certfile" : config.get('ssl', 'hostcert') ,
-                "keyfile" : config.get('ssl', 'hostkey'),
-                })
-
-    http_server.listen(config.get('server', 'port'))
-
-    logging.info("Starting application")
-    IOLoop.instance().start()
+from dbod.api.api import Application
 
 if __name__ == "__main__":
-    main()
+    Application()
+

dbod/api/api.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2015, CERN
+# This software is distributed under the terms of the GNU General Public
+# Licence version 3 (GPL Version 3), copied verbatim in the file "LICENSE".
+# In applying this license, CERN does not waive the privileges and immunities
+# granted to it by virtue of its status as Intergovernmental Organization
+# or submit itself to any jurisdiction.
+
+import ConfigParser
+import sys, traceback
+import tornado.web
+import logging
+
+from tornado.options import parse_command_line, options, define
+from tornado.httpserver import HTTPServer
+from tornado.ioloop import IOLoop
+
+from dbod.api.base import DocHandler
+from dbod.api.rundeck import RundeckResources, RundeckJobs
+from dbod.api.metadata import Metadata
+from dbod.api.functionalalias import FunctionalAliasHandler
+from dbod.api.hostaliases import HostAliases
+from dbod.api.entity import Entity
+from dbod.config import config
+
+handlers = [
+    (r"/", DocHandler),
+    (r"/api/v1/entity/([^/]+)", Entity),
+    (r"/api/v1/host/aliases/([^/]+)", HostAliases),
+    (r"/api/v1/entity/alias/([^/]*)", FunctionalAliasHandler),
+    (r"/api/v1/metadata/(?P<class>[^\/]+)/?(?P<name>[^\/]+)?", Metadata),
+    (r"/api/v1/rundeck/resources.xml", RundeckResources),
+    (r"/api/v1/rundeck/job/(?P<job>[^\/]+)/?(?P<entity>[^\/]+)?", RundeckJobs),
+    ]
+
+class Application():
+    def __init__(self):
+        # Set up log file and level.
+        options.log_file_prefix = config.get('logging', 'path')
+        options.logging = config.get('logging', 'level')
+        options.log_to_stderr = config.getboolean('logging', 'stderr')
+
+        # Port and arguments
+        port = config.get('server', 'port')
+        define('port', default=port, help='Port to be used')
+        parse_command_line()
+
+        # Defining handlers
+        logging.info("Defining application (url, handler) pairs")
+        application = tornado.web.Application(handlers, debug=config.getboolean('tornado', 'debug'))
+
+        # Configuring server and SSL
+        logging.info("Configuring HTTP server")
+        if (config.has_section('ssl')):
+            http_server = HTTPServer(application,
+                    ssl_options = {
+                        "certfile" : config.get('ssl', 'hostcert') ,
+                        "keyfile" : config.get('ssl', 'hostkey'),
+                        })
+        else:
+            http_server = HTTPServer(application)
+            logging.info("Host certificate undefined, SSL is DISABLED")
+
+        # Listening port
+        http_server.listen(options.port)
+
+        # Starting
+        logging.info("Starting application")
+        tornado.ioloop.IOLoop.instance().start()

dbod/api/base.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2015, CERN
+# This software is distributed under the terms of the GNU General Public
+# Licence version 3 (GPL Version 3), copied verbatim in the file "LICENSE".
+# In applying this license, CERN does not waive the privileges and immunities
+# granted to it by virtue of its status as Intergovernmental Organization
+# or submit itself to any jurisdiction.
+
+"""
+REST API Server for the DB On Demand System
+"""
+
+import tornado.web
+import base64
+import functools
+import logging
+
+from dbod.config import config
+
+# HTTP API status codes
+OK = 200
+CREATED = 201 # Request fulfilled resulting in creation of new resource
+NO_CONTENT = 204 # Succesfull delete
+NOT_FOUND = 404
+UNAUTHORIZED = 401
+BAD_REQUEST = 400
+
+# Basic HTTP Authentication decorator
+def http_basic_auth(fun):
+    """Decorator for extracting HTTP basic authentication user/password pairs
+    from the request headers and matching them to configurated credentials.
+    It will generate an HTTP UNAUTHORIZED (Error code 401) if the request is 
+    not using HTTP basic authentication.
+
+    Example:
+        @http_basic_auth
+        def get(self, user, pwd)
+    """
+    @functools.wraps(fun)
+    def wrapper(*args, **kwargs):
+        """ Decorator wrapper """
+        self = args[0]
+        try:
+            # Try
+            auth = self.request.headers.get('Authorization')
+            scheme, _, token = auth.partition(' ')
+            if scheme.lower() == 'basic':
+                # Decode user and password
+                user, _, pwd = base64.decodestring(token).partition(':')
+                if user == config.get('api','user') and pwd == config.get('api','pass'):
+                    return fun(*args, **kwargs)
+                else:
+                    # Raise UNAUTHORIZED HTTP Error (401) 
+                    logging.error("Unauthorized access from: %s",
+                        self.request.headers)
+                    raise tornado.web.HTTPError(UNAUTHORIZED)
+
+            else:
+                # We only support basic authentication
+                logging.error("Authentication scheme not recognized")
+                return "Authentication scheme not recognized"
+        except AttributeError:
+            # Raise UNAUTHORIZED HTTP Error (401) if the request is not
+            # using autentication (auth will be None and partition() will fail
+            logging.error("Unauthorized access from: %s",
+                self.request.headers)
+            raise tornado.web.HTTPError(UNAUTHORIZED)
+
+    return wrapper
+
+class DocHandler(tornado.web.RequestHandler):
+    """Generates the API endpoint documentation"""
+    def get(self):
+        logging.info("Generating API endpoints doc")
+        response = """Please use :
+            <p>http://hostname:port/api/v1/entity/NAME</p>
+            <p>http://hostname:port/api/v1/host/HOSTNAME</p>"""
+        self.write(response)