record_store 5.5.3 → 5.5.4

data/lib/record_store/provider/google_cloud_dns.rb

@@ -3,7 +3,7 @@ require 'google/cloud/dns'
 module RecordStore
   class Provider::GoogleCloudDNS < Provider
     class << self
-      def apply_changeset(changeset, stdout = $stdout)
+      def apply_changeset(changeset, _stdout = nil)
         zone = session.zone(convert_to_name(changeset.zone))
 
         deletions = convert_records_to_gcloud_record_sets(zone, changeset.current_records)
@@ -45,10 +45,10 @@ module RecordStore
 
       def session
         @dns ||= begin
-          Google::Cloud::Dns.new({
+          Google::Cloud::Dns.new(
             project_id: secrets.fetch('project_id'),
             credentials: Google::Cloud::Dns::Credentials.new(secrets),
-          })
+          )
         end
       end
 
@@ -72,9 +72,8 @@ module RecordStore
           [record.type, record.fqdn]
         end
 
-
         record_sets.map do |(rr_type, rr_fqdn), records_for_set|
-          zone.record(rr_fqdn, rr_type, records_for_set[0].ttl, records_for_set.map(&:rdata_txt))
+          zone.record(rr_fqdn, rr_type, records_for_set[0].ttl, Record.long_quote(records_for_set.map(&:rdata_txt)))
         end
       end
 
@@ -109,7 +108,7 @@ module RecordStore
         when 'NS'
           record_params.merge!(nsdname: record.data[0])
         when 'SPF', 'TXT'
-          txtdata = Record.unquote(record.data[0]).gsub(';', '\;')
+          txtdata = Record.unlong_quote(record.data[0]).gsub(';', '\;')
           record_params.merge!(txtdata: txtdata)
         when 'SRV'
           priority, weight, port, target = record.data[0].split(' ')

data/lib/record_store/provider/ns1.rb

@@ -12,7 +12,7 @@ module RecordStore
       # Downloads all the records from the provider.
       #
       # Returns: an array of `Record` for each record in the provider's zone
-      def retrieve_current_records(zone:, stdout: $stdout)
+      def retrieve_current_records(zone:, stdout: $stdout) # rubocop:disable Lint/UnusedMethodArgument
         full_api_records = records_for_zone(zone).map do |short_record|
           client.record(
             zone: zone,
@@ -22,7 +22,7 @@ module RecordStore
           )
         end
 
-        full_api_records.map { |r| build_from_api(r, zone) }.flatten.compact
+        full_api_records.map { |r| build_from_api(r) }.flatten.compact
       end
 
       # Returns an array of the zones managed by provider as strings
@@ -129,7 +129,11 @@ module RecordStore
           answer["answer"] = build_api_answer_from_record(record)
         end
 
-        raise(Error, "while trying to update a record, could not find answer with fqdn: #{record.fqdn}, type; #{record.type}, id: #{id}") unless updated
+        unless updated
+          error = +'while trying to update a record, could not find answer with fqdn: '
+          error << "#{record.fqdn}, type; #{record.type}, id: #{id}"
+          raise Error, error
+        end
 
         client.modify_record(
           zone: zone,
@@ -139,7 +143,7 @@ module RecordStore
         )
       end
 
-      def build_from_api(api_record, zone)
+      def build_from_api(api_record)
         fqdn = Record.ensure_ends_with_dot(api_record["domain"])
 
         record_type = api_record["type"]
@@ -150,7 +154,7 @@ module RecordStore
           record = {
             ttl: api_record["ttl"],
             fqdn: fqdn.downcase,
-            record_id: api_answer["id"]
+            record_id: api_answer["id"],
           }
 
           case record_type
@@ -179,7 +183,7 @@ module RecordStore
           when 'NS'
             record.merge!(nsdname: answer.first)
           when 'SPF', 'TXT'
-            record.merge!(txtdata: Record.unescape(answer.first).gsub(';', '\;'))
+            record.merge!(txtdata: Record.unlong_quote(Record.unescape(answer.first).gsub(';', '\;')))
           when 'SRV'
             priority, weight, port, host = answer
 
@@ -197,8 +201,8 @@ module RecordStore
       def build_api_answer_from_record(record)
         if record.is_a?(Record::MX)
           [record.preference, record.exchange]
-        elsif record.is_a?(Record::TXT) or record.is_a?(Record::SPF)
-          [record.txtdata]
+        elsif record.is_a?(Record::TXT) || record.is_a?(Record::SPF)
+          [Record.long_quote(record.txtdata)]
         elsif record.is_a?(Record::CAA)
           [record.flags, record.tag, record.value]
         elsif record.is_a?(Record::SRV)
@@ -209,7 +213,7 @@ module RecordStore
       end
 
       def symbolize_keys(hash)
-        hash.map{ |key, value| [key.to_sym, value] }.to_h
+        hash.map { |key, value| [key.to_sym, value] }.to_h
       end
 
       def secrets

data/lib/record_store/provider/ns1/client.rb

@@ -26,22 +26,21 @@ module RecordStore
 
       def create_record(zone:, fqdn:, type:, params:)
         result = super(zone, fqdn, type, params)
-        raise(Error, result.to_s) if result.is_a? NS1::Response::Error
+        raise(Error, result.to_s) if result.is_a?(NS1::Response::Error)
         nil
       end
 
       def modify_record(zone:, fqdn:, type:, params:)
         result = super(zone, fqdn, type, params)
-        raise(Error, result.to_s) if result.is_a? NS1::Response::Error
+        raise(Error, result.to_s) if result.is_a?(NS1::Response::Error)
         nil
       end
 
       def delete_record(zone:, fqdn:, type:)
         result = super(zone, fqdn, type)
-        raise(Error, result.to_s) if result.is_a? NS1::Response::Error
+        raise(Error, result.to_s) if result.is_a?(NS1::Response::Error)
         nil
       end
     end
   end
-
 end

data/lib/record_store/record.rb

@@ -1,7 +1,7 @@
 module RecordStore
   class Record
     FQDN_REGEX  = /\A(\*\.)?([a-z0-9_]+(-[a-z0-9]+)*\._?)+[a-z]{2,}\.\Z/i
-    CNAME_REGEX =  /\A(\*\.)?([a-z0-9_]+((-|--)?[a-z0-9]+)*\._?)+[a-z]{2,}\.\Z/i
+    CNAME_REGEX = /\A(\*\.)?([a-z0-9_]+((-|--)?[a-z0-9]+)*\._?)+[a-z]{2,}\.\Z/i
 
     include ActiveModel::Validations
 
@@ -17,7 +17,21 @@ module RecordStore
       end
 
       def quote(value)
-        %("#{escape(value)}")
+        result = escape(value)
+        %("#{result}")
+      end
+
+      def long_quote(value)
+        result = value
+        if needs_long_quotes?(value)
+          result = unquote(value).scan(/.{1,255}/).join('" "')
+          result = %("#{result}")
+        end
+        result
+      end
+
+      def unlong_quote(value)
+        value.length > 255 ? value.scan(/.{1,258}/).map { |x| x.sub(/^\"/, "").sub(/\" ?$/, "") }.join : unquote(value)
       end
 
       def unescape(value)
@@ -27,6 +41,14 @@ module RecordStore
       def unquote(value)
         unescape(value.sub(/\A"(.*)"\z/, '\1'))
       end
+
+      def ensure_ends_with_dot(fqdn)
+        fqdn.end_with?(".") ? fqdn : "#{fqdn}."
+      end
+
+      def needs_long_quotes?(value)
+        value.length > 255 && value !~ /^((\\)?"((\\"|[^"])){1,255}(\\)?"\s*)+$/
+      end
     end
 
     def initialize(record)
@@ -40,7 +62,7 @@ module RecordStore
       Record.const_get(record_type).new(yaml_definition)
     end
 
-    def log!(logger=STDOUT)
+    def log!(logger = STDOUT)
       logger.puts to_s
     end
 
@@ -48,7 +70,7 @@ module RecordStore
       {
         type: type,
         fqdn: fqdn,
-        ttl: ttl
+        ttl: ttl,
       }.merge(rdata)
     end
 
@@ -57,7 +79,7 @@ module RecordStore
     end
 
     def ==(other)
-      other.class == self.class && other.to_hash == self.to_hash
+      other.class == self.class && other.to_hash == to_hash
     end
 
     alias_method :eql?, :==
@@ -93,9 +115,5 @@ module RecordStore
         errors.add(:fqdn, "A label should be at most 63 characters")
       end
     end
-
-    def self.ensure_ends_with_dot(fqdn)
-      fqdn.end_with?(".") ? fqdn : "#{fqdn}."
-    end
   end
 end

data/lib/record_store/record/a.rb

@@ -21,12 +21,10 @@ module RecordStore
     private
 
     def valid_address?
-      begin
-        ip = IPAddr.new(address)
-        errors.add(:address, 'is not an IPv4 address') unless ip.ipv4?
-      rescue IPAddr::InvalidAddressError
-        errors.add(:address, 'is invalid')
-      end
+      ip = IPAddr.new(address)
+      errors.add(:address, 'is not an IPv4 address') unless ip.ipv4?
+    rescue IPAddr::InvalidAddressError
+      errors.add(:address, 'is invalid')
     end
   end
 end

data/lib/record_store/record/aaaa.rb

@@ -21,12 +21,10 @@ module RecordStore
     private
 
     def valid_address?
-      begin
-        ip = IPAddr.new(address)
-        errors.add(:address, 'is not an IPv6 address') unless ip.ipv6?
-      rescue IPAddr::InvalidAddressError
-        errors.add(:address, 'is invalid')
-      end
+      ip = IPAddr.new(address)
+      errors.add(:address, 'is not an IPv6 address') unless ip.ipv6?
+    rescue IPAddr::InvalidAddressError
+      errors.add(:address, 'is invalid')
     end
   end
 end

data/lib/record_store/record/alias.rb

@@ -2,7 +2,11 @@ module RecordStore
   class Record::ALIAS < Record
     attr_accessor :alias
 
-    validates :alias, presence: true, format: { with: Record::CNAME_REGEX, message: 'is not a fully qualified domain name' }
+    validates :alias, presence: true, format:
+      {
+        with: Record::CNAME_REGEX,
+        message: 'is not a fully qualified domain name',
+      }
     validate :validate_circular_reference
 
     def initialize(record)

data/lib/record_store/record/caa.rb

@@ -5,10 +5,14 @@ module RecordStore
     LABEL_REGEX = '[a-z0-9](?:-*[a-z0-9])*'
     DOMAIN_REGEX = /\A#{LABEL_REGEX}(?:\.#{LABEL_REGEX})\z/i
 
-    validates :flags, numericality: { only_integer: true, greater_than_or_equal_to: 0, less_than_or_equal_to: 255 }, presence: true
+    validates :flags, presence: true, numericality:
+      {
+        only_integer: true, greater_than_or_equal_to: 0,
+        less_than_or_equal_to: 255
+      }
     validates :tag, inclusion: { in: %w(issue issuewild iodef) }, presence: true
     validate :validate_uri_value, if: :iodef?
-    validates :value, format: { with: DOMAIN_REGEX, message: 'is not a fully qualified domain name'}, unless: :iodef?
+    validates :value, format: { with: DOMAIN_REGEX, message: 'is not a fully qualified domain name' }, unless: :iodef?
 
     def initialize(record)
       super
@@ -37,7 +41,7 @@ module RecordStore
 
     def validate_uri_value
       uri = URI(value)
-      return if uri.kind_of?(URI::MailTo) || uri.kind_of?(URI::HTTP)
+      return if uri.is_a?(URI::MailTo) || uri.is_a?(URI::HTTP)
       errors.add(:value, "URL scheme should be mailto, http, or https")
     rescue URI::Error
       errors.add(:value, "Value should be a valid URI")

data/lib/record_store/record/cname.rb

@@ -2,7 +2,11 @@ module RecordStore
   class Record::CNAME < Record
     attr_accessor :cname
 
-    validates :cname, presence: true, format: { with: Record::CNAME_REGEX, message: 'is not a fully qualified domain name' }
+    validates :cname, presence: true, format:
+      {
+        with: Record::CNAME_REGEX,
+        message: 'is not a fully qualified domain name',
+      }
     validate :validate_circular_reference
 
     def initialize(record)

data/lib/record_store/record/mx.rb

@@ -2,8 +2,16 @@ module RecordStore
   class Record::MX < Record
     attr_accessor :exchange, :preference
 
-    validates :preference, numericality: { only_integer: true, greater_than_or_equal_to: 0 }, presence: true
-    validates :exchange, presence: true, format: { with: Record::FQDN_REGEX, message: 'is not a fully qualified domain name' }
+    validates :preference, presence: true, numericality:
+      {
+        only_integer: true,
+        greater_than_or_equal_to: 0,
+      }
+    validates :exchange, presence: true, format:
+      {
+        with: Record::FQDN_REGEX,
+        message: 'is not a fully qualified domain name',
+      }
 
     def initialize(record)
       super
@@ -14,7 +22,7 @@ module RecordStore
     def rdata
       {
         preference: preference,
-        exchange: exchange
+        exchange: exchange,
       }
     end
 

data/lib/record_store/record/ns.rb

@@ -2,7 +2,11 @@ module RecordStore
   class Record::NS < Record
     attr_accessor :nsdname
 
-    validates :nsdname, presence: true, format: { with: Record::FQDN_REGEX, message: 'is not a fully qualified domain name' }
+    validates :nsdname, presence: true, format:
+      {
+        with: Record::FQDN_REGEX,
+        message: 'is not a fully qualified domain name',
+      }
 
     def initialize(record)
       super

data/lib/record_store/record/srv.rb

@@ -2,10 +2,26 @@ module RecordStore
   class Record::SRV < Record
     attr_accessor :priority, :port, :weight, :target
 
-    validates :priority, presence: true, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
-    validates :port, presence: true, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
-    validates :weight, presence: true, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
-    validates :target, presence: true, format: { with: Record::CNAME_REGEX, message: 'is not a fully qualified domain name' }
+    validates :priority, presence: true, numericality:
+      {
+        only_integer: true,
+        greater_than_or_equal_to: 0,
+      }
+    validates :port, presence: true, numericality:
+      {
+        only_integer: true,
+        greater_than_or_equal_to: 0,
+      }
+    validates :weight, presence: true, numericality:
+      {
+        only_integer: true,
+        greater_than_or_equal_to: 0,
+      }
+    validates :target, presence: true, format:
+      {
+        with: Record::CNAME_REGEX,
+        message: 'is not a fully qualified domain name',
+      }
 
     def initialize(record)
       super

data/lib/record_store/record/txt.rb

@@ -2,7 +2,7 @@ module RecordStore
   class Record::TXT < Record
     attr_accessor :txtdata
 
-    validates :txtdata, presence: true, length: { maximum: 255 }
+    validates :txtdata, presence: true, length: { maximum: 4096 }
     validate :escaped_semicolons
 
     def initialize(record)

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '5.5.3'.freeze
+  VERSION = '5.5.4'.freeze
 end

data/lib/record_store/zone.rb

@@ -6,7 +6,11 @@ module RecordStore
     attr_accessor :name
     attr_reader :config
 
-    validates :name, presence: true, format: { with: Record::FQDN_REGEX, message: 'is not a fully qualified domain name' }
+    validates :name, presence: true, format:
+      {
+        with: Record::FQDN_REGEX,
+        message: 'is not a fully qualified domain name',
+      }
     validate :validate_records
     validate :validate_config
     validate :validate_all_records_are_unique
@@ -18,14 +22,14 @@ module RecordStore
 
     class << self
       def download(name, provider_name, **write_options)
-        zone = Zone.new(name: name, config: {providers: [provider_name]})
+        zone = Zone.new(name: name, config: { providers: [provider_name] })
         raise ArgumentError, zone.errors.full_messages.join("\n") unless zone.valid?
 
         zone.records = zone.providers.first.retrieve_current_records(zone: name)
 
         zone.config = Zone::Config.new(
           providers: [provider_name],
-          ignore_patterns: [{type: "NS", fqdn: "#{name}."}],
+          ignore_patterns: [{ type: "NS", fqdn: "#{name}." }],
           supports_alias: (zone.records.map(&:type).include?('ALIAS') || nil)
         )
 
@@ -41,13 +45,15 @@ module RecordStore
       end
 
       MAX_PARALLEL_THREADS = 10
-      def modified(verbose: false)
-        modified_zones, mutex, zones = [], Mutex.new, self.all
+      def modified(verbose: false) # rubocop:disable Lint/UnusedMethodArgument
+        modified_zones = []
+        mutex = Mutex.new
+        zones = all
 
         (1..MAX_PARALLEL_THREADS).map do
           Thread.new do
             current_zone = nil
-            while not zones.empty?
+            while zones.any?
               mutex.synchronize { current_zone = zones.shift }
               mutex.synchronize { modified_zones << current_zone } unless current_zone.unchanged?
             end
@@ -147,15 +153,15 @@ module RecordStore
       cname_records = records.select { |record| record.is_a?(Record::CNAME) }
       cname_records.each do |cname_record|
         records.each do |record|
-          if record.fqdn == cname_record.fqdn && record != cname_record
-            case record.type
-              when 'SIG', 'NXT', 'KEY'
-                # this is fine
-              when 'CNAME'
-                errors.add(:records, "Multiple CNAME records are defined for #{record.fqdn}: #{record}")
-              else
-                errors.add(:records, "A CNAME record is defined for #{cname_record.fqdn}, so this record is not allowed: #{record}")
-            end
+          next unless record.fqdn == cname_record.fqdn && record != cname_record
+          case record.type
+          when 'SIG', 'NXT', 'KEY'
+            # this is fine
+          when 'CNAME'
+            errors.add(:records, "Multiple CNAME records are defined for #{record.fqdn}: #{record}")
+          else
+            cname_error = "A CNAME record is defined for #{cname_record.fqdn}, so this record is not allowed: #{record}"
+            errors.add(:records, cname_error)
           end
         end
       end
@@ -175,7 +181,7 @@ module RecordStore
 
       providers.each do |provider|
         (record_types - provider.record_types).each do |record_type|
-          errors.add(:records, "#{record_type} is a not a supported record type in #{provider.to_s}")
+          errors.add(:records, "#{record_type} is a not a supported record type in #{provider}")
         end
       end
     end