Let Me Out, Let Me Out!

This is not a dance !

LMO is a ruby app used to generate french "attestation de déplacement dérogatoire" directly from cli (and it's also a Telegram Bot, duh).

Now supports QRCode output to SVG !

It works for the last curfew rules (from 19:00 to 6:00) ! Yay !

Context switching from curfew to quarantine is now available ! Yay !

Getting Started

Prerequisites

• Ruby
• Bundler

Install

bundle install

Contexts

LMO is now aware of contexts (thx to our administration for this s i m p l i c i t y).

For now two kinds of contexts are supported :

• curfew
• quarantine (default)

Switching context changes internal values to match both reasons and text template

Usage (cli mode)

bundle exec ruby bin/lmo.rb --help

Get values from env

LMO can fetch key value pairs directly from env. Add thoose to your .profile for a quick generation.

• "LMO_NAME"
• "LMO_FIRSTNAME"
• "LMO_BIRTH_DATE"
• "LMO_BIRTH_LOCATION"
• "LMO_STREET"
• "LMO_POSTAL_CODE"
• "LMO_CITY"
• "LMO_REASON" (supported values : "work", "health", "family", "handicap", "pets", "missions", "justice", "transits")

With this method just pipe the output directly to the lp command and you're out !

Get values from profiles

name: NAME
firstname: Firstname
birth_date: 01/11/1990
birth_location: City
street: address
postal_code: code
city: city

LMO can read from key value pairs from profile files. Profile files are .yml file put in profiles dir. By default, profile dir is set to ~/.config/lmo/profiles and can be customize with LMO_PROFILES_DIR env value.

When using a profile, just use -p to select profile name and -r flag to select a reason.

For example, using profile example from ~/.config/lmo/profiles/example.yml with reason purchase

bundle exec ruby lmo.rb -r purchase -p example

Forwarders

LMO can also send certificate and asssociated QR Code to multiple ouputs.

This outputs are enabled with the -f flag

Each forwarder requires a specific configuration, specified bellow

Mail

Enabled with -f mail

• "LMO_MAIL_DEST", destination mail address
• "LMO_MAIL_PORT", smtp server port
• "LMO_MAIL_USER", smtp server user
• "LMO_MAIL_PASSWORD" smtp server password
• "LMO_MAIL_SERVER", smtp server address

With Google and 2FA, you need to create an application with application password.

Use this password as LMO_MAIL_PASSWORD value.

Telegram

Create a Telegram Bot and save the bot token

Enabled with -f telegram

• "LMO_TELEGRAM_CHAT", destination chat ID
• "LMO_TELEGRAM_TOKEN", bot token

To get your Telegram Chat ID, invite your bot to a channel, send a dummy message to it (do not forget to mention it with @botname), check https://api.telegram.org/bot$BOT_TOKEN/getUpdates and replace bot token value.

Usage (bot mode)

LMO now supports a Telegram Bot mode ! (kudos @tomMoulard for the motivation)

LMO_TELEGRAM_TOKEN=VALUE bundle exec ruby bin/bot.rb

Use /start or /help to get help message.

This mode use profile files as decribe in profiles section. Profile name is the Telegram user ID. To get your ID ask /me to the bot instance.

Docker container

A Docker container (builded from my personnal CI) is available with bot mode as default.

docker container run e LMO_TELEGRAM_TOKEN=VALUE -v /path/to/profiles:/srv/lmo/profiles papey/lmo:latest

Where /path/to/profiles is the path to profiles directory

Authors

• Wilfried OLLIVIER - Main author - Papey

License

LICENSE file for details