Merge pull request #5 from wk8/possibly_several_records_with_same_name

v0.1.6: Added the `shared_A_record` attribute

Author: wk8

Berksfile.lock

@@ -4,4 +4,4 @@ DEPENDENCIES
     metadata: true
 
 GRAPH
-  cloudflare (0.1.4)
+  cloudflare (0.1.6)

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 This file is used to list changes made in each version of cloudflare.
 
+## 0.1.6:
+
+* Added the `shared_A_record` attribute to the LWRP to make it possible to have several A records with the same name (aka DNS load balancing)
+* Properly updating LWRP states when an action has been performed
+* More complete example recipes (should integrate Test Kitchen soon)
+
 ## 0.1.5:
 
 * Included Vagrant & Berkshelf for easier development

README.md

@@ -19,9 +19,10 @@ I strongly recommend storing your Cloudflare credentials in an encrypted data ba
 
 There also are a number of optional node attributes:
 
-* `['cloudflare']['check_credentials']`: whether to check your Cloudflare credentials before attempting any API call (defaults to `true`)
-* `['cloudflare']['check_zone']`: whether to check if the specified DNS zone(s) exist(s) on your Cloudflare account before trying to add or delete records (defaults to `true`)
-* `['cloudflare']['check_with_DNS']`: whether to try checking your records' existence against a DNS server rather than querying the Cloudflare API (will still query the Cloudflare API if the DNS server does not return what's expected - defaults to `false`)
+* `['cloudflare']['debug']`: used to defined other default attributes (see below - defaults to `false`); basically, you might want to turn that to true when setting up your cookbook, but **be sure to turn that back to `false` when running this cookbook on your actual servers to avoid hitting Cloudflare's API thresholds**
+* `['cloudflare']['check_credentials']`: whether to check your Cloudflare credentials before attempting any API call (defaults to `node['cloudflare']['debug']`)
+* `['cloudflare']['check_zone']`: whether to check if the specified DNS zone(s) exist(s) on your Cloudflare account before trying to add or delete records (defaults to `node['cloudflare']['debug']`)
+* `['cloudflare']['check_with_DNS']`: whether to try checking your records' existence against a DNS server rather than querying the Cloudflare API (will still query the Cloudflare API if the DNS server does not return what's expected - defaults to `true`)
 * `['cloudflare']['DNS_server']`: if you use the `check_with_DNS` option, that is the DNS server that will be queried (defaults to `ns.cloudflare.com`, which is Cloudflare's main public DNS server)
 
 Those attributes come in especially handy if you have a number of servers and get throttled by Cloudflare's API limits.
@@ -41,7 +42,8 @@ This resource defines the following attributes (they're all `String`s unless oth
 * `zone` (required): the zone of the DNS record
 * `content` (optional - defaults to `node.ipaddress`): the content of the DNS record
 * `type` (one of `'A'` or `'CNAME'` - defaults to `'A'`): the type of the DNS record. Please let me know if you'd like other record types supported
-* `ttl` (must be a `Fixnum` - defaults to `1`, which, according to Cloudflare doc, means 'automatic'): the ttl of the DNS record
+* `ttl` (must be a `Fixnum` - defaults to `1`, which, according to Cloudflare's doc, means 'automatic'): the ttl of the DNS record
+* `shared_A_record` (boolean - optional, defaults to `false`): set that to `true` if you want to have several A records with the same name (aka DNS load balancing). Also works for deleting a single A record when several share the same name. Disclaimer: IMHO, that's [pretty bad practice](http://bitplex.me/2008/09/why-round-robin-dns-is-bad.html). This attribute is totally ignored for CNAME records.
 
 For instance, the following code in your cookbook's recipe would create an `A` DNS record `server_name.example.com` pointing to `1.2.3.4` with an automatic TTL:
 
@@ -82,7 +84,9 @@ You also need to define 3 environment variables to be able to use my Vagrantfile
 
 You can do so by typing e.g. `export CLOUDFLARE_EMAIL='[email protected]'` and so on in your shell.
 
-Be aware that the example recipe will then proceed to create a few DNS records on that DNS zone with your credentials, so use with caution!
+Be aware that the example recipe will then proceed to create a few DNS records on that DNS zone with your credentials, so use with caution! That being said, all said records will start with 'cl-cb-test-' so they have little chance of clonflicting with exisiting records on your account.
+
+You can also easily clean up the test records created that way by running `CLOUDFLARE_CLEANUP=1 vagrant provision`.
 
 Then playing with this cookbook should be as easy as running `bundle install && vagrant up`!
 
@@ -95,6 +99,11 @@ Feel free to reach me at <[email protected]>
 Changes
 =======
 
+* 0.1.6 (Jul 9, 2014)
+    * Added the `shared_A_record` attribute to the LWRP to make it possible to have several A records with the same name (aka DNS load balancing)
+    * Properly updating LWRP states when an action has been performed
+    * More complete example recipes (should integrate Test Kitchen soon)
+
 * 0.1.5 (Jul 8, 2014)
     * Included Vagrant & Berkshelf for easier development
 

Vagrantfile

@@ -3,7 +3,7 @@
 
 CLOUDFLARE_EMAIL = ENV['CLOUDFLARE_EMAIL']
 CLOUDFLARE_API_KEY = ENV['CLOUDFLARE_API_KEY']
-CLOUDFLARE_ZONE = ENV['CLOUDFLARE_DOMAIN']
+CLOUDFLARE_ZONE = ENV['CLOUDFLARE_ZONE']
 
 if !CLOUDFLARE_EMAIL || !CLOUDFLARE_API_KEY || !CLOUDFLARE_ZONE
   raise 'You must define the CLOUDFLARE_EMAIL, CLOUDFLARE_API_KEY and CLOUDFLARE_ZONE environment variables'
@@ -28,12 +28,16 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
           'email' => CLOUDFLARE_EMAIL,
           'api_key' => CLOUDFLARE_API_KEY
         },
-        'example_zone' => CLOUDFLARE_ZONE
+        'example_zone' => CLOUDFLARE_ZONE,
+        'debug' => true
       }
     }
 
     chef.run_list = [
       'recipe[cloudflare::example]',
     ]
+    if ENV['CLOUDFLARE_CLEANUP']
+      chef.run_list << 'recipe[cloudflare::example-cleanup]'
+    end
   end
 end

attributes/default.rb

@@ -1,13 +1,18 @@
+# If set to true, will perform all possible checks on your credentials and so on
+# You most likely want that switched to `false' when you're done setting up your
+# cookbook! That way we'll make as few calls to Cloudflare API as possible
+default['cloudflare']['debug'] = false
+
 # If set to true, we'll check your credentials are valid before carrying on
-default['cloudflare']['check_credentials'] = true
+default['cloudflare']['check_credentials'] = node['cloudflare']['debug']
 # If set to true, we'll check the specified zone exists before trying to create
 # or delete new records in it
-default['cloudflare']['check_zone'] = true
+default['cloudflare']['check_zone'] = node['cloudflare']['debug']
 
 # Set that attribute below to true if you decide to check your records by
 # querying a DNS server instead of Cloudflare directly (can be useful to avoid
 # making too many requests to Cloudflare if you have a number of servers
-default['cloudflare']['check_with_DNS'] = false
+default['cloudflare']['check_with_DNS'] = true
 # If you set the attribute above to true, that's the DNS server we're going
 # to ask - defaults to Cloudflare's main public DNS server
 default['cloudflare']['DNS_server'] = 'ns.cloudflare.com'

libraries/cloudflare.rb

@@ -7,20 +7,50 @@ class Connection
 
 # adding a few useful methods to the vanilla Cloudflare library
 class CloudflareClient < CloudFlare::Connection
-
     # custom timeout to avoid timing out
     TIMEOUT = 10
 
-    # This method deletes a DNS record by name
+    # This method deletes DNS records by name
     #
     # @param zone [String]
     # @param name [String]
     def rec_delete_by_name zone, name
-        rec_id = get_record(zone, name)['rec_id'] or return false
-        rec_delete(zone, rec_id)
+        get_records(zone, name).keys.each { |rec_id| rec_delete(zone, rec_id) }
+    end
+
+    # This method finds a record by its name, zone, content and type,
+    # Returns nil of none was found, the meta hash otherwise
+    #
+    # @param zone [String]
+    # @param name [String]
+    # @param content [String]
+    # @param type [String]
+    def find_single_record zone, name, content, type = 'A'
+        get_records(zone, name).values.each do |rec|
+            if rec['zone_name'] == zone \
+                && rec['display_name'] == name \
+                && rec['content'] == content \
+                && rec['type'] == type
+                return rec
+            end
+        end
+        nil
+    end
+
+    # This method deletes a single record
+    # Returns true iff a record was deleted
+    #
+    # @param zone [String]
+    # @param name [String]
+    # @param content [String]
+    # @param type [String]
+    def rec_delete_single zone, name, content, type = 'A'
+        rec = find_single_record(zone, name, content, type) or return false
+        rec_delete(zone, rec['rec_id'])
+        true
     end
 
-    # This method returns true if that zone exists
+    # This method returns true iff that zone exists
     #
     # @param zone [String]
     def zone_exists? zone
@@ -35,15 +65,20 @@ def credentials_valid?
         zone_load_multi['result'] == 'success' rescue false
     end
 
-    # Gets all the metadata hash for a given record
+    # Gets all the metadata for records that match
+    # the given `zone' and `name'
+    # Returns a hash mapping record's IDs to the metadata hashes
     # 
     # @param zone [String]
     # @param name [String]
-    def get_record zone, name
+    def get_records zone, name
+        result = {}
         get_all_records_for_zone(zone).each do |rec|
-            return rec if rec['display_name'] == name && rec['zone_name'] == zone
-        end rescue NoMethodError
-        nil
+            if rec['display_name'] == name && rec['zone_name'] == zone
+                result[rec['rec_id']] = rec
+            end
+        end
+        result
     end
 
     # The vanilla lib's 'rec_load_all' implementation doesn't account (as of v2.0.1)
@@ -56,6 +91,20 @@ def rec_load_all zone, offset = 0
         send_req({a: :rec_load_all, z: zone, o: offset})
     end
 
+    # we need to flush the cache when creating, editing or deleting records
+    def rec_new zone, *args
+        flush_cache_for_zone zone
+        super zone, *args
+    end
+    def rec_edit zone, *args
+        flush_cache_for_zone zone
+        super zone, *args
+    end
+    def rec_delete zone, *args
+        flush_cache_for_zone zone
+        super zone, *args
+    end
+
     private
 
     # Returns an array containing all the records for this zone,
@@ -85,4 +134,11 @@ def zone_load_multi
         @zone_load_multi_cache ||= super
     end
 
+    # We need to flush the cache when we make changes that make it obsolete
+    #
+    # @param zone [String]
+    def flush_cache_for_zone zone
+        @records_cache ||= {}
+        @records_cache.delete zone
+    end
 end