record_store 6.3.1 → 6.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6875c27f0cf86510b733a58f668d44560eeb40e7c8b6c9438183fee175bc514
-  data.tar.gz: 3599cc9903a5afe46d544f8aeef349961fdc2d95011973325bbdcc75972c56c5
+  metadata.gz: 7870ecd8f6c7f112a049ad82c71993773df9cd47ebfec1ece571bac97d209572
+  data.tar.gz: 6c137abf69f115a6fc78e38e800ff3d270d54e6462c2467627f97b8fc524dd4e
 SHA512:
-  metadata.gz: 9a6def9342919457cc71fdda4691c92310450dfc28a476eee6d353b73798b8d1b612b4775982704b0c44b2e657149a02f0e96330796b03d591619ad5930509ae
-  data.tar.gz: 42183ae0ecd31e27a2d40977ecdda6cb51c0368ff24ac3a2de4411ab016809c5551ee3faeb50eb53503be059ece4bc41889e6c73d3e1f0ab53e7ab9290563628
+  metadata.gz: 376c0a4183592b115118cabf2d89befa26209d0f02bd85f82bece5e0afc5c2c62db8fc2c1ae6668ccfe57148ccbee922aca7386fcb04e9ec5785fbabfb195744
+  data.tar.gz: 8a42c0c7ed8a121d57c0b2c58f2bbe6f568c809fe53e9908724083415f44643497d6019a1cb712e561901ee4e1258d523f9f36738221090ff321c921fb99037c

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 100
+    groups:
+      minor_versions:
+        update-types:
+          - 'minor'
+          - 'patch'  
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: weekly

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on: [push, pull_request]
+
+env:
+  SRB_SKIP_GEM_RBIS: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.7.1, 3.2.1 ]
+    name: Test Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install build-essential libcurl4-openssl-dev
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: rubocop
+        run: bin/rubocop --version && bin/rubocop
+      - name: setup
+        run: bin/setup
+      - name: test
+        run: bundle exec rake test

data/.github/workflows/cla.yml

@@ -0,0 +1,23 @@
+# .github/workflows/cla.yml
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      )
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.github/workflows/stale-action-handling.yml

@@ -0,0 +1,31 @@
+# Configuration for stale action https://github.com/actions/stale
+name: 'Close stale issues and PRs'
+on:
+  schedule:
+    - cron: '0 14 * * *'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/stale@v9
+        with:
+          ascending: true
+          operations-per-run: 100
+          stale-pr-message: 'As of today this PR is stale. If you want to keep it apply an update otherwise it will be closed in 7 days.'
+          close-pr-message: 'PR was closed because of missing activity.'
+          days-before-pr-stale: 90
+          days-before-pr-close: 7
+          stale-issue-message: >
+            This issue is stale because it has been open for 90 days with no activity. It will be closed if no further action occurs in 7 days.
+          close-issue-message: |
+            We are closing this issue because it has been inactive for a few months.
+            This probably means that it is not reproducible or it has been fixed in a newer version.
+            If it's an enhancement and hasn't been taken on since it was submitted, then it seems other issues have taken priority.
+          days-before-issue-stale: 90
+          days-before-issue-close: 7

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

@@ -195,6 +195,7 @@ Style/FrozenStringLiteralComment:
   SupportedStyles:
     - always
     - never
+  SafeAutoCorrect: true
 
 Style/GlobalVars:
   AllowedVariables: []
@@ -264,7 +265,7 @@ Style/MethodCallWithArgsParentheses:
   - raise
   - puts
   Exclude:
-  - Gemfile
+  - '**/Gemfile'
 
 Style/MethodDefParentheses:
   EnforcedStyle: require_parentheses
@@ -577,6 +578,7 @@ Layout/BlockEndNewline:
 
 Style/CaseEquality:
   Enabled: true
+  AllowOnConstant: true
 
 Style/CharacterLiteral:
   Enabled: true
@@ -659,6 +661,9 @@ Style/IfWithSemicolon:
 Style/IdenticalConditionalBranches:
   Enabled: true
 
+Layout/IndentationStyle:
+  Enabled: true
+
 Style/InfiniteLoop:
   Enabled: true
 
@@ -803,9 +808,6 @@ Layout/SpaceInsideRangeLiteral:
 Style/SymbolLiteral:
   Enabled: true
 
-Layout/IndentationStyle:
-  Enabled: true
-
 Layout/TrailingWhitespace:
   Enabled: true
 
@@ -834,7 +836,7 @@ Style/ZeroLengthPredicate:
   Enabled: true
 
 Layout/HeredocIndentation:
-  EnforcedStyle: squiggly
+  Enabled: true
 
 Lint/AmbiguousOperator:
   Enabled: true
@@ -1015,3 +1017,6 @@ Style/ModuleFunction:
 
 Lint/OrderedMagicComments:
   Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true

data/.rubocop.yml

@@ -1,19 +1,40 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6.4
   Exclude:
     - vendor/**/*
   UseCache: true
   CacheRootDirectory: tmp/rubocop
 
+Naming/InclusiveLanguage:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/QuotedSymbols:
+  Enabled: false
+
 Style/MethodCallWithArgsParentheses:
   Include:
     - '**/*.rb'
 
-Style/ClassAndModuleChildren:
-  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -1,7 +1,7 @@
 cache: bundler
 language: ruby
 rvm:
-  - 2.6.4
+  - 3.2.1
 
 before_install:
   - gem update --system

data/CHANGELOG.md

@@ -1,5 +1,57 @@
 # CHANGELOG
 
+# 6.7.1
+- Change update_record to update_zone_record for DNSimple
+
+## 6.7.0
+- Update dependencies like dnsimple, thor, ruby-limiter
+
+## 6.6.0
+- Update ruby version
+
+## 6.5.11
+- Fix updates of SRV records in using the NS1 provider
+
+## 6.5.10
+- print the full error for ActiveModel::Error errors
+
+## 6.5.9
+- Relax version requirements for the google-cloud-dns gem
+
+## 6.5.5
+- Include DNSimple validation error details in exceptions
+
+## 6.5.4
+- Updates config path structure for build pipeline
+
+## 6.5.3
+- Adds check for detecting shadowed records, used when a record being added to a zone in record-store will have no effect because it is shadowed by another record.
+
+## 6.5.2
+- Ensure filters for implicit_records, `except_record` and `conflict_with`, are truly optional [BUGFIX]
+
+## 6.5.1
+
+Add support for a new parameter in the implicit records templates:
+
+- `except_record`: the template will *NOT* generate the `injected_records` for records matching `except_record`, even if they matched `each_record`.
+
+Also added support for regular expressions in the matching, using the already available `!ruby/regexp` text in a YAML value. The object loaded from the YAML
+will be of `Regexp` type, and will thus be used to _match_ the value, instead of being identical only. This is supported in both `except_record` and
+`each_record` fields.
+
+## 6.5.0
+
+...
+
+## 6.4.0
+
+Add support for injecting implicit records into a zone based on a pre-configured template. Brief overview of template keys:
+
+- `each_record`: the template will generate all `injected_records` in the template for each Record in the Zone that matches criteria listed here.
+- `conflict_with`: if any Record in the Zone matches the criteria listed here, the template will avoid injecting any of its generated implicit records into the zone
+- `injected_records`: the implicit records that will be generated by the template for every Zone Record that matches the `each_record` criteria
+
 ## 6.3.1
 - Improve resiliency in the face of temporary provider outages [BUGFIX]
 

data/README.md

@@ -20,6 +20,12 @@ record-store validate_initial_state    # Validates state hasn't diverged since t
 record-store validate_records          # Validates that all DNS records have valid definitions
 ```
 
+## Releasing a new version
+* Bump the version [here](https://github.com/Shopify/record_store/blob/main/lib/record_store/version.rb).
+* Add to CHANGELOG [here](https://github.com/Shopify/record_store/blob/main/CHANGELOG.md).
+* PR, merge and shipit [here](https://shipit.shopify.io/shopify/record_store/production).
+
+
 ## Providers
 
 Below is the list of DNS providers supported by Record Store. PRs [adding more](#adding-new-providers) are welcome.
@@ -116,6 +122,13 @@ When running `bin/record-store apply`, a `Changeset` is generated by comparing t
 
 Record store attempts to parallelize some of the bulk zone fetching operations. It does so by spawning multiple threads (default: 10). This value can be configured by setting the RECORD_STORE_MAX_THREADS environment variable to a positive integer value.
 
+
+### Templates
+
+Record Store supports injecting implicit records into a zone based on templates. Each `Zone` can have a list of `Zone::Config::ImplicitRecordTemplate` in its `Zone::Config` that can define their own criteria for which records they use for generating implicit template records, which records conflict with the template-generated records, and what the template-generated records look like. These records are injected at the time of `Zone` initialization within `Zone#build_records`.
+
+Templates can help reduce zone file bloat where instead of defining many generic literals within the zone file for a given criteria zone record, these generic records can be implicitly injected into the `Zone` at the time of initialization based on information provided within the template.
+
 ----
 
 # Development

data/bin/console

@@ -6,6 +6,7 @@ require 'record_store'
 
 RecordStore.zones_path = File.expand_path('../../dev/zones', __FILE__)
 RecordStore.config_path = File.expand_path('../../dev/config.yml', __FILE__)
+RecordStore.implicit_records_templates_path = File.expand_path('../../dev/templates/implicit_records', __FILE__)
 
 require 'pry'
 binding.pry(RecordStore) # rubocop:disable Lint/Debugger

data/bin/rubocop

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/dev.yml

@@ -2,7 +2,7 @@
 name: recordstore
 
 up:
-  - ruby: 2.6.4
+  - ruby: 3.2.1
   - bundler
 
 commands:

data/lib/record_store/changeset.rb

@@ -9,16 +9,18 @@ module RecordStore
         @id = id
       end
 
-      def self.addition(record)
-        new(type: :addition, record: record)
-      end
+      class << self
+        def addition(record)
+          new(type: :addition, record: record)
+        end
 
-      def self.removal(record)
-        new(type: :removal, record: record)
-      end
+        def removal(record)
+          new(type: :removal, record: record)
+        end
 
-      def self.update(id, record)
-        new(type: :update, record: record, id: id)
+        def update(id, record)
+          new(type: :update, record: record, id: id)
+        end
       end
 
       def removal?
@@ -36,18 +38,20 @@ module RecordStore
 
     attr_reader :current_records, :desired_records, :removals, :additions, :updates, :provider, :zone
 
-    def self.build_from(provider:, zone:, all: false)
-      current_zone = provider.build_zone(zone_name: zone.unrooted_name, config: zone.config)
+    class << self
+      def 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
+        current_records = all ? current_zone.all : current_zone.records
+        desired_records = all ? zone.all : zone.records
 
-      new(
-        current_records: current_records,
-        desired_records: desired_records,
-        provider: provider,
-        zone: zone.unrooted_name
-      )
+        new(
+          current_records: current_records,
+          desired_records: desired_records,
+          provider: provider,
+          zone: zone.unrooted_name,
+        )
+      end
     end
 
     def initialize(current_records: [], desired_records: [], provider:, zone:)

data/lib/record_store/cli.rb

@@ -10,8 +10,10 @@ module RecordStore
       RecordStore.config_path = options.fetch('config', "#{Dir.pwd}/config.yml")
     end
 
-    def self.exit_on_failure?
-      true
+    class << self
+      def exit_on_failure?
+        true
+      end
     end
 
     desc 'thaw', 'Thaws all zones under management to allow manual edits'
@@ -108,6 +110,7 @@ module RecordStore
           end
 
           next unless options.fetch('verbose')
+
           puts "Unchanged:"
           changeset.unchanged.each do |record|
             puts " - #{record}"
@@ -147,7 +150,7 @@ 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'
+      '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?('.')
@@ -193,14 +196,12 @@ module RecordStore
 
     desc 'secrets', 'Decrypts DynECT credentials'
     def secrets
-      environment = begin
-        if ENV['PRODUCTION']
-          'production'
-        elsif ENV['CI']
-          'ci'
-        else
-          'dev'
-        end
+      environment = if ENV['PRODUCTION']
+        'production'
+      elsif ENV['CI']
+        'ci'
+      else
+        'dev'
       end
 
       secrets = %x(ejson decrypt #{RecordStore.secrets_path.sub(/\.json\z/, ".#{environment}.ejson")})
@@ -281,9 +282,7 @@ module RecordStore
         invalid_zones << zone.unrooted_name
 
         puts "#{zone.unrooted_name} definition is not valid:"
-        zone.errors.each do |field, msg|
-          puts " - #{field}: #{msg}"
-        end
+        puts zone.errors.full_messages.map { |msg| " - #{msg}" }
 
         invalid_records = zone.records.reject(&:valid?)
         puts '  Invalid records' unless invalid_records.empty?

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

@@ -0,0 +1,20 @@
+module Dnsimple
+  class RequestError < Error
+    private
+
+    alias_method :original_message_from, :message_from
+
+    def message_from(http_response)
+      message = original_message_from(http_response)
+      return unless json_response?(http_response)
+
+      base_error = http_response.parsed_response.dig("errors", "base")&.join(", ")
+      message += ": #{base_error}" unless base_error.nil?
+      message
+    end
+
+    def json_response?(http_response)
+      http_response.headers["Content-Type"]&.start_with?("application/json")
+    end
+  end
+end

data/lib/record_store/provider/dnsimple.rb

@@ -1,5 +1,6 @@
 require 'dnsimple'
 require_relative 'dnsimple/patch_api_header'
+require_relative 'dnsimple/patch_request_error_to_include_errors'
 
 module RecordStore
   class Provider::DNSimple < Provider
@@ -19,13 +20,11 @@ module RecordStore
       # returns an array of Record objects that match the records which exist in the provider
       def retrieve_current_records(zone:, stdout: $stdout)
         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
+          session.zones.all_zone_records(account_id, zone).data.map do |record|
+            build_from_api(record, zone)
+          rescue StandardError
+            stdout.puts "Cannot build record: #{record}"
+            raise
           end.compact
         end
       end
@@ -41,7 +40,7 @@ module RecordStore
 
       def add(record, zone)
         record_hash = api_hash(record, zone)
-        res = session.zones.create_record(account_id, zone, record_hash)
+        res = session.zones.create_zone_record(account_id, zone, record_hash)
 
         if record.type == 'ALIAS'
           txt_alias = retrieve_current_records(zone: zone).detect do |rr|
@@ -54,17 +53,17 @@ module RecordStore
       end
 
       def remove(record, zone)
-        session.zones.delete_record(account_id, zone, record.id)
+        session.zones.delete_zone_record(account_id, zone, record.id)
       end
 
       def update(id, record, zone)
-        session.zones.update_record(account_id, zone, id, api_hash(record, zone))
+        session.zones.update_zone_record(account_id, zone, id, api_hash(record, zone))
       end
 
       def session
         @dns ||= Dnsimple::Client.new(
           base_url: secrets.fetch('base_url'),
-          access_token: secrets.fetch('api_token')
+          access_token: secrets.fetch('api_token'),
         )
       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::Dynect::DNS::Real.extend(Limiter::Mixin)
+Fog::Dynect::DNS::Real.limit_method(:request, rate: 5, interval: 1) # 5 RPS == 300 RPM
 
 module RecordStore
   class Provider::DynECT < Provider
@@ -36,11 +36,9 @@ module RecordStore
       def retrieve_current_records(zone:, stdout: $stdout)
         session.get_all_records(zone).body.fetch('data').flat_map do |_type, records|
           records.map do |record_body|
-            begin
-              build_from_api(record_body)
-            rescue StandardError
-              stdout.puts "Cannot build record: #{record_body}"
-            end
+            build_from_api(record_body)
+          rescue StandardError
+            stdout.puts "Cannot build record: #{record_body}"
           end
         end.compact
       end

data/lib/record_store/provider/google_cloud_dns.rb

@@ -22,13 +22,11 @@ module RecordStore
 
           # Unroll each record set into multiple records
           record_set.data.map do |record|
-            begin
-              record_set_member = record_set.dup
-              record_set_member.data = [record]
-              build_from_api(record_set_member)
-            rescue StandardError
-              stdout.puts "Cannot build record: #{record}"
-            end
+            record_set_member = record_set.dup
+            record_set_member.data = [record]
+            build_from_api(record_set_member)
+          rescue StandardError
+            stdout.puts "Cannot build record: #{record}"
           end
         end
 
@@ -44,12 +42,10 @@ module RecordStore
       private
 
       def session
-        @dns ||= begin
-          Google::Cloud::Dns.new(
-            project_id: secrets.fetch('project_id'),
-            credentials: Google::Cloud::Dns::Credentials.new(secrets),
-          )
-        end
+        @dns ||= Google::Cloud::Dns.new(
+          project_id: secrets.fetch('project_id'),
+          credentials: Google::Cloud::Dns::Credentials.new(secrets),
+        )
       end
 
       def secrets

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

@@ -23,7 +23,8 @@ module RecordStore
       def record(zone:, fqdn:, type:, must_exist: false)
         result = super(zone, fqdn, type)
         raise_if_error!(result) if must_exist
-        return nil if result.is_a?(NS1::Response::Error)
+        return if result.is_a?(NS1::Response::Error)
+
         result
       end
 
@@ -52,6 +53,7 @@ module RecordStore
         if result.is_a?(NS1::Response::UnparsableBodyError)
           raise RecordStore::Provider::UnparseableBodyError, result.to_s
         end
+
         raise RecordStore::Provider::Error, result.to_s
       end
     end

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

@@ -19,7 +19,7 @@ module NS1::Transport
 
       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
+          [1, response_hash[X_RATELIMIT_REMAINING].first.to_i].max.to_f
 
         rate_limit = RateLimitWaiter.new('NS1')
         rate_limit.wait(sleep_time)