vagrant-proxyconf 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,6 +1,12 @@
+# 0.2.0 / 2013-07-05
+
+- Add Apt proxy configuration for FTP URIs ([GH-5][])
+- Warn and fail if Vagrant is older than v1.2.0 ([GH-7][])
+- New [home page](http://tmatilai.github.io/vagrant-proxyconf/) ([GH-8][])
+
 # 0.1.1 / 2013-06-27
 
-- Don't crash if there is no configuration for us in the Vagrantfiles ([GH-2])
+- Don't crash if there is no configuration for us in the Vagrantfiles ([GH-2][])
     * Related [Vagrant issue](https://github.com/mitchellh/vagrant/issues/1877)
 
 # 0.1.0 / 2013-06-27
@@ -11,3 +17,6 @@
 
 
 [GH-2]:  https://github.com/tmatilai/vagrant-proxyconf/issues/2  "Issue 2"
+[GH-5]:  https://github.com/tmatilai/vagrant-proxyconf/issues/5  "Issue 5"
+[GH-7]:  https://github.com/tmatilai/vagrant-proxyconf/issues/7  "Issue 7"
+[GH-8]:  https://github.com/tmatilai/vagrant-proxyconf/issues/8  "Issue 8"

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 gem 'rake'
 gem 'rspec', '~> 2.11'
 gem 'tailor', '~> 1.2'
-gem 'vagrant', github: 'mitchellh/vagrant'
+gem 'vagrant', github: 'mitchellh/vagrant', ref: 'v1.2.2'
 
 group :development do
   gem 'guard-rspec'

data/README.md

@@ -1,5 +1,6 @@
 # Vagrant Proxy Configuration Plugin
 
+<span class="badges">
 [![Gem Version](https://badge.fury.io/rb/vagrant-proxyconf.png)][gem]
 [![Build Status](https://travis-ci.org/tmatilai/vagrant-proxyconf.png?branch=master)][travis]
 [![Dependency Status](https://gemnasium.com/tmatilai/vagrant-proxyconf.png)][gemnasium]
@@ -9,52 +10,85 @@
 [travis]: https://travis-ci.org/tmatilai/vagrant-proxyconf
 [gemnasium]: https://gemnasium.com/tmatilai/vagrant-proxyconf
 [codeclimate]: https://codeclimate.com/github/tmatilai/vagrant-proxyconf
+</span>
 
-A [Vagrant](http://www.vagrantup.com/) 1.1+ plugin that configures the virtual machine to use specified proxies for package managers etc.
+A [Vagrant](http://www.vagrantup.com/) plugin that configures the virtual machine to use specified proxies for package managers etc.
 
 At this state we support:
 
-- [APT](http://en.wikipedia.org/wiki/Advanced_Packaging_Tool) proxy/cacher
+* [APT](http://en.wikipedia.org/wiki/Advanced_Packaging_Tool) proxy/cacher
 
 Support is planned for other package managers (at least yum).
 
-## Usage
+## Installation
+
+**Note:** This plugin requires Vagrant v1.2 or newer ([downloads](http://downloads.vagrantup.com/)).
+
+Install using standard Vagrant plugin installation method:
 
-Install using standard Vagrant 1.1+ plugin installation method:
 ```sh
 vagrant plugin install vagrant-proxyconf
 ```
 
+## Usage
+
+Proxy settings can be configured in Vagrantfile. In the common case that you want to use the same configuration in all Vagrant machines, you can use _$HOME/.vagrant.d/Vagrantfile_ or environment variables. Package manager specific settings are only used on supporting platforms (i.e. Apt configuration on Debian based systems), so there is no harm using global configuration.
+
+Project specific Vagrantfile overrides global settings. Environment variables override both.
+
 ### Apt
 
-The proxy for Apt can be specified in the Vagrantfile. You might want to set it to all boxes, in which case use _$HOME/.vagrant.d/Vagrantfile_. The configuration only triggers on Debian based machines, so there is no harm in setting it globally.
+Configures Apt to use the specified proxy settings. The configuration will be written to _/etc/apt/apt.conf.d/01proxy_ on the guest.
+
+#### Example Vagrantfile
 
-Example configuration:
 ```ruby
 Vagrant.configure("2") do |config|
-
-  config.apt_proxy.http = "192.168.33.1:3142"
-
+  config.apt_proxy.http  = "192.168.33.1:3142"
+  config.apt_proxy.https = "DIRECT"
   # ... other stuff
 end
 ```
 
-The proxy can be specified as an IP address, name or full URL, with optional port (defaults to 3142).
+#### Configuration keys
+
+* `config.apt_proxy.http`  - The proxy for HTTP URIs
+* `config.apt_proxy.https` - The proxy for HTTPS URIs
+* `config.apt_proxy.ftp`   - The proxy for FTP URIs
+
+#### Possible values
+
+* If all keys are unset or `nil`, no configuration is written.
+* A proxy can be specified in the form of _[http://][user:pass@]host[:port]_. So all but the _host_ part are optional. The default port is 3142 and protocol is the same as the key.
+* Empty string (`""`) or `false` in any protocol also force the configuration file to be written, but without configuration for that protocol. Can be used to clear the old configuration and/or override a global setting.
+* `"DIRECT"` can be used to specify that no proxy should be used. This is mostly useful for disabling proxy for HTTPS URIs when HTTP proxy is set (as Apt defaults to the latter).
+* Please refer to [apt.conf(5)](http://manpages.debian.net/man/5/apt.conf) manual for more information.
+
+#### Environment variables
+
+* `APT_PROXY_HTTP`
+* `APT_PROXY_HTTPS`
+* `APT_PROXY_FTP`
+
+These also override the Vagrantfile configuration. To disable or remove the proxy use "DIRECT" or an empty value.
+
+For example to spin up a VM, run:
 
-You can also use `APT_PROXY_HTTP` and `APT_PROXY_HTTPS` environment variables. These override the Vagrantfile configuration. To disable or remove the proxy use "DIRECT" or an empty value. For example to spin up a VM while overriding a globally configured proxy, run:
 ```sh
-APT_PROXY_HTTP="10.5.5.200:8080" vagrant up
+APT_PROXY_HTTP="proxy.example.com:8080" vagrant up
 ```
 
-Proxy settings will be written to _/etc/apt/apt.conf.d/01proxy_ on the guest.
-
 #### Running apt-cacher-ng on a Vagrant box
 
 [Here](https://github.com/tmatilai/apt-cacher-box) is an example for setting up apt-cacher proxy server in a Vagrant VM.
 
 ## Related plugins and projects
 
-- [apt-cacher-box](https://github.com/tmatilai/apt-cacher-box) (Vagrant setup for apt-cacher-ng)
-- [vagrant-cachier](https://github.com/fgrehm/vagrant-cachier) (Vagrant plugin)
-- [vagrant-httpproxy](https://github.com/juliandunn/vagrant-httpproxy) (Chef cookbook)
-- [vagrant-proxy](https://github.com/clintoncwolfe/vagrant-proxy) (Vagrant plugin)
+* [apt-cacher-box](https://github.com/tmatilai/apt-cacher-box)<br/>
+  a Vagrant setup for apt-cacher-ng.
+* [vagrant-cachier](https://github.com/fgrehm/vagrant-cachier)<br/>
+  An excellent Vagrant plugin that shares various cache directories among similar VM instances. Should work fine together with vagrant-proxyconf.
+* [vagrant-httpproxy](https://github.com/juliandunn/vagrant-httpproxy)<br/>
+  A Chef cookbook for configuring Chef resources to use the specified proxy (while offline).
+* [vagrant-proxy](https://github.com/clintoncwolfe/vagrant-proxy)<br/>
+  A Vagrant plugin that uses iptables rules to force the VM to use a proxy.

data/Rakefile

@@ -14,6 +14,7 @@ namespace :test do
 end
 desc "Run all tests"
 task :test => ['test:unit']
+task :spec => :test
 
 Tailor::RakeTask.new do |task|
   task.file_set('lib/**/*.rb', 'code') do |style|
@@ -26,3 +27,16 @@ Tailor::RakeTask.new do |task|
     style.spaces_before_lbrace 1, level: :off
   end
 end
+
+desc "Update gh-pages"
+task 'gh-pages' do
+  require 'tmpdir'
+
+  rev = `git rev-parse HEAD`.chomp
+  Dir.mktmpdir do |clone|
+    sh %Q{git clone --branch gh-pages "#{File.expand_path('..', __FILE__)}" "#{clone}"}
+    Dir.chdir(clone) do
+      sh %Q{_bin/update "#{rev}"}
+    end
+  end
+end

data/lib/vagrant-proxyconf/action/configure_apt_proxy.rb

@@ -32,6 +32,8 @@ module VagrantPlugins
           end
         end
 
+        private
+
         def write_apt_proxy_conf(machine, config)
           logger.debug "Configuration:\n#{config}"
 

data/lib/vagrant-proxyconf/config/apt_proxy.rb

@@ -0,0 +1,97 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module ProxyConf
+    module Config
+      class AptProxy < Vagrant.plugin('2', :config)
+        # HTTP proxy for Apt
+        attr_accessor :http
+
+        # HTTPS proxy for Apt
+        attr_accessor :https
+
+        # FTP proxy for Apt
+        attr_accessor :ftp
+
+        def initialize
+          @http  = UNSET_VALUE
+          @https = UNSET_VALUE
+          @ftp   = UNSET_VALUE
+        end
+
+        def finalize!
+          @http = override_from_env_var('http', @http)
+          @http = nil if @http == UNSET_VALUE
+
+          @https = override_from_env_var('https', @https)
+          @https = nil if @https == UNSET_VALUE
+
+          @ftp = override_from_env_var('ftp', @ftp)
+          @ftp = nil if @ftp == UNSET_VALUE
+        end
+
+        def enabled?
+          !http.nil? || !https.nil? || !ftp.nil?
+        end
+
+        # @return [String] the full configuration stanza
+        def to_s
+          %w[http https ftp].map { |proto| config_for(proto) }.join
+        end
+
+        private
+
+        def override_from_env_var(proto, default)
+          ENV.fetch("APT_PROXY_#{proto.upcase}", default)
+        end
+
+        def config_for(proto)
+          ConfigValue.new(proto, send(proto.to_sym))
+        end
+
+        class ConfigValue
+
+          attr_reader :proto, :value
+
+          # @param proto [String] the protocol ("http", "https", ...)
+          # @param value [Object] the configuration value
+          def initialize(proto, value)
+            @proto = proto
+            @value = value
+          end
+
+          # @return [String] the full Apt configuration line
+          def to_s
+            set? ? %Q{Acquire::#{proto}::Proxy "#{proxy_uri}";\n} : ""
+          end
+
+          private
+
+          def set?
+            value && !value.empty?
+          end
+
+          def direct?
+            value.upcase == "DIRECT"
+          end
+
+          def proxy_uri
+            direct? ? "DIRECT" : "#{prefix}#{value}#{suffix}"
+          end
+
+          def prefix
+            "#{proto}://" if value !~ %r{^.*://}
+          end
+
+          def suffix
+            ":#{default_port}" if value !~ %r{:\d+$}
+          end
+
+          def default_port
+            3142
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/plugin.rb

@@ -3,11 +3,28 @@ require 'vagrant'
 module VagrantPlugins
   module ProxyConf
     class Plugin < Vagrant.plugin('2')
+      # The minimum compatible Vagrant version
+      MIN_VAGRANT_VERSION = '1.2.0'
+
+      # Verifies that the Vagrant version fulfills the requirements
+      #
+      # @raise [VagrantPlugins::ProxyConf::VagrantVersionError] if this plugin
+      # is incompatible with the Vagrant version
+      def self.check_vagrant_version!
+        if Gem::Version.new(Vagrant::VERSION) < Gem::Version.new(MIN_VAGRANT_VERSION)
+          msg = "vagrant-proxyconf plugin requires Vagrant #{MIN_VAGRANT_VERSION} or newer"
+          $stderr.puts msg
+          raise msg
+        end
+      end
+
+      check_vagrant_version!
+
       name 'vagrant-proxyconf'
 
-      config('apt_proxy') do
-        require_relative 'apt_proxy_config'
-        AptProxyConfig
+      config 'apt_proxy' do
+        require_relative 'config/apt_proxy'
+        Config::AptProxy
       end
 
       guest_capability 'debian', 'apt_proxy_conf' do
@@ -16,7 +33,7 @@ module VagrantPlugins
       end
 
       proxyconf_action_hook = lambda do |hook|
-        require_relative 'action'
+        require_relative 'action/configure_apt_proxy'
         hook.after Vagrant::Action::Builtin::Provision, Action::ConfigureAptProxy
       end
       action_hook 'proxyconf-machine-up', :machine_action_up, &proxyconf_action_hook

data/lib/vagrant-proxyconf/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ProxyConf
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/spec/unit/vagrant-proxyconf/{apt_proxy_config_spec.rb → config/apt_proxy_spec.rb}

@@ -1,13 +1,13 @@
 require 'spec_helper'
 require 'unit/support/shared/apt_proxy_config'
-require 'vagrant-proxyconf/apt_proxy_config'
+require 'vagrant-proxyconf/config/apt_proxy'
 
-describe VagrantPlugins::ProxyConf::AptProxyConfig do
+describe VagrantPlugins::ProxyConf::Config::AptProxy do
   let(:instance) { described_class.new }
 
   before :each do
     # Ensure tests are not affected by environment variables
-    %w[APT_PROXY_HTTP APT_PROXY_HTTPS].each { |k| ENV.delete(k) }
+    %w[APT_PROXY_HTTP APT_PROXY_HTTPS APT_PROXY_FTP].each { |k| ENV.delete(k) }
   end
 
   context "defaults" do
@@ -18,6 +18,7 @@ describe VagrantPlugins::ProxyConf::AptProxyConfig do
 
   include_examples "apt proxy config", "http"
   include_examples "apt proxy config", "https"
+  include_examples "apt proxy config", "ftp"
 
   context "with both http and https proxies" do
     subject        { config_with(http: "10.2.3.4", https: "ssl-proxy:8443") }
@@ -29,6 +30,7 @@ describe VagrantPlugins::ProxyConf::AptProxyConfig do
   context "with env var" do
     include_examples "apt proxy env var", "APT_PROXY_HTTP", "http"
     include_examples "apt proxy env var", "APT_PROXY_HTTPS", "https"
+    include_examples "apt proxy env var", "APT_PROXY_FTP", "ftp"
   end
 
 end

data/spec/unit/vagrant-proxyconf/plugin_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/plugin'
+
+describe VagrantPlugins::ProxyConf::Plugin do
+
+  describe ".check_vagrant_version!" do
+    let(:min_vagrant_verision) { '1.2.3' }
+    let(:err_msg) { /requires Vagrant #{min_vagrant_verision}/ }
+
+    before :each do
+      stub_const('VagrantPlugins::ProxyConf::Plugin::MIN_VAGRANT_VERSION', min_vagrant_verision)
+      stub_const('Vagrant::VERSION', vagrant_version)
+      $stderr.stub(:puts)
+    end
+
+    context "on too old Vagrant version" do
+      let(:vagrant_version) { '1.1.5' }
+      it "raises" do
+        expect { described_class.check_vagrant_version! }.to raise_error(err_msg)
+      end
+      it "warns" do
+        $stderr.should_receive(:puts).with(err_msg)
+        described_class.check_vagrant_version! rescue nil
+      end
+    end
+
+    context "on exact required Vagrant version" do
+      let(:vagrant_version) { min_vagrant_verision }
+      it "does not raise" do
+        expect { described_class.check_vagrant_version! }.not_to raise_error
+      end
+    end
+
+    context "on newer Vagrant version" do
+      let(:vagrant_version) { '1.3.5' }
+      it "does not raise" do
+        expect { described_class.check_vagrant_version! }.not_to raise_error
+      end
+    end
+  end
+
+end

data/vagrant-proxyconf.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["teemu.matilainen@iki.fi"]
   spec.description   = "A Vagrant Plugin that configures the virtual machine to use proxies"
   spec.summary       = spec.description
-  spec.homepage      = "https://github.com/tmatilai/vagrant-proxyconf"
+  spec.homepage      = "http://tmatilai.github.io/vagrant-proxyconf/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-proxyconf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies: []
 description: A Vagrant Plugin that configures the virtual machine to use proxies
 email:
@@ -30,17 +30,17 @@ files:
 - development/README.md
 - development/Vagrantfile.example
 - lib/vagrant-proxyconf.rb
-- lib/vagrant-proxyconf/action.rb
 - lib/vagrant-proxyconf/action/configure_apt_proxy.rb
-- lib/vagrant-proxyconf/apt_proxy_config.rb
 - lib/vagrant-proxyconf/cap/debian/apt_proxy_conf.rb
+- lib/vagrant-proxyconf/config/apt_proxy.rb
 - lib/vagrant-proxyconf/plugin.rb
 - lib/vagrant-proxyconf/version.rb
 - spec/spec_helper.rb
 - spec/unit/support/shared/apt_proxy_config.rb
-- spec/unit/vagrant-proxyconf/apt_proxy_config_spec.rb
+- spec/unit/vagrant-proxyconf/config/apt_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/plugin_spec.rb
 - vagrant-proxyconf.gemspec
-homepage: https://github.com/tmatilai/vagrant-proxyconf
+homepage: http://tmatilai.github.io/vagrant-proxyconf/
 licenses:
 - MIT
 post_install_message: 
@@ -55,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4594869159718557476
+      hash: -654121375063372740
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4594869159718557476
+      hash: -654121375063372740
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -74,4 +74,5 @@ summary: A Vagrant Plugin that configures the virtual machine to use proxies
 test_files:
 - spec/spec_helper.rb
 - spec/unit/support/shared/apt_proxy_config.rb
-- spec/unit/vagrant-proxyconf/apt_proxy_config_spec.rb
+- spec/unit/vagrant-proxyconf/config/apt_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/plugin_spec.rb

data/lib/vagrant-proxyconf/action.rb

@@ -1 +0,0 @@
-require_relative 'action/configure_apt_proxy'

data/lib/vagrant-proxyconf/apt_proxy_config.rb

@@ -1,88 +0,0 @@
-require 'vagrant'
-
-module VagrantPlugins
-  module ProxyConf
-    class AptProxyConfig < Vagrant.plugin('2', :config)
-      # HTTP proxy for Apt
-      attr_accessor :http
-
-      # HTTPS proxy for Apt
-      attr_accessor :https
-
-      def initialize
-        @http  = UNSET_VALUE
-        @https = UNSET_VALUE
-      end
-
-      def finalize!
-        @http = override_from_env_var('http', @http)
-        @http = nil if @http == UNSET_VALUE
-
-        @https = override_from_env_var('https', @https)
-        @https = nil if @https == UNSET_VALUE
-      end
-
-      def enabled?
-        !http.nil? || !https.nil?
-      end
-
-      # @return [String] the full configuration stanza
-      def to_s
-        "#{config_for('http')}#{config_for('https')}"
-      end
-
-      private
-
-      def override_from_env_var(proto, default)
-        ENV.fetch("APT_PROXY_#{proto.upcase}", default)
-      end
-
-      def config_for(proto)
-        ConfigValue.new(proto, send(proto.to_sym))
-      end
-
-      class ConfigValue
-
-        attr_reader :proto, :value
-
-        # @param proto [String] the protocol ("http", "https")
-        # @param value [Object] the configuration value
-        def initialize(proto, value)
-          @proto = proto
-          @value = value
-        end
-
-        # @return [String] the full Apt configuration line
-        def to_s
-          set? ? %Q{Acquire::#{proto}::Proxy "#{proxy_uri}";\n} : ""
-        end
-
-        private
-
-        def set?
-          value && !value.empty?
-        end
-
-        def direct?
-          value.upcase == "DIRECT"
-        end
-
-        def proxy_uri
-          direct? ? "DIRECT" : "#{prefix}#{value}#{suffix}"
-        end
-
-        def prefix
-          "#{proto}://" if value !~ %r{^.*://}
-        end
-
-        def suffix
-          ":#{default_port}" if value !~ %r{:\d+$}
-        end
-
-        def default_port
-          3142
-        end
-      end
-    end
-  end
-end