Merge pull request #4 from tinpan-io/dev

Production hotfixes, new signals

Author: mystery-house

README.rst

@@ -33,6 +33,8 @@ Next, add busker's URLs to your Django project's main ``urls.py`` module::
 
 For uploaded images to display correctly you also will need ``MEDIA_ROOT`` and ``MEDIA_URL`` configured in your ``settings.py`` module. (See <https://docs.djangoproject.com/en/3.1/howto/static-files/> for a way to tweak your project ``urls.py`` to serve media when developing locally.)
 
+When deploying to production, you'll need to run the ``collectstatic`` admin command.
+
 Finally, in the terminal, run busker's migrations from the top level of the Django project::
 
   python manage.my migrate busker
@@ -52,7 +54,7 @@ Represents an artist/creator.
 DownloadableWork
 ----------------
 
-Represents an item that will be accessible to people with valid download codes; for example, an music album or EP.
+Represents an item that will be accessible to people with valid download codes; for example, a zip file containing an album of music. (Or, several zip files of the same album in different formats.)
 
 File
 ----
@@ -68,3 +70,13 @@ DownloadCode
 ------------
 
 DownloadCode objects represent the actual codes users can use to access files. They're generally auto-created when a new Batch is saved. Note the 'export csv' option in the DownloadCode admin view.
+
+Signals
+=======
+Busker provides the following signals which may be useful:
+
+``busker.signals.code_post_redeem(sender, request, code)``
+This signal is sent whenever a DownloadCode is redeemed, *after* its ``times_used`` and ``last_used_date`` fields have been updated but *before* the user is presented with the download page. It sends the `request` object and the `DownloadCode` object being redeemed. 
+
+``busker.signals.file_pre_download(sender, request, file)``
+This signal is sent whenever a user clicks on a link to download a file, *after* the File object has been loaded but *before* the file is actually sent to the client. It sends the `request` object and the `File` object being redeemed.

busker/manage.py

@@ -0,0 +1,4 @@
+from django.dispatch import Signal
+
+code_post_redeem = Signal(providing_args=["request", "code"])
+file_pre_download = Signal(providing_args=["request", "file"])

busker/models.py

@@ -9,8 +9,8 @@ <h2>Code Expired</h2>
 <h2>Redeem Code</h2>
 {% endif %}
     {% if code.batch.work.image %}
-        <div class="busker-thumbnail">
-            <img src="{{ code.batch.work.thumbnail.url }}" alt="{{ code.batch.work.title }}">
+<div class="busker-thumbnail">
+        <img src="{{ code.batch.work.thumbnail.url }}" alt="{{ code.batch.work.title }}">
         </div>
     {% endif %}
 <form action="{% url 'busker:redeem' form.code.value %}" method="POST">
@@ -20,9 +20,13 @@ <h2>Redeem Code</h2>
     {% elif code.remaining_uses > 0 %}
         <p>This code has {{ code.remaining_uses }} use{{ code.remaining_uses|pluralize }} left.</p>
         {{ form.as_p }}
-        <input type="submit" value="Continue">
+	{% if code.batch.public_message %}
+	{{ code.batch.public_message_rendered|safe }}
+	{% endif %}
+
+	<input type="submit" value="Continue">
     {% else %}
         This code has already been used.
     {% endif %}
 </form>
-{% endblock %}
+{% endblock %}

busker/signals.py

@@ -10,6 +10,7 @@
 import magic
 from .forms import RedeemCodeForm, ConfirmForm
 from .models import DownloadCode, File, validate_code
+from .signals import code_post_redeem, file_pre_download
 from .util import log_activity
 
 # TODO custom 404 view using base.html for this app https://stackoverflow.com/a/35110595/3280582
@@ -57,6 +58,7 @@ def form_valid(self, form):
         log_activity(logger, code, "Code Redeemed", self.request)
         context = self.get_context_data()
         context['code'] = code
+        code_post_redeem.send(sender=self.__class__, request=self.request, code=code)
         return render(self.request, 'busker/file_list.html', context=context)
 
 
@@ -75,6 +77,7 @@ def get(self, request, *args, **kwargs):
 
         mime = magic.Magic(mime=True)
         filename = os.path.basename(file.file.path)
+        file_pre_download.send(sender=self.__class__, request=self.request, file=file)
         response = HttpResponse(file.file, content_type=mime.from_file(file.file.path))
         response['Content-Disposition'] = f'attachment; filename="{filename}"'
         response['Content-Length'] = file.file.size

busker/templates/busker/confirm_form.html

@@ -1,6 +1,6 @@
 [metadata]
 name = django-busker
-version = 0.5.2
+version = 0.6.0
 description = A Django app to manage download codes for digital assets.
 long_description = file: README.rst
 url = https://github.com/tinpan-io/django-busker