do-dyndns 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6acae6a533a232c1b1a6669a654a720a888ec149ab2caee17c08db14e81e5a11
+  data.tar.gz: '09b944f01f9b9aefbadfabb50c23c71a31981cee7817eb9117153d95ead2bd74'
+SHA512:
+  metadata.gz: db766ce0f59398b1834bf0e7f199730371aef8d0d41c64f1f912c07831bf4ddd25a2a3bf594a9c4233cc4f4697293138c493efc91c69f8983d65a39314f789d2
+  data.tar.gz: dacd17e32bce6057f759d0a4655aa0dd59da5110dbc6e26df48e3512f1ce9a12a2824002ca4d28f3b9ed974f97d1ca0ec1d9d61735e96426e2286312c1265d4d

data/README.md

@@ -0,0 +1,39 @@
+# DO-Dyndns
+
+Automatically update DNS records on DigitalOcean
+
+Finds the wan IPv4 address of the server it's running on and
+updates the corresponding DNS records on digital ocean.
+
+## Installation
+`$ gem install do-dyndns`
+
+## Configuration
+Configuration is located at:
+`~/.config/dyndns.yml`
+
+if no config file is found, do-dyndns will create one and open it with your `$EDITOR`
+
+```yaml
+:token: your_digital_ocean_token_here
+:domains:
+  example-domain1.com:
+    - example-subdomain1
+```
+
+## Usage
+```
+$ dyndns 
+I, [2019-03-26T14:39:20.643564 #11387]  INFO -- : Started IP check
+I, [2019-03-26T14:39:20.720905 #11387]  INFO -- : Current WAN IP: **.**.**.**
+I, [2019-03-26T14:39:21.977426 #11387]  INFO -- : IPs Match for ***.***.***
+```
+
+## Automation
+
+### Cron:
+Check every 15 minutes:
+
+```
+*/15 * * * * dyndns
+```

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dyndns"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/dyndns

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+lib = File.expand_path(File.join(__dir__, '..', 'lib'))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'yaml'
+require 'fileutils'
+require 'logger'
+require 'shellwords'
+require 'dyndns'
+
+LOG = Logger.new($stdout)
+
+rpath = File.expand_path(File.dirname(__FILE__))
+Dir.chdir rpath
+
+config_path = File.expand_path "~/.config/dyndns.yml"
+
+if File.exist? config_path
+  config = YAML.load_file config_path
+  Dyndns::Updater.new(**config, logger: LOG).update_ips
+else
+  LOG.warn "No configuration exists @ #{config_path}: Creating file."
+  FileUtils.mkdir_p File.dirname(config_path)
+  FileUtils.cp("../config.example.yml", config_path)
+  editor = ENV['EDITOR'] || 'nano'
+  system "#{editor} #{Shellwords.shellescape(config_path)}"
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.example.yml

@@ -0,0 +1,4 @@
+:token: your_digital_ocean_token_here
+:domains:
+  example-domain1.com:
+    - example-subdomain1

data/lib/dyndns.rb

@@ -0,0 +1,5 @@
+require "dyndns/version"
+require "dyndns/updater"
+
+module Dyndns
+end

data/lib/dyndns/updater.rb

@@ -0,0 +1,85 @@
+module Dyndns
+  class Updater
+    require 'droplet_kit'
+
+    def initialize(token:, domains:, logger: Logger.new($stdout))
+      @logger = logger
+      @domains = domains
+      @api = DropletKit::Client.new(access_token: token)
+    end
+
+    # Get the domains from DO's API and selecto only ones specified in the config
+    def domains
+      @api.domains
+        .all
+        .select{ |d| @domains.keys.include? d.name }
+    end
+
+    # Get the config specified sub domains for a domain
+    # - param {DropletKit::Domain} domain - The domain object
+    def sub_domains_for(domain)
+      @api.domain_records
+        .all(for_domain: domain.name)
+        .select{ |r| r.type == "A" && @domains[domain.name].include?(r.name) }
+    end
+
+    # Check if a record ip differs from your current ip
+    # - param {DropletKit::DomainRecord} record - A domain record
+    def ip_changed?(record)
+      raise "Cannot determine WAN IPv4" unless _ip = wan_ipv4
+      record.data != _ip
+    end
+
+    # Calls update on all configured domain's subdomains
+    def update_ips
+      @logger.info "Started IP check"
+      @logger.info "Current WAN IP: #{wan_ipv4}"
+
+      domains.each do |domain|
+        sub_domains_for(domain).each do |record|
+          if ip_changed?(record)
+            @logger.info "IPs Differ for #{record.name}.#{domain.name}"
+            update(domain, record)
+          else
+            @logger.info "IPs Match for #{record.name}.#{domain.name}"
+          end
+        end
+      end
+    end
+
+    # Update the associated domain with the current WAN IPv4 address
+    # - param {DropletKit::Domain} domain - The domain object
+    # - param {DropletKit::DomainRecord} record - A domain record
+    def update(domain, record)
+      @logger.info "Updating record #{record.name}.#{domain.name} from #{record.data} to #{wan_ipv4}"
+      record.data = wan_ipv4
+      @api.domain_records.update(record, for_domain: domain.name, id: record.id)
+    end
+
+    def wan_ipv4
+      resolve([
+        "dig -4 @resolver1.opendns.com ANY myip.opendns.com +short",
+        "dig -4 @ns1-1.akamaitech.net ANY whoami.akamai.net +short",
+        "dig -4 @ns1.google.com ANY o-o.myaddr.l.google.com +short"
+      ])
+    end
+
+    def wan_ipv6
+      resolve([
+        "dig -6 @resolver1.opendns.com ANY myip.opendns.com +short",
+        "dig -6 @ns1.google.com ANY o-o.myaddr.l.google.com +short"
+      ])
+    end
+
+    private
+
+    def resolve(commands)
+      _ip = nil
+      commands.each do |service|
+        _ip = `#{service}`.chomp.gsub(/[^a-z0-9\:\.]/i, '')
+        _ip = _ip and break unless _ip.empty?
+      end
+      _ip.empty? ? nil : _ip
+    end
+  end
+end

data/lib/dyndns/version.rb

@@ -0,0 +1,3 @@
+module Dyndns
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: do-dyndns
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alex Clink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: droplet_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Finds the wan IPv4 address of the server it's running on and
+  updates the corresponding DNS records on digital ocean.
+email:
+- alexclink@gmail.com
+executables:
+- dyndns
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/dyndns
+- bin/setup
+- config.example.yml
+- lib/dyndns.rb
+- lib/dyndns/updater.rb
+- lib/dyndns/version.rb
+homepage: http://alexclink.com/gems/dyndns
+licenses:
+- UNLICENSED
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Automatically update DNS records on DigitalOcean
+test_files: []