code doctor test

.gitignore

@@ -1,2 +1,9 @@
+.idea/
+.pytest_cache/
+.tox/
 *.py[cod]
+Activate.ps1
 db.sqlite3
+public/media/
+public/static/
+venv/

.travis.yml

@@ -0,0 +1,8 @@
+language: python
+python:
+  - "3.6"
+install:
+  - pip install pip-tools
+  - pip-sync
+script:
+  - pytest -vv -s payshare/purchases/tests.py

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Christoph Buelter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,120 @@
+# Payshare
+
+A web app to track shared expenses in a group of people.
+
+[![Build Status](https://travis-ci.com/cb109/payshare.svg?branch=develop)](https://travis-ci.com/cb109/payshare)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/6a111b89f4464f3bb5eb69f08fad568e)](https://www.codacy.com/manual/cb109/payshare?utm_source=github.com&utm_medium=referral&utm_content=cb109/payshare&utm_campaign=Badge_Grade)
+
+Payshare is the equivalent of a whiteboard in the kitchen of your shared flat where everyone writes down how much he paid for groceries, who paid the cinema ticket or pizza for whom and so on, while it does the math for you to figure out who should buy the next round.
+
+## Demo
+
+You can login using the password `demo` [here](https://payshare.cbuelter.de/28d7c6ad-9548-45d6-b023-b8e3b0950a44).
+
+## License
+
+**MIT**, see [LICENSE.txt](LICENSE.txt)
+
+## Screenshots
+
+![](docs/transfers.png) ![](docs/ranking.png)
+
+![](docs/cashup.png) ![](docs/newoutlay.png)
+
+## Terminology
+
+- `Collective`: This is basically your shared flat, sports team, whatever
+- `User`: A person that can be a member of one or more Collectives
+- `Membership`: The connection of a User to a Collective
+- ` Purchase`: A User bought something and the cost is shared equally in the Collective
+- ` Liquidation` (named "Outlay" in the frontend): Some User gave money to another one and that debt will have to be paid back later
+
+## Development Setup
+
+If you want to setup and run the project yourself, follow these steps (assuming you are on a Unix OS):
+
+### Backend
+
+- Make sure you have Python 3.x installed
+- Clone the project and `cd` into its root directory
+- `$ virtualenv venv`
+- `$ source venv/bin/activate`
+- `$ pip install pip-tools`
+- `$ pip-sync`
+- `$ python manage.py migrate`
+- `$ python manage.py createsuperuser`
+- `$ python manage.py runserver`
+
+### Frontend
+
+Make sure to have ` npm` or ` yarn` installed globally
+
+- `$ cd payshare/purchases/static/client`
+- `$ yarn`/ `$ npm install`
+- `$ npm run serve`
+
+### Creating initial Data
+
+The project currently relies on the Django admin pages to create new Collectives and Users and add  Memberships between them.
+
+Assuming your Django dev-server is running at the default port, go to:
+
+[https://localhost:8000/admin](https://localhost:8000/admin)
+
+- Create a Collective and set a password for it
+- Create some Users (`username` is the only field that is displayed. Django requires us to set a password here, but you can just give any, it isn't used)
+- Create Memberships for those Users in your Collective
+
+The URL for your collective will be e.g. `http://localhost:8000/<collective-key>`. You can get the key from the admin pages. Send the URL (and the Collective's password of course) to everyone you want to participate, they will be asked to choose a User when logging in for the first time.
+
+You can also assign an avatar for each user by assigning some URL to a hosted image (there is no own upload feature, sorry). You can do that in the ` User profiles` area in the admin pages. There are many avatar generators, I like these:
+
+- [https://getavataaars.com](https://getavataaars.com/)
+- [http://avatars.adorable.io](http://avatars.adorable.io/)
+- [https://robohash.org](https://robohash.org/)
+
+## A Note about Security
+
+The whiteboard metaphor is valid: Anyone with a "key" to your flat (aka password for the Collective) can create and delete content or impersonate other Users. It's based on trust between the people in the group.
+
+## Tech Stack
+
+Project is build with [Django](https://www.djangoproject.com/) 2.1, [Django-REST-Framework](http://www.django-rest-framework.org/) 3, Vue 2.5, [vue](https://vuejs.org/)-cli-3 and the wonderful [Vuetify](https://vuetifyjs.com/en/) 1.1.0. It is build mainly to be used on a mobile phone, but responsive and very usable on desktop as well. Technically it is a [PWA](https://developers.google.com/web/progressive-web-apps/), but right now that is only used to cache the app shell, not any API responses. Uses SQLite as its database, creating a single file for easy backup.
+
+## Deployment
+
+Oh the joy of deploying custom web apps to your own server. Our backend can be setup as a systemd service that runs a WSGI app via gunicorn, whereas the frontend is built into a bundle of static files that our nginx webserver can serve.
+
+### Building the Frontend
+
+- `$ cd payshare/purchases/static/client`
+- Update the `src/store.js` `apiBaseUrl` as needed, depending where your API lives on.
+- `$ npm run build`
+- ` $ cd -`
+- `$ python manage.py collectstatic --noinput`
+- Copy the results from `public` to a folder that your webserver knows, e.g. ` /var/www/payshare`
+- Configure your webserver and systemd, see below
+- Don't forget to install gunicorn: `$ pip install gunicorn`
+
+Please see the following files for examples on simple systemd and nginx configurations:
+
+- [payshare.service](payshare.service)
+- [payshare.conf](payshare.conf)
+
+Notes: We should use https in any case, but it is also a requirement for the service-worker. One specialty about location blocks here is that for some we'll want to pass through the URL path and for others we don't.
+
+### Image Hosting (e.g. avatars)
+
+You can upload images within the admin page using [Filer](https://django-filer.readthedocs.io/en/latest/index.html)
+which is particularly helpful to upload avatars to use within the UserProfile model.
+Any URLs that may have been used to create the avatar can be stored in the 'description'
+field of the image so it can be used later on.
+
+Images are hosted efficiently by making use of [Whitenoise](http://whitenoise.evans.io/en/stable/),
+so there is no need to configure your webserver for it in addition.
+
+### Paypal.me Integration
+
+Well, integration is a big word. You can set a paypal.me username in the profile
+of each User and the app will show a button on the cashup page to open a tab
+in the browser with the correct amount for that payback action.

build.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+workon payshare &&
+
+pip install pip-tools &&
+pip-sync &&
+
+cd payshare/purchases/static/client &&
+yarn install --check-files &&
+npm run build &&
+
+cd - &&
+python manage.py collectstatic --noinput
+
+echo "build finished"

payshare.conf

@@ -0,0 +1,26 @@
+server {
+  listen 443;
+  server_name payshare.com;
+
+  location ~ ^/(api|admin) {
+    # Make sure proxy is properly resolved via headers.
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+
+    # If we dont set this, https will make us run into a timeout.
+    # See: https://stackoverflow.com/questions/24453388
+    proxy_http_version 1.1;
+    proxy_set_header Connection "";
+
+    proxy_pass https://localhost:1234;
+  }
+
+  location /static {
+    root /var/www/payshare;
+  }
+
+  location / {
+    root /var/www/payshare/static;
+    error_page 404 =200 /index.html;
+  }
+}

payshare.service

@@ -0,0 +1,18 @@
+[Unit]
+Description=Payshare
+
+[Service]
+User=root
+WorkingDirectory=/opt/payshare/
+ExecStart=/~/.virtualenvs/payshare/bin/gunicorn payshare.wsgi:application \
+          --workers 2 \
+          --bind 127.0.0.1:1234 \
+          --log-level debug \
+          --certfile /etc/letsencrypt/live/payshare.com/fullchain.pem \
+          --keyfile /etc/letsencrypt/live/payshare.com/privkey.pem \
+          --access-logfile /var/log/payshare-access.log \
+          --error-logfile /var/log/payshare-error.log
+
+[Install]
+WantedBy=multi-user.target
+Alias=payshare.service

payshare/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.11.4"

payshare/purchases/admin.py

@@ -1,6 +1,147 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
-from django.contrib import admin
-
-# Register your models here.
+from django.contrib import admin
+from django.contrib.auth.models import User
+from django.urls import reverse
+from django.utils.safestring import mark_safe
+
+from payshare.purchases.models import Collective
+from payshare.purchases.models import Liquidation
+from payshare.purchases.models import Membership
+from payshare.purchases.models import Purchase
+from payshare.purchases.models import UserProfile
+
+
+class UserAdmin(admin.ModelAdmin):
+    list_display = (
+        "id",
+        "username",
+        "email",
+        "first_name",
+        "last_name",
+    )
+    list_editable = (
+        "username",
+        "email",
+        "first_name",
+        "last_name",
+    )
+    search_fields = ("username", "first_name", "last_name", "email", "id")
+
+
+class UserProfileAdmin(admin.ModelAdmin):
+    list_display = (
+        "user",
+        "avatar_image_url_link",
+        "avatar_image_url",
+        "paypal_me_username",
+        "id",
+    )
+    autocomplete_fields = ("user",)
+    list_editable = ("avatar_image_url",)
+
+    def avatar_image_url_link(self, profile):
+        image_url = profile.avatar_image_url
+        editor_url = ""
+        is_avataaars_url = image_url.startswith("https://avataaars.io")
+        if is_avataaars_url:
+            editor_url = image_url.replace(
+                "https://avataaars.io", "https://getavataaars.com"
+            )
+        template = """
+            <image src="{0}"
+                   style="max-width: 200px; max-height: 200px"/>
+        """
+        if is_avataaars_url:
+            template += """
+                <a href="{1}" target="blank_">
+                    Edit on https://getavataaars.com
+                </a>
+            """
+            html = template.format(image_url, editor_url)
+        else:
+            html = template.format(image_url)
+        return mark_safe(html)
+
+
+class CollectiveAdmin(admin.ModelAdmin):
+    class MembershipInline(admin.TabularInline):
+        model = Membership
+        autocomplete_fields = ("member",)
+
+        def get_queryset(self, request):
+            return (
+                super()
+                .get_queryset(request)
+                .order_by(
+                    "member__first_name",
+                    "member__last_name",
+                )
+            )
+
+    inlines = (MembershipInline,)
+
+    readonly_fields = ("key",)
+    list_display = (
+        "name",
+        "url",
+        "created_at",
+        "readonly",
+        "currency_symbol",
+        "id",
+    )
+    search_fields = ("name", "id")
+
+    @mark_safe
+    def url(self, collective):
+        url = reverse("app", args=[collective.key])
+        return f"<a href='{url}'>Visit in App: {collective.name}</a>"
+
+
+class PurchaseAdmin(admin.ModelAdmin):
+    list_display = ["name", "active", "price", "buyer", "id", "collective"]
+    list_filter = ("collective",)
+    autocomplete_fields = ("buyer", "collective")
+
+    def active(self, purchase):
+        return not purchase.deleted
+
+    active.boolean = True
+
+
+class LiquidationAdmin(admin.ModelAdmin):
+    list_display = [
+        "name",
+        "active",
+        "amount",
+        "creditor",
+        "debtor",
+        "id",
+        "collective",
+    ]
+    list_filter = ("collective",)
+    autocomplete_fields = ("creditor", "debtor", "collective")
+
+    def active(self, liquidation):
+        return not liquidation.deleted
+
+    active.boolean = True
+
+
+class MembershipAdmin(admin.ModelAdmin):
+    list_display = [
+        "collective",
+        "member",
+        "created_at",
+        "id",
+    ]
+    list_filter = ("collective",)
+    autocomplete_fields = ("member", "collective")
+
+
+admin.site.unregister(User)
+admin.site.register(User, UserAdmin)
+admin.site.register(UserProfile, UserProfileAdmin)
+
+admin.site.register(Collective, CollectiveAdmin)
+admin.site.register(Membership, MembershipAdmin)
+admin.site.register(Purchase, PurchaseAdmin)
+admin.site.register(Liquidation, LiquidationAdmin)