Merge pull request #18 from dipcode-software/feat/name-refactor

srtab · web-flow · commit 55dad01b198d · 2017-09-14T18:53:11.000+01:00
refactor on app name
diff --git a/.coveragerc b/.coveragerc
@@ -1,5 +1,5 @@
 [run]
-source=mailings/
+source=cbmail/
 branch=True
 omit=
     *tests*
@@ -20,4 +20,4 @@ exclude_lines =
 
     # Don't complain if tests don't hit defensive assertion code:
     raise AssertionError
-    raise NotImplementedError
+    raise NotImplementedError
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
 include LICENSE
 include MANIFEST.in
 include README.md
-recursive-include mailings/templates *
+recursive-include cbmail/templates *
diff --git a/README.rst b/README.rst
@@ -1,4 +1,4 @@
-Django maillings
+Django CBMail
 ================
 
 |Build Status| |Codacy Badge| |Coverage Status| |BCH compliance|
@@ -19,20 +19,20 @@ To install the app run :
 
 .. code:: shell
 
-    pip install django-mailings
+    pip install django-cbmail
 
 or add it to the list of requirements of your project.
 
 Example usage
 -------------
 
-Use the BaseMailing class to define your email like:
+Create a mails.py and use the BaseMail class to define your email like:
 
 .. code:: python
 
-    from mailings.mailings import BaseMailing
+    from cbmail.base import BaseMail
 
-    class ExampleEmail(BaseMailing):
+    class ExampleEmail(BaseMail):
         """ """
         template_name = "myapp/mails/myemail.html"
         subject = "Example subject of email"
@@ -56,7 +56,7 @@ settings:
 
     DEFAULT_FROM_EMAIL = "example@example.com"
 
-    MAILINGS = {
+    CBMAIL = {
         'DEFAULT_REPLY_TO': "examplereplyto@example.com",
         'DEFAULT_SUJECT': "Example subject",
         'BASE_URL': "https://domain.com",
@@ -84,11 +84,11 @@ projects and commercial products.
 .. _Settings reference: #settings-reference
 .. _License: #license
 
-.. |Build Status| image:: https://travis-ci.org/dipcode-software/django-mailings.svg?branch=master
-   :target: https://travis-ci.org/dipcode-software/django-mailings
+.. |Build Status| image:: https://travis-ci.org/dipcode-software/django-cbmail.svg?branch=master
+   :target: https://travis-ci.org/dipcode-software/django-cbmail
 .. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/d01ebbe43c684d478cacc530e44633ad
-   :target: https://www.codacy.com/app/srtabs/django-mailings?utm_source=github.com&utm_medium=referral&utm_content=dipcode-software/django-mailings&utm_campaign=Badge_Grade
-.. |Coverage Status| image:: https://coveralls.io/repos/github/dipcode-software/django-mailings/badge.svg?branch=master
-   :target: https://coveralls.io/github/dipcode-software/django-mailings?branch=master
-.. |BCH compliance| image:: https://bettercodehub.com/edge/badge/dipcode-software/django-mailings?branch=master
+   :target: https://www.codacy.com/app/srtabs/django-cbmail?utm_source=github.com&utm_medium=referral&utm_content=dipcode-software/django-cbmail&utm_campaign=Badge_Grade
+.. |Coverage Status| image:: https://coveralls.io/repos/github/dipcode-software/django-cbmail/badge.svg?branch=master
+   :target: https://coveralls.io/github/dipcode-software/django-cbmail?branch=master
+.. |BCH compliance| image:: https://bettercodehub.com/edge/badge/dipcode-software/django-cbmail?branch=master
    :target: https://bettercodehub.com/
diff --git a/cbmail/__init__.py b/cbmail/__init__.py
@@ -0,0 +1,3 @@
+default_app_config = 'cbmail.apps.CBMAilConfig'
+
+__version__ = '0.1.0'
diff --git a/cbmail/apps.py b/cbmail/apps.py
@@ -3,5 +3,5 @@
 from django.apps import AppConfig
 
 
-class MailingsConfig(AppConfig):
-    name = 'mailings'
+class CBMAilConfig(AppConfig):
+    name = 'cbmail'
diff --git a/cbmail/base.py b/cbmail/base.py
@@ -1,14 +1,14 @@
 from __future__ import unicode_literals
 
+from cbmail.conf import settings
 from django.conf import settings as dj_settings
 from django.core.mail import get_connection
 from django.core.mail.message import EmailMultiAlternatives
 from django.template import loader
 from django.utils.html import strip_tags
-from mailings.conf import settings
 
 
-class BaseMailing(object):
+class BaseMail(object):
     """
     This class represents the base of a templated email
     TODO: add prefix support to subject
@@ -49,7 +49,7 @@ def get_mail_to(self, object_or_list):
             raise ValueError(
                 'object_or_list must be object with get_mailing_list method '
                 'defined or list instance.')
-        return BaseMailing._filter_whitelist(object_or_list)
+        return BaseMail._filter_whitelist(object_or_list)
 
     def get_mail_cc(self):
         """ Returns the list of emails to be used on cc email field """
diff --git a/cbmail/conf.py b/cbmail/conf.py
@@ -5,6 +5,8 @@
 from django.core.exceptions import ImproperlyConfigured
 
 
+APP_NAME = 'CBMAIL'
+
 DEFAULTS = {
     'DEFAULT_REPLY_TO': 'examplereplyto@example.com',
     'DEFAULT_SUJECT': 'Example subject',
@@ -30,7 +32,7 @@ def check_settings(self):
 
     @property
     def user_settings(self):
-        return getattr(dj_settings, 'MAILINGS', {})
+        return getattr(dj_settings, APP_NAME, {})
 
     def __getattr__(self, attr):
         """ """
diff --git a/cbmail/mixins.py b/cbmail/mixins.py
diff --git a/cbmail/templates/cbmail/base.html b/cbmail/templates/cbmail/base.html
diff --git a/cbmail/tests/__init__.py b/cbmail/tests/__init__.py
diff --git a/cbmail/tests/test_base.py b/cbmail/tests/test_base.py
@@ -1,13 +1,13 @@
 from tempfile import NamedTemporaryFile
 
+from cbmail.base import Attachment, BaseMail
+from cbmail.mixins import MailingListMixin
 from django.test import SimpleTestCase
-from mailings.base import Attachment, BaseMailing
-from mailings.mixins import MailingListMixin
 from mock import patch
 
 
-class TestBaseObject(BaseMailing):
-    template_name = 'mailings/base.html'
+class TestBaseObject(BaseMail):
+    template_name = 'cbmail/base.html'
     mail_to = [('dev', 'dev@unit.com')]
     mail_cc = ['dev@unit.com']
     mail_bcc = ['dev@unit.com']
@@ -27,8 +27,8 @@ def get_attachments(self):
         return [att]
 
 
-class TestBaseNoInfoObject(BaseMailing):
-    template_name = 'mailings/base.html'
+class TestBaseNoInfoObject(BaseMail):
+    template_name = 'cbmail/base.html'
     mail_to = [('dev', 'dev@unit.com')]
     mail_cc = ['dev@unit.com']
     mail_bcc = ['dev@unit.com']
@@ -72,18 +72,18 @@ def test_get_mail_to_error(self):
             ValueError, self.object.get_mail_to, '"invalid type"')
 
     def test_filter_whitelist(self):
-        with self.settings(MAILINGS={'WHITELIST': ['a@unit.c', 'b@unit.c']}):
-            result = BaseMailing._filter_whitelist(['a@unit.c', 'c@unit.c'])
+        with self.settings(CBMAIL={'WHITELIST': ['a@unit.c', 'b@unit.c']}):
+            result = BaseMail._filter_whitelist(['a@unit.c', 'c@unit.c'])
         self.assertEqual(result, ['a@unit.c'])
 
     def test_filter_whitelist_not_defined(self):
-        with self.settings(MAILINGS={}):
-            result = BaseMailing._filter_whitelist(['a@unit.c', 'c@unit.c'])
+        with self.settings(CBMAIL={}):
+            result = BaseMail._filter_whitelist(['a@unit.c', 'c@unit.c'])
         self.assertEqual(result, ['a@unit.c', 'c@unit.c'])
 
     def test_filter_whitelist_empty(self):
-        with self.settings(MAILINGS={'WHITELIST': ['a@unit.c', 'b@unit.c']}):
-            result = BaseMailing._filter_whitelist(['c@unit.c', 'd@unit.c'])
+        with self.settings(CBMAIL={'WHITELIST': ['a@unit.c', 'b@unit.c']}):
+            result = BaseMail._filter_whitelist(['c@unit.c', 'd@unit.c'])
         self.assertEqual(result, [])
 
     def test_get_mail_cc(self):
@@ -120,13 +120,13 @@ def test_get_no_info_subject(self):
 
     def test_get_template_name(self):
         result = self.object.get_template_name()
-        self.assertEqual(result, 'mailings/base.html')
+        self.assertEqual(result, 'cbmail/base.html')
 
     def test_get_base_url(self):
         result = self.object.get_base_url()
         self.assertEqual(result, 'https://domain.com')
 
-    @patch('mailings.base.loader.render_to_string')
+    @patch('cbmail.base.loader.render_to_string')
     def test_render(self, render_to_string):
         render_to_string.return_value = "dummy"
         result = self.object.render()
@@ -138,9 +138,9 @@ def test_render(self, render_to_string):
                 'subject': self.object.get_subject()
             })
 
-    @patch('mailings.base.loader.render_to_string')
+    @patch('cbmail.base.loader.render_to_string')
     def test_render_extra_data(self, render_to_string):
-        with self.settings(MAILINGS={
+        with self.settings(CBMAIL={
                 'EXTRA_DATA': {'dummy_key': 'dummy_value'}}):
             render_to_string.return_value = "dummy"
             result = self.object.render()
@@ -153,11 +153,11 @@ def test_render_extra_data(self, render_to_string):
                     'dummy_key': 'dummy_value'
                 })
 
-    @patch('mailings.base.get_connection')
+    @patch('cbmail.base.get_connection')
     def test_get_send_empty(self, get_connection):
         self.assertEqual(self.object.send([]), 0)
 
-    @patch('mailings.base.get_connection')
+    @patch('cbmail.base.get_connection')
     def test_get_send(self, get_connection):
         self.object.send(['dev@unit.com'])
         get_connection().send_messages.assert_called_once()
diff --git a/cbmail/tests/test_conf.py b/cbmail/tests/test_conf.py
@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
+from cbmail.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.test import SimpleTestCase
-from mailings.conf import settings
 
 
 class MailingsSettingsTest(SimpleTestCase):
@@ -16,10 +16,10 @@ def test_getattr_default(self):
         self.assertEqual(settings.WHITELIST, [])
 
     def test_getattr_user(self):
-        with self.settings(MAILINGS={'BASE_URL': 'https://domain.com'}):
+        with self.settings(CBMAIL={'BASE_URL': 'https://domain.com'}):
             self.assertEqual(settings.BASE_URL, 'https://domain.com')
 
     def test_check_settings(self):
-        with self.settings(MAILINGS={}):
+        with self.settings(CBMAIL={}):
             with self.assertRaises(ImproperlyConfigured):
                 settings.check_settings()
diff --git a/cbmail/tests/test_mixins.py b/cbmail/tests/test_mixins.py
@@ -1,6 +1,6 @@
 from django.test import SimpleTestCase
 
-from mailings.mixins import MailingListMixin
+from cbmail.mixins import MailingListMixin
 
 
 class MixinsTest(SimpleTestCase):
diff --git a/mailings/__init__.py b/mailings/__init__.py
diff --git a/runtests.py b/runtests.py
@@ -1,14 +1,16 @@
-import django
 import sys
 
-from django.test.runner import DiscoverRunner
+import django
+
 from django.conf import settings
+from django.test.runner import DiscoverRunner
+
 
 settings.configure(
     INSTALLED_APPS=(
-        'mailings',
+        'cbmail',
     ),
-    MAILINGS={
+    CBMAIL={
         'DEFAULT_REPLY_TO': "replyto@unittest.com",
         'DEFAULT_SUJECT': "Unit test default",
         'BASE_URL': "https://domain.com",
@@ -24,6 +26,6 @@
 if __name__ == "__main__":
     django.setup()
     runner = DiscoverRunner()
-    failures = runner.run_tests(['mailings'])
+    failures = runner.run_tests(['cbmail'])
     if failures:
         sys.exit(failures)
diff --git a/setup.py b/setup.py
@@ -10,10 +10,10 @@
 
 
 # Package meta-data.
-VERSION = __import__("mailings").__version__
-NAME = 'django-mailings'
+VERSION = __import__("cbmail").__version__
+NAME = 'django-cbmail'
 DESCRIPTION = 'Django module to easily send templated emails. '
-URL = 'https://github.com/dipcode-software/django-mailings/'
+URL = 'https://github.com/dipcode-software/django-cbmail/'
 EMAIL = 'team@dipcode.com'
 AUTHOR = 'Dipcode'
 
diff --git a/tox.ini b/tox.ini
@@ -8,7 +8,7 @@ commands = {envpython} runtests.py
 
 [testenv:flake8]
 deps = flake8
-commands = flake8 {toxinidir}/mailings --exclude=*/migrations/*,*settings*
+commands = flake8 {toxinidir}/cbmail --exclude=*/migrations/*,*settings*
 
 [testenv:coverage]
 basepython=python2.7
@@ -23,7 +23,7 @@ commands=
     coverage erase
 
 [testenv:travis]
-passenv = TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH CODACY_PROJECT_TOKEN
+passenv = TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH
 deps =
     -r{toxinidir}/requirements/tests.txt
     coverage
@@ -36,4 +36,3 @@ commands =
     coverage report
     coverage xml
     coveralls
-    python-codacy-coverage -r coverage.xml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+default_app_config = 'cbmail.apps.CBMAilConfig'`
	`2`	`+`
	`3`	`+__version__ = '0.1.0'`