manifest-dl 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ba4017f3570e96546119341a0092abe82f0429a
-  data.tar.gz: f802f115ac50c6c9485301fc0a2946ec85bda7d3
+  metadata.gz: cc716ceae8c6a8d54cd5c4156fd0702ee4536f2e
+  data.tar.gz: 232fe98b96f4beb249b2077c6c9fd309a7012116
 SHA512:
-  metadata.gz: 16370c0a559a79ca2b89ec5f28b8e4a59789605bacdb39b136355f320764835f5032ee1b2fb26f877f8d17b3cbeaa79e0312518be72a1d3f51995a087095a664
-  data.tar.gz: 926034ddfc85008573540f4a8db3b6f0330be00e9dc8602e73c88f4a689757964431163d25ac1f8952247889f637aa7868746e225d47e43dd5d4cb82dee6e93c
+  metadata.gz: cf2e8d4e8a3860be0e750804cd96eea75a624a6fbe94920499257c1eaab80e7ac86369cfb4fe3e410262ea4095f0ed5a59f2831478c5cdb85679fa1ec2d55d68
+  data.tar.gz: 64ed81694a1acdcad6fe0ebc496e32b213563d97309e823b57997a55f5211c2acd3ca90ddc6b3efdce65bca74cbe222725cc51a0224ac3d48e227f6f43072a1b

data/README.md

@@ -2,30 +2,29 @@
 
     File        : README.md
     Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-    Date        : 2014-10-16
+    Date        : 2014-10-20
 
     Copyright   : Copyright (C) 2014  Felix C. Stegerman
-    Version     : v0.1.0
+    Version     : v0.1.1
 
 []: }}}1
 
-<!--
 [![Gem Version](https://badge.fury.io/rb/manifest-dl.png)](https://rubygems.org/gems/manifest-dl)
--->
 
 ## Description
 []: {{{1
 
-  manifest-dl - download extra files for your app
+  manifest-dl - download extra files for your ruby app
 
   Sometimes you have a (web) app that needs some extra files (e.g.
-  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.
+  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 (and
-  updates them when they -- i.e. their checksums -- change).
+  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.
 
@@ -34,25 +33,38 @@
 ## Examples
 []: {{{1
 
-`Gemfile`:
-```
+### Rails
+
+```ruby
+# Gemfile
 gem 'manifest-dl', require: 'manifest-dl/rails'
 ```
 
-`config/manifest-dl.yaml`:
 ```yaml
+# config/manifest-dl.yaml
 - path:       public/uploads/t-and-c.pdf
-- url:        https://example.com/path/to/tandc.pdf
-- sha512sum:  9c573b5ed223f076b4f0c9483608c2d341eb8...
+  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`
 ```
+# .gitignore
 /.manifest-dl-cache
 ```
 
 ```bash
-rake manifest:dl
+rake manifest:dl    # run!
+```
+
+### Standalone
+
+```ruby
+require 'manifest-rb'
+ManifestRB.run!
 ```
 
 []: }}}1

data/lib/manifest-dl.rb

@@ -2,7 +2,7 @@
 #
 # File        : manifest-dl.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2014-10-16
+# Date        : 2014-10-20
 #
 # Copyright   : Copyright (C) 2014  Felix C. Stegerman
 # Licence     : LGPLv3+
@@ -22,15 +22,19 @@ module ManifestDL
   class SystemError       < StandardError; end
   class VerificationError < StandardError; end
 
-  DEFAULT_CONFIG  = File.expand_path './config/manifest-dl.yaml'
-  DEFAULT_CACHE   = File.expand_path './.manifest-dl-cache'
+  DEFAULT_CONFIG  = './config/manifest-dl.yaml'
+  DEFAULT_CACHE   = './.manifest-dl-cache'
 
   # --
 
   # download files in manifest
-  def self.run!(quiet = false, config_file = DEFAULT_CONFIG)
-    YAML.load(File.read(DEFAULT_CONFIG)).map do |item|
-      _check! item; _dl?(item) ? _dl!(item, quiet) : nil;
+  def self.run!(opts = {})
+    quiet       = opts.fetch(:quiet)        { false           }
+    config_file = opts.fetch(:config_file)  { DEFAULT_CONFIG  }
+    cache_dir   = opts.fetch(:cache_dir)    { DEFAULT_CACHE   }
+    YAML.load(File.read(config_file)).map do |item|
+      _check! item
+      _dl?(item, cache_dir) ? _dl!(item, quiet, cache_dir) : nil;
     end .compact
   end
 
@@ -47,7 +51,7 @@ module ManifestDL
   end
 
   # download, verify, mv file
-  def self._dl!(item, quiet = false)
+  def self._dl!(item, quiet, cache_dir)
     $stderr.puts "==> #{item['path']}" unless quiet
     Dir.mktmpdir do |dir|
       tempfile = Pathname.new(dir).join('dl').to_s
@@ -55,22 +59,22 @@ module ManifestDL
       _verify! tempfile, item['sha512sum']
       FileUtils.mkdir_p File.dirname(item['path'])
       FileUtils.mv tempfile, item['path'], force: true
-      _cache! item['path'], item['sha512sum']
+      _cache! item['path'], item['sha512sum'], cache_dir
     end
     item['path']
   end
 
   # should file be downloaded?
   # (i.e. does not exist or sum has changed)
-  def self._dl?(item)
+  def self._dl?(item, cache_dir)
     return true unless File.exist? item['path']
-    _cached_sha512sum(item['path']) != item['sha512sum']
+    _cached_sha512sum(item['path'], cache_dir) != item['sha512sum']
   end
 
   # --
 
   # download file w/ curl
-  def self._curl!(url, file, quiet = false)
+  def self._curl!(url, file, quiet)
     args = %w{ curl -L } + (quiet ? %w{ -s } : []) + ['-o', file, '--', url]
     # no shell b/c multiple args!
     system(*args) or raise SystemError 'curl returned non-zero'
@@ -88,22 +92,22 @@ module ManifestDL
 
   # get item's cached sha512sum;
   # returns nil if cache file does not exist
-  def self._cached_sha512sum(path)
-    file = _cachefile path
+  def self._cached_sha512sum(path, cache_dir)
+    file = _cachefile cache_dir, path
     File.exist?(file) ? File.read(file) : nil
   end
 
   # cache item's sha512sum (based on sha1sum of path)
-  def self._cache!(path, sum)
-    FileUtils.mkdir_p DEFAULT_CACHE
-    File.write _cachefile(path), sum
+  def self._cache!(path, sum, cache_dir)
+    FileUtils.mkdir_p cache_dir
+    File.write _cachefile(cache_dir, path), sum
     nil
   end
 
   # cache file path
-  def self._cachefile(path)
+  def self._cachefile(cache_dir, path)
     sha1 = Digest::SHA1.hexdigest path
-    Pathname.new(DEFAULT_CACHE).join(sha1).to_s
+    Pathname.new(cache_dir).join(sha1).to_s
   end
 
 end

data/lib/manifest-dl/version.rb

@@ -1,4 +1,4 @@
 module ManifestDL
-  VERSION = '0.1.0'
-  DATE    = '2014-10-16'
+  VERSION = '0.1.1'
+  DATE    = '2014-10-20'
 end

data/manifest-dl.gemspec

@@ -3,10 +3,10 @@ require File.expand_path('../lib/manifest-dl/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'manifest-dl'
   s.homepage    = 'https://github.com/obfusk/manifest-dl'
-  s.summary     = 'download extra files for your app'
+  s.summary     = 'download extra files for your ruby app'
 
   s.description = <<-END.gsub(/^ {4}/, '')
-    download extra files for your app
+    download extra files for your ruby app
 
     ...
   END

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manifest-dl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Felix C. Stegerman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |
-  download extra files for your app
+  download extra files for your ruby app
 
   ...
 email:
@@ -65,6 +65,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: download extra files for your app
+summary: download extra files for your ruby app
 test_files: []
 has_rdoc: