Implement an Outbook Django Model

[mikelane]

Sisters of the Road Outbook

Description

Sisters is a safe space and is dedicated to maintaning a violence-free, respectful, and dignified environment in the cafe. If a customer violates the house rules, they can be put on an "out", meaning they are not invited to the cafe for some period of time. This duration is determined through a conversation with the customer and sisters staff.

We'd eventually like to be able to support the outbook for Sisters of the Road. We'd like to be able to allow the POS app to know if a client is currently out and we'd like to make it easy for SotR to generate the various reports that they are required to make.

Requirements

Outbook Events

• New django model with a name OutbookEvents
• barter account: A required Foreign key field to a barter account (establishing the many-to-one relation).
• out start date: A required date field
• out end date: A required date field
• reason: An optional text field
• Set the default ordering of the model to be by the out end date in descending order
• Custom manager method is_barter_account_out that takes a BarterAccount object and returns a bool makes it easy to determine if a given barter account is currently out
• Custom manager method get_barter_account_out_reason that takes a BarterAccount object and returns a str that makes it easy to see why a given barter account is currently out

BarterAccount Model changes

• add BarterAccount method add_out_event that adds an event to the outbook for this barter account
• add @property named is_out to BarterAccount that takes no parameters and returns a bool that uses self in the is_barter_account_out custom manager method
• add @property named out_reason to BarterAccount that takes no parameters and returns an optional str that uses self to call the get_barter_account_out_reason method.

Tests

• Tests for the outbook events custom model manager methods and the sorting (depends on Use DRF for the REST responses #113)

Notes:

• Feel free to pair with @mikelane on any of this.
• The barter account field must have an on_delete parameter set since we are using django 2.
• It makes it easy to do reverse relations if you provide a related_name parameter to the foreign key field, too
• Django Many-to-one relationships
• Django adding extra manager methods
• Django default ordering

Testing

Implement the following if the new testing system gets released before this work is done. Please feel free to pair with @mikelane for help on this.

• It'd be nice to use the upcoming testing system for the tests, if possible. Mike is happy to pair with you on this.
• It'd also be nice to create a model factory to facilitate the creation of outbook events
• It'd also be nice to create functionality to optionally add outbook events in the barter account factory

[trezp]

Hello! I learned about this project at a PyLadies meetup quite a while ago and have been wanting to contribute. Can I start working on this issue? Is this the best place to ask questions, and is the python-for-good slack channel still active? I wasn't able to join it (it said "token revoked"). Thanks :)

[jarrighi]

Awesome, Treasure! This is a great case to work on. Let us know if you need anything and I'll try to respond quicker next time.