This project has been deprecated by the new API and its components. REST services are now provided by turaco, intensive compute tasks are facilitated by myna, and all database models can be found in kagu.
PS: We loved using Scala, loved the community, loved contributing, and sincerely hope to be back in the future. The lack of stable test frameworks that support popular libraries turned us away, and having to manually wrap Akka::HTTP and write so much from scratch was a decision our small team could not concede to.
Install the following through your favorite package manager.
- JDK 8
- Latest Scala and SBT
- Typesafe Activator
- PostgreSQL 9.5+
- Valid AWS access key and secret. Amazon IAM Documentation
You may want to play with some test data. To do so, please clear out your test database's public schema space and then run the following:
CREATE_FIXTURES=true sbt testProdThe server will start, insert fixtures, and then kill its own PID from target/universal/stage/RUNNING_PID. We eventually plan to refactor this into a command you can invoke via sbt, but this works for now. The debug output will contain a message with an API key for you to use in your development environment:
[debug] application - Fixture generation complete! Use this API key: (key here)
All you really need to do is:
git clone git@github.com:birdfeed/chirp.git
cd chirp
# Configure your AWS keys and PostgreSQL credentials
vim .env
sbt runWe recommend using a PaaS such as Heroku for convenience, but you can feel free to set chirp up behind your favorite web server. Play provides documentation on how to set up a project using nginx, apache, and lighttpd.
All that is required of you is to define the PLAY_SESSION_SECRET environment variable. See application.conf for more details. You can feel free to provide tinfoil-hat-friendly high entropy salts, but we feel that the Play sbt hook does the job well enough.
Please be mindful and run web services as non-privileged users.
export PLAY_SESSION_SECRET=$(sbt generatePlaySecret)
# sbt testProd will simulate production but you should not use it
cd chirp/target/universal/stage
chmod +x chirp
./chirphostname/v1/{resource}
View the routes file for available resources and actions
The Chirp API uses a two-key system to authorize clients to the service, and users to their resources. Your headers should define Chirp-Api-Key and Chirp-Access-Token. API keys are issued by administrators to developers and access tokens are issued per-session, per-user as resources are requested. Both the API key and access token are ISO-11578 compliant UUIDv4 strings.
It is absolutely imperative you use HSTS-compliant HTTPS to avoid interception of your requests
TODO: Enforce refresh tokens
POST /v1/user/authenticate
Chirp-Api-Key: [your key]
Content-Type: application/json
{
"email": "foo@bar.baz",
"password": "hunter12"
}200 OK
{
"userId": 1,
"token": "d647f4e1-1198-4523-87dc-44dba7e9671b",
"refreshToken": "fd44f936-aba6-40ff-a53b-220192a1d423"
}Due to poor mocking support in recent versions of ScalaTest, you must place your AWS keys in .env to run the test suite or the AWS client we use will throw a fatal exception. We are planning to rectify this as soon as there is a new ScalaMock milestone.
Otherwise: sbt test