write before the first try at getting this into the store

Author: buckmaxwell

Diff for: Changelog

@@ -0,0 +1,2 @@
+Version 0.1.0 2015-09-15
+ * first version

Diff for: MANIFEST.in

@@ -0,0 +1,2 @@
+include README.rst
+include Changelog

Diff for: README.rst

@@ -0,0 +1,11 @@
+summary
+=======
+
+NeoApi is an OGM built on top of NeoModel.  NeoApi Classes extend the StructuredNode from NeoModel by adding methods that allow each object to be easiy serialized into json api responses that comply with the standard on http://jsonapi.org.  With this framework your neo4j api will basically build itself!
+
+example api
+===========
+
+Please take a look at the sample project to get started.  Also, remember to familiarize yourself with the json api specification.
+
+http://github.com/buckmaxwell/sample-neo-api

Diff for: neoapi/__init__.py

@@ -0,0 +1,7 @@
+from .serializable_structured_node import *
+
+__author__ = 'Max Buck'
+__email__ = '[email protected]'
+__license__ = 'MIT'
+__package__ = 'neoapi'
+__version__ = '0.1.0'

Diff for: neoapi/application_codes.py

@@ -0,0 +1,36 @@
+from .http_error_codes import (OK, CREATED, BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND,
+                              CONFLICT, INTERNAL_SERVER_ERROR, NOT_ALLOWED)
+from flask import jsonify, make_response
+
+BAD_FORMAT_VIOLATION = '4000', 'there is a problem with the request format', BAD_REQUEST
+UNIQUE_KEY_VIOLATION = '4001', 'a uniqueness constraint is violated by the request', BAD_REQUEST
+WRONG_TYPE_VIOLATION = '4002', 'the type key does not match the resource requested', BAD_REQUEST
+PARAMETER_NOT_SUPPORTED_VIOLATION = '4003', 'a query parameter you tried to use is not supported for this endpoint', BAD_REQUEST
+ENUMERATED_TYPE_VIOLATION = '4004', 'a value given for an enumerated type was unsupported', BAD_REQUEST
+BAD_PARAMETER_VIOLATION = '4005', 'one or more of the attributes in your request is not part of the model', BAD_REQUEST
+
+RESOURCE_NOT_FOUND = '4040', 'the requested resource was not found on the server', NOT_FOUND
+
+METHOD_NOT_ALLOWED = '4050', 'the http method you tried is not a legal operation on this resource', NOT_ALLOWED
+FORBIDDEN_VIOLATION = '4030', 'the http method you tried is forbidden.', FORBIDDEN
+UNAUTHORIZED_VIOLATION = '4010', 'missing or bad authorization', UNAUTHORIZED
+BAD_AUTHENTICATION = '4011', 'bad authorization', UNAUTHORIZED
+NO_AUTHENTICATION = '4012', 'no authorization header provided', UNAUTHORIZED
+
+
+def error_response(array_of_application_code_tuples):
+    errors = list()
+    for app_code_tuple in array_of_application_code_tuples:
+        error = dict()
+        error['status'] = app_code_tuple[2]
+        error['code'] = app_code_tuple[0]
+        error['title'] = app_code_tuple[1]
+        errors.append(error)
+
+    r = make_response(jsonify({'errors': errors}))
+    r.status_code = app_code_tuple[2]
+    r.headers['Content-Type'] = "application/vnd.api+json; charset=utf-8"
+
+    return r
+
+

Diff for: neoapi/errors.py

@@ -0,0 +1,8 @@
+class WrongTypeError(Exception):
+
+    def __init__(self, value='wrong type error'):
+        self.value = value
+
+    def __str__(self):
+        return repr(self.value)
+

Diff for: neoapi/http_error_codes.py

@@ -0,0 +1,10 @@
+OK = 200
+CREATED = 201
+NO_CONTENT = 204
+BAD_REQUEST = 400
+UNAUTHORIZED = 401
+FORBIDDEN = 403
+NOT_FOUND = 404
+NOT_ALLOWED = 405
+CONFLICT = 409
+INTERNAL_SERVER_ERROR = 500

Diff for: neoapi/serializable_structured_node.py

@@ -3,11 +3,11 @@
                       DeflateError)
 from py2neo.cypher.error.statement import ParameterMissing
 import os
-import http_error_codes
+import .http_error_codes
 from flask import jsonify, make_response
 from neomodel import db
-import application_codes
-from errors import WrongTypeError
+import .application_codes
+from .errors import WrongTypeError
 from datetime import datetime
 import hashlib
 

Diff for: setup.cfg

@@ -0,0 +1,5 @@
+[bdist_wheel]
+# This flag says that the code is written to work on both Python 2 and Python
+# 3. If at all possible, it is good practice to do this. If you cannot, you
+# will need to generate wheels for each Python version that you support.
+universal=1

Diff for: setup.py

@@ -28,7 +28,7 @@
         #   3 - Alpha
         #   4 - Beta
         #   5 - Production/Stable
-        'Development Status :: 5 - Production/Stable',
+        'Development Status :: 3 - Alpha',
 
         # Indicate who your project is intended for
         'Intended Audience :: Developers',
@@ -49,7 +49,7 @@
     ],
 
     # What does your project relate to?
-    keywords='zip codes',
+    keywords='json api specification neomodel neo4j',
 
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
@@ -59,14 +59,11 @@
     # your project is installed. For an analysis of "install_requires" vs pip's
     # requirements files see:
     # https://packaging.python.org/en/latest/requirements.html
-    install_requires=['haversine'],
+    install_requires=['neomodel', 'py2neo', 'flask', 'hashlib'],
 
     # If there are data files included in your packages that need to be
     # installed, specify them here.  If using Python 2.6 or less, then these
     # have to be included in MANIFEST.in as well.
-    #package_data={
-    #    'zipcode': ['zipcode.db'],
-    #},
     include_package_data=True
 
 )