Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Added assignments in credits_available endpoint #307

Merged
merged 1 commit into from
Nov 6, 2023
Merged

feat: Added assignments in credits_available endpoint #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion enterprise_access/apps/api/serializers/subsidy_access_policy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from requests.exceptions import HTTPError
from rest_framework import serializers

from enterprise_access.apps.subsidy_access_policy.constants import CENTS_PER_DOLLAR, PolicyTypes
from enterprise_access.apps.subsidy_access_policy.constants import CENTS_PER_DOLLAR, AccessMethods, PolicyTypes
from enterprise_access.apps.subsidy_access_policy.models import SubsidyAccessPolicy

from .content_assignments.assignment import LearnerContentAssignmentResponseSerializer
Expand Down Expand Up @@ -522,6 +522,19 @@ class SubsidyAccessPolicyCreditsAvailableResponseSerializer(SubsidyAccessPolicyR
help_text='',
source='subsidy_expiration_datetime',
)
learner_content_assignments = serializers.SerializerMethodField('get_assignments_serializer')

def get_assignments_serializer(self, obj):
"""
Return serialized assignments if the policy access method is of the 'assigned' type
"""
if obj.access_method == AccessMethods.ASSIGNED:
assignments = obj.assignment_configuration.assignments.prefetch_related('actions').filter(
lms_user_id=self.context.get('lms_user_id')
)
serializer = LearnerContentAssignmentResponseSerializer(assignments, many=True)
return serializer.data
return []

@extend_schema_field(serializers.IntegerField)
def get_remaining_balance_per_user(self, obj):
Expand All @@ -535,6 +548,7 @@ def get_remaining_balance_per_user(self, obj):

@extend_schema_field(serializers.IntegerField)
def get_remaining_balance(self, obj):
"""Returns the remaining balance for the policy"""
return obj.subsidy_balance()


Expand Down
91 changes: 90 additions & 1 deletion enterprise_access/apps/api/v1/tests/test_subsidy_access_policy_views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@
from rest_framework import status
from rest_framework.reverse import reverse

from enterprise_access.apps.content_assignments.tests.factories import AssignmentConfigurationFactory
from enterprise_access.apps.content_assignments.constants import LearnerContentAssignmentStateChoices
from enterprise_access.apps.content_assignments.tests.factories import (
AssignmentConfigurationFactory,
LearnerContentAssignmentFactory
)
from enterprise_access.apps.core.constants import (
SYSTEM_ENTERPRISE_ADMIN_ROLE,
SYSTEM_ENTERPRISE_LEARNER_ROLE,
Expand Down Expand Up @@ -1321,6 +1325,91 @@ def test_credits_available_endpoint(
# with an inactive (i.e., expired, not yet started) subsidy, we should get no records back.
assert len(response_json) == 0

@mock.patch('enterprise_access.apps.subsidy_access_policy.models.get_and_cache_transactions_for_learner')
@mock.patch('enterprise_access.apps.subsidy_access_policy.models.SubsidyAccessPolicy.subsidy_record')
def test_credits_available_endpoint_with_content_assignments(
self,
mock_subsidy_record,
mock_transactions_cache_for_learner # pylint: disable=unused-argument
):
"""
Verify that SubsidyAccessPolicyViewset credits_available returns learner content assignments for assigned
learner credit access policies.
"""
content_key = 'demoX'
content_title = 'edx: Demo 101'
content_price_cents = 100
# Create a pair of AssignmentConfiguration + SubsidyAccessPolicy for the main test customer.
assignment_configuration = AssignmentConfigurationFactory(
enterprise_customer_uuid=self.enterprise_uuid,
)
AssignedLearnerCreditAccessPolicyFactory(
display_name='An assigned learner credit policy, for the test customer.',
enterprise_customer_uuid=self.enterprise_uuid,
active=True,
assignment_configuration=assignment_configuration,
spend_limit=1000000,
)
assignment1 = LearnerContentAssignmentFactory.create(
assignment_configuration=assignment_configuration,
learner_email='alice@foo.com',
lms_user_id=1234,
content_key=content_key,
content_title=content_title,
content_quantity=-content_price_cents,
state=LearnerContentAssignmentStateChoices.ALLOCATED,
)
action, _ = assignment1.add_successful_linked_action()
LearnerContentAssignmentFactory.create(
irfanuddinahmad marked this conversation as resolved.
Show resolved Hide resolved
assignment_configuration=assignment_configuration,
learner_email='bob@foo.com',
lms_user_id=12345,
content_key=content_key,
content_title=content_title,
content_quantity=-content_price_cents,
state=LearnerContentAssignmentStateChoices.ACCEPTED,
)
mock_subsidy_record.return_value = {
'uuid': str(uuid4()),
'title': 'Test Subsidy',
'enterprise_customer_uuid': str(self.enterprise_uuid),
'expiration_datetime': '2030-01-01 12:00:00Z',
'active_datetime': '2020-01-01 12:00:00Z',
'current_balance': '5000',
'is_active': True,
}
self.lms_client_instance.enterprise_contains_learner.return_value = True
expected_learner_content_assignment = {
'uuid': str(assignment1.uuid),
'assignment_configuration': str(assignment_configuration.uuid),
'learner_email': 'alice@foo.com',
'lms_user_id': 1234,
'content_key': content_key,
'content_title': content_title,
'content_quantity': -content_price_cents,
'state': LearnerContentAssignmentStateChoices.ALLOCATED,
'transaction_uuid': None,
'last_notification_at': None,
'actions': [
{
'created': action.created.strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
'modified': action.modified.strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
'uuid': str(action.uuid),
'action_type': 'learner_linked',
'completed_at': action.completed_at.strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
'error_reason': None
}
]
}
query_params = {
'enterprise_customer_uuid': str(self.enterprise_uuid),
'lms_user_id': 1234,
}
response = self.client.get(self.subsidy_access_policy_credits_available_endpoint, query_params)
response_json = response.json()
self.assertEqual(len(response_json[0]['learner_content_assignments']), 1)
self.assertEqual(response_json[0]['learner_content_assignments'][0], expected_learner_content_assignment)


@ddt.ddt
class TestSubsidyAccessPolicyCanRedeemView(APITestWithMocks):
Expand Down
Loading