vagrant-subdomains-updater 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 275bd134be05f36710155c2179c230a60ae14e9a9fa6c4e181c6f9eea84ad402
+  data.tar.gz: 5437ae0382618572e1de534249020fc6106a77d4e2e8aa38a8f1f2cfc4f39318
+SHA512:
+  metadata.gz: 55bc4276f7b7e8bbf1bdadfa274ebe5fd85bb42cbb9e37bbbec345bc3406e513900af0cfeb15d4adf69d5bb93d52c2716f6e4fa9b76b8632f219ff1b97ef4b2b
+  data.tar.gz: 38f5c3ba03b1257870c19a85b3d0aa62cd8ab7ddd298dfdd8e456e201038d9ac7e4bfb955c559a12c14cdb0edbd826a714312e9ddeb1b0eb192e3be8d126ae93

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/Vagrantfile
+/.vagrant/
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+    gemspec
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nassim Kacha
+
+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/README.md

@@ -0,0 +1,89 @@
+# vagrant-subdomains-updater
+
+[![Gem Version](https://badge.fury.io/rb/vagrant-subdomains-updater.svg)](http://badge.fury.io/rb/vagrant-subdomains-updater)
+[![Code Climate](https://codeclimate.com/github/illuin-tech/vagrant-subdomains-updater/badges/gpa.svg)](https://codeclimate.com/github/illuin-tech/vagrant-subdomains-updater)
+
+## Introduction
+
+`vagrant-subdomains-updater` allows you to automatically configure subdomains with the ip of your vagrant instance using your registrar API.
+
+Difference with the [upstream](https://github.com/nasskach/vagrant-dns-updater) : `vagrant-subdomains-updater` handles multiple subdomains instead of a single one.
+
+## Important
+- This plugin is currently only compatible with Linux guests.
+- Only OVH registrar is supported for the moment.
+
+## Installation
+
+    $ vagrant plugin install vagrant-subdomains-updater
+
+## Usage
+
+Configuration example for OVH:
+
+```ruby
+Vagrant.configure(2) do |config|
+    # for the moment only "ovh" is supported
+    config.subdomainsupdater.registrar = "ovh"
+
+    # API credentials, specific to OVH
+    # for more information read the OVH section below
+    config.subdomainsupdater.appkey = "XXXXXXXX"
+    config.subdomainsupdater.appsecret = "YYYYYYYYYYYYYYYYYY"
+    config.subdomainsupdater.consumerkey = "ZZZZZZZZZZZZZZZZZZZ"
+
+    # domain settings, test.mydomain.com in our example
+    config.subdomainsupdater.zone = "mydomain.com"
+    config.subdomainsupdater.subdomains = ["test"]
+
+    # the network interface on which retreive the ip
+    config.subdomainsupdater.interface = "eth2"
+
+    # ttl is optional, default value is set to 60 seconds
+    config.subdomainsupdater.ttl = "120"
+end
+```
+
+## Registrars
+### OVH
+
+First you need an `appkey` and an `appsecret` which can be obtained [here](https://www.ovh.com/fr/cgi-bin/api/createApplication.cgi).
+
+You will also need a `consumerkey`, you can get it using the `ovh-consumer-key` command provided by this plugin:
+
+```
+vagrant ovh-consumer-key <appkey>
+```
+
+This command will display a `consumerkey` and a `validationUrl`, the `consumerkey` need a validation before use, this
+can be done by following the `validationUrl` and entering your credentials.
+
+Finally you can add the following parameters to your Vagrantfile.
+
+```ruby
+Vagrant.configure(2) do |config|
+    config.subdomainsupdater.registrar = "ovh"
+    config.subdomainsupdater.appkey = "XXXXXXXX"
+    config.subdomainsupdater.appsecret = "YYYYYYYYYYYYYYYYYY"
+    config.subdomainsupdater.consumerkey = "ZZZZZZZZZZZZZZZZZZZ"
+    config.subdomainsupdater.zone = "mydomain.com"
+    config.subdomainsupdater.subdomains = ["test"]
+    config.subdomainsupdater.interface = "eth2"
+end
+```
+
+## ToDo
+
+- Improve error handling.
+- Support additional registrars : gandi, ultradns, ...
+- Write tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/illuin-tech/vagrant-subdomains-updater.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vagrant/dns/updater"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vagrant-subdomains-updater.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+require 'vagrant-subdomains-updater/plugin'
+
+module VagrantPlugins
+  module SubdomainsUpdater
+    lib_root = File.dirname(File.absolute_path(__FILE__))
+    Dir.glob(lib_root + '/vagrant-subdomains-updater/registrar/*') {|file| require file}
+
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/lib/vagrant-subdomains-updater/action.rb

@@ -0,0 +1,24 @@
+require_relative 'action/set_dns_records'
+require_relative 'action/remove_dns_records'
+
+module VagrantPlugins
+  module SubdomainsUpdater
+    module Action
+      include Vagrant::Action::Builtin
+
+      def self.set_dns_records
+        Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use SetDnsRecords
+        end
+      end
+
+      def self.remove_dns_records
+        Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use RemoveDnsRecords
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-subdomains-updater/action/remove_dns_records.rb

@@ -0,0 +1,22 @@
+module VagrantPlugins
+  module SubdomainsUpdater
+    module Action
+      class RemoveDnsRecords
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+        end
+
+        def call(env)
+          config = @machine.config.subdomainsupdater
+          unless config.registrar.nil?
+            registrar = Registrar::Registrar.load config
+            registrar.remove_dns_records
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-subdomains-updater/action/set_dns_records.rb

@@ -0,0 +1,28 @@
+module VagrantPlugins
+  module SubdomainsUpdater
+    module Action
+      class SetDnsRecords
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+        end
+
+        def call(env)
+          config = @machine.config.subdomainsupdater
+          unless config.registrar.nil?
+            interface = config.interface
+            registrar = Registrar::Registrar.load config
+            @machine.communicate.execute("ip addr show #{interface} | awk '/inet/ && /#{interface}/{sub(/\\/.*$/,\"\",$2); print $2}'") do |type, output|
+              raise Vagrant::Errors::VagrantError.new, output if type.to_s == 'stderr'
+              ip = output
+              @machine.ui.info("Pointing #{config.subdomains.join(', ')} subdomains for zone #{config.zone} to #{ip}")
+              registrar.set_dns_records ip
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-subdomains-updater/command.rb

@@ -0,0 +1,60 @@
+require 'ovh/rest'
+
+module VagrantPlugins
+  module SubdomainsUpdater
+    class Command < Vagrant.plugin('2', :command)
+
+      def self.synopsis
+        'Get OVH consumer key'
+      end
+
+      def execute
+        access = {
+            "accessRules" => [
+                { "method" => "GET", "path" => "/domain/*" },
+                { "method" => "POST", "path" => "/domain/*" },
+                { "method" => "PUT", "path" => "/domain/*" },
+                { "method" => "DELETE", "path" => "/domain/*" },
+            ]
+        }
+
+        argv = parse_args
+
+        result = OVH::REST.generate_consumer_key(argv, access)
+
+        raise Vagrant::Errors::VagrantError.new, result['message'] if result['message'] == 'Invalid application key'
+
+        puts <<-EOF
+        validationUrl: #{result['validationUrl']}
+        consumerkey: #{result['consumerKey']}
+        EOF
+
+      end
+
+
+      private
+
+
+      def parse_args
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant ovh-consumer-key [options] <appkey>'
+          o.separator ''
+
+          o.on('-h', '--help', 'Print this help') do
+            safe_puts(opts.help)
+          end
+        end
+
+        args = parse_options(opts)
+
+        if args.length != 1
+          safe_puts(opts.help)
+          exit 1
+        end
+
+        args[0]
+        end
+
+    end
+  end
+end

data/lib/vagrant-subdomains-updater/config.rb

@@ -0,0 +1,53 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module SubdomainsUpdater
+    class Config < Vagrant.plugin(2, :config)
+      attr_accessor :registrar
+      attr_accessor :appkey
+      attr_accessor :appsecret
+      attr_accessor :consumerkey
+      attr_accessor :zone
+      attr_accessor :subdomains
+      attr_accessor :interface
+      attr_accessor :ttl
+
+
+      def initialize
+        @registrar = UNSET_VALUE
+        @appkey = UNSET_VALUE
+        @appsecret = UNSET_VALUE
+        @consumerkey = UNSET_VALUE
+        @zone = UNSET_VALUE
+        @subdomains = UNSET_VALUE
+        @interface = UNSET_VALUE
+        @ttl = UNSET_VALUE
+      end
+
+      def finalize!
+        @registrar = nil if @registrar == UNSET_VALUE
+        @appkey = nil if @appkey == UNSET_VALUE
+        @appsecret = nil if @appsecret == UNSET_VALUE
+        @consumerkey = nil if @consumerkey == UNSET_VALUE
+        @zone = nil if @zone == UNSET_VALUE
+        @subdomains = nil if @subdomains == UNSET_VALUE
+        @interface = nil if @interface == UNSET_VALUE
+        @ttl = 60 if @ttl == UNSET_VALUE
+      end
+
+      def validate(machine)
+        finalize!
+        errors = []
+        errors << 'appkey parameter is required' if @appkey.nil? && @registrar == 'ovh'
+        errors << 'appsecret parameter is required' if @appsecret.nil? && @registrar == 'ovh'
+        errors << 'consumerkey parameter is required' if @consumerkey.nil? && @registrar == 'ovh'
+        errors << 'zone parameter is required' if @zone.nil? && !@registrar.nil?
+        errors << 'subdomains parameter is required' if @subdomains.nil? && !@registrar.nil?
+        errors << 'interface parameter is required' if @interface.nil? && !@registrar.nil?
+
+        { "SubdomainsUpdater" => errors }
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'vagrant'
+require_relative 'action'
+require_relative 'registrar'
+
+module VagrantPlugins
+  module SubdomainsUpdater
+    class Plugin < Vagrant.plugin('2')
+      Vagrant.require_version('>= 1.5.1')
+
+      name 'dns-updater'
+
+      description <<-DESC
+        This plugin allows you to automatically configure subdomains
+        with the ip of your vagrant instance using your registrar API.
+      DESC
+
+
+      command "ovh-consumer-key" do
+        require_relative "command"
+        Command
+      end
+
+
+      config "subdomainsupdater" do
+        require_relative "config"
+        Config
+      end
+
+      %w{up provision}.each do |action|
+        action_hook :subdomainsupdater, "machine_action_#{action}".to_sym do |hook|
+          hook.append Action.set_dns_records
+        end
+      end
+
+      action_hook :subdomainsupdater, "machine_action_destroy".to_sym do |hook|
+        hook.append Action.remove_dns_records
+      end
+
+    end
+  end
+end

data/lib/vagrant-subdomains-updater/registrar.rb

@@ -0,0 +1,25 @@
+module VagrantPlugins
+  module SubdomainsUpdater
+    module Registrar
+      class Registrar
+
+        @@registrars = {}
+
+        def self.load(config)
+          registrar = @@registrars[config.registrar]
+          if registrar
+            registrar.new config
+          else
+            raise Vagrant::Errors::VagrantError.new,
+                    "SubdomainsUpdater: The registrar \"#{config.registrar}\" is not supported."
+          end
+        end
+
+        def self.register_registrar(name)
+          @@registrars[name] = self
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-subdomains-updater/registrar/ovh.rb

@@ -0,0 +1,75 @@
+require 'ovh/rest'
+
+module VagrantPlugins
+  module SubdomainsUpdater
+    module Registrar
+      class Ovh < Registrar
+
+        register_registrar 'ovh'
+
+        def initialize(config)
+          @zone = config.zone
+          @subdomains = config.subdomains
+          @ttl = config.ttl
+          @api = OVH::REST.new config.appkey, config.appsecret, config.consumerkey
+        end
+
+        def set_dns_records(ip)
+          @subdomains.each do |subdomain|
+            set_dns_record(ip, subdomain)
+          end
+        end
+
+        def set_dns_record(ip, subdomain)
+          begin
+            record_id = get_record_id(subdomain)
+            if record_id.nil?
+              @api.post("/domain/zone/#{@zone}/record", {
+                        'fieldType' => 'A',
+                        'target' => ip,
+                        'subDomain' => subdomain,
+                        'ttl' => @ttl})
+            else
+              @api.put("/domain/zone/#{@zone}/record/#{record_id}", {
+                       'target' => ip,
+                       'subDomain' => subdomain,
+                       'ttl' => @ttl})
+            end
+
+            @api.post("/domain/zone/#{@zone}/refresh")
+          rescue OVH::RESTError => error
+            raise Vagrant::Errors::VagrantError.new, "SubdomainsUpdater: #{error}"
+          end
+        end
+
+        def remove_dns_records
+          @subdomains.each do |subdomain|
+            remove_dns_record(subdomain)
+          end
+        end
+
+        def remove_dns_record(subdomain)
+          begin
+            record_id = get_record_id(subdomain)
+            @api.delete("/domain/zone/#{@zone}/record/#{record_id}") unless record_id.nil?
+          rescue OVH::RESTError => error
+            raise Vagrant::Errors::VagrantError.new, "SubdomainsUpdater: #{error}"
+          end
+        end
+
+
+        private
+
+        def get_record_id(subdomain)
+          records = @api.get("/domain/zone/#{@zone}/record")
+          records.each do |r|
+            record = @api.get("/domain/zone/#{@zone}/record/#{r}")
+            return r if record['subDomain'] == subdomain
+          end
+          nil
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module SubdomainsUpdater
+    VERSION = "0.1.4"
+  end
+end

data/vagrant-subdomains-updater.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-subdomains-updater/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-subdomains-updater"
+  spec.version       = VagrantPlugins::SubdomainsUpdater::VERSION
+  spec.authors       = ["Illuin Technology"]
+  spec.email         = ["contact+rubygems@illuin.tech"]
+
+  spec.description   = 'A Vagrant plugin that allows you to automatically configure subdomains' \
+                       ' with the ip of your vagrant instance using your registrar API.' \
+                       ' Only the registrar OVH is supported at the moment.'
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/illuin-tech/vagrant-subdomains-updater"
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ovh-rest', '~> 0.0.5'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-subdomains-updater
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Illuin Technology
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ovh-rest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A Vagrant plugin that allows you to automatically configure subdomains
+  with the ip of your vagrant instance using your registrar API. Only the registrar
+  OVH is supported at the moment.
+email:
+- contact+rubygems@illuin.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vagrant-subdomains-updater.rb
+- lib/vagrant-subdomains-updater/action.rb
+- lib/vagrant-subdomains-updater/action/remove_dns_records.rb
+- lib/vagrant-subdomains-updater/action/set_dns_records.rb
+- lib/vagrant-subdomains-updater/command.rb
+- lib/vagrant-subdomains-updater/config.rb
+- lib/vagrant-subdomains-updater/plugin.rb
+- lib/vagrant-subdomains-updater/registrar.rb
+- lib/vagrant-subdomains-updater/registrar/ovh.rb
+- lib/vagrant-subdomains-updater/version.rb
+- vagrant-subdomains-updater.gemspec
+homepage: https://github.com/illuin-tech/vagrant-subdomains-updater
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A Vagrant plugin that allows you to automatically configure subdomains with
+  the ip of your vagrant instance using your registrar API. Only the registrar OVH
+  is supported at the moment.
+test_files: []