namecheap-dynamic-dns 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a35a8b0426385235c8b42ca47a6f1e1dbf8bcd76
+  data.tar.gz: f671de1c94d191c5e9ff7eb9c87a7206c47afe8f
+SHA512:
+  metadata.gz: 1c8ce77cefa340465eb71616a04631b695292eefac0a684fa3b415df532985a552fdb94225e4616c8dc92527c1f0835f4ae5432e4c7b73e0535235f63a2407c8
+  data.tar.gz: e1f240fb68ed958e199c14fbf52c560f21649d03caac75a5df01b89cbefab9c109abfd8a3529206589831b63a27e10b84f0c31530196cc21c64974a204d5ff3b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea
+/domains.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Saimon Lovell
+
+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,142 @@
+# Namecheap Dynamic Dns
+
+Imagine you want to host your development server from home. So you buy a domain from namecheap and point the sub-domains to your home I.P address. Now the problem is every couple of months or on every power failure (how ever rare they might be) you external I.P ends up changing. Now you have to login to your domain host and change the I.P for all of them.
+
+This gem allows you to automatically easily change the I.P address of the subdomains that are pointing to your home Internet. It does this by checking your external I.P address with each specified subdomains to see if they match. Then if they don't match a call is made to namecheap to change it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'namecheap-dynamic-dns'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install namecheap-dynamic-dns
+
+## Usage
+
+In order to use this gem you must first create a YML file that tells this gem information about what are the domain/s to target and some additional information. You control the run time interval either through ruby script via cronjob or by rails. I recommend at least 5 minutes gap in-between checks. Some DNS takes time to update. 
+
+You will need to have connection to Internet.If you are in highly secure site then the following domains needs to be white listed:  
+* dynamicdns.park-your-domain.com
+* whatismyip.akamai.com
+
+### YML
+
+The file you are about to create can have any name. I named mine `domains.yml`. As long as you specify the file path you should be fine.
+
+Create a YML file with the following:
+
+```yaml
+---
+domains:
+  example.com:
+    password: 74gh9j3eufh86gh39jygh9f8h3f4
+
+    subdomains:
+      home:
+      test:
+        # Subdomain level
+        ip: 1.2.3.4
+
+  foo.com:
+    password: 3fj987jg0wi4u9e84fh0342jghjd
+    # Domain level
+    ip: 2.4.6.8
+
+    subdomains:
+      bar:
+      donkey:
+        ip: aaa.com    
+```
+
+#### Password
+The `password` here you will get from NameCheap when you select a domain and under `Advanced DNS` and enable `DYNAMIC DNS` and you will see `Dynamic DNS Password`.
+
+#### I.P
+I.P can be host name as well. By default if you don't specify any I.P anywhere then the I.P will be the external I.P (wan) of the computer this gem is running from. If you specify an I.P address in domain level then any subdomains that did not specified an I.P address will user the I.P address of the domain. Any I.P you specifies in the subdomain level will only affect that subdomain. One thing to note which is if you are using a host name that uses load balancers then you may get different I.P on every call or every other call.
+
+#### Explanation
+The above settings translates to, example.com has two subdomains. First home.example.com will always have the external I.P address of the machine you are using this gem on. The last subdomain test.example.com will always have the I.P 1.2.3.4
+
+The second part of the settings translates to, foo.com has two subdomains. First subdomain bar.foo.com will always have I.P 2.4.6.8 and the second subdomain donkey.foo.com will always have I.P address of host aaa.com
+
+_NOTE: Make sure that you git ignore this file since it has your password in it._
+
+## Using Script
+
+In your ruby script include the modules.
+
+```ruby
+require 'namecheap-dynamic-dns'
+
+include Namecheap::Dynamic::Dns
+
+setup('domains.yml')
+process_domains
+```
+
+## Using Rails
+
+In you class enter the following.
+
+```ruby
+class Example
+  include Namecheap::Dynamic::Dns
+
+  def initialize(config_file)
+    setup(config_file)
+  end
+end
+```
+
+Then to process the domains
+```ruby
+foo = Example.new('config/domains.yml')
+foo.process_domains
+```
+
+## Other Methods
+These methods you won't need to use but can be useful for you in other way.
+
+```ruby
+# Get external I.P
+external_ip
+
+# Get IP from hostname
+host_to_ip('google.com')
+
+# Valid IP?
+an_ip?('1.2.3.4')
+
+# Get list of domains
+domains
+
+# Chack is domain specified is valid
+valid_domain?('google.com')
+
+# Force reload config YML file
+load_config
+
+# See raw response
+xml_response
+
+# See JSON response
+response
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/namecheap-dynamic-dns.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "namecheap/dynamic/dns"
+
+# 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(__FILE__)

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/lib/namecheap/dynamic/dns.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'xml/to/hash'
+
+require 'open-uri'
+require 'oj'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'yaml'
+require 'open-uri'
+require 'resolv'
+require 'ipaddress'
+require 'logger'
+
+require 'namecheap/dynamic/dns/version'
+require 'namecheap/dynamic/dns/processor'
+require 'namecheap/dynamic/dns/request'
+require 'namecheap/dynamic/dns/settings'
+require 'namecheap/dynamic/dns/network'
+
+module Namecheap
+  module Dynamic
+    # This is the main module where all the rest loads from.
+    module Dns
+      include Processor
+      include Request
+      include Settings
+      include Network
+
+      attr_accessor :config_file, :config, :response, :xml_response, :ip, :updated_domains, :logger
+
+      def setup(config_file)
+        self.config_file = config_file
+        load_config
+        external_ip
+        self.logger = Logger.new(STDOUT)
+        logger.level = Logger::WARN
+      end
+
+    end
+  end
+end

data/lib/namecheap/dynamic/dns/network.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Namecheap
+  module Dynamic
+    module Dns
+      # This module is designed for all network related functions.
+      module Network
+        def external_ip
+          self.ip = nil
+          begin
+            self.ip = open('http://whatismyip.akamai.com').read
+          rescue StandardError => err
+            logger.warn('Failed to retrieve external I.P.')
+            logger.debug(err)
+          end
+        end
+
+        def host_to_ip(host_name)
+          begin
+            Resolv.getaddress(host_name)
+          rescue StandardError => err
+            logger.fatal('Failed to retrieve host I.P. address')
+            logger.debug("Host Name: #{hostname}")
+            logger.error(err)
+            host_name
+          end
+        end
+
+        def an_ip?(host_name)
+          IPAddress.valid?(host_name)
+        end
+
+        def extract_ip(ip_or_host)
+          if an_ip?(ip_or_host)
+            ip_or_host
+          else
+            host_to_ip(ip_or_host)
+          end
+        end
+
+        def host_ip_match?(domain, target, target_ip)
+          host = %w(@ *).include?(target) ? domain : [target, domain].join('.')
+          host_to_ip(host) == target_ip
+        end
+
+        def valid_domain?(target_domain)
+          !target_domain.match(/\A[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,16}\z/ix).nil?
+        end
+
+        def got_external_ip?
+          return true unless ip.nil?
+          logger.error('No external ip detected. Aborting!!')
+          false
+        end
+      end
+    end
+  end
+end

data/lib/namecheap/dynamic/dns/processor.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Namecheap
+  module Dynamic
+    module Dns
+      # This module puts it all together and the main functions are here.
+      module Processor
+        def process_domains
+          return unless pre_check_domain
+          self.updated_domains = []
+
+          domains.each do |domain, attr|
+            next unless pre_check_sub_domains(domain, attr)
+            logger.info("Checking domain: #{domain}")
+            process_subdomains(domain,
+                               attr[:subdomains],
+                               attr[:password],
+                               extract_ip(attr[:ip] ||= ip))
+          end
+        end
+
+        private
+
+        def pre_check_domain
+          return false unless got_external_ip?
+          domains?
+        end
+
+        def pre_check_sub_domains(domain, attr)
+          return unless valid_domain?(domain)
+          return unless password?(attr)
+          return unless subdomains?(attr)
+          return if attr[:ip].nil? && ip.nil?
+          true
+        end
+
+        def process_subdomains(domain, subdomains, password, target_ip)
+          subdomains.each do |subdomain, attributes|
+            ip = process_ip(target_ip, attributes)
+
+            next unless valid_domain?([subdomain, domain].join('.'))
+
+            if host_ip_match?(domain, subdomain, ip)
+              logger.info("  - Host '#{subdomain}' is Valid.")
+              next
+            else
+              process_subdomain(domain, subdomain, password, ip)
+            end
+          end
+        end
+
+        def process_subdomain(domain, subdomain, password, ip)
+          logger.info("  - Updating host '#{subdomain}' !!")
+          request generate_url(subdomain, domain, password, ip)
+          updated_domains.push [subdomain, domain].join('.')
+        end
+
+        def process_ip(target_ip, attributes)
+          if attributes.key?(:ip) && !attributes[:ip].strip.empty?
+            target_ip = attributes[:ip]
+          end
+          extract_ip(target_ip)
+        end
+      end
+    end
+  end
+end

data/lib/namecheap/dynamic/dns/request.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Namecheap
+  module Dynamic
+    module Dns
+      # This module is for handling all requests
+      module Request
+        def base_url
+          'https://dynamicdns.park-your-domain.com/update?'
+        end
+
+        def generate_url(host, domain, password, ip = nil)
+          url = base_url
+          url += [:host, host].join('=')
+          url += ['&', :domain, '=', domain].join
+          url += ['&', :password, '=', password].join
+          url += ['&', :ip, '=', ip].join unless ip.nil?
+          url
+        end
+
+        def request(url)
+          self.xml_response = Nokogiri::XML(open(url))
+          self.response = xml_response.root.to_hash
+        end
+      end
+    end
+  end
+end

data/lib/namecheap/dynamic/dns/settings.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Namecheap
+  module Dynamic
+    module Dns
+      # This module is all about loading and processing configuration items
+      module Settings
+        def load_config
+          if config_file.empty? || !File.exist?(config_file)
+            raise 'Invalid YML config file!'
+          end
+          self.config = YAML.load_file(config_file)
+          self.config = ActiveSupport::HashWithIndifferentAccess.new(config)
+        end
+
+        def domains?
+          config.key?(:domains) && !config[:domains].empty?
+        end
+
+        def domains
+          config[:domains]
+        end
+
+        def subdomains?(domain)
+          return true if domain.key?(:subdomains) && !domain[:subdomains].empty?
+          logger.error('Subdomains are not found.')
+          false
+        end
+
+        def valid_domain?(domain)
+          unless valid_domain?(domain)
+            logger.error("Invalid domain found #{domain}.")
+            return false
+          end
+          true
+        end
+
+        def password?(attr)
+          unless attr.key?(:password)
+            logger.error("No password is specified for #{domain}.")
+            return false
+          end
+          true
+        end
+      end
+    end
+  end
+end

data/lib/namecheap/dynamic/dns/version.rb

@@ -0,0 +1,7 @@
+module Namecheap
+  module Dynamic
+    module Dns
+      VERSION = '0.0.1'.freeze
+    end
+  end
+end

data/namecheap-dynamic-dns.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'namecheap/dynamic/dns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'namecheap-dynamic-dns'
+  spec.version       = Namecheap::Dynamic::Dns::VERSION
+  spec.authors       = ['Saimon Lovell']
+  spec.email         = ['staysynchronize@gmail.com']
+
+  spec.summary       = %q{NameCheap Dynamic DNS}
+  spec.description   = %q{If you host your services from home your wan I.P can change over time.
+                          This gem will help you by making sure the subdomains always point to your home wan ip.}
+  spec.homepage      = 'https://github.com/SaimonL/namecheap-dynamic-dns'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'oj'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'xml-to-hash'
+  spec.add_dependency 'ipaddress'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: namecheap-dynamic-dns
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Saimon Lovell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: oj
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+- !ruby/object:Gem::Dependency
+  name: xml-to-hash
+  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'
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+description: |-
+  If you host your services from home your wan I.P can change over time.
+                            This gem will help you by making sure the subdomains always point to your home wan ip.
+email:
+- staysynchronize@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/namecheap/dynamic/dns.rb
+- lib/namecheap/dynamic/dns/network.rb
+- lib/namecheap/dynamic/dns/processor.rb
+- lib/namecheap/dynamic/dns/request.rb
+- lib/namecheap/dynamic/dns/settings.rb
+- lib/namecheap/dynamic/dns/version.rb
+- namecheap-dynamic-dns.gemspec
+homepage: https://github.com/SaimonL/namecheap-dynamic-dns
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: NameCheap Dynamic DNS
+test_files: []