updated to version 0.5.10

.github/workflows/main.yml

@@ -0,0 +1,62 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Unittests
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master, develop ]
+  pull_request:
+    branches: [ master, develop ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+
+  # This workflow contains a single job called "build"
+  build:
+    environment: Master
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      - name: Generate env vars from gh secrets
+        run: |  
+          echo TEMPLATE_ROOT_DIR=${{ secrets.TEMPLATE_ROOT_DIR }} >> .env
+          echo FAUNA_SECRET=${{ secrets.FAUNA_SECRET }}  >> .env
+          echo FAUNA_SCHEME=${{ secrets.FAUNA_SCHEME }} >> .env
+          echo FAUNA_DOMAIN=${{ secrets.FAUNA_DOMAIN }} >> .env
+          echo FAUNA_PORT=${{ secrets.FAUNA_PORT}} >> .env
+          echo FAUNA_GRAPHQL_IMPORT_URL=${{ secrets.FAUNA_GRAPHQL_IMPORT_URL}} >> .env
+          echo FAUNA_GRAPHQL_URL=$${{ secrets.FAUNA_GRAPHQL_URL }} >> .env
+          echo DEFAULT_FROM_EMAIL=${{ secrets.DEFAULT_FROM_EMAIL }} >> .env
+          echo PROJECT_NAME=${{ secrets.PROJECT_NAME }} >> .env
+          echo KEY_MODULE=${{ secrets.KEY_MODULE }}  >> .env
+          cat .env
+      - run: docker-compose pull
+
+      # In this step, this action saves a list of existing images,
+      # the cache is created without them in the post run.
+      # It also restores the cache if it exists.
+      - uses: satackey/[email protected]
+        # Ignore the failure of a step and avoid terminating the job.
+        continue-on-error: true
+
+      - run: docker volume create --name=pfunk-fauna-data
+      - run: docker-compose build
+
+      # Runs a single command using the runners shell
+      - name: Run Unit Tests
+        run: docker-compose run web poetry run python -m unittest
+      - name: Build and publish to pypi
+        if: github.ref == 'refs/heads/master'
+        uses: JRubics/[email protected]
+        with:
+          pypi_token: ${{ secrets.PYPI_TOKEN }}
+          ignore_dev_requirements: "yes"

.gitignore

@@ -132,3 +132,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 /pfunk/carcamp/
+/notebooks/

Dockerfile

@@ -1,4 +1,5 @@
 FROM capless/capless-docker:jupyter
+RUN pip install --upgrade pip
 COPY . /code
 RUN poetry run pip install --upgrade pip
 RUN poetry install

README.md

@@ -22,21 +22,29 @@ Includes GraphQL and generic ABAC auth workflow integrations.
 
 - [Getting Started](#Getting-Started)
     - [Installation](#Installation)
+    - [Environment Variables](#environment-variables)
     - [Setup the Connection](#setup-the-connection)
     - [Define your Collections](#define-your-collections-collectionspy)
     - [Choose an Auth Workflow](#auth-workflows)
     - [Publish](#publish)
     - [Save Some Data](#save-some-data)
     - [Query Your Data](#query-your-data)
     - [Delete a Record](#delete-a-record)
-
+- [Customizing your setup](#customizing-your-setup)
+    - [Option 1: Environment Variables](#option-1-environment-variables)
+    - [Option 2: Inline Field](#option-2-inline-field)
 
 
 ### Getting Started
 
 ### Installation
 ```pip install pfunk```
 
+### Environment Variables
+
+- **FAUNA_SECRET** - Fauna admin or server key.
+- **FAUNA_SCHEME** - (optional) HTTP scheme to use (default: https)
+- 
 ### Setup the Connection
 
 #### Using Environment Variables (Preferred Method)
@@ -207,3 +215,120 @@ Let's delete the record from above.
 ```python
 product.delete()
 ```
+
+
+
+### Customizing your setup
+This section is for customizing your `user` and `group` collections to your liking. e.g.
+- Renaming your `User` and `Group` collection to something more verbose to your usage e.g. `Agent (User)` to `Firm (Group)`
+- Subclassing the `user` or `group` collection in order to have more control to what kind of auth collection you want to have
+
+
+### Custom User and Groups
+Initially, we have multiple ways of defining your custom user-group collections.
+Things to keep in mind:
+- `UserGroup` class **must** be subclassed and reference to the custom `user` and `group`
+- How the permissions work will do the same thing in custom user and group. This just gives you the ability to fully customize your own auth collections.
+
+
+
+### Option 1: Environment Variables
+This is the easiest way. Just go to your `.env` file and define:
+```
+USER_COLLECTION=Newuser    # Class name of your custom user class - case-sensitive!
+GROUP_COLLECTION=Newgroup  # Class name of your custom group class - case-sensitive!
+GROUP_COLLECTION_DIR=dir.to.Newgroup  # class dir to import your custom group 
+USER_COLLECTION_DIR=dir.to.Newuser   # class dir to import your custom user group
+```
+Then you'll end up with this in your `collections.py`
+```python
+from pfunk.contrib.auth.collections import BaseGroup, ExtendedUser, BaseUserGroup as ug
+from pfunk.contrib.auth.resources import GenericUserBasedRole
+
+
+class UserGroups(ug):
+    userID = ReferenceField('dir.to.Newuser')
+    groupID = ReferenceField('dir.to.Newgroup')
+
+
+class Newgroup(BaseGroup):
+    users = ManyToManyField('dir.to.Newuser', relation_name='custom_users_groups')
+
+
+class Newuser(ExtendedUser):
+    user_group_class = import_util('dir.to.UserGroups')
+    group_class = import_util('dir.to.Newgroup')
+    groups = ManyToManyField('dir.to.Newgroup', relation_name='custom_users_groups')
+    blogs = ManyToManyField('dir.to.Blog', relation_name='users_blogs')
+
+
+class Blog(Collection):
+    collection_roles = [GenericUserBasedRole]
+    title = StringField(required=True)
+    content = StringField(required=True)
+    user = ReferenceField('dir.to.Newuser', relation_name='users_blogs')
+
+    def __unicode__(self):
+        return self.title
+
+```
+
+
+
+### Option 2: Inline Field
+If for some reason you don't want to use the environment variables, you can define the needed fields
+directly in your `Collection`. This is what we use in PFunk's unit tests, refer to it if you 
+need more usage but essentially:
+```python
+class Blog(Collection):
+    user_collection = 'Newuser'
+    group_collection = 'Newgroup'
+    user_collection_dir = 'dir.to.Newuser'
+    group_collection_dir = 'dir.to.Newgroup'
+    ...
+```
+
+
+Generally, this is how your `collections.py` will look like in the end if you want to define
+your custom auth collections in fields.
+
+
+```python
+from pfunk.contrib.auth.collections import BaseGroup, ExtendedUser, BaseUserGroup as ug
+from pfunk.contrib.auth.resources import GenericUserBasedRole
+
+
+class UserGroups(ug):
+    userID = ReferenceField('this.file.NewUser')
+    groupID = ReferenceField('this.file.Newgroup')
+
+
+class Newgroup(BaseGroup):
+    users = ManyToManyField('this.file.Newuser', relation_name='custom_users_groups')
+
+
+class Newuser(ExtendedUser):
+    user_group_class = import_util('this.file.UserGroups')
+    group_class = import_util('this.file.Newgroup')
+    groups = ManyToManyField('this.file.Newgroup', relation_name='custom_users_groups')
+    blogs = ManyToManyField('this.file.Blog',
+                            relation_name='users_blogs')
+
+    group_collection = 'Newgroup'
+
+
+class Blog(Collection):
+    collection_roles = [GenericUserBasedRole]
+    title = StringField(required=True)
+    content = StringField(required=True)
+    user = ReferenceField('this.file.Newuser', relation_name='users_blogs')
+
+    user_collection = 'Newuser'
+    group_collection = 'Newgroup'
+    user_collection_dir = 'this.file.Newuser'
+    group_collection_dir = 'this.file.Newgroup'
+
+    def __unicode__(self):
+        return self.title
+```
+

docker-compose.yaml

@@ -10,7 +10,8 @@ services:
       - "8010"
       - "3434"
     depends_on:
-      - fauna
+      fauna:
+        condition: service_healthy
     ports:
       - 8010:8888
       - 3434:3434
@@ -22,12 +23,12 @@ services:
 
   fauna:
     restart: always
-    image: fauna/faunadb
+    image: fauna/faunadb:4.15.0
     ports:
       - 8443:8443
       - 8444:8444
       - 8445:8445
-      - 8084:8084
+      - 8085:8085
     volumes:
       - ./logs:/var/log/faunadb
       - ./docker-fauna.yml:/docker-fauna.yml

pfunk/__init__.py

@@ -5,8 +5,9 @@
 .. include:: ../CONTRIBUTE.md
 """
 __docformat__ = "google"
+
+from .client import FaunaClient
 from .collection import Collection, Enum
 from .fields import (StringField, IntegerField, DateField, DateTimeField, BooleanField, FloatField, EmailField,
                      EnumField, ReferenceField, ManyToManyField, SlugField)
 from .project import Project
-from .client import FaunaClient