Adding docs and updating

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.12
+current_version = 0.2.5
 commit = True
 tag = True
 

.github/workflows/main.yml

@@ -20,29 +20,9 @@ jobs:
       fail-fast: false
       max-parallel: 3
       matrix:
-        python-version: [3.7, 3.8]
-        django-version: [2.2.12, 3.0.5]
-        drf-version: [3.7.7, 3.8.2, 3.9.4, 3.11.0]
-        # Remove unsupported combinations
-        exclude:
-          - python-version: 3.7
-            django-version: 3.0.5
-            drf-version: 3.7.7
-          - python-version: 3.7
-            django-version: 3.0.5
-            drf-version: 3.8.2
-          - python-version: 3.7
-            django-version: 3.0.5
-            drf-version: 3.9.4
-          - python-version: 3.8
-            django-version: 3.0.5
-            drf-version: 3.7.7
-          - python-version: 3.8
-            django-version: 3.0.5
-            drf-version: 3.8.2
-          - python-version: 3.8
-            django-version: 3.0.5
-            drf-version: 3.9.4
+        python-version: [3.8]
+        django-version: [2.2.23, 3.1.11, 3.2.5]
+        drf-version: [3.11.2, 3.12.1, 3.12.4]
 
     steps:
       - uses: actions/checkout@v1
@@ -60,9 +40,9 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: "Install Poetry"
-        uses: Gr1N/setup-poetry@v2
+        uses: Gr1N/setup-poetry@v4
         with:
-          poetry-version: 1.0.5
+          poetry-version: 1.1.4
 
       - uses: actions/cache@v1
         id: cache

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-    "python.formatting.provider": "black"
+    "python.formatting.provider": "black",
+    "restructuredtext.confPath": "${workspaceFolder}/docs"
 }

SECURITY.md

@@ -0,0 +1,28 @@
+# Security
+
+## 🔐 Reporting Security Issues
+
+> Do not open issues that might have security implications!
+> It is critical that security related issues are reported privately so we have time to address them before they become public knowledge.
+
+Vulnerabilities can be reported by emailing core members:
+
+- Patrick Forringer [[email protected]](mailto:[email protected])
+- Buddy Lindsey [[email protected]](mailto:[email protected])
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Environment (e.g. Linux / Windows / macOS)
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Preferred Languages
+
+We prefer all communications to be in English.

ariadne_extended.code-workspace

@@ -4,5 +4,10 @@
 			"path": "."
 		}
 	],
-	"settings": {}
+	"settings": {
+		"cSpell.words": [
+			"camelize",
+			"decamelize"
+		]
+	}
 }

ariadne_extended/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.12"
+__version__ = "0.2.5"

ariadne_extended/contrib/waffle_graph/resolvers.py

@@ -1,12 +1,33 @@
-from ariadne_extended.resolvers import ListModelResolver, Resolver
+from ariadne_extended.resolvers import ListModelResolver, Resolver, DetailModelMixin
+from ariadne_extended.permissions import AllowAny
 from waffle import get_waffle_flag_model
 from waffle.models import Sample, Switch
 from waffle.utils import get_setting
 
 from .types import query, waffle_item_interface, waffle_type
 
 
-class WaffleResolver(ListModelResolver):
+class WaffleResolver(DetailModelMixin, ListModelResolver):
+    """
+    Base resolver for waffle models, allows all users to resolve as the data is not sensitive
+    and may even be resolved by users that aren't logged in.
+    """
+
+    lookup_arg = "name"
+    lookup_field = "name"
+    permission_classes = [AllowAny]
+
+    def get_object(self):
+        """
+        Use the get method provided by the django-waffle library to lookup a flag/switch/sample
+
+        Waffle models don't require object level permissions
+
+        Returns an empty model class if not found with the used lookup name
+        """
+        lookup = self.get_lookup_filter_kwargs()
+        return self.model.get(**lookup)
+
     def get_queryset(self):
         # Not a true QS, will ask cache for saved model objects
         return self.model.get_all()
@@ -29,18 +50,24 @@ def list(self, *args, **kwargs):
         return Switch.get_all() + Sample.get_all() + get_waffle_flag_model().get_all()
 
 
-@waffle_item_interface.field("active")
-def resolve_flag_active(obj, info, *args, **kwargs):
-    try:
-        return obj.is_active(info.context)
-    except TypeError:
-        return obj.is_active()
+class ActiveResolver(Resolver):
+    permission_classes = [AllowAny]
+
+    def check(self, parent, *args, **kwargs):
+        try:
+            return parent.is_active(self.request)
+        except TypeError:
+            return parent.is_active()
 
 
 waffle_type.set_field("flags", FlagResolver.as_resolver(method="list"))
 waffle_type.set_field("switches", SwitchResolver.as_resolver(method="list"))
 waffle_type.set_field("samples", SampleResolver.as_resolver(method="list"))
 waffle_type.set_field("all", AllWaffleTypesResolver.as_resolver(method="list"))
+waffle_type.set_field("flag", FlagResolver.as_resolver(method="retrieve"))
+waffle_type.set_field("switch", SwitchResolver.as_resolver(method="retrieve"))
+waffle_type.set_field("sample", SampleResolver.as_resolver(method="retrieve"))
+waffle_item_interface.set_field("active", ActiveResolver.as_resolver(method="check"))
 query.set_field(
     "waffle",
     lambda *x: {

ariadne_extended/contrib/waffle_graph/schema.graphql

@@ -1,26 +1,26 @@
 interface WaffleItem {
-  id: ID!
+  id: ID
   name: String
   active: Boolean
   note: String
 }
 
 type WaffleFlag implements WaffleItem {
-  id: ID!
+  id: ID
   name: String
   active: Boolean
   note: String
 }
 
 type WaffleSwitch implements WaffleItem {
-  id: ID!
+  id: ID
   name: String
   active: Boolean
   note: String
 }
 
 type WaffleSample implements WaffleItem {
-  id: ID!
+  id: ID
   name: String
   active: Boolean
   note: String
@@ -31,8 +31,17 @@ type Waffle {
   switches: [WaffleSwitch]
   samples: [WaffleSample]
   all: [WaffleItem]
+  "Retrieve a flag"
+  flag(name: String): WaffleFlag
+  "Retrieve a switch"
+  switch(name: String): WaffleSwitch
+  "Retrieve a sample"
+  sample(name: String): WaffleSample
+  "The default flag value as specified in the settings"
   flagDefault: Boolean
+  "The default switch value as specified in the settings"
   switchDefault: Boolean
+  "The default sample value as specified in the settings"
   sampleDefault: Boolean
 }
 

ariadne_extended/cursor_pagination/__init__.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 from .mixins import RelayModelMixin
 from .pagination import CursorPage, CursorPaginator, InternalPaginator, InvalidCursor
 from .resolvers import RelayModelResolver, page_info_resolver

ariadne_extended/cursor_pagination/pagination.py

@@ -3,10 +3,10 @@
 updated to remove dependency on six
 """
 from base64 import b64decode, b64encode
-from collections import Sequence
+from collections.abc import Sequence
 
 from django.db.models import Field, Func, Value, TextField
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 
 
 class TupleField(Field):
@@ -87,8 +87,8 @@ def __init__(self, qs, ordering):
 
         self.ordering = ordering
 
-        if not all(o.startswith("-") for o in ordering) and not all(
-            not o.startswith("-") for o in ordering
+        if not all(o.startswith("-") for o in ordering) and any(
+            o.startswith("-") for o in ordering
         ):
             raise InvalidCursor("Direction of orderings must match")
 
@@ -143,8 +143,7 @@ def decode_cursor(self, cursor):
             raise InvalidCursor(self.invalid_cursor_message)
 
     def encode_cursor(self, position):
-        encoded = b64encode(self.delimiter.join(position).encode("utf8")).decode("ascii")
-        return encoded
+        return b64encode(self.delimiter.join(position).encode("utf8")).decode("ascii")
 
     def position_from_instance(self, instance):
         position = []

ariadne_extended/filters/__init__.py

@@ -1,2 +1,3 @@
+# flake8: noqa
 from .backends import GraphQLFilterBackend
 from .mixins import FilterMixin

ariadne_extended/filters/mixins.py

@@ -21,7 +21,7 @@ def filter_queryset(self, queryset):
         default queryset.
         """
         for backend in list(self.filter_backends):
-            queryset = backend().filter_queryset(self.info, queryset, self)
+            queryset = backend().filter_queryset(self.request, queryset, self)
         return queryset
 
     def get_filter_data(self):

ariadne_extended/graph_loader/apps.py

@@ -17,17 +17,17 @@ class GraphLoaderConfig(AppConfig):
 
     def ready(self):
         # Find all schema.graphql and resolver modules and load them
-        self.type_defs = list()
-        self.types = list()
-        self.resolvers = list()
+        self.type_defs = []
+        self.types = []
+        self.resolvers = []
 
         logger.debug("Trying to load resolvers and schemas:")
         for config in apps.get_app_configs():
             self.load_schema(config)
             self.load_resolvers(config)
             self.load_custom_types(config)
 
-        logger.debug("Types: %s", ", ".join([_type.name for _type in self.types]))
+        logger.debug("Types: %s", ", ".join(_type.name for _type in self.types))
 
     def load_schema(self, config):
         try:
@@ -59,10 +59,7 @@ def load_custom_types(self, config):
             for type_name in [
                 t
                 for _, t in types_module.__dict__.items()
-                if isinstance(t, ObjectType)
-                or isinstance(t, ScalarType)
-                or isinstance(t, EnumType)
-                or isinstance(t, UnionType)
+                if isinstance(t, (ObjectType, ScalarType, EnumType, UnionType))
             ]:
                 self.types.append(type_name)
         except ModuleNotFoundError as e:

ariadne_extended/payload/resolvers.py

@@ -1,8 +1,6 @@
 from copy import copy
 
 import humps.main as humps
-from ariadne import FallbackResolversSetter
-from graphql.type import GraphQLList, GraphQLField
 from .types import error_detail, payload
 from rest_framework.exceptions import ErrorDetail
 
@@ -14,10 +12,9 @@ def resolve_error_detail_error(parent, info, *args, **kwargs):
 
 
 def traverse_errors(fields, node, stack=""):
-
     # Does the list contain errors or more fields?
     if isinstance(node, list):
-        if any([isinstance(i, ErrorDetail) for i in node]):
+        if any(isinstance(i, ErrorDetail) for i in node):
             stack_key = copy(stack)
             fields.append(dict(name=humps.camelize(stack_key), values=node))
         else:
@@ -32,7 +29,7 @@ def traverse_errors(fields, node, stack=""):
     # If node is a dict, use the keys
     if isinstance(node, dict):
         for name, errors in node.items():
-            # Copy key so the ref is lost and the chain becomes unique
+            # Copy key so the ref is lost and the stack becomes unique
             stack_key = copy(stack)
             if bool(stack_key):
                 if isinstance(name, int):