record_store 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e96a230fae8c5a5a73e2c51a2097c5b14094f82d
-  data.tar.gz: 55c913c54e64b78454624b0844ebf1e3ca74fa36
+  metadata.gz: b939adb80cff762bc3463596e80a684a8a4accc6
+  data.tar.gz: a97fdd41e9ef24859af390d2004ff3468911b637
 SHA512:
-  metadata.gz: 512431b9f45815ee10a9b8b10228660b944b862a99be5e1ecb42705cab33fd069f8787971881e0a905722ddf20b127c121c091da61af93b93d1ee568b48f66f9
-  data.tar.gz: d0f22e77f0a914a0c3ee11cef077cc8bd1e31eb4ce04acc8e351e01c43cff7218831e9621350ab631bcd9e62f9c943e2b690c1f275242be05479567ca36c5b75
+  metadata.gz: 187c99f674558e6032f722d9bc352acca2385380c981dacae81d1ae1e24b7f4893d6bc4e61e91d1eb1e4ffe028d42fe128c4ec8b7cd15cd2f9c56160085c6c02
+  data.tar.gz: 33e19e66a3d68da1f1af1eb0147dca02e430e769bee89617f199c3684509a2137f9eca5ff52fbf20e007a27c2399524e92ec9b3abf70af3ac05df22998afb34c

data/Gemfile

@@ -8,7 +8,7 @@ gem 'ejson'
 gem 'fog'
 gem 'fog-json'
 gem 'fog-xml'
-gem 'fog-dynect'
+gem 'fog-dynect', '~> 0.1.0'
 
 group :test do
   gem 'mocha'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (2.3.2)
+    CFPropertyList (2.3.3)
     activemodel (4.2.2)
       activesupport (= 4.2.2)
       builder (~> 3.1)
@@ -14,18 +14,17 @@ GEM
     builder (3.2.2)
     coderay (1.1.0)
     ejson (1.0.0)
-    excon (0.45.4)
+    excon (0.52.0)
     fission (0.5.0)
       CFPropertyList (~> 2.2)
-    fog (1.36.0)
-      fog-aliyun (>= 0.1.0)
+    fog (1.33.0)
       fog-atmos
       fog-aws (>= 0.6.0)
       fog-brightbox (~> 0.4)
       fog-core (~> 1.32)
-      fog-dynect (~> 0.0.2)
-      fog-ecloud (~> 0.1)
-      fog-google (<= 0.1.0)
+      fog-dynect
+      fog-ecloud (= 0.1.1)
+      fog-google (>= 0.0.2)
       fog-json
       fog-local
       fog-powerdns (>= 0.1.1)
@@ -39,59 +38,49 @@ GEM
       fog-terremark
       fog-vmfusion
       fog-voxel
-      fog-xenserver
       fog-xml (~> 0.1.1)
       ipaddress (~> 0.5)
       nokogiri (~> 1.5, >= 1.5.11)
-    fog-aliyun (0.1.0)
-      fog-core (~> 1.27)
-      fog-json (~> 1.0)
-      ipaddress (~> 0.8)
-      xml-simple (~> 1.1)
     fog-atmos (0.1.0)
       fog-core
       fog-xml
-    fog-aws (0.7.6)
-      fog-core (~> 1.27)
+    fog-aws (0.11.0)
+      fog-core (~> 1.38)
       fog-json (~> 1.0)
       fog-xml (~> 0.1)
       ipaddress (~> 0.8)
-    fog-brightbox (0.9.0)
+    fog-brightbox (0.11.0)
       fog-core (~> 1.22)
       fog-json
       inflecto (~> 0.0.2)
-    fog-core (1.32.1)
+    fog-core (1.42.0)
       builder
-      excon (~> 0.45)
+      excon (~> 0.49)
       formatador (~> 0.2)
-      mime-types
-      net-scp (~> 1.1)
-      net-ssh (>= 2.1.3)
-    fog-dynect (0.0.2)
+    fog-dynect (0.1.0)
       fog-core
       fog-json
       fog-xml
-    fog-ecloud (0.3.0)
+    fog-ecloud (0.1.1)
       fog-core
       fog-xml
-    fog-google (0.1.0)
+    fog-google (0.4.0)
       fog-core
       fog-json
       fog-xml
     fog-json (1.0.2)
       fog-core (~> 1.0)
       multi_json (~> 1.10)
-    fog-local (0.2.1)
+    fog-local (0.3.0)
       fog-core (~> 1.27)
     fog-powerdns (0.1.1)
       fog-core (~> 1.27)
       fog-json (~> 1.0)
       fog-xml (~> 0.1)
-    fog-profitbricks (0.0.5)
-      fog-core
-      fog-xml
-      nokogiri
-    fog-radosgw (0.0.4)
+    fog-profitbricks (2.0.1)
+      fog-core (~> 1.42)
+      fog-json (~> 1.0)
+    fog-radosgw (0.0.5)
       fog-core (>= 1.21.0)
       fog-json
       fog-xml (>= 0.0.1)
@@ -99,13 +88,13 @@ GEM
       fog-core
       fog-json
       fog-xml
-    fog-sakuracloud (1.4.0)
+    fog-sakuracloud (1.7.5)
       fog-core
       fog-json
     fog-serverlove (0.1.2)
       fog-core
       fog-json
-    fog-softlayer (1.0.2)
+    fog-softlayer (1.1.4)
       fog-core
       fog-json
     fog-storm_on_demand (0.1.1)
@@ -120,30 +109,25 @@ GEM
     fog-voxel (0.1.0)
       fog-core
       fog-xml
-    fog-xenserver (0.2.2)
-      fog-core
-      fog-xml
     fog-xml (0.1.2)
       fog-core
       nokogiri (~> 1.5, >= 1.5.11)
     formatador (0.2.5)
     i18n (0.7.0)
     inflecto (0.0.2)
-    ipaddress (0.8.0)
+    ipaddress (0.8.3)
     json (1.8.3)
     metaclass (0.0.4)
     method_source (0.8.2)
-    mime-types (2.6.1)
-    mini_portile (0.6.2)
+    mini_portile2 (2.1.0)
     minitest (5.9.0)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    multi_json (1.11.2)
-    net-scp (1.2.1)
-      net-ssh (>= 2.6.5)
-    net-ssh (2.9.2)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
+    multi_json (1.12.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -155,7 +139,6 @@ GEM
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     vcr (2.9.3)
-    xml-simple (1.1.5)
 
 PLATFORMS
   ruby
@@ -165,7 +148,7 @@ DEPENDENCIES
   activesupport (~> 4.2)
   ejson
   fog
-  fog-dynect
+  fog-dynect (~> 0.1.0)
   fog-json
   fog-xml
   mocha
@@ -175,4 +158,4 @@ DEPENDENCIES
   vcr
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/README.md

@@ -48,9 +48,11 @@ The permissions required are broken into 2 groups:
 * WRITE: `RecordAdd`, `RecordDelete`, `ZonePublish`, `ZoneDiscardChangeset`, `ZoneFreeze`, `ZoneThaw`, `ZoneAddNode`,
 `ZoneRemoveNode`
 
-All CI validations only require READ permissions; deplyoing requires a user with READ and WRITE permissions.
+All CI validations only require READ permissions; deploying requires a user with READ and WRITE permissions.
 
-For a breakdown of what each permssion allows read through [DynECT's permissions guide](https://help.dyn.com/user-and-group-permissions/).
+In addition, the `AliasService` permission is required to be able to read or write ALIAS records on DynECT.
+
+For a breakdown of what each permission allows read through [DynECT's permissions guide](https://help.dyn.com/user-and-group-permissions/).
 
 ----
 
@@ -145,7 +147,7 @@ end
 
 #### Provider-Specific Records
 
-For provider-specific records (e.g. `ALIAS`), create the record model in `lib/record_store/record` as any other record. In the provider, extend `self.record_types` and append the custom record types to the `Set` returned by `Provider.record_types` (e.g. [`DNSimple.record_types`](https://github.com/Shopify/record_store/blob/1ec0d1410cf8bedf79bc63e8e4cdc7cdb0f1019b/lib/record_store/provider/dnsimple.rb#L5-L7)).
+For provider-specific records (e.g. `ALIAS`), create the record model in `lib/record_store/record` as any other record. In the provider, extend `self.record_types` and append the custom record types to the `Set` returned by `Provider.record_types` (e.g. [`DNSimple.record_types`](https://github.com/Shopify/record_store/blob/368153106068800325b4e579483faa427afe7add/lib/record_store/provider/dnsimple.rb#L6)).
 
 #### Secrets
 

data/dev.yml

@@ -5,6 +5,18 @@ up:
   - ruby: 2.3.1
   - bundler
 
+commands:
+  test:
+    syntax:
+      argument: file
+      optional: args...
+    desc:   'run tests'
+    run: |
+      if [[ $# -eq 0 ]]; then
+        bundle exec rake test
+      else
+        bundle exec ruby -Itest "$@"
+      fi
+
 packages:
   - git@github.com:Shopify/dev-shopify.git
-

data/lib/record_store/provider.rb

@@ -23,6 +23,7 @@ module RecordStore
       Set.new([
         'A',
         'AAAA',
+        'ALIAS',
         'CNAME',
         'MX',
         'NS',
@@ -32,6 +33,10 @@ module RecordStore
       ])
     end
 
+    def self.supports_alias?
+      false
+    end
+
     def initialize(zone:)
       @zone_name = zone
     end

data/lib/record_store/provider/dnsimple.rb

@@ -2,8 +2,8 @@ require 'fog/dnsimple'
 
 module RecordStore
   class Provider::DNSimple < Provider
-    def self.record_types
-      super.add('ALIAS')
+    def self.supports_alias?
+      true
     end
 
     def add(record)
@@ -19,7 +19,7 @@ module RecordStore
 
       if record.type == 'ALIAS'
         txt_alias = retrieve_current_records.detect do |rr|
-          rr.type == 'TXT' && rr.fqdn == record.fqdn && rr.txtdata == "ALIAS for #{record.cname.gsub(/.\z/, '')}"
+          rr.type == 'TXT' && rr.fqdn == record.fqdn && rr.txtdata == "ALIAS for #{record.alias.chomp('.')}"
         end
         remove(txt_alias)
       end
@@ -93,7 +93,7 @@ module RecordStore
       when 'AAAA'
         record.merge!(address: api_record.fetch('content'))
       when 'ALIAS'
-        record.merge!(cname: api_record.fetch('content'))
+        record.merge!(alias: api_record.fetch('content'))
       when 'CNAME'
         record.merge!(cname: api_record.fetch('content'))
       when 'MX'
@@ -124,7 +124,7 @@ module RecordStore
 
     def api_hash(record)
       record_hash = {
-        name: record.fqdn.gsub("#{Record.ensure_ends_with_dot(@zone_name)}", '').gsub(/.\z/, ''),
+        name: record.fqdn.gsub("#{Record.ensure_ends_with_dot(@zone_name)}", '').chomp('.'),
         ttl: record.ttl,
         type: record.type,
       }
@@ -135,18 +135,18 @@ module RecordStore
       when 'AAAA'
         record_hash[:content] = record.address
       when 'ALIAS'
-        record_hash[:content] = record.cname.gsub(/.\z/, '')
+        record_hash[:content] = record.alias.chomp('.')
       when 'CNAME'
-        record_hash[:content] = record.cname.gsub(/.\z/, '')
+        record_hash[:content] = record.cname.chomp('.')
       when 'MX'
         record_hash[:prio] = record.preference
-        record_hash[:content] = record.exchange.gsub(/.\z/, '')
+        record_hash[:content] = record.exchange.chomp('.')
       when 'NS'
-        record_hash[:content] = record.nsdname.gsub(/.\z/, '')
+        record_hash[:content] = record.nsdname.chomp('.')
       when 'SPF'
         record_hash[:content] = record.txtdata
       when 'SRV'
-        record_hash[:content] = "#{record.weight} #{record.port} #{record.target.gsub(/.\z/, '')}"
+        record_hash[:content] = "#{record.weight} #{record.port} #{record.target.chomp('.')}"
         record_hash[:prio] = record.priority
       when 'TXT'
         record_hash[:content] = record.txtdata

data/lib/record_store/record.rb

@@ -18,7 +18,16 @@ module RecordStore
     end
 
     def self.build_from_yaml_definition(yaml_definition)
-      Record.const_get(yaml_definition.fetch(:type)).new(yaml_definition)
+      record_type = yaml_definition.fetch(:type)
+      # TODO: remove backward compatibility support for ALIAS records using cname attribute instead of alias
+      #       REMOVE after merging https://github.com/Shopify/record-store/pull/781
+      case record_type
+      when 'ALIAS'
+        if yaml_definition.key?(:cname)
+          yaml_definition[:alias] = yaml_definition.delete(:cname)
+        end
+      end
+      Record.const_get(record_type).new(yaml_definition)
     end
 
     def log!(logger=STDOUT)

data/lib/record_store/record/alias.rb

@@ -1,20 +1,20 @@
 module RecordStore
   class Record::ALIAS < Record
-    attr_accessor :cname
+    attr_accessor :alias
 
-    validates :cname, 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' }
 
     def initialize(record)
       super
-      @cname = Record.ensure_ends_with_dot(record.fetch(:cname))
+      @alias = Record.ensure_ends_with_dot(record.fetch(:alias))
     end
 
     def rdata
-      { cname: cname }
+      { alias: self.alias }
     end
 
     def to_s
-      "[ALIASRecord] #{fqdn} #{ttl} IN ALIAS #{cname}"
+      "[ALIASRecord] #{fqdn} #{ttl} IN ALIAS #{self.alias}"
     end
   end
 end

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/lib/record_store/zone.rb

@@ -108,10 +108,12 @@ module RecordStore
     validate :validate_records
     validate :validate_config
     validate :validate_all_records_are_unique
-    validate :validate_a_records_for_same_fqdn
     validate :validate_cname_records_for_same_fqdn
     validate :validate_cname_records_dont_point_to_root
+    validate :validate_same_ttl_for_records_sharing_fqdn_and_type
     validate :validate_provider_can_handle_zone_records
+    validate :validate_can_handle_alias_records
+    validate :validate_alias_points_to_root
 
     def self.from_yaml_definition(name, definition)
       new(name, definition.deep_symbolize_keys)
@@ -123,6 +125,7 @@ module RecordStore
       write(name, records: current_records, config: {
         provider: provider_name,
         ignore_patterns: [{type: "NS", fqdn: "#{name}."}],
+        supports_alias: current_records.map(&:type).include?('ALIAS') || nil
       }, **write_options)
     end
 
@@ -155,7 +158,7 @@ module RecordStore
     end
 
     def provider
-      Provider.const_get(config.provider).new(zone: name.gsub(/\.\z/, ''))
+      Provider.const_get(config.provider).new(zone: name.chomp('.'))
     end
 
     def write(**write_options)
@@ -193,11 +196,12 @@ module RecordStore
       end
     end
 
-    def validate_a_records_for_same_fqdn
-      a_records = records.select { |record| record.is_a?(Record::A) }.group_by(&:fqdn)
-      a_records.each do |fqdn, records|
-        if records.map(&:ttl).uniq.size > 1
-          errors.add(:records, "All A records for #{fqdn} should have the same TTL")
+    def validate_same_ttl_for_records_sharing_fqdn_and_type
+      records_sharing_fqdn_and_type = records.group_by { |record| [record.type, record.fqdn] }
+      records_sharing_fqdn_and_type.each do |(type, fqdn), matching_records|
+        all_ttls = matching_records.map(&:ttl).uniq
+        if all_ttls.length > 1
+          errors.add(:records, "All #{type} records for #{fqdn} should have the same TTL")
         end
       end
     end
@@ -245,5 +249,19 @@ module RecordStore
         errors.add(:records, "#{record_type} is a not a supported record type in #{config.provider}")
       end
     end
+
+    def validate_can_handle_alias_records
+      return unless records.any? { |record| record.is_a?(Record::ALIAS) }
+      return if config.supports_alias?
+      errors.add(:records, "#{config.provider} does not support ALIAS records for #{name.chomp('.')} zone")
+    end
+
+    def validate_alias_points_to_root
+      alias_record = records.find { |record| record.is_a?(Record::ALIAS) && record.fqdn != @name }
+
+      return unless alias_record
+
+      errors.add(:records, "ALIAS record should be defined on the root of the zone: #{alias_record}")
+    end
   end
 end

data/lib/record_store/zone/config.rb

@@ -3,13 +3,18 @@ module RecordStore
     class Config
       include ActiveModel::Validations
 
-      attr_reader :ignore_patterns, :provider
+      attr_reader :ignore_patterns, :provider, :supports_alias
 
       validate :validate_zone_config
 
-      def initialize(ignore_patterns: [], provider: nil)
+      def initialize(ignore_patterns: [], provider: nil, supports_alias: nil)
         @ignore_patterns = ignore_patterns
         @provider = provider
+        @supports_alias = supports_alias
+      end
+
+      def supports_alias?
+        @supports_alias.nil? && valid_provider? ? Provider.const_get(provider).supports_alias? : @supports_alias
       end
 
       def to_hash
@@ -22,9 +27,11 @@ module RecordStore
       private
 
       def validate_zone_config
-        unless Provider.constants.include?(provider.to_s.to_sym)
-          errors.add(:provider, 'provider specified does not exist')
-        end
+        errors.add(:provider, 'provider specified does not exist') unless valid_provider?
+      end
+
+      def valid_provider?
+        Provider.constants.include?(provider.to_s.to_sym)
       end
     end
   end

data/record_store.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'fog'
   spec.add_runtime_dependency 'fog-json'
   spec.add_runtime_dependency 'fog-xml'
-  spec.add_runtime_dependency 'fog-dynect'
+  spec.add_runtime_dependency 'fog-dynect', '~> 0.1.0'
   spec.add_runtime_dependency 'ejson'
 
   spec.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -99,16 +99,16 @@ dependencies:
   name: fog-dynect
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: ejson
   requirement: !ruby/object:Gem::Requirement