provider-dsl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e03114f692a9bb504c5c542872a125844180cfb
+  data.tar.gz: 6d5d68f7aa7cc8d21dce62ac696e8abf84259a7e
+SHA512:
+  metadata.gz: b055051b2bcb8e59bd06c7088dd05ef42def0657069182cc051fe0b791a6c5148c857ee05bd6d2710cd0cf4866a3fa34c74fea6eb6f9a035d16c24657fdf2924
+  data.tar.gz: 3e0db13f2286a8091d44ceb4ce9c1f72819ee31fe620e1e5d7f2be449cd089141a0ba3c83ee46f3d2a709459bf962d62a7fe43b4f5a4b6e0f68bec57470810f9

data/lib/provider_dsl/dsl.rb

@@ -0,0 +1,25 @@
+require 'provider_dsl/gandi'
+require 'provider_dsl/log'
+
+module ProviderDSL
+  # The DSL processor
+  class DSL
+    def initialize
+      @logger = Log.instance
+    end
+
+    def execute(glob = nil, &block)
+      Dir[glob].each do |filename|
+        @logger.log("DSL processing #{filename}")
+        instance_eval(File.read(filename))
+        @logger.log("DSL completed processing #{filename}")
+      end if glob.is_a?(String)
+      instance_eval(&block) if block_given?
+    end
+
+    def gandi(parameters, &block)
+      parameters[:session_factory] = GandiSessionFactory.new unless parameters.key?(:session_factory)
+      Gandi.new(parameters, &block)
+    end
+  end
+end

data/lib/provider_dsl/gandi.rb

@@ -0,0 +1,98 @@
+require 'gandi'
+require 'provider_dsl/gandi_proxy'
+require 'provider_dsl/zone'
+require 'provider_dsl/log'
+
+module ProviderDSL
+  #
+  class GandiSessionFactory
+    def instance(api_key, environment)
+      ::Gandi::Session.new(api_key, env: environment)
+    end
+  end
+
+  # Manage a domain on Gandi
+  class Gandi
+    attr_reader :name_servers, :zone_name
+
+    def initialize(parameters = {}, &block)
+      session_factory = parameters[:session_factory]
+      api_key = parameters[:api_key]
+      raise 'Gandi API key is not a valid string' unless api_key.is_a?(String)
+      environment = parameters[:environment] || :production
+      @domain_name = parameters[:domain_name]
+      @logger = Log.instance
+      @logger.confidential(/#{Regexp.quote(api_key)}/)
+      @logger.log("Processing Gandi account in #{environment}")
+      @session = session_factory.instance(api_key, environment)
+      if @domain_name
+        @logger.log("Domain name: #{@domain_name}")
+        @name_servers = @session.domain.info(@domain_name).nameservers.uniq.sort
+        @name_server_addresses =
+          Hash[@session.domain.host.list(@domain_name).map { |data| [data['name'], data['ips'].uniq.sort] }]
+      end
+      @zone_name = nil
+      @required_zone = []
+      instance_eval(&block) if block_given?
+    end
+
+    def execute(&block)
+      instance_eval(&block)
+    end
+
+    def zone(zone_name, parameters = {}, &block)
+      @logger.log("Zone: #{zone_name}")
+      original_zone = @session.domain.zone.list.select { |data| data['name'] == zone_name }
+      if original_zone.count.zero?
+        zone_id = nil
+        original_zone = nil
+      else
+        zone_id = original_zone.first['id']
+        original_zone = @session.domain.zone.record.list(zone_id, 0).map { |record| Hash[record] }
+      end
+      if block_given?
+        zone = Zone.new(original_zone.nil? ? [] : original_zone, parameters)
+        zone.create(&block)
+        zone_id = original_zone.nil? ? @session.domain.zone.create(name: zone_name).id : zone_id
+        if original_zone.nil? || zone.changed?
+          @logger.log("Zone records:\n#{zone.to_s('  ')}")
+          version = @session.domain.zone.version.new(zone_id)
+          @session.domain.zone.record.set(zone_id, version, zone.hash)
+          @session.domain.zone.version.set(zone_id, version)
+          @logger.log("Created version #{version} of zone #{zone_name}")
+        else
+          @logger.log("Zone #{zone_name} is unchanged")
+        end
+      elsif original_zone.nil?
+        raise "Zone #{zone_name} is undefined"
+      end
+      return unless @domain_name
+      @logger.log("Attaching Gandi zone #{zone_name} to domain #{@domain_name}")
+      @session.domain.zone.set(@domain_name, zone_id)
+      name_servers!
+    end
+
+    def name_server_addresses(name_server)
+      name_server = "#{name_server}.#{@domain_name}"
+      @name_server_addresses.key?(name_server) ? @name_server_addresses[name_server] : []
+    end
+
+    def name_server_addresses!(name_server, required_name_server_addresses)
+      current_name_server_addresses = name_server_addresses(name_server)
+      required_name_server_addresses = Array(required_name_server_addresses).uniq.sort
+      name_server = "#{name_server}.#{@domain_name}"
+      return if current_name_server_addresses == required_name_server_addresses
+      if @name_server_addresses.key?(name_server)
+        @session.domain.host.update(name_server, required_name_server_addresses)
+      else
+        @session.domain.host.create(name_server, required_name_server_addresses)
+      end
+    end
+
+    def name_servers!(required_name_servers = %w(a.dns.gandi.net b.dns.gandi.net c.dns.gandi.net))
+      @name_servers = Array(required_name_servers).uniq.sort
+      @logger.log((["Setting name servers for Gandi domain #{@domain_name} to:"] + @name_servers).join("\n  "))
+      @session.domain.nameservers.set(@domain_name, @name_servers)
+    end
+  end
+end

data/lib/provider_dsl/gandi_proxy.rb

@@ -0,0 +1,27 @@
+require 'gandi'
+require 'provider_dsl/rate_limiter'
+require 'provider_dsl/log'
+
+module ProviderDSL
+  module GandiProxy
+    # Gandi allow 30 calls to their API every 2 seconds - http://doc.rpc.gandi.net/overview.html#rate-limit
+    # To be safe we'll limit calls to no more than 20 every 2 seconds
+    LIMITER = RateLimiter.new(20, 2)
+
+    def method_missing(method, *arguments)
+      result = super(method, *arguments)
+      return result unless ::Gandi::VALID_METHODS.include?(chained.join('.'))
+      Log.instance.debug((["-> Gandi #{method}"] + [*arguments]).join("\n  "))
+      Log.instance.debug("Result:\n#{result.to_yaml}")
+      LIMITER.wait
+      result
+    end
+  end
+end
+
+module Gandi
+  # Mix in this custom call handler to the standard Gandi client
+  class ProxyCall
+    prepend ProviderDSL::GandiProxy
+  end
+end

data/lib/provider_dsl/gem_description.rb

@@ -0,0 +1,10 @@
+module ProviderDSL
+  module GemDescription
+    NAME = 'provider-dsl'.freeze
+    VERSION = '1.0.0'.freeze
+    SUMMARY = 'A DSL for interacting with various service provider APIs'.freeze
+    PAGE = 'https://github.com/sappho/gem-provider_dsl'.freeze
+    AUTHORS = ['Andrew Heald'].freeze
+    EMAIL = ['andrew@heald.uk'].freeze
+  end
+end

data/lib/provider_dsl/log.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+
+module ProviderDSL
+  # A simple logger
+  class Log
+    include Singleton
+
+    attr_accessor :callback, :debug
+
+    def initialize
+      @log = []
+      @confidential = []
+      @callback = nil
+      @debug = ENV['DSL_DEBUG'] == 'true'
+    end
+
+    def log(message)
+      @confidential.each { |regex| message.gsub!(regex, '******') }
+      @log << message
+      @callback.call(message) unless @callback.nil?
+    end
+
+    def debug(message)
+      log(message) if @debug
+    end
+
+    def confidential(regex)
+      @confidential << regex
+      @confidential.uniq!
+    end
+
+    def to_s
+      @log.join("\n")
+    end
+  end
+end

data/lib/provider_dsl/rate_limiter.rb

@@ -0,0 +1,26 @@
+module ProviderDSL
+  # Simple rate limiter
+  class RateLimiter
+    def initialize(maximum_calls, time_period)
+      @maximum_calls = maximum_calls
+      @time_period = time_period
+      reset
+    end
+
+    def wait
+      if @call_countdown.zero?
+        delta = Time.now - @timestamp
+        sleep(@time_period - delta) if delta < @time_period
+        reset
+      end
+      @call_countdown -= 1
+    end
+
+    private
+
+    def reset
+      @call_countdown = @maximum_calls
+      @timestamp = Time.now
+    end
+  end
+end

data/lib/provider_dsl/record.rb

@@ -0,0 +1,26 @@
+module ProviderDSL
+  # Manage a DNS record
+  class Record
+    attr_reader :name, :type, :value, :ttl, :hash
+
+    def initialize(name, type, value, ttl)
+      @name = name
+      @type = type
+      @value = value
+      @ttl = ttl
+      @hash = { name: name, type: type, value: value, ttl: ttl }
+    end
+
+    def to_s
+      "#{ttl} #{name} #{type} #{value}"
+    end
+
+    def ==(other)
+      self === other && ttl == other.ttl
+    end
+
+    def ===(other)
+      name == other.name && type == other.type && value == other.value
+    end
+  end
+end

data/lib/provider_dsl/zone.rb

@@ -0,0 +1,127 @@
+require 'ipaddress'
+require 'provider_dsl/record'
+require 'provider_dsl/log'
+
+module ProviderDSL
+  # Manage a DNS zone
+  class Zone
+    attr_reader :records
+
+    def initialize(original_records, parameters = {})
+      @logger = Log.instance
+      @original_records = original_records.map do |record|
+        if record.is_a?(Hash)
+          Record.new(record['name'], record['type'], record['value'], record['ttl'])
+        else
+          record
+        end
+      end
+      @records = parameters[:inherit_records] ? @original_records.clone : []
+      @names = []
+      name
+      ttl
+    end
+
+    def create(&block)
+      instance_eval(&block)
+    end
+
+    def name(name = nil, &block)
+      new_names = name.nil? ? @names : [name] + @names
+      effective_name(new_names)
+      if block_given?
+        saved_names = @names
+        @names = new_names
+        instance_eval(&block)
+        @names = saved_names
+        effective_name(@names)
+      end
+    end
+
+    def ttl(ttl = 3600)
+      @ttl = ttl
+    end
+
+    def aaaa(ip_addresses)
+      record('AAAA', ip_addresses) do |ip_address|
+        raise "#{ip_address} is not a valid IPv6 address" unless IPAddress.valid_ipv6?(ip_address)
+        IPAddress(ip_address).compressed
+      end
+    end
+
+    def a(ip_addresses)
+      record('A', ip_addresses) do |ip_address|
+        raise "#{ip_address} is not a valid IPv4 address" unless IPAddress.valid_ipv4?(ip_address)
+        IPAddress(ip_address).octets.join('.')
+      end
+    end
+
+    def cname(value)
+      value = String(value)
+      raise "CNAME #{value} cannot be defined for a naked domain" if @name == '@'
+      record('CNAME', value) do
+        @records = records.select { |other| !(other.type == 'CNAME' && other.name == @name) }
+        value
+      end
+    end
+
+    def mx(values)
+      record('MX', values)
+    end
+
+    def txt(values)
+      record('TXT', values)
+    end
+
+    def new_records
+      records.select { |record| @original_records.select { |original| original == record }.count.zero? }
+    end
+
+    def removed_records
+      @original_records.select { |original| records.select { |record| original == record }.count.zero? }
+    end
+
+    def changed?
+      !(new_records + removed_records).count.zero?
+    end
+
+    def to_s(prefix = '', suffix = '')
+      "#{prefix}#{sorted_records.join("#{suffix}\n#{prefix}")}#{suffix}"
+    end
+
+    def hash
+      sorted_records.map(&:hash)
+    end
+
+    private
+
+    def effective_name(names)
+      @name = names.count.zero? ? '@' : names.join('.')
+    end
+
+    def record(type, values)
+      values = Array(values)
+      keepers = values.select { |value| value == '?' }.count
+      if keepers > 0
+        raise "Keeper ? flag is inconsistently used for #{@name} #{type} #{values}" if keepers != 1 || values.count != 1
+        @original_records.select { |original| original.name == @name && original.type == type }.each do |original|
+          add(original)
+        end
+      else
+        values.each do |value|
+          value = yield(value) if block_given?
+          add(Record.new(@name, type, value, @ttl))
+        end
+      end
+    end
+
+    def add(record)
+      @logger.log("Adding #{record}")
+      @records = records.select { |other| !(record === other) } + [record]
+    end
+
+    def sorted_records
+      records.sort_by { |record| [record.name, record.type, record.value] }
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: provider-dsl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Heald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: gandi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.27
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.27
+- !ruby/object:Gem::Dependency
+  name: map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+description: See the project home page for more information
+email:
+- andrew@heald.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/provider_dsl/dsl.rb
+- lib/provider_dsl/gandi.rb
+- lib/provider_dsl/gandi_proxy.rb
+- lib/provider_dsl/gem_description.rb
+- lib/provider_dsl/log.rb
+- lib/provider_dsl/rate_limiter.rb
+- lib/provider_dsl/record.rb
+- lib/provider_dsl/zone.rb
+homepage: https://github.com/sappho/gem-provider_dsl
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A DSL for interacting with various service provider APIs
+test_files: []