knife-tarsnap 0.1.1 → 0.1.2

data/README.md

@@ -2,7 +2,7 @@
 
 Provides a chef cookbook with LWRP's to take directory snapshots and maintain retention schedules. Includes a knife plugin for managing tarsnap keys, listing backups, and restoring files.
 
-Backup services are handled by [Colin Percival's](https://twitter.com/cperciva) excellent [tarsnap](https://www.tarsnap.com/).
+Backup services are handled by [Colin Percival](https://twitter.com/cperciva)'s excellent [tarsnap](https://www.tarsnap.com/).
 
 
 ## Installation
@@ -37,7 +37,7 @@ Or install it yourself as:
 
     $ gem install knife-tarsnap
 
-Alternatively, and add this line to your application's Gemfile:
+Alternatively, add this line to your application's Gemfile:
 
     gem 'knife-tarsnap', :path => 'cookbooks/tarsnap/knife-tarsnap'
 
@@ -50,7 +50,7 @@ And then execute:
 
 ### Backing up node data
 
-Create a recipe to define your tarnsap resources, like this:
+Create a recipe to define your tarsnap resources, like this:
 
 ```ruby
 # my-app::backups
@@ -242,7 +242,8 @@ You need to keep a copy of your keys somewhere safe. If you lose them, then it i
 
 ## License
 
-Author:: Scott Sanders (ssanders@taximagic.com)
+Author:: Scott Sanders (scott@jssjr.com)
+Author:: Greg Fitzgerald (greg@gregf.org)
 
 Copyright:: Copyright (c) 2013 RideCharge, Inc.
 

data/lib/chef/knife/tarsnap/core.rb

@@ -53,8 +53,9 @@ class Chef
           end
         end
 
-        # Convenience methods for options
+        ## Convenience methods for options
 
+        # Returns the tarsnap account username or throw an exception.
         def tarsnap_username
           if Chef::Config[:knife][:tarsnap_username]
             Chef::Config[:knife][:tarsnap_username]
@@ -63,6 +64,7 @@ class Chef
           end
         end
 
+        # Returns the tarsnap account password, or prompt the user for input.
         def tarsnap_password
           if Chef::Config[:knife][:tarsnap_password].nil?
             Chef::Config[:knife][:tarsnap_password] = ui.ask('Tarsnap Password: ') { |q| q.echo = '*' }
@@ -70,41 +72,50 @@ class Chef
           Chef::Config[:knife][:tarsnap_password]
         end
 
+        # Returns the name of the data bag used to store tarsnap keys.
         def tarsnap_data_bag
           Chef::Config[:knife][:tarsnap_data_bag] || config[:tarsnap_data_bag]
         end
 
-        # Required tools
+        ## Required tools
 
+        # Returns the path of the tarsnap-keygen command line binary.
         def keygen_tool
           @_keygen_path || @_keygen_path = which('tarsnap-keygen')
         end
 
+        # Returns the path of the tarsnap command line binary.
         def tarsnap_tool
           @_tarsnap_path || @_tarsnap_path = which('tarsnap')
         end
 
-        # Helpers
+        ## Helpers
 
+        # Normalize the FQDN by replacing dots (.) with underscores (_).
         def canonicalize(fqdn)
           fqdn.gsub(".","_")
         end
 
+        # Return the list of nodes from the data bag marked as pending.
         def pending_nodes
+          Shell::Extensions.extend_context_object(self)
           @_pending_nodes || @_pending_nodes =
-            Chef::DataBag.load(tarsnap_data_bag).keep_if{|k,v| k =~ /^__/}.map{|k,v| k.gsub(/^__/, '').gsub("_",".")}
+            nodes.find('tarsnap_pending:true').map{|n| n.fqdn}
         end
 
+        # Return the list of nodes from the data bag marked as having keys.
         def tarsnap_nodes
           @_tarsnap_nodes || @_tarsnap_nodes =
             Chef::DataBag.load(tarsnap_data_bag).keep_if{|k,v| k !~ /^__/}.map{|k,v| k.gsub("_",".")}
         end
 
+        # Convenience method for returning a Chef::Node object from its FQDN.
         def fetch_node(fqdn)
           Shell::Extensions.extend_context_object(self)
           nodes.find("fqdn:#{fqdn}").first
         end
 
+        # Returns the tarsnap key for a given node's FQDN.
         def fetch_key(fqdn)
           bag_item = fetch_tarsnap_bag_item(fqdn)
           if bag_item
@@ -114,16 +125,21 @@ class Chef
           end
         end
 
+        # Returns a boolean indicating if the node has a tarsnap key and is ready for use, or not.
         def is_a_tarsnap_node?(fqdn)
           tarsnap_nodes.include?(fqdn)
         end
 
+        # Remove the data bag entry for a pending node.
         def remove_pending_node(fqdn)
-          rest.delete_rest("data/#{tarsnap_data_bag}/__#{canonicalize(fqdn)}")
+          n = nodes.find("fqdn:#{fqdn}").first
+          n.set.delete('tarsnap_pending')
+          n.save
         end
 
         private
 
+        # Returns the path for the requested binary.
         def which(binary)
           which_cmd = "which #{binary}"
           which_shell = Mixlib::ShellOut.new(which_cmd)
@@ -134,6 +150,7 @@ class Chef
           which_shell.stdout.chomp
         end
 
+        # Fetch the tarsnap keys data bag item for a node and return it.
         def fetch_tarsnap_bag_item(fqdn)
           begin
             Chef::EncryptedDataBagItem.load(tarsnap_data_bag, canonicalize(fqdn))

data/lib/knife-tarsnap/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Tarsnap
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-tarsnap
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -78,4 +78,3 @@ summary: Provides a chef cookbook with LWRP's to directory snapshots and maintai
   retention schedules. Includes a knife plugin for managing tarsnap keys, listing
   backups, and restoring files.
 test_files: []
-has_rdoc: