Package: drf-integrations-framework
DRF Integrations FrameworkDRF Integrations Framework is a toolkit that plugs in toDjango REST Frameworkand simplifies the management of third party integrations. If you find yourself connecting to multiple services with
different sets of credentials, or handling multiple inbound requests from third party services, DRF Integrations
Framework will probably simplify that for you. DRF Integrations Framework will help you split the responsibilities
between the source/destiny of events, how these requests are authenticated and the business logic associated to them.RequirementsPython 3.7+Django 2.2+Django REST Framework 3.9.2+Django OAuth Toolkit 1.7.1+InstallationThe following library is required in order to build onLinux systems. It fixes the
problem whereError: pg_config executable not found.is given when installing psycopg2
viapoetry installsudo apt install libpq-devInstall from PyPi:pipinstalldrf-integrations-frameworkOr install from source:pipinstallhttps://github.com/yoyowallet/drf-integrations-framework/archive/v0.7.1.tar.gzAdd the apps to yourINSTALLED_APPS:INSTALLED_APPS=[...,"rest_framework","oauth2_provider","drf_integrations",]If you are going to configure any inbound integration, you will want to add the integration URLs to yoururls.py:fromdrf_integrationsimportintegrationsurlpatterns=[...]+integrations.get_urls()ConfigurationSettingsDRF Integrations Framework relies on Django OAuth Toolkit to manage third party applications. In order to be able to use
it, first you'll need to configure DOT by setting (at least) the model references in your settings.OAUTH2_PROVIDER_APPLICATION_MODEL="drf_integrations.Application"OAUTH2_PROVIDER_ACCESS_TOKEN_MODEL="drf_integrations.AccessToken"OAUTH2_PROVIDER_GRANT_MODEL="drf_integrations.Grant"OAUTH2_PROVIDER_REFRESH_TOKEN_MODEL="drf_integrations.RefreshToken"Then, similarly, you will have to configure the model for the integrations.INTEGRATIONS_APPLICATION_INSTALLATION_MODEL="drf_integrations.ApplicationInstallation"You will also have to configure how the integrations are stored in the database. On the one hand, you will have to set
the type of JSON field your DB uses. On the other hand, you will have to set the name of the attribute where you want to
relate the integrations.DB_BACKEND_JSON_FIELD="django.db.models.JSONField"INTEGRATIONS_APPLICATION_INSTALLATION_INSTALL_ATTRIBUTE="organisation"Finally, you have to set the list of integrations that are available in your system (see the following section to learn
about creating integrations).INSTALLED_INTEGRATIONS=["example.drf_integrations_example.api.integrations.APIClientIntegration",]Creating integrationsAn integration is represented by an extension ofBaseIntegration. Then, the integration will be available to be
installed to different clients (as related with the previously configuredINTEGRATIONS_APPLICATION_INSTALLATION_INSTALL_ATTRIBUTE) once it is stored into anApplication. This can be done in
two different ways:Internal integrations (or non-local integrations) are those that can be configured once and installed to different clients with different
parameters. For example, your system may connect to Mixpanel, the connections and interactions with the service are all
the same, only the secret in the connection changes.These will only have 1Applicationobject in the database, and it can be related to multiple installations. They
can also be automatically created by using thesyncregistrymanagement command.pythonmanage.pysyncregistryLocal integrations are those that are specific to just one client. For example, OAuth clients are local, there is
1 application per client, which will have the specific credentials for them, so they can only be installed once. These
are usually created on demand as required by clients.An integration broadly has 3 functions:Generates a list of URLs that a third party represented by this integration can connect to.
Mainly used for inward integrations.Returns a client that can connect to the third party it represents. Mainly used for outward integrations.Produce queryset filter lookups to search for installations of the integration.Once you have a class inheriting fromBaseIntegrationthat represents a third party, simply add it toINSTALLED_INTEGRATIONSin your settings and the sky is the limit! You can create custom authentication backends,
permissions, event hooks... Take a look atthe exampleto see some basic examples of how you can make use
of DRF Integrations Framework.PreconfiguredThere are some features that DRF Integrations Framework provides out of the box.Admin model forApplicationInstallationthat already handles integration-specific configuration via dynamic forms.Automatic form validation for integrations that have one.An authentication backend for local OAuth2 integrations
(drf_integrations.auth_backends.IntegrationOAuth2Authentication).Running the testsTo run the tests you need to have a postgresql server running on localhost and have a
postgres user/role defined. To create the postgres user and role you can use the
following:psql -c 'CREATE ROLE postgres WITH LOGIN SUPERUSER'To run the tests execute the followingmake testsIf running tests under pycharm ensure thatpython tests->pytestis used and set
theAdditional Argumentsto--no-migrationsFailing to specify--no-migrationswill result in the following error:ValueError: Related model 'oauth2_provider.idtoken' cannot be resolvedChangelogSeeReleasesAuthorsDRF Integrations Framework is an original idea by@jianyuan, developed and maintained by
the platform team at@yoyowallet.