Initial commit

Author: Patrick Jentsch

.gitignore

@@ -0,0 +1,3 @@
+build
+dist
+*.egg-info

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Patrick Jentsch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,69 @@
+# Flask-Hashids
+
+Hashids integration for Flask applications, it is based on the [Hashid](https://github.com/davidaurelio/hashids-python) package available on [PyPi](https://pypi.org/project/hashids/). With this extension you can conveniently use integer ids for your application logic or database tables and hash them before exposing it in URLs or JSON data.
+
+## Installation
+
+The latest stable version [is available on PyPI](https://pypi.org/project/Flask-Hashids/). Either add `Flask-Hashids` to your `requirements.txt` file or install with pip:
+
+```
+pip install Flask-Hashids
+```
+
+## Configuration
+
+Flask-Hashids is configured through the standard Flask config API. These are the available options:
+
+- **HASHIDS_ALPHABET**: Read more about that in [Hashids documentation](https://github.com/davidaurelio/hashids-python#using-a-custom-alphabet)
+- **HASHIDS_MIN_LENGTH**: Read more about that in [Hashids documentation](https://github.com/davidaurelio/hashids-python#controlling-hash-length)
+- **SECRET_KEY**: Used as the salt, read more in [Hashids documentation](https://github.com/davidaurelio/hashids-python#using-a-custom-salt)
+
+## Examples
+
+```python
+from flask import abort, Flask, render_template, url_for
+from flask_hashids import HashidMixin, Hashids
+from flask_sqlalchemy import SQLAlchemy
+
+
+app = Flask(__name__)
+# The SECRET_KEY is used as a salt, so don't forget to set this in production
+app.config['SECRET_KEY'] = 'secret!'
+db = SQLAlchemy(app)
+hashids = Hashids(app)
+
+
+class User(HashidMixin, db.Model):
+    __tablename__ = 'users'
+
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String(64), nullable=False)
+
+
+@app.route('/users')
+def users():
+    hashid_users = [
+      {
+        'id': user.hashid,  # hashid property from HashidMixin
+        'name': user.name,
+        'url': url_for('user', user_id=user.id)  # Int id for url generation
+      } for user in User.query.all()
+    ]
+    return render_template('users.html', users=hashid_users)
+
+
+@app.route('/users/<hashid:user_id>')
+def user(user_id):
+    # The HashidConverter decodes the given hashid to an int
+    user = User.query.get_or_404(user_id):
+    return render_template('user.html', user=user)
+
+
+if __name__ == '__main__':
+    app.run()
+```
+
+
+## Ressources
+
+- https://hashids.org/python/

flask_hashids.py

@@ -0,0 +1,69 @@
+from flask import current_app, Flask
+from hashids import Hashids as _Hashids
+from typing import Any, Dict
+from werkzeug.routing import BaseConverter
+
+
+class HashidMixin:
+    '''
+    Hashid mixin meant for use with SQLAlchemy models.
+    Adds a property to the model which returns a hashid based on the model id.
+
+    This won't add a column to the model, the hashid is computed on runtime.
+
+    Note: The extended class must have an attribute 'id' of type int!
+    '''
+    @property
+    def hashid(self):
+        return current_app.extensions['hashids'].encode(self.id)
+
+
+class HashidConverter(BaseConverter):
+    '''
+    Hashid Converter.
+
+    Converts given hashids from routes to integers.
+    Example: @bq.route('/users/<hashid:user_id')
+
+    Converts integers to hashids when generating urls.
+    Example: url_for('users.user', user_id=user.id)
+    '''
+
+    def to_python(self, value: str) -> int:
+        return current_app.extensions['hashids'].decode(value)
+
+    def to_url(self, value: int) -> str:
+        return current_app.extensions['hashids'].encode(value)
+
+
+class Hashids:
+    ''' Wrapper class to easily integrate hashids in Flask '''
+
+    def __init__(self, app: Flask = None):
+        self.app = app
+        if app is not None:
+            self.init_app(app)
+
+    def init_app(self, app: Flask):
+        ''' Setup Hashids, includes the integration of the HashidConverter. '''
+        hashids_config: Dict[str, Any] = {}
+        if 'HASHIDS_ALPHABET' in app.config:
+            hashids_config['alphabet'] = app.config['HASHIDS_ALPHABET']
+        if 'HASHIDS_MIN_LENGTH' in app.config:
+            hashids_config['min_length'] = \
+                int(app.config['HASHIDS_MIN_LENGTH'])
+        if 'SECRET_KEY' in app.config:
+            hashids_config['salt'] = app.config['SECRET_KEY']
+        self._hashids = _Hashids(**hashids_config)
+        if not hasattr(app, 'extensions'):
+            app.extensions = {}
+        app.extensions['hashids'] = self
+        app.url_map.converters['hashid'] = HashidConverter
+
+    def decode(self, value: str) -> int:
+        ''' Decode a hashid to an integer. '''
+        return self._hashids.decode(value)[0]
+
+    def encode(self, value: int) -> str:
+        ''' Encode an integer to a hashid. '''
+        return self._hashids.encode(value)

setup.py

@@ -0,0 +1,25 @@
+from setuptools import setup
+
+
+with open('README.md', 'r') as fh:
+    long_description = fh.read()
+
+
+setup(
+    name='Flask-Hashids',
+    version='0.2.0',
+    url='https://github.com/Pevtrick/Flask-Hashids',
+    author='Patrick Jentsch',
+    author_email='[email protected]',
+    description='Hashids integration for Flask applications.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    py_modules=['flask_hashids'],
+    install_requires=['Flask', 'Hashids >= 1.0.2'],
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.5',
+)