record_store 5.0.4 → 5.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e8f21e1bb405e185727380fc0c7760116ef5deb
-  data.tar.gz: 29bed06e5aa2e8a4e3f78690015ee3bcc5f96c92
+  metadata.gz: 8898e68756f44cc7777bfbbff84d9806eeace0ed
+  data.tar.gz: 861fc60403a348b1c2c2fe0bf551a935e1a747ff
 SHA512:
-  metadata.gz: d72af6c709460b9b81c44722e6ddd13cfa7f89f18659c7341f7512a6486c44e28364f512d49fee9f16d21240db229d16df07936447f6214356e76a64df862a02
-  data.tar.gz: 35ae3d3718486153cdd9d763de16ca4ef478e0a58f283fd43f6a39a537455547a75687f02daacc8add2db21c3415df42a26308fe08d7ba6691816eb8a551cdb5
+  metadata.gz: fbc65b2ee1998c5f13bd28025892b1433716e0c74c1e7e44a50b6e5550ecb66913acda076224a85c4059dcc878835bb02ec195adc80460a9c1177b8c46408d2d
+  data.tar.gz: ea7ab36879e1c6cae29573f9d51140a00e4f7a447563764f877dc4556b23f4f81bffe2f193137587f2c359011d72239ccb8a3b38750cd3163743540881917b86

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # CHANGELOG
 
+## 5.0.5
+- Output progress messages for GoogleCloudDNS provider too. [BUGFIX]
+- Fix quoting/escaping for TXT records. [BUGFIX]
+- Make implementation-specific methods of Provider private. [REFACTOR]
+- DRY up SPF support to use TXT superclass implementation. [REFACTOR]
+
 ## 5.0.4
-- Replaces fog-dnsimple with dnsimple-ruby gem.
+- Replaces fog-dnsimple with dnsimple-ruby gem. [REFACTOR]
+
+## 5.0.0
+- Use DNSimple API v2 (via fog-dnsimple gem update).
+
+## 4.0.7
 
-## ¯\_(ツ)_/¯
+- Fix issue updating records with same FQDN. [BUGFIX]

data/README.md

@@ -96,28 +96,6 @@ Provider API interactions are tested with [VCR](https://github.com/vcr/vcr). To
 Outline of [`Provider`](lib/record_store/provider.rb):
 ```ruby
 class Provider
-  # Creates a new record to the zone. It is expected this call modifies external state.
-  #
-  # Arguments:
-  # record - a kind of `Record`
-  def add(record)
-  end
-
-  # Deletes an existing record from the zone. It is expected this call modifies external state.
-  #
-  # Arguments:
-  # record - a kind of `Record`
-  def remove(record)
-  end
-
-  # Updates an existing record in the zone. It is expected this call modifies external state.
-  #
-  # Arguments:
-  # id - provider specific ID of record to update
-  # record - a kind of `Record` which the record with `id` should be updated to
-  def update(id, record)
-  end
-
   # Downloads all the records from the provider.
   #
   # Returns: an array of `Record` for each record in the provider's zone
@@ -141,6 +119,35 @@ class Provider
   # Unlocks the zone to allow making changes (see `Provider#freeze_zone`).
   def thaw
   end
+
+  private
+
+  ######## NOTE ########
+  # The following methods only need to be implemented if you are using the base provider's
+  # implementation of apply_changeset to manage the contents of the changeset (or transaction).
+  ######################
+
+  # Creates a new record to the zone. It is expected this call modifies external state.
+  #
+  # Arguments:
+  # record - a kind of `Record`
+  def add(record)
+  end
+
+  # Deletes an existing record from the zone. It is expected this call modifies external state.
+  #
+  # Arguments:
+  # record - a kind of `Record`
+  def remove(record)
+  end
+
+  # Updates an existing record in the zone. It is expected this call modifies external state.
+  #
+  # Arguments:
+  # id - provider specific ID of record to update
+  # record - a kind of `Record` which the record with `id` should be updated to
+  def update(id, record)
+  end
 end
 ```
 

data/dev.yml

@@ -2,7 +2,7 @@
 name: recordstore
 
 up:
-  - ruby: 2.3.1
+  - ruby: 2.4.3
   - bundler
 
 commands:

data/lib/record_store/changeset.rb

@@ -57,7 +57,11 @@ module RecordStore
     end
 
     def apply
+      puts "Applying #{additions.size} additions, #{removals.size} removals, and #{updates.size} updates..."
+
       provider.apply_changeset(self)
+
+      puts "Published #{zone} changes to #{provider}\n\n"
     end
 
     def unchanged

data/lib/record_store/provider.rb

@@ -55,40 +55,22 @@ module RecordStore
         raise NotImplementedError
       end
 
-      def add(record)
-        raise NotImplementedError
-      end
-
-      def remove(record)
-        raise NotImplementedError
-      end
-
-      def update(id, record)
-        raise NotImplementedError
-      end
-
       # Applies changeset to provider
       def apply_changeset(changeset, stdout = $stdout)
-        begin
-          stdout.puts "Applying #{changeset.additions.size} additions, #{changeset.removals.size} removals, & #{changeset.updates.size} updates..."
-
-          changeset.changes.each do |change|
-            case change.type
-              when :removal;
-                stdout.puts "Removing #{change.record}..."
-                remove(change.record, changeset.zone)
-              when :addition;
-                stdout.puts "Creating #{change.record}..."
-                add(change.record, changeset.zone)
-              when :update;
-                stdout.puts "Updating record with ID #{change.id} to #{change.record}..."
-                update(change.id, change.record, changeset.zone)
-              else
-                raise ArgumentError, "Unknown change type #{change.type.inspect}"
-            end
+        changeset.changes.each do |change|
+          case change.type
+          when :removal
+            stdout.puts "Removing #{change.record}..."
+            remove(change.record, changeset.zone)
+          when :addition
+            stdout.puts "Creating #{change.record}..."
+            add(change.record, changeset.zone)
+          when :update
+            stdout.puts "Updating record with ID #{change.id} to #{change.record}..."
+            update(change.id, change.record, changeset.zone)
+          else
+            raise ArgumentError, "Unknown change type #{change.type.inspect}"
           end
-
-          puts "\nPublished #{changeset.zone} changes to #{changeset.provider.to_s}\n"
         end
       end
 
@@ -116,6 +98,20 @@ module RecordStore
       def to_s
         self.name.demodulize
       end
+
+      private
+
+      def add(record)
+        raise NotImplementedError
+      end
+
+      def remove(record)
+        raise NotImplementedError
+      end
+
+      def update(id, record)
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/record_store/provider/dnsimple.rb

@@ -7,6 +7,25 @@ module RecordStore
         true
       end
 
+      # 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
+      end
+
+      # Returns an array of the zones managed by provider as strings
+      def zones
+        session.zones.all_zones(account_id).data.map(&:name)
+      end
+
+      private
+
       def add(record, zone)
         record_hash = api_hash(record, zone)
         res = session.zones.create_record(account_id, zone, record_hash)
@@ -29,25 +48,6 @@ module RecordStore
         session.zones.update_record(account_id, zone, id, api_hash(record, zone))
       end
 
-      # 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
-      end
-
-      # Returns an array of the zones managed by provider as strings
-      def zones
-        session.zones.all_zones(account_id).data.map(&:name)
-      end
-
-      private
-
       def session
         @dns ||= Dnsimple::Client.new(
           base_url: secrets.fetch('base_url'),
@@ -85,7 +85,7 @@ module RecordStore
         when 'NS'
           record.merge!(nsdname: api_record.content)
         when 'SPF', 'TXT'
-          record.merge!(txtdata: api_record.content.gsub(';', '\;'))
+          record.merge!(txtdata: Record::TXT.unescape(api_record.content).gsub(';', '\;'))
         when 'SRV'
           weight, port, host = api_record.content.split(' ')
 
@@ -124,7 +124,7 @@ module RecordStore
         when 'NS'
           record_hash[:content] = record.nsdname.chomp('.')
         when 'SPF', 'TXT'
-          record_hash[:content] = record.txtdata.gsub('\;', ';')
+          record_hash[:content] = Record::TXT.escape(record.txtdata).gsub('\;', ';')
         when 'SRV'
           record_hash[:content] = "#{record.weight} #{record.port} #{record.target.chomp('.')}"
           record_hash[:priority] = record.priority

data/lib/record_store/provider/dynect.rb

@@ -11,35 +11,21 @@ module RecordStore
         session.put_zone(zone, thaw: true)
       end
 
-      def add(record, zone)
-        session.post_record(record.type, zone, record.fqdn, record.rdata, 'ttl' => record.ttl)
-      end
-
-      def remove(record, zone)
-        session.delete_record(record.type, zone, record.fqdn, record.id)
-      end
-
-      def update(id, record, zone)
-        session.put_record(record.type, zone, record.fqdn, record.rdata, 'ttl' => record.ttl, 'record_id' => id)
-      end
-
       def publish(zone)
         session.put_zone(zone, publish: true)
       end
 
       # Applies changeset to provider
       def apply_changeset(changeset, stdout = $stdout)
-        begin
-          thaw_zone(changeset.zone)
-          super
-          publish(changeset.zone)
-        rescue StandardError
-          puts "An exception occurred while applying DNS changes, deleting changeset"
-          discard_change_set(changeset.zone)
-          raise
-        ensure
-          freeze_zone(changeset.zone)
-        end
+        thaw_zone(changeset.zone)
+        super
+        publish(changeset.zone)
+      rescue StandardError
+        puts "An exception occurred while applying DNS changes, deleting changeset"
+        discard_change_set(changeset.zone)
+        raise
+      ensure
+        freeze_zone(changeset.zone)
       end
 
       # returns an array of Record objects that match the records which exist in the provider
@@ -62,6 +48,18 @@ module RecordStore
 
       private
 
+      def add(record, zone)
+        session.post_record(record.type, zone, record.fqdn, api_rdata(record), 'ttl' => record.ttl)
+      end
+
+      def remove(record, zone)
+        session.delete_record(record.type, zone, record.fqdn, record.id)
+      end
+
+      def update(id, record, zone)
+        session.put_record(record.type, zone, record.fqdn, api_rdata(record), 'ttl' => record.ttl, 'record_id' => id)
+      end
+
       def discard_change_set(zone)
         session.request(expects: 200, method: :delete, path: "ZoneChanges/#{zone}")
       end
@@ -84,16 +82,28 @@ module RecordStore
         super.fetch('dynect')
       end
 
+      def api_rdata(record)
+        case record.type
+        when 'TXT'
+          { txtdata: record.rdata_txt }
+        else
+          record.rdata
+        end
+      end
+
       def build_from_api(api_record)
-        record = api_record.merge(api_record.fetch('rdata')).slice!('rdata').symbolize_keys
+        rdata = api_record.fetch('rdata')
+        record = api_record.merge(rdata).slice!('rdata').symbolize_keys
 
-        return if record.fetch(:record_type) == 'SOA'
+        type = record.fetch(:record_type)
+        return if type == 'SOA'
 
-        unless record.fetch(:fqdn).ends_with?('.')
-          record[:fqdn] = "#{record.fetch(:fqdn)}."
-        end
+        record[:txtdata] = Record::TXT.unescape(record[:txtdata]) if %w[SPF TXT].include?(type)
+
+        fqdn = record.fetch(:fqdn)
+        record[:fqdn] = "#{fqdn}." unless fqdn.ends_with?('.')
 
-        Record.const_get(record.fetch(:record_type)).new(record)
+        Record.const_get(type).new(record)
       end
     end
   end

data/lib/record_store/provider/google_cloud_dns.rb

@@ -9,7 +9,7 @@ module RecordStore
         deletions = convert_records_to_gcloud_record_sets(zone, changeset.current_records)
         additions = convert_records_to_gcloud_record_sets(zone, changeset.desired_records)
 
-        # The Google API library will handle applying the changeset transactioanlly
+        # The Google API library will handle applying the changeset transactionally
         zone.update(additions, deletions)
       end
 
@@ -98,7 +98,8 @@ module RecordStore
         when 'NS'
           record_params.merge!(nsdname: record.data[0])
         when 'SPF', 'TXT'
-          record_params.merge!(txtdata: record.data[0].gsub(';', '\;'))
+          txtdata = Record::TXT.unquote(record.data[0]).gsub(';', '\;')
+          record_params.merge!(txtdata: txtdata)
         when 'SRV'
           priority, weight, port, target = record.data[0].split(' ')
 

data/lib/record_store/record.rb

@@ -35,7 +35,7 @@ module RecordStore
     end
 
     def type
-      self.class.name.split('::').last
+      self.class.name.demodulize
     end
 
     def ==(other)
@@ -65,8 +65,7 @@ module RecordStore
     end
 
     def to_s
-      rr_type = self.class.name.demodulize
-      "[#{rr_type}Record] #{fqdn} #{ttl} IN #{rr_type} #{rdata_txt}"
+      "[#{type}Record] #{fqdn} #{ttl} IN #{type} #{rdata_txt}"
     end
 
     protected

data/lib/record_store/record/spf.rb

@@ -1,24 +1,8 @@
 module RecordStore
-  class Record::SPF < Record
-    attr_accessor :txtdata
-
-    validates :txtdata, presence: true, length: { maximum: 255 }
-
+  class Record::SPF < Record::TXT
     def initialize(record)
+      STDERR.puts "SPF record type is deprecated (See RFC 7208 Section 14.1)"
       super
-      @txtdata = record.fetch(:txtdata)
-    end
-
-    def to_s
-      "[SPFRecord] #{fqdn} #{ttl} IN SPF \"#{rdata_txt}\""
-    end
-
-    def rdata
-      { txtdata: txtdata }
-    end
-
-    def rdata_txt
-      txtdata
     end
   end
 end

data/lib/record_store/record/txt.rb

@@ -5,21 +5,35 @@ module RecordStore
     validates :txtdata, presence: true, length: { maximum: 255 }
     validate :escaped_semicolons
 
+    class << self
+      def escape(value)
+        value.gsub('"', '\"')
+      end
+
+      def quote(value)
+        %("#{escape(value)}")
+      end
+
+      def unescape(value)
+        value.gsub('\"', '"')
+      end
+
+      def unquote(value)
+        unescape(value.sub(/\A"(.*)"\z/, '\1'))
+      end
+    end
+
     def initialize(record)
       super
       @txtdata = record.fetch(:txtdata)
     end
 
-    def to_s
-      "[TXTRecord] #{fqdn} #{ttl} IN TXT \"#{rdata_txt}\""
-    end
-
     def rdata
       { txtdata: txtdata }
     end
 
     def rdata_txt
-      txtdata
+      Record::TXT.quote(txtdata)
     end
 
     private

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '5.0.4'.freeze
+  VERSION = '5.0.5'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 5.0.5
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor