Admin extensions #185

mjumbewu · 2015-04-21T16:02:36Z

This should close issue #162 (organizational changes through the admin) and #173 (export affordance).

Some things to be aware of:

The schema changed. There is a more explicit relationship between users and departments. Previously, users had a string field representing any department they were primary or backup contact for. Now that relationship is represented by primary key fields on departments to users.
Adding relationships between users and departments in the admin requires that both be created first.
The "export affordance" is really simple; a link.

The admin page currently uses the fields that are used in the `STAFF_URL` CSV file: Name (alias), Email, Department, and Phone Number (phone). Also, the `is_staff` field is exposed so that administrators can see all users (like the non-staff liasons).

…ctly

Allow unrestricted access to the admin views

In a recent commit, I added the ability to administer system users through the web interface. This commit allows the same for departments. * Add `primary_contact_id` and `backup_contact_id` fields to the `Department` model, so that the Flask admin extension can reason about the relationship. * Change the `department_id` field to use `use_alter` flag, so that the user table and the department table can both be created without a circular dependency error. This commit does introduce changes that make upgrades difficult; the effort in creating migrations isn't worth it.

When a user first goes to create a department, they have empty lists for both primary and backup contact options. We want the user to know that the contacts correspond to system users.

I changed the foreign key on a `User` referring to a `Department` from *department* to *department_id*. This commit updates various references to the field.

* Update the version of Flask-Admin from 1.0.6 to 1.0.9. The latest provides more options for overriding template blocks. * Add an export link in to the menu_links template block.

* Add a "Content-disposition" header that designates the file as a downloadable attachment. * Add a default file name ("records.csv"), and take an optional query string argument (`filename`) to set a different file name.

waltz · 2015-04-21T16:08:51Z

I'm not super active on this project and I'm not in a place to merge this, but I want to give a huge thumbs up 👍 to active work on this project.

The string representation just refers to the underlying *user* instance. This may introduce another query for each displayed owner and subscriber, unless the *user* instances are pre-joined.

Always join the `user` attribute when loading owners and subscribers to avoid the situation described in commit #52c370b

It is a legal requirement that record request receipts not be post-dated. This change enforces that within the Record admin pages

- Add javascript validators for the form - Add simple value validation on the server, just in case something gets past the javascript validation This commit along with commit fed1b92 should close issue #178.

Used to return `False` no matter what. Now returns `True` in the appropriate cases.

richaagarwal · 2015-05-05T00:22:45Z

@mjumbewu Thanks for this work! I pulled the branch down locally and noticed that the /view_requests page doesn't load (in addition to 8 test failures) -- is this still a WIP?

mjumbewu · 2015-05-05T21:04:40Z

@richaagarwal The /view_requests route loads fine for me. What does it look like to you? 404? 500? Blank screen?

And yeah, I'm still looking into those failing tests.

richaagarwal · 2015-05-07T16:13:31Z

@mjumbewu Woops, had to start with a fresh database, my bad -- /view_requests is all good.

richaagarwal · 2015-05-07T16:41:18Z

public_records_portal/models.py

@@ -31,14 +31,17 @@ class User(db.Model):
 	phone = db.Column(db.String())
 	date_created = db.Column(db.DateTime)
 	password = db.Column(db.String(255))
-	department = db.Column(Integer, ForeignKey("department.id"))
-	current_department = relationship("Department", foreign_keys = [department], uselist = False)
+	department_id = db.Column(Integer, ForeignKey("department.id", use_alter=True, name="fk_department"))


Is it necessary to do this renaming? If so, a migration would be helpful.

The Flask login extension allows disabling login with either the `LOGIN_DISABLED` or the `TESTING` variable. Loading the former as we were doing conflicted with `login_required`'s default behavior.

Also changed the *alembic/env.py* file to use the `SQLALCHEMY_DATABASE_URI` from the app config, as that's where the `DATABASE_URL` from the environment is stored. foreman run alembic upgrade head

Addresses issue #176, "force responder to select a reason when submitting a letter of extension".

This, along with commits 7a9b0ac and 9c420e7 should at least partially resolve issue #172 as I undersand it. I think the problem is that the requested dates weren't being displayed, even though they were stored in the database. There is another side to the story: The due_date may still report a premature overdue status, because it's set relative to the date_created. The set_due_date method is going to have to become smarter to take into account the time of day that the request was made. For now, displaying the time at least allows users to spot check whether the request is ACTUALLY overdue.

Admin extensions

Bugfix/OP-1063: Fix to Unformatted Date in Add File Email

mjumbewu added 18 commits April 9, 2015 16:33

Whitespace

2e202fe

Simplify the UsersView by using the current_department field dire…

a3b3521

…ctly

Correct a typo: change UsersView to UserView

ea41796

Whitespace

296d37b

Get rid of unused import, contextfunction

ffc6b67

UNDO THIS COMMIT!

1043701

Allow unrestricted access to the admin views

Add better column labels to the user admin page

178fe0c

Explain that contacts are just users

86e1480

When a user first goes to create a department, they have empty lists for both primary and backup contact options. We want the user to know that the contacts correspond to system users.

Whitespace

fddf0c0

Update User.department_id field references

ed8ca98

I changed the foreign key on a `User` referring to a `Department` from *department* to *department_id*. This commit updates various references to the field.

Whitespace

c927f35

Undoing commit 1043701

2bb599b

Add a link in the admin to export request data

61f731e

* Update the version of Flask-Admin from 1.0.6 to 1.0.9. The latest provides more options for overriding template blocks. * Add an export link in to the menu_links template block.

Allow disabling @login_required via environment var

02f5f9d

Give the records export data a filename

9ee1feb

* Add a "Content-disposition" header that designates the file as a downloadable attachment. * Add a default file name ("records.csv"), and take an optional query string argument (`filename`) to set a different file name.

Whitespace

82bbefb

mjumbewu added 5 commits April 27, 2015 13:24

Add a pretty string representation for owners and subscribers

52c370b

The string representation just refers to the underlying *user* instance. This may introduce another query for each displayed owner and subscriber, unless the *user* instances are pre-joined.

Use eager loading of owners and subscribers

8811121

Always join the `user` attribute when loading owners and subscribers to avoid the situation described in commit #52c370b

Add post-date protection to admin

fed1b92

It is a legal requirement that record request receipts not be post-dated. This change enforces that within the Record admin pages

Whitespace

45384c0

Add post date protection to the main UI

af60797

- Add javascript validators for the form - Add simple value validation on the server, just in case something gets past the javascript validation This commit along with commit fed1b92 should close issue #178.

mjumbewu force-pushed the admin-extensions branch from bd09c6f to af60797 Compare April 27, 2015 20:26

Correct the is_supported_browser method

27745b8

Used to return `False` no matter what. Now returns `True` in the appropriate cases.

richaagarwal reviewed May 7, 2015
View reviewed changes

mjumbewu added 6 commits May 7, 2015 10:30

Remove LOGIN_DISABLED environment setting

5851abe

The Flask login extension allows disabling login with either the `LOGIN_DISABLED` or the `TESTING` variable. Loading the former as we were doing conflicted with `login_required`'s default behavior.

Add an alembic migration for the User and Deparment models

8256dcc

Also changed the *alembic/env.py* file to use the `SQLALCHEMY_DATABASE_URI` from the app config, as that's where the `DATABASE_URL` from the environment is stored. foreman run alembic upgrade head

Require an extension reason before submitting

5599ac1

Addresses issue #176, "force responder to select a reason when submitting a letter of extension".

Convert the Request.date_created column to UTC

7a9b0ac

Show the requested time with on the case template

9c420e7

Whitespace

89cd96f

mjumbewu force-pushed the admin-extensions branch from fd4806e to 527af33 Compare May 20, 2015 03:48

mjumbewu force-pushed the admin-extensions branch from 527af33 to ef33cd7 Compare May 20, 2015 03:50

This was referenced May 20, 2015

force responder to select a reason when submitting a letter of extension #176

Open

don't allow postdating a manually entered "date received" #178

Open

richaagarwal added a commit that referenced this pull request Aug 14, 2015

Merge pull request #185 from codeforamerica/admin-extensions

03958e0

Admin extensions

richaagarwal merged commit 03958e0 into master Aug 14, 2015

richaagarwal deleted the admin-extensions branch September 16, 2015 06:52

joelbcastillo referenced this pull request in CityOfNewYork/NYCOpenRecords Mar 2, 2017

Merge pull request #185 from joelbcastillo/bugfix/OP-1063

08b0357

Bugfix/OP-1063: Fix to Unformatted Date in Add File Email

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Admin extensions #185

Admin extensions #185

mjumbewu commented Apr 21, 2015

waltz commented Apr 21, 2015

richaagarwal commented May 5, 2015

mjumbewu commented May 5, 2015

richaagarwal commented May 7, 2015

richaagarwal May 7, 2015

Admin extensions #185

Admin extensions #185

Conversation

mjumbewu commented Apr 21, 2015

waltz commented Apr 21, 2015

richaagarwal commented May 5, 2015

mjumbewu commented May 5, 2015

richaagarwal commented May 7, 2015

richaagarwal May 7, 2015

Choose a reason for hiding this comment