django-pfx 1.2.dev97__tar.gz → 1.2.dev101__tar.gz

{django-pfx-1.2.dev97 → django-pfx-1.2.dev101}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev97
+Version: 1.2.dev101
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev97 → django-pfx-1.2.dev101}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev97
+Version: 1.2.dev101
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev97 → django-pfx-1.2.dev101}/django_pfx.egg-info/SOURCES.txt

@@ -17,6 +17,7 @@ django_pfx.egg-info/top_level.txt
 doc/Makefile
 doc/conf.py
 doc/index.rst
+doc/source/api.views.rst
 doc/source/authentication.md
 doc/source/cookbook.md
 doc/source/decorator.md
@@ -24,7 +25,6 @@ doc/source/getting_started.md
 doc/source/internationalisation.md
 doc/source/model.md
 doc/source/pfx_views.md
-doc/source/pfxcore.views.rst
 doc/source/testing.md
 img/pfx.png
 img/pfx.svg

{django-pfx-1.2.dev97 → django-pfx-1.2.dev101}/doc/conf.py

@@ -16,6 +16,8 @@ import sys
 import django
 from django.conf import settings
 
+from sphinx.ext.autodoc import between
+
 sys.path.insert(0, os.path.abspath('../'))
 settings.configure(
     SECRET_KEY='something to make Django happy',
@@ -26,8 +28,16 @@ settings.configure(
         'pfx.pfxcore'])
 django.setup()
 
-# -- Project information -----------------------------------------------------
 
+def setup(app):
+    # Register a sphinx.ext.autodoc.between listener to ignore everything
+    # between lines that contain --- and """ (yaml from apispec)
+    app.connect('autodoc-process-docstring',
+                between('^.*(---|""")$', exclude=True))
+    return app
+
+
+# -- Project information -----------------------------------------------------
 project = 'Django PFX'
 copyright = '2021, Hervé Martinet, Nicolas Béraneck'
 author = 'Hervé Martinet, Nicolas Béraneck'

{django-pfx-1.2.dev97 → django-pfx-1.2.dev101}/doc/index.rst

@@ -24,12 +24,12 @@ Topics
    source/getting_started
    source/decorator
    source/pfx_views
-   source/pfxcore.views
    source/model
    source/internationalisation
    source/authentication
    source/cookbook
    source/testing
+   source/api.views
 
 Indices and tables
 ==================

django-pfx-1.2.dev97/doc/source/pfxcore.views.rst → django-pfx-1.2.dev101/doc/source/api.views.rst

@@ -1,4 +1,4 @@
-Django PFX views
+API
 =====================
 
 The ``DetailRestViewMixin`` class
@@ -10,6 +10,20 @@ The ``DetailRestViewMixin`` class
 
 .. :inherited-members:
 
+The ``LocaleMiddleware`` class
+*********************************
+.. autoclass:: pfx.pfxcore.middleware.LocaleMiddleware
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The ``LocaleRestView`` class
+*********************************
+.. autoclass:: pfx.pfxcore.views.LocaleRestView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 The ``ModelMixin`` class
 *********************************
 .. autoclass:: pfx.pfxcore.views.ModelMixin

django-pfx-1.2.dev101/doc/source/internationalisation.md

@@ -0,0 +1,41 @@
+# Internationalisation
+
+## Translated strings
+
+Use Django's standard way of translating strings (verbose name, choices values, messages, ...).
+PFX will use the translated values according to the requested language.
+
+## Specify available languages
+
+In Django, `USE_I18N` must be `True` to use internationalization. Use `LANGUAGE_CODE` to set default locale.
+
+You can optionally set `USE_L10N` to `True` (see Django documentation).
+
+In Addition, you can set the list of available languages for web services with `LANGUAGES`:
+```
+LANGUAGES = [
+    ('fr', "French"),
+    ('en', "English"),
+]
+```
+
+You can use language only code of language and country.
+
+Service responses will use the first language of `Accept-Language` present in `LANGUAGES`.
+Use `X-Custom-Language` to force the use of a specific language.
+
+## LocaleRestView
+
+The `LocaleRestView` exposes a service on `/locales/languages` which returns the list of
+available languages.
+
+## LocaleMiddleware
+
+To enable internationalization in services, you have to add `'pfx.pfxcore.middleware.LocaleMiddleware'`
+in the `MIDDLEWARE` list.
+
+This middleware will use:
+* `LANGUAGES`, `LANGUAGE_CODE`, `Accept-Language` and `X-Custom-Language` to set the language.
+* `TIME_ZONE` and `X-Custom-Timezone` sot set the timezone.
+
+You can replace it by a custom middleware if you need another specific behavior.

{django-pfx-1.2.dev97 → django-pfx-1.2.dev101}/doc/source/testing.md

@@ -18,12 +18,12 @@ so that each request header contains
 the HTTP_X_CUSTOM_LANGUAGE attribute with the locale.
 
 Example :
-```
+```python
 client = APIClient(default_locale='en_GB')
 ```
 Each request to a service can also override the locale.
 Example :
-```
+```python
 client = APIClient()
 response = client.get('/api/authors', locale='fr_CH')
 ```
@@ -33,7 +33,7 @@ response = client.get('/api/authors', locale='fr_CH')
 Send a get request.
 
 Example :
-```
+```python
 client = APIClient()
 response = client.get('/api/authors')
 ```
@@ -42,7 +42,7 @@ response = client.get('/api/authors')
 Send a post request with content type 'application/json'.
 
 Example :
-```
+```python
 client = APIClient()
 response = client.post(
     '/api/authors', {
@@ -54,7 +54,7 @@ response = client.post(
 Send a put request with content type 'application/json'.
 
 Example :
-```
+```python
 client = APIClient()
 response = self.client.put(
     f'/api/authors/{author_pk}',
@@ -67,13 +67,12 @@ response = self.client.put(
 Send a delete request with content type 'application/json'.
 
 Example :
-```
+```python
 client = APIClient()
 response = client.delete(
     f'/api/authors/{author_pk}')
 ```
 
-
 ### Login
 If you use PFX authentication views you can use this login method.
 
@@ -81,7 +80,7 @@ Once you called login, you can call any other method
 listed above, the authentication token will be sent with the requests.
 
 Example :
-```
+```python
 client = APIClient()
 client.login(
     username='jrr.tolkien',
@@ -98,7 +97,7 @@ Test the response code of a response.
 It takes two parameters, the response and the expected status code.
 
 Example :
-```
+```python
 class ATestClass(TestAssertMixin, TransactionTestCase):
 
     def a_test(self):
@@ -110,12 +109,12 @@ class ATestClass(TestAssertMixin, TransactionTestCase):
         self.assertRC(response, 200)
 ```
 
-### assertJE
-Test the value of a json property in the json_content of the response.
-It takes 3 parameters, the response, the key and the expected value.
-It allows you to specify the path to reach an element in the json structure.
+### get_val
+
+Get a value for a python dictionary or a json HTTP response by a string path key.
+The src parameter can be a Python dictionary or an object with `json_content` attribute.
 For instance if you have a response like
-```
+```python
 {
     "author": {
         "pk": 2,
@@ -125,32 +124,58 @@ For instance if you have a response like
     "pk": 6,
 }
 ```
-you can reach the author pk by providing "author.pk" as the key.
+you can reach the author pk by providing `"author.pk"` as the key.
 
-AssertJE also allows to specify the index in an array.
-The syntax is "@index".
+get_val also allows to specify the index in an array.
+The syntax is `"@index"`.
 
 For instance if you want the pk of the author of the
-third item in an array of books you can specify "items.@3.author.pk"
+third item in an array of books you can specify `"items.@3.author.pk"`
 
 Example :
+```python
+class ATestClass(TestAssertMixin, TransactionTestCase):
+
+    def a_test(self):
+        client = APIClient()
+        response = client.get('/api/books')
+        author_pk = self.get_val(response, 'items.@3.author.pk')
 ```
+
+### assertJE
+Test the value of a dictionary property (using `get_val`).
+It takes 3 parameters, the source, the key and the expected value.
+
+Example :
+```python
 class ATestClass(TestAssertMixin, TransactionTestCase):
 
     def a_test(self):
         client = APIClient()
         response = client.get('/api/books')
-        self.assertJE(response, 'items.@3.author.pk', 6)
+        author_pk = self.assertJE(response, 'items.@3.author.pk', 6)
 ```
 
 ### assertNJE
-Assert NJE is the same as AssertJE, but it tests that the value is not equal.
+`AssertNJE` is the same as `AssertJE`, but it tests that the value is not equal.
+
+### assertJEExists
+Assert the path exists in the source.
+
+### assertJENotExists
+Assert the path does not exists in the source.
+
+### assertSize
+Test the size of a value (if the value is a collection).
+
+### assertJIn
+Test that an element is part of a collection value.
 
 ## Print Response
 You can use the print_response helper to print a response in the console.
 
 Example :
-```
+```python
 client = APIClient()
 response = client.get('/api/books')
 print_response(response)
@@ -158,7 +183,7 @@ print_response(response)
 
 will produce
 
-```
+```plain
 *********************http response*********************
 Status :  200 OK
 Headers :
@@ -186,3 +211,54 @@ Content :
 }
 *******************************************************
 ```
+
+## PermsAPITest
+
+This test class can be used to test permissions on services with multiple users.
+
+Create multiple users in `setUpTestData` and add a method for each service
+you want to test.
+
+You can test the response status code or the response list count for items list responses.
+
+Example :
+```python
+class BookPermsAPITest(PermsAPITest):
+    def setUp(self):
+        self.client = APIClient(with_cookie=True)
+
+    @classmethod
+    def setUpTestData(cls):
+        # Create your users here
+
+    def list(self):
+        # Create a book
+        return self.client.get('/api/books?items=1&count=1')
+
+    def get(self):
+        # book = … (create a book)
+        return self.client.get(f'/api/books/{book.pk}')
+
+    def post(self):
+        return self.client.post('/api/books', dict(
+            name="Test new"))
+
+    def put(self):
+        return self.client.put(
+            f'/api/books/{self.organization.pk}', dict(
+                name="Updated"))
+
+    def delete(self):
+        # book = … (create a book)
+        return self.client.delete(f'/api/books/{book.pk}')
+
+    USER_TESTS = {
+        "admin@user.org": dict(
+            list=200, list__count=1, get=200
+            post=200, put=200, delete=200),
+        "user@user.org": dict(
+            list=200, list__count=1, get=200,
+            post=403, put=403, delete=403),
+    }
+
+```

django-pfx-1.2.dev97/doc/source/internationalisation.md

@@ -1,5 +0,0 @@
-# Internationalisation
-
-- parameters
-- LocaleMiddleware
-- LocaleRestView