diff --git a/openedx_events/enterprise/data.py b/openedx_events/enterprise/data.py index 2c5e9892..0e4d71af 100644 --- a/openedx_events/enterprise/data.py +++ b/openedx_events/enterprise/data.py @@ -31,6 +31,10 @@ class SubsidyRedemption: class LedgerTransactionReversal: """ Attributes of an ``openedx_ledger.Reversal`` record. + A ``Reversal`` is a model that represents the "undo-ing" of a ``Transaction`` (see below). It's primarily + used within the domain of edX Enterprise for recording unenrollments and refunds of subsidized + enterprise enrollments. + https://github.com/openedx/openedx-ledger/blob/master/openedx_ledger/models.py Arguments: uuid (str): Primary identifier of the record. @@ -53,6 +57,9 @@ class LedgerTransactionReversal: class LedgerTransaction: """ Attributes of an ``openedx_ledger.Transaction`` record. + A ``Transaction`` is a model that represents value moving in or out of a ``Ledger``. It's primarily + used within the domain of edX Enterprise for recording the redemption of subsidized enrollments. + https://github.com/openedx/openedx-ledger/blob/master/openedx_ledger/models.py Arguments: uuid (UUID): Primary identifier of the Transaction. diff --git a/openedx_events/enterprise/signals.py b/openedx_events/enterprise/signals.py index dd8e1d93..50c8a3b7 100644 --- a/openedx_events/enterprise/signals.py +++ b/openedx_events/enterprise/signals.py @@ -13,7 +13,7 @@ # .. event_type: org.openedx.enterprise.subsidy.redeemed.v1 # .. event_name: SUBSIDY_REDEEMED -# .. event_description: (deprecated) emitted when an enterprise subsidy is utilized. +# .. event_description: emitted when an enterprise subsidy is utilized. # .. event_data: SubsidyRedemption SUBSIDY_REDEEMED = OpenEdxPublicSignal( event_type="org.openedx.enterprise.subsidy.redeemed.v1", @@ -24,7 +24,7 @@ # .. event_type: org.openedx.enterprise.subsidy.redemption-reversed.v1 # .. event_name: SUBSIDY_REDEMPTION_REVERSED -# .. event_description: (deprecated) emitted when an enterprise subsidy is reversed. +# .. event_description: emitted when an enterprise subsidy is reversed. # .. event_data: SubsidyRedemption SUBSIDY_REDEMPTION_REVERSED = OpenEdxPublicSignal( event_type="org.openedx.enterprise.subsidy.redemption-reversed.v1", @@ -34,48 +34,52 @@ ) -# .. event_type: org.openedx.enterprise_subsidies.ledger_transaction.created.v1 +# .. event_type: org.openedx.enterprise.subsidy_ledger_transaction.created.v1 # .. event_name: LEDGER_TRANSACTION_CREATED # .. event_description: emitted when an enterprise ledger transaction is created. +# See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions # .. event_data: LedgerTransaction LEDGER_TRANSACTION_CREATED = OpenEdxPublicSignal( - event_type="org.openedx.enterprise_subsidies.ledger_transaction.created.v1", + event_type="org.openedx.enterprise.subsidy_ledger_transaction.created.v1", data={ "ledger_transaction": LedgerTransaction, } ) -# .. event_type: org.openedx.enterprise_subsidies.ledger_transaction.committed.v1 +# .. event_type: org.openedx.enterprise.subsidy_ledger_transaction.committed.v1 # .. event_name: LEDGER_TRANSACTION_COMMITTED # .. event_description: emitted when an enterprise ledger transaction is committed. +# See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions # .. event_data: LedgerTransaction LEDGER_TRANSACTION_COMMITTED = OpenEdxPublicSignal( - event_type="org.openedx.enterprise_subsidies.ledger_transaction.committed.v1", + event_type="org.openedx.enterprise.subsidy_ledger_transaction.committed.v1", data={ "ledger_transaction": LedgerTransaction, } ) -# .. event_type: org.openedx.enterprise_subsidies.ledger_transaction.failed.v1 +# .. event_type: org.openedx.enterprise.subsidy_ledger_transaction.failed.v1 # .. event_name: LEDGER_TRANSACTION_FAILED # .. event_description: emitted when an enterprise ledger transaction fails. +# See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions # .. event_data: LedgerTransaction LEDGER_TRANSACTION_FAILED = OpenEdxPublicSignal( - event_type="org.openedx.enterprise_subsidies.ledger_transaction.failed.v1", + event_type="org.openedx.enterprise.subsidy_ledger_transaction.failed.v1", data={ "ledger_transaction": LedgerTransaction, } ) -# .. event_type: org.openedx.enterprise_subsidies.ledger_transaction.reversed.v1 +# .. event_type: org.openedx.enterprise.subsidy_ledger_transaction.reversed.v1 # .. event_name: LEDGER_TRANSACTION_REVERSED # .. event_description: emitted when an enterprise ledger transaction is reversed. +# See: https://github.com/openedx/openedx-ledger/tree/main/docs/decisions # .. event_data: LedgerTransaction LEDGER_TRANSACTION_REVERSED = OpenEdxPublicSignal( - event_type="org.openedx.enterprise_subsidies.ledger_transaction.reversed.v1", + event_type="org.openedx.enterprise.subsidy_ledger_transaction.reversed.v1", data={ "ledger_transaction": LedgerTransaction, } diff --git a/openedx_events/event_bus/avro/tests/test_custom_serializers.py b/openedx_events/event_bus/avro/tests/test_custom_serializers.py index c07a9536..40fec1af 100644 --- a/openedx_events/event_bus/avro/tests/test_custom_serializers.py +++ b/openedx_events/event_bus/avro/tests/test_custom_serializers.py @@ -4,9 +4,7 @@ from ccx_keys.locator import CCXLocator -from openedx_events.event_bus.avro.custom_serializers import CcxCourseLocatorAvroSerializer - -from ..custom_serializers import UuidAvroSerializer +from openedx_events.event_bus.avro.custom_serializers import CcxCourseLocatorAvroSerializer, UuidAvroSerializer class TestCCXLocatorSerailizer(TestCase): diff --git a/setup.cfg b/setup.cfg index 4bc0fb68..4c16b98c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -13,6 +13,3 @@ multi_line_output = 3 [wheel] universal = 1 - -[flake8] -max-line-length = 120 \ No newline at end of file