[]: {{{1

File        : README.md
Maintainer  : Felix C. Stegerman <flx@obfusk.net>
Date        : 2014-10-20

Copyright   : Copyright (C) 2014  Felix C. Stegerman
Version     : v0.1.2

[]: }}}1

Description

[]: {{{1

manifest-dl - download extra files for your ruby app

Sometimes you have a (web) app that needs some extra files (e.g. assets like videos or terms and conditions) that you don't want to have to upload manually, but prefer (e.g. because they're not very small) not to have in your version control system.

manifest-dl allows you to specify the paths, urls and checksums in a manifest and automatically downloads those extra files for you (from a website or cloud storage) and updates them when they -- i.e. their checksums -- change.

NB: uses curl to download files; you'll need to have it installed.

[]: }}}1

Examples

[]: {{{1

Rails

# Gemfile
gem 'manifest-dl', require: 'manifest-dl/rails'

# config/manifest-dl.yaml
- path:       public/uploads/t-and-c.pdf
  url:        https://example.com/path/to/tandc.pdf
  sha512sum:  9c573b5ed223f076b4f0c9483608c2d341eb8...

- path:       public/uploads/video.mp4
  url:        https://cloud.example.com/share/my-video.mp4
  sha512sum:  f7fbba6e0636f890e56fbbf3283e524c6fa32...

# .gitignore
/.manifest-dl-cache

rake manifest:dl    # run!

Standalone

require 'manifest-rb'
ManifestRB.run!

Rake

require 'manifest-dl/rake'
ManifestDL::Rake.define_tasks

[]: }}}1

Specs & Docs

rake spec   # TODO
rake docs

TODO

• gpg support?
• what to do with errors?
• specs/docs?
• ...

License

LGPLv3+ [1].

References

[1] GNU Lesser General Public License, version 3 --- http://www.gnu.org/licenses/lgpl-3.0.html

[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )