Major update

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.0
+current_version = 1.0.0
 files = setup.py oscar_support/__init__.py docs/source/conf.py
 commit = True
 tag = True

.travis.yml

@@ -3,8 +3,8 @@ python:
   - "2.6"
   - "2.7"
 env:
-  - DJANGO_VERSION=">=1.4,<1.5" OSCAR_VERSION=">=0.6,<0.7"
-  - DJANGO_VERSION=">=1.5,<1.6" OSCAR_VERSION=">=0.6,<0.7"
+  - DJANGO_VERSION=">=1.8,<2.0" OSCAR_VERSION=">=1.3,<1.6"
+  - DJANGO_VERSION=">=1.8,<2.0" OSCAR_VERSION=">=1.3,<1.6"
 install:
   - pip install Django$DJANGO_VERSION django-oscar$OSCAR_VERSION
   - pip install .

CHANGELOG.rst

@@ -0,0 +1,7 @@
+__CHANGELOG:__
+
+__1.0.0__ 
+
+- Support for insert files, orders, lines and products in `dashboard` and `admin`. 
+- Add ticket types, ticket statuses and priorities in `dashboard`.
+- Create, Edit and Delete tickets. 

README.rst

@@ -24,11 +24,11 @@ Currently it only allow very basic functionality such as:
 #. Reply to a customer with a message.
 #. Make a note on the ticket for internal use.
 #. Assign tickets to a staff user.
+#. Relating a ticket to products, orders or order lines(User case: only staff can do it, staff take al information from attached files (invoices for example))
+#. Allow file attachments
 
 Features currently in the making:
 
-#. Relating a ticket to products, orders or order lines
-#. Allow file attachments
 #. Integrate with Oscar's alert system to notify the user of new replies.
 #. Add templating for messages in the dashboard for quicker replies.
 
@@ -44,6 +44,11 @@ Longer-term direction:
   are then prioritized or re-assigned according to actions related to these
   SLAs.
 
+For to do:
+
+* Test and coverage for all features.
+* Improve styles: print only file name instead his path.
+* Not all changes in the forms have to make a new messages.
 
 Screenshots
 -----------

docs/source/getting_started.rst

@@ -2,12 +2,6 @@
 Getting Started
 ===============
 
-.. warning:: *django-oscar-support* has been tested with Oscar 0.6 ``master``
-    (due to it's pre-release state) and only works with commit `4aea545de3`_
-    or later. Due to major changes in the stock record architecture and the
-    customer account templates earlier version will not work with the
-    instructions below.
-
 .. _`4aea545de3`: https://github.com/tangentlabs/django-oscar/commit/4aea545de3d79fb20af49c24984541873c6be89c
 
 Installation
@@ -24,7 +18,7 @@ Start off by installing the required package either from PyPI::
 
 or install the latest version from github using::
 
-    pip install git+https://github.com/tangentlabs/django-oscar-support.git
+    pip install git+https://github.com/mykljohn/django-oscar-support.git
 
 To make your Django project aware of the new package add it to your
 ``INSTALLED_APPS``::
@@ -57,14 +51,18 @@ a default UI for these two entry points but they need to be hooked into your
 Oscar project. Let's start by adding the URL patterns to your current project
 by adding the following line into your ``urls.py`` file::
 
-    import oscar_support.urls
-
-    urlpatterns = patterns(''
+    from oscar_support.app import application as support
+    from oscar_support.api.app import application as support_api
+    from oscar_support.dashboard.app import application as support_dashboard
+
+    urlpatterns = [
         ...
+	url(r'^dashboard/support/', include(support_dashboard.urls)),
         url(r'^', include(shop.urls)),  # Oscar's URL patterns
-        url(r'^', include(oscar_support.urls)),
+        url(r'', include(support.urls)),
+    	url(r'^api/', include(support_api.urls)), # You can use instead Oscar api urls
         ...
-    )
+    ]
 
 This will provide all the URLs required to interact with the support system.
 The next step is to make the dashboard UI available in the navigation using
@@ -75,18 +73,14 @@ Oscar's ``OSCAR_DASHBOARD_NAVIGATION`` settings::
 
     ....
 
-    OSCAR_DASHBOARD_NAVIGATION = OSCAR_DASHBOARD_NAVIGATION + [
+    OSCAR_DASHBOARD_NAVIGATION += [
         {
             'label': _("Support"),
             'icon': 'icon-comments',
             'url_name': 'support-dashboard:ticket-list',
         }
     ]
 
-.. note:: Make sure that you aren't using ``OSCAR_DASHBOARD_NAVIGATION +=``
-    because this will cause duplicate entries due to a bug in Django that will
-    only be fixed in version 1.6+
-
 All that is left to do now is integrating the customer-facing part of the
 support system. The templates that come with *django-oscar-support* extend
 Oscar's customer account templates and should pick up the styles that are
@@ -102,11 +96,10 @@ template directory and add the following content::
 
     {% extends "oscar/customer/baseaccountpage.html" %}
     {% load i18n %}
-    {% load url from future %}
 
     {% block standard_tabs %}
         {{ block.super }}
-        <li>
+        <li{% if active_tab == 'support' %} class="active"{% endif %}>
             <a href="{% url 'support:customer-ticket-list' %}">{% trans "Support" %}</a>
         </li>
     {% endblock %}

oscar_support/__init__.py

@@ -1 +1,2 @@
-__version__ = '0.1.0'
+__version__ = '0.2.0'
+default_app_config = 'oscar_support.config.OscarSupportConfig'

oscar_support/abstract_models.py

@@ -1,4 +1,6 @@
 from django.db import models
+from django.urls import reverse
+from django.utils.encoding import python_2_unicode_compatible
 from django.utils.translation import ugettext_lazy as _
 
 from shortuuidfield import ShortUUIDField
@@ -17,11 +19,12 @@ class Meta:
         abstract = True
 
 
+@python_2_unicode_compatible
 class AbstractTicketType(BaseSupportModel):
     slug = AutoSlugField(_("Slug"), populate_from='name', unique=True)
     name = models.CharField(_("Name"), max_length=64)
 
-    def __unicode__(self):
+    def __str__(self):
         return self.name
 
     class Meta:
@@ -30,11 +33,12 @@ class Meta:
         verbose_name_plural = _("Ticket types")
 
 
+@python_2_unicode_compatible
 class AbstractTicketStatus(BaseSupportModel):
     slug = AutoSlugField(_("Slug"), populate_from='name', unique=True)
     name = models.CharField(_("Name"), max_length=64)
 
-    def __unicode__(self):
+    def __str__(self):
         return self.name
 
     class Meta:
@@ -43,6 +47,7 @@ class Meta:
         verbose_name_plural = _("Ticket statuses")
 
 
+@python_2_unicode_compatible
 class AbstractTicket(ModificationTrackingMixin, BaseSupportModel):
     number = models.CharField(
         _("Number"),
@@ -93,7 +98,9 @@ class AbstractTicket(ModificationTrackingMixin, BaseSupportModel):
 
     # main content of the (initial) ticket
     subject = models.CharField(_("Subject"), max_length=255)
-    body = models.TextField(_("Body"))
+    body = models.TextField(_("Body"), blank=True)
+    # TODO: In CreateForm in dashboard JS give us: An invalid form control with name='body' is not focusable,
+    # for avoid it was needed make BODY unrequired, putting "black=true" property. It doesn't happen in customer view.
 
     priority = models.ForeignKey(
         'Priority',
@@ -145,8 +152,15 @@ def save(self, *args, **kwargs):
             self.subticket_id = ticket_numbers['subticket_id']
         return super(AbstractTicket, self).save(*args, **kwargs)
 
-    def __unicode__(self):
-        return "Ticket #{0}".format(self.printable_number)
+    def __str__(self):
+        return _("Ticket #{0}").format(self.printable_number)
+
+    def get_absolute_url(self):
+        """
+        Return a product's absolute url
+        """
+        return reverse('support:customer-ticket-update',
+                       kwargs={'pk': self.uuid})
 
     class Meta:
         abstract = True
@@ -158,17 +172,22 @@ class Meta:
         unique_together = (('number', 'subticket_id'),)
 
 
+@python_2_unicode_compatible
 class AbstractPriority(BaseSupportModel):
     name = models.CharField(_("Name"), max_length=255)
     slug = AutoSlugField(_("Slug"), populate_from='name')
     comment = models.TextField(_("Comment"), blank=True)
 
+    def __str__(self):
+        return self.name
+
     class Meta:
         abstract = True
         verbose_name = _("Priority")
         verbose_name_plural = _("Priorities")
 
 
+@python_2_unicode_compatible
 class AbstractMessage(ModificationTrackingMixin, BaseSupportModel):
     PUBLIC = u'public'
     INTERNAL = u'internal'
@@ -198,8 +217,8 @@ class AbstractMessage(ModificationTrackingMixin, BaseSupportModel):
     def is_internal(self):
         return self.type == self.INTERNAL
 
-    def __unicode__(self):
-        return "{0} from {1} for ticket #{2}".format(
+    def __str__(self):
+        return _("{0} from {1} for {2}").format(
             self.type,
             self.user.email,
             self.ticket
@@ -212,6 +231,7 @@ class Meta:
         verbose_name_plural = _("Messages")
 
 
+@python_2_unicode_compatible
 class AbstractRelatedItem(ModificationTrackingMixin, BaseSupportModel):
     ticket = models.ForeignKey(
         'Ticket',
@@ -224,58 +244,65 @@ class AbstractRelatedItem(ModificationTrackingMixin, BaseSupportModel):
         related_name="%(class)ss",
     )
 
+    def __str__(self):
+        return _("{0} related to {1}").format(self.ticket, self.user)
+
     class Meta:
         abstract = True
 
 
+@python_2_unicode_compatible
 class AbstractRelatedOrderLine(AbstractRelatedItem):
     line = models.ForeignKey(
         "order.Line",
         verbose_name=_("Order line"),
         related_name="ticket_related_order_lines",
     )
 
-    def __unicode__(self):
-        return "{0} related to {1}".format(self.line, self.ticket)
+    def __str__(self):
+        return _("{0} related to {1}").format(self.line, self.ticket)
 
     class Meta:
         abstract = True
         verbose_name = _("Related order line")
         verbose_name_plural = _("Related order lines")
 
 
+@python_2_unicode_compatible
 class AbstractRelatedOrder(AbstractRelatedItem):
     order = models.ForeignKey(
         "order.Order",
         verbose_name=_("Order"),
         related_name="ticket_related_orders",
     )
 
-    def __unicode__(self):
-        return "{0} related to {1}".format(self.order, self.ticket)
+    def __str__(self):
+        return _("{0} related to {1}").format(self.order, self.ticket)
 
     class Meta:
         abstract = True
         verbose_name = _("Related order")
         verbose_name_plural = _("Related orders")
 
 
+@python_2_unicode_compatible
 class AbstractRelatedProduct(AbstractRelatedItem):
     product = models.ForeignKey(
         "catalogue.Product",
         verbose_name=_("Product"),
         related_name="ticket_related_products",
     )
 
-    def __unicode__(self):
-        return "{0} related to {1}".format(self.product, self.ticket)
+    def __str__(self):
+        return _("{0} related to {1}").format(self.product, self.ticket)
 
     class Meta:
         abstract = True
         verbose_name = _("Related product")
         verbose_name_plural = _("Related products")
 
 
+@python_2_unicode_compatible
 class AbstractAttachment(ModificationTrackingMixin, BaseSupportModel):
     ticket = models.ForeignKey(
         'Ticket',
@@ -289,11 +316,13 @@ class AbstractAttachment(ModificationTrackingMixin, BaseSupportModel):
     )
     file = models.FileField(
         upload_to="oscar_support/%Y/%m",
-        verbose_name=_("File")
+        verbose_name=_("File"),
+        help_text=_("Add documents that present important information to understand the problem, "
+                    "such as: invoices, catalogs, photos, orders, etc.")
     )
 
-    def __unicode__(self):
-        return "{0} attached to {1}".format(self.file.url, self.ticket)
+    def __str__(self):
+        return _("{0} attached to {1}").format(self.file.url, self.ticket)
 
     class Meta:
         abstract = True