Merge pull request #1 from ekonstantinidis/setup-project

ekonstantinidis · web-flow · commit 521498e56b6e · 2016-08-24T00:51:37.000+01:00
Setup Project
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,36 @@
+language: python
+
+sudo: false
+
+python:
+  - "3.5"
+
+env:
+  - TOX_ENV=py27-django18
+  - TOX_ENV=py34-django18
+  - TOX_ENV=py35-django18
+
+  - TOX_ENV=py27-django19
+  - TOX_ENV=py34-django19
+  - TOX_ENV=py35-django19
+
+  - TOX_ENV=py27-django110
+  - TOX_ENV=py34-django110
+  - TOX_ENV=py35-django110
+
+  - TOX_ENV=py27-djangomaster
+  - TOX_ENV=py34-djangomaster
+  - TOX_ENV=py35-djangomaster
+
+cache:
+  - pip
+
+install:
+  - pip install tox
+  - pip install codecov
+
+script:
+  - tox -e $TOX_ENV
+
+after_success:
+  - codecov
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,23 @@
+Copyright (c) 2016 Emmanouil Konstantinidis
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include MANIFEST.in
+
+global-exclude __pycache__
+global-exclude *.py[co]
+
+prune docs
diff --git a/README.md b/README.md
@@ -1,2 +1,71 @@
-# django-rest-framework-api-key
+# django-rest-framework-api-key [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![pypi][pypi-image]][pypi-url]
 Authenticate Web APIs made with Django REST Framework
+
+
+### Supports
+
+  - Python (2.7, 3.3, 3.4, 3.5)
+  - Django (1.8, 1.9, 1.10)
+  - Django Rest Framework (3+)
+
+
+### Installation
+
+Install using pip:
+
+    pip install drfapikey
+
+Add 'rest_framework_api_key' to your `INSTALLED_APPS` setting:
+
+    INSTALLED_APPS = (
+        ...
+        'rest_framework_api_key',
+    )
+
+Finally set the django-rest-framework permissions under your django settings:
+
+    REST_FRAMEWORK = {
+        'DEFAULT_PERMISSION_CLASSES': (
+            'rest_framework_api_key.permissions.HasAPIAccess',
+        )
+    }
+
+
+### Example Request
+
+```python
+response = requests.get(
+    url="http://0.0.0.0:8000/api/login",
+    headers={
+        "Api-Key": "fd8b4a98c8f53035aeab410258430e2d86079c93",
+    },
+)
+```
+
+
+### Tests
+    
+    pyvenv env
+    source env/bin/activate
+    pip install -r requirements/requirements-testing.txt
+    python runtests.py
+
+
+### Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request
+6. Make sure tests are passing
+
+
+[travis-image]: https://travis-ci.org/ekonstantinidis/django-rest-framework-api-key.svg?branch=master
+[travis-url]: https://travis-ci.org/ekonstantinidis/django-rest-framework-api-key
+
+[codecov-image]: https://codecov.io/github/ekonstantinidis/django-rest-framework-api-key/coverage.svg?branch=master
+[codecov-url]:https://codecov.io/github/ekonstantinidis/django-rest-framework-api-key?branch=master
+
+[pypi-image]: https://badge.fury.io/py/drfapikey.svg
+[pypi-url]: https://pypi.python.org/pypi/drfapikey/
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,11 @@
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+  status:
+    project: false
+    patch: false
+    changes: false
+
+comment: off
diff --git a/requirements/requirements-base.txt b/requirements/requirements-base.txt
@@ -0,0 +1 @@
+djangorestframework>=3.3
diff --git a/requirements/requirements-testing.txt b/requirements/requirements-testing.txt
@@ -0,0 +1,8 @@
+-r requirements-base.txt
+
+# PyTest for running the tests.
+pytest==3.0.0
+pytest-cov==2.3.1
+pytest-django==3.0.0
+
+flake8==3.0.4
diff --git a/rest_framework_api_key/__init__.py b/rest_framework_api_key/__init__.py
@@ -0,0 +1 @@
+__version__ = "0.0.1"
diff --git a/rest_framework_api_key/admin.py b/rest_framework_api_key/admin.py
@@ -0,0 +1,32 @@
+from django.contrib import admin
+from django.contrib import messages
+from rest_framework_api_key.models import APIKey
+from rest_framework_api_key.helpers import generate_key
+
+
+class ApiKeyAdmin(admin.ModelAdmin):
+    list_display = ('id', 'name', 'created', 'modified')
+
+    fieldsets = (
+        ('Required Information', {'fields': ('name',)}),
+        ('Additional Information', {'fields': ('key_message',)}),
+    )
+    readonly_fields = ('key_message',)
+
+    search_fields = ('id', 'name',)
+
+    def has_delete_permission(self, request, obj=None):
+        return False
+
+    def key_message(self, obj):
+        if obj.key:
+            return "Hidden"
+        return "The API Key will be generated once you click save."
+
+    def save_model(self, request, obj, form, change):
+        if not obj.key:
+            obj.key = generate_key()
+            messages.add_message(request, messages.WARNING, ('The API Key for %s is %s. Please note it since you will not be able to see it again.' % (obj.name, obj.key)))
+        obj.save()
+
+admin.site.register(APIKey, ApiKeyAdmin)
diff --git a/rest_framework_api_key/helpers.py b/rest_framework_api_key/helpers.py
@@ -0,0 +1,6 @@
+import binascii
+import os
+
+
+def generate_key():
+    return binascii.hexlify(os.urandom(20)).decode()
diff --git a/rest_framework_api_key/models.py b/rest_framework_api_key/models.py
@@ -0,0 +1,19 @@
+import uuid
+from django.db import models
+
+
+class APIKey(models.Model):
+
+    class Meta:
+        verbose_name_plural = "API Keys"
+        ordering = ['-created']
+
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+
+    name = models.CharField(max_length=50, unique=True)
+    key = models.CharField(max_length=40, unique=True)
+
+    def __str__(self):
+        return self.name
diff --git a/rest_framework_api_key/permissions.py b/rest_framework_api_key/permissions.py
@@ -0,0 +1,10 @@
+from rest_framework import permissions
+from rest_framework_api_key.models import APIKey
+
+
+class HasAPIAccess(permissions.BasePermission):
+    message = 'Invalid or missing API Key.'
+
+    def has_permission(self, request, view):
+        api_key = request.META.get('HTTP_API_KEY', '')
+        return APIKey.objects.filter(key=api_key).exists()
diff --git a/runtests.py b/runtests.py
@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+import sys
+import subprocess
+import pytest
+
+
+FLAKE8_ARGS = ['rest_framework_api_key', 'tests/', '--ignore=E501']
+PYTEST_ARGS = ['tests', '--cov=rest_framework_api_key', '--tb=short', '-rw']
+
+
+def exit_on_failure(command, message=None):
+    if command:
+        sys.exit(command)
+
+
+def flake8_main(args):
+    print('Running: flake8', FLAKE8_ARGS)
+    command = subprocess.call(['flake8'] + args)
+    print("" if command else "Success. flake8 passed.")
+    return command
+
+
+def run_tests_coverage():
+    if __name__ == "__main__":
+        pytest.main(PYTEST_ARGS)
+
+exit_on_failure(flake8_main(FLAKE8_ARGS))
+exit_on_failure(run_tests_coverage())
diff --git a/setup.py b/setup.py
@@ -0,0 +1,32 @@
+from setuptools import find_packages, setup
+
+setup(
+    name='drfapikey',
+    version=__import__('rest_framework_api_key').__version__,
+    author="Emmanouil Konstantinidis",
+    author_email="manos@iamemmanouil.com",
+    packages=find_packages(),
+    include_package_data=True,
+    url="https://github.com/ekonstantinidis/django-rest-framework-api-key",
+    license='BSD',
+    description="Authenticate Web APIs made with Django REST Framework",
+    long_description=open("README.md").read(),
+    install_requires=[],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Environment :: Web Environment",
+        "Framework :: Django",
+        "Framework :: Django :: 1.7",
+        "Framework :: Django :: 1.8",
+        "Framework :: Django :: 1.9",
+        "License :: OSI Approved :: BSD License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.2",
+        "Programming Language :: Python :: 3.3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "Framework :: Django",
+    ],
+)
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/settings.py b/tests/settings.py
@@ -0,0 +1,65 @@
+import os
+
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+SECRET_KEY = 'django-rest-framework-api-key'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+INSTALLED_APPS = [
+    # Django Apps
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.staticfiles',
+
+    # External Packages
+    "rest_framework",
+    "rest_framework_api_key",
+
+    # Test apps
+    "tests"
+]
+
+REST_FRAMEWORK = {
+    'DEFAULT_PERMISSION_CLASSES': (
+        'rest_framework_api_key.permissions.HasAPIAccess',
+    )
+}
+
+MIDDLEWARE_CLASSES = (
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'django.middleware.security.SecurityMiddleware',
+)
+
+ROOT_URLCONF = 'tests.urls'
+
+STATIC_URL = '/static/'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
diff --git a/tests/test_admin.py b/tests/test_admin.py
diff --git a/tests/test_models.py b/tests/test_models.py
diff --git a/tests/test_views.py b/tests/test_views.py
diff --git a/tests/urls.py b/tests/urls.py
diff --git a/tests/views.py b/tests/views.py
diff --git a/tox.ini b/tox.ini
