record_store 5.5.3 → 5.5.4

data/.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_from:
+  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - vendor/**/*
+  UseCache: true
+  CacheRootDirectory: tmp/rubocop
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  Include:
+    - '**/*.rb'
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -8,4 +8,5 @@ before_install:
   - gem --version
 
 before_script:
+  - bin/rubocop --version && bin/rubocop
   - bin/setup

data/bin/console

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'bundler/setup'
 require 'record_store'
 
@@ -8,4 +8,4 @@ RecordStore.zones_path = File.expand_path('../../dev/zones', __FILE__)
 RecordStore.config_path = File.expand_path('../../dev/config.yml', __FILE__)
 
 require 'pry'
-binding.pry(RecordStore)
+binding.pry(RecordStore) # rubocop:disable Lint/Debugger

data/bin/record-store

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'bundler/setup'
 require 'record_store'
 

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/dev.yml

@@ -17,3 +17,7 @@ commands:
       else
         bundle exec ruby -Itest "$@"
       fi
+  style:
+    syntax: ""
+    desc:   'Run rubocop'
+    run:    'bin/rubocop'

data/lib/record_store.rb

@@ -46,7 +46,10 @@ module RecordStore
     end
 
     def zones_path
-      @zones_path ||= Pathname.new(File.expand_path(config.fetch('zones_path'), File.dirname(config_path))).realpath.to_s
+      @zones_path ||= Pathname.new(
+        File.expand_path(config.fetch('zones_path'),
+        File.dirname(config_path)),
+      ).realpath.to_s
     end
 
     def config_path

data/lib/record_store/changeset.rb

@@ -4,7 +4,9 @@ module RecordStore
       attr_accessor :type, :record, :id
 
       def initialize(type: nil, record: nil, id: nil)
-        @type, @record, @id = type, record, id
+        @type = type
+        @record = record
+        @id = id
       end
 
       def self.addition(record)
@@ -37,7 +39,7 @@ module RecordStore
     def self.build_from(provider:, zone:)
       current_zone = provider.build_zone(zone_name: zone.unrooted_name, config: zone.config)
 
-      self.new(
+      new(
         current_records: current_zone.records,
         desired_records: zone.records,
         provider: provider,
@@ -51,7 +53,9 @@ module RecordStore
       @provider = provider
       @zone = zone
 
-      @additions, @removals, @updates = [], [], []
+      @additions = []
+      @removals = []
+      @updates = []
 
       build_changeset
     end
@@ -81,7 +85,7 @@ module RecordStore
     def build_changeset
       current_records_set = (current_records - unchanged).sort_by(&:to_s).group_by(&:key)
       desired_records_set = (desired_records - unchanged).sort_by(&:to_s).group_by(&:key)
-      current_records_set.default_proc = desired_records_set.default_proc = Proc.new{Array.new}
+      current_records_set.default_proc = desired_records_set.default_proc = proc { [] }
 
       record_keys = current_records_set.keys | desired_records_set.keys
 

data/lib/record_store/cli.rb

@@ -1,3 +1,5 @@
+require 'English'
+
 module RecordStore
   class CLI < Thor
     class_option :config, desc: 'Path to config.yml', aliases: '-c'
@@ -34,9 +36,7 @@ module RecordStore
     def list
       Zone.each do |name, zone|
         puts "Zone: #{name}"
-        zone.records.each do |record|
-          record.log!
-        end
+        zone.records.each(&:log!)
       end
     end
 
@@ -60,34 +60,33 @@ module RecordStore
           next if !options.fetch('verbose') && changeset.changes.empty?
 
           puts '-' * 20
-          puts "Provider: #{changeset.provider.to_s}"
+          puts "Provider: #{changeset.provider}"
 
           if !changeset.additions.empty? || options.fetch('verbose')
             puts "Add:"
             changeset.additions.map(&:record).each do |record|
-              puts " - #{record.to_s}"
+              puts " - #{record}"
             end
           end
 
           if !changeset.removals.empty? || options.fetch('verbose')
             puts "Remove:"
             changeset.removals.map(&:record).each do |record|
-              puts " - #{record.to_s}"
+              puts " - #{record}"
             end
           end
 
           if !changeset.updates.empty? || options.fetch('verbose')
             puts "Update:"
             changeset.updates.map(&:record).each do |record|
-              puts " - #{record.to_s}"
+              puts " - #{record}"
             end
           end
 
-          if options.fetch('verbose')
-            puts "Unchanged:"
-            changeset.unchanged.each do |record|
-              puts " - #{record.to_s}"
-            end
+          next unless options.fetch('verbose')
+          puts "Unchanged:"
+          changeset.unchanged.each do |record|
+            puts " - #{record}"
           end
         end
         puts '=' * 20
@@ -105,7 +104,7 @@ module RecordStore
       end
 
       zones.each do |zone|
-        abort "Attempted to apply invalid zone: #{zone.name}" unless zone.valid?
+        abort("Attempted to apply invalid zone: #{zone.name}") unless zone.valid?
 
         changesets = zone.build_changesets
         changesets.each(&:apply)
@@ -116,11 +115,12 @@ module RecordStore
 
     option :name, desc: 'Zone to download', aliases: '-n', type: :string, required: true
     option :provider, desc: 'Provider in which this zone exists', aliases: '-p', type: :string
-    desc 'download', 'Downloads all records from zone and creates YAML zone definition in zones/ e.g. record-store download --name=shopify.io'
+    desc 'download', 'Downloads all records from zone and creates YAML zone definition in zones/ '\
+                     'e.g. record-store download --name=shopify.io'
     def download
       name = options.fetch('name')
-      abort 'Please omit the period at the end of the zone' if name.ends_with?('.')
-      abort 'Zone with this name already exists in zones/' if File.exist?("#{RecordStore.zones_path}/#{name}.yml")
+      abort('Please omit the period at the end of the zone') if name.ends_with?('.')
+      abort('Zone with this name already exists in zones/') if File.exist?("#{RecordStore.zones_path}/#{name}.yml")
 
       provider = options.fetch('provider', Provider.provider_for(name))
       if provider.nil?
@@ -151,11 +151,12 @@ module RecordStore
     desc 'sort', 'Sorts the zonefile alphabetically e.g. record-store sort --name=shopify.io'
     def sort
       name = options.fetch('name')
-      abort "Please omit the period at the end of the zone" if name.ends_with?('.')
+      abort("Please omit the period at the end of the zone") if name.ends_with?('.')
 
       yaml = YAML.load_file("#{RecordStore.zones_path}/#{name}.yml")
-      yaml.fetch(name).fetch('records').sort_by! { |r| [r.fetch('fqdn'), r.fetch('type'), r['nsdname'] || r['address']] }
-
+      yaml.fetch(name).fetch('records').sort_by! do |r|
+        [r.fetch('fqdn'), r.fetch('type'), r['nsdname'] || r['address']]
+      end
       File.write("#{RecordStore.zones_path}/#{name}.yml", yaml.deep_stringify_keys.to_yaml.gsub("---\n", ''))
     end
 
@@ -171,11 +172,11 @@ module RecordStore
         end
       end
 
-      secrets = `ejson decrypt #{RecordStore.secrets_path.sub(/\.json\z/, ".#{environment}.ejson")}`
-      if $?.exitstatus == 0
+      secrets = %x(ejson decrypt #{RecordStore.secrets_path.sub(/\.json\z/, ".#{environment}.ejson")})
+      if $CHILD_STATUS.success?
         File.write(RecordStore.secrets_path, secrets)
       else
-        abort secrets
+        abort(secrets)
       end
     end
 
@@ -184,7 +185,7 @@ module RecordStore
       zones = Zone.modified.map(&:name)
 
       unless zones.empty?
-        abort "The following zones have diverged: #{zones.join(', ')}"
+        abort("The following zones have diverged: #{zones.join(', ')}")
       end
     end
 
@@ -200,18 +201,18 @@ module RecordStore
         end
 
         invalid_records = zone.records.reject(&:valid?)
-        puts '  Invalid records' if invalid_records.size > 0
+        puts '  Invalid records' unless invalid_records.empty?
 
         invalid_records.each do |record|
-          puts "    #{record.to_s}"
+          puts "    #{record}"
           record.errors.each do |field, msg|
             puts "      - #{field}: #{msg}"
           end
         end
       end
 
-      if invalid_zones.size > 0
-        abort "The following zones were invalid: #{invalid_zones.join(', ')}"
+      if invalid_zones.present?
+        abort("The following zones were invalid: #{invalid_zones.join(', ')}")
       else
         puts "All zones have valid definitions."
       end
@@ -227,7 +228,10 @@ module RecordStore
         end
 
         unless removals.empty?
-          abort "As a safety measure, you cannot remove more than #{MAXIMUM_REMOVALS} records at a time per zone. (zones failing this: #{removals.map(&:name).join(', ')})"
+          error = +"As a safety measure, you cannot remove more than #{MAXIMUM_REMOVALS} "
+          error << 'records at a time per zone. '
+          error << "(zones failing this: #{removals.map(&:name).join(', ')})"
+          abort(error)
         end
       end
     end
@@ -235,30 +239,28 @@ module RecordStore
     SKIP_CHECKS = 'SKIP_DEPLOY_VALIDATIONS'
     desc 'validate_initial_state', "Validates state hasn't diverged since the last deploy"
     def validate_initial_state
-      begin
-        assert_empty_diff
-        puts "Deploy will cause no changes, no need to validate initial state"
-      rescue SystemExit
-        if File.exist?(File.expand_path(SKIP_CHECKS, Dir.pwd))
-          puts "Found '#{SKIP_CHECKS}', skipping predeploy validations"
-        else
-          puts "Checkout git SHA #{ENV['LAST_DEPLOYED_SHA']}"
-          `git checkout #{ENV['LAST_DEPLOYED_SHA']}`
-          abort "Checkout of old commit failed" if $?.exitstatus != 0
+      assert_empty_diff
+      puts "Deploy will cause no changes, no need to validate initial state"
+    rescue SystemExit
+      if File.exist?(File.expand_path(SKIP_CHECKS, Dir.pwd))
+        puts "Found '#{SKIP_CHECKS}', skipping predeploy validations"
+      else
+        puts "Checkout git SHA #{ENV['LAST_DEPLOYED_SHA']}"
+        %x(git checkout #{ENV['LAST_DEPLOYED_SHA']})
+        abort("Checkout of old commit failed") unless $CHILD_STATUS.success?
 
-          `record-store secrets`
-          abort "Decrypt secrets failed" if $?.exitstatus != 0
+        %x(record-store secrets)
+        abort("Decrypt secrets failed") unless $CHILD_STATUS.success?
 
-          `record-store assert_empty_diff`
-          abort "Dyn status has diverged!" if $?.exitstatus != 0
+        %x(record-store assert_empty_diff)
+        abort("Dyn status has diverged!") unless $CHILD_STATUS.success?
 
-          puts "Checkout git SHA #{ENV['REVISION']}"
-          `git checkout #{ENV['REVISION']}`
-          abort "Checkout of new commit failed" if $?.exitstatus != 0
+        puts "Checkout git SHA #{ENV['REVISION']}"
+        %x(git checkout #{ENV['REVISION']})
+        abort("Checkout of new commit failed") unless $CHILD_STATUS.success?
 
-          `record-store secrets`
-          abort "Decrypt secrets failed" if $?.exitstatus != 0
-        end
+        %x(record-store secrets)
+        abort("Decrypt secrets failed") unless $CHILD_STATUS.success?
       end
     end
 

data/lib/record_store/provider.rb

@@ -9,20 +9,18 @@ module RecordStore
         begin
           ns_server = dns.getresource(zone_name, Resolv::DNS::Resource::IN::SOA).mname.to_s
         rescue Resolv::ResolvError
-          abort "Domain doesn't exist"
+          abort("Domain doesn't exist")
         end
 
         case ns_server
-        when /dnsimple\.com\z/
+        when /\.dnsimple\.com\z/
           'DNSimple'
-        when /dynect\.net\z/
+        when /\.dynect\.net\z/
           'DynECT'
-        when /googledomains\.com\z/
+        when /\.googledomains\.com\z/
           'GoogleCloudDNS'
         when /\.nsone\.net\z/
           'NS1'
-        else
-          nil
         end
       end
 
@@ -54,7 +52,7 @@ module RecordStore
       end
 
       # returns an array of Record objects that match the records which exist in the provider
-      def retrieve_current_records(zone:, stdout: $stdout)
+      def retrieve_current_records(zone:, stdout: $stdout) # rubocop:disable Lint/UnusedMethodArgument
         raise NotImplementedError
       end
 
@@ -91,28 +89,28 @@ module RecordStore
       end
 
       def thawable?
-        self.respond_to?(:thaw_zone)
+        respond_to?(:thaw_zone)
       end
 
       def freezable?
-        self.respond_to?(:freeze_zone)
+        respond_to?(:freeze_zone)
       end
 
       def to_s
-        self.name.demodulize
+        name.demodulize
       end
 
       private
 
-      def add(record)
+      def add(record) # rubocop:disable Lint/UnusedMethodArgument
         raise NotImplementedError
       end
 
-      def remove(record)
+      def remove(record) # rubocop:disable Lint/UnusedMethodArgument
         raise NotImplementedError
       end
 
-      def update(id, record)
+      def update(id, record) # rubocop:disable Lint/UnusedMethodArgument
         raise NotImplementedError
       end
     end

data/lib/record_store/provider/dnsimple.rb

@@ -113,7 +113,7 @@ module RecordStore
 
       def api_hash(record, zone)
         record_hash = {
-          name: record.fqdn.gsub("#{Record.ensure_ends_with_dot(zone)}", '').chomp('.'),
+          name: record.fqdn.gsub(Record.ensure_ends_with_dot(zone).to_s, '').chomp('.'),
           ttl: record.ttl,
           type: record.type,
         }
@@ -138,7 +138,6 @@ module RecordStore
           record_hash[:content] = "#{record.weight} #{record.port} #{record.target.chomp('.')}"
           record_hash[:priority] = record.priority
         end
-
         record_hash
       end
     end

data/lib/record_store/provider/dynect.rb

@@ -1,8 +1,8 @@
 require 'fog/dynect'
 require 'limiter'
 
-Fog::DNS::Dynect::Real.extend Limiter::Mixin
-Fog::DNS::Dynect::Real.limit_method :request, rate: 5, interval: 1 # 5 RPS == 300 RPM
+Fog::DNS::Dynect::Real.extend(Limiter::Mixin)
+Fog::DNS::Dynect::Real.limit_method(:request, rate: 5, interval: 1) # 5 RPS == 300 RPM
 
 module RecordStore
   class Provider::DynECT < Provider
@@ -34,7 +34,7 @@ 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.get_all_records(zone).body.fetch('data').flat_map do |type, records|
+        session.get_all_records(zone).body.fetch('data').flat_map do |_type, records|
           records.map do |record_body|
             begin
               build_from_api(record_body)
@@ -88,8 +88,8 @@ module RecordStore
 
       def api_rdata(record)
         case record.type
-        when 'TXT'
-          { txtdata: record.rdata_txt }
+        when 'SPF', 'TXT'
+          { txtdata: Record.long_quote(record.rdata_txt) }
         else
           record.rdata
         end
@@ -102,7 +102,7 @@ module RecordStore
         type = record.fetch(:record_type)
         return if type == 'SOA'
 
-        record[:txtdata] = Record.unescape(record[:txtdata]) if %w[SPF TXT].include?(type)
+        record[:txtdata] = Record.unlong_quote(Record.unescape(record[:txtdata])) if %w[SPF TXT].include?(type)
 
         fqdn = record.fetch(:fqdn)
         fqdn = "#{fqdn}." unless fqdn.ends_with?('.')