diff --git a/.coveragerc b/.coveragerc index d1be2d0..02ebb99 100644 --- a/.coveragerc +++ b/.coveragerc @@ -1,14 +1,8 @@ [run] -omit = - ../*admin* - ../*urls* - retirement_api/migrations/* - setup.py - retirement_api/settings.py +source=retirement_api [report] - -exclude_lines = +exclude_lines= pragma: no cover def __unicode__ if __name__ == .__main__.: diff --git a/.travis.yml b/.travis.yml index c72aa90..0cdcd0f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,18 +3,13 @@ python: - '2.7' cache: pip env: DJ_KEY=testkey -before_install: -- nvm use 6 install: -- pip install -r requirements.txt -- pip install coveralls +- pip install coveralls tox before_script: - - npm install -g bower gulp-cli - - bower install + - npm install -g bower gulp-cli + - bower install script: -- cp test_settings.py settings.py -- ./manage.py migrate -- coverage run --source='.' manage.py test +- tox - python2.7 setup.py bdist_wheel - ls dist/* after_success: diff --git a/README.md b/README.md index cb61504..9e6962b 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,10 @@ Tú puedes ver este app en español por poner `/es` al parte final del url. * [virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/) * [Node](http://nodejs.org/) * [Gulp](http://gulpjs.com/) + * [Bower](https://bower.io/) ### Code dependencies - * [Django 1.8](https://docs.djangoproject.com/en/1.8/) + * [Django 1.8-1.11](https://docs.djangoproject.com/en/1.11/) * [BeautifulSoup4](http://www.crummy.com/software/BeautifulSoup/bs4/doc/) * [Python-dateutil](https://dateutil.readthedocs.org/en/latest/) * [Requests](http://docs.python-requests.org/en/latest/) @@ -47,7 +48,7 @@ mkvirtualenv retirement git clone https://github.com/cfpb/retirement.git cd retirement setvirtualenvproject -pip install -r requirements.txt +pip install -e '.[testing]' ``` Build the front-end requirements and the JavaScript files. @@ -66,23 +67,24 @@ Fire up a development server. python manage.py runserver ``` -The "Before You Claim" page should load at `localhost:8000/retirement/before-you-claim/`. +The "Before You Claim" page should load at `localhost:8000/before-you-claim/`. ### Usage notes - The app is set up to run inside [consumerfinance.gov](http://www.consumerfinance.gov), so if you run it locally, some fonts may not load because of [Cross-Origin Resource Sharing](http://www.w3.org/TR/cors/) policies. - The app sends http requests to the Social Security Administration's [Quick Calculator](http://www.ssa.gov/OACT/quickcalc/index.html) to get benefit estimates for the chart. ### How to run software tests -- You can use nose to run the Python test suite and see code coverage information: +- To run the Python tests, install [tox](https://tox.readthedocs.io/en/latest/) and then run it: + +```bash +tox +``` - ```bash - ./pytest.sh - ``` - You can run the JavaScript tests with: - ```bash - npm test - ``` +```bash +npm test +``` ## Additional documentation * [Front-end documentation](front-end.md) diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 225958c..0000000 --- a/requirements.txt +++ /dev/null @@ -1,9 +0,0 @@ -beautifulsoup4==4.3.2 -coverage==3.7.1 -Django==1.8.9 -django-filter==0.9.2 -dj-database-url==0.4.2 -mock==1.0.1 -python-dateutil==2.2 -requests==2.9.1 -six==1.9.0 diff --git a/retirement_api/locale/es/LC_MESSAGES/django.mo b/retirement_api/locale/es/LC_MESSAGES/django.mo index 58048d1..d865445 100644 Binary files a/retirement_api/locale/es/LC_MESSAGES/django.mo and b/retirement_api/locale/es/LC_MESSAGES/django.mo differ diff --git a/retirement_api/locale/es/LC_MESSAGES/django.po b/retirement_api/locale/es/LC_MESSAGES/django.po index f3b52c8..c69377f 100644 --- a/retirement_api/locale/es/LC_MESSAGES/django.po +++ b/retirement_api/locale/es/LC_MESSAGES/django.po @@ -859,10 +859,6 @@ msgstr "Nuestra herramienta aplica aumentos en sus beneficios estimados inmediat msgid "The tool gives estimates for people ages 22 to 70" msgstr "La herramienta proporciona estimaciones para las personas entre las edades de 22 a 70 años" -#: -msgid "about" -msgstr "/retirement/before-you-claim/about/es/" - #: msgid "Planning for Retirement: Before you claim" msgstr "Planifique para su Jubilación: Antes de solicitar" diff --git a/retirement_api/templates/base.html b/retirement_api/templates/base.html deleted file mode 100644 index 8b8021e..0000000 --- a/retirement_api/templates/base.html +++ /dev/null @@ -1,181 +0,0 @@ - -{% load i18n %} -{% load staticfiles %} -{% trans page.title as TITLE %} -{% trans "Yes" as YES %} -{% trans "No" as NO %} -{% trans "Not Sure" as NOTSURE %} -{% trans "Step" as STEP %} - - - - - - - - - - - - - {{ TITLE }} > {% trans "Consumer Financial Protection Bureau" %} - - - - - - - - {% block page_meta %} - - - {% endblock %} - - {% block open_graph_image %} - - - {% endblock %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -{% if es %} - -{% else %} - -{% endif %} - - - - - - - - - - - - - -{% block content %}{% endblock %} - -
- -
- -
- -
- - -{% block foot_js %}{% endblock %} - - - diff --git a/retirement_api/templates/about.html b/retirement_api/templates/retirement_api/about.html similarity index 100% rename from retirement_api/templates/about.html rename to retirement_api/templates/retirement_api/about.html diff --git a/retirement_api/templates/claiming.html b/retirement_api/templates/retirement_api/claiming.html similarity index 99% rename from retirement_api/templates/claiming.html rename to retirement_api/templates/retirement_api/claiming.html index b5b5efb..3dd0f84 100644 --- a/retirement_api/templates/claiming.html +++ b/retirement_api/templates/retirement_api/claiming.html @@ -182,7 +182,7 @@

{% trans "About your early benefit claiming age:" %}<

- + {% trans "Where do these numbers come from?" %}

diff --git a/retirement_api/templates/standalone/base_update.html b/retirement_api/templates/retirement_api/standalone/base_update.html similarity index 100% rename from retirement_api/templates/standalone/base_update.html rename to retirement_api/templates/retirement_api/standalone/base_update.html diff --git a/retirement_api/templates/standalone/share_box.html b/retirement_api/templates/retirement_api/standalone/share_box.html similarity index 100% rename from retirement_api/templates/standalone/share_box.html rename to retirement_api/templates/retirement_api/standalone/share_box.html diff --git a/retirement_api/templates/standalone/share_links.html b/retirement_api/templates/retirement_api/standalone/share_links.html similarity index 100% rename from retirement_api/templates/standalone/share_links.html rename to retirement_api/templates/retirement_api/standalone/share_links.html diff --git a/retirement_api/templates/standalone/on-demand/footer.html b/retirement_api/templates/standalone/on-demand/footer.html deleted file mode 100644 index cb9f855..0000000 --- a/retirement_api/templates/standalone/on-demand/footer.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - diff --git a/retirement_api/templates/standalone/share_block.html b/retirement_api/templates/standalone/share_block.html deleted file mode 100644 index b7e4834..0000000 --- a/retirement_api/templates/standalone/share_block.html +++ /dev/null @@ -1,3 +0,0 @@ -
- {% include "standalone/share_links.html" %} -
diff --git a/retirement_api/tests/test_views.py b/retirement_api/tests/test_views.py index 2f68858..b1c2e1f 100644 --- a/retirement_api/tests/test_views.py +++ b/retirement_api/tests/test_views.py @@ -5,23 +5,13 @@ import mock -from django.test import Client from django.core.urlresolvers import reverse from django.shortcuts import render_to_response from django.template import RequestContext from django.test import TestCase # import unittest from django.http import HttpRequest -from django.conf import settings -client = Client() -# if __name__ == '__main__': -# BASE_DIR = '~/Projects/retirement1.6/retirement/retirement_api' -# else: -# BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(__file__))) -BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(__file__))) -sys.path.append(BASE_DIR) -os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings") from retirement_api.views import (param_check, income_check, @@ -62,11 +52,11 @@ class ViewTests(TestCase): return_keys = ['data', 'error'] def test_base_view(self): - url = reverse('claiming') - response = client.get(url) + url = reverse('retirement_api:claiming') + response = self.client.get(url) self.assertTrue(response.status_code == 200) - url = reverse('claiming_es') - response = client.get(url) + url = reverse('retirement_api:claiming_es') + response = self.client.get(url) self.assertTrue(response.status_code == 200) def test_param_check(self): @@ -141,9 +131,9 @@ def test_estimator_query_data_bad_income(self): self.assertTrue(response.status_code == 400) def test_about_pages(self): - url = reverse('retirement_about') - response = client.get(url) + url = reverse('retirement_api:about') + response = self.client.get(url) self.assertTrue(response.status_code == 200) - url = reverse('retirement_about_es', kwargs={'language': 'es'}) - response = client.get(url) + url = reverse('retirement_api:about_es', kwargs={'language': 'es'}) + response = self.client.get(url) self.assertTrue(response.status_code == 200) diff --git a/retirement_api/tests/urls.py b/retirement_api/tests/urls.py new file mode 100644 index 0000000..41a89bd --- /dev/null +++ b/retirement_api/tests/urls.py @@ -0,0 +1,10 @@ +from django.conf.urls import include, url +from django.contrib import admin + +import retirement_api.urls + + +urlpatterns = [ + url(r'^', include(retirement_api.urls, 'retirement_api')), + url(r'^admin/', include(admin.site.urls)), +] diff --git a/retirement_api/urls.py b/retirement_api/urls.py index 53763dd..d55e344 100644 --- a/retirement_api/urls.py +++ b/retirement_api/urls.py @@ -1,44 +1,19 @@ -from django.conf.urls import patterns, include, url -from django.conf import settings -from django.contrib import admin +from django.conf.urls import url + +from retirement_api.views import about, claiming, estimator + + +app_name = 'retirement_api' -try: - STANDALONE = settings.STANDALONE -except AttributeError: # pragma: no cover - STANDALONE = False urlpatterns = [ - url(r'^before-you-claim/about/$', 'retirement_api.views.about', - name='retirement_about'), - url(r'^before-you-claim/about/es/$', 'retirement_api.views.about', - {'language': 'es'}, name='retirement_about_es'), - url(r'^before-you-claim/$', 'retirement_api.views.claiming', - name='claiming'), - url(r'^before-you-claim/es/$', 'retirement_api.views.claiming', - {'es': True}, name='claiming_es'), + url(r'^before-you-claim/about/$', about, name='about'), + url(r'^before-you-claim/about/es/$', about, {'language': 'es'}, + name='about_es'), + url(r'^before-you-claim/$', claiming, name='claiming'), + url(r'^before-you-claim/es/$', claiming, {'es': True}, name='claiming_es'), url(r'^retirement-api/estimator/(?P[^/]+)/(?P\d+)/$', - 'retirement_api.views.estimator', name='estimator'), + estimator, name='estimator'), url(r'^retirement-api/estimator/(?P[^/]+)/(?P\d+)/es/$', - 'retirement_api.views.estimator', - {'language': 'es'}, name='estimator_es'), - ] - -if STANDALONE: - admin.autodiscover() - urlpatterns = [ - url(r'^retirement/admin/', include(admin.site.urls)), - url(r'^retirement/before-you-claim/about/$', - 'retirement_api.views.about', name='retirement_about'), - url(r'^retirement/before-you-claim/about/es/$', - 'retirement_api.views.about', - {'language': 'es'}, name='retirement_about_es'), - url(r'^retirement/before-you-claim/$', - 'retirement_api.views.claiming', name='claiming'), - url(r'^retirement/before-you-claim/es/$', - 'retirement_api.views.claiming', {'es': True}, name='claiming_es'), - url(r'^retirement/retirement-api/estimator/(?P[^/]+)/(?P\d+)/$', - 'retirement_api.views.estimator', name='estimator'), - url(r'^retirement/retirement-api/estimator/(?P[^/]+)/(?P\d+)/es/$', - 'retirement_api.views.estimator', - {'language': 'es'}, name='estimator_es'), - ] + estimator, {'language': 'es'}, name='estimator_es'), +] diff --git a/retirement_api/views.py b/retirement_api/views.py index a184f8f..d2871b9 100644 --- a/retirement_api/views.py +++ b/retirement_api/views.py @@ -2,7 +2,7 @@ import json from django.conf import settings -from django.shortcuts import render_to_response +from django.shortcuts import render from django.http import HttpResponse, HttpResponseBadRequest from .utils.ss_calculator import get_retire_data from .utils.ss_utilities import get_retirement_age @@ -16,7 +16,7 @@ standalone = getattr(settings, 'STANDALONE', False) if standalone: - base_template = "standalone/base_update.html" + base_template = "retirement_api/standalone/base_update.html" else: # pragma: no cover base_template = "front/base_update.html" @@ -39,6 +39,7 @@ def claiming(request, es=False): final_steps = {} for step in Step.objects.filter(title__contains='final_'): final_steps[step.title] = step + cdict = { 'tstamp': datetime.datetime.now(), 'final_steps': final_steps, @@ -49,8 +50,10 @@ def claiming(request, es=False): 'base_template': base_template, 'available_languages': ['en', 'es'], 'es': es, - } - return render_to_response('claiming.html', cdict) + 'about_view_name': 'retirement_api:' + ('about_es' if es else 'about'), + } + + return render(request, 'retirement_api/claiming.html', cdict) def param_check(request, param): @@ -135,4 +138,4 @@ def about(request, language='en'): 'available_languages': ['en', 'es'], 'es': es } - return render_to_response('about.html', cdict) + return render(request, 'retirement_api/about.html', cdict) diff --git a/setup.py b/setup.py index 6a7af23..ff56898 100644 --- a/setup.py +++ b/setup.py @@ -2,6 +2,30 @@ from setuptools import setup + +install_requires = [ + 'beautifulsoup4==4.3.2', + 'Django>=1.8,<1.12', + 'django-filter==0.9.2', + 'dj-database-url==0.4.2', + 'python-dateutil==2.2', + 'requests==2.9.1', + 'six==1.9.0', +] + + +setup_requires=[ + 'cfgov-setup==1.2', + 'setuptools-git-version==1.0.3', +] + + +testing_extras = [ + 'coverage==4.2', + 'mock==1.0.1', +] + + def read_file(filename): """Read a file into a string""" path = os.path.abspath(os.path.dirname(__file__)) @@ -34,7 +58,10 @@ def read_file(filename): ], long_description=read_file('README.md'), zip_safe=False, - setup_requires=['cfgov-setup==1.2', 'setuptools-git-version==1.0.3'], - frontend_build_script='frontendbuild.sh', - + install_requires=install_requires, + setup_requires=setup_requires, + extras_require={ + 'testing': testing_extras, + }, + frontend_build_script='frontendbuild.sh' ) diff --git a/src/js/wizards/fetch-api-data.js b/src/js/wizards/fetch-api-data.js index d206b80..9548c99 100644 --- a/src/js/wizards/fetch-api-data.js +++ b/src/js/wizards/fetch-api-data.js @@ -7,10 +7,10 @@ const fetch = { apiData: function( birthdate, salary, dataLang ) { let url; if ( dataLang === 'es' ) { - url = '/retirement/retirement-api/estimator/' + + url = '../../retirement-api/estimator/' + birthdate + '/' + Number( salary ) + '/es/'; } else { - url = '/retirement/retirement-api/estimator/' + + url = '../retirement-api/estimator/' + birthdate + '/' + Number( salary ) + '/'; } diff --git a/test_settings.py b/test_settings.py index f3710a4..d708e5e 100755 --- a/test_settings.py +++ b/test_settings.py @@ -15,14 +15,8 @@ DEBUG = True -TEMPLATE_DEBUG = True - ALLOWED_HOSTS = [] -TEMPLATE_DIRS = ( - '%s/retirement_api/templates' % BASE_DIR, -) - # Application definition INSTALLED_APPS = ( @@ -45,7 +39,7 @@ 'django.middleware.clickjacking.XFrameOptionsMiddleware', ) -ROOT_URLCONF = 'retirement_api.urls' +ROOT_URLCONF = 'retirement_api.tests.urls' DATABASES = { 'default': { @@ -69,3 +63,18 @@ STATIC_URL = '/static/' STATIC_ROOT = '%s/retirement_api/static/' % BASE_DIR + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..9dc20a4 --- /dev/null +++ b/tox.ini @@ -0,0 +1,14 @@ +[tox] +skipsdist=True +envlist=py{27}-dj{18,111} + +[testenv] +install_command=pip install -e ".[testing]" -U {opts} {packages} +commands= + coverage erase + coverage run ./manage.py test {posargs} + coverage report + +deps= + dj18: Django>=1.8,<1.9 + dj111: Django>=1.11,<1.12