do-dyndns 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6acae6a533a232c1b1a6669a654a720a888ec149ab2caee17c08db14e81e5a11
-  data.tar.gz: '09b944f01f9b9aefbadfabb50c23c71a31981cee7817eb9117153d95ead2bd74'
+  metadata.gz: 2ec2df7936a50a97b7b9d57b1f25e93c4ba2009bd33935ffa5b8d2cd64b180db
+  data.tar.gz: 4e1808967f7082420bc107301839e8d761568bdf8c79e8370c6f3725ff862e1e
 SHA512:
-  metadata.gz: db766ce0f59398b1834bf0e7f199730371aef8d0d41c64f1f912c07831bf4ddd25a2a3bf594a9c4233cc4f4697293138c493efc91c69f8983d65a39314f789d2
-  data.tar.gz: dacd17e32bce6057f759d0a4655aa0dd59da5110dbc6e26df48e3512f1ce9a12a2824002ca4d28f3b9ed974f97d1ca0ec1d9d61735e96426e2286312c1265d4d
+  metadata.gz: d5f6e904affc8d598b9ab6f1c6bd310f08aa127c918b6ec77ddfb2f0cbe32bf537c44a6396c650652b48673ecda54a764f04918ce0bf9d9cf40c43626c8a71a8
+  data.tar.gz: 15c243d17f0afedb3a018c1ccf01663cba6c74685df55cdbdcfaf4a574a51c2f4d27a39bdaab4e5d6ff797c84e55a54da6eb400059b7345e0823fed21a12a873

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/{dyndns → do_dyndns}

@@ -6,22 +6,23 @@ 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
+  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/lib/do_dyndns.rb

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

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

@@ -1,4 +1,4 @@
-module Dyndns
+module DoDyndns
   class Updater
     require 'droplet_kit'
 
@@ -8,7 +8,7 @@ module Dyndns
       @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
@@ -73,6 +73,7 @@ module Dyndns
 
     private
 
+    # Try all the commands until one of them works
     def resolve(commands)
       _ip = nil
       commands.each do |service|

data/lib/do_dyndns/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: do-dyndns
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex Clink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,77 +16,77 @@ 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'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: droplet_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.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
+- lib/do_dyndns.rb
+- lib/do_dyndns/updater.rb
+- lib/do_dyndns/version.rb
 homepage: http://alexclink.com/gems/dyndns
 licenses:
-- UNLICENSED
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Automatically update DNS records on DigitalOcean

data/lib/dyndns.rb

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

data/lib/dyndns/version.rb

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