route53_aliaser 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4a21547d3908c6cbfd826ee93a4106990a1981f
-  data.tar.gz: a04a1405caa9e0360bc58636ce59ae498d748129
+  metadata.gz: 7ab9ef8a372dec5ffad110b0cf3a2a629e52a282
+  data.tar.gz: 81bceee8f1616015be7bb1293c6878ef7d4b31e9
 SHA512:
-  metadata.gz: 2be90ca647c63d0947cb0792288a6431b0abf1d5b4cc11b4b04067663bc634687b676444c36e88ffe597f162067b5a94490cd08e1c2d94c25200155e5bc4bcd1
-  data.tar.gz: c777416c75e594a442eeb918460b6648df5d61a7a52b18f812970e264f14f99fb6063209e4187c1e23d2b552fabf2ecdddef4270c81079fc3fa32f9595447162
+  metadata.gz: ffcbbd229e0f23783945ab7a0b731dedc3482f2493df79442392a8f7207c55633c685a4ef0203dc972b490cd3dbc41489be6cc07243ca3ab4d7383331a585fc4
+  data.tar.gz: fb6d97fae28e055d8514682ec9c466678f107672d5eaa1466b541394fcf26304a641c113cee872084635e9f45bb0c67d26b59baddbe0c3f696ef5580a0b90de7

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# Route53Aliaser 0.0.3
+- increase log verbosity on NOOP and Matches (helps to provide assurance that
+  we're doing *something*)
+- improve documentation
+
 # Route53Aliaser 0.0.2
 - add Rails Engine support
 - use Rails.cache when Rails is defined

data/README.md

@@ -1,15 +1,22 @@
 # 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.
+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/)
+by looking for changes to the CNAME you'd like to point to and updating your
+A-Record via the Route 53 APIs.
+
+Just point your ping monitor at the engine URL and you're good to go! Your
+A-Record will remain in sync with whatever CNAME you point it at.
+
+This is useful because some providers (like Heroku) don'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 fake CNAME record set on the root domain; fake
+because you [cannot have a CNAME at the
+apex](http://serverfault.com/questions/613829/why-cant-a-cname-record-be-used-at-the-apex-of-a-domain)).
+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:
 
@@ -21,8 +28,6 @@ This code will:
           domain)
         - If the Target and Source addresses differ, update the `target_record`
 
-The updates are easily triggered by polling a URL in your application that is
-mounted via a Rails Engine.
 
 ## Installation
 
@@ -38,6 +43,7 @@ Or install it yourself as:
 
     $ gem install route53_aliaser
 
+
 ## Usage
 
 #### With Rails
@@ -67,15 +73,20 @@ Finally, set up something to ping this URL occasionally:
 
     $ curl https://example.com/route53-update
 
-Heroku's [free scheduler](https://devcenter.heroku.com/articles/scheduler) has
-an "every 10 minutes" option that'd be great for this. Just put the curl
-command in there. Note that Heroku charges dyno hours for scheduled jobs; if
-you're worried about this then you may prefer to use the "once an hour" option
-instead.
-
-You could also ping that URL via a free service like
+The easiest way to do this is to ping that URL via a free service like
 [Pingdom](http://www.pingdom.com/free). Since the DNS lookups are cached, most
-of the time requests to this URL will return nearly instantly.
+of the time requests to this URL will return nearly instantly. Pingdom
+defaults to checking once per minute, which should be within even the shortest
+TTLs.
+
+Heroku's [free scheduler](https://devcenter.heroku.com/articles/scheduler) has
+an "every 10 minutes" option that could also be used for this. Just put the
+curl command in there. Note that Heroku
+[charges](https://devcenter.heroku.com/articles/usage-and-billing) dyno hours
+for scheduled jobs; if you're worried about this then you may prefer to use
+the "once an hour" option instead. The downside to this approach is that the
+further you stretch out the update interval the more likely you are to end up
+with an out of date A-Record.
 
 #### Without Rails
 
@@ -99,6 +110,7 @@ have a better idea. Here are a couple alternatives:
   not in a separate thread) in a controller action is not recommended since
   DNS lookups / AWS calls might be slow & will block the request to your page.
 
+
 ## Contributing
 
 So far, this is being used against a limited number of configurations so

data/lib/route53_aliaser/aliaser.rb

@@ -13,7 +13,7 @@ module Route53Aliaser
     def call
       unless stale?
         # NOOP if we haven't expired
-        config.logger.debug "Route53Aliaser: NOOP because cache is fresh"
+        config.logger.info "Route53Aliaser: NOOP because cache is fresh"
         return
       end
 
@@ -21,7 +21,7 @@ module Route53Aliaser
       source_ips = get_ips(config.source_record, config.source_key)
 
       if target_ips == source_ips
-        config.logger.debug "Route53Aliaser: No Route 53 Update required (Target IPs match the Source IPs)"
+        config.logger.info "Route53Aliaser: No Route 53 Update required (Target IPs match the Source IPs)"
       else
         config.logger.info "Route53Aliaser: IPs for #{config.target_record} #{target_ips} differ from #{config.source_record} #{source_ips}; will attempt to update"
         rt53 = Route53Updater.new(config)

data/lib/route53_aliaser/route53_updater.rb

@@ -1,3 +1,5 @@
+# AWS::Route53 API docs:
+# http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/Route53.html
 module Route53Aliaser
   class Route53Updater
     attr_reader :config

data/lib/route53_aliaser/version.rb

@@ -1,3 +1,3 @@
 module Route53Aliaser
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route53_aliaser
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ryan Dlugosz