vagrant-proxyconf 0.2.0 → 0.3.0

data/.gitignore

@@ -1,4 +1,6 @@
 /.bundle
+/.yardoc
 /Gemfile.lock
+/doc
 /pkg
 /tmp

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+-
+CHANGELOG.md
+LICENSE.txt
+README.md

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.0 / 2013-07-12
+
+- Support the [AWS provider](https://github.com/mitchellh/vagrant-aws) ([GH-10][])
+- Support `vagrant rebuild` command of the [Digital Ocean provider](https://github.com/smdahlen/vagrant-digitalocean) ([GH-11][])
+- Do not add the default port to complete URIs (e.g. `http://proxy`) ([GH-9][])
+
 # 0.2.0 / 2013-07-05
 
 - Add Apt proxy configuration for FTP URIs ([GH-5][])
@@ -20,3 +26,6 @@
 [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"
+[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"

data/Gemfile

@@ -2,11 +2,15 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'cane', '~> 2.6'
 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'
 
 group :development do
   gem 'guard-rspec'
+  gem 'redcarpet'
+  gem 'yard', '~> 0.8'
 end

data/README.md

@@ -1,16 +1,16 @@
-# Vagrant Proxy Configuration Plugin
+# Proxy Configuration Plugin for Vagrant
 
 <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]
 [![Code Climate](https://codeclimate.com/github/tmatilai/vagrant-proxyconf.png)][codeclimate]
+</span>
 
 [gem]: https://rubygems.org/gems/vagrant-proxyconf
 [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/) plugin that configures the virtual machine to use specified proxies for package managers etc.
 
@@ -20,9 +20,18 @@ At this state we support:
 
 Support is planned for other package managers (at least yum).
 
-## Installation
+## Compatibility
+
+This plugin requires Vagrant 1.2 or newer ([downloads](http://downloads.vagrantup.com/)).
 
-**Note:** This plugin requires Vagrant v1.2 or newer ([downloads](http://downloads.vagrantup.com/)).
+The plugin is supposed to be compatible with all Vagrant providers. Please file an [issue](https://github.com/tmatilai/vagrant-proxyconf/issues) if this is not the case.
+The following providers are confirmed to work:
+[AWS](https://github.com/mitchellh/vagrant-aws),
+[Digital Ocean](https://github.com/smdahlen/vagrant-digitalocean),
+[VirtualBox](http://docs.vagrantup.com/v2/virtualbox),
+[VMware Fusion](http://docs.vagrantup.com/v2/vmware/index.html).
+
+## Installation
 
 Install using standard Vagrant plugin installation method:
 
@@ -32,6 +41,8 @@ vagrant plugin install vagrant-proxyconf
 
 ## Usage
 
+The plugin hooks itself to `vagrant up`, `vagrant reload` and `vagrant rebuild` commands.
+
 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.

data/Rakefile

@@ -1,8 +1,9 @@
 require 'bundler/gem_tasks'
+require 'cane/rake_task'
 require 'rspec/core/rake_task'
 require 'tailor/rake_task'
 
-task :default => [:test, :tailor]
+task :default => [:test, :quality]
 
 # Remove 'install' task as the gem is installed to Vagrant, not to system
 Rake::Task[:install].clear
@@ -28,6 +29,14 @@ Tailor::RakeTask.new do |task|
   end
 end
 
+Cane::RakeTask.new(:cane) do |task|
+  task.style_measure = 100
+  task.options[:color] = true
+end
+
+desc 'Run all quality tasks'
+task :quality => [:cane, :tailor]
+
 desc "Update gh-pages"
 task 'gh-pages' do
   require 'tmpdir'
@@ -40,3 +49,10 @@ task 'gh-pages' do
     end
   end
 end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  # gem not installed on the CI server
+end

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

@@ -4,6 +4,7 @@ require 'tempfile'
 module VagrantPlugins
   module ProxyConf
     class Action
+      # Action for configuring Apt on the guest
       class ConfigureAptProxy
         attr_reader :logger
 

data/lib/vagrant-proxyconf/cap/debian/apt_proxy_conf.rb

@@ -2,7 +2,9 @@ module VagrantPlugins
   module ProxyConf
     module Cap
       module Debian
+        # Capability for Apt proxy configuration
         module AptProxyConf
+          # @return [String] the path to the configuration file
           def self.apt_proxy_conf(machine)
             '/etc/apt/apt.conf.d/01proxy'
           end

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

@@ -3,14 +3,17 @@ require 'vagrant'
 module VagrantPlugins
   module ProxyConf
     module Config
+      # Proxy configuration for Apt
+      #
+      # @!parse class AptProxy < Vagrant::Plugin::V2::Config; end
       class AptProxy < Vagrant.plugin('2', :config)
-        # HTTP proxy for Apt
+        # @return [String] the HTTP proxy
         attr_accessor :http
 
-        # HTTPS proxy for Apt
+        # @return [String] the HTTPS proxy
         attr_accessor :https
 
-        # FTP proxy for Apt
+        # @return [String] the FTP proxy
         attr_accessor :ftp
 
         def initialize
@@ -49,6 +52,9 @@ module VagrantPlugins
           ConfigValue.new(proto, send(proto.to_sym))
         end
 
+        # Helper for building configuration lines
+        #
+        # @api private
         class ConfigValue
 
           attr_reader :proto, :value
@@ -84,7 +90,7 @@ module VagrantPlugins
           end
 
           def suffix
-            ":#{default_port}" if value !~ %r{:\d+$}
+            ":#{default_port}" if value !~ %r{:\d+$} && value !~ %r{/}
           end
 
           def default_port

data/lib/vagrant-proxyconf/plugin.rb

@@ -2,6 +2,9 @@ require 'vagrant'
 
 module VagrantPlugins
   module ProxyConf
+    # Vagrant Plugin class that registers all proxy configs, hooks, etc.
+    #
+    # @!parse class Plugin < Vagrant::Plugin::V2::Plugin; end
     class Plugin < Vagrant.plugin('2')
       # The minimum compatible Vagrant version
       MIN_VAGRANT_VERSION = '1.2.0'
@@ -35,9 +38,16 @@ module VagrantPlugins
       proxyconf_action_hook = lambda do |hook|
         require_relative 'action/configure_apt_proxy'
         hook.after Vagrant::Action::Builtin::Provision, Action::ConfigureAptProxy
+
+        # vagrant-aws uses a non-standard provision action
+        if VagrantPlugins.const_defined?('AWS')
+          hook.after VagrantPlugins::AWS::Action::TimedProvision, Action::ConfigureAptProxy
+        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.2.0'
+    VERSION = '0.3.0'
   end
 end

data/spec/spec_helper.rb

@@ -6,5 +6,11 @@ RSpec.configure do |config|
   config.tty = true
 end
 
+require 'simplecov'
+SimpleCov.start do
+  coverage_dir('tmp/coverage')
+  add_filter '/spec/'
+end
+
 require 'tempfile'
 require 'vagrant-proxyconf'

data/spec/unit/support/shared/apt_proxy_config.rb

@@ -9,7 +9,8 @@ def conf_line(proto, name, port = 3142)
   if name == :direct
     %Q{Acquire::#{proto}::Proxy "DIRECT";\n}
   else
-    %Q{Acquire::#{proto}::Proxy "#{proto}://#{name}:#{port}";\n}
+    port = ":#{port}" if port
+    %Q{Acquire::#{proto}::Proxy "#{proto}://#{name}#{port}";\n}
   end
 end
 
@@ -41,7 +42,13 @@ shared_examples "apt proxy config" do |proto|
     context "with protocol and name" do
       subject        { config_with(proto => "#{proto}://proxy.foo.tld") }
       its(:enabled?) { should be_true }
-      its(:to_s)     { should eq conf_line(proto, "proxy.foo.tld") }
+      its(:to_s)     { should eq conf_line(proto, "proxy.foo.tld", nil) }
+    end
+
+    context "with trailing slash" do
+      subject        { config_with(proto => "#{proto}://proxy.foo.tld/") }
+      its(:enabled?) { should be_true }
+      its(:to_s)     { should eq conf_line(proto, "proxy.foo.tld/", nil) }
     end
 
     context "with protocol and name and port" do

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

@@ -0,0 +1,5 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/action/configure_apt_proxy'
+
+describe VagrantPlugins::ProxyConf::Action::ConfigureAptProxy do
+end

data/spec/unit/vagrant-proxyconf/cap/debian/apt_proxy_conf_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/cap/debian/apt_proxy_conf'
+
+describe VagrantPlugins::ProxyConf::Cap::Debian::AptProxyConf do
+
+  describe '.apt_proxy_conf' do
+    let(:subject) { described_class.apt_proxy_conf(double) }
+    it { should eq '/etc/apt/apt.conf.d/01proxy' }
+  end
+
+end

data/vagrant-proxyconf.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = VagrantPlugins::ProxyConf::VERSION
   spec.authors       = ["Teemu Matilainen"]
   spec.email         = ["teemu.matilainen@iki.fi"]
-  spec.description   = "A Vagrant Plugin that configures the virtual machine to use proxies"
+  spec.description   = "A Vagrant plugin that configures the virtual machine to use proxies"
   spec.summary       = spec.description
   spec.homepage      = "http://tmatilai.github.io/vagrant-proxyconf/"
   spec.license       = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-proxyconf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies: []
-description: A Vagrant Plugin that configures the virtual machine to use proxies
+description: A Vagrant plugin that configures the virtual machine to use proxies
 email:
 - teemu.matilainen@iki.fi
 executables: []
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -37,6 +38,8 @@ files:
 - lib/vagrant-proxyconf/version.rb
 - 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/cap/debian/apt_proxy_conf_spec.rb
 - spec/unit/vagrant-proxyconf/config/apt_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/plugin_spec.rb
 - vagrant-proxyconf.gemspec
@@ -55,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -654121375063372740
+      hash: 3198216208626978364
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -64,15 +67,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -654121375063372740
+      hash: 3198216208626978364
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A Vagrant Plugin that configures the virtual machine to use proxies
+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/action/configure_apt_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/plugin_spec.rb
+has_rdoc: