Create Pecan project for Higgins

Change-Id: I85129d4e596616b5ba154a8c4e1ecb11f741cd5f
Partially-Implements: blueprint pecan-project-higgins

higgins/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include public *

higgins/api/app.py

@@ -0,0 +1,25 @@
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    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.
+from higgins import model
+from pecan import make_app
+
+
+def setup_app(config):
+
+    model.init_model()
+    app_conf = dict(config.app)
+
+    return make_app(
+        app_conf.pop('root'),
+        logging=getattr(config, 'logging', {}),
+        **app_conf
+    )

higgins/api/config.py

@@ -0,0 +1,70 @@
+# Copyright 2013 - Noorul Islam K M
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, 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.
+
+# Server Specific Configurations
+server = {
+    'port': '8080',
+    'host': '0.0.0.0'
+}
+
+# Pecan Application Configurations
+app = {
+    'root': 'higgins.controllers.root.RootController',
+    'modules': ['higgins'],
+    'static_root': '%(confdir)s/public',
+    'template_path': '%(confdir)s/higgins/templates',
+    'debug': True,
+    'errors': {
+        404: '/error/404',
+        '__force_dict__': True
+    }
+}
+
+logging = {
+    'root': {'level': 'INFO', 'handlers': ['console']},
+    'loggers': {
+        'higgins': {'level': 'DEBUG', 'handlers': ['console'],
+                    'propagate': False},
+        'pecan': {'level': 'DEBUG', 'handlers': ['console'],
+                  'propagate': False},
+        'py.warnings': {'handlers': ['console']},
+        '__force_dict__': True
+    },
+    'handlers': {
+        'console': {
+            'level': 'DEBUG',
+            'class': 'logging.StreamHandler',
+            'formatter': 'color'
+        }
+    },
+    'formatters': {
+        'simple': {
+            'format': ('%(asctime)s %(levelname)-5.5s [%(name)s]'
+                       '[%(threadName)s] %(message)s')
+        },
+        'color': {
+            '()': 'pecan.log.ColorFormatter',
+            'format': ('%(asctime)s [%(padded_color_levelname)s] [%(name)s]'
+                       '[%(threadName)s] %(message)s'),
+            '__force_dict__': True
+        }
+    }
+}
+
+# Custom Configurations must be in Python dictionary format::
+#
+# foo = {'bar':'baz'}
+#
+# All configurations are accessible at::
+# pecan.conf

higgins/api/controllers/root.py

@@ -0,0 +1,34 @@
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    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.
+from pecan import expose
+from pecan import redirect
+from webob.exc import status_map
+
+
+class RootController(object):
+
+    @expose(generic=True, template='index.html')
+    def index(self):
+        return dict()
+
+    @index.when(method='POST')
+    def index_post(self, q):
+        redirect('http://pecan.readthedocs.org/en/latest/search.html?q=%s' % q)
+
+    @expose('error.html')
+    def error(self, status):
+        try:
+            status = int(status)
+        except ValueError:  # pragma: no cover
+            status = 500
+        message = getattr(status_map.get(status), 'explanation', '')
+        return dict(status=status, message=message)

higgins/api/templates/error.html

@@ -0,0 +1,12 @@
+<%inherit file="layout.html" />
+
+## provide definitions for blocks we want to redefine
+<%def name="title()">
+    Server Error ${status}
+</%def>
+
+## now define the body of the template
+    <header>
+        <h1>Server Error ${status}</h1>
+    </header>
+    <p>${message}</p>

higgins/api/templates/index.html

@@ -0,0 +1,34 @@
+<%inherit file="layout.html" />
+
+## provide definitions for blocks we want to redefine
+<%def name="title()">
+    Welcome to Pecan!
+</%def>
+
+## now define the body of the template
+    <header>
+        <h1><img src="/images/logo.png" /></h1>
+    </header>
+
+    <div id="content">
+
+        <p>This is a sample Pecan project.</p>
+
+        <p>
+            Instructions for getting started can be found online at <a
+            href="http://pecanpy.org" target="window">pecanpy.org</a>
+        </p>
+
+        <p>
+            ...or you can search the documentation here:
+        </p>
+
+        <form method="POST" action="/">
+            <fieldset>
+                <input name="q" />
+                <input type="submit" value="Search" />
+            </fieldset>
+            <small>Enter search terms or a module, class or function name.</small>
+        </form>
+
+    </div>

higgins/api/templates/layout.html

@@ -0,0 +1,22 @@
+<html>
+    <head>
+        <title>${self.title()}</title>
+        ${self.style()}
+        ${self.javascript()}
+    </head>
+    <body>
+        ${self.body()}
+    </body>
+</html>
+
+<%def name="title()">
+    Default Title
+</%def>
+
+<%def name="style()">
+    <link rel="stylesheet" type="text/css" media="screen" href="/css/style.css" />
+</%def>
+
+<%def name="javascript()">
+    <script language="text/javascript" src="/javascript/shared.js"></script>
+</%def>

higgins/public/css/style.css

@@ -0,0 +1,43 @@
+body {
+  background: #311F00;
+  color: white;
+  font-family: 'Helvetica Neue', 'Helvetica', 'Verdana', sans-serif;
+  padding: 1em 2em;
+}
+
+a {
+  color: #FAFF78;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+div#content  {
+  width: 800px;
+  margin: 0 auto;
+}
+
+form {
+  margin: 0;
+  padding: 0;
+  border: 0;
+}
+
+fieldset {
+  border: 0;
+}
+
+input.error {
+  background: #FAFF78;
+}
+
+header {
+  text-align: center;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-family: 'Futura-CondensedExtraBold', 'Futura', 'Helvetica', sans-serif;
+  text-transform: uppercase;
+}