A system to share your appreciation
Clone or download
rockdog Merge pull request #54 from sjaensch/sjaensch-enable-console-more-log…
…ging

Enable the console as well as more verbose logging for development
Latest commit 0079abe Sep 10, 2018
Permalink
Failed to load latest commit information.
import Putting back files I've accidentaly deleted. Jul 28, 2017
logic Fixed test issues Apr 26, 2018
models fixing extraneous slash in love-link generation Aug 2, 2017
screenshots added screenshot for new LoveSent screen Jul 30, 2017
static Initial commit Feb 13, 2017
testing adding required tests for new love-link functionality Aug 1, 2017
tests Changes in api return format Apr 29, 2018
themes/default Handle the case that some of the users within a love link are unknown Sep 3, 2018
util Bump requirements Mar 10, 2017
views Add required parentheses for catching multiple exceptions Sep 3, 2018
.gitignore Add loveLink data model, /l endpoint Jul 27, 2017
.pre-commit-config.yaml Add detect-secrets hook & baseline Jul 10, 2018
.secrets.baseline Add detect-secrets hook & baseline Jul 10, 2018
.travis.yml Create config.py before running make test Feb 14, 2017
AUTHORS.md Update contributors Jul 11, 2018
CHANGELOG.md pre-commit run --all-files Feb 21, 2017
LICENSE Initial commit Feb 13, 2017
Makefile Enable the console as well as more verbose logging for development Sep 10, 2018
README.md howto for fixing gcloud app create error on README Jul 28, 2017
_config.yml Initial commit Feb 13, 2017
app.yaml Putting back files I've accidentaly deleted. Jul 28, 2017
appengine_config.py pre-commit run --all-files Feb 21, 2017
config-example.py flask debug mode can now easily be turned on with a setting in config.py Jul 30, 2017
cron.yaml.example removing cron.yaml and putting into example file for others to use Aug 1, 2017
departments.yaml Initial commit Feb 13, 2017
dispatch.yaml Initial commit Feb 13, 2017
errors.py first attempt at new facetile visuals Jul 28, 2017
index.yaml Initial commit Feb 13, 2017
main.py flask debug mode can now easily be turned on with a setting in config.py Jul 30, 2017
queue.yaml Initial commit Feb 13, 2017
requirements-dev.txt Bump requirements Mar 10, 2017
requirements.txt Bump requirements Mar 10, 2017
setup.py Initial commit Feb 13, 2017
tox.ini Install and run hooks as part of make test Feb 22, 2017
worker.yaml Putting back files I've accidentaly deleted. Jul 28, 2017
yelplove-medium.png Initial commit Feb 13, 2017

README.md

Build Status

Yelp Love

Yelp Love

Yelp Love lets you show others your appreciation for something they've done. Did they make you laugh in your darkest hour? Did they save your ass? Did they help fix that bug? Send them love!

Features

  • Send love to one or more recipients (publicly or privately)
  • Email notifications when users receive love
  • Viewing the most recent 20 loves sent or received by any user
  • Leaderboard with the top 20 users who sent and received love
  • API that allows external applications to send and retrieve love data
  • Manual or automated synchronization between Yelp Love and your employee data
  • Admin section to manage aliases and API keys

To get an idea what Yelp Love looks like go and check out the screenshots.

Installation

Yelp Love runs on Google App Engine. In order to install Yelp Love you will need a Google account and the Google App Engine SDK for Python. We recommend installing this via Homebrew if you don't already have it:

$ brew install google-app-engine

Create a new project

Login to Google Cloud Platform and create a new project and give it a project name. Optionally you can specify a project id - a unique identifier for your project. If you don‘t specify a project id Google will create a random one for you. This id can not be changed once the project is created.

Prepare for deployment

Before you can deploy the application for the first time and start sending love you have to modify app.yaml and worker.yaml. Please edit these files and replace the application placeholder with your project id.

Copy the example config file to config.py and change the settings. Don't forget to specify your own SECRET_KEY.

Initial deployment

Finally, run

$ make deploy

This will open a browser window for you to authenticate yourself with your Google account and will upload your local application code to Google App Engine.

Once the deployment succeeds open your browser and navigate to your application URL, normally https://project_id.appspot.com.

Import employee data

CSV

Create a file employees.csv in the import directory, add all your employee data, and deploy it. We‘ve put an example csv file in that directory so you can get an idea of which fields Yelp Love requires for an employee.

Once the CSV file is deployed point your browser to https://project_id.appspot.com/employees/import. and follow the instructions.

JSON via Amazon S3

Create a file employees.json, add all your employee data, and save it in an S3 bucket. We‘ve put an example JSON file in the import directory so you can get an idea of which fields Yelp Love requires for an employee.

The S3 bucket name must be configured in config.py.

In order to access the S3 bucket you have to save AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY using the Secret model. Locally you can open up the interactive console and execute the following code:

from models import Secret

Secret(id='AWS_ACCESS_KEY_ID', value='change-me').put()
Secret(id='AWS_SECRET_ACCESS_KEY', value='change-me').put()

In production you can either use the Datastore UI or the Remote API.

To kick off the final import you have to run:

from logic import employee
employee.load_employees()

You can also setup a cronjob to keep employee data up to date. Checkout cron.yaml for further details.

Development

Prerequisites

Before you can run Yelp Love on your local machine please install the Google App Engine SDK for Python. You can get it from Google directly or use your favorite packet manager.

Running the application locally

Deployment

Once you've made your code changes and want to deploy them, you must bump the app version. If you don't, your deployment will overwrite the active version of the app on App Engine. The version number must be updated in 2 or possibly 3 places, depending on the nature of your changes.

You will absolutely want to bump the version in setup.py and app.yaml. These versions should always match e.g., 1.3.10 in setup.py and 1-3-10 in app.yaml.

If you modified worker.yaml then you will also need to bump the version of worker.yaml. This version number is specific to the worker module and is independent of the main app version.

When you bumped versions in the appropriate files you can deploy your changes by running make deploy.

If you are seeing the following error:

Error 404: --- begin server output ---
This application does not exist (project_id=u'PROJECT-ID'). To create an App Engine application in this project, run "gcloud app create" in your console.

This is because GAE is no longer automatically initialized, you must run gcloud app create using the Google Cloud Shell (not your terminal...I know...confusing) before deploying on App Engine for the first time. See the screenshot below: GAE cloud shell

Once your code has been uploaded to Google, you must activate the newly deployed version in the Developer Console. Then you're done!

API

Yelp Love also ships with an API which will be available under https://project_id.appspot.com/api. All data of successful GET requests is sent as JSON.

Authentication

Successful requests to the API require an API key. These can be created in the Admin section of the application. Authenticating with an invalid API key will return 401 Unauthorized.

Endpoints

All names, e.g. sender or recipient in the following examples refer to employee usernames.

Retrieve love

GET /love?sender=foo&recipient=bar&limit=20

You must provide either a sender or a recipient. The limit parameter is optional - no limiting will be applied if omitted.

Example
curl "https://project_id.appspot.com/api/love?sender=hammy&api_key=secret"
[
  {
    "timestamp": "2017-02-10T18:10:08.552636",
    "message": "New Barking Release! <3",
    "sender": "hammy",
    "recipient": "darwin"
  }
]

Send love

POST /love

Sending love requires 3 parameters: sender, recipient, and message. The recipient parameter may contain multiple comma-separated usernames.

Example
curl -X POST -F "sender=hammy" -F "recipient=john,jane" -F "message=YOLO" -F "api_key=secret"  https://project_id.appspot.com/api/love
Love sent to john, jane!

Autocomplete usernames

GET /autocomplete?term=ham

The autocomplete endpoint will return all employees which first_name, last_name, or username match the given term.

Example
curl "https://project_id.appspot.com/api/autocomplete?term=ha&api_key=secret"
[
  {
    "label": "Hammy Yo (hammy)",
    "value": "hammy"
  },
  {
    "label": "Johnny Hamburger (jham)",
    "value": "jham"
  }
]

Original Authors and Contributors

For more info check out the Authors file.

License

Yelp Love is licensed under the MIT license.

Contributing

Everyone is encouraged to contribute to Yelp Love by forking the Github repository and making a pull request or opening an issue.