vagrant-proxyconf 0.3.0 → 0.4.0.rc1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.4.0.rc1 / 2013-08-30
+
+- BREAKING: Environment variables for Apt config renamed to `VAGRANT_APT_HTTP_PROXY` etc. ([GH-15][])
+- Configure all supported programs with a single `config.proxy` configuration or `VAGRANT_HTTP_PROXY` etc. environment variables ([GH-14][], [GH-17][])
+- Add support for global `*_proxy` environment variables via `config.env_proxy` ([GH-6][])
+- Configure the VM also on `vagrant provision` ([GH-12][])
+    * Hook to all commands that trigger provisioning action
+- Ensure the proxies are configured before [vagrant-omnibus](https://github.com/schisamo/vagrant-omnibus) ([GH-13][])
+
 # 0.3.0 / 2013-07-12
 
 - Support the [AWS provider](https://github.com/mitchellh/vagrant-aws) ([GH-10][])
@@ -24,8 +33,14 @@
 
 [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-6]:  https://github.com/tmatilai/vagrant-proxyconf/issues/6  "Issue 6"
 [GH-7]:  https://github.com/tmatilai/vagrant-proxyconf/issues/7  "Issue 7"
 [GH-8]:  https://github.com/tmatilai/vagrant-proxyconf/issues/8  "Issue 8"
 [GH-9]:  https://github.com/tmatilai/vagrant-proxyconf/issues/9  "Issue 9"
 [GH-10]: https://github.com/tmatilai/vagrant-proxyconf/issues/10 "Issue 10"
 [GH-11]: https://github.com/tmatilai/vagrant-proxyconf/issues/11 "Issue 11"
+[GH-12]: https://github.com/tmatilai/vagrant-proxyconf/issues/12 "Issue 12"
+[GH-13]: https://github.com/tmatilai/vagrant-proxyconf/issues/13 "Issue 13"
+[GH-14]: https://github.com/tmatilai/vagrant-proxyconf/issues/14 "Issue 14"
+[GH-15]: https://github.com/tmatilai/vagrant-proxyconf/issues/15 "Issue 15"
+[GH-17]: https://github.com/tmatilai/vagrant-proxyconf/issues/17 "Issue 17"

data/Gemfile

@@ -7,7 +7,7 @@ gem 'rake'
 gem 'rspec', '~> 2.11'
 gem 'simplecov', '~> 0.7', :require => false
 gem 'tailor', '~> 1.2'
-gem 'vagrant', github: 'mitchellh/vagrant', ref: 'v1.2.2'
+gem 'vagrant', github: 'mitchellh/vagrant', ref: 'v1.2.7'
 
 group :development do
   gem 'guard-rspec'

data/README.md

@@ -12,11 +12,12 @@
 [gemnasium]: https://gemnasium.com/tmatilai/vagrant-proxyconf
 [codeclimate]: https://codeclimate.com/github/tmatilai/vagrant-proxyconf
 
-A [Vagrant](http://www.vagrantup.com/) 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.
 
 At this state we support:
 
-* [APT](http://en.wikipedia.org/wiki/Advanced_Packaging_Tool) proxy/cacher
+* Generic `*_proxy` environment variables that many programs support
+* APT proxy/cacher
 
 Support is planned for other package managers (at least yum).
 
@@ -41,12 +42,99 @@ vagrant plugin install vagrant-proxyconf
 
 ## Usage
 
-The plugin hooks itself to `vagrant up`, `vagrant reload` and `vagrant rebuild` commands.
+The plugin hooks itself to all Vagrant commands triggering provisioning (e.g. `vagrant up`, `vagrant provision`, etc.). The proxy configurations are written just before provisioners are run.
 
-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.
+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. Platform specific settings are only used on virtual machines that support them (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.
 
+### Default/global configuration
+
+It's a common case that you want all possible connections to pass through the same proxy. This will set the default values for all other proxy configuration keys.
+
+#### Example Vagrantfile
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.proxy.http     = "http://192.168.0.2:3128/"
+  config.proxy.https    = "http://192.168.0.2:3128/"
+  config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
+  # ... other stuff
+end
+```
+
+#### Configuration keys
+
+* `config.proxy.http` - The proxy for HTTP URIs
+* `config.proxy.https` - The proxy for HTTPS URIs
+* `config.proxy.ftp` - The proxy for FTS URIs
+* `config.proxy.no_proxy` - A comma separated list of hosts or domains which do not use proxies.
+
+#### Possible values
+
+* If all keys are unset or `nil`, no configuration is written.
+* A proxy should be specified in the form of _protocol://[user:pass@]host[:port]_.
+* Empty string (`""`) or `false` in any setting also force the configuration files to be written, but without configuration for that key. Can be used to clear the old configuration and/or override a global setting.
+
+#### Environment variables
+
+* `VAGRANT_HTTP_PROXY`
+* `VAGRANT_HTTPS_PROXY`
+* `VAGRANT_FTP_PROXY`
+* `VAGRANT_NO_PROXY`
+
+These also override the Vagrantfile configuration. To disable or remove the proxy use an empty value.
+
+For example to spin up a VM, run:
+
+```sh
+VAGRANT_HTTP_PROXY="http://proxy.example.com:8080" vagrant up
+```
+
+### Global `*_proxy` environment variables
+
+Many programs (wget, curl, yum, etc.) can be configured to use proxies with `<protocol>_proxy` or `<PROTOCOL>_PROXY` environment variables. This configuration will be written to _/etc/profile.d/proxy.sh_ on the guest.
+
+#### Example Vagrantfile
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.env_proxy.http     = "http://192.168.33.200:8888/"
+  config.env_proxy.https    = "$http_proxy"
+  config.env_proxy.no_proxy = "localhost,127.0.0.1,.example.com"
+  # ... other stuff
+end
+```
+
+#### Configuration keys
+
+* `config.env_proxy.http` - The proxy for HTTP URIs
+* `config.env_proxy.https` - The proxy for HTTPS URIs
+* `config.env_proxy.ftp` - The proxy for FTS URIs
+* `config.env_proxy.no_proxy` - A comma separated list of hosts or domains which do not use proxies.
+
+#### Possible values
+
+* If all keys are unset or `nil`, no configuration is written.
+* A proxy can be specified in the form of _protocol://[user:pass@]host[:port]_.
+* The values are used as specified, so you can use for example variables that will be evaluated by the shell on the VM.
+* Empty string (`""`) or `false` in any setting also force the configuration file to be written, but without configuration for that key. Can be used to clear the old configuration and/or override a global setting.
+
+#### Environment variables
+
+* `VAGRANT_ENV_HTTP_PROXY`
+* `VAGRANT_ENV_HTTPS_PROXY`
+* `VAGRANT_ENV_FTP_PROXY`
+* `VAGRANT_ENV_NO_PROXY`
+
+These also override the Vagrantfile configuration. To disable or remove the proxy use an empty value.
+
+For example to spin up a VM, run:
+
+```sh
+VAGRANT_ENV_HTTP_PROXY="http://proxy.example.com:8080" vagrant up
+```
+
 ### Apt
 
 Configures Apt to use the specified proxy settings. The configuration will be written to _/etc/apt/apt.conf.d/01proxy_ on the guest.
@@ -77,16 +165,16 @@ end
 
 #### Environment variables
 
-* `APT_PROXY_HTTP`
-* `APT_PROXY_HTTPS`
-* `APT_PROXY_FTP`
+* `VAGRANT_APT_HTTP_PROXY`
+* `VAGRANT_APT_HTTPS_PROXY`
+* `VAGRANT_APT_FTP_PROXY`
 
 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:
 
 ```sh
-APT_PROXY_HTTP="proxy.example.com:8080" vagrant up
+VAGRANT_APT_HTTP_PROXY="proxy.example.com:8080" vagrant up
 ```
 
 #### Running apt-cacher-ng on a Vagrant box

data/Rakefile

@@ -30,7 +30,7 @@ Tailor::RakeTask.new do |task|
 end
 
 Cane::RakeTask.new(:cane) do |task|
-  task.style_measure = 100
+  task.style_measure = 140
   task.options[:color] = true
 end
 

data/development/README.md

@@ -11,7 +11,7 @@
 3. Test, hack, edit _Vagrantfile_ and test again:
 
         VAGRANT_LOG=debug bundle exec vagrant reload
-        APT_PROXY_HTTP="foo:8080" bundle exec vagrant reload
+        VAGRANT_APT_HTTP_PROXY="foo:8080" bundle exec vagrant provision
         # ...
 
 4. Goto 3.

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

@@ -0,0 +1,90 @@
+require 'log4r'
+require 'tempfile'
+require 'vagrant'
+
+module VagrantPlugins
+  module ProxyConf
+    class Action
+      # Base class for proxy configuration Actions
+      class Base
+        attr_reader :logger
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant::proxyconf')
+        end
+
+        def call(env)
+          @app.call env
+
+          machine = env[:machine]
+          config  = config(machine)
+
+          if !config.enabled?
+            logger.debug I18n.t("vagrant_proxyconf.#{config_name}.not_enabled")
+          elsif !supported?(machine)
+            env[:ui].info I18n.t("vagrant_proxyconf.#{config_name}.not_supported")
+          else
+            env[:ui].info I18n.t("vagrant_proxyconf.#{config_name}.configuring")
+            write_config(machine, config)
+          end
+        end
+
+        # @return [String] the name of the configuration section
+        def config_name
+          raise NotImplementedError, "Must be implemented by the inheriting class"
+        end
+
+        private
+
+        # @return [Vagrant::Plugin::V2::Config] the configuration
+        def config(machine)
+          config = machine.config.send(config_name.to_sym)
+          finalize_config(config)
+          config.merge_defaults(default_config(machine))
+        end
+
+        # @return [Vagrant::Plugin::V2::Config] the default configuration
+        def default_config(machine)
+          config = machine.config.proxy
+          finalize_config(config)
+        end
+
+        def finalize_config(config)
+          # Vagrant pre 1.2.5 does not call `finalize!` if the configuration
+          # key is not used in Vagrantfiles.
+          # https://github.com/tmatilai/vagrant-proxyconf/issues/2
+          config.finalize! if Gem::Version.new(Vagrant::VERSION) < Gem::Version.new('1.2.5')
+          config
+        end
+
+        def write_config(machine, config)
+          logger.debug "Configuration:\n#{config}"
+
+          temp = Tempfile.new("vagrant")
+          temp.binmode
+          temp.write(config)
+          temp.close
+
+          machine.communicate.tap do |comm|
+            comm.upload(temp.path, "/tmp/vagrant-proxyconf")
+            comm.sudo("cat /tmp/vagrant-proxyconf > #{config_path(machine)}")
+            comm.sudo("rm /tmp/vagrant-proxyconf")
+          end
+        end
+
+        def cap_name
+          "#{config_name}_conf".to_sym
+        end
+
+        def supported?(machine)
+          machine.guest.capability?(cap_name)
+        end
+
+        def config_path(machine)
+          machine.guest.capability(cap_name)
+        end
+      end
+    end
+  end
+end

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

@@ -1,61 +1,12 @@
-require 'log4r'
-require 'tempfile'
+require_relative 'base'
 
 module VagrantPlugins
   module ProxyConf
     class Action
       # Action for configuring Apt on the guest
-      class ConfigureAptProxy
-        attr_reader :logger
-
-        def initialize(app, env)
-          @app    = app
-          @logger = Log4r::Logger.new('vagrant::proxyconf::action::configure_apt_proxy')
-        end
-
-        def call(env)
-          @app.call env
-
-          proxy_config = env[:machine].config.apt_proxy
-
-          # Vagrant does not seem to call `finalize!` if the configuration
-          # key is not used in Vagrantfiles.
-          # https://github.com/tmatilai/vagrant-proxyconf/issues/2
-          proxy_config.finalize!
-
-          if !proxy_config.enabled?
-            logger.debug "apt_proxy not enabled or configured"
-          elsif !proxy_conf_capability?(env[:machine])
-            env[:ui].info "Skipping Apt proxy config as the machine does not support it"
-          else
-            env[:ui].info "Configuring proxy for Apt..."
-            write_apt_proxy_conf(env[:machine], proxy_config)
-          end
-        end
-
-        private
-
-        def write_apt_proxy_conf(machine, config)
-          logger.debug "Configuration:\n#{config}"
-
-          temp = Tempfile.new("vagrant")
-          temp.binmode
-          temp.write(config)
-          temp.close
-
-          machine.communicate.tap do |comm|
-            comm.upload(temp.path, "/tmp/vagrant-apt-proxy-conf")
-            comm.sudo("cat /tmp/vagrant-apt-proxy-conf > #{proxy_conf_path(machine)}")
-            comm.sudo("rm /tmp/vagrant-apt-proxy-conf")
-          end
-        end
-
-        def proxy_conf_capability?(machine)
-          machine.guest.capability?(:apt_proxy_conf)
-        end
-
-        def proxy_conf_path(machine)
-          machine.guest.capability(:apt_proxy_conf)
+      class ConfigureAptProxy < Base
+        def config_name
+          'apt_proxy'
         end
       end
     end

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

@@ -0,0 +1,14 @@
+require_relative 'base'
+
+module VagrantPlugins
+  module ProxyConf
+    class Action
+      # Action for configuring proxy environment variables on the guest
+      class ConfigureEnvProxy < Base
+        def config_name
+          'env_proxy'
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/cap/linux/env_proxy_conf.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module ProxyConf
+    module Cap
+      module Linux
+        # Capability for Env proxy configuration
+        module EnvProxyConf
+          # @return [String] the path to the configuration file
+          def self.env_proxy_conf(machine)
+            '/etc/profile.d/proxy.sh'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 require 'vagrant'
+require_relative 'key_mixin'
 
 module VagrantPlugins
   module ProxyConf
@@ -7,55 +8,32 @@ module VagrantPlugins
       #
       # @!parse class AptProxy < Vagrant::Plugin::V2::Config; end
       class AptProxy < Vagrant.plugin('2', :config)
+        include KeyMixin
+        # @!parse extend KeyMixin::ClassMethods
+
+        # @!attribute
         # @return [String] the HTTP proxy
-        attr_accessor :http
+        key :http, env_var: 'VAGRANT_APT_HTTP_PROXY'
 
+        # @!attribute
         # @return [String] the HTTPS proxy
-        attr_accessor :https
+        key :https, env_var: 'VAGRANT_APT_HTTPS_PROXY'
 
+        # @!attribute
         # @return [String] the FTP proxy
-        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
+        key :ftp, env_var: 'VAGRANT_APT_FTP_PROXY'
 
         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))
+        # (see KeyMixin#config_for)
+        def config_for(key, value)
+          ConfigLine.new(key.name, value)
         end
 
-        # Helper for building configuration lines
+        # Helper for constructing a configuration line for apt.conf
         #
         # @api private
-        class ConfigValue
+        class ConfigLine
 
           attr_reader :proto, :value
 
@@ -68,7 +46,7 @@ module VagrantPlugins
 
           # @return [String] the full Apt configuration line
           def to_s
-            set? ? %Q{Acquire::#{proto}::Proxy "#{proxy_uri}";\n} : ""
+            %Q{Acquire::#{proto}::Proxy "#{direct || proxy_uri}";\n} if set?
           end
 
           private
@@ -77,12 +55,12 @@ module VagrantPlugins
             value && !value.empty?
           end
 
-          def direct?
-            value.upcase == "DIRECT"
+          def direct
+            "DIRECT" if value.upcase == "DIRECT"
           end
 
           def proxy_uri
-            direct? ? "DIRECT" : "#{prefix}#{value}#{suffix}"
+            "#{prefix}#{value}#{suffix}"
           end
 
           def prefix

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

@@ -0,0 +1,46 @@
+require 'vagrant'
+require_relative 'key_mixin'
+
+module VagrantPlugins
+  module ProxyConf
+    module Config
+      # Configuration for generic `<protocol>_proxy` environment variables
+      #
+      # @!parse class EnvProxy < Vagrant::Plugin::V2::Config; end
+      class EnvProxy < Vagrant.plugin('2', :config)
+        include KeyMixin
+        # @!parse extend KeyMixin::ClassMethods
+
+        # @!attribute
+        # @return [String] the HTTP proxy
+        key :http, env_var: 'VAGRANT_ENV_HTTP_PROXY'
+
+        # @!attribute
+        # @return [String] the HTTPS proxy
+        key :https, env_var: 'VAGRANT_ENV_HTTPS_PROXY'
+
+        # @!attribute
+        # @return [String] the FTP proxy
+        key :ftp, env_var: 'VAGRANT_ENV_FTP_PROXY'
+
+        # @!attribute
+        # @return [String] a comma separated list of hosts or domains which do not use proxies
+        key :no_proxy, env_var: 'VAGRANT_ENV_NO_PROXY'
+
+        private
+
+        # (see KeyMixin#config_for)
+        def config_for(key, value)
+          if value && !value.empty?
+            var = env_variable_name(key)
+            [var.upcase, var.downcase].map { |v| "export #{v}=#{value}\n" }.join
+          end
+        end
+
+        def env_variable_name(key)
+          key.name == :no_proxy ? "no_proxy" : "#{key.name}_proxy"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module VagrantPlugins
+  module ProxyConf
+    module Config
+      # Configuration key specifications
+      class Key
+        # @return [Symbol] the configuration key name
+        attr_reader :name
+
+        # @return [String, nil] the default value for the key
+        attr_reader :default
+
+        # @return [String, nil] the environment variable name
+        attr_reader :env_var
+
+        # @param name [Symbol, String] the key name
+        # @param opts [Hash] optional key properties
+        # @option opts [String, nil] :default (nil) the default value
+        # @option opts [String, nil] :env_var (nil) the environment variable
+        #   that overrides the configuration
+        def initialize(name, opts = {})
+          @name    = name.to_sym
+          @default = opts[:default]
+          @env_var = opts[:env_var]
+        end
+
+        # @yield if environment variable is not specified or set
+        # @yieldparam default [String, nil] the {#default} value of the key
+        # @yieldreturn [String, nil] the default value to be returned
+        # @return [String] the value from the environment variable or the
+        #   return value of the block or {#default}
+        def value_from_env_var
+          if env_var && ENV.key?(env_var)
+            ENV[env_var]
+          elsif block_given?
+            yield default
+          else
+            default
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+require_relative 'key'
+
+module VagrantPlugins
+  module ProxyConf
+    module Config
+      # Helper module for Config classes.
+      #
+      # Handles mapping to environment variables, setting default values,
+      # and constructing the configuration file stanza.
+      module KeyMixin
+
+        # Methods for the including class to specify and access the configuration keys.
+        module ClassMethods
+          # @!attribute [r] keys
+          # @return [Array<Key>] the configuration keys for the class
+          def keys
+            @keys ||= []
+          end
+
+          # Defines a configuration key for the class.
+          # Creates `attr_accessor` for the key name and adds a {Key} to {#keys}.
+          # @param (see Key#initialize)
+          # @option (see Key#initialize)
+          def key(name, opts = {})
+            self.class_eval { attr_accessor name }
+            keys << Key.new(name, opts)
+          end
+        end
+
+        # Extends the including class with {ClassMethods}
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        # Initializes all keys to `UNSET_VALUE`
+        def initialize
+          super
+          keys.each do |key|
+            set(key, self.class::UNSET_VALUE)
+          end
+        end
+
+        # Overrides values from specified environment variables, and sets them
+        # to default values if no configuration was found
+        def finalize!
+          super
+          keys.each { |key| set(key, resolve_value(key)) }
+        end
+
+        # @return [Boolean] true if any of the configuration keys has a non-nil value
+        def enabled?
+          keys.any? { |key| set?(key) }
+        end
+
+        # Returns the full configuration stanza
+        # Calls {#config_for} for each key.
+        #
+        # @return [String]
+        def to_s
+          keys.map { |key| config_for(key, get(key)).to_s }.join
+        end
+
+        # Returns a configuration line/stanza for the specified key and value.
+        # The returned line should include linefeed `\\n` if not empty.
+        # The default implementations returns "<key>=<value>\\n".
+        #
+        # @param key [Key] the configuration key
+        # @param value [String, nil] the configuration value
+        # @return [#to_s] the configuration line(s)
+        def config_for(key, value)
+          "#{key}=#{value}\n"
+        end
+
+        # Returns a new instance of this class where all nil keys are
+        # replaced from the specified default config
+        #
+        # @param defaults [KeyMixin] the default configuration
+        # @return [KeyMixin]
+        def merge_defaults(defaults)
+          result = dup
+          keys.each do |key|
+            if !set?(key) && defaults.key?(key)
+              result.set(key, defaults.get(key))
+            end
+          end
+          result
+        end
+
+        protected
+
+        def keys
+          self.class.keys
+        end
+
+        def key?(key)
+          keys.any? { |k| k.name == key.name }
+        end
+
+        def get(key)
+          send(key.name)
+        end
+
+        def set?(key)
+          !get(key).nil?
+        end
+
+        def set(key, value)
+          send(:"#{key.name}=", value)
+        end
+
+        private
+
+        def resolve_value(key)
+          key.value_from_env_var do |default|
+            value = get(key)
+            value == self.class::UNSET_VALUE ? default : value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'vagrant'
+require_relative 'key_mixin'
+
+module VagrantPlugins
+  module ProxyConf
+    module Config
+      # Default configuration for all proxy Config classes
+      #
+      # @!parse class Proxy < Vagrant::Plugin::V2::Config; end
+      class Proxy < Vagrant.plugin('2', :config)
+        include KeyMixin
+        # @!parse extend KeyMixin::ClassMethods
+
+        # @!attribute
+        # @return [String] the HTTP proxy
+        key :http, env_var: 'VAGRANT_HTTP_PROXY'
+
+        # @!attribute
+        # @return [String] the HTTPS proxy
+        key :https, env_var: 'VAGRANT_HTTPS_PROXY'
+
+        # @!attribute
+        # @return [String] the FTP proxy
+        key :ftp, env_var: 'VAGRANT_FTP_PROXY'
+
+        # @!attribute
+        # @return [String] a comma separated list of hosts or domains which do not use proxies
+        key :no_proxy, env_var: 'VAGRANT_NO_PROXY'
+
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/plugin.rb

@@ -15,12 +15,35 @@ module VagrantPlugins
       # 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"
+          msg = I18n.t('vagrant_proxyconf.errors.vagrant_version', min_version: MIN_VAGRANT_VERSION)
           $stderr.puts msg
           raise msg
         end
       end
 
+      # Initializes the internationalization strings
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('../../../locales/en.yml', __FILE__)
+        I18n.reload!
+      end
+
+      def self.register_hooks(hook, provision_action)
+        require_relative 'action/configure_apt_proxy'
+        require_relative 'action/configure_env_proxy'
+
+        hook.after provision_action, Action::ConfigureAptProxy
+        hook.after provision_action, Action::ConfigureEnvProxy
+      end
+
+      def self.aws_plugin_installed?
+        VagrantPlugins.const_defined?('AWS')
+      end
+
+      def self.omnibus_plugin_installed?
+        VagrantPlugins.const_defined?('Omnibus')
+      end
+
+      setup_i18n
       check_vagrant_version!
 
       name 'vagrant-proxyconf'
@@ -30,24 +53,37 @@ module VagrantPlugins
         Config::AptProxy
       end
 
+      config 'env_proxy' do
+        require_relative 'config/env_proxy'
+        Config::EnvProxy
+      end
+
+      config 'proxy' do
+        require_relative 'config/proxy'
+        Config::Proxy
+      end
+
       guest_capability 'debian', 'apt_proxy_conf' do
         require_relative 'cap/debian/apt_proxy_conf'
         Cap::Debian::AptProxyConf
       end
 
-      proxyconf_action_hook = lambda do |hook|
-        require_relative 'action/configure_apt_proxy'
-        hook.after Vagrant::Action::Builtin::Provision, Action::ConfigureAptProxy
+      guest_capability 'linux', 'env_proxy_conf' do
+        require_relative 'cap/linux/env_proxy_conf'
+        Cap::Linux::EnvProxyConf
+      end
+
+      action_hook 'proxyconf_configure' do |hook|
+        if omnibus_plugin_installed?
+          # configure the proxies before vagrant-omnibus
+          register_hooks(hook, VagrantPlugins::Omnibus::Action::InstallChef)
+        else
+          register_hooks(hook, Vagrant::Action::Builtin::Provision)
 
-        # vagrant-aws uses a non-standard provision action
-        if VagrantPlugins.const_defined?('AWS')
-          hook.after VagrantPlugins::AWS::Action::TimedProvision, Action::ConfigureAptProxy
+          # vagrant-aws uses a non-standard provision action
+          register_hooks(hook, VagrantPlugins::AWS::Action::TimedProvision) if aws_plugin_installed?
         end
       end
-      action_hook 'proxyconf-machine-up', :machine_action_up, &proxyconf_action_hook
-      action_hook 'proxyconf-machine-reload', :machine_action_reload, &proxyconf_action_hook
-      # Hook to vagrant-digitalocean's `rebuild` command
-      action_hook 'proxyconf-machine-rebuild', :machine_action_rebuild, &proxyconf_action_hook
     end
   end
 end

data/lib/vagrant-proxyconf/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ProxyConf
-    VERSION = '0.3.0'
+    VERSION = '0.4.0.rc1'
   end
 end

data/locales/en.yml

@@ -0,0 +1,21 @@
+en:
+  vagrant_proxyconf:
+    apt_proxy:
+      not_enabled: |-
+        apt_proxy not enabled or configured
+      not_supported: |-
+        Skipping Apt proxy config as the machine does not support it
+      configuring: |-
+        Configuring proxy for Apt...
+
+    env_proxy:
+      not_enabled: |-
+        env_proxy not enabled or configured
+      not_supported: |-
+        Skipping environment variable based proxy config as the machine does not support it
+      configuring: |-
+        Configuring proxy environment variables...
+
+    errors:
+      vagrant_version: |-
+        vagrant-proxyconf plugin requires Vagrant %{min_version} or newer

data/spec/unit/vagrant-proxyconf/action/configure_apt_proxy_spec.rb

@@ -2,4 +2,10 @@ require 'spec_helper'
 require 'vagrant-proxyconf/action/configure_apt_proxy'
 
 describe VagrantPlugins::ProxyConf::Action::ConfigureAptProxy do
+
+  describe '#config_name' do
+    subject { described_class.new(double, double).config_name }
+    it      { should eq 'apt_proxy' }
+  end
+
 end

data/spec/unit/vagrant-proxyconf/action/configure_env_proxy_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/action/configure_env_proxy'
+
+describe VagrantPlugins::ProxyConf::Action::ConfigureEnvProxy do
+
+  describe '#config_name' do
+    subject { described_class.new(double, double).config_name }
+    it      { should eq 'env_proxy' }
+  end
+
+end

data/spec/unit/vagrant-proxyconf/config/apt_proxy_spec.rb

@@ -7,7 +7,7 @@ describe VagrantPlugins::ProxyConf::Config::AptProxy do
 
   before :each do
     # Ensure tests are not affected by environment variables
-    %w[APT_PROXY_HTTP APT_PROXY_HTTPS APT_PROXY_FTP].each { |k| ENV.delete(k) }
+    %w[HTTP HTTPS FTP].map { |proto| ENV.delete("VAGRANT_APT_#{proto}_PROXY") }
   end
 
   context "defaults" do
@@ -28,9 +28,9 @@ describe VagrantPlugins::ProxyConf::Config::AptProxy do
   end
 
   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"
+    include_examples "apt proxy env var", "VAGRANT_APT_HTTP_PROXY", "http"
+    include_examples "apt proxy env var", "VAGRANT_APT_HTTPS_PROXY", "https"
+    include_examples "apt proxy env var", "VAGRANT_APT_FTP_PROXY", "ftp"
   end
 
 end

data/spec/unit/vagrant-proxyconf/config/env_proxy_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/config/env_proxy'
+
+def config_with(options)
+  instance.tap do |c|
+    options.each_pair { |k, v| c.send("#{k}=".to_sym, v) }
+    c.finalize!
+  end
+end
+
+def conf_lines(env_var, val)
+  [env_var.upcase, env_var.downcase].map { |var| "export #{var}=#{val}\n" }
+end
+
+RSpec::Matchers.define :match_lines do |expected|
+  match do |actual|
+    expect(actual.lines.to_a).to match_array(expected)
+  end
+end
+
+describe VagrantPlugins::ProxyConf::Config::EnvProxy do
+  let(:instance) { described_class.new }
+
+  before :each do
+    # Ensure tests are not affected by environment variables
+    %w[HTTP_PROXY HTTPS_PROXY FTP_PROXY NO_PROXY].each do |var|
+      ENV.delete("VAGRANT_ENV_#{var}")
+    end
+  end
+
+  context "defaults" do
+    subject        { config_with({}) }
+    its(:enabled?) { should be_false }
+    its(:to_s)     { should eq "" }
+  end
+
+  context "with http config" do
+    let(:proxy)    { 'http://proxy.example.com:8888' }
+    subject        { config_with({ http: proxy }) }
+    its(:enabled?) { should be_true }
+    its(:to_s)     { should match_lines conf_lines('http_proxy', proxy) }
+  end
+
+  context "with http and no_proxy config" do
+    let(:proxy)    { 'http://proxy.example.com:8888' }
+    let(:no_proxy) { 'localhost,127.0.0.1' }
+    subject        { config_with({ http: proxy, no_proxy: no_proxy }) }
+    its(:enabled?) { should be_true }
+    its(:to_s)     { should match_lines conf_lines('http_proxy', proxy) + conf_lines('no_proxy', no_proxy) }
+  end
+
+  context "with VAGRANT_ENV_HTTP_PROXY env var" do
+    let(:proxy)    { 'http://proxy.example.com:8888' }
+    before(:each)  { ENV['VAGRANT_ENV_HTTP_PROXY'] = proxy }
+    subject        { config_with({ http: 'http://default:3128' }) }
+    its(:enabled?) { should be_true }
+    its(:to_s)     { should match_lines conf_lines('HTTP_PROXY', proxy) }
+  end
+end

data/spec/unit/vagrant-proxyconf/config/key_mixin_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/config/key_mixin'
+
+describe VagrantPlugins::ProxyConf::Config::KeyMixin do
+
+  class TestConfig < Vagrant.plugin('2', :config)
+    include VagrantPlugins::ProxyConf::Config::KeyMixin
+    key :foo
+    key :bar
+  end
+
+  class TestDefaultConfig < Vagrant.plugin('2', :config)
+    include VagrantPlugins::ProxyConf::Config::KeyMixin
+    key :foo
+    key :baz
+  end
+
+  let(:config) do
+    TestConfig.new.tap do |c|
+      c.foo = foo
+      c.bar = bar
+    end
+  end
+
+  let(:default) do
+    TestDefaultConfig.new.tap do |c|
+      c.foo = default_foo
+      c.baz = default_baz
+    end
+  end
+
+  let(:foo) { nil }
+  let(:bar) { nil }
+  let(:default_foo) { nil }
+  let(:default_baz) { nil }
+
+  describe '#merge_defaults' do
+    subject { config.merge_defaults(default) }
+
+    context 'with no configuration' do
+      it { should be_kind_of config.class }
+      it { should_not be config }
+
+      its(:foo) { should be_nil }
+      its(:bar) { should be_nil }
+    end
+
+    context 'without default configuration' do
+      let(:foo) { 'tricky' }
+      let(:bar) { 'tracks' }
+
+      its(:foo) { should eq foo }
+      its(:bar) { should eq bar }
+    end
+
+    context 'with default configuration' do
+      let(:foo) { 'tricky' }
+      let(:bar) { 'tracks' }
+      let(:default_foo) { 'billy' }
+      let(:default_baz) { 'bam-bam' }
+
+      its(:foo) { should eq foo }
+      its(:bar) { should eq bar }
+    end
+
+    context 'with a mixture configuration' do
+      let(:bar) { 'tracks' }
+      let(:default_foo) { 'billy' }
+
+      its(:foo) { should eq default_foo }
+      its(:bar) { should eq bar }
+    end
+
+    context 'with only default configuration' do
+      let(:default_foo) { 'billy' }
+      let(:default_baz) { 'bam-bam' }
+
+      its(:foo) { should eq default_foo }
+      its(:bar) { should be_nil }
+    end
+  end
+
+end

data/spec/unit/vagrant-proxyconf/config/key_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/config/key'
+
+describe VagrantPlugins::ProxyConf::Config::Key do
+
+  describe '.new' do
+    context 'without options' do
+      subject       { described_class.new(name) }
+      let(:name)    { :mykey }
+      its(:name)    { should eq name }
+      its(:default) { should be_nil }
+      its(:env_var) { should be_nil }
+    end
+
+    context 'with string name' do
+      subject       { described_class.new(name) }
+      let(:name)    { 'mykey' }
+      its(:name)    { should eq name.to_sym }
+    end
+
+    context 'with default value' do
+      subject       { described_class.new(name, default: default) }
+      let(:name)    { :foo }
+      let(:default) { 'bar' }
+      its(:default) { should eq default }
+    end
+
+    context 'with env_var' do
+      subject       { described_class.new(name, env_var: env_var) }
+      let(:name)    { :key }
+      let(:env_var) { 'baz' }
+      its(:env_var) { should eq env_var }
+    end
+  end
+
+  describe '#value_from_env_var' do
+    before :each do
+      %w[foo_bar BAZ].each { |k| ENV.delete(k) }
+    end
+    let(:instance) { described_class.new(name, default: default, env_var: env_var) }
+    let(:name)     { 'the_key' }
+    let(:default)  { nil }
+    let(:env_var)  { nil }
+
+    shared_examples 'env_var' do
+      it 'returns :default without block' do
+        expect(instance.value_from_env_var).to eq default
+      end
+      it 'yields with the :default value' do
+        expect { |b| instance.value_from_env_var(&b) }.to yield_with_args default
+      end
+      it 'returns the value from the block' do
+        ret = 'block_default'
+        expect(instance.value_from_env_var { ret }).to eq ret
+      end
+    end
+
+    context 'without env_var' do
+      context 'with a specified default' do
+        let(:default)  { 'param_default' }
+        include_examples 'env_var'
+      end
+
+      context 'and without default' do
+        include_examples 'env_var'
+      end
+    end
+
+    context 'with env_var' do
+      before :each do
+        ENV['foo_bar'] = 'from_env_var'
+        ENV['BAZ']     = 'second_env_var'
+      end
+      let(:env_var) { 'BAZ' }
+      let(:default) { 'the_default' }
+
+      it 'returns value of the environment variable' do
+        expect(instance.value_from_env_var).to eq ENV['BAZ']
+      end
+      it 'does not yield' do
+        expect { |b| instance.value_from_env_var(&b) }.not_to yield_control
+      end
+    end
+  end
+
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-proxyconf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.4.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Teemu Matilainen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies: []
 description: A Vagrant plugin that configures the virtual machine to use proxies
 email:
@@ -31,16 +31,28 @@ files:
 - development/README.md
 - development/Vagrantfile.example
 - lib/vagrant-proxyconf.rb
+- lib/vagrant-proxyconf/action/base.rb
 - lib/vagrant-proxyconf/action/configure_apt_proxy.rb
+- lib/vagrant-proxyconf/action/configure_env_proxy.rb
 - lib/vagrant-proxyconf/cap/debian/apt_proxy_conf.rb
+- lib/vagrant-proxyconf/cap/linux/env_proxy_conf.rb
 - lib/vagrant-proxyconf/config/apt_proxy.rb
+- lib/vagrant-proxyconf/config/env_proxy.rb
+- lib/vagrant-proxyconf/config/key.rb
+- lib/vagrant-proxyconf/config/key_mixin.rb
+- lib/vagrant-proxyconf/config/proxy.rb
 - lib/vagrant-proxyconf/plugin.rb
 - lib/vagrant-proxyconf/version.rb
+- locales/en.yml
 - spec/spec_helper.rb
 - spec/unit/support/shared/apt_proxy_config.rb
 - spec/unit/vagrant-proxyconf/action/configure_apt_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/action/configure_env_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/cap/debian/apt_proxy_conf_spec.rb
 - spec/unit/vagrant-proxyconf/config/apt_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/config/env_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/config/key_mixin_spec.rb
+- spec/unit/vagrant-proxyconf/config/key_spec.rb
 - spec/unit/vagrant-proxyconf/plugin_spec.rb
 - vagrant-proxyconf.gemspec
 homepage: http://tmatilai.github.io/vagrant-proxyconf/
@@ -58,16 +70,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3198216208626978364
+      hash: -457260254384338946
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 3198216208626978364
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -78,7 +87,11 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/support/shared/apt_proxy_config.rb
 - spec/unit/vagrant-proxyconf/action/configure_apt_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/action/configure_env_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/cap/debian/apt_proxy_conf_spec.rb
 - spec/unit/vagrant-proxyconf/config/apt_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/config/env_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/config/key_mixin_spec.rb
+- spec/unit/vagrant-proxyconf/config/key_spec.rb
 - spec/unit/vagrant-proxyconf/plugin_spec.rb
 has_rdoc: