dnsync 1.0.0

data/Gemfile

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rake'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2014 Eric Lindvall
+
+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,180 @@
+# Dnsync
+
+Dnsync provides a simple way to replicate records from DNSimple to NSONE
+(because DNSimple does not yet support AXFR for zone transfer). For a domain
+owner, using two different DNS networks is much better DDoS protection than
+relying on any single one.
+
+
+## Installation
+
+    $ gem install dnsync
+
+or to install a prerelease, add to your `Gemfile`:
+
+    gem 'dnsync', :git => 'git://github.com/papertrail/dnsync.git'
+
+and use:
+
+    $ bundle exec dnsync
+
+## Using
+
+Dnsync can be used to either do one-time synchronization or run in the
+foreground forever, synchronizing every 10 seconds.
+
+
+### Doing a one-time synchronization
+
+To do a one-time synchronization:
+
+    $ dnsync <options> sync
+
+
+### Monitoring a DNSimple zone for changes
+
+To monitor a DNSimple domain for changes and automatically propagate the
+changes to NSONE:
+
+    $ dnsync <options> monitor
+
+
+## Configuration
+
+Configuration and authentication can be provided either by command line
+arguments, environment variables, or environment variable files.
+
+Environment variable files are files that contain a list of enviroment variable
+name value pairs, like:
+
+```
+DNSYNC_DNSIMPLE_EMAIL=user@email.com
+DNSYNC_DNSIMPLE_TOKEN=xxxxxxxxxx
+```
+
+The files are looked for in:
+
+* `$HOME/dnsync.env`
+* `<dnsync-code-root>/.env`
+* `$PWD/.env`
+
+
+### General options
+
+To specify the domain to synchronize, the command line argument is:
+
+```
+        --domain=DOMAIN              Domain to synchronize
+```
+
+Alternatively, the environment variable `DNSYNC_DOMAIN` can be used.
+
+### Monitor options
+
+The `monitor` command has a few options to help configure how it behaves:
+
+```
+        --monitor-frequency=FREQUENCY
+                                     Frequency to check DNSimple for updates
+        --status-port=PORT           Port to run status HTTP server on
+
+```
+
+These arguments can also be specified as environment variables:
+`DNSYNC_MONITOR_FREQUENCY` and `DNSYNC_STATUS_PORT`.
+
+
+### DNSimple
+
+To authenticate against DNSimple, the command line arguments are:
+
+```
+        --dnsimple-email=EMAIL       DNSimple email address
+        --dnsimple-token=TOKEN       DNSimple token
+```
+
+Alternately, the environment variables `DNSYNC_DNSIMPLE_EMAIL` and
+`DNSYNC_DNSIMPLE_TOKEN` can be used.
+
+### NSONE
+
+To authenticate against NSONE, the command line arguments are:
+
+```
+        --nsone-token=TOKEN          NSONE token
+```
+
+Alternatively, the environment variable `DNSYNC_NSONE_TOKEN` is used.
+
+
+## Running on Heroku
+
+Heroku provides a simple place to run synchronization. The process for 
+getting a synchronizer up and running is:
+
+### 1. Create a new directory for the heroku app:
+
+    $ mkdir dns-synchronizer
+    $ cd dns-synchronizer
+    $ git init
+    $ touch .gitignore
+    $ git add .gitignore
+    $ git commit -m 'Initial commit'
+
+### 2. Create a basic ruby project:
+
+    $ bundle init
+    $ echo "gem 'dnsync', :git => 'git://github.com/papertrail/dnsync.git'" >> Gemfile
+    $ bundle
+
+### 3. Create a `Procfile` to run the worker:
+
+    $ echo 'web: bundle exec dnsync --status-port=$PORT monitor' >> Procfile
+
+### 4. Commit the changes:
+
+    $ git add Gemfile Gemfile.lock Procfile
+    $ git commit -m 'Setting up dnsync'
+
+### 5. Create a heroku app:
+
+    $ heroku apps:create
+
+### 6. Deploy to heroku:
+
+    $ git push heroku master
+
+### 7. Set configuration variables:
+
+    $ heroku config:set DNSYNC_DNSIMPLE_EMAIL=user@domain.com DNSYNC_DNSIMPLE_TOKEN=xxxx \
+        DNSYNC_NSONE_TOKEN=xxxx DNSYNC_DOMAIN=domain.com
+
+### 8. Setting up monitoring
+
+Now that the service is running and synchronizing, it would be wise to
+monitor of the service.
+
+As always, it's good to keep an eye on your logs, so use `heroku logs -t` or
+[send the logs](http://help.papertrailapp.com/kb/hosting-services/heroku/) to
+[Papertrail](https://papertrailapp.com/).
+
+To ensure that the synchronization is working properly, poll the status URL
+with your favorite website monitor.
+
+Poll `https://<your-app>.herokuapp.com/status` for a 200 response code.
+
+If it responds with a non-200 error code, it will return the reason for the
+monitoring failure.
+
+
+## Debugging
+
+### Getting a zone dump
+
+To get a zone dump from DNSimple:
+
+    $ dnsync --domain=domain.com dump dnsimple
+
+To get a zone dump from NSONE:
+
+    $ dnsync --domain=domain.com dump nsone

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+# desc "Generate RCov test coverage and open in your browser"
+# task :coverage do
+#   require 'rcov'
+#   sh "rm -fr coverage"
+#   sh "rcov test/test_*.rb"
+#   sh "open coverage/index.html"
+# end
+
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "#{name} #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/dnsync

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'dnsync'
+require 'dnsync/cli'
+
+Dnsync::Cli.new(ARGV).call

data/dnsync.gemspec

@@ -0,0 +1,88 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'dnsync'
+  s.version           = '1.0.0'
+  s.date              = '2014-12-30'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "DNS Synchronizer"
+  s.description = "DNS Synchronizer between DNSimple and NSONE"
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Eric Lindvall"]
+  s.email    = 'eric@papertrailapp.com'
+  s.homepage = 'https://github.com/papertrail/dnsync'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ["dnsync"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('faraday')
+  s.add_dependency('faraday_middleware')
+  s.add_dependency('configlet')
+  s.add_dependency('activesupport')
+  s.add_dependency('scrolls')
+  s.add_dependency('atomic')
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('minitest')
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    bin/dnsync
+    dnsync.gemspec
+    lib/dnsync.rb
+    lib/dnsync/answer.rb
+    lib/dnsync/cli.rb
+    lib/dnsync/dnsimple.rb
+    lib/dnsync/http_status.rb
+    lib/dnsync/nsone.rb
+    lib/dnsync/record.rb
+    lib/dnsync/record_identifier.rb
+    lib/dnsync/recurring_zone_updater.rb
+    lib/dnsync/zone.rb
+    lib/dnsync/zone_difference.rb
+    lib/dnsync/zone_updater.rb
+    test/record_identifier_test.rb
+    test/record_test.rb
+    test/test_helper.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/.*\.rb/ }
+end

data/lib/dnsync/answer.rb

@@ -0,0 +1,28 @@
+module Dnsync
+  class Answer
+    include Comparable
+
+    attr_reader :content, :priority
+    
+    def initialize(content, priority = nil)
+      unless content.present?
+        raise ArgumentError, 'content must be provided'
+      end
+
+      @content  = content
+      @priority = priority
+
+      freeze
+    end
+    
+    def <=>(other)
+      [ content, priority ] <=> [ other.content, other.priority ]
+    end
+    
+    def hash
+      [ content, priority ].hash
+    end
+
+    alias_method :eql?, :==
+  end
+end

data/lib/dnsync/cli.rb

@@ -0,0 +1,207 @@
+require 'optparse'
+require 'configlet'
+require 'pp'
+require 'scrolls'
+
+require 'dnsync/dnsimple'
+require 'dnsync/nsone'
+require 'dnsync/zone_difference'
+require 'dnsync/zone_updater'
+require 'dnsync/recurring_zone_updater'
+require 'dnsync/http_status'
+
+module Dnsync
+  class Cli
+    attr_reader :program_name
+
+    def initialize(argv)
+      @args         = argv.dup
+      @program_name = File.basename($0)
+    end
+    
+    def call
+      Configlet.prefix = 'dnsync'
+      Configlet.munge(:noop) { |v| v == "true" }
+      Configlet.munge(:monitor_frequency) { |v| v.present? ? v.to_i : v }
+
+      read_env_from_file(File.expand_path("~/.dnsync.env"))
+      read_env_from_file(File.expand_path("../../../.env", __FILE__))
+      read_env_from_file('.env')
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "usage: #{program_name} [options] <command> [<args>]"
+
+        opts.separator ""
+        opts.separator commands_help
+
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on("--dnsimple-email=EMAIL", "DNSimple email address") do |v|
+          Configlet[:dnsimple_email] = v
+        end
+        opts.on("--dnsimple-token=TOKEN", "DNSimple token") do |v|
+          Configlet[:dnsimple_token] = v
+        end
+        opts.on("--nsone-token=TOKEN", "NSONE token") do |v|
+          Configlet[:nsone_token] = v
+        end
+        opts.on("--domain=DOMAIN", "Domain to synchronize") do |v|
+          Configlet[:domain] = v
+        end
+        opts.on("--monitor-frequency=FREQUENCY", "Frequency to check DNSimple for updates") do |v|
+          Configlet[:monitor_frequency] = v
+        end
+        opts.on("--status-port=PORT", "Port to run status HTTP server on") do |v|
+          Configlet[:status_port] = v
+        end
+        opts.on("--noop", "Don't do any write operations") do |v|
+          Configlet[:noop] = v.to_s
+        end
+        opts.on("-h", "--help", "This help message") do
+          puts opts
+          exit(1)
+        end
+      end
+      @args = opts.order(@args)
+      
+      case command = @args.shift
+      when 'dump'
+        dump
+      when 'diff'
+        diff
+      when 'sync'
+        sync
+      when 'monitor'
+        monitor
+      else
+        puts "#{program_name}: '#{command}' is not a command. see '#{program_name} --help'."
+        exit(1)
+      end
+      
+      exit(0)
+    end
+    
+    def commands_help
+      unindent(<<-EOF)
+        The available commands are:
+             sync         Perform a one-time synchronization from DNSimple to NSONE
+             monitor      Perform continual synchronization from DNSimple to NSONE
+
+      EOF
+    end
+
+    def dump
+      case command = @args.shift
+      when 'nsone'
+        nsone = Nsone.new(Configlet[:nsone_token], Configlet[:domain])
+        records = nsone.zone
+      else
+        dnsimple = Dnsimple.new(Configlet[:dnsimple_email], 
+          Configlet[:dnsimple_token], Configlet[:domain])
+        records = dnsimple.zone
+      end
+      
+      pp records
+    end
+    
+    def diff
+      nsone = Nsone.new(Configlet[:nsone_token], Configlet[:domain])
+      dnsimple = Dnsimple.new(Configlet[:dnsimple_email], 
+        Configlet[:dnsimple_token], Configlet[:domain])
+      
+      diff = ZoneDifference.new(nsone.zone, dnsimple.zone,
+        %w(NS SOA))
+
+      puts " ---- added ---- "
+      pp diff.added
+      
+      puts " ---- removed ---- "
+      pp diff.removed
+      
+      puts " ---- changed ---- "
+      pp diff.changed
+    end
+    
+    def sync
+      nsone = Nsone.new(Configlet[:nsone_token], Configlet[:domain])
+      dnsimple = Dnsimple.new(Configlet[:dnsimple_email],
+        Configlet[:dnsimple_token], Configlet[:domain])
+
+      nsone_zone, dnsimple_zone = nil
+
+      Scrolls.log(:zone => Configlet[:domain], :from => :nsone) do
+        nsone_zone = nsone.zone
+      end
+
+      Scrolls.log(:zone => Configlet[:domain], :from => :dnsimple) do
+        dnsimple_zone = dnsimple.zone
+      end
+
+      diff = ZoneDifference.new(nsone_zone, dnsimple_zone,
+        %w(NS SOA))
+
+      if Configlet[:noop]
+        puts "Would be: Adding: #{diff.added.length} Updating: #{diff.changed.length} Removing: #{diff.removed.length}"
+      else
+        updater = ZoneUpdater.new(diff, nsone)
+
+        Scrolls.log(:zone => Configlet[:domain], :action => :updating, :to => :nsone,
+          :adding => diff.added.length, :updating => diff.changed.length,
+          :removing => diff.removed.length) do
+          updater.call
+        end
+      end
+    end
+
+    def monitor
+      nsone = Nsone.new(Configlet[:nsone_token], Configlet[:domain])
+      dnsimple = Dnsimple.new(Configlet[:dnsimple_email],
+        Configlet[:dnsimple_token], Configlet[:domain])
+
+      updater = RecurringZoneUpdater.new(dnsimple, nsone,
+        Configlet[:monitor_frequency] || 10)
+      updater.start
+
+      if status_port = Configlet[:status_port]
+        puts "Starting status server on #{status_port}"
+        status = HttpStatus.new(status_port, updater)
+        status.start
+      end
+
+      rd, wr = IO.pipe
+      Thread.new do
+        # Wait for a signal
+        rd.read(1)
+        updater.stop
+
+        if status
+          status.stop
+        end
+      end
+
+      %w(QUIT HUP INT TERM).each do |sig|
+        Signal.trap(sig) { wr.write('x') }
+      end
+
+      updater.join
+      if status
+        status.join
+      end
+    end
+
+    private
+    def unindent(string)
+      indentation = string[/\A\s*/]
+      string.strip.gsub(/^#{indentation}/, "") + "\n"
+    end
+
+    def read_env_from_file(filename)
+      if File.exists?(filename)
+        IO.read(filename).split(/\n+/).each do |line|
+          ENV[$1] = $2 if line =~ /^([^#][^=]*)=(.+)$/
+        end
+      end
+    end
+  end
+end