route53_aliaser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f5f82836a1ef13c74c8ea8ee34e4b03adbf1bd5
+  data.tar.gz: 4eea87944e778b4d4cd94112aa9b8e58f3e47588
+SHA512:
+  metadata.gz: 54e4b74a04201d403e573c9d58ce4f13ee6237356e7f788aec3d66d299bebcfb151844c567a9cb3bc7bd51b277c0ac1d1397baa9e68f7f26a605b6ce4ef9dabb
+  data.tar.gz: de24589f9f8feef46adc4f245cbfcdefe262598ced7a9d9e980a5a05e2e72e8ee06ba9d4f5285358509c38426d3f1dea0e9299e4dabeb08c86bba5bb3f1f6d71

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Route53Aliaser 0.0.1
+- initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Dlugosz
+
+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,94 @@
+# Route53Aliaser
+
+Simulate DNS ALIAS-record support for [apex
+zones](https://devcenter.heroku.com/articles/apex-domains) (a.k.a. bare / naked / root
+domains) via Amazon [Route 53](https://aws.amazon.com/route53/).
+
+This is useful because Heroku doesn't support these so-called naked domains
+and there are a limited number of DNS providers who support the [ALIAS
+record](http://support.dnsimple.com/articles/alias-record/) type (which is
+essentially a CNAME record set on the root domain, that typically must be an
+A-Record). Amazon Route 53 only supports ALIASes to a few specific types of
+records, which doesn't solve the problem for Heroku users who require SSL.
+
+This code will:
+
+- Check to see if our cached lookup of the `source_record` has expired
+    - if no, return immediately (noop)
+    - if yes:
+        - Lookup the A record for our `source_record` (e.g., CNAME to Heroku)
+        - Lookup the A record for our `target_record` (probably the naked
+          domain)
+        - If the Target and Source addresses differ, update the `target_record`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'route53_aliaser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install route53_aliaser
+
+## Usage
+
+Add an initializer that looks like this:
+
+    # ./config/initializers/route53_aliaser.rb
+
+    Route53Aliaser.configure do |config|
+      config.target_record   = ENV['RT53_TARGET_RECORD'] #This is the one that is updated, i.e., your ALIAS
+      config.source_record   = ENV['RT53_SOURCE_RECORD'] #This is what the ALIAS should be pointed to
+      config.zone_id         = ENV['RT53_ZONE_ID']       #Amazon Hosted Zone ID
+
+      # Only need to set these if you aren't already setting them for another AWS service
+      # config.aws_access_key_id     = ENV['RT53_AWS_ACCESS_KEY_ID']
+      # config.aws_secret_access_key = ENV['RT53_AWS_SECRET_ACCESS_KEY']
+    end
+
+
+Then, just call `Route53Aliaser.update_alias_if_needed` periodically.
+
+Not sure what the best approach is for this yet, but here are a few ideas:
+
+- Add a `cron` job executing a Rake task.
+- Create a special controller action that you load every so often via a ping
+  monitoring service. This controller action would act similar to a webhook in
+  that it would just call `Route53Aliaser.update_alias_if_needed` and return a
+  success code.
+- Dropping `Thread.new { Route53Aliaser.update_alias_if_needed }` into a
+  controller action that gets called relatively frequently (say, your home page).
+  This is the #YOLO approach, but shouldn't be terribly harmful since: A) this
+  is a very short-lived thread, and B) there are no real consequences if the
+  thread were suddenly killed. Note that I would not recommend calling this in
+  line (i.e., not in a separate thread) in a controller action since DNS
+  lookups / AWS calls might be slow & will block the request to your page.
+
+## Contributing
+
+I'm using this against a limited number of configurations so patches are
+*very* welcome!
+
+1. Fork it ( https://github.com/[my-github-username]/route53_aliaser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+### Todos
+
+1. Add some tests! *(Yes, I feel dirty.)*
+1. Extract the dependency on ActiveSupport. The only thing really in use is
+   the caching mechanism.
+1. Include support for other API-enabled DNS Hosts, e.g., Rackspace.
+
+## Warranty
+
+This software is provided “as is” and without any express or implied
+warranties, including, without limitation, the implied warranties of
+merchantability and fitness for a particular purpose.

data/Rakefile

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

data/lib/route53_aliaser/aliaser.rb

@@ -0,0 +1,74 @@
+module Route53Aliaser
+  class Aliaser
+    attr_reader :config
+
+    def initialize(config = Configuration.new)
+      @config = config
+    end
+
+    def stale?
+      config.cache.fetch(config.source_key).nil?
+    end
+
+    def call
+      # NOOP if we haven't expired
+      return unless stale?
+
+      target_ips = get_ips(config.target_record, config.target_key)
+      source_ips = get_ips(config.source_record, config.source_key)
+
+      if target_ips == source_ips
+        config.logger.debug "No Route 53 Update required."
+      else
+        config.logger.info "IPs for #{config.target_record} #{target_ips} differ from #{config.source_record} #{source_ips}; will attempt to update."
+        rt53 = Route53Updater.new(config)
+        rt53.update_target(config.target_record, source_ips, config.zone_id)
+      end
+    end
+
+    private
+    def get_ips(zone, key)
+      ips = retrieve_ips_from_cache(key)
+      if ips.empty?
+        ips, ttl = get_ips_and_ttl_from_dns(zone)
+        cache_results(key, zone, ips, ttl)
+      end
+      ips
+    end
+
+    def retrieve_ips_from_cache(key)
+      cached_value = config.cache.fetch(key)
+      if cached_value
+        cached_value.split(',')
+      else
+        []
+      end
+    end
+
+    def get_ips_and_ttl_from_dns(zone)
+      ips, ttl = [], 0
+      resources = Resolv::DNS.new.getresources(zone, Resolv::DNS::Resource::IN::A)
+      if resources && resources.size > 0
+        ips = resources.collect{|res| res.address.to_s}.sort
+        ttl = resources.first.ttl
+      end
+      return ips, ttl
+    rescue ResolvError => e
+      config.logger.error e
+      return ips, ttl
+    end
+
+    def cache_results(key, zone, ips, ttl)
+      unless ips.empty?
+        config.cache.write(key,
+                           ips.join(','),
+                           expires_in: ttl.seconds,
+                           race_condition_ttl: 10
+                          )
+        config.logger.debug "Route53Aliaser Caching #{key}: #{ips} for #{ttl} seconds (ttl)"
+      else
+        config.logger.error "Route53Aliaser NOT Caching #{key} because no IPs were found."
+      end
+    end
+  end
+end

data/lib/route53_aliaser/configuration.rb

@@ -0,0 +1,19 @@
+module Route53Aliaser
+  class Configuration
+    attr_accessor :target_record, :source_record, :zone_id, :logger, :cache,
+      :aws_access_key_id, :aws_secret_access_key
+
+    def initialize
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @cache  = ActiveSupport::Cache::MemoryStore.new
+    end
+
+    def target_key
+      "rt53_#{target_record}_ips"
+    end
+
+    def source_key
+      "rt53_#{source_record}_ips"
+    end
+  end
+end

data/lib/route53_aliaser/route53_updater.rb

@@ -0,0 +1,45 @@
+module Route53Aliaser
+  class Route53Updater
+    attr_reader :config
+    def initialize(config)
+      @config = config
+    end
+
+    def update_target(target_record, ips, zone_id)
+      change = {
+        action: "UPSERT",
+        resource_record_set: {
+          name: target_record,
+          type: "A",
+          ttl: 60,
+          resource_records: ips.collect{ |ip| { value: ip } }
+        }
+      }
+      change_batch = {
+        comment: "auto updated",
+        changes: [change]
+      }
+      options = {
+        hosted_zone_id: zone_id,
+        change_batch: change_batch
+      }
+
+      rt53 = get_configured_aws_client
+
+      res = rt53.client.change_resource_record_sets(options)
+
+      res && res.successful?
+    end
+
+    private
+    def get_configured_aws_client
+      if(config.aws_access_key_id && config.aws_secret_access_key)
+        AWS::Route53.new(access_key_id:     config.aws_access_key_id,
+                         secret_access_key: config.aws_secret_access_key)
+      else
+        # Use the config set at the AWS module level (probably set for something else)
+        AWS::Route53.new
+      end
+    end
+  end
+end

data/lib/route53_aliaser/version.rb

@@ -0,0 +1,3 @@
+module Route53Aliaser
+  VERSION = "0.0.1"
+end

data/lib/route53_aliaser.rb

@@ -0,0 +1,30 @@
+require "route53_aliaser/version"
+require "route53_aliaser/configuration"
+require "route53_aliaser/route53_updater"
+require "route53_aliaser/aliaser"
+
+require "resolv"
+
+require "aws-sdk"
+require "active_support" #TODO: Can we break this dep?
+
+module Route53Aliaser
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Route53Aliaser::Configuration.new
+    yield(config)
+  end
+
+  def self.update_alias_if_needed
+    unless(config && config.target_record && config.source_record && config.zone_id)
+      Configuration.new.logger.error "Route53Aliaser is not configured properly. Please check the docs."
+      return
+    end
+
+    aliaser = Route53Aliaser::Aliaser.new(config)
+    aliaser.call
+  end
+end

data/route53_aliaser.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'route53_aliaser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "route53_aliaser"
+  spec.version       = Route53Aliaser::VERSION
+  spec.authors       = ["Ryan Dlugosz"]
+  spec.email         = ["ryan@dlugosz.net"]
+  spec.summary       = %q{Simulate DNS ALIAS-record support for apex zones (a.k.a. bare / naked / root domains) via Amazon Route 53}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "https://github.com/rdlugosz/route53_aliaser"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+
+  spec.add_dependency "aws-sdk", "~> 1.57"
+  spec.add_dependency "activesupport", ">= 3.2"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: route53_aliaser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Dlugosz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.57'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.57'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- ryan@dlugosz.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/route53_aliaser.rb
+- lib/route53_aliaser/aliaser.rb
+- lib/route53_aliaser/configuration.rb
+- lib/route53_aliaser/route53_updater.rb
+- lib/route53_aliaser/version.rb
+- route53_aliaser.gemspec
+homepage: https://github.com/rdlugosz/route53_aliaser
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simulate DNS ALIAS-record support for apex zones (a.k.a. bare / naked / root
+  domains) via Amazon Route 53
+test_files: []