record_store 5.5.4 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f96ae123926fc5ccc32796348a250ed7c0dda8c03e84bc04f00e03502b0d83b
-  data.tar.gz: 01550ab52e78f3b30cb1512e7406bc471d328ca536e9a80eaeefd622dddd659f
+  metadata.gz: f51b768f45c65d0eee98819d583fb206fe4be73f9a8f5410aeee4c6b6ad5ab64
+  data.tar.gz: 77bc9dc6603c60096c107c9c304fff3a4e23475866d727b7ae235d7943aa6308
 SHA512:
-  metadata.gz: c34de6f849092154933070a7356279e6c790694d6045a70c2792d77fccf4d769ae961a5bdee2fd4cc62d6eeb208d211ca9745f7bb95cb99b0a246aaa586c922b
-  data.tar.gz: f2ef26d2be53ffcec008c5db964d294a43b10a98abd0c31221d8a31731eb99346412b9624c17d3c8c396e91dfea4b04e798faf4e83138ad570480c56e18f3937
+  metadata.gz: 6f9c5c381c14d1509b305c4b2635ced20b701662f99877e5eb42a16ca7efe724a4ad5314d23ce48ef8cdeee6d3bb5912bca0ec7aed6874a7919c2b2d912b422b
+  data.tar.gz: 9ea92388f604ebd39fccaea099f54925ad03f23d7146e698d3fbb19e3f255b8057a872b5b9aca67c25cad4c24064f4f884c0e94624b34984df1f6cc6b2cfca7c

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 # CHANGELOG
+## 5.6.0
+- add OCI provider [FEATURE]
+
+## 5.5.3
+- add NS1 provider [FEATURE]
 
 ## 5.4.3
 - use fog-dynect 0.4.0 to avoid version override [REFACTOR]

data/lib/record_store.rb

@@ -32,6 +32,7 @@ require 'record_store/provider/dynect'
 require 'record_store/provider/dnsimple'
 require 'record_store/provider/google_cloud_dns'
 require 'record_store/provider/ns1'
+require 'record_store/provider/oracle_cloud_dns'
 require 'record_store/cli'
 
 module RecordStore

data/lib/record_store/provider.rb

@@ -21,6 +21,8 @@ module RecordStore
           'GoogleCloudDNS'
         when /\.nsone\.net\z/
           'NS1'
+        when /\.oraclecloud\.net\z/
+          'OracleCloudDNS'
         end
       end
 

data/lib/record_store/provider/oracle_cloud_dns.rb

@@ -0,0 +1,183 @@
+require 'oci'
+
+module RecordStore
+  class Provider::OracleCloudDNS < Provider
+    class Error < StandardError; end
+
+    class << self
+      def client
+        @client ||= begin
+          config = OCI::Config.new
+          config.user = secrets['user']
+          config.fingerprint = secrets['fingerprint']
+          config.key_content = secrets['key_content']
+          config.tenancy = secrets['tenancy']
+          config.region = secrets['region']
+          config.validate
+          OCI::Dns::DnsClient.new(config: config)
+        end
+      end
+
+      # Downloads all the records from the provider.
+      #
+      # Returns: an array of `Record` for each record in the provider's zone
+      def retrieve_current_records(zone:, stdout: $stdout)
+        client.get_zone_records(zone)
+          .flat_map { |response| response.data.items }
+          .flat_map { |api_record| build_from_api(api_record) }
+          .compact
+      rescue OCI::Errors::HttpRequestBasedError
+        stdout.puts "Cannot build record for zone: #{zone}"
+        raise
+      end
+
+      # Returns an array of the zones managed by provider as strings
+      def zones
+        client.list_zones(secrets['compartment_id']).data.map(&:name)
+      end
+
+      private
+
+      # Creates a new record to the zone. It is expected this call modifies external state.
+      #
+      # Arguments:
+      # record - a kind of `Record`
+      def add(record, zone)
+        patch_add_record = [
+          OCI::Dns::Models::RecordOperation.new(
+            domain: record.fqdn,
+            rtype: record.type,
+            ttl: record.ttl,
+            rdata: record.rdata_txt,
+            operation: 'ADD',
+          ),
+        ]
+
+        client.patch_zone_records(
+          zone,
+          OCI::Dns::Models::PatchZoneRecordsDetails.new(items: patch_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, zone)
+        record_fqdn = Record.ensure_ends_without_dot(record.fqdn)
+        found_record = client.get_zone_records(
+          zone,
+          rtype: record.type,
+          domain: record_fqdn,
+        ).data.items.select { |r| r.rdata == record.rdata_txt }
+
+        return unless found_record
+        begin
+          record_hash = found_record.first.record_hash if found_record.length == 1
+        rescue NoMethodError
+          puts "No matching record to remove: #{record_fqdn}, #{record.type}"
+        else
+          patch_remove_record = [
+            OCI::Dns::Models::RecordOperation.new(
+              domain: record_fqdn,
+              record_hash: record_hash,
+              rtype: record.type,
+              ttl: record.ttl,
+              rdata: record.rdata_txt,
+              operation: 'REMOVE',
+            ),
+          ]
+
+          client.patch_zone_records(
+            zone,
+            OCI::Dns::Models::PatchZoneRecordsDetails.new(items: patch_remove_record)
+          )
+        end
+      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, zone)
+        record_fqdn = Record.ensure_ends_without_dot(record.fqdn)
+
+        # Retrieve all records that you want to keep before it's updated because it will overwrite
+        all_records = client.get_zone_records(zone).map(&:data).map(&:items).flatten
+
+        update_zone_record_items = all_records.map do |r|
+          OCI::Dns::Models::RecordDetails.new(
+            domain: r.domain,
+            ttl: r.ttl,
+            rtype: r.rtype,
+            recordHash: r.record_hash,
+            rdata: r.rdata,
+            rrsetVersion: r.rrset_version,
+            isProtected: true,
+          )
+        end
+
+        update_zone_record_items << OCI::Dns::Models::RecordDetails.new(
+          domain: record_fqdn,
+          ttl: record.ttl,
+          rtype: record.type,
+          rdata: record.rdata_txt
+        )
+        update_zone_record_items.delete_if { |r| id == r.record_hash }
+
+        client.update_zone_records(
+          zone,
+          OCI::Dns::Models::UpdateZoneRecordsDetails.new(items: update_zone_record_items),
+        )
+      end
+
+      def secrets
+        super.fetch('oracle_cloud_dns')
+      end
+
+      def build_from_api(api_record)
+        fqdn = Record.ensure_ends_with_dot(api_record.domain)
+
+        record_type = api_record.rtype
+        return if record_type == 'SOA'
+
+        record = {
+          ttl: api_record.ttl,
+          fqdn: fqdn.downcase,
+          record_id: api_record.record_hash,
+        }
+        case record_type
+        when 'A', 'AAAA'
+          record[:address] = api_record.rdata
+        when 'ALIAS'
+          record[:alias] = api_record.rdata
+        when 'CAA'
+          flags, tag, value = api_record.rdata.split
+          record[:flags] = flags.to_i
+          record[:tag] = tag
+          record[:value] = Record.unquote(value)
+        when 'CNAME'
+          record[:cname] = api_record.rdata
+        when 'MX'
+          preference, exchange = api_record.rdata.split
+          record[:preference] = preference.to_i
+          record[:exchange] = exchange
+        when 'NS'
+          record[:nsdname] = api_record.rdata
+        when 'SPF', 'TXT'
+          record[:txtdata] = Record.unquote(api_record.rdata)
+        when 'SRV'
+          priority, weight, port, host = api_record.rdata.split
+          record[:priority] = priority.to_i
+          record[:weight] = weight.to_i
+          record[:port] = port.to_i
+          record[:target] = Record.ensure_ends_with_dot(host)
+        else
+          raise NameError, "Unsupported record type: #{record_type}"
+        end
+        Record.const_get(record_type).new(record)
+      end
+    end
+  end
+end

data/lib/record_store/record.rb

@@ -46,6 +46,10 @@ module RecordStore
         fqdn.end_with?(".") ? fqdn : "#{fqdn}."
       end
 
+      def ensure_ends_without_dot(fqdn)
+        fqdn.sub(/\.$/, '')
+      end
+
       def needs_long_quotes?(value)
         value.length > 255 && value !~ /^((\\)?"((\\"|[^"])){1,255}(\\)?"\s*)+$/
       end

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '5.5.4'.freeze
+  VERSION = '5.6.0'.freeze
 end

data/record_store.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'oci'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 5.5.4
+  version: 5.6.0
 platform: ruby
 authors:
 - Willem van Bergen
@@ -297,6 +297,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Manage DNS through a git-based workflow. If you're looking for the original
   'record_store', that has been renamed to 'sequel_record_store'.
 email:
@@ -331,6 +345,7 @@ files:
 - 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/oracle_cloud_dns.rb
 - lib/record_store/record.rb
 - lib/record_store/record/a.rb
 - lib/record_store/record/aaaa.rb