openimis-be-contract 1.0.0__tar.gz

openimis_be_contract-1.0.0/LICENSE.md

@@ -0,0 +1,12 @@
+
+
+The program users must agree to the following terms:
+
+License notices This program is free software: you can redistribute it and/or modify it under the terms of the GNU AGPL v3 License as published by the Free Software Foundation, version 3 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU AGPL v3 License for more details www.gnu.org.
+
+Disclaimer of Warranty There is no warranty for the program, to the extent permitted by applicable law; except when otherwise stated in writing the copyright holders and/or other parties provide the program "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the program is with you. Should the program prove defective, you assume the cost of all necessary servicing, repair or correction.
+
+Limitation of Liability In no event unless required by applicable law or agreed to in writing will any copyright holder, or any other party who modifies and/or conveys the program as permitted above, be liable to you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the program to operate with any other programs), even if such holder or other party has been advised of the possibility of such damages.
+
+In case of dispute arising out or in relation to the use of the program, it is subject to the public law of Switzerland. The place of jurisdiction is Berne.
+

openimis_be_contract-1.0.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.1
+Name: openimis-be-contract
+Version: 1.0.0
+Summary: The openIMIS Backend Contract reference module.
+Home-page: https://openimis.org/
+Author: Damian Borowiecki
+Author-email: dborowiecki@soldevelo.com
+License: GNU AGPL v3
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 2.1
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: django
+Requires-Dist: django-db-signals
+Requires-Dist: djangorestframework
+Requires-Dist: openimis-be-core
+Requires-Dist: openimis-be-policyholder
+Requires-Dist: openimis-be-contribution_plan
+Requires-Dist: openimis-be-payment
+Requires-Dist: openimis-be-contribution
+Requires-Dist: openimis-be-insuree
+Requires-Dist: openimis-be-policy
+Requires-Dist: openimis-be-calculation
+
+# openIMIS Backend Contract reference module
+This repository holds the files of the openIMIS Backend Contract reference module.
+It is dedicated to be deployed as a module of [openimis-be_py](https://github.com/openimis/openimis-be_py).
+
+## ORM mapping:
+* tblContract > Contract
+* tblContractDetails > ContractDetails
+* tblContractContributionPlanDetails > ContractContributionPlanDetails
+
+## Listened Django Signals
+- post_save - Payment: handles service activate_contracted_policies - only when payment
+is related to the contract/contracts. (it is verified by this post save)
+Another payments are omitted in processing.
+
+## GraphQl Queries
+* contract
+* contractDetails
+* contractContributionPlanDetails
+
+## GraphQL Mutations - each mutation emits default signals and return standard error lists (cfr. openimis-be-core_py)
+* createContract
+* updateContract
+* deleteContract
+* submitContract
+* approveContract
+* approveBulkContract (works with Celery)
+* counterContract
+* amendContract
+* renewContract
+* createContractDetails
+* updateContractDetails
+* deleteContractDetails
+* createContractDetailsByPhInsuree
+
+## Additional mutation log helper in Create graphQl mutations - ObjectMutation from core
+- "ObjectMutation" from openimis-be-core_py - models.py
+- "object_mutated" method allows the creation of an object to update the xxxMutation easily.
+- dedicated for createContract and createContractDetails graphQl mutations
+- more info about it and how it was implemented here in Contract module in models.py in class ObjectMutation in docs string
+
+## Services
+- Contract
+  - create
+  - update
+  - submit
+  - approve
+  - amend
+  - renew
+  - delete
+  - get_negative_amount_amendment
+  - terminate_contract
+- ContractDetails
+  - get_details_from_ph_insuree
+  - ph_insuree_to_contract_details
+- ContractContributionPlanDetails - CRUD services, replace
+  - create_ccpd (ccpd - acronym of contract contribution plan details)
+  - contract_valuation
+  - create_contribution
+- PaymentService
+  - create (with creating payment details for that newly created payment)
+  - collect_payment_details (collect data from all contributions to assign it to the payment details)
+
+## Configuration options (can be changed via core.ModuleConfiguration)
+* gql_query_contract_perms: required rights to call createContract GraphQL Query (default: ["152101"])
+* gql_query_contract_admins_perms: required rights to call contribution_plan_bundle_admin GraphQL Query (default: [])
+
+* gql_mutation_create_contract_perms: required rights to call createContract, createContractDetails GraphQL Mutations (default: ["152102"])
+* gql_mutation_update_contract_perms: required rights to call updateContract, updateContractDetails GraphQL Mutations (default: ["152103"])
+* gql_mutation_delete_contract_perms: required rights to call deleteContract, deleteContractDetails GraphQL Mutations (default: ["152104"])
+* gql_mutation_renew_contract_perms: required rights to call renewContract GraphQL Mutation (default: ["152106"])
+* gql_mutation_submit_contract_perms: required rights to call submitContract GraphQL Mutation (default: ["152107"])
+* gql_mutation_approve_ask_for_change_contract_perms: required rights to call approveContract, approveBulkContract and counterContract GraphQL Mutations (default: ["152108"])
+* gql_mutation_amend_contract_perms: required rights to call amendContract GraphQL Mutation (default: ["152109"])
+
+## openIMIS Modules Dependencies
+- core.models.HistoryModel
+- core.models.HistoryBusinessModel
+- core.models.ObjectMutation
+- policyholder.models.PolicyHolder
+- policyholder.models.PolicyHolderInsuree
+- contribution_plan.models.ContributionPlan
+- contribution_plan.models.ContributionPlanBundleDetails
+- insuree.models.Insuree
+- insuree.models.InsureePolicy
+- contribution.models.Premium
+- payment.models.Payment
+- payment.models.PaymentDetail
+- policy.models.Policy
+- calculation module
+
+
+## bulk operations - required configuration
+- for 'bulk approve contract' and 'bulk counter contract' graphQL mutations
+- running rabbitmq docker image
+- running celery within "{imis_directory}/openimis-be_py/venv/bin/celery":
+`-A openIMIS worker --loglevel=DEBUG --without-gossip --without-mingle --without-heartbeat -Ofair`
+- without this required steps you won't be able to bulk counter/approve contract

openimis_be_contract-1.0.0/README.md

@@ -0,0 +1,97 @@
+# openIMIS Backend Contract reference module
+This repository holds the files of the openIMIS Backend Contract reference module.
+It is dedicated to be deployed as a module of [openimis-be_py](https://github.com/openimis/openimis-be_py).
+
+## ORM mapping:
+* tblContract > Contract
+* tblContractDetails > ContractDetails
+* tblContractContributionPlanDetails > ContractContributionPlanDetails
+
+## Listened Django Signals
+- post_save - Payment: handles service activate_contracted_policies - only when payment
+is related to the contract/contracts. (it is verified by this post save)
+Another payments are omitted in processing.
+
+## GraphQl Queries
+* contract
+* contractDetails
+* contractContributionPlanDetails
+
+## GraphQL Mutations - each mutation emits default signals and return standard error lists (cfr. openimis-be-core_py)
+* createContract
+* updateContract
+* deleteContract
+* submitContract
+* approveContract
+* approveBulkContract (works with Celery)
+* counterContract
+* amendContract
+* renewContract
+* createContractDetails
+* updateContractDetails
+* deleteContractDetails
+* createContractDetailsByPhInsuree
+
+## Additional mutation log helper in Create graphQl mutations - ObjectMutation from core
+- "ObjectMutation" from openimis-be-core_py - models.py
+- "object_mutated" method allows the creation of an object to update the xxxMutation easily.
+- dedicated for createContract and createContractDetails graphQl mutations
+- more info about it and how it was implemented here in Contract module in models.py in class ObjectMutation in docs string
+
+## Services
+- Contract
+  - create
+  - update
+  - submit
+  - approve
+  - amend
+  - renew
+  - delete
+  - get_negative_amount_amendment
+  - terminate_contract
+- ContractDetails
+  - get_details_from_ph_insuree
+  - ph_insuree_to_contract_details
+- ContractContributionPlanDetails - CRUD services, replace
+  - create_ccpd (ccpd - acronym of contract contribution plan details)
+  - contract_valuation
+  - create_contribution
+- PaymentService
+  - create (with creating payment details for that newly created payment)
+  - collect_payment_details (collect data from all contributions to assign it to the payment details)
+
+## Configuration options (can be changed via core.ModuleConfiguration)
+* gql_query_contract_perms: required rights to call createContract GraphQL Query (default: ["152101"])
+* gql_query_contract_admins_perms: required rights to call contribution_plan_bundle_admin GraphQL Query (default: [])
+
+* gql_mutation_create_contract_perms: required rights to call createContract, createContractDetails GraphQL Mutations (default: ["152102"])
+* gql_mutation_update_contract_perms: required rights to call updateContract, updateContractDetails GraphQL Mutations (default: ["152103"])
+* gql_mutation_delete_contract_perms: required rights to call deleteContract, deleteContractDetails GraphQL Mutations (default: ["152104"])
+* gql_mutation_renew_contract_perms: required rights to call renewContract GraphQL Mutation (default: ["152106"])
+* gql_mutation_submit_contract_perms: required rights to call submitContract GraphQL Mutation (default: ["152107"])
+* gql_mutation_approve_ask_for_change_contract_perms: required rights to call approveContract, approveBulkContract and counterContract GraphQL Mutations (default: ["152108"])
+* gql_mutation_amend_contract_perms: required rights to call amendContract GraphQL Mutation (default: ["152109"])
+
+## openIMIS Modules Dependencies
+- core.models.HistoryModel
+- core.models.HistoryBusinessModel
+- core.models.ObjectMutation
+- policyholder.models.PolicyHolder
+- policyholder.models.PolicyHolderInsuree
+- contribution_plan.models.ContributionPlan
+- contribution_plan.models.ContributionPlanBundleDetails
+- insuree.models.Insuree
+- insuree.models.InsureePolicy
+- contribution.models.Premium
+- payment.models.Payment
+- payment.models.PaymentDetail
+- policy.models.Policy
+- calculation module
+
+
+## bulk operations - required configuration
+- for 'bulk approve contract' and 'bulk counter contract' graphQL mutations
+- running rabbitmq docker image
+- running celery within "{imis_directory}/openimis-be_py/venv/bin/celery":
+`-A openIMIS worker --loglevel=DEBUG --without-gossip --without-mingle --without-heartbeat -Ofair`
+- without this required steps you won't be able to bulk counter/approve contract

openimis_be_contract-1.0.0/contract/__init__.py

@@ -0,0 +1 @@
+default_app_config = "contract.apps.ContractConfig"

openimis_be_contract-1.0.0/contract/admin.py

@@ -0,0 +1,2 @@
+# from django.contrib import admin
+# Register your models here.

openimis_be_contract-1.0.0/contract/apps.py

@@ -0,0 +1,63 @@
+from django.apps import AppConfig
+
+MODULE_NAME = "contract"
+
+
+DEFAULT_CFG = {
+    "gql_query_contract_perms": ["152101"],
+    "gql_query_contract_admins_perms": [],
+    "gql_mutation_create_contract_perms": ["152102"],
+    "gql_mutation_update_contract_perms": ["152103"],
+    "gql_mutation_delete_contract_perms": ["152104"],
+    "gql_mutation_renew_contract_perms": ["152106"],
+    "gql_mutation_submit_contract_perms": ["152107"],
+    "gql_mutation_approve_ask_for_change_contract_perms": ["152108"],
+    "gql_mutation_amend_contract_perms": ["152109"],
+    "gql_query_payment_perms": ["101401"],
+    "gql_mutation_create_payments_perms": ["101402"],
+    "gql_mutation_update_payments_perms": ["101403"],
+    "gql_mutation_delete_payments_perms": ["101404"],
+    "gql_mutation_approve_payments_perms": ["101408"],
+    # OFS-259: Support the policyholder portal perms on Contract
+    "gql_query_contract_policyholder_portal_perms": ["154201"],
+    "gql_mutation_create_contract_policyholder_portal_perms": ["154202"],
+    "gql_mutation_update_contract_policyholder_portal_perms": ["154203"],
+    "gql_mutation_submit_contract_policyholder_portal_perms": ["154207"],
+    "gql_mutation_amend_contract_policyholder_portal_perms": ["154209"],
+    "gql_invoice_create_perms": ["155102"],
+}
+
+
+class ContractConfig(AppConfig):
+    name = MODULE_NAME
+    gql_query_contract_perms = []
+    gql_query_contract_admins_perms = []
+    gql_mutation_create_contract_perms = []
+    gql_mutation_update_contract_perms = []
+    gql_mutation_delete_contract_perms = []
+    gql_mutation_renew_contract_perms = []
+    gql_mutation_submit_contract_perms = []
+    gql_mutation_approve_ask_for_change_contract_perms = []
+    gql_mutation_amend_contract_perms = []
+    gql_mutation_create_payments_perms = []
+    gql_mutation_update_payments_perms = []
+    gql_mutation_delete_payments_perms = []
+    gql_mutation_approve_payments_perms = []
+    # OFS-259: Support the policyholder portal perms on Contract
+    gql_query_contract_policyholder_portal_perms = []
+    gql_mutation_create_contract_policyholder_portal_perms = []
+    gql_mutation_update_contract_policyholder_portal_perms = []
+    gql_mutation_submit_contract_policyholder_portal_perms = []
+    gql_mutation_amend_contract_policyholder_portal_perms = []
+    gql_invoice_create_perms = []
+
+    def __load_config(self, cfg):
+        for field in cfg:
+            if hasattr(ContractConfig, field):
+                setattr(ContractConfig, field, cfg[field])
+
+    def ready(self):
+        from core.models import ModuleConfiguration
+
+        cfg = ModuleConfiguration.get_or_default(MODULE_NAME, DEFAULT_CFG)
+        self.__load_config(cfg)

openimis_be_contract-1.0.0/contract/config.py

@@ -0,0 +1,69 @@
+CONTRACT_STATE = {
+    "ContractState": [
+        {
+            "value": "1",
+            "label": {"fr": "Demande d'information", "en": "Request for information"},
+        },
+        {"value": "2", "label": {"fr": "Brouillon", "en": "Draft"}},
+        {"value": "3", "label": {"fr": "Offre", "en": "offer"}},
+        {"value": "4", "label": {"fr": "En negociation", "en": "Negotiable"}},
+        {"value": "5", "label": {"fr": "Apprové", "en": "executable"}},
+        {"value": "6", "label": {"fr": "addendum", "en": "addendum"}},
+        {"value": "7", "label": {"fr": "En cours", "en": "effective"}},
+        {"value": "8", "label": {"fr": "Appliqué", "en": "executed"}},
+        {"value": "9", "label": {"fr": "Suspendu", "en": "Disputed"}},
+        {"value": "10", "label": {"fr": "Terminé", "en": "terminated"}},
+        {"value": "11", "label": {"fr": "révision demandé", "en": "counter"}},
+    ]
+}
+
+
+def get_message_approved_contract(
+    code, name, contact_name, due_amount, payment_reference, language="en"
+):
+    message_payment_notification = {
+        "payment_notification": {
+            "en": f"""
+                 Dear {contact_name}
+
+                 The contract {code} - {name} was approved.
+                 Please proceed to the payment of {due_amount} with the reference {payment_reference}.
+
+                 Best regards,
+                 """,
+            "fr": f"""
+                 Monsieur, Madame {contact_name}
+
+                 le contract {code} - {name} à été apprové.
+                 Veuillez faire un paiement de < CONTRACT - DUEAMOUNT > avec la référence {payment_reference}.
+
+                 Meilleurs Salutations
+                 """,
+        }
+    }
+    return message_payment_notification["payment_notification"][language]
+
+
+def get_message_counter_contract(code, name, contact_name, language="en"):
+    message_payment_notification = {
+        "payment_notification": {
+            "en": f"""
+                 Dear {contact_name}
+
+                 The contract {code} - {name} was counter.
+                 Please proceed recheck the information and correct the issues,
+                 in case of questions please check contact us.
+
+                 Best regards,
+                 """,
+            "fr": f"""
+                 Monsieur, Madame {contact_name}
+
+                 le contract {code} - {name} à été contré.
+                 Veuillez verifier les information saisie, en cas de question veuillez nous contacter.
+
+                 Meilleurs Salutations
+                 """,
+        }
+    }
+    return message_payment_notification["payment_notification"][language]

openimis_be_contract-1.0.0/contract/exceptions.py

@@ -0,0 +1,2 @@
+class CeleryWorkerError(Exception):
+    pass

openimis_be_contract-1.0.0/contract/gql/__init__.py

@@ -0,0 +1 @@
+# from .gql_types import *

openimis_be_contract-1.0.0/contract/gql/gql_mutations/contract_details_mutations.py

@@ -0,0 +1,70 @@
+from core.gql.gql_mutations import DeleteInputType
+from core.gql.gql_mutations.base_mutation import (
+    BaseDeleteMutation,
+    BaseHistoryModelCreateMutationMixin,
+    BaseHistoryModelDeleteMutationMixin,
+    BaseHistoryModelUpdateMutationMixin,
+    BaseMutation,
+)
+
+from contract.gql.gql_mutations.input_types import (
+    ContractDetailsCreateFromInsureeInputType,
+    ContractDetailsCreateInputType,
+    ContractDetailsUpdateInputType,
+)
+from contract.models import ContractDetails, ContractDetailsMutation
+
+from .mutations import ContractDetailsFromPHInsureeMutationMixin
+
+
+class CreateContractDetailsMutation(BaseHistoryModelCreateMutationMixin, BaseMutation):
+    _mutation_class = "ContractDetailsMutation"
+    _mutation_module = "contract"
+    _model = ContractDetails
+
+    @classmethod
+    def _mutate(cls, user, **data):
+        client_mutation_id = data.get("client_mutation_id")
+        if "client_mutation_id" in data:
+            data.pop("client_mutation_id")
+        if "client_mutation_label" in data:
+            data.pop("client_mutation_label")
+        contract_detail = cls.create_object(user=user, object_data=data)
+        ContractDetailsMutation.object_mutated(
+            user, client_mutation_id=client_mutation_id, contract_detail=contract_detail
+        )
+        return None
+
+    class Input(ContractDetailsCreateInputType):
+        pass
+
+
+class UpdateContractDetailsMutation(BaseHistoryModelUpdateMutationMixin, BaseMutation):
+    _mutation_class = "ContractDetailsMutation"
+    _mutation_module = "contract"
+    _model = ContractDetails
+
+    class Input(ContractDetailsUpdateInputType):
+        pass
+
+
+class DeleteContractDetailsMutation(
+    BaseHistoryModelDeleteMutationMixin, BaseDeleteMutation
+):
+    _mutation_class = "ContractDetailsMutation"
+    _mutation_module = "contract"
+    _model = ContractDetails
+
+    class Input(DeleteInputType):
+        pass
+
+
+class CreateContractDetailByPolicyHolderInsureeMutation(
+    ContractDetailsFromPHInsureeMutationMixin, BaseMutation
+):
+    _mutation_class = "CreateContractDetailByPolicyHolderInsureetMutation"
+    _mutation_module = "contract"
+    _model = ContractDetails
+
+    class Input(ContractDetailsCreateFromInsureeInputType):
+        pass