route53_aliaser 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f5f82836a1ef13c74c8ea8ee34e4b03adbf1bd5
-  data.tar.gz: 4eea87944e778b4d4cd94112aa9b8e58f3e47588
+  metadata.gz: a4a21547d3908c6cbfd826ee93a4106990a1981f
+  data.tar.gz: a04a1405caa9e0360bc58636ce59ae498d748129
 SHA512:
-  metadata.gz: 54e4b74a04201d403e573c9d58ce4f13ee6237356e7f788aec3d66d299bebcfb151844c567a9cb3bc7bd51b277c0ac1d1397baa9e68f7f26a605b6ce4ef9dabb
-  data.tar.gz: de24589f9f8feef46adc4f245cbfcdefe262598ced7a9d9e980a5a05e2e72e8ee06ba9d4f5285358509c38426d3f1dea0e9299e4dabeb08c86bba5bb3f1f6d71
+  metadata.gz: 2be90ca647c63d0947cb0792288a6431b0abf1d5b4cc11b4b04067663bc634687b676444c36e88ffe597f162067b5a94490cd08e1c2d94c25200155e5bc4bcd1
+  data.tar.gz: c777416c75e594a442eeb918460b6648df5d61a7a52b18f812970e264f14f99fb6063209e4187c1e23d2b552fabf2ecdddef4270c81079fc3fa32f9595447162

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+# Route53Aliaser 0.0.2
+- add Rails Engine support
+- use Rails.cache when Rails is defined
+
 # Route53Aliaser 0.0.1
 - initial release

data/README.md

@@ -21,6 +21,9 @@ 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
 
 Add this line to your application's Gemfile:
@@ -37,6 +40,8 @@ Or install it yourself as:
 
 ## Usage
 
+#### With Rails
+
 Add an initializer that looks like this:
 
     # ./config/initializers/route53_aliaser.rb
@@ -47,34 +52,59 @@ Add an initializer that looks like this:
       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
+      # NOTE: You'll need to use AWS IAM to add a Route 53 read/write Policy for the user/group
+      # associated with these credentials!
       # config.aws_access_key_id     = ENV['RT53_AWS_ACCESS_KEY_ID']
       # config.aws_secret_access_key = ENV['RT53_AWS_SECRET_ACCESS_KEY']
     end
 
+Next, mount the Rails Engine at a URL of your choosing:
+
+    # ./config/routes.rb
+    mount Route53Aliaser::Engine => '/route53-update'
+
+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
+[Pingdom](http://www.pingdom.com/free). Since the DNS lookups are cached, most
+of the time requests to this URL will return nearly instantly.
+
+#### Without Rails
+
+If you're not using Rails, or if you'd like to update ad-hoc, just call
+`Route53Aliaser.update_alias_if_needed` periodically. You'll of course need to
+do some initialization similar to what is shown above.
 
-Then, just call `Route53Aliaser.update_alias_if_needed` periodically.
+### Other Options
 
-Not sure what the best approach is for this yet, but here are a few ideas:
+For now, hitting the engine URL is the best option. It should keep things up
+to date with minimal load on your app (since it's basically a NOOP when the
+cached lookups are fresh). Please open an issue with your suggestion if you
+have a better idea. Here are a couple alternatives:
 
 - 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.
+  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 calling this in line (i.e.,
+  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
 
-I'm using this against a limited number of configurations so patches are
-*very* welcome!
+So far, this is being used against a limited number of configurations so
+patches are *very* welcome!
 
-1. Fork it ( https://github.com/[my-github-username]/route53_aliaser/fork )
+1. Fork it ( https://github.com/rdlugosz/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`)
@@ -82,13 +112,12 @@ I'm using this against a limited number of configurations so patches are
 
 ### Todos
 
-1. Add some tests! *(Yes, I feel dirty.)*
+1. Add some tests
 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
+### Questions?
 
-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.
+Feel free to use the issue tracker for questions/comments or hit me up on
+Twitter [@lbwski](https://twitter.com/lbwski).

data/app/controllers/route53_aliaser/aliaser_controller.rb

@@ -0,0 +1,8 @@
+module Route53Aliaser
+  class AliaserController < ActionController::Base
+    def update
+      Route53Aliaser.update_alias_if_needed
+      head :ok
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Route53Aliaser::Engine.routes.draw do
+  root to: 'aliaser#update', via: [:get, :head]
+end

data/lib/route53_aliaser/aliaser.rb

@@ -11,16 +11,19 @@ module Route53Aliaser
     end
 
     def call
-      # NOOP if we haven't expired
-      return unless stale?
+      unless stale?
+        # NOOP if we haven't expired
+        config.logger.debug "Route53Aliaser: NOOP because cache is fresh"
+        return
+      end
 
       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."
+        config.logger.debug "Route53Aliaser: No Route 53 Update required (Target IPs match the Source IPs)"
       else
-        config.logger.info "IPs for #{config.target_record} #{target_ips} differ from #{config.source_record} #{source_ips}; will attempt to update."
+        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)
         rt53.update_target(config.target_record, source_ips, config.zone_id)
       end
@@ -65,9 +68,9 @@ module Route53Aliaser
                            expires_in: ttl.seconds,
                            race_condition_ttl: 10
                           )
-        config.logger.debug "Route53Aliaser Caching #{key}: #{ips} for #{ttl} seconds (ttl)"
+        config.logger.debug "Route53Aliaser: Caching #{key}: #{ips} for #{ttl} seconds (ttl)"
       else
-        config.logger.error "Route53Aliaser NOT Caching #{key} because no IPs were found."
+        config.logger.error "Route53Aliaser: NOT Caching #{key} because no IPs were found."
       end
     end
   end

data/lib/route53_aliaser/configuration.rb

@@ -5,7 +5,7 @@ module Route53Aliaser
 
     def initialize
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-      @cache  = ActiveSupport::Cache::MemoryStore.new
+      @cache  = defined?(Rails) ? Rails.cache  : ActiveSupport::Cache::MemoryStore.new
     end
 
     def target_key

data/lib/route53_aliaser/engine.rb

@@ -0,0 +1,5 @@
+module Route53Aliaser
+  class Engine < ::Rails::Engine
+    isolate_namespace Route53Aliaser
+  end
+end

data/lib/route53_aliaser/version.rb

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

data/lib/route53_aliaser.rb

@@ -3,6 +3,8 @@ require "route53_aliaser/configuration"
 require "route53_aliaser/route53_updater"
 require "route53_aliaser/aliaser"
 
+require "route53_aliaser/engine" if defined?(Rails)
+
 require "resolv"
 
 require "aws-sdk"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: route53_aliaser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan Dlugosz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-03 00:00:00.000000000 Z
+date: 2014-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,9 +93,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/route53_aliaser/aliaser_controller.rb
+- config/routes.rb
 - lib/route53_aliaser.rb
 - lib/route53_aliaser/aliaser.rb
 - lib/route53_aliaser/configuration.rb
+- lib/route53_aliaser/engine.rb
 - lib/route53_aliaser/route53_updater.rb
 - lib/route53_aliaser/version.rb
 - route53_aliaser.gemspec