PLAT-10739: Release 2.0b1 (#165)

* PLAT-10433: Sphinx documentation (#130)

* PLAT-10483 - HealthService implementation (#132)

- HealthService implementation and tests 
- Renamed test classes from `test_name_of_class.py` to `name_of_class_test.py`

* PLAT-10532: ApplicationService implementation (#133)

* ApplicationService implementation

* Update documentation

* PLAT-10530: Presence service implementation (#134)

- Presence service implementation and tests
- Put the presence service test payloads in one JSON file
- Added type-hint to the ServiceFactory.get_health_service function

* PLAT-10530 Fixed documentation issues in links regarding the presence service (#135)

This fix was added to correctly show links to the endpoint documentation when sphinx documentation is generated.

* PLAT-10531 Signal service implementation (#138)

* PLAT-10529 Ability to set private key and certificate content programmatically (#137)

Private key and Certificate were able to only be loaded from the config file when initializing bdk. In this PR, we update bot config to be able to set private key and certificate after bdk being initialized.

* PLAT-10489: Implemented automatic pagination (#139)

* PLAT-10643: Load certs from system store

In #122 we enable loading a custom cert store for the HTTP client. This
broked using pods with valid certs because the system certs are no
longer loaded. This change loads them even all the time (and we might
add custom ones on top of that).

Also sync the rest.mustache template used for code generation.

* PLAT-10643: Unit test system certs loading

* Added forgotten default value in list_all_stream_members (#144)

* PLAT-10533: Added User-Agent header in requests (#141)

* PLAT-10600 enforce pylint checks in PR builder (#146)

Goal of this PR is to enable pylint checks in the PR builder.
For now the limit to fail is set to 9.50 (max being 10.00). We can start like this and if needed we can adapt it later on, if we think that is too strict.

All changes about fixture are related to this issue: https://stackoverflow.com/questions/46089480/pytest-fixtures-redefining-name-from-outer-scope-pylint

* PLAT-10534: Added X-Trace-Id header to each HTTP call (#147)

* PLAT-10534: Added X-Trace-Id header to each HTTP call

* Replaced single quotes with double quotes

* Fixed python version in GH workflow

* Updated caching logic in workflows (#148)

* Changed caching logic of poetry deps to be specific to the actual python version.

* Updated build, push and pylint to cache pip dependencies as well

* PLAT-10651: Updated generated code following role type update to string (#149)

* Updated generated code using openApiGen 5.0.1 and updated role format to str

* Updated unit tests and examples

* PLAT-10565 Adding utils classes (#150)

Adding some util classes on message processing to:

Extract entities from a given incoming message (mentions, hashtags, cashtags, emojis)
Extract message content from presentationML
Pre-process an outgoing message by "cleaning" the text message, escaping all special characters that will violate messageML format
Convert a stream id into a url safe id and viceversa

* PLAT-10535: Extension App RSA authentication (#153)

* PLAT-10535: First implementation of RSA ext app authentication

* Added and improved docstrings

* Fixed some pylint errors

* Updated poetry deps

* #143 Activity API (#151)

* #143 Activity API (draft version)

* #143 Added unit tests

* #143 Added markdown doc

* #143 Documented AbstractActivity class

* PLAT-10709: Switch from python-jose to PyJWT (#159)

Switch from using python-jose to using PyJWT

* PLAT-10588: Implemented concurrent DF loop (#158)

* PLAT-10588: Implemented concurrency of event handling in DF loop

* Refactored datafeed loops

* Updated poetry deps

* PLAT-10563: FormReply activity (#161)

- Base classes for a FormReply Activity.
- Modification of the command activity to parse attributes in the constructor instead 
- Fixed related tests

* PLAT-10538: Minor improvements on extension app authenticator (#163)

* PLAT-10538: added allowed audience = app-id when validating jwt

* Improved error handling in ExtensionAppAuthenticatorRsa.validate_jwt

* Updated dependencies

* Bumped version to 2.0b1

* PR builder should build 2.0-rc branch

Co-authored-by: symphony-youness <76746033+symphony-youness@users.noreply.github.com>
Co-authored-by: symphony-hong <65538951+symphony-hong@users.noreply.github.com>
Co-authored-by: Mariacristina De Dominicis <65179248+symphony-mariacristina@users.noreply.github.com>
Co-authored-by: Soufiane Aourinmouche <52406574+symphony-soufiane@users.noreply.github.com>
Co-authored-by: Youri Bonnaffe <youri.bonnaffe@symphony.com>
Co-authored-by: Youri Bonnaffé <63661676+symphony-youri@users.noreply.github.com>
Co-authored-by: Thibault Pensec <39826516+symphony-thibault@users.noreply.github.com>

Author: 7 people

.github/workflows/build.yml

@@ -2,9 +2,9 @@ name: build
 
 on:
   push:
-    branches: [ "2.0" ]
+    branches: [ "2.0", "2.0-rc" ]
   pull_request:
-    branches: [ "2.0" ]
+    branches: [ "2.0", "2.0-rc" ]
 
 jobs:
   build:
@@ -24,29 +24,39 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Set up Python 3.8
+        id: setup-python
         uses: actions/setup-python@v2
         with:
           python-version: 3.8
 
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
+
       - name: Install Poetry
         run: pip install poetry
 
       - name: Cache poetry
         uses: actions/cache@v2
         with:
           path: ${{ matrix.path }}
-          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+          key: ${{ runner.os }}-poetry-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
           restore-keys: |
-            ${{ runner.os }}-poetry-
+            ${{ runner.os }}-poetry-${{ steps.setup-python.outputs.python-version }}-
 
       - name: Install dependencies
         run: poetry install
 
       - name: Run tests with coverage
         run: poetry run pytest
-
-      - name: Run pylint
-        run: poetry run pylint symphony tests
+        timeout-minutes: 10
 
       - name: Upload test results
         uses: actions/upload-artifact@v2
@@ -60,4 +70,4 @@ jobs:
         with:
           name: pytest-coverage-${{ matrix.os }}
           path: htmlcov
-        if: ${{ always() }}
+        if: ${{ always() }}

.github/workflows/push.yml

@@ -0,0 +1,79 @@
+name: On 2.0 push
+
+on:
+  push:
+    branches: [ "2.0" ]
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Run Snyk to check for vulnerabilities
+        uses: snyk/actions/python@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+        with:
+          args: --severity-threshold=high
+          command: monitor
+
+  documentation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.8
+        id: setup-python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Copy 2.0 branch into gh-pages
+        run: |
+          git checkout gh-pages
+          git reset --hard 2.0
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
+
+      - name: Install Poetry
+        run: pip install poetry
+
+      - name: Cache poetry
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pypoetry/virtualenvs
+          key: ${{ runner.os }}-poetry-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-poetry-${{ steps.setup-python.outputs.python-version }}-
+
+      - name: Install Poetry deps
+        run: poetry install
+
+      - name: Generate Sphinx documentation
+        working-directory: ./docsrc
+        run: |
+          . `poetry env info --path`/bin/activate
+          make html
+
+      - name: Copy Sphinx documentation into docs/
+        working-directory: ./docsrc/_build/html
+        run: mv * $GITHUB_WORKSPACE/docs/
+
+      - name: Commit changes
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          git add docs/
+          git commit -m "Generated commit for Sphinx documentation"
+          git push -f origin gh-pages

.github/workflows/pylint.yaml

@@ -0,0 +1,56 @@
+name: pylint
+
+on:
+  push:
+    branches: [ "2.0" ]
+  pull_request:
+    branches: [ "2.0" ]
+
+jobs:
+  build:
+    name: pylint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.8
+        id: setup-python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
+
+      - name: Install Pylint
+        run: pip install pylint
+
+      - name: Download previous run results
+        uses: dawidd6/action-download-artifact@v2.12.0
+        continue-on-error: true
+        with:
+          workflow: pylint.yaml
+          workflow_conclusion: success
+          name: .pylint.d
+          path: /home/runner/.pylint.d
+          branch: "2.0"
+
+      - name: Run Pylint
+        run: pylint symphony tests
+
+      - name: Upload Pylint results
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: .pylint.d
+          path: ~/.pylint.d

.github/workflows/release.yml

@@ -26,6 +26,7 @@ jobs:
 
       - name: Run tests with coverage
         run: poetry run pytest
+        timeout-minutes: 10
 
       - name: publish
         env:

.github/workflows/snyk.yml

@@ -64,7 +64,8 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docsrc/_build/
+docsrc/_autosummary/
 
 # PyBuilder
 target/

.gitignore

@@ -6,7 +6,7 @@
 extension-pkg-whitelist=
 
 # Specify a score threshold to be exceeded before program exits with error.
-fail-under=0.00
+fail-under=9.50
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
@@ -34,7 +34,7 @@ limit-inference-results=100
 load-plugins=
 
 # Pickle collected data for later comparisons.
-persistent=no
+persistent=yes
 
 # When enabled, pylint would attempt to guess common misconfiguration and emit
 # user-friendly hints instead of false-positive error messages.
@@ -61,6 +61,7 @@ confidence=
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
 disable=print-statement,
+        import-error,
         parameter-unpacking,
         unpacking-in-except,
         old-raise-syntax,
@@ -397,14 +398,14 @@ class-naming-style=PascalCase
 
 # Regular expression matching correct class names. Overrides class-naming-
 # style.
-#class-rgx=
+class-rgx=[A-Z_][a-zA-Z0-9_]+$
 
 # Naming style matching correct constant names.
 const-naming-style=UPPER_CASE
 
 # Regular expression matching correct constant names. Overrides const-naming-
 # style.
-#const-rgx=
+const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
 
 # Minimum line length for functions/classes that require docstrings, shorter
 # ones are exempt.
@@ -437,7 +438,7 @@ inlinevar-naming-style=any
 
 # Regular expression matching correct inline iteration names. Overrides
 # inlinevar-naming-style.
-#inlinevar-rgx=
+inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
 
 # Naming style matching correct method names.
 method-naming-style=snake_case
@@ -459,7 +460,7 @@ name-group=
 
 # Regular expression which should only match function or class names that do
 # not require a docstring.
-no-docstring-rgx=^_
+no-docstring-rgx= ^_|test|assert|fixture
 
 # List of decorators that produce properties, such as abc.abstractproperty. Add
 # to this list to register other decorators that produce valid properties.
@@ -478,7 +479,9 @@ variable-naming-style=snake_case
 
 # This flag controls whether inconsistent-quotes generates a warning when the
 # character used as a quote delimiter is used inconsistently within a module.
-check-quote-consistency=no
+check-quote-consistency=yes
+string-quote=double
+docstring-quote=double
 
 # This flag controls whether the implicit-str-concat should generate a warning
 # on implicit string concatenation in sequences defined over several lines.

.pylintrc

@@ -1,4 +1,4 @@
-Copyright (c) 2018 The Python Packaging Authority
+Copyright (c) 2021 Symphony Communication Services, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,13 +1,35 @@
-# symphony-api-client-python
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9-blue)](https://www.python.org/downloads/release/python-3)
+[![Pypi](https://img.shields.io/badge/pypi-2.0b0-green)](https://pypi.org/project/sym-api-client-python/2.0b0/)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/SymphonyPlatformSolutions/symphony-api-client-python/build/2.0)
 
-This is the Symphony BDK for Python to help developing bots and interact with the [Symphony REST APIs](https://developers.symphony.com/restapi/reference).
+# Symphony BDK for Python
+
+This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://developers.symphony.com/restapi/reference).
 
 Legacy Python BDK is located in [legacy](./legacy) folder.
 
-## How to build
+## Installation and getting started
+The [reference documentation](https://symphonyplatformsolutions.github.io/symphony-api-client-python/) includes detailed
+installation instructions as well as a comprehensive
+[getting started](https://symphonyplatformsolutions.github.io/symphony-api-client-python/markdown/getting_started.html)
+guide.
+
+## Build from source
+
+The Symphony BDK uses and requires Python 3.8 or higher. Be sure you have it installed before going further.
 
 We use [poetry](https://python-poetry.org/) in order to manage dependencies, build, run tests and publish.
 To install poetry, follow instructions [here](https://python-poetry.org/docs/#installation).
 
 On the first time, run `poetry install`. Then run `poetry build` to build the sdist and wheel packages.
 To run the tests, use `poetry run pytest`.
+
+It is possible to run pylint scan locally (on a specific file or package) executing the following command:
+`poetry run pylint <module_name>`.
+
+To generate locally the Sphinx documentation, run: `cd docsrc && make html`.
+
+## Contributing
+
+If you want to contribute, please check the [contributing guidelines](CONTRIBUTING.md).