usingnamespace · digitalresistor · Aug 26, 2017 · Aug 26, 2017 · Aug 26, 2017 · Aug 26, 2017
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013 Bert JW Regeer <bertjw@regeer.org>
+Copyright (c) 2012-2017 Bert JW Regeer <bertjw@regeer.org>
 
 Permission to use, copy, modify, and distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

diff --git a/README.rst b/README.rst
@@ -0,0 +1,57 @@
+usingnamespace
+==============
+
+Installation
+------------
+
+Not available yet...
+
+Developing
+----------
+
+Prerequisites:
+
+ 0. PostgreSQL 9.6, modify config/development.ini to configure the connection
+    string
+ 1. Create new database for usingnamespace, and make sure to run as a database
+    administrator in the new database:
+
+    .. code::
+
+        CREATE EXTENSION pgcrypto;
+
+    This is used by the application to create UUID's.
+
+    If PostgreSQL >9.4 is not available, you may also use the ``uuid-ossp`` extension:
+
+    .. code::
+
+        CREATE EXTENSION "uuid-ossp";
+
+    Then add a new function:
+
+    .. code::
+
+        CREATE FUNCTION gen_random_uuid()
+        RETURNS uuid
+        AS '
+        BEGIN
+        RETURN uuid_generate_v4();
+        END'
+        LANGUAGE 'plpgsql';
+
+ 2. Yarn has to be installed (node as well...)
+
+Getting the application set up locally:
+
+ 0. Change directory to this project
+ 1. Create virtualenv for Project in $venv
+ 2. $venv/bin/pip install -e .
+ 3. $venv/bin/usingnamespace_db_init config/development.ini
+ 4. cd webassets
+    yarn install
+ 5. In a seperate terminal window:
+    yarn run watch
+ 6. In a seperate terminal window:
+    $venv/bin/pserve --reload config/development.ini
+ 7. Visit the URL printed on the console
diff --git a/README.txt b/README.txt
diff --git a/TODO b/TODO
@@ -0,0 +1,9 @@
+TODO:
+
+- Move remote_addr from user_tickets and user_api_tickets into a seperate table
+  so that one can see a list of what remote endpoints have used a particular
+  ticket. This will allow user for example to know if their API token has been
+  stolen, or if their session is being used from a location they aren't
+  expecting.
+
+- 
diff --git a/config/development.ini b/config/development.ini
@@ -6,40 +6,33 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.default_locale_name = en
 
-sqlalchemy.url = postgresql://usingnamespace:usingnamespace@127.0.0.1/usingnamespace
+sqlalchemy.url = postgresql://127.0.0.1/usingnamespace
 pyramid.includes =
     pyramid_debugtoolbar
 
-pyramid.secret.session = INSERTSECRETHERE
-pyramid.secret.auth = INSERTOTHERSECRETHERE
+usingnamespace.secret.session = INSERTSECRETHERE
+usingnamespace.secret.auth = INSERTOTHERSECRETHERE
 usingnamespace.upload_path = /tmp
-usingnamespace.management.domain = management.usingnamespace.net
 usingnamespace.name = Using Namespace
+usingnamespace.api.sub = true
+usingnamespace.api.domain = api.usingnamespace.net
+usingnamespace.api.route_path =
 
 [app:main]
 use = egg:usingnamespace#main
 
 [app:api]
 use = egg:usingnamespace#api
 
-[app:management]
-use = egg:usingnamespace#management
-
 [server:main]
 use = egg:waitress#main
-host = 0.0.0.0
-port = 6545
+listen = 0.0.0.0:6545 [::]:6545
 
 [server:api]
 use = egg:waitress#main
 host = 0.0.0.0
 port = 6546
 
-[server:management]
-use = egg:waitress#main
-host = 0.0.0.0
-port = 6547
-
 # Begin logging configuration
 
 [loggers]

diff --git a/setup.py b/setup.py
@@ -3,69 +3,70 @@
 from setuptools import setup, find_packages
 
 here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, 'README.txt')).read()
+README = open(os.path.join(here, 'README.rst')).read()
 CHANGES = open(os.path.join(here, 'CHANGES.txt')).read()
 
 requires = [
-    'SQLAlchemy',
-    'pyramid',
-    'pyramid_tm',
-    'transaction',
-    'waitress',
-    'zope.sqlalchemy',
-
     'cryptacular',
-    'deform',
     'misaka',
     'psycopg2',
-    'pyramid_deform',
+    'pygments',
+    'pyramid',
+    'pyramid_authsanity~=1.1.0,<2.0.0',
     'pyramid_mailer',
     'pyramid_mako',
-    ]
+    'pyramid_services',
+    'pyramid_retry',
+    'pyramid_tm',
+    'sqlalchemy',
+    'transaction',
+    'waitress',
+    'zope.sqlalchemy',
+]
 
 tests_require = []
 
-testing_requires =  tests_require + [
-    'nose',
+testing_requires = tests_require + [
+    'pytest',
+    'pytest-cov',
     'coverage',
-    ]
+]
 
 develop_requires = [
     'pyramid_debugtoolbar',
-    ]
+]
 
-setup(name='usingnamespace',
-      version='0.0',
-      description='usingnamespace',
-      long_description=README + '\n\n' +  CHANGES,
-      classifiers=[
+setup(
+    name='usingnamespace',
+    version='0.0',
+    description='usingnamespace',
+    long_description=README + '\n\n' + CHANGES,
+    classifiers=[
         "Programming Language :: Python",
         "Framework :: Pyramid",
         "Topic :: Internet :: WWW/HTTP",
         "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
+    ],
+    author='Bert JW Regeer',
+    author_email='bertjw@regeer.org',
+    url='http://usingnamespace.com/',
+    keywords='web wsgi pylons pyramid blog',
+    packages=find_packages('.', exclude=['tests']),
+    include_package_data=True,
+    zip_safe=False,
+    install_requires=requires,
+    extras_require={
+        'develop': develop_requires,
+        'testing': testing_requires,
+    },
+    entry_points={
+        "paste.app_factory": [
+            'main = usingnamespace:main',
+            'api = usingnamespace:api',
         ],
-      author='Bert JW Regeer',
-      author_email='bertjw@regeer.org',
-      url='http://usingnamespace.com/',
-      keywords='web wsgi bfg pylons pyramid',
-      packages=find_packages(),
-      include_package_data=True,
-      zip_safe=False,
-      test_suite='usingnamespace.tests',
-      install_requires=requires,
-      tests_require=tests_require,
-      extras_require = {
-          'develop': develop_requires,
-          'testing': testing_requires,
-          },
-      entry_points="""\
-      [paste.app_factory]
-      main = usingnamespace:main
-      api  = usingnamespace.api:main
-      management = usingnamespace.management:main
-      [console_scripts]
-      usingnamespace_init_db = usingnamespace.scripts.initializedb:main
-      usingnamespace_destroy_db = usingnamespace.scripts.destroydb:main
-      """,
-      )
-
+        "console_scripts": [
+            'usingnamespace_init_db = usingnamespace.scripts.initializedb:main',
+            'usingnamespace_destroy_db = usingnamespace.scripts.destroydb:main',
+        ],
+    }
+)
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1 @@
+
diff --git a/usingnamespace/__init__.py b/usingnamespace/__init__.py
@@ -1,16 +1,39 @@
 import logging
-log = logging.getLogger(__name__)
 
 from pyramid.config import Configurator
+from pyramid.settings import asbool
 
-from sqlalchemy import engine_from_config
-from sqlalchemy.exc import DBAPIError
-
-from .models import DBSession
+log = logging.getLogger(__name__)
 
 required_settings = [
-        'usingnamespace.name',
-        ]
+    'usingnamespace.name',
+    'usingnamespace.api.sub',
+]
+
+def includeme(config):
+    config.include('pyramid_retry')
+    config.include('pyramid_services')
+    config.include('pyramid_mako')
+    config.include('pyramid_mailer')
+
+    config.include('.models.meta')
+
+    config.add_static_view('static', 'static', cache_max_age=3600)
+    config.add_static_view(
+        'files',
+        config.registry.settings['usingnamespace.upload_path'],
+        cache_max_age=3600
+    )
+
+    config.add_route(
+        'main',
+        '/*traverse',
+        use_global_views=True
+    )
+
+    config.scan('.views')
+    config.scan('.subscribers')
+
 
 def main(global_config, **app_settings):
     """ This function returns a Pyramid WSGI application.
@@ -19,10 +42,6 @@ def main(global_config, **app_settings):
     settings = global_config.copy()
     settings.update(app_settings)
 
-    engine = engine_from_config(settings, 'sqlalchemy.')
-    DBSession.configure(bind=engine)
-    config = Configurator(settings=settings, root_factory='.traversal.MainRoot')
-
     do_start = True
 
     for _req in required_settings:
@@ -34,37 +53,11 @@ def main(global_config, **app_settings):
         log.error('Unable to start due to missing configuration')
         exit(-1)
 
-    # Include the transaction manager
-    config.include('pyramid_tm')
-
-    # We use mako for template rendering
-    config.include('pyramid_mako')
-
-    # Set-up pyramid_deform
-    config.include('pyramid_deform')
-
-    # Add in pyramid_mailer for sending out emails
-    config.include('pyramid_mailer')
-
-    # Add in the API...
-    config.include('.api')
-
-    # Add in the Management interface...
-    config.include('.management')
-
-    config.add_static_view('static', 'static', cache_max_age=3600)
-    config.add_static_view('deform_static', 'deform:static', cache_max_age=3600)
-    config.add_static_view('files', config.registry.settings['usingnamespace.upload_path'], cache_max_age=3600)
-
-    config.add_route('main',
-            '/*traverse',
-            use_global_views=True
-            )
-
-    # Scan the views sub-module
-    config.scan('.views')
+    settings['tm.manager_hook'] = 'pyramid_tm.explicit_manager'
+    config = Configurator(settings=settings, root_factory='.traversal.MainRoot')
+    config.include('.')
 
-    # Scan the subscribers for events sub-module
-    config.scan('.subscribers')
+    if asbool(settings['usingnamespace.api.sub']) is True:
+        config.include('.api')
 
     return config.make_wsgi_app()