vagrant-save 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b61d2c1869c2781c59cce9b501e55fc56ee2dca6
+  data.tar.gz: 0b6b807477ce3b01e6e133c1153e25331b81aa2c
+SHA512:
+  metadata.gz: 3e9cf1802217aeccfae0f99107cee0a8115699ed1241b1530670ed9c57c593ac9ab949385b38251e5a14803005bc299e9ead422fa3fe088cc40d153cec115008
+  data.tar.gz: 30a5948f0055017eceb7d11723da3c4b93d5c99192d65a8e47c7e1f74fb971415af0a87591949e3e5a052cf5bd8af3289c855f184ab235fe5e2762bf13b88b2a

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Gemfile.lock
+/.idea
+/.vagrant
+*.gem

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+group :development do
+	  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+end
+
+gem 'vagrant-export', '~> 0.2.3', git: 'https://github.com/trenker/vagrant-export.git'
+
+group :plugins do
+	  gem 'vagrant-save', path: '.'
+end

data/README.md

@@ -0,0 +1,65 @@
+# vagrant-save
+
+This is a simple plugin to export boxes into .box files using [vagrant-export](https://github.com/trenker/vagrant-export) and pushes that file to a  [boxserver](https://github.com/trenker/boxserver) instance.
+
+## Installation
+
+Like with any other vagrant plugin:
+
+```bash
+vagrant plugin install vagrant-save
+```
+
+## Usage
+
+Have a [boxserver](https://github.com/trenker/boxserver) instance running and set the property `config.vm.box_server_url` to its address in your vagrant file.
+
+Then just run
+
+```bash
+vagrant save
+```
+
+to release a new version of your box.
+
+Without any further arguments, vagrant-save will delete old versions, keeping only the last three. You can override this by setting the `-c|--clean` option.
+
+```bash
+# Keeping the last six versions
+vagrant save -c 6
+
+# Keeping all versions
+vagrant save -c 0
+```
+
+By default, it increases the bugfix version number by one. So an installed 1.0.0 becomes 1.0.1. You can specify the version yourself using the parameter `-v|--version`, like this:
+
+```bash
+vagrant save -v 1.2.0
+```
+
+The parameter must always have all three digits and must be greater than the installed version
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Georg Großberger
+
+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/Vagrantfile

@@ -0,0 +1,5 @@
+
+Vagrant.configure("2") do |config|
+  config.vm.box_server_url = "http://localhost:8001"
+  config.vm.box = "base/typo3"
+end

data/lib/vagrant-save.rb

@@ -0,0 +1,7 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+require 'vagrant-save/plugin'
+require 'vagrant-save/version'

data/lib/vagrant-save/command.rb

@@ -0,0 +1,81 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+require_relative 'errors'
+
+module VagrantPlugins
+  module Save
+    class Command < Vagrant.plugin('2', :command)
+
+      def self.synopsis
+        'exports a box file with additional actions taken'
+      end
+
+      def execute
+        options = {}
+        options[:version] = nil
+        options[:clean] = 3
+
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant save [version]'
+          o.separator ''
+
+          o.on('-c', '--clean', 'Set the version of the uploaded box') do |c|
+            options[:clean] = c.to_i
+          end
+        end
+
+        argv = parse_options(opts)
+        return 1 unless argv
+
+        target_version = options[:version]
+
+        unless target_version == nil
+          unless /^[0-9]+\.[0-9]+\.[0-9]+$/ =~ target_version
+            raise VagrantPlugins::Save::Errors::NoValidVersion
+          end
+        end
+
+        require 'vagrant-export/exporter'
+        require_relative 'uploader'
+
+        ex = VagrantPlugins::Export::Exporter.new(@env, @logger)
+        up = Uploader.new(@env, @logger)
+
+        with_target_vms argv, reverse: true do |machine|
+
+          if target_version
+            version = target_version
+
+            if Gem::Version.new(machine.box.version.to_s) <= Gem::Version.new(version)
+              raise VagrantPlugins::Save::Errors::InvalidVersion
+            end
+
+          else
+            version_parts = machine.box.version.to_s
+            if /^[0-9]+\.[0-9]+\.[0-9]+$/ =~ version_parts
+              version_parts = version_parts.split('.')
+              version = version_parts[0] + '.' + version_parts[1] + '.' + (version_parts[2].to_i + 1).to_s
+            else
+              version = '1.0.0'
+            end
+          end
+
+          file = ex.handle(machine, false, false)
+
+          up.send(machine, file, version)
+
+          FileUtils.remove(file)
+
+          if options[:clean] && options[:clean] > 1
+            up.clean(machine, options[:clean])
+          end
+
+        end
+        0
+      end
+    end
+  end
+end

data/lib/vagrant-save/errors.rb

@@ -0,0 +1,28 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+module VagrantPlugins
+  module Save
+    module Errors
+
+      class CannotContactBoxServer < VagrantError
+        error_message('Cannot contact the given box server. Please make sure the URL is correct and it is running')
+      end
+
+      class UploadFailed < VagrantError
+        error_message('Cannot upload the box file to the boxserver')
+      end
+
+      class NoValidVersion < VagrantError
+        error_message('The given version is not valid. Please pass a version number like 1.2.3, or leave it to automatically bump the bugfix/release number')
+      end
+
+      class InvalidVersion < VagrantError
+        error_message('The given version number is lower or equal to the current version of the box')
+      end
+
+    end
+  end
+end

data/lib/vagrant-save/plugin.rb

@@ -0,0 +1,23 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+module VagrantPlugins
+  module Save
+    class Plugin < Vagrant.plugin('2')
+
+      name('Vagrant Save')
+
+      description <<-EOF
+      Uses vagrant-export to create a.box file from the current machine and
+      saves it to a boxserver using a HTTP PUT request.
+      EOF
+
+      command 'save' do
+        require_relative 'command'
+        Command
+      end
+    end
+  end
+end

data/lib/vagrant-save/uploader.rb

@@ -0,0 +1,87 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+require 'httpclient'
+
+module VagrantPlugins
+  module Save
+    class Uploader
+
+      # @param [Vagrant::Environment] env
+      # @param [Log4r::Logger] logger
+      def initialize(env, logger)
+        @env = env
+        @logger = logger
+      end
+
+      # @param [Vagrant::Machine] machine
+      # @param [string] file
+      # @param [string] version
+      # @return int
+      def send(machine, file, version)
+
+        @env.ui.info('Uploading now')
+
+        provider = machine.provider_name.to_s
+        ping_url = make_url(machine)
+        post_url = ping_url + '/' + version + '/' + provider
+
+        client = HTTPClient.new
+        res = client.options(ping_url)
+
+        raise VagrantPlugins::Save::Errors::CannotContactBoxServer unless res.http_header.status_code == 200
+
+        File.open(file) do |f|
+          body = {'box' => f}
+          res = client.post(post_url, body)
+        end
+
+        raise VagrantPlugins::Save::Errors::UploadFailed unless res.http_header.status_code == 200
+
+        @env.ui.info('Upload successful')
+
+        0
+      end
+
+      # @param [Vagrant::Machine] machine
+      # @param [int] keep
+      # @return int
+      def clean(machine, keep)
+        @env.ui.info('Cleaning up old versions')
+
+        data_url = make_url(machine)
+
+        res = client.get(data_url)
+        data = JSON.parse(res.http_body)
+
+        client = HTTPClient.new
+        saved_versions = data['versions'].map{ |v| v.version}
+
+        if saved_versions.length > keep
+          saved_versions = saved_versions.sort.reverse
+          saved_versions.slice(keep, saved_versions.length).each { |v|
+            client.delete(data_url + '/' + v)
+          }
+        end
+
+        0
+      end
+
+      private
+
+      # @param [Vagrant::Machine] machine
+      # @return string
+      def make_url(machine)
+        name = machine.box.name.gsub(/_+/, '/')
+        base_url = Vagrant.server_url(machine.config.vm.box_server_url).to_s
+
+        raise Vagrant::Errors::BoxServerNotSet unless base_url
+
+        base_url + '/' + name
+      end
+
+    end
+  end
+end

data/lib/vagrant-save/version.rb

@@ -0,0 +1,10 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+module VagrantPlugins
+  module Save
+    VERSION = '0.1.0'
+  end
+end

data/vagrant-save.gemspec

@@ -0,0 +1,50 @@
+$:.unshift(File.expand_path('../lib', __FILE__))
+
+require 'vagrant-save/version'
+
+Gem::Specification.new do |g|
+  g.name          = 'vagrant-save'
+  g.version       = VagrantPlugins::Save::VERSION
+  g.platform      = Gem::Platform::RUBY
+  g.license       = 'MIT'
+  g.authors       = 'Georg Großberger'
+  g.email         = 'contact@grossberger-ge.org'
+  g.homepage      = 'https://github.com/trenker/vagrant-save.git'
+  g.summary       = 'Export boxes to a boxserver'
+  g.description   = 'Export boxes to a boxserver on a remote machine using HTTP/PUT'
+
+  # 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| %w(. ..).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
+
+  g.files         = unignored_files
+  g.require_path  = 'lib'
+  g.add_dependency 'vagrant-export', '~> 0.2.3'
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-save
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georg Großberger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vagrant-export
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+description: Export boxes to a boxserver on a remote machine using HTTP/PUT
+email: contact@grossberger-ge.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Vagrantfile
+- lib/vagrant-save.rb
+- lib/vagrant-save/command.rb
+- lib/vagrant-save/errors.rb
+- lib/vagrant-save/plugin.rb
+- lib/vagrant-save/uploader.rb
+- lib/vagrant-save/version.rb
+- vagrant-save.gemspec
+homepage: https://github.com/trenker/vagrant-save.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Export boxes to a boxserver
+test_files: []