do-dyndns 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6acae6a533a232c1b1a6669a654a720a888ec149ab2caee17c08db14e81e5a11
-  data.tar.gz: '09b944f01f9b9aefbadfabb50c23c71a31981cee7817eb9117153d95ead2bd74'
+  metadata.gz: a45320eb7b5dd1d027f5c12daa59498f6e861ca38005b6fc80ec559106ba0f43
+  data.tar.gz: cc4f5886a47dd1f86c5f6cd297d2c90a1b785b8066b4868ca6f5344e2d40ed29
 SHA512:
-  metadata.gz: db766ce0f59398b1834bf0e7f199730371aef8d0d41c64f1f912c07831bf4ddd25a2a3bf594a9c4233cc4f4697293138c493efc91c69f8983d65a39314f789d2
-  data.tar.gz: dacd17e32bce6057f759d0a4655aa0dd59da5110dbc6e26df48e3512f1ce9a12a2824002ca4d28f3b9ed974f97d1ca0ec1d9d61735e96426e2286312c1265d4d
+  metadata.gz: 489d3253a1c6ed719158254bd2a246f6f63a0a79a6ed62f8908d470731825793954656b5603613a8e8e148a60c59f8bac077466185a41888b214cccac6c9108f
+  data.tar.gz: 727165fd149526b1dd4cc6edd28b896361755046a34188331cde0a4a92c19d0af67903bbcd5e4a54dcd3235703e7fd9f71028ed1b5ea2801115eb911592047c3

data/README.md

@@ -1,16 +1,44 @@
 # DO-Dyndns
 
-Automatically update DNS records on DigitalOcean
+Automatically update DNS records on DigitalOcean to the current IP of the machine running the script.
 
 Finds the wan IPv4 address of the server it's running on and
 updates the corresponding DNS records on digital ocean.
 
+This is useful if you don't have a static ip from your ISP.
+
 ## Installation
 `$ gem install do-dyndns`
 
-## Configuration
+## Gemfile
+
+`gem 'do-dyndns', '~> 0.3.0'`
+
+`require 'do_dydns'`
+
+## Usage
+
+```ruby
+require 'do_dyndns'
+
+updater = DoDyndns::Updater.new(
+  token: '...',
+  domains: {
+    'example.com' => [
+      'subdomain'
+    ]
+  },
+  logger: Logger.new($stdout)
+)
+
+updater.update_ips # Updates 'subdomain.example.com' to your current IPv4 address
+```
+
+## CLI Configuration
+When runninng `do_dyndns`, the updater reads a configuration file:
+
 Configuration is located at:
-`~/.config/dyndns.yml`
+`~/.config/do-dyndns.yml`
 
 if no config file is found, do-dyndns will create one and open it with your `$EDITOR`
 
@@ -21,19 +49,50 @@ if no config file is found, do-dyndns will create one and open it with your `$ED
     - example-subdomain1
 ```
 
-## Usage
+## CLI Usage
 ```
-$ dyndns 
+$ do-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
+Following are examples on how to run this script periodically to update your VPS with the machine's current IP
 
 ### Cron:
 Check every 15 minutes:
 
 ```
-*/15 * * * * dyndns
+*/15 * * * * /path/to/do-dyndns
+```
+
+
+### Launchctl
+Check every 15 minutes:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>Label</key>
+    <string>com.pixelfaucet.do-dyndns</string>
+
+    <key>WorkingDirectory</key>
+    <string>~/</string>
+
+    <key>UserName</key>
+    <string>nobody</string>
+
+    <key>ProgramArguments</key>
+    <array>
+      <string>~/.rvm/wrappers/ruby-2.6.5@do-dyndns</string>
+      <string>do-dyndns</string>
+    </array>
+
+    <key>StartInterval</key>
+    <integer>900</integer>
+  </dict>
+</plist>
 ```

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "dyndns"
+require "do_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.

data/bin/{dyndns → do_dyndns}

@@ -6,22 +6,37 @@ require 'yaml'
 require 'fileutils'
 require 'logger'
 require 'shellwords'
-require 'dyndns'
+require 'do_dyndns'
 
 LOG = Logger.new($stdout)
 
 rpath = File.expand_path(File.dirname(__FILE__))
 Dir.chdir rpath
 
-config_path = File.expand_path "~/.config/dyndns.yml"
+config_path = File.expand_path "~/.config/do-dyndns.yml"
 
 if File.exist? config_path
   config = YAML.load_file config_path
-  Dyndns::Updater.new(**config, logger: LOG).update_ips
+
+  key_missing = false
+  %i[token domains ipv4_commands ipv6_commands].each do |key|
+    unless config.key?(key)
+      key_missing = true
+      $stderr.puts "missing configuration: `:#{key}`"
+    end
+  end
+
+  if key_missing
+    $stderr.puts "\nExample configuration:\n\n```yml\n#{File.read("../config.example.yml")}\n```"
+    exit 1
+  end
+
+  DoDyndns::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)}"
+  LOG.info "Config created."
 end

data/config.example.yml

@@ -1,4 +1,13 @@
 :token: your_digital_ocean_token_here
+
 :domains:
   example-domain1.com:
     - example-subdomain1
+
+:ipv4_commands:
+  - "dig -4 @ns1-1.akamaitech.net ANY whoami.akamai.net +short"
+  - "dig -4 @ns1.google.com ANY o-o.myaddr.l.google.com +short"
+
+:ipv6_commands:
+  - "dig -6 @resolver1.opendns.com ANY myip.opendns.com +short"
+  - "dig -6 @ns1.google.com ANY o-o.myaddr.l.google.com +short"

data/lib/{dyndns → do_dyndns}/updater.rb

@@ -1,14 +1,19 @@
-module Dyndns
+module DoDyndns
   class Updater
     require 'droplet_kit'
 
-    def initialize(token:, domains:, logger: Logger.new($stdout))
+    IPV4_RE = /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/m
+    IPV6_RE = /(?:\:{,2}[A-Z\d]{1,4}\:{,2}){1,8}/im
+
+    def initialize(token:, domains:, ipv4_commands:, ipv6_commands:, logger: Logger.new($stdout))
       @logger = logger
       @domains = domains
+      @ipv4_commands = ipv4_commands
+      @ipv6_commands = ipv6_commands
       @api = DropletKit::Client.new(access_token: token)
     end
 
-    # Get the domains from DO's API and selecto only ones specified in the config
+    # Get the domains from DO's API and select only ones specified in the config
     def domains
       @api.domains
         .all
@@ -57,29 +62,24 @@ module Dyndns
     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"
-      ])
+      resolve(@ipv4_commands, regex: IPV4_RE)
     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"
-      ])
+      resolve(@ipv6_commands, regex: IPV6_RE)
     end
 
     private
 
-    def resolve(commands)
+    # Try all the commands until one of them works
+    def resolve(commands, regex:)
       _ip = nil
-      commands.each do |service|
-        _ip = `#{service}`.chomp.gsub(/[^a-z0-9\:\.]/i, '')
-        _ip = _ip and break unless _ip.empty?
+      commands.each do |command|
+        result = `#{command}`
+        _ip = result[regex]
+        break if _ip
       end
-      _ip.empty? ? nil : _ip
+      _ip
     end
   end
-end
+end

data/lib/do_dyndns/version.rb

@@ -0,0 +1,3 @@
+module DoDyndns
+  VERSION = "0.4.0"
+end

data/lib/do_dyndns.rb

@@ -0,0 +1,5 @@
+require "do_dyndns/version"
+require "do_dyndns/updater"
+
+module DoDyndns
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: do-dyndns
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alex Clink
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,79 +16,79 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: droplet_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.18.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
+- do_dyndns
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - bin/console
-- bin/dyndns
+- bin/do_dyndns
 - bin/setup
 - config.example.yml
-- lib/dyndns.rb
-- lib/dyndns/updater.rb
-- lib/dyndns/version.rb
-homepage: http://alexclink.com/gems/dyndns
+- lib/do_dyndns.rb
+- lib/do_dyndns/updater.rb
+- lib/do_dyndns/version.rb
+homepage: https://github.com/SleepingInsomniac/dyndns
 licenses:
-- UNLICENSED
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Automatically update DNS records on DigitalOcean
 test_files: []

data/lib/dyndns/version.rb

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

data/lib/dyndns.rb

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