dnsign 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85311274d2708899e43aa9ccdbf039c29efe8354
+  data.tar.gz: efd33c67131f96eb5910af36346b8594a4481530
+SHA512:
+  metadata.gz: a5cec85f197d8c2cb29397c948384dbc9de5c12c32c5f9390770ffcb3545750c1dbb84bfae6fe52bfc644631c68286d1be5cd8a9052dfbe618079d56666f684d
+  data.tar.gz: 1c57245b2c64fd5970f3168fdffe7ae2a692372e7f9ff0eea97fbc733f3f61f2730b7202a69c10a476ccc10e5a84f97ea096039c5223fa2be41af76b61468973

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script:
+  - "bundle exec rspec spec"
+notifications:
+  recipients:
+    - veljko@floatingpoint.io
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dnsign.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Veljko Dragsic
+
+MIT License
+
+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,34 @@
+[![Build Status](https://travis-ci.org/vdragsic/dnsign.svg?branch=master)](https://travis-ci.org/vdragsic/dnsign)
+
+# Dnsign
+
+Dnsign is a dynamic DNS updater.
+
+It's a simple command line tool that resolves your public IP address and accordingly updates DNS record on one of the currently supported (Linode, DigitalOcean) DNS services.
+
+## Installation
+
+`gem install dnsign`
+
+## Usage
+
+`dnsign --config /path/to/config.yml`
+
+Example config:
+
+```
+dns_service: 'DigitalOcean' # [DigitalOcean|Linode]
+dns_token: 'your access token from DNS service'
+domain: 'foobar.example.com'
+interval: 300 # refresh interval in seconds, defaults to 5 minutes
+```
+
+It's important that you already have domain on DNS service. Dnsign will periodically check your public IP and try to update or add DNS record to your domain.
+
+For example above to work, there already must be `example.com` domain on DNS service and Dnsign will try to add/update `A` record `foobar` with currently public IP of the host it's running on.
+
+## Adding support for other DNS services
+
+It should be not to hard to add support for the other DNS services.
+
+Just inherit `Dnsign::DnsService` and implement `update_ip`, `retrieve_ip` and optionally initializer methods. For example take a look at one of the existing services.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/dnsign

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'dnsign'
+
+def config
+  @config ||= Dnsign::ConfigLoader.parse_and_load ARGV
+end
+
+def dns_service
+  @dns_service ||= Dnsign::DnsService.create_from_name config[:dns_service], access_token: config[:dns_token]
+rescue Dnsign::Error::UnsupportedDnsService => e
+  puts e
+  exit(1)
+end
+
+loop = Dnsign::ResolveUpdateLoop.new(config[:domain], dns_service, Dnsign::IpResolver.new, config)
+loop.update # don't wait for the first tick
+loop.kickoff

data/config/example.yml

@@ -0,0 +1,4 @@
+dns_service: 'DigitalOcean' # [DigitalOcean|Linode]
+dns_token: 'your access token from DNS service'
+domain: 'foobar.example.com'
+interval: 300 # refresh interval in seconds, defaults to 5 minutes

data/dnsign.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dnsign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dnsign"
+  spec.version       = Dnsign::VERSION
+  spec.authors       = ["Veljko Dragsic"]
+  spec.email         = ["veljko@floatingpoint.io"]
+  spec.summary       = %q{Dynamic DNS updater}
+  spec.description   = "Simple command line tool that resolves your public IP address and accordingly updates DNS record on one of the currently supported (Linode, DigitalOcean) DNS services."
+  spec.homepage      = "http://github.com/vdragsic/dnsign"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "timers", "~> 4.0"
+  spec.add_dependency "droplet_kit", "~> 1.2"
+  spec.add_dependency "linode", "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "vcr", "~> 2.9"
+end

data/lib/dnsign.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'dnsign/version'
+require 'dnsign/error'
+require 'dnsign/dns_service'
+require 'dnsign/dns_services/linode'
+require 'dnsign/dns_services/digital_ocean'
+require 'dnsign/ip_resolver'
+require 'dnsign/config_loader'
+require 'dnsign/resolve_update_loop'
+require 'json'
+require 'yaml'
+require 'net/http'
+
+module Dnsign
+end

data/lib/dnsign/config_loader.rb

@@ -0,0 +1,49 @@
+require 'optparse'
+require 'yaml'
+
+module Dnsign
+  class ConfigLoader
+
+    Config = Struct.new :path
+
+    def initialize
+      @config = Config.new
+    end
+
+    def parse(params)
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: ruby dyndns.rb [options]"
+
+        opts.on("-cCONFIG", "--config=CONFIG", "Path to config file") do |c|
+          @config.path = c
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end
+
+      opt_parser.parse! params
+
+      return @config
+    end
+
+    def load(path)
+      config = YAML.load_file path
+
+      # symbolize keys
+      config.reduce({}) do |acc, (k,v)|
+        acc[k.to_sym] = v
+        acc
+      end
+    end
+
+    def self.parse_and_load(params)
+      loader = self.new
+      config = loader.parse params
+      loader.load config.path
+    end
+
+  end
+end

data/lib/dnsign/dns_service.rb

@@ -0,0 +1,33 @@
+module Dnsign
+  class DnsService
+
+    def initialize(opts={})
+    end
+
+    def update_ip(fqdn, ip)
+      raise NotImplementedError
+    end
+
+    def retrieve_ip(fqdn)
+      raise NotImplementedError
+    end
+
+    def self.create_from_name(service_name, opts={})
+      service_name = service_name.to_sym
+
+      if DnsServices.constants.include? service_name
+        DnsServices.const_get(service_name).new opts
+      else
+        fail Error::UnsupportedDnsService,
+        "DNS Service #{service_name} is not supported, choose among #{DnsServices::Constants}"
+      end
+    end
+
+    protected
+
+    def split_fqdn(fqdn)
+      result = /(.*)\.(.*\..*)/.match fqdn
+      [result[1], result[2]]
+    end
+  end
+end

data/lib/dnsign/dns_services/digital_ocean.rb

@@ -0,0 +1,63 @@
+require 'droplet_kit'
+require 'dnsign/dns_service'
+
+# monkey patch
+require 'vendor/droplet_kit'
+
+module DnsServices
+  class DigitalOcean < Dnsign::DnsService
+
+    def initialize(opts={})
+      @access_token = opts.fetch :access_token
+    end
+
+    def update_ip(fqdn, ip)
+      name, domain = split_fqdn fqdn
+
+      if existing = fetch_record_by_name(domain, name)
+        handle_record_response update_record(existing.id, domain, name, ip)
+      else
+        handle_record_response create_record(domain, name, ip)
+      end
+    end
+
+    def retrieve_ip(fqdn)
+      name, domain = split_fqdn fqdn
+
+      if record = fetch_record_by_name(domain, name)
+        record.data
+      end
+    end
+
+    private
+
+    def client
+      @client ||= DropletKit::Client.new access_token: @access_token
+    end
+
+    def handle_record_response(record)
+      record.data # ip
+    end
+
+    def fetch_record_by_name(domain, record_name)
+      # todo: handle non-existing domains
+
+      client
+        .domain_records
+        .all(for_domain: domain)
+        .select {|r| r.name == record_name}
+        .first
+    end
+
+    def update_record(id, domain, record_name, ip)
+      record = DropletKit::DomainRecord.new(name: record_name, data: ip)
+      client.domain_records.update(record, for_domain: domain, id: id)
+    end
+
+    def create_record(domain, record_name, ip)
+      record = DropletKit::DomainRecord.new(type: 'A', name: record_name, data: ip)
+      client.domain_records.create(record, for_domain: domain)
+    end
+
+  end
+end

data/lib/dnsign/dns_services/linode.rb

@@ -0,0 +1,64 @@
+require 'linode'
+require 'dnsign/dns_service'
+
+module DnsServices
+  class Linode < Dnsign::DnsService
+
+    def initialize(opts={})
+      @access_token = opts.fetch :access_token
+    end
+
+    def update_ip(fqdn, ip)
+      record_name, domain_name = split_fqdn fqdn
+
+      if record = fetch_record(domain_name, record_name)
+        response = update_record(record.domainid, record.resourceid, record_name, ip)
+        handle_record_response response, ip
+      else
+        domain = fetch_domain(domain_name)
+        response = create_record(domain.domainid, record_name, ip)
+        handle_record_response response, ip
+      end
+    end
+
+    def retrieve_ip(fqdn)
+      record_name, domain_name = split_fqdn fqdn
+
+      if record = fetch_record(domain_name, record_name)
+        record.target
+      end
+    end
+
+    private
+
+    def client
+      @client ||= ::Linode.new api_key: @access_token
+    end
+
+    def handle_record_response(response, ip)
+      # Linode API only returns resourceid on success
+      ip if response.resourceid
+    end
+
+    def fetch_domain(domain_name)
+      domain = client.domain.list.select {|d| d.domain == domain_name}.first
+    end
+
+    def fetch_record(domain_name, record_name)
+      domain = fetch_domain domain_name
+      client
+        .domain
+        .resource.list(DomainId: domain.domainid)
+        .select {|r| r.name == record_name}.first
+    end
+
+    def create_record(domain_id, record_name, ip)
+      client.domain.resource.create DomainId: domain_id, Type: 'A', Name: record_name, Target: ip
+    end
+
+    def update_record(domain_id, record_id, record_name, ip)
+      client.domain.resource.update DomainId: domain_id, ResourceId: record_id, Name: record_name, Target: ip
+    end
+
+  end
+end

data/lib/dnsign/error.rb

@@ -0,0 +1,9 @@
+module Dnsign
+  module Error
+
+    class UnsupportedDnsService < StandardError; end
+    class DomainDoesNotExists < StandardError; end
+    class RecordDoesNotExists < StandardError; end
+    class InvalidResponseFromIpResolver < StandardError; end
+  end
+end

data/lib/dnsign/ip_resolver.rb

@@ -0,0 +1,21 @@
+require 'dnsign/ip_resolvers/ip_info_io.rb'
+
+module Dnsign
+  class IpResolver
+
+    def initialize(service=IpResolvers::IpInfoIo, opts={})
+      @resolver = service.new self
+    end
+
+    def resolve
+      @resolver.fetch
+    rescue => e
+      puts "#{e.class}: #{e.message}"
+    end
+
+    def self.resolve(*args)
+      self.new(*args).resolve
+    end
+
+  end
+end

data/lib/dnsign/ip_resolvers/ip_info_io.rb

@@ -0,0 +1,23 @@
+module IpResolvers
+  class IpInfoIo
+
+    def initialize(resolver)
+      @resolver = resolver
+    end
+
+    def fetch
+      uri = URI 'http://ipinfo.io/json'
+
+      res = ::Net::HTTP.get_response uri
+
+      if /2../.match res.code
+        data = JSON.parse res.body
+        data.fetch 'ip'
+      else
+        raise Error::InvalidResponseFromIpResolverService "Invalid response for #{self.class} with code: #{res.code}; body: #{res.body}"
+      end
+
+    end
+
+  end
+end