patforna/social

A social console app.

Social App

For context, see docs/instructions.txt.

Prerequisites

Make sure you've got the following installed:

• Docker 1.6.x
• Java 8 (if not using docker)
• Gradle 2.x (for development)

Usage

Docker

This is probably the easiest way to run the app:

$ docker run -t -i patforna/social:0.1
------------------------------------------------------------------------
 Hi! Please type some commands:
------------------------------------------------------------------------
 <user> -> <msg>           Post a new message
 <user>                    Read posts
 <user> follows <other>    Follow other user
 <user> wall               Read wall posts
 Ctrl-C                    Quit.
------------------------------------------------------------------------

>

Java Binary

Alternatively, you can download the latest binary distribution. Then unpack it and execute the provided start script:

$ unzip social-*.zip
$ cd social-*/
$ bin/social
------------------------------------------------------------------------
 Hi! Please type some commands:
------------------------------------------------------------------------
 <user> -> <msg>           Post a new message
 <user>                    Read posts
 <user> follows <other>    Follow other user
 <user> wall               Read wall posts
 Ctrl-C                    Quit.
------------------------------------------------------------------------

>

Development

Clone the source code. To see what's possible, run:

$ gradle tasks

To compile, test and package the app, run:

$ ./build.sh

To start the app, run:

$ ./run.sh

Known Issues

• for posts newer than 1 min, message reads "moments ago" instead of "x seconds ago".

Notes

These were some topics that got me scratching my chin:

• should I put command parsing logic in CommandParser or in Command objects?
• should I introduce equals/hashCode on Command objects just so I can test?
• is there really no better way to use regexes in java?
• should Command#execute() return something more expressive than Object?
• should Command#execute() return Optional<?>
• should timestamp creation happen in Command or Post object?
• should I have a User object?
• how do I feel about making SocialApp#run public for easier testing?
• should I abstract away input/output into a Console object?