cargonaut

README

my-cargonaut/cargonaut

Educational ride and transport sharing app for an university course. - by Lukas Malkmus, Philipp Alexander Händler & Robert Feuerhack

---

Table of Contents

1. Introduction
2. Usage
3. Contributing
4. License

Introduction

Cargonaut is an dducational ride and transport sharing app for an university course.

Usage

Installation

This project uses native go mod support for vendoring and requires a working go toolchain installation.

Binary releases are currently not available.

Install using go get

GO111MODULE=on go install github.com/my-cargonaut/cargonaut/cmd/...

Install from source

git clone https://github.com/my-cargonaut/cargonaut.git
cd cargonaut
make # Build production binaries
make install # Build and install binaries into $GOPATH

Validate installation

The installation can be validated by running cargonaut version in the terminal.

Configuration

The application can be configured by either the environment or command line flags. It provides a basic help flag -help which prints out application and configuration help. See Using the application.

The application can be configured by command line flags:

cargonaut serve -listen-address=:8080

Flags are mapped to environment variables by replacing dashes - with an underscore _. However, they are prefixed by the application name:

export CARGONAUT_LISTEN_ADDRESS=:8080

Configuration priority from lowest to highest is like presented above: Command line option (flag), environment.

Using the application

cargonaut [flags] [commands]

Help on flags and commands:

cargonaut --help

Contributing

Feel free to submit PRs or to fill issues. Every kind of help is appreciated.

Before committing, make should pass without any issues.

License

© Lukas Malkmus, Philipp Alexander Händler, Robert Feuerhack 2020

Distributed under MIT License (The MIT License).

See LICENSE for more information.

Documentation

Index

• Variables
• type Rating
• type Token
• type TokenBlacklist
• type Trip
• type TripRepository
• type User
• type UserRepository
• type Vehicle
• type VehicleRepository

Variables

var (
	// ErrTokenExists is raised when a token with the same unique constraints
	// already exists.
	ErrTokenExists = errors.New("token exists")
	// ErrTokenNotFound is raised when a token does not exist.
	ErrTokenNotFound = errors.New("token not found")
	// ErrUserExists is raised when a user with the same unique constraints
	// already exists.
	ErrUserExists = errors.New("user exists")
	// ErrUserNotFound is raised when a user does not exist.
	ErrUserNotFound = errors.New("user not found")
	// ErrRatingExists is raised when a rating with the same unique constraints
	// already exists.
	ErrRatingExists = errors.New("rating exists")
	// ErrRatingNotFound is raised when a rating does not exist.
	ErrRatingNotFound = errors.New("rating not found")
	// ErrVehicleExists is raised when a vehicle with the same unique
	// constraints already exists.
	ErrVehicleExists = errors.New("vehicle exists")
	// ErrVehicleNotFound is raised when a vehicle does not exist.
	ErrVehicleNotFound = errors.New("vehicle not found")
	// ErrTripExists is raised when a trip with the same unique constraints
	// already exists.
	ErrTripExists = errors.New("trip exists")
	// ErrTripNotFound is raised when a trip does not exist.
	ErrTripNotFound = errors.New("trip not found")
)

Types

type Rating

type Rating struct {
	ID        uuid.UUID `json:"id" db:"id" sql:"type:uuid"`
	UserID    uuid.UUID `json:"user_id" db:"user_id" sql:"type:uuid"`
	AuthorID  uuid.UUID `json:"author_id" db:"author_id" sql:"type:uuid"`
	TripID    uuid.UUID `json:"trip_id" db:"trip_id" sql:"type:uuid"`
	Comment   string    `json:"comment" db:"comment"`
	Value     float32   `json:"value" db:"value"`
	CreatedAt time.Time `json:"created_at" db:"created_at"`
}

Rating is a rating given by a user (Author) to another user. Users can't rate themselves.

type Token

type Token struct {
	ID        uuid.UUID `db:"id" sql:"type:uuid"`
	UserID    uuid.UUID `db:"user_id" sql:"type:uuid"`
	Token     string    `db:"-"`
	ExpiresAt time.Time `db:"expires_at"`
	CreatedAt time.Time `db:"created_at"`
}

Token represents an authentication token.

type TokenBlacklist

type TokenBlacklist interface {
	// IsTokenBlacklisted retrieves a token by its unique token ID. If the token
	// is on the blacklist, true is returned.
	IsTokenBlacklisted(ctx context.Context, tokenID uuid.UUID) (bool, error)
	// BlacklistToken blacklists one or more tokens by putting them onto the
	// token blacklist. The tokens are identified by their unique token ID.
	BlacklistToken(ctx context.Context, tokens ...*Token) error
}

TokenBlacklist provides methods for blacklisting authentication tokens.

type Trip

type Trip struct {
	ID          uuid.UUID  `json:"id" db:"id" sql:"type:uuid"`
	UserID      uuid.UUID  `json:"user_id" db:"user_id" sql:"type:uuid"`
	VehicleID   uuid.UUID  `json:"vehicle_id" db:"vehicle_id" sql:"type:uuid"`
	RiderID     *uuid.UUID `json:"rider_id" db:"rider_id" sql:"type:uuid"`
	Start       string     `json:"start" db:"start"`
	Destination string     `json:"destination" db:"destination"`
	Price       float32    `json:"price" db:"price"`
	Depature    time.Time  `json:"depature" db:"depature"`
	Arrival     time.Time  `json:"arrival" db:"arrival"`
	CreatedAt   time.Time  `json:"created_at" db:"created_at"`
	UpdatedAt   time.Time  `json:"updated_at" db:"updated_at"`
}

Trip is a trip from one location to another one. If no RiderID is assigned, the trip is still available.

type TripRepository

type TripRepository interface {
	// ListTrips lists all trips.
	ListTrips(context.Context) ([]*Trip, error)
	// GetTrip returns a trip identified by its unique ID.
	GetTrip(ctx context.Context, id uuid.UUID) (*Trip, error)
	// CreateTrip creates a new trip.
	CreateTrip(context.Context, *Trip) error
	// UpdateTrip updates a given trip.
	UpdateTrip(context.Context, *Trip) error
	// DeleteTrip deletes a trip identified by his unique ID.
	DeleteTrip(ctx context.Context, id uuid.UUID) error
	// GetRating gets a rating for a trip.
	GetRating(ctx context.Context, id uuid.UUID) (*Rating, error)
	// CreateRating creates a new rating fro a trip.
	CreateRating(context.Context, *Rating) error
}

TripRepository provides access to the trip resource.

type User

type User struct {
	ID          uuid.UUID `json:"id" db:"id" sql:"type:uuid"`
	Email       string    `json:"email" db:"email"`
	Password    string    `json:"-" db:"password_hash"`
	DisplayName string    `json:"display_name" db:"display_name"`
	Birthday    time.Time `json:"birthday" db:"birthday"`
	Avatar      string    `json:"-" db:"avatar"`
	CreatedAt   time.Time `json:"created_at" db:"created_at"`
	UpdatedAt   time.Time `json:"updated_at" db:"updated_at"`
}

User represents a user identity.

type UserRepository

type UserRepository interface {
	// ListUsers lists all users.
	ListUsers(context.Context) ([]*User, error)
	// GetUser returns a user identified by his unique ID.
	GetUser(ctx context.Context, userID uuid.UUID) (*User, error)
	// GetUserByEmail returns a user identified by his E-Mail address.
	GetUserByEmail(ctx context.Context, email string) (*User, error)
	// CreateUser creates a new user.
	CreateUser(context.Context, *User) error
	// UpdateUser updates a given user.
	UpdateUser(context.Context, *User) error
	// DeleteUser deletes a user identified by his unique ID.
	DeleteUser(ctx context.Context, userID uuid.UUID) error
	// ListTokens lists all authentication tokens for the user identified by his
	// unique ID.
	ListTokens(ctx context.Context, userID uuid.UUID) ([]*Token, error)
	// CreateToken creates an authentication token for the user identified by
	// the tokens unique user ID.
	CreateToken(ctx context.Context, token *Token) error
	// DeleteToken deletes an users authentication token. Token and user are
	// identified by their unique IDs.
	DeleteToken(ctx context.Context, userID, tokenID uuid.UUID) error
	// ListRatings lists all ratings for the user identified by his unique ID.
	ListRatings(ctx context.Context, userID uuid.UUID) ([]*Rating, error)
	// ListVehicles lists all vehicles for the user identified by his unique ID.
	ListVehicles(ctx context.Context, userID uuid.UUID) ([]*Vehicle, error)
}

UserRepository provides access to the user resource.

type Vehicle

type Vehicle struct {
	ID                uuid.UUID `json:"id" db:"id" sql:"type:uuid"`
	UserID            uuid.UUID `json:"user_id" db:"user_id" sql:"type:uuid"`
	Brand             string    `json:"brand" db:"brand"`
	Model             string    `json:"model" db:"model"`
	Passengers        uint8     `json:"passengers" db:"passengers"`
	LoadingAreaLength float32   `json:"loading_area_length" db:"loading_area_length"`
	LoadingAreaWidth  float32   `json:"loading_area_width" db:"loading_area_width"`
	CreatedAt         time.Time `json:"created_at" db:"created_at"`
	UpdatedAt         time.Time `json:"updated_at" db:"updated_at"`
}

Vehicle is a vehicle belonging to a user.

type VehicleRepository

type VehicleRepository interface {
	// ListVehicles lists all vehicles.
	ListVehicles(context.Context) ([]*Vehicle, error)
	// GetVehicle returns a vehicle identified by its unique ID.
	GetVehicle(ctx context.Context, id uuid.UUID) (*Vehicle, error)
	// CreateVehicle creates a new vehicle.
	CreateVehicle(context.Context, *Vehicle) error
	// UpdateVehicle updates a given vehicle.
	UpdateVehicle(context.Context, *Vehicle) error
	// DeleteVehicle deletes a vehicle identified by his unique ID.
	DeleteVehicle(ctx context.Context, id uuid.UUID) error
}

VehicleRepository provides access to the vehicle resource.