Change log (#659)

* Add decryption mechanism.
On purpose we separate it from the anonymizer/

* Fix tests

* Remove unneeded params
fix docs and tests

* Add decryption engine to match the anonymizer engine.
Refactor code so the text builder and text manipulator will be mutual.

* Change engine result to be unified with different items inheriting from result item.

* Fix decrypt elements and implmentations

* Add hints

* Fix naming

* Change manipulators to operators.

* Change manipulators to operators.

* Move initialization of text manipulator
Change the analyzer results json to receive the list and not the entire content.
Fix tests

* Move getting operators classes into the operator factory.

* Fix entities.
Make sure all engines can use the same entities by using factories, builders and inheritance more.

* revert unneeded change

* Code cleanup

* Add tests and clean up code.

* Move anonymizer configuration to inherit from operator metadata and add decryptor config

* More cleanup

* More cleanup

* revert

* cleanup

* Fix imports and renaming

* Start working on linting.

* Start working on linting.

* add tests

* add tests

* add tests

* add tests

* remove unneeded formating.

* fix linting

* try to understand why it fails in pipe

* try to understand why it fails in pipe

* Fix equal check for recognizer result

* revert change for test investigation

* fix imports and add test

* fix dictionary

* add test for dictionary fix

* Fix example

* Fix E2E entities

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments - use comprehensions

* Fix PR comments - Change names and move classes accordingly.

* fix linting

* fix linting

* use dictionary comprehensions

* Fix documentation and nameing.

* Fix documentation and nameing.

* remove unused code.

* PR comments

* fix linting

* PR review -> be background compatible.

* fix linting

* fix linting due to merge

* Fix PR comments

* linting

* remove my name from code.

* Add engine test for encrypt decrypt in integration tests
Add helper method to change anonymized entity into encrypt result.

* add docs

* fix import

* Remove unneeded field

* Replace decrypt with deanonymize.

* Replace decrypt with deanonymize.

* revert

* Change to anonymizer_results

* Remove entities and merge them together.

* Remove entities and merge them together + renaming

* Remove entities and merge them together + renaming

* fix linting

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix tests

* fix tests

* fix tests

* rename

* fix docs

* Change docs to the new deanonymization functionality.

* Change docs to the new deanonymization functionality.

* Fix PR comments

* Fix linting

* Fix linting

* fux PR comments

* fux PR comments

* fix PR comments

* fix PR comments

* add tests

* add tests

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* bump version for breaking changes

* fix API doc

* Update docs/anonymizer/adding_operators.md

Co-authored-by: Omri Mendels <[email protected]>

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <[email protected]>

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <[email protected]>

* Update docs/api-docs/api-docs.yml

Co-authored-by: Omri Mendels <[email protected]>

* PR comments

* Add documentation

* Fix merge issue

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <[email protected]>

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <[email protected]>

* fix PR comments

* Update presidio-anonymizer/README.MD

Co-authored-by: Omri Mendels <[email protected]>

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* Add change log

* Add change log

* Add change log

* PR comments

* PR comments

* Add note for V2 changlog

Co-authored-by: Omri Mendels <[email protected]>

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+### Changed
+
+### Removed
+
+### Deprecated
+
+## [2.2.0] - 12.04.2021
+### Changed
+#### Analyzer:
+Upgrade Analyzer spacy version to 3.0.5
+
+#### Anonymizer Engine:
+1. Request entity AnonymizerConfig renamed OperatorConfig
+    - In OperatorConfig: anonymizer_name -> operator_name
+2. Response entity AnonymizerResult renamed to EngineResult
+    - In EngineResult: List[AnonymizedEntity] -> List[OperatorResult]
+    - In OperatorResult: 
+        - anonymizer -> operator
+        - anonymized_text -> text
+
+#### Anonymize API:
+1. Response entity anonymizer renamed to operator.
+2. Response entity anonymizer_text renamed to text.
+
+#### Deanonymize:
+New endpoint for deanonymizing encrypted entities by the anonymizer.
+
+[unreleased]: https://github.com/microsoft/presidio/compare/2.2.0...HEAD
+[2.2.0]: https://github.com/microsoft/presidio/compare/2.1.0...2.2.0

CONTRIBUTING.md

@@ -12,6 +12,15 @@ Presidio is a community project aimed at helping everyone handle their private d
 Presidio is both a framework and a system. It's a framework in a sense that you could take code parts from it, extend, customize and plug somewhere. It's also a system you could take as a whole or in parts and deploy locally, on-prem on in the cloud.
 When contributing to presidio, it's important to keep this in mind, as some "framework" contributions might not be suitable for a deployment, or vice-versa.
 
+### PR guidelines
+Commit message should be clear, explaining the committed changes.
+
+Update CHANGELOG.md:
+
+Under Unreleased section, use the category which is most suitable for your change (changed/removed/deprecated). 
+Document the change with simple readable text and push it as part of the commit.
+Next release, the change will be documented under the new version.
+
 ### Build and Release process
 
 The project currently supports [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) using YAML pipelines which can be easily imported to any Azure Pipelines instance.

docs/presidio_V2.md

@@ -185,3 +185,6 @@ Below is a detailed outline of all the changes done to the Analyzer and Anonymiz
 | Mask               | <pre>string maskingCharacter = 1;<br>int32 charsToMask = 2; <br>bool fromEnd = 3;</pre> | <pre>{<br> "chars_to_mask": 10,<br> "from_end": true,<br> "masking_char": "\*" <br>}</pre> |
 | Hash               | NONE                                                                                    | <pre>{"hash_type": "VALUE"}</pre>                                                          |
 | FPE (now Encrypt)  | <pre>string key = 3t6w9z$C&F)J@NcR;<br>int32 tweak = D8E7920AFA330A73</pre>             | <pre>{"key": "3t6w9z$C&F)J@NcR"}</pre>                                                          |
+
+!!! note "Note"
+	The V2 API keeps changing please [follow the change log](https://github.com/microsoft/presidio/blob/main/CHANGELOG.md) for updates.