[CAT-1069] Create configuration for onfido-python library generation (#64)

* Preliminary changes to allow delivery generated code with multiple libraries
* Add Python (sync) client library configuration

Author: dvacca-onfido

.github/workflows/update-specs-and-client-libraries.yaml

@@ -36,6 +36,11 @@ on:
         required: true
         default: false
         type: boolean
+      update-onfido-python:
+        description: "Update onfido-python?"
+        required: true
+        default: false
+        type: boolean
 jobs:
   validate_input_specs:
     name: Validate multi file specification
@@ -51,6 +56,7 @@ jobs:
       java_version: ${{ steps.generator.outputs.java_version }}
       typescript_axios_version: ${{ steps.generator.outputs.typescript_axios_version }}
       php_version: ${{ steps.generator.outputs.php_version }}
+      python_version: ${{ steps.generator.outputs.python_version }}
     container:
       image: openapitools/openapi-generator-cli:v7.4.0
       env:
@@ -64,7 +70,8 @@ jobs:
           apt-get install -yqq \
             gettext-base \
             git \
-            jq
+            jq \
+            pipx
       - name: Validate multi-file OpenAPI specification
         run: |
           $OPENAPI_GENERATOR_COMMAND validate -i openapi.yaml
@@ -78,7 +85,7 @@ jobs:
           name: artifacts-${{ github.workflow }}-${{ github.run_id }}-${{ github.run_number }}
           path: |
             generated/artifacts
-            generators/*/exclusions.txt
+            generators/**/exclusions.txt
   update_specs:
     name: Update and commit single-file OpenAPI specifications
     runs-on: ubuntu-latest
@@ -112,7 +119,7 @@ jobs:
     strategy:
       matrix:
         include:
-          - generator: java
+          - generator: java/okhttp-gson
             git_repo_id: onfido-java
             preCommit: |
               mvn -B package --file pom.xml clean
@@ -127,9 +134,16 @@ jobs:
           - generator: php
             git_repo_id: onfido-php
             preCommit: |
-              composer install
+              composer update --lock
             version: ${{ needs.generate_specs_and_libraries.outputs.php_version }}
             update: ${{ inputs.update-onfido-php }}
+          - generator: python/urllib3
+            git_repo_id: onfido-python
+            preCommit: |
+              pipx install poetry==1.8
+              poetry lock
+            version: ${{ needs.generate_specs_and_libraries.outputs.python_version }}
+            update: ${{ inputs.update-onfido-python }}
     if: github.event_name == 'workflow_dispatch'
     steps:
       - uses: actions/checkout@v4
@@ -143,7 +157,8 @@ jobs:
       - name: Integrate generated code (${{ matrix.version }})
         if: ${{ matrix.update }}
         run: |
-          rsync -r --delete-after --exclude='/.git*' --exclude='CHANGELOG*' \
+          rsync -r --delete-after --exclude='/.git*' --exclude='/CHANGELOG*' \
+                --exclude='/.openapi-generator-ignore' \
                 --exclude-from=generators/${{ matrix.generator }}/exclusions.txt \
                 generated/artifacts/${{ matrix.generator }}/ .
       - name: Run pre-commit script

generators/common/config.yaml

@@ -1,6 +1,7 @@
 inputSpec: openapi.yaml
 gitUserId: onfido
-generatorName: ${GENERATOR}
+generatorName: ${GENERATOR_NAME}
+library: "${GENERATOR_LIBRARY}"
 templateDir: generators/${GENERATOR}/templates
 outputDir: generated/artifacts/${GENERATOR}
 disallowAdditionalPropertiesIfNotPresent: false

generators/common/templates/.openapi-generator-ignore

@@ -5,7 +5,6 @@ groupId: com.onfido
 invokerPackage: com.onfido
 apiPackage: com.onfido.api
 modelPackage: com.onfido.model
-library: okhttp-gson
 httpUserAgent: onfido-java/${CLIENT_LIBRARY_VERSION}
 artifactDescription: Official Java API client library for the Onfido API
 artifactUrl: https://documentation.onfido.com

generators/java/config.yaml renamed to generators/java/okhttp-gson/config.yaml

@@ -0,0 +1 @@
+../../../common/templates/LICENSE.mustache

generators/java/exclusions.txt renamed to generators/java/okhttp-gson/exclusions.txt

@@ -4,11 +4,13 @@ The official Java library for integrating with the Onfido API.
 
 Documentation can be found at <{{ documentationUrl }}>.
 
-This library is only for use on the backend, as it uses Onfido API tokens which must be kept secret.
+This library is only for use on the backend, as it uses Onfido API tokens which must be kept secret. If you do need to collect applicant data in the frontend of your application, we recommend that you use the Onfido SDKs: [iOS](https://github.com/onfido/onfido-ios-sdk), [Android](https://github.com/onfido/onfido-android-sdk), [Web](https://github.com/onfido/onfido-sdk-ui), and [React Native](https://github.com/onfido/react-native-sdk).
 
 This version uses Onfido API {{ apiVersion }}. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
 
-## Requirements
+## Installation & Usage
+
+### Requirements
 
 Building the API client library requires:
 
@@ -20,7 +22,7 @@ Building the API client library requires:
 3. Maven/Gradle
    {{/jersey2}}
 
-## Installation
+### Installation
 
 To install the API client library to your local Maven repository, simply execute:
 
@@ -36,7 +38,7 @@ mvn clean deploy
 
 Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
 
-### Maven users
+#### Maven users
 
 Add this dependency to your project's POM:
 
@@ -49,7 +51,7 @@ Add this dependency to your project's POM:
 </dependency>
 ```
 
-## Gradle users
+#### Gradle users
 
 Add this dependency to your project's build file:
 
@@ -64,7 +66,7 @@ Add this dependency to your project's build file:
   }
 ```
 
-### Others
+#### Others
 
 At first generate the JAR by executing:
 
@@ -86,6 +88,7 @@ Import the `DefaultApi` object, this is the main object used for interfacing wit
 ```java
 import com.onfido.api.DefaultApi;
 import com.onfido.ApiException;
+import com.onfido.OnfidoInvalidSignatureError;
 ```
 
 Instantiate and configure an `Onfido` instance with your API token, and region if necessary:
@@ -100,7 +103,7 @@ DefaultApi onfido = new DefaultApi(Configuration.getDefaultApiClient()
 
 NB: by default, timeout values are set to 30 seconds.
 
-## Making a call to the API
+### Making a call to the API
 
 Most of the request bodies can be created using a builder pattern, this would look something like:
 
@@ -121,14 +124,6 @@ try {
 
    // ...
 
-   // Webhook verification
-   WebhookEventVerifier verifier = new WebhookEventVerifier("_ABC123abc...3ABC123_");
-
-   String signature = "a0...760e";
-
-   WebhookEvent event = verifier.readPayload(rawEvent, signature);
-
-   const event = verifier.readPayload("{\"payload\":{\"r...3\"}}}", signature);
 } catch (ApiException e) {
     // An error response was received from the Onfido API, extra info is available.
     System.out.println(e.getMessage());
@@ -139,7 +134,24 @@ try {
 }
 ```
 
-## Recommendation
+### Webhook event verification
+
+Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:
+
+```java
+try {
+   WebhookEventVerifier verifier = new WebhookEventVerifier("_ABC123abc...3ABC123_");
+
+   String signature = "a0...760e";
+
+   WebhookEvent event = verifier.readPayload("{\"payload\":{\"r...3\"}}}", signature);
+} catch( OnfidoInvalidSignatureError e ) {
+   // Invalid webhook signature
+}
+```
+
+
+### Recommendation
 
 It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
 

generators/java/okhttp-gson/templates/LICENSE.mustache

@@ -0,0 +1,3 @@
+files:
+  README.mustache:
+    destinationFilename: README.md

generators/java/templates/OnfidoInvalidSignatureError.mustache renamed to generators/java/okhttp-gson/templates/OnfidoInvalidSignatureError.mustache

@@ -0,0 +1,7 @@
+# Onfido OpenAPI YAML specification
+
+The official OpenAPI YAML specification of Onfido API.
+
+Documentation can be found at <{{ documentationUrl }}>.
+
+This version is based on Onfido API {{ apiVersion }}.

generators/java/templates/README.mustache renamed to generators/java/okhttp-gson/templates/README.mustache

@@ -0,0 +1,3 @@
+files:
+  README.mustache:
+    destinationFilename: README.md

generators/java/templates/SHA256SUM renamed to generators/java/okhttp-gson/templates/SHA256SUM

@@ -0,0 +1,7 @@
+# Onfido OpenAPI JSON specification
+
+The official OpenAPI JSON specification of Onfido API.
+
+Documentation can be found at <{{ documentationUrl }}>.
+
+This version is based on Onfido API {{ apiVersion }}.

generators/java/templates/WebhookEventVerifier.mustache renamed to generators/java/okhttp-gson/templates/WebhookEventVerifier.mustache

@@ -1,3 +1,6 @@
 /test/
 /docs/
-/git_push.sh
+/vendor/
+/composer.lock
+/git_push.sh
+/.travis.yml

generators/java/templates/libraries/okhttp-gson/ApiClient.mustache renamed to generators/java/okhttp-gson/templates/libraries/okhttp-gson/ApiClient.mustache

@@ -0,0 +1,128 @@
+# Onfido PHP Library
+
+The official PHP library for integrating with the Onfido API.
+
+Documentation can be found at <{{ documentationUrl }}>.
+
+This version uses Onfido API {{ apiVersion }}. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
+
+## Installation & Usage
+
+### Requirements
+
+PHP 7.4 and later.
+Should also work with PHP 8.0.
+
+### Installation
+
+#### Composer
+
+To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:
+
+```json
+{
+  "repositories": [
+    {
+      "type": "vcs",
+      "url": "https://{{gitHost}}/{{gitUserId}}/{{gitRepoId}}.git"
+    }
+  ],
+  "require": {
+    "{{gitUserId}}/{{gitRepoId}}": "*@dev"
+  }
+}
+```
+
+Then run `composer install`
+
+#### Manual Installation
+
+Download the files and include `autoload.php`:
+
+```php
+<?php
+require_once('/path/to/{{packageName}}/vendor/autoload.php');
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$configuration = {{invokerPackage}}\Configuration::getDefaultConfiguration();
+$configuration->setApiToken($_ENV['ONFIDO_API_TOKEN']);
+$configuration->setRegion({{invokerPackage}}\Region::EU);   // Supports `EU`, `US` and `CA`
+
+$onfidoApi = new {{invokerPackage}}\Api\DefaultApi(
+              new \GuzzleHttp\Client([
+                  'timeout'  => 30,
+                  'connect_timeout' => 30,
+                  'read_timeout' => 30
+              ]), $configuration);
+
+```
+
+### Making a call to the API
+
+```php
+try {
+  $applicant = $onfidoApi->createApplicant(
+      new {{invokerPackage}}\Model\ApplicantBuilder(
+          [
+              'first_name' => 'First',
+              'last_name' => 'Last'
+          ])
+  );
+
+  // To access the information use the getter for the desired property on the object, for example:
+  $applicant->getFirstName();
+
+  // ...
+
+} catch ({{invokerPackage}}\ApiException $ex) {
+  // Handle API exception
+  echo 'Caught exception: ',  $ex->getMessage(), "\n";
+}
+```
+
+### Webhook event verification
+
+Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:
+
+```php
+try {
+  $verifier = new Onfido\WebhookEventVerifier('_ABC123abc...3ABC123_');
+
+  $signature = 'a0...760e';
+
+  $event = $verifier->readPayload('{"payload":{"r...3"}}', $signature);
+} catch ({{invokerPackage}}\OnfidoInvalidSignatureError $ex) {
+  // Invalid webhook signature
+}
+```
+
+## Contributing
+
+This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) - version: {{generatorVersion}};
+therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
+
+For contributions to the tests instead, please follow the steps below:
+
+1. [Fork](<https://github.com/{{ gitUserId }}/{{ gitRepoId }}/fork>) repository
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## More documentation
+
+More documentation and code examples can be found at <{{ documentationUrl }}>.
+
+## Support
+
+Should you encounter any technical issues during integration, please contact Onfido's Customer Support team
+via the [{{ supportDescription }}]({{ supportUrl }}) which also include support documentation.

generators/java/templates/libraries/okhttp-gson/oneof_model.mustache renamed to generators/java/okhttp-gson/templates/libraries/okhttp-gson/oneof_model.mustache

@@ -1,4 +1,5 @@
 
 bb92a3f3107664c296ebc45c75bff7c88abf8b765565f4656a05e24234cb6d67  ./Configuration.mustache
+8eebaed003795c011df87fecd1f89c630dd3f23282d80e7f407f62009e2cd0ee  ./README.mustache
 2d94750ad5d913f8b7fbba24681c7cc1d75e96c89ec46c379e6625c825b39020  ./model_generic.mustache
 37d3333c7c3dbc6f6bffe64ce076bc512a2a1e61e986738c8e023bb745168e9a  ./phpunit.xml.mustache