Class: ProviderDSL::GandiProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/provider_dsl/gandi_provider.rb

Overview

Manage a domain on Gandi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key, parameters = {}, &block) ⇒ GandiProvider

Returns a new instance of GandiProvider.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/provider_dsl/gandi_provider.rb', line 19

def initialize(api_key, parameters = {}, &block)
  session_factory = parameters[:session_factory] || GandiSessionFactory.new
  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

Instance Attribute Details

#name_servers ⇒ Object (readonly)

Returns the value of attribute name_servers.



17
18
19
 
# File 'lib/provider_dsl/gandi_provider.rb', line 17

def name_servers
  @name_servers
end

#zone_name ⇒ Object (readonly)

Returns the value of attribute zone_name.



17
18
19
 
# File 'lib/provider_dsl/gandi_provider.rb', line 17

def zone_name
  @zone_name
end

Instance Method Details

#mail_redirections ⇒ Object 



101
102
103
 
# File 'lib/provider_dsl/gandi_provider.rb', line 101

def mail_redirections
  Hash[@session.domain.forward.list(@domain_name).map { |data| [data['source'], data['destinations'].uniq.sort] }]
end

#mail_redirections!(new_redirections) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/provider_dsl/gandi_provider.rb', line 105

def mail_redirections!(new_redirections)
  new_redirections =
    new_redirections.map { |source, destinations| [source.to_s, Array(destinations).uniq.sort] }.to_h
  current_redirections = mail_redirections
  new_redirections.each do |source, new_destinations|
    if current_redirections.key?(source)
      current_destinations = current_redirections[source].uniq.sort
      next if new_destinations == current_destinations
      @logger.log((["Updating #{@domain_name} mail forwarder for #{source}:"] + new_destinations).join("\n  "))
      @session.domain.forward.update(@domain_name, source, destinations: new_destinations)
    else
      @logger.log((["Creating #{@domain_name} mail forwarder for #{source}:"] + new_destinations).join("\n  "))
      @session.domain.forward.create(@domain_name, source, destinations: new_destinations)
    end
  end
  current_redirections.each do |source, _|
    next if new_redirections.key?(source)
    @logger.log("Deleting #{@domain_name} mail forwarder for #{source}")
    @session.domain.forward.delete(@domain_name, source)
  end
end

#name_server_addresses(name_server) ⇒ Object 



78
79
80
81
 
# File 'lib/provider_dsl/gandi_provider.rb', line 78

def name_server_addresses(name_server)
  name_server = "#{name_server}.#{@domain_name}"
  @name_server_addresses.key?(name_server) ? @name_server_addresses[name_server] : []
end

#name_server_addresses!(name_server, required_name_server_addresses) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/provider_dsl/gandi_provider.rb', line 83

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

#name_servers!(required_name_servers = %w(a.dns.gandi.net b.dns.gandi.net c.dns.gandi.net)) ⇒ Object 



95
96
97
98
99
 
# File 'lib/provider_dsl/gandi_provider.rb', line 95

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

#zone(zone_name, parameters = {}, &block) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/provider_dsl/gandi_provider.rb', line 38

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 = []
  else
    zone_id = original_zone.first['id']
    original_zone = @session.domain.zone.record.list(zone_id, 0).map do |record|
      Record.new(record['name'], record['type'], record['value'], record['ttl'])
    end
  end
  if block_given?
    zone = Zone.new(original_zone, parameters)
    zone.create(&block)
    zone_id = original_zone.empty? ? @session.domain.zone.create(name: zone_name).id : zone_id
    if original_zone.empty? || zone.changed?
      @logger.log("Zone records:\n#{zone.to_s('  ')}")
      gandi_zone = []
      zone.records.each do |record|
        record.values.each do |value|
          gandi_zone << { name: record.name, type: record.type, value: value, ttl: record.ttl }
        end
      end
      version = @session.domain.zone.version.new(zone_id)
      @session.domain.zone.record.set(zone_id, version, gandi_zone)
      @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.empty?
    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