diff --git a/openedx/core/djangoapps/credit/api/provider.py b/openedx/core/djangoapps/credit/api/provider.py
index 50f4447e9a..5337b1548d 100644
--- a/openedx/core/djangoapps/credit/api/provider.py
+++ b/openedx/core/djangoapps/credit/api/provider.py
@@ -2,17 +2,13 @@
API for initiating and tracking requests for credit from a provider.
"""
-import logging
-import uuid
import datetime
-
+import logging
import pytz
+import uuid
from django.db import transaction
-from util.date_utils import to_timestamp
-
-from student.models import User
from openedx.core.djangoapps.credit.exceptions import (
UserIsNotEligible,
CreditProviderNotConfigured,
@@ -27,6 +23,8 @@ from openedx.core.djangoapps.credit.models import (
CreditEligibility,
)
from openedx.core.djangoapps.credit.signature import signature, get_shared_secret_key
+from student.models import User
+from util.date_utils import to_timestamp
log = logging.getLogger(__name__)
@@ -51,6 +49,47 @@ def get_credit_providers():
return CreditProvider.get_credit_providers()
+def get_credit_provider_info(provider_id):
+ """Retrieve the 'CreditProvider' model data against provided
+ credit provider.
+
+ Args:
+ provider_id (str): The identifier for the credit provider
+
+ Returns: 'CreditProvider' data dictionary
+
+ Example Usage:
+ >>> get_credit_provider_info("hogwarts")
+ {
+ "provider_id": "hogwarts",
+ "display_name": "Hogwarts School of Witchcraft and Wizardry",
+ "provider_url": "https://credit.example.com/",
+ "provider_status_url": "https://credit.example.com/status/",
+ "enable_integration": False,
+ "fulfillment_instructions": "
+ In order to fulfill credit, Hogwarts School of Witchcraft and Wizardry requires learners to:
+
+ - Sample instruction abc
+ - Sample instruction xyz
+
",
+ }
+
+ """
+ credit_provider = CreditProvider.get_credit_provider(provider_id=provider_id)
+ credit_provider_data = {}
+ if credit_provider:
+ credit_provider_data = {
+ "provider_id": credit_provider.provider_id,
+ "display_name": credit_provider.display_name,
+ "provider_url": credit_provider.provider_url,
+ "provider_status_url": credit_provider.provider_status_url,
+ "enable_integration": credit_provider.enable_integration,
+ "fulfillment_instructions": credit_provider.fulfillment_instructions
+ }
+
+ return credit_provider_data
+
+
@transaction.commit_on_success
def create_credit_request(course_key, provider_id, username):
"""
@@ -84,7 +123,7 @@ def create_credit_request(course_key, provider_id, username):
Arguments:
course_key (CourseKey): The identifier for the course.
provider_id (str): The identifier of the credit provider.
- user (User): The user initiating the request.
+ username (str): The user initiating the request.
Returns: dict
diff --git a/openedx/core/djangoapps/credit/migrations/0014_auto__add_field_creditprovider_fulfillment_instructions.py b/openedx/core/djangoapps/credit/migrations/0014_auto__add_field_creditprovider_fulfillment_instructions.py
new file mode 100644
index 0000000000..b818845cb4
--- /dev/null
+++ b/openedx/core/djangoapps/credit/migrations/0014_auto__add_field_creditprovider_fulfillment_instructions.py
@@ -0,0 +1,154 @@
+# -*- coding: utf-8 -*-
+from south.utils import datetime_utils as datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+ def forwards(self, orm):
+ # Adding field 'CreditProvider.fulfillment_instructions'
+ db.add_column('credit_creditprovider', 'fulfillment_instructions',
+ self.gf('django.db.models.fields.TextField')(null=True, blank=True),
+ keep_default=False)
+
+
+ def backwards(self, orm):
+ # Deleting field 'CreditProvider.fulfillment_instructions'
+ db.delete_column('credit_creditprovider', 'fulfillment_instructions')
+
+
+ models = {
+ 'auth.group': {
+ 'Meta': {'object_name': 'Group'},
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+ 'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+ },
+ 'auth.permission': {
+ 'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
+ 'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+ 'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+ },
+ 'auth.user': {
+ 'Meta': {'object_name': 'User'},
+ 'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+ 'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
+ 'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+ 'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+ 'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+ 'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+ 'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+ 'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+ 'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+ 'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
+ 'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
+ },
+ 'contenttypes.contenttype': {
+ 'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+ 'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+ 'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+ },
+ 'credit.creditcourse': {
+ 'Meta': {'object_name': 'CreditCourse'},
+ 'course_key': ('xmodule_django.models.CourseKeyField', [], {'unique': 'True', 'max_length': '255', 'db_index': 'True'}),
+ 'enabled': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'})
+ },
+ 'credit.crediteligibility': {
+ 'Meta': {'unique_together': "(('username', 'course'),)", 'object_name': 'CreditEligibility'},
+ 'course': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'eligibilities'", 'to': "orm['credit.CreditCourse']"}),
+ 'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
+ 'deadline': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime(2016, 7, 6, 0, 0)'}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
+ 'username': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'})
+ },
+ 'credit.creditprovider': {
+ 'Meta': {'object_name': 'CreditProvider'},
+ 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+ 'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
+ 'display_name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+ 'enable_integration': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+ 'fulfillment_instructions': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
+ 'provider_id': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '255'}),
+ 'provider_status_url': ('django.db.models.fields.URLField', [], {'default': "''", 'max_length': '200'}),
+ 'provider_url': ('django.db.models.fields.URLField', [], {'default': "''", 'max_length': '200'})
+ },
+ 'credit.creditrequest': {
+ 'Meta': {'unique_together': "(('username', 'course', 'provider'),)", 'object_name': 'CreditRequest'},
+ 'course': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'credit_requests'", 'to': "orm['credit.CreditCourse']"}),
+ 'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
+ 'parameters': ('jsonfield.fields.JSONField', [], {}),
+ 'provider': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'credit_requests'", 'to': "orm['credit.CreditProvider']"}),
+ 'status': ('django.db.models.fields.CharField', [], {'default': "'pending'", 'max_length': '255'}),
+ 'username': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}),
+ 'uuid': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '32', 'db_index': 'True'})
+ },
+ 'credit.creditrequirement': {
+ 'Meta': {'unique_together': "(('namespace', 'name', 'course'),)", 'object_name': 'CreditRequirement'},
+ 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+ 'course': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'credit_requirements'", 'to': "orm['credit.CreditCourse']"}),
+ 'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
+ 'criteria': ('jsonfield.fields.JSONField', [], {}),
+ 'display_name': ('django.db.models.fields.CharField', [], {'default': "''", 'max_length': '255'}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
+ 'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+ 'namespace': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+ 'order': ('django.db.models.fields.PositiveIntegerField', [], {'default': '0'})
+ },
+ 'credit.creditrequirementstatus': {
+ 'Meta': {'unique_together': "(('username', 'requirement'),)", 'object_name': 'CreditRequirementStatus'},
+ 'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
+ 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ 'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
+ 'reason': ('jsonfield.fields.JSONField', [], {'default': '{}'}),
+ 'requirement': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'statuses'", 'to': "orm['credit.CreditRequirement']"}),
+ 'status': ('django.db.models.fields.CharField', [], {'max_length': '32'}),
+ 'username': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'})
+ },
+ 'credit.historicalcreditrequest': {
+ 'Meta': {'ordering': "(u'-history_date', u'-history_id')", 'object_name': 'HistoricalCreditRequest'},
+ 'course': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "u'+'", 'null': 'True', 'on_delete': 'models.DO_NOTHING', 'to': "orm['credit.CreditCourse']"}),
+ 'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
+ u'history_date': ('django.db.models.fields.DateTimeField', [], {}),
+ u'history_id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ u'history_type': ('django.db.models.fields.CharField', [], {'max_length': '1'}),
+ u'history_user': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "u'+'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': "orm['auth.User']"}),
+ 'id': ('django.db.models.fields.IntegerField', [], {'db_index': 'True', 'blank': 'True'}),
+ 'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
+ 'parameters': ('jsonfield.fields.JSONField', [], {}),
+ 'provider': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "u'+'", 'null': 'True', 'on_delete': 'models.DO_NOTHING', 'to': "orm['credit.CreditProvider']"}),
+ 'status': ('django.db.models.fields.CharField', [], {'default': "'pending'", 'max_length': '255'}),
+ 'username': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}),
+ 'uuid': ('django.db.models.fields.CharField', [], {'max_length': '32', 'db_index': 'True'})
+ },
+ 'credit.historicalcreditrequirementstatus': {
+ 'Meta': {'ordering': "(u'-history_date', u'-history_id')", 'object_name': 'HistoricalCreditRequirementStatus'},
+ 'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
+ u'history_date': ('django.db.models.fields.DateTimeField', [], {}),
+ u'history_id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+ u'history_type': ('django.db.models.fields.CharField', [], {'max_length': '1'}),
+ u'history_user': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "u'+'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': "orm['auth.User']"}),
+ 'id': ('django.db.models.fields.IntegerField', [], {'db_index': 'True', 'blank': 'True'}),
+ 'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
+ 'reason': ('jsonfield.fields.JSONField', [], {'default': '{}'}),
+ 'requirement': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "u'+'", 'null': 'True', 'on_delete': 'models.DO_NOTHING', 'to': "orm['credit.CreditRequirement']"}),
+ 'status': ('django.db.models.fields.CharField', [], {'max_length': '32'}),
+ 'username': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'})
+ }
+ }
+
+ complete_apps = ['credit']
\ No newline at end of file
diff --git a/openedx/core/djangoapps/credit/models.py b/openedx/core/djangoapps/credit/models.py
index 9c6bc34f8c..6834c523c3 100644
--- a/openedx/core/djangoapps/credit/models.py
+++ b/openedx/core/djangoapps/credit/models.py
@@ -94,6 +94,16 @@ class CreditProvider(TimeStampedModel):
)
)
+ fulfillment_instructions = models.TextField(
+ null=True,
+ blank=True,
+ help_text=ugettext_lazy(
+ "Plain text or html content for displaying further steps on "
+ "receipt page *after* paying for the credit to get credit for a "
+ "credit course against a credit provider."
+ )
+ )
+
CREDIT_PROVIDERS_CACHE_KEY = "credit.providers.list"
@classmethod
@@ -123,6 +133,16 @@ class CreditProvider(TimeStampedModel):
return providers
+ @classmethod
+ def get_credit_provider(cls, provider_id):
+ """
+ Retrieve a credit provider with provided 'provider_id'.
+ """
+ try:
+ return CreditProvider.objects.get(active=True, provider_id=provider_id)
+ except cls.DoesNotExist:
+ return None
+
def __unicode__(self):
"""Unicode representation of the credit provider. """
return self.provider_id
diff --git a/openedx/core/djangoapps/credit/tests/test_api.py b/openedx/core/djangoapps/credit/tests/test_api.py
index 38deef2f66..a8846e5fc2 100644
--- a/openedx/core/djangoapps/credit/tests/test_api.py
+++ b/openedx/core/djangoapps/credit/tests/test_api.py
@@ -48,6 +48,8 @@ class CreditApiTestBase(TestCase):
PROVIDER_NAME = "Hogwarts School of Witchcraft and Wizardry"
PROVIDER_URL = "https://credit.example.com/request"
PROVIDER_STATUS_URL = "https://credit.example.com/status"
+ ENABLE_INTEGRATION = True
+ FULFILLMENT_INSTRUCTIONS = "Sample fulfillment instruction for credit completion."
def setUp(self, **kwargs):
super(CreditApiTestBase, self).setUp()
@@ -62,7 +64,8 @@ class CreditApiTestBase(TestCase):
display_name=self.PROVIDER_NAME,
provider_url=self.PROVIDER_URL,
provider_status_url=self.PROVIDER_STATUS_URL,
- enable_integration=True,
+ enable_integration=self.ENABLE_INTEGRATION,
+ fulfillment_instructions=self.FULFILLMENT_INSTRUCTIONS
)
return credit_course
@@ -447,6 +450,25 @@ class CreditProviderIntegrationApiTests(CreditApiTestBase):
result = api.get_credit_providers()
self.assertEqual(result, [])
+ def test_get_credit_provider_details(self):
+ """Test that credit api method 'test_get_credit_provider_details'
+ returns dictionary data related to provided credit provider.
+ """
+ expected_result = {
+ "provider_id": self.PROVIDER_ID,
+ "display_name": self.PROVIDER_NAME,
+ "provider_url": self.PROVIDER_URL,
+ "provider_status_url": self.PROVIDER_STATUS_URL,
+ "enable_integration": self.ENABLE_INTEGRATION,
+ "fulfillment_instructions": self.FULFILLMENT_INSTRUCTIONS
+ }
+ result = api.get_credit_provider_info(self.PROVIDER_ID)
+ self.assertEqual(result, expected_result)
+
+ # now test that user gets empty dict for non existent credit provider
+ result = api.get_credit_provider_info('fake_provider_id')
+ self.assertEqual(result, {})
+
def test_credit_request(self):
# Initiate a credit request
request = api.create_credit_request(self.course_key, self.PROVIDER_ID, self.USER_INFO['username'])