/cron_api

Cron-like job scheduler as a service.

Primary LanguageElixir

CronApi

CircleCI Deps Status

  • Cron-like job scheduler as a service
  • A minimal docker alpine container
  • Automatically pushes it to dockerhub if tests pass

Installation

git clone https://github.com/rafaeljesus/cron_api.git
cd cron_api
mix deps.get

Running server

To start the serve execute:

iex -S mix

API Documentation

create

curl -X POST 'http://localhost:3000/v1/events' \
 -d 'url=https://api.your-server.com/your-url' \
 -d 'cron=* * * * *' \
 -d 'status=active'

update

curl -X PATCH 'http://localhost:3000/v1/events/1' \
 -d 'cron=1 * * * *' \
 -d 'status=inactive'

show

curl -X GET 'http://localhost:3000/v1/events/1'

delete

curl -X DELETE 'http://localhost:3000/v1/events/1'

search

curl -X GET 'http://localhost:3000/v1/events/?status=active&page=2&page_size=25'

Built with

  • elixir Backend is a elixir 1.2.
  • maru API is exposed by maru. HTTP microservices
  • Mongodb Mongodb as a data store.

Docker

This repository has automated image builds on hub.docker.com after successfully building and testing. See the deployment section of circle.yml for details on how this is done. Note that three environment variables need to be set on CircleCI for the deployment to work:

  • DOCKER_EMAIL - The email address associated with the user with push access to the Docker Hub repository
  • DOCKER_USER - Docker Hub username
  • DOCKER_PASS - Docker Hub password (these are all stored encrypted on CircleCI, and you can create a deployment user with limited permission on Docker Hub if you like)

run:

$ docker-machine start default
$ eval $(docker-machine env default)
$ docker-compose up
$ curl `docker-machine ip default`:3000

Contributing

  • Fork it
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create new Pull Request

Maintaners