record_store 5.11.0 → 6.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7a361748d4f6dd8179730ba18eadc60890c4317df58730ffd23dbb15bef6230
-  data.tar.gz: b4a3c7ffaeceedde2621a580cd52534fbba8cd4b4052a0f8561008f8718e6d64
+  metadata.gz: 4d05ecb06f048975b797baa10df042222f03ee4f0b1b5e268afa87e97b16ede6
+  data.tar.gz: 4ca96a597c88f5d17df9f85ea50e8743b0cab6fa4d57196447d3808cc22711a6
 SHA512:
-  metadata.gz: 95c9e88b0721f53f0212e5b97c852523a0864a6a191045a45083541a4ff3f3d25c5a179814519c651bcba4b4b857a4ab9b34e435ecffadb4f727af9c2f115c32
-  data.tar.gz: 6f418902506b12e6a5e58640ddc3efc21a2c790a2d0a315a97b284fa5ae2443bb9d76a6f623d641eae1b24eec2bd6971c3dafb0be5da6454b01a43faef50439c
+  metadata.gz: 98581b53f61499cb2f83d92ae2de4cf132ce2784cf56f8dc81531228f4090995f8e7a5a2c70f0a8fcac0cc5a3bdea29dd5c1d7b6996eef61e416c0c65c6a252d
+  data.tar.gz: 8e753593bc358e83f82a0191f07528e14aa793305570afae5fcc865e1bdd97fffb48319fec43642e662c7b62e1070dd3b384464b9ca55a39e2a590fcf0f6738b

data/.rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml

@@ -671,7 +671,7 @@ Style/LineEndConcatenation:
 Style/MethodCallWithoutArgsParentheses:
   Enabled: true
 
-Style/MethodMissingSuper:
+Lint/MissingSuper:
   Enabled: true
 
 Style/MissingRespondToMissing:
@@ -964,7 +964,7 @@ Lint/UselessAccessModifier:
 Lint/UselessAssignment:
   Enabled: true
 
-Lint/UselessComparison:
+Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
 
 Lint/UselessElseWithoutRescue:

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## 6.1.1
+- Emit messages when waiting for rate-limit to elapse for DNSimple and NS1 providers, so deployment does not timeout [BUGFIX]
+
+## 6.1.0
+- sort zone files [FEATURE]
+- CLI support for specifying zones for validate_authority [FEATURE]
+- retry failed lookup using another nameserver if unreachable [BUGFIX]
+- ignore records other than NS in authority section [BUGFIX]
+
+## 6.0.1
+- add API rate limiting to DNSimple provider [FEATURE]
+
+## 6.0.0
+- add `--all` option for `record-store diff` to compare ignored records too [FEATURE]
+
 ## 5.11.0
 - support PTR record type [FEATURE]
 

data/lib/record_store/changeset.rb

@@ -36,12 +36,15 @@ module RecordStore
 
     attr_reader :current_records, :desired_records, :removals, :additions, :updates, :provider, :zone
 
-    def self.build_from(provider:, zone:)
+    def self.build_from(provider:, zone:, all: false)
       current_zone = provider.build_zone(zone_name: zone.unrooted_name, config: zone.config)
 
+      current_records = all ? current_zone.all : current_zone.records
+      desired_records = all ? zone.all : zone.records
+
       new(
-        current_records: current_zone.records,
-        desired_records: zone.records,
+        current_records: current_records,
+        desired_records: desired_records,
         provider: provider,
         zone: zone.unrooted_name
       )

data/lib/record_store/cli.rb

@@ -59,13 +59,18 @@ module RecordStore
       end
     end
 
-    desc 'diff', 'Displays the DNS differences between the zone files in this repo and production'
+    desc 'diff [ZONE ...]', 'Displays the DNS differences between the zone files in this repo and production'
+    option :all, desc: 'Include all records', aliases: '-a', type: :boolean, default: false
     option :verbose, desc: 'Print records that haven\'t diverged', aliases: '-v', type: :boolean, default: false
-    def diff
-      puts "Diffing #{Zone.defined.count} zones"
+    def diff(*zones)
+      puts "Diffing #{zones.any? ? zones.count : Zone.defined.count} zone(s)"
+
+      all = options.fetch('all')
 
       Zone.each do |name, zone|
-        changesets = zone.build_changesets
+        next unless zones.empty? || zones.include?(name)
+
+        changesets = zone.build_changesets(all: all)
 
         if !options.fetch('verbose') && changesets.all?(&:empty?)
           print_and_flush('.')
@@ -81,21 +86,21 @@ module RecordStore
           puts '-' * 20
           puts "Provider: #{changeset.provider}"
 
-          if !changeset.additions.empty? || options.fetch('verbose')
+          if changeset.additions.any?
             puts "Add:"
             changeset.additions.map(&:record).each do |record|
               puts " - #{record}"
             end
           end
 
-          if !changeset.removals.empty? || options.fetch('verbose')
+          if changeset.removals.any?
             puts "Remove:"
             changeset.removals.map(&:record).each do |record|
               puts " - #{record}"
             end
           end
 
-          if !changeset.updates.empty? || options.fetch('verbose')
+          if changeset.updates.any?
             puts "Update:"
             changeset.updates.map(&:record).each do |record|
               puts " - #{record}"
@@ -215,12 +220,14 @@ module RecordStore
       end
     end
 
-    desc 'validate_authority', 'Validates that authoritative nameservers match the providers'
+    desc 'validate_authority [ZONE ...]', 'Validates that authoritative nameservers match the providers'
     option :verbose, desc: 'Include valid zones in output', aliases: '-v', type: :boolean, default: false
-    def validate_authority
+    def validate_authority(*zones)
       verbose = options.fetch('verbose')
 
       Zone.each do |name, zone|
+        next unless zones.empty? || zones.include?(name)
+
         authority = zone.fetch_authority
 
         delegation = Hash.new { |h, k| h[k] = [] }

data/lib/record_store/provider.rb

@@ -128,6 +128,36 @@ module RecordStore
 
         dns.getresource(zone_name, Resolv::DNS::Resource::IN::SOA).mname.to_s
       end
+
+      def retry_on_connection_errors(
+        max_timeouts: 5,
+        max_conn_resets: 5,
+        delay: 1,
+        backoff_multiplier: 2,
+        max_backoff: 10
+      )
+        loop do
+          begin
+            return yield
+          rescue Net::OpenTimeout
+            raise if max_timeouts <= 0
+            max_timeouts -= 1
+
+            $stderr.puts("Retrying after a connection timeout")
+          rescue Errno::ECONNRESET
+            raise if max_conn_resets <= 0
+            max_conn_resets -= 1
+
+            $stderr.puts("Retrying in #{delay}s after a connection reset")
+            backoff_sleep(delay)
+            delay = [delay * backoff_multiplier, max_backoff].min
+          end
+        end
+      end
+
+      def backoff_sleep(delay)
+        sleep(delay)
+      end
     end
   end
 end

data/lib/record_store/provider/dnsimple.rb

@@ -1,4 +1,5 @@
 require 'dnsimple'
+require_relative 'dnsimple/patch_api_header'
 
 module RecordStore
   class Provider::DNSimple < Provider
@@ -13,19 +14,23 @@ module RecordStore
 
       # returns an array of Record objects that match the records which exist in the provider
       def retrieve_current_records(zone:, stdout: $stdout)
-        session.zones.all_records(account_id, zone).data.map do |record|
-          begin
-            build_from_api(record, zone)
-          rescue StandardError
-            stdout.puts "Cannot build record: #{record}"
-            raise
-          end
-        end.compact
+        retry_on_connection_errors do
+          session.zones.all_records(account_id, zone).data.map do |record|
+            begin
+              build_from_api(record, zone)
+            rescue StandardError
+              stdout.puts "Cannot build record: #{record}"
+              raise
+            end
+          end.compact
+        end
       end
 
       # Returns an array of the zones managed by provider as strings
       def zones
-        session.zones.all_zones(account_id).data.map(&:name)
+        retry_on_connection_errors do
+          session.zones.all_zones(account_id).data.map(&:name)
+        end
       end
 
       private

data/lib/record_store/provider/dnsimple/patch_api_header.rb

@@ -0,0 +1,33 @@
+require_relative '../provider_utils/rate_limit'
+
+# Patch Dnsimple client method which retrieves headers for API rate limit dynamically
+module Dnsimple
+  class Client
+    def execute(method, path, data = nil, options = {})
+      response = request(method, path, data, options)
+      rate_limit_sleep(response.headers['x-ratelimit-reset'].to_i, response.headers['x-ratelimit-remaining'].to_i)
+
+      case response.code
+      when 200..299
+        response
+      when 401
+        raise AuthenticationFailed, response['message']
+      when 404
+        raise NotFoundError, response
+      else
+        raise RequestError, response
+      end
+    end
+
+    private
+
+    def rate_limit_sleep(rate_limit_reset, rate_limit_remaining)
+      rate_limit_reset_in = [0, rate_limit_reset - Time.now.to_i].max
+      rate_limit_periods = rate_limit_remaining + 1
+      sleep_time = rate_limit_reset_in / rate_limit_periods.to_f
+
+      rate_limit = RateLimit.new('DNSimple')
+      rate_limit.sleep_for(sleep_time)
+    end
+  end
+end

data/lib/record_store/provider/ns1.rb

@@ -60,14 +60,18 @@ module RecordStore
 
       # Returns an array of the zones managed by provider as strings
       def zones
-        client.zones.map { |zone| zone['zone'] }
+        retry_on_connection_errors do
+          client.zones.map { |zone| zone['zone'] }
+        end
       end
 
       private
 
       # Fetches simplified records for the provided zone
       def records_for_zone(zone)
-        client.zone(zone)['records']
+        retry_on_connection_errors do
+          client.zone(zone)['records']
+        end
       end
 
       # Creates a new record to the zone. It is expected this call modifies external state.

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

@@ -1,11 +1,22 @@
 require 'net/http'
+require_relative '../provider_utils/rate_limit'
 
 # Patch the method which retrieves headers for API rate limit dynamically
 module NS1::Transport
   class NetHttp
+    X_RATELIMIT_PERIOD = 'x-ratelimit-period'.freeze
+    X_RATELIMIT_REMAINING = 'x-ratelimit-remaining'.freeze
+
     def process_response(response)
-      sleep(response.to_hash["x-ratelimit-period"].first.to_i /
-        [1, response.to_hash["x-ratelimit-remaining"].first.to_i].max.to_f)
+      response_hash = response.to_hash
+
+      if response_hash.key?(X_RATELIMIT_PERIOD) && response_hash.key?(X_RATELIMIT_REMAINING)
+        sleep_time = response_hash[X_RATELIMIT_PERIOD].first.to_i /
+                     [1, response_hash[X_RATELIMIT_REMAINING].first.to_i].max.to_f
+
+        rate_limit = RateLimit.new('NS1')
+        rate_limit.sleep_for(sleep_time)
+      end
 
       body = JSON.parse(response.body)
       case response

data/lib/record_store/provider/provider_utils/rate_limit.rb

@@ -0,0 +1,14 @@
+class RateLimit
+  def initialize(provider)
+    @provider = provider
+  end
+
+  def sleep_for(sleep_time)
+    while sleep_time > 0
+      wait = [10, sleep_time].min
+      puts "Waiting on #{@provider} rate-limit" if wait > 1
+      sleep(wait)
+      sleep_time -= wait
+    end
+  end
+end

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '5.11.0'.freeze
+  VERSION = '6.1.2'.freeze
 end

data/lib/record_store/zone.rb

@@ -70,10 +70,10 @@ module RecordStore
       @records = build_records(records)
     end
 
-    def build_changesets
+    def build_changesets(all: false)
       @changesets ||= begin
         providers.map do |provider|
-          Changeset.build_from(provider: provider, zone: self)
+          Changeset.build_from(provider: provider, zone: self, all: all)
         end
       end
     end
@@ -129,14 +129,12 @@ module RecordStore
     )
 
     def fetch_authority(nameserver = ROOT_SERVERS.sample)
-      authority = Resolv::DNS.open(nameserver: nameserver) do |resolv|
-        resolv.fetch_resource(name, Resolv::DNS::Resource::IN::SOA) do |reply, name|
-          break if reply.answer.any?
+      authority = fetch_soa(nameserver) do |reply, _name|
+        break if reply.answer.any?
 
-          raise "No authority found (#{name})" unless reply.authority.any?
+        raise "No authority found (#{name})" unless reply.authority.any?
 
-          break extract_authority(reply)
-        end
+        break extract_authority(reply.authority)
       end
 
       # candidate DNS name is returned instead when NXDomain or other error
@@ -147,18 +145,39 @@ module RecordStore
 
     private
 
-    def extract_authority(reply)
-      authority = reply.authority.sample
+    def fetch_soa(nameserver)
+      Resolv::DNS.open(nameserver: nameserver) do |resolv|
+        resolv.fetch_resource(name, Resolv::DNS::Resource::IN::SOA) do |reply, name|
+          yield reply, name
+        end
+      end
+    end
 
-      if unrooted_name.casecmp?(authority.first.to_s)
-        build_authority(reply.authority)
+    def resolve_authority(authority)
+      nameservers = authority.map { |a| a.last.name.to_s }
+
+      begin
+        nameserver = nameservers.shift
+        fetch_authority(nameserver)
+      rescue Errno::EHOSTUNREACH => e
+        $stderr.puts "Warning: #{e} [host=#{nameserver}]"
+        raise if nameservers.empty?
+        retry
+      end
+    end
+
+    def extract_authority(authority)
+      if unrooted_name.casecmp?(authority.first.first.to_s)
+        build_authority(authority)
       else
-        fetch_authority(authority.last.name.to_s) || build_authority(reply.authority)
+        resolve_authority(authority) || build_authority(authority)
       end
     end
 
     def build_authority(authority)
-      authority.map.with_index do |(name, ttl, data), index|
+      ns = authority.select { |_name, _ttl, data| data.is_a?(Resolv::DNS::Resource::IN::NS) }
+
+      ns.map.with_index do |(name, ttl, data), index|
         Record::NS.new(ttl: ttl, fqdn: name.to_s, nsdname: data.name.to_s, record_id: index)
       end
     end

data/lib/record_store/zone/yaml_definitions.rb

@@ -10,6 +10,7 @@ module RecordStore
       def defined
         @defined ||= yaml_files
           .map { |file| load_yml_zone_definition(file) }
+          .sort_by(&:unrooted_name)
           .index_by(&:unrooted_name)
       end
 

data/record_store.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'fog-xml'
   spec.add_runtime_dependency 'fog-dynect', '~> 0.4.0'
   spec.add_runtime_dependency 'dnsimple', '~> 4.4.0'
-  spec.add_runtime_dependency 'google-cloud-dns'
+  spec.add_runtime_dependency 'google-cloud-dns', '~> 0.31.0'
   spec.add_runtime_dependency 'ruby-limiter', '~> 1.0', '>= 1.0.1'
   spec.add_runtime_dependency 'ns1'
   spec.add_runtime_dependency 'oci', '~> 2.6.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 5.11.0
+  version: 6.1.2
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -141,16 +141,16 @@ dependencies:
   name: google-cloud-dns
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: ruby-limiter
   requirement: !ruby/object:Gem::Requirement
@@ -355,12 +355,14 @@ files:
 - lib/record_store/cli.rb
 - lib/record_store/provider.rb
 - lib/record_store/provider/dnsimple.rb
+- lib/record_store/provider/dnsimple/patch_api_header.rb
 - lib/record_store/provider/dynect.rb
 - lib/record_store/provider/google_cloud_dns.rb
 - lib/record_store/provider/ns1.rb
 - lib/record_store/provider/ns1/client.rb
 - lib/record_store/provider/ns1/patch_api_header.rb
 - lib/record_store/provider/oracle_cloud_dns.rb
+- lib/record_store/provider/provider_utils/rate_limit.rb
 - lib/record_store/record.rb
 - lib/record_store/record/a.rb
 - lib/record_store/record/aaaa.rb
@@ -412,7 +414,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Manage DNS using git