zonesync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 799ab804db56a8f9b6882b1dd64ebdcad5f88310bb25ca6261ab997ecb9934d9
+  data.tar.gz: 3410be337d22be94eaae226aadf34d064f9f66289306023dce0d4d26ecaa31b2
+SHA512:
+  metadata.gz: 06c7e0f79883aaa040aa9d98b61793495adcc48ce565f1072d14cf22c98e81aea2877d4e4917371f72d26d6b952a1f8daed443e71c51d32003464b9b850a61e2
+  data.tar.gz: 1112ee6ef2d185e6d21cea7284035960e71d9dc6b23dc21a8768c08da4b831c1780452fbb1d93e2436ded427c4559b70643a3c7eeca3050a0ee10741090a0fa6

data/.envrc

@@ -0,0 +1,2 @@
+layout ruby
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require debug

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zonesync.gemspec
+gemspec
+
+gem "debug"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Ottaway
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# zonesync
+
+Sync your DNS host with your DNS zone file, making it easy to version your zone file and sync changes.
+
+## Why?
+
+Configuration management is important, and switched-on technical types now agree that "configuration is code". This means that your DNS configuration should be treated with the same degree of respect you would give to any other code you would write.
+
+In order to live up to this standard, there needs to be an easy way to manage your DNS host file in a SCM tool like Git, allowing you to feed it into a continuous integration pipeline. This library enables this very ideal, making DNS management no different to source code management.
+
+## How?
+
+### Install
+
+Add `zonesync` to your Gemfile:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'zonesync'
+```
+
+or run:
+
+`gem install zonesync`
+
+### DNS zone file
+
+The following is an example DNS zone file for `example.com`:
+
+```
+$ORIGIN example.com.
+$TTL 1h
+example.com.  IN  SOA  ns.example.com. username.example.com. (2007120710; 1d; 2h; 4w; 1h)
+example.com.  NS    ns
+example.com.  NS    ns.somewhere.example.
+example.com.  MX    10 mail.example.com.
+@             MX    20 mail2.example.com.
+@             MX    50 mail3
+example.com.  A     192.0.2.1
+              AAAA  2001:db8:10::1
+ns            A     192.0.2.2
+              AAAA  2001:db8:10::2
+www           CNAME example.com.
+wwwtest       CNAME www
+mail          A     192.0.2.3
+mail2         A     192.0.2.4
+mail3         A     192.0.2.5
+```
+
+### DNS Host
+
+We need to tell `zonesync` about our DNS host by building a small YAML file. The structure of this file will depend on your DNS host, so here are some examples:
+
+**Cloudflare**
+
+```
+provider: Cloudflare
+email: <CLOUDFLARE_EMAIL>
+key: <CLOUDFLARE_API_KEY>
+```
+
+**Route 53**
+
+```
+provider: AWS
+aws_access_key_id: <AWS_ACCESS_KEY_ID>
+aws_secret_access_key: <AWS_SECRET_ACCESS_KEY>
+```
+
+### Usage
+
+Assuming your zone file lives in `hostfile.txt` and your DNS provider credentials are configured in `provider.yml`:
+
+```ruby
+require 'zonesync'
+Zonesync.call(zonefile: 'hostfile.txt', credentials: YAML.load('provider.yml'))
+```
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/lib/zonesync/cloudflare.rb

@@ -0,0 +1,64 @@
+require "zonesync/record"
+require "zonesync/http"
+
+module Zonesync
+  class Cloudflare < Provider
+    def read
+      http.get("/export")
+    end
+
+    def remove record
+      id = records.fetch(record)
+      http.delete("/#{id}")
+    end
+
+    def change old_record, new_record
+      id = records.fetch(old_record)
+      http.patch("/#{id}", {
+        name: new_record[:name],
+        type: new_record[:type],
+        ttl: new_record[:ttl],
+        content: new_record[:rdata],
+      })
+    end
+
+    def add record
+      http.post(nil, {
+        name: record[:name],
+        type: record[:type],
+        ttl: record[:ttl],
+        content: record[:rdata],
+      })
+    end
+
+    def records
+      @records ||= begin
+        response = http.get(nil)
+        response["result"].reduce({}) do |map, attrs|
+          map.merge attrs["id"] => Record.new(
+            attrs["name"],
+            attrs["type"],
+            attrs["ttl"].to_i,
+            attrs["content"],
+          ).to_h
+        end.invert
+      end
+    end
+
+    private
+
+    def http
+      return @http if @http
+      @http = HTTP.new("https://api.cloudflare.com/client/v4/zones/#{credentials[:zone_id]}/dns_records")
+      @http.before_request do |request|
+        request["Content-Type"] = "application/json"
+        request["X-Auth-Email"] = credentials[:email]
+        request["X-Auth-Key"] = credentials[:key]
+      end
+      @http.after_response do |response|
+      end
+      @http
+    end
+  end
+end
+

data/lib/zonesync/diff.rb

@@ -0,0 +1,24 @@
+require "diff/lcs"
+
+module Zonesync
+  class Diff < Struct.new(:from, :to)
+    def self.call(from:, to:)
+      new(from, to).call
+    end
+
+    def call
+      changes = ::Diff::LCS.sdiff(from.diffable_records, to.diffable_records)
+      changes.map do |change|
+        case change.action
+        when "-"
+          [:remove, change.old_element.to_h]
+        when "!"
+          [:change, [change.old_element.to_h, change.new_element.to_h]]
+        when "+"
+          [:add, change.new_element.to_h]
+        end
+      end.compact
+    end
+  end
+end
+

data/lib/zonesync/http.rb

@@ -0,0 +1,50 @@
+require "net/http"
+
+module Zonesync
+  class HTTP < Struct.new(:base)
+    def get path
+      request("get", path)
+    end
+
+    def post path, body
+      request("post", path, body)
+    end
+
+    def patch path, body
+      request("patch", path, body)
+    end
+
+    def delete path
+      request("delete", path)
+    end
+
+    def before_request &block
+      @before_request = block
+    end
+
+    def after_response &block
+      @after_response = block
+    end
+
+    def request method, path, body=nil
+      uri = URI.parse("#{base}#{path}")
+      request = Net::HTTP.const_get(method.to_s.capitalize).new(uri.path)
+
+      @before_request.call(request) if @before_request
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        body = JSON.dump(body) if request["Content-Type"].include?("application/json")
+        http.request(request, body)
+      end
+
+      @after_response.call(response) if @after_response
+
+      raise response.body unless response.code =~ /^20.$/
+      if response["Content-Type"].include?("application/json")
+        JSON.parse(response.body)
+      else
+        response.body
+      end
+    end
+  end
+end

data/lib/zonesync/provider.rb

@@ -0,0 +1,64 @@
+require "dns/zonefile"
+require "zonesync/record"
+
+module Zonesync
+  class Provider < Struct.new(:credentials)
+    def self.from credentials
+      Zonesync.const_get(credentials[:provider]).new(credentials)
+    end
+
+    def diffable_records
+      DNS::Zonefile.load(read).records.map do |record|
+        rdata = case record
+        when DNS::Zonefile::A, DNS::Zonefile::AAAA
+          record.address
+        when DNS::Zonefile::CNAME
+          record.domainname
+        when DNS::Zonefile::MX
+          record.domainname
+        when DNS::Zonefile::TXT
+          record.data
+        else
+          next
+        end
+        Record.new(
+          record.host,
+          record.class.name.split("::").last,
+          record.ttl,
+          rdata,
+        )
+      end.compact
+    end
+
+    def read record
+      raise NotImplementedError
+    end
+
+    def remove record
+      raise NotImplementedError
+    end
+
+    def change old_record, new_record
+      raise NotImplementedError
+    end
+
+    def add record
+      raise NotImplementedError
+    end
+  end
+
+  require "zonesync/cloudflare"
+
+  class Memory < Provider
+    def read
+      credentials[:string]
+    end
+  end
+
+  class Filesystem < Provider
+    def read
+      File.read(credentials[:path])
+    end
+  end
+end
+

data/lib/zonesync/record.rb

@@ -0,0 +1,5 @@
+module Zonesync
+  class Record < Struct.new(:name, :type, :ttl, :rdata)
+  end
+end
+

data/lib/zonesync/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Zonesync
+  VERSION = "0.1.0"
+end

data/lib/zonesync.rb

@@ -0,0 +1,18 @@
+require "zonesync/provider"
+require "zonesync/diff"
+
+module Zonesync
+  def self.call zonefile:, credentials:
+    Sync.new(zonefile, credentials).call
+  end
+
+  class Sync < Struct.new(:zonefile, :credentials)
+    def call
+      local = Provider.from({ provider: "Filesystem", path: zonefile })
+      remote = Provider.from(credentials)
+      operations = Diff.call(from: remote, to: local)
+      operations.each { |method, args| puts [method, *args].inspect }
+    end
+  end
+end
+

data/zonesync.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/zonesync/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zonesync"
+  spec.version       = Zonesync::VERSION
+  spec.authors       = ["Micah Geisel", "James Ottaway"]
+  spec.email         = ["micah@botandrose.com", "git@james.ottaway.io"]
+
+  spec.summary       = %q{Sync your Zone file with your DNS host}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/botandrose/zonesync"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dns-zonefile", "~>1.0"
+  spec.add_dependency "diff-lcs", "~>1.4"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: zonesync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Micah Geisel
+- James Ottaway
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dns-zonefile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Sync your Zone file with your DNS host
+email:
+- micah@botandrose.com
+- git@james.ottaway.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zonesync.rb
+- lib/zonesync/cloudflare.rb
+- lib/zonesync/diff.rb
+- lib/zonesync/http.rb
+- lib/zonesync/provider.rb
+- lib/zonesync/record.rb
+- lib/zonesync/version.rb
+- zonesync.gemspec
+homepage: https://github.com/botandrose/zonesync
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/botandrose/zonesync
+  source_code_uri: https://github.com/botandrose/zonesync
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.1
+signing_key: 
+specification_version: 4
+summary: Sync your Zone file with your DNS host
+test_files: []