manifest-dl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ba4017f3570e96546119341a0092abe82f0429a
+  data.tar.gz: f802f115ac50c6c9485301fc0a2946ec85bda7d3
+SHA512:
+  metadata.gz: 16370c0a559a79ca2b89ec5f28b8e4a59789605bacdb39b136355f320764835f5032ee1b2fb26f877f8d17b3cbeaa79e0312518be72a1d3f51995a087095a664
+  data.tar.gz: 926034ddfc85008573540f4a8db3b6f0330be00e9dc8602e73c88f4a689757964431163d25ac1f8952247889f637aa7868746e225d47e43dd5d4cb82dee6e93c

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -0,0 +1,83 @@
+[]: {{{1
+
+    File        : README.md
+    Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+    Date        : 2014-10-16
+
+    Copyright   : Copyright (C) 2014  Felix C. Stegerman
+    Version     : v0.1.0
+
+[]: }}}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
+
+  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.
+
+  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).
+
+  NB: uses `curl` to download files; you'll need to have it installed.
+
+[]: }}}1
+
+## Examples
+[]: {{{1
+
+`Gemfile`:
+```
+gem 'manifest-dl', require: 'manifest-dl/rails'
+```
+
+`config/manifest-dl.yaml`:
+```yaml
+- path:       public/uploads/t-and-c.pdf
+- url:        https://example.com/path/to/tandc.pdf
+- sha512sum:  9c573b5ed223f076b4f0c9483608c2d341eb8...
+```
+
+`.gitignore`
+```
+/.manifest-dl-cache
+```
+
+```bash
+rake manifest:dl
+```
+
+[]: }}}1
+
+## Specs & Docs
+
+```bash
+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 : )

data/Rakefile

@@ -0,0 +1,59 @@
+desc 'Run specs'
+task :spec do
+  sh 'rspec -c'
+end
+
+desc 'Run specs verbosely'
+task 'spec:verbose' do
+  sh 'rspec -cfd'
+end
+
+desc 'Run specs verbosely, view w/ less'
+task 'spec:less' do
+  sh 'rspec -cfd --tty | less -R'
+end
+
+desc 'Check for warnings'
+task :warn do
+  reqs = %w{ config }.map { |x| "-r manifest-dl/#{x}" } * ' '
+  sh "ruby -w -I lib #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs'
+task 'warn:spec' do
+  reqs = Dir['spec/**/*.rb'].sort.map { |x| "-r ./#{x}" } * ' '
+  sh "ruby -w -I lib -r rspec #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs (but not void context)'
+task 'warn:spec:novoid' do
+  sh 'rake warn:spec 2>&1 | grep -v "void context"'
+end
+
+desc 'Generate docs'
+task :docs do
+  sh 'yardoc | cat'
+end
+
+desc 'List undocumented objects'
+task 'docs:undoc' do
+  sh 'yard stats --list-undoc'
+end
+
+desc 'Cleanup'
+task :clean do
+  sh 'rm -rf .yardoc/ doc/ *.gem'
+end
+
+desc 'Build SNAPSHOT gem'
+task :snapshot do
+  v = Time.new.strftime '%Y%m%d%H%M%S'
+  f = 'lib/manifest-dl/version.rb'
+  sh "sed -ri~ 's!(SNAPSHOT)!\\1.#{v}!' #{f}"
+  sh 'gem build manifest-dl.gemspec'
+end
+
+desc 'Undo SNAPSHOT gem'
+task 'snapshot:undo' do
+  sh 'git checkout -- lib/manifest-dl/version.rb'
+end

data/lib/manifest-dl.rb

@@ -0,0 +1,111 @@
+# --                                                            ; {{{1
+#
+# File        : manifest-dl.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2014-10-16
+#
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
+#
+# --                                                            ; }}}1
+
+require 'digest/sha1'
+require 'fileutils'
+require 'pathname'
+require 'tmpdir'
+require 'yaml'
+
+# namespace
+module ManifestDL
+
+  class InvalidItemError  < StandardError; end
+  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'
+
+  # --
+
+  # 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;
+    end .compact
+  end
+
+  # --
+
+  # check item
+  def self._check!(item)
+    raise InvalidItemError,
+      "unexpected/missing keys for item #{item.inspect}" \
+        unless item.keys.sort == %w{ path sha512sum url }
+    raise InvalidItemError,
+      "non-string keys for item #{item.inspect}" \
+        unless item.keys.all? { |x| String === x }
+  end
+
+  # download, verify, mv file
+  def self._dl!(item, quiet = false)
+    $stderr.puts "==> #{item['path']}" unless quiet
+    Dir.mktmpdir do |dir|
+      tempfile = Pathname.new(dir).join('dl').to_s
+      _curl! item['url'], tempfile, quiet
+      _verify! tempfile, item['sha512sum']
+      FileUtils.mkdir_p File.dirname(item['path'])
+      FileUtils.mv tempfile, item['path'], force: true
+      _cache! item['path'], item['sha512sum']
+    end
+    item['path']
+  end
+
+  # should file be downloaded?
+  # (i.e. does not exist or sum has changed)
+  def self._dl?(item)
+    return true unless File.exist? item['path']
+    _cached_sha512sum(item['path']) != item['sha512sum']
+  end
+
+  # --
+
+  # download file w/ curl
+  def self._curl!(url, file, quiet = false)
+    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'
+    nil
+  end
+
+  # verify file
+  def self._verify!(file, sum)
+    # no shell b/c multiple args!
+    sum2 = IO.popen(%w{ shasum -a 512 } + [file]) { |f| f.gets.split.first }
+    raise SystemError 'shasum returned non-zero' unless $?.success?
+    raise VerificationError, file unless sum == sum2
+    nil
+  end
+
+  # get item's cached sha512sum;
+  # returns nil if cache file does not exist
+  def self._cached_sha512sum(path)
+    file = _cachefile 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
+    nil
+  end
+
+  # cache file path
+  def self._cachefile(path)
+    sha1 = Digest::SHA1.hexdigest path
+    Pathname.new(DEFAULT_CACHE).join(sha1).to_s
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/manifest-dl/rails.rb

@@ -0,0 +1,26 @@
+# --                                                            ; {{{1
+#
+# File        : manifest-dl/rails.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2014-10-16
+#
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
+#
+# --                                                            ; }}}1
+
+require 'rails'
+
+require 'manifest-dl'
+
+# namespace
+module LocalConfig
+
+  # railtie that adds the rake tasks
+  class Railtie < Rails::Railtie
+    rake_tasks { ManifestDL::Rake.define_tasks }
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/manifest-dl/rake.rb

@@ -0,0 +1,35 @@
+# --                                                            ; {{{1
+#
+# File        : manifest-dl/rake.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2014-10-16
+#
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
+#
+# --                                                            ; }}}1
+
+require 'rake/dsl_definition'
+
+require 'manifest-dl'
+
+# namespace
+module LocalConfig
+
+  # rake tasks
+  module Rake
+    extend ::Rake::DSL
+
+    # define rake task manifest:dl
+    def self.define_tasks
+      desc 'download extra files w/ manifest-dl'
+      task 'manifest:dl' do
+        ManifestDL.run!
+      end
+    end
+
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/manifest-dl/version.rb

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

data/manifest-dl.gemspec

@@ -0,0 +1,31 @@
+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.description = <<-END.gsub(/^ {4}/, '')
+    download extra files for your app
+
+    ...
+  END
+
+  s.version     = ManifestDL::VERSION
+  s.date        = ManifestDL::DATE
+
+  s.authors     = [ 'Felix C. Stegerman' ]
+  s.email       = %w{ flx@obfusk.net }
+
+  s.licenses    = %w{ LGPLv3+ }
+
+  s.files       = %w{ .yardopts README.md Rakefile } \
+                + %w{ manifest-dl.gemspec } \
+                + Dir['{lib,spec}/**/*.rb']
+
+  s.add_runtime_dependency 'rake'
+
+  # s.add_development_dependency 'rspec'
+
+  s.required_ruby_version = '>= 1.9.1'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: manifest-dl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix C. Stegerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  download extra files for your app
+
+  ...
+email:
+- flx@obfusk.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- README.md
+- Rakefile
+- lib/manifest-dl.rb
+- lib/manifest-dl/rails.rb
+- lib/manifest-dl/rake.rb
+- lib/manifest-dl/version.rb
+- manifest-dl.gemspec
+homepage: https://github.com/obfusk/manifest-dl
+licenses:
+- LGPLv3+
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: download extra files for your app
+test_files: []
+has_rdoc: