vagrant-box-updater 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-box-updater.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 spil-ruslan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# vagrant-box-updater
+
+  vagrant-box-updater - Vagrant (version 1.1+) plugin  save details about box images, checks remote box images for updates, notify user and perform interactive update
+
+  By default Vagrant just store box image to localdisk (during box add) and never checks if there are updates for that image, so users may end up working with outdated boxes.
+
+  This plugin meant to notify user about new versions of remote box images available, and provide interactive prompt to download updates. 
+
+
+  vagrant plugin hooks into :
+
+	"vagrant box add" - save details about remote box image: image creation timestamp, image source path (box data stored in yaml format inside ~/.vagrant.d/$box_name.stat);
+
+	"vagrant up" -	checks source box url for updates (use remote file modification date to define whether image updated or not), 
+					when update found - print message and optionally perform interactive download.
+ 
+
+## Installation
+
+Note: plugin is written for Vagrant version 1.1 and higher
+
+To install from gem repository:
+
+vagrant plugin install vagrant-box-updater
+
+To install from source code:
+
+1. Clone project
+2. run "rake build" - should create gem file
+3. install plugin to vagrant environment "sudo vagrant  plugin install pkg/vagrant-box-updater-0.0.1.gem" 
+
+## Usage
+
+After plugin installed it's recommended to re-add box images (vagrant box add -f ) so plugin can collect necessary information about box (such as source url and creation timestamp).
+
+It is possible to disable plugin by adding configuration parameter to Vagrantfile:
+
+config.box_updater.disable = true
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vagrant-box-updater.rb

@@ -0,0 +1,2 @@
+require "vagrant"
+require "vagrant-box-updater/plugin"

data/lib/vagrant-box-updater/action/add_box.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+module VagrantPlugins
+  module BoxUpdater
+    module Action
+      class AddBox
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          box_url = env[:box_url]
+          box_name = env[:box_name]
+
+          begin
+            remote_modification_date = get_remote_modification_date?(box_url)
+          rescue
+            env[:ui].error("Unable access: #{box_url}")
+            env[:ui].error("Can not collect image status, please check box url and repeat action")
+            @app.call(env)
+            return 0
+          end
+
+          @box_attributes = {"modification_date" => remote_modification_date, "url" => box_url}
+          env[:ui].info("Box details: #{@box_attributes.to_yaml}")
+          stat_file = env[:home_path].join(box_name + ".stat")
+          File.open(stat_file, 'w+') {|f| f.write(@box_attributes.to_yaml) }
+          @app.call(env)
+        end
+
+        def get_remote_modification_date?(url)
+          require 'open-uri'
+          require 'net/http'
+          url = URI.parse(url)
+          Net::HTTP.start(url.host, url.port) do |http|
+            response = http.head(url.request_uri)
+            return response['Last-Modified']
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-box-updater/action/up_box.rb

@@ -0,0 +1,127 @@
+require 'yaml'
+
+module VagrantPlugins
+  module BoxUpdater
+    module Action
+      class UpBox
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          require 'time'
+          box_name = env[:machine].config.vm.box
+          box_url  = env[:machine].config.vm.box_url
+
+          disable_plugin_flag = env[:machine].config.box_updater.disable
+          if disable_plugin_flag == true
+            env[:ui].warn("Update disabled")    
+            @app.call(env)
+            return 0
+          end
+          
+          stat_file = env[:home_path].join(box_name + ".stat")
+
+          # Create empty stat file if missing 
+          if !File.file?(stat_file)
+            env[:ui].info("Local stat file not found: #{stat_file}")
+            @box_attributes = {"modification_date" => nil, "url" => box_url}
+            puts @box_attributes.to_yaml
+            File.open(stat_file, 'w+') {|f| f.write(@box_attributes.to_yaml) }
+          end
+
+          box_stats = YAML.load_file(stat_file)
+
+          present_modification_date = box_stats["modification_date"] 
+          box_url = box_stats["url"]
+
+          if present_modification_date == nil
+            env[:ui].warn("Local box image \"modification_date\" is not set")
+            env[:ui].warn("Unable to check remote box")
+            env[:ui].warn("Please, add box again \"vagrant box add\" so it'll update image data")
+            @app.call(env)
+            return 0
+          end
+
+          if box_url == nil
+            env[:ui].warn("Local box url is not set")
+            env[:ui].warn("Unable to check remote box")
+            env[:ui].warn("Please, add box again \"vagrant box add\" so it'll update image data")
+            @app.call(env)
+            return 0
+          end
+
+          begin
+              env[:ui].info("Verify remote box modification date: #{box_url}")
+              remote_modification_date = get_remote_modification_date?(box_url)
+          rescue 
+              env[:ui].warn("Unable access: #{box_url}")
+              env[:ui].warn("Skip remote box check")
+              @app.call(env)
+              return 0
+          end
+
+          if remote_modification_date == nil
+              env[:ui].warn("Can not retrieve 'Last-Modified' attribute for: #{box_url}")
+              env[:ui].warn("Skip remote box check")
+              @app.call(env)
+              return 0
+          end
+
+          remote_modification_timestamp = Time.parse(remote_modification_date)
+          present_modification_timestamp = Time.parse(present_modification_date)
+
+          env[:ui].info("Remote box timestamp #{remote_modification_timestamp}")
+          env[:ui].info("Local box timestamp #{present_modification_timestamp}")
+
+          if present_modification_timestamp < remote_modification_timestamp
+            env[:ui].warn("Updated image detected!!!!")
+            if ask_confirm(env,"Would you like to update the box? (Y/N)")
+              env[:ui].info("Going to update and replace box \"#{box_name}\" now!")
+              provider = nil
+              env[:action_runner].run(Vagrant::Action.action_box_add, {
+                :box_name     => box_name,
+                :box_provider => provider,
+                :box_url      => box_url,
+                :box_force    => true,
+                :box_download_insecure => true,
+               })
+            else
+            env[:ui].warn("Update disabled")    
+            @app.call(env)
+            end
+          end
+
+          env[:ui].info("Box is uptodate")    
+          @app.call(env)
+        end
+        
+        private 
+
+        def ask_confirm(env, message)
+          choice = nil
+          # If we have a force key set and we're forcing, then set
+          # the result to "Y"
+          choice = "Y" if @force_key && env[@force_key]
+          # If we haven't chosen yes, then ask the user via TTY
+          choice = env[:ui].ask(message) if !choice
+          # The result is only true if the user said "Y"
+          result = choice && choice.upcase == "Y"
+          return result  
+        end
+
+        def get_remote_modification_date?(url)
+          require 'open-uri'
+          require 'net/http'
+          url = URI.parse(url)
+          Net::HTTP.start(url.host, url.port) do |http|
+            response = http.head(url.request_uri)
+            return response['Last-Modified']
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-box-updater/config.rb

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module BoxUpdater
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :disable
+
+      def initialize
+        @disable = false
+      end
+
+      def finalize!
+        @disable = false if @disable == UNSET_VALUE
+      end
+
+      def validate(machine)
+        {}
+      end
+    end
+  end
+end

data/lib/vagrant-box-updater/plugin.rb

@@ -0,0 +1,24 @@
+module VagrantPlugins
+  module BoxUpdater
+    class Plugin < Vagrant.plugin('2')
+      name 'Vagrant BoxUpdater'
+      description 'Plugin allows to check source box for updates and interactively prompt user when update is available.'
+
+      config(:box_updater) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook 'do-before-boot' do |hook|
+        require_relative 'action/up_box'
+        hook.before ::Vagrant::Action::Builtin::ConfigValidate, VagrantPlugins::BoxUpdater::Action::UpBox
+      end
+
+      action_hook 'on_update' do |hook|
+        require_relative 'action/add_box'
+        hook.after ::Vagrant::Action::Builtin::BoxAdd, VagrantPlugins::BoxUpdater::Action::AddBox
+      end
+
+    end
+  end 
+end

data/lib/vagrant-box-updater/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+    module BoxUpdater
+      VERSION = "0.0.2"
+    end
+  end

data/lib/vagrant_init.rb

@@ -0,0 +1 @@
+require 'vagrant-box-updater'

data/vagrant-box-updater.gemspec

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-box-updater/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vagrant-box-updater"
+  gem.version       = Vagrant::BoxUpdater::VERSION
+  gem.authors       = ["Ruslan Lutsenko"]
+  gem.email         = ["ruslan.lutcenko@gmail.com"]
+  gem.description   = "vagrant plugin which save details about added box image (image creation timestamp image source path), during start of virtual machine checks the source url of a box image for updates (use 'Last-Modified' header to detect changes), notify user and perform interactive download of the box image if update detected"
+  gem.summary       = "vagrant plugin to monitor and notify about updates of remote box images"
+  gem.homepage      = ""
+
+  #gem.files         = `git ls-files`.split($/)
+  #gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  #gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  #gem.require_paths = ["lib"]
+	# The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  gem.files         = unignored_files
+  gem.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  gem.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-box-updater
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ruslan Lutsenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies: []
+description: vagrant plugin which save details about added box image (image creation
+  timestamp image source path), during start of virtual machine checks the source
+  url of a box image for updates (use 'Last-Modified' header to detect changes), notify
+  user and perform interactive download of the box image if update detected
+email:
+- ruslan.lutcenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- vagrant-box-updater.gemspec
+- lib/vagrant-box-updater/version.rb
+- lib/vagrant-box-updater/action/up_box.rb
+- lib/vagrant-box-updater/action/add_box.rb
+- lib/vagrant-box-updater/config.rb
+- lib/vagrant-box-updater/plugin.rb
+- lib/vagrant_init.rb
+- lib/vagrant-box-updater.rb
+- Rakefile
+- LICENSE.txt
+- README.md
+- .gitignore
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: vagrant plugin to monitor and notify about updates of remote box images
+test_files: []