Sharedlists

Sharedlists is a simple rails driven database for managing multiple product lists of various suppliers.

This app is used in conjunction with foodsoft. Recommended Ruby version is 2.3 (note that 2.4 does not work).

Development

Setup

Copy config/database.yml.SAMPLE to config/database.yml and

docker-compose run --rm app bundle
docker-compose run --rm app rake db:setup

Run

docker-compose up

Creating a user

To access sharedlists, you'll need to create a user (and I guess you want admin access).

docker-compose run --rm app rails c
> u = User.new(email: 'admin@example.com', password: 'secret')
> u.admin = true
> u.save!
> exit

Production

Either fetch the image, or build it:

docker pull sharedlists:latest
# or
docker build --tag sharedlists:latest --rm .

Then set environment variables SECRET_TOKEN and DATABASE_URL and run:

docker run --name sharedlists_web \
  -e SECRET_TOKEN -e DATABASE_URL -e RAILS_FORCE_SSL=false \
  sharedlists:latest

To run cronjobs, start another instance:

docker run --name sharedlists_cron \
  -e SECRET_TOKEN -e DATABASE_URL \
  sharedlists:latest  ./proc-start cron

If you want to process incoming mails, add another instance like the previous, substituting mail for cron.

To put this all together, you may want to wrap this in docker-compose. See the foodcoops.net setup for a real-world example.

Connecting Foodsoft

To use shared suppliers from this sharedlists instance from within Foodsoft, you need to configure the shared_lists option in its config/app_config.yml. Don't forget to grant the Foodsoft database user SELECT access on sharedlists' suppliers and articles tables.

Updating articles

Articles in the database can be updated regularly. There are currently two options to do this automatically.

FTP

Some suppliers distribute article lists via FTP. You can use the rake task called sync_ftp_files in order to download and parse those article lists. First, you need to enable FTP synchronization for a certain supplier by activating the checkbox Synchronize FTP files. Fill out all corresponding form fields. In particular, make sure to adjust the file filter (regular expression) such that it matches the files of interest; non-matching files are ignored. The two supported file formats and sensible choices for a corresponding file filter are shown in the following table.

file format	example file filter
BNN3	`\A(?:[.]/)?PL.{0,6}[.]BNN\z`
foodsoft	`\A(?:[.]/)?.+[.]csv\z`

Once you have the sync_ftp_files task working, you may wish to setup a cronjob using whenever.

Email

Some suppliers send a regular email with an article list in the attachment. For this, an email server needs to be run using the rake task mail:smtp_server. On production, you may want to run this on localhost on an unprivileged port, with a proper MTA in front that does message routing.

To enable this for a certain supplier, tick the checkbox Update articles by email. Then select a file format to use for importing, and the supplier's email address from which the email is sent. If you only want to import for mails with a subject that contains a certain text (e.g. Articles in week), fill in the subject field as well.

What email address does the supplier need to send to? Users will find this after saving the supplier after Send to.

This needs setting up of the environment variable MAILER_DOMAIN, on which you receive the emails. It is allowed to prefix the address, you may want to set the prefix in MAILER_PREFIX. This is useful when you're running an email server in front to route mails.

4.5 KiB Raw Blame History