zonesync 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de0f19d0c0fc5e8ce4abdbf8162e812bc8e9625949c569f8241f1dd3a26b1d59
-  data.tar.gz: ac995b1a37c31ebfcc942d1b7bdf8af61d3ea542b928181d98a5339ae3ed873f
+  metadata.gz: 58c4f6168ca0355c6aa7f0580ede2f8c080b04b44f196a24ecb827b38a3edda8
+  data.tar.gz: 9064bdd19540cc12d5cc48dfd93cbbb4a940c3e4cb4423255a0f66c9b282287a
 SHA512:
-  metadata.gz: 2ae81d95b270a1832003e80fa9b9a239fa84550baef01b2e965ea98c4d9088386cf7bda17c25dc62d91b1bb1d24fb6e743957246b38f927219844185d8eefc89
-  data.tar.gz: a21efe23b40750c68ab57597fca878771fdf1e5738b847d818b56fb4331af83094fb78d5d340f006815c264cd80217239c2a0be59e77295ad22c797838af3657
+  metadata.gz: 3e06ff17f120b42693ca00fd27fcd3c56501bb01abb2b72c9dea149ef8173f3f3f02765767805b03210d6df1a40dee0c84f872d5f07f549ec7ccc95b9d250c6c
+  data.tar.gz: 8ddf71739ae861c356f27162484e9a1f006e841bbe8900471a1c098046db4287efae357df715b78f60154df7d54e03247892726e8156f68ba8400560951c2147

data/README.md

@@ -1,4 +1,6 @@
-# zonesync
+# Zonesync
+
+[![CI Status](https://github.com/botandrose/zonesync/workflows/CI/badge.svg?branch=master)](https://github.com/botandrose/zonesync/actions?query=workflow%3ACI+branch%3Amaster)
 
 Sync your DNS host with your DNS zone file, making it easy to version your zone file and sync changes.
 
@@ -70,6 +72,17 @@ aws_secret_access_key: <AWS_SECRET_ACCESS_KEY>
 
 ### Usage
 
+#### CLI
+
+```
+$ bundle exec zonesync
+```
+```
+$ bundle exec zonesync --dry-run # log to STDOUT but don't actually perform the sync
+```
+
+#### Ruby
+
 Assuming your zone file lives in `hostfile.txt` and your DNS provider credentials are configured in `provider.yml`:
 
 ```ruby

data/exe/zonesync

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative "../lib/zonesync"
+Zonesync::CLI.start ARGV

data/lib/zonesync/cli.rb

@@ -0,0 +1,29 @@
+require "thor"
+
+module Zonesync
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    default_command :sync
+    desc "sync", "syncs the contents of Zonefile to the DNS server configured in Rails.application.credentials.zonesync"
+    method_option :dry_run, type: :boolean, default: false, aliases: :n, desc: "log operations to STDOUT but don't perform the sync"
+    def sync
+      Zonesync.call credentials: default_credentials, dry_run: options[:dry_run]
+    end
+
+    private
+
+    def default_credentials
+      if defined?(Rails.application.credentials)
+        Rails.application.credentials.zonesync
+      else
+        require "active_support/encrypted_configuration"
+        require "active_support/core_ext/hash/keys"
+        credentials = ActiveSupport::EncryptedConfiguration.new(config_path: "config/credentials.yml.enc", key_path: "config/master.key", raise_if_missing_key: true, env_key: "RAILS_MASTER_KEY")
+        credentials.zonesync
+      end
+    end
+  end
+end

data/lib/zonesync/http.rb

@@ -1,4 +1,5 @@
 require "net/http"
+require "json"
 
 module Zonesync
   class HTTP < Struct.new(:base)

data/lib/zonesync/logger.rb

@@ -0,0 +1,25 @@
+require "logger"
+require "fileutils"
+
+class Logger
+  def self.log method, args, dry_run: false
+    loggers = [::Logger.new(STDOUT)]
+
+    if !dry_run
+      FileUtils.mkdir_p("log")
+      loggers << ::Logger.new("log/zonesync.log")
+    end
+
+    loggers.each do |logger|
+      operation = case args
+      when Array
+        args.map { |h| h.values.join(" ") }.join(" -> ")
+      when Hash
+        args.values.join(" ")
+      else
+        raise args.inspect
+      end
+      logger.info "Zonesync: #{method.capitalize} #{operation}"
+    end
+  end
+end

data/lib/zonesync/provider.rb

@@ -8,13 +8,21 @@ module Zonesync
     end
 
     def diffable_records
-      DNS::Zonefile.load(read).records.map do |record|
+      zonefile.records.map do |record|
         Record.from_dns_zonefile_record(record)
       end.select do |record|
         %w[A AAAA CNAME MX TXT SPF NAPTR PTR].include?(record.type)
       end.sort
     end
 
+    private def zonefile
+      body = read
+      if body !~ /\sSOA\s/ # insert dummy SOA to trick parser if needed
+        body.sub!(/\n([^$])/, "\n@ 1 SOA example.com example.com ( 2000010101 1 1 1 1 )\n\\1")
+      end
+      DNS::Zonefile.load(body)
+    end
+
     def read record
       raise NotImplementedError
     end

data/lib/zonesync/version.rb

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

data/lib/zonesync.rb

@@ -1,19 +1,21 @@
 require "zonesync/provider"
 require "zonesync/diff"
+require "zonesync/logger"
+require "zonesync/cli"
 
 module Zonesync
-  def self.call zonefile:, credentials:
-    Sync.new(zonefile, credentials).call
+  def self.call zonefile: "Zonefile", credentials:, dry_run: false
+    Sync.new({ provider: "Filesystem", path: zonefile }, credentials).call(dry_run: dry_run)
   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)
+  class Sync < Struct.new(:source, :destination)
+    def call dry_run: false
+      source = Provider.from(self.source)
+      destination = Provider.from(self.destination)
+      operations = Diff.call(from: destination, to: source)
       operations.each do |method, args|
-        puts [method, args].inspect
-        remote.send(method, args)
+        Logger.log(method, args, dry_run: dry_run)
+        destination.send(method, args) unless dry_run
       end
     end
   end

data/zonesync.gemspec

@@ -29,7 +29,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "dns-zonefile", "~>1.0"
   spec.add_dependency "diff-lcs", "~>1.4"
+  spec.add_dependency "thor", "~>1.0"
 
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "webmock"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zonesync
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Micah Geisel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dns-zonefile
@@ -39,6 +39,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: rake
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -71,7 +99,8 @@ description: Sync your Zone file with your DNS host
 email:
 - micah@botandrose.com
 - git@james.ottaway.io
-executables: []
+executables:
+- zonesync
 extensions: []
 extra_rdoc_files: []
 files:
@@ -81,13 +110,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/zonesync
 - lib/zonesync.rb
+- lib/zonesync/cli.rb
 - lib/zonesync/cloudflare.rb
 - lib/zonesync/diff.rb
 - lib/zonesync/http.rb
+- lib/zonesync/logger.rb
 - lib/zonesync/provider.rb
 - lib/zonesync/record.rb
 - lib/zonesync/version.rb
+- log/.keep
 - zonesync.gemspec
 homepage: https://github.com/botandrose/zonesync
 licenses: