vagrant-box-updater 0.0.2 → 0.0.3

data/README.md

@@ -1,46 +1,52 @@
 # 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
+Vagrant 1.1+ plugin to detect changes to a remote box's creation date,
+and perform an interactive update if desired.
 
-  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.
+By default Vagrant just store box images locally and never checks if
+there are updates for that image. Users may therefore 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. 
+This plugin hooks into `vagrant box add` and `vagrant up`, saving
+details about each box sources creation date, and optioning performing
+an update when a change is detected.
 
+## Installation
 
-  vagrant plugin hooks into :
+    vagrant plugin install vagrant-box-updater
 
-	"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);
+## Usage
 
-	"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.
- 
+After plugin installed it's recommended to re-add box images so that the
+plugin can collect necessary information about the box.
 
-## Installation
+    vagrant box add --force <source_uri>
 
-Note: plugin is written for Vagrant version 1.1 and higher
+To disable the plugin for a project:
 
-To install from gem repository:
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise64"
+  config.vm.box_url = "http://files.vagrantup.com/precise64.box"
 
-vagrant plugin install vagrant-box-updater
+  config.box_updater.disable = true
 
-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" 
+end
+```
 
-## 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).
+## Install from source (Advanced)
 
-It is possible to disable plugin by adding configuration parameter to Vagrantfile:
+1. Clone project
+2. Create a gem file: `rake build`
+3. Install local gem: `vagrant plugin install pkg/vagrant-box-updater-0.0.1.gem`
 
-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`)
+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/lib/vagrant-box-updater/action/add_box.rb

@@ -1,4 +1,7 @@
 require 'yaml'
+require 'net/http'
+require 'uri'
+require 'vagrant-box-updater/util/common'
 
 module VagrantPlugins
   module BoxUpdater
@@ -12,32 +15,20 @@ module VagrantPlugins
         def call(env)
           box_url = env[:box_url]
           box_name = env[:box_name]
-
           begin
-            remote_modification_date = get_remote_modification_date?(box_url)
+            modification_attribute = Util::Common.get_modification_attribute(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) }
+          @box_attributes = {"url" => box_url}.merge(modification_attribute)
+	  path_box_stat_file = Util::Common.get_path_box_stat_file(env, box_name)
+	  Util::Common.save_box_stats(path_box_stat_file, @box_attributes)
           @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

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

@@ -1,4 +1,7 @@
 require 'yaml'
+require 'net/http'
+require 'uri'
+require 'vagrant-box-updater/util/common'
 
 module VagrantPlugins
   module BoxUpdater
@@ -13,6 +16,7 @@ module VagrantPlugins
           require 'time'
           box_name = env[:machine].config.vm.box
           box_url  = env[:machine].config.vm.box_url
+	  path_box_stat_file = Util::Common.get_path_box_stat_file(env, box_name)
 
           disable_plugin_flag = env[:machine].config.box_updater.disable
           if disable_plugin_flag == true
@@ -20,26 +24,38 @@ module VagrantPlugins
             @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) }
+	    Util::Common.save_box_stats(path_box_stat_file, @box_attributes)
           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")
+          current_modification_date = box_stats["Last-Modified"] 
+	  # "Etag" attribute is not in use - but we may use it in future 
+	  # What we trying to achieve : some public resources such as github.com does not provide "Last-Modified"
+	  # but "Etag" id, so optionally we may need number of generic methods to decide if object modified
+          current_modification_etag = box_stats["Etag"] 
+
+          if current_modification_date == nil and current_modification_etag != nil
+            env[:ui].warn("Not enough data to decide whether image need to be updated")
+            env[:ui].warn("Remote server does not provide \"Last-Modified\" field in the header but \"Etag\" which is not supported at the moment")
+            env[:ui].warn("This is known issue for some websites (like github.com)")
+            env[:ui].warn("If you want to have this functionality added, please, fire feature request on oficial plugin page on github")
+            @app.call(env)
+            return 0
+          end
+
+          if current_modification_date == nil
+            env[:ui].warn("Not enough data to decide whether image need to be updated")
+            env[:ui].warn("Please, add box again \"vagrant box add -f\" so it'll update image data")
             @app.call(env)
             return 0
           end
@@ -47,53 +63,59 @@ module VagrantPlugins
           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")
+            env[:ui].warn("Please, add box again \"vagrant box add -f\" 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)
+            env[:ui].info("Verify remote image data: #{box_url}")
+            remote_modification_attribute = Util::Common.get_modification_attribute(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
+            env[:ui].warn("Unable access: #{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")    
+          if remote_modification_attribute['Last-Modified'] == nil
+            env[:ui].warn("Can not retrieve any useful data for: #{box_url}")
+            env[:ui].warn("Skip remote box check")
             @app.call(env)
-            end
+            return 0
+          end
+          remote_modification_timestamp = remote_modification_attribute['Last-Modified'].is_a?(Time) ? remote_modification_attribute['Last-Modified'] : Time.parse(remote_modification_attribute['Last-Modified'])
+          current_modification_timestamp = current_modification_date.is_a?(Time) ? current_modification_date : Time.parse(current_modification_date)
+
+          #env[:ui].info("Remote box timestamp #{remote_modification_timestamp}")
+          #env[:ui].info("Local box timestamp #{current_modification_timestamp}")
+
+          if current_modification_timestamp.to_i < remote_modification_timestamp.to_i
+	    box_stats = Util::Common.read_box_stats(path_box_stat_file, box_name)
+	    if box_stats['ignored_image_attribute'] and box_stats['ignored_image_attribute'].to_i == remote_modification_timestamp.to_i
+              env[:ui].warn("Modified image detected, this update set to be ignored until next change")
+	    else
+              env[:ui].warn("Modified image detected : #{box_stats['url']} #{remote_modification_attribute}")
+	      if ask_confirm(env,"Would you like to update the box? \nIf negative - we keep ignoring this update, and notify only when another update detected. \nType (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("This update will be ignored")   
+	        Util::Common.add_box_stats(path_box_stat_file, {'ignored_image_attribute' => remote_modification_timestamp})
+                @app.call(env)
+              end
+	    end
+	  else
+            env[:ui].info("Box is uptodate")
           end
 
-          env[:ui].info("Box is uptodate")    
           @app.call(env)
         end
         
@@ -111,16 +133,6 @@ module VagrantPlugins
           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

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

@@ -9,9 +9,15 @@ module VagrantPlugins
         Config
       end
 
-      action_hook 'do-before-boot' do |hook|
-        require_relative 'action/up_box'
-        hook.before ::Vagrant::Action::Builtin::ConfigValidate, VagrantPlugins::BoxUpdater::Action::UpBox
+     # action_hook 'do-before-boot' do |hook|
+     #   require_relative 'action/up_box'
+     #   #hook.after ::Vagrant::Action::Builtin::ConfigValidate, VagrantPlugins::BoxUpdater::Action::UpBox
+     #   hook.before Vagrant::Action::Builtin::Provision, VagrantPlugins::BoxUpdater::Action::UpBox
+     # end
+
+      action_hook(:do_before_boot, :machine_action_up) do |hook|
+	require_relative 'action/up_box'
+        hook.prepend(VagrantPlugins::BoxUpdater::Action::UpBox)
       end
 
       action_hook 'on_update' do |hook|

data/lib/vagrant-box-updater/util/common.rb

@@ -0,0 +1,76 @@
+module VagrantPlugins
+  module BoxUpdater
+    module Util
+      class Common
+
+        def self.get_path_box_stat_file(env, box_name)
+          YAML::ENGINE.yamler='syck'
+          stat_file = env[:home_path].join(box_name + ".stat")
+	  return stat_file
+        end
+
+        def self.save_box_stats(stat_file, box_attributes)
+          YAML::ENGINE.yamler='syck'
+          File.open(stat_file, 'w+') {|f| f.write(box_attributes.to_yaml) }
+        end
+
+        def self.add_box_stats(stat_file, box_attributes)
+          YAML::ENGINE.yamler='syck'
+	  content = YAML.load_file(stat_file)
+	  content = content.merge(box_attributes)
+          #env[:ui].info("Save to: #{stat_file}")
+          File.open(stat_file, 'w+') {|f| f.write(content.to_yaml) }
+        end
+
+        def self.read_box_stats(stat_file, box_name)
+          YAML::ENGINE.yamler='syck'
+	  content = YAML.load_file(stat_file)
+	  return content
+        end
+
+        def self.get_modification_attribute(box_path)
+          if !box_path.start_with? "http"
+            ref_modification_attribute = method(:get_local_file_modification_date?)
+          else
+            ref_modification_attribute = method(:get_url_modification_attribute?)
+          end
+            modification_attribute = ref_modification_attribute.call(box_path)
+            return modification_attribute
+        end
+        
+        def self.get_url_modification_attribute?(url)
+          response = fetch_url(url)
+          return { 'Last-Modified' => response['Last-Modified'] } if response['Last-Modified']
+          return { 'Etag' => response['ETag'].delete("\"") } if response['Etag']
+        end
+        
+        def self.fetch_url(uri_str, limit = 10)
+          # You should choose better exception.
+          raise ArgumentError, 'HTTP redirect too deep' if limit == 0
+        
+          uri = URI.parse(uri_str)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = (uri.port == 443)
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        
+          #request = Net::HTTP::Get.new(uri.request_uri, { 'User-Agent' => 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.63 Safari/537.31' })
+          #response = Net::HTTP.start(uri.host, uri.port) { |http| http.request(request) }
+          #response = http.request(request)
+          response = http.head(uri.request_uri)
+          case response
+          when Net::HTTPSuccess     then response
+          when Net::HTTPRedirection then fetch_url(response['location'], limit - 1)
+          else
+            response.error!
+          end
+        end
+        
+        def self.get_local_file_modification_date?(url)
+          mtime = File.mtime(url)
+          return { 'Last-Modified' => mtime }
+        end
+
+      end
+    end
+  end
+end

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

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

data/out.txt

@@ -0,0 +1,40 @@
+HTTP/1.1 302 Found
+Server: GitHub.com
+Date: Fri, 07 Jun 2013 21:33:10 GMT
+Content-Type: text/html; charset=utf-8
+Connection: keep-alive
+Status: 302 Found
+Cache-Control: no-cache
+X-RateLimit-Limit: 100
+X-RateLimit-Remaining: 100
+X-Frame-Options: deny
+Access-Control-Allow-Origin: https://render.github.com
+Location: https://raw.github.com/cloudbau/vagrant-openstack-plugin/master/dummy.box
+X-Runtime: 20
+Content-Length: 139
+Vary: Accept-Encoding
+
+HTTP/1.1 200 OK
+Date: Fri, 07 Jun 2013 21:33:10 GMT
+Server: GitHub.com
+Content-Type: text/plain
+Status: 200 OK
+X-RateLimit-Limit: 100
+X-RateLimit-Remaining: 100
+X-Frame-Options: deny
+Access-Control-Allow-Origin: https://render.github.com
+X-Content-Type-Options: nosniff
+Content-Disposition: attachment; filename=dummy.box
+Content-Transfer-Encoding: binary
+X-Runtime: 13
+ETag: "bc98c4c9dbf7e8c513544a2615758fec"
+Content-Length: 685
+Accept-Ranges: bytes
+Via: 1.1 varnish
+Age: 0
+X-Served-By: cache-a39-AMS
+X-Cache: MISS
+X-Cache-Hits: 0
+Vary: Accept-Encoding
+Cache-Control: private
+

data/vagrant-box-updater.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |gem|
   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.summary       = "Vagrant plugin to detect and notify on update of remote box images"
+  gem.homepage      = "https://github.com/spil-ruslan/vagrant-box-updater"
 
   #gem.files         = `git ls-files`.split($/)
   #gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-box-updater
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-06-18 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
@@ -23,7 +23,9 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - vagrant-box-updater.gemspec
+- out.txt
 - lib/vagrant-box-updater/version.rb
+- lib/vagrant-box-updater/util/common.rb
 - lib/vagrant-box-updater/action/up_box.rb
 - lib/vagrant-box-updater/action/add_box.rb
 - lib/vagrant-box-updater/config.rb
@@ -34,7 +36,7 @@ files:
 - LICENSE.txt
 - README.md
 - .gitignore
-homepage: ''
+homepage: https://github.com/spil-ruslan/vagrant-box-updater
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -57,5 +59,5 @@ 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
+summary: Vagrant plugin to detect and notify on update of remote box images
 test_files: []