CareersBlock for Resource Page template sections streamblock(USAJobs API) #799

johnnyporkchops · 2017-02-03T06:43:37Z

This block allows one to add a list of all open FEC jobs in the Resource Page template using a streamfield static block. To be used in creating the /about/careers page. The list is real-time and will always be up to date upon page load. Below is a screenshot of careers page made with the Resource Page template and this new block.

In the final page, It shows current openings if there are any, otherwise in shows "check back later" language. (The query is currently querying the PeaceCorps ("Organization":"PU00") for demo purposes since we have no open jobs, will switch to FEC (LF00) in production.

Files:
home/templatetags/open_jobs.py
home/templates/block/careers.html
home/templates/partials/jobs.html
home/blocks.py

This uses home/templatetags/open_jobs.py to register an inclusion for jobs.html partial and query the USAJobs API

A block definition for CareersBlock is added to the streamfield definition for ResourceBlock that is available in the editing interface on Resource Page template. (The best part is I could add this without having to alter any models or makemigrations :-)

Related issues:
https://github.com/18F/fec-cms/issues/769
https://github.com/18F/fec-cms/issues/678

Similar PR:
https://github.com/18F/fec-cms/pull/735

Below is a screenshot of careers page made using this new streamfield block inside Resource Page template:

codecov-io · 2017-02-03T06:49:00Z

Codecov Report

❗ No coverage uploaded for pull request base (release/public-beta-20170216@ee94384). Click here to learn what that means.
The diff coverage is 37.93%.

@@                       Coverage Diff                       @@
##             release/public-beta-20170216     #799   +/-   ##
===============================================================
  Coverage                                ?   63.11%           
===============================================================
  Files                                   ?      124           
  Lines                                   ?     2700           
  Branches                                ?      208           
===============================================================
  Hits                                    ?     1704           
  Misses                                  ?      988           
  Partials                                ?        8

Impacted Files	Coverage Δ
fec/fec/urls.py	`58.82% <ø> (ø)`
fec/home/templatetags/open_jobs.py	`0% <ø> (ø)`
fec/fec/settings/base.py	`79.24% <100%> (ø)`
fec/home/blocks.py	`100% <100%> (ø)`
fec/home/migrations/0061_merge_20170210_2230.py	`100% <100%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ee94384...bd3294d. Read the comment docs.

noahmanger

Works great. Just caught a few small things. Nice work!

noahmanger · 2017-02-08T01:34:11Z

fec/fec/urls.py

@@ -22,7 +22,7 @@
    url(r'^documents/', include(wagtaildocs_urls)),
    url(r'^search/$', search_views.search, name='search'),
    url(r'^updates/$', home_views.updates),
-
+   


You should be able to add a preference to your text editor to strip out extraneous whitespace like this. Not a big deal, but will result in fewer false diffs.

noahmanger · 2017-02-08T01:35:07Z

fec/home/templates/partials/jobs.html

@@ -0,0 +1,17 @@
+{% load wagtailcore_tags %}
+<section class="slab  slab--neutral" style="padding:1rem">


We try to avoid inline styles. Does the default padding on the .slab class not work?

noahmanger · 2017-02-08T01:35:43Z

fec/home/templates/partials/jobs.html

+    </ul>
+  </li><br>
+  {% empty %}
+  <p>There are currently no open positions available. Please check back on this page or Job Announcements on <a href='https://www.usajobs.gov/' title='USAJobs website'>USAJOBs</a> for the latest FEC Vacancy Announcements.")</p>


<p> should be outside the <ul>

noahmanger · 2017-02-08T01:36:24Z

fec/home/templatetags/open_jobs.py

+
+@register.inclusion_tag('partials/jobs.html')
+def get_jobs():
+    from django.http import HttpResponse


Imports should be at the top of the file.

noahmanger · 2017-02-08T01:37:01Z

fec/home/templatetags/open_jobs.py

+    querystring = {"Organization":"PU00","WhoMayApply":"All"}
+
+    headers = {
+        'authorization-key': "ZQbNd1iLrQ+rPN3Rj2Q9gDy2Qpi/3haXSXGuHbP1SRk=",


Is this key private? If so, it shouldn't be checked in and should instead be set as a secret env var (and should probably be replaced now if it is supposed to be private).

I am waiting to hear back from USAjobs API support regarding a ticket I submitted to resolve this.

in prep for pen testing

johnnyporkchops · 2017-02-10T22:25:28Z

The USAJobs API key has been deactivated and removed from checked-in code. A new key will be set as an environmental variable using "create-user-provided-service (cups)" on the next push.
Other requested edits have been made.

The previous two hotfixes seem to have gotten in the way of this latest migration, so this changeset fixes them and sets things straight again.

noahmanger · 2017-02-11T00:11:43Z

Cool. You'll just need to also add the env var lookup to base.py (like https://github.com/18F/fec-cms/pull/755/files#diff-5593e913baa39c1a426336cbe3e0af6dR189)

make staging use the umbrella

noahmanger · 2017-02-14T18:27:12Z

@johnnyporkchops do you know if you'll be able to finish this up today? I'd like to get it merged in if possible.

johnnyporkchops · 2017-02-14T18:56:26Z

Yes, I will update shortly

Fixes migrations in CMS develop branch

johnnyporkchops · 2017-02-14T23:04:28Z

--@ccostino added the API Key as a sensitive env var to CF using UUPS. I have referenced it in fec/settings/base.py and as a variable in home/templatetags/open_jobs.py.

--There are no open FEC jobs, so it will show the alt language. If we want see a job list for presentation/testing purposes, one could temporarily change line #14 in open_jobs.py to read "Organization":"HS" (homeland security has open jobs)(FEC is LF00)

Please let me know of any changes, I will make them ASAP

johnnyporkchops · 2017-02-14T23:13:01Z

Let me know if I can also build the about/careers page when this is merged in.

… into feature/usa-jobs-templatetag

noahmanger · 2017-02-15T01:08:19Z

fec/home/templates/partials/jobs.html

+      <li>
+      <h3><a href="{{ j.PositionURI }}">{{ j.PositionID }} , {{ j.PositionTitle}}</a></h3>
+        <ul class="u-padding--bottom">
+          <li class='t-sans'><strong>Open Period:</strong> {{ j.PositionStartDate }} - {{ j.PositionEndDate }}</li>


Super small thing, but prefer double quotes for attributes in HTML. Also, you can just put .t-sans on the parent element, I believe.

noahmanger · 2017-02-15T01:10:30Z

fec/home/templatetags/open_jobs.py

+    jobData = []
+    for i in responses['SearchResult']['SearchResultItems']:
+        x= {}
+        x = { "PositionTitle": i["MatchedObjectDescriptor"]["PositionTitle"] , 


A few small formatting things:

Each item should be on a new line (PositionURI is on the same line as PositionID)

Key names should be lower case and use underscores instead of camelCase

noahmanger · 2017-02-15T01:12:05Z

Looking great. Just had a few small code style comments.

johnnyporkchops added 8 commits January 28, 2017 23:29

committing usajobs app and base/settings.py to register app

383ff65

usajobs/templates/fec_jobs_list.html

6dcfe03

deleted unused files

2b8f510

removed unused app on INSATALLED APPS in base.py

0b0c5f1

removed unused url definition and import statement

20ea464

Merge remote-tracking branch 'origin' into feature/usa-jobs-templatetag

0d034eb

added careers blocks and templatetag

1c0eea3

restored fec/urls.py to match original on dev

218c1e2

johnnyporkchops added the Please review label Feb 3, 2017

updated open_jobs.py, needed Positio URI variable

fbcb9db

johnnyporkchops mentioned this pull request Feb 7, 2017

Create careers page content and implement USAJobs query #785

Closed

noahmanger suggested changes Feb 8, 2017

View reviewed changes

noahmanger self-assigned this Feb 9, 2017

LindsayYoung and others added 2 commits February 9, 2017 15:48

make staging use the umbrella

388dca2

in prep for pen testing

removed API key did other requested edits

2ef91aa

Fixes migrations in CMS develop branch

5336bc8

The previous two hotfixes seem to have gotten in the way of this latest migration, so this changeset fixes them and sets things straight again.

Merge pull request #807 from 18F/feature/new-api-url

32bec7a

make staging use the umbrella

noahmanger added the Before release label Feb 14, 2017

Noah Manger and others added 2 commits February 14, 2017 13:09

Merge pull request #811 from 18F/bug/fix-table-migration

c6c55b9

Fixes migrations in CMS develop branch

set API key as sensitive env var using UUPS in CF

c02b731

johnnyporkchops and others added 3 commits February 14, 2017 18:26

Merge branch 'develop' into feature/usa-jobs-templatetag

271d313

padding to bottom of job entries

9982536

Merge branch 'feature/usa-jobs-templatetag' of github.com:18F/fec-cms…

3cb9078

… into feature/usa-jobs-templatetag

fixed UL nesting...again

fdd9724

noahmanger approved these changes Feb 15, 2017

View reviewed changes

noahmanger changed the base branch from develop to release/public-beta-20170216 February 15, 2017 01:07

noahmanger reviewed Feb 15, 2017

View reviewed changes

johnnyporkchops added 2 commits February 14, 2017 20:38

requested edits to Python

8556ce1

missed on lowercase change

bd3294d

noahmanger merged commit 92d646f into release/public-beta-20170216 Feb 15, 2017

noahmanger deleted the feature/usa-jobs-templatetag branch February 15, 2017 01:49

noahmanger mentioned this pull request Feb 15, 2017

Query USAJobs API to populate list on about/careers #769

Closed

2 tasks

LindsayYoung unassigned noahmanger Mar 9, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CareersBlock for Resource Page template sections streamblock(USAJobs API) #799

CareersBlock for Resource Page template sections streamblock(USAJobs API) #799

johnnyporkchops commented Feb 3, 2017 •

edited

Loading

codecov-io commented Feb 3, 2017 •

edited

Loading

noahmanger left a comment

noahmanger Feb 8, 2017

noahmanger Feb 8, 2017

noahmanger Feb 8, 2017

noahmanger Feb 8, 2017

noahmanger Feb 8, 2017

johnnyporkchops Feb 8, 2017

johnnyporkchops commented Feb 10, 2017

noahmanger commented Feb 11, 2017

noahmanger commented Feb 14, 2017

johnnyporkchops commented Feb 14, 2017

johnnyporkchops commented Feb 14, 2017

johnnyporkchops commented Feb 14, 2017

noahmanger Feb 15, 2017

noahmanger Feb 15, 2017

noahmanger commented Feb 15, 2017

		@@ -0,0 +1,17 @@
		{% load wagtailcore_tags %}
		<section class="slab slab--neutral" style="padding:1rem">

CareersBlock for Resource Page template sections streamblock(USAJobs API) #799

CareersBlock for Resource Page template sections streamblock(USAJobs API) #799

Conversation

johnnyporkchops commented Feb 3, 2017 • edited Loading

codecov-io commented Feb 3, 2017 • edited Loading

Codecov Report

noahmanger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnnyporkchops commented Feb 10, 2017

noahmanger commented Feb 11, 2017

noahmanger commented Feb 14, 2017

johnnyporkchops commented Feb 14, 2017

johnnyporkchops commented Feb 14, 2017

johnnyporkchops commented Feb 14, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

noahmanger commented Feb 15, 2017

johnnyporkchops commented Feb 3, 2017 •

edited

Loading

codecov-io commented Feb 3, 2017 •

edited

Loading