palisade 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6be72549c6a94a8a615a45b64ff95cd7903f8ed9
-  data.tar.gz: a82ad1ca51611fdf1dabe77394ac4dd3757f0fed
+  metadata.gz: a529d4ac1d98c172b9e26bb10fa44604053d719e
+  data.tar.gz: 3f2529c58389b2d82025ecbe9a04c412cdbe9f9e
 SHA512:
-  metadata.gz: 9355ba9498ccc78f80a3ee28cd409b75a2c2ccf226eeb6d1d389561e73290177384a18000a6bf0fa9068280e115e5ca12d0ed8e45e6ae097ad75933383e8e6ae
-  data.tar.gz: 90d516bffa251b4aa31909f27cba7ba48644bdf9f449db717c49c0637a297d51e2456cea2d0b6c25863eaba9663025c0adfa6ef142796cc560e4b37dc7b744f9
+  metadata.gz: 4c72e5aa330f67aad252a439130103c6d2836c16a78774301b336c85b596b42f6c61e1e45d1b874d61b152fb2e275fcb1adad4b911bf151d21ae3e0c3b5adaee
+  data.tar.gz: 8c1e3a97f2115f90615610836afb1745434a9ce3d5029c21a5632aea7c209c8727770631a7b56064e22e4f3040bccac80a6c8b6ead5c1a1017a7c148c295d2fb

data/README.md

@@ -1,26 +1,39 @@
 # Palisade
 
-This gem is in development. Please check back for updates.
+**WARNING! Palisade is still under v1.0 development. However, pieces of what
+I'd like to be v1.0 are working. This document reflects its current state. Feel
+free to use, but use at your own risk.**
 
-## Installation
+## Installation & Configuration
 
-Add this line to your application's Gemfile:
+Palisade is a system gem. Install it globally to your system:
 
-```ruby
-gem 'palisade'
+```text
+$ gem install palisade
 ```
 
-And then execute:
+If you're using `rbenv` or `rvm`, you may need to refresh your `$PATH`. Run
+that command, or simply open a new command line session.
 
-    $ bundle
+We then need to generate a config file:
 
-Or install it yourself as:
+```text
+$ palisade install
+```
 
-    $ gem install palisade
+This will generate a hidden directory -- `.palisade` -- inside your home
+directory. The Palisade directory has only one file -- `config.yml`. This is
+where you place your backup configuration.
 
 ## Usage
 
-TODO: Write usage instructions here
+Once you are configured, you can run backups from the command line.
+
+```text
+$ palisade backup
+```
+
+More automated options coming soon.
 
 ## Contributing
 

data/lib/palisade/backup.rb

@@ -24,17 +24,15 @@ module Palisade
             verify_db_dir(name)
             rsync(config['db'], db_dir(name))
           end
-          if config['assets']
-            method = config['assets']['method']
+          config['assets'].each do |asset_name, data|
+            method = data['method']
             method = 'rsync' if method.nil? || method == ''
             case method
             when 'rsync'
-              config['assets'].each do |asset_name, url|
-                unless asset_name == 'method'
-                  # verify_asset_dir(name, asset_name)
-                  rsync(url, project_dir(name))
-                end
-              end
+              rsync(data['route'], project_dir(name))
+            when 's3cmd'
+              verify_s3_dir(name, asset_name)
+              s3cmd(data['route'], s3_dir(name, asset_name), data['config'])
             end
           end
         end
@@ -44,6 +42,11 @@ module Palisade
         system("rsync #{rsync_options} #{src} #{dest}")
       end
 
+      def s3cmd(src, dest, config = nil)
+        config = "-c #{config}" unless config.nil?
+        system("s3cmd get -vr --skip-existing #{config} s3://#{src}/ #{dest}")
+      end
+
       # ------------------------------------------ Directory Management
 
       def project_dir(name)
@@ -54,9 +57,9 @@ module Palisade
         "#{project_dir(name)}/db"
       end
 
-      # def asset_dir(project_name, asset_name)
-      #   "#{project_dir(project_name)}/#{asset_name}"
-      # end
+      def s3_dir(name, asset_name)
+        "#{project_dir(name)}/#{asset_name}"
+      end
 
       def verify_project_dir(name)
         unless Dir.exists?(project_dir(name))
@@ -70,11 +73,11 @@ module Palisade
         end
       end
 
-      # def verify_asset_dir(project_name, asset_name)
-      #   unless Dir.exists?(asset_dir(project_name, asset_name))
-      #     FileUtils.mkdir_p(asset_dir(project_name, asset_name))
-      #   end
-      # end
+      def verify_s3_dir(name, asset_name)
+        unless Dir.exists?(s3_dir(name, asset_name))
+          FileUtils.mkdir_p(s3_dir(name, asset_name))
+        end
+      end
 
       # ------------------------------------------ Configuration / Options
 

data/lib/palisade/version.rb

@@ -1,3 +1,3 @@
 module Palisade
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/templates/config.yml

@@ -36,19 +36,48 @@ projects:
     # `assets` should stay as it is and have NO VALUE
     # -------------------
     assets:
-      # -------------------
-      # `method` is the method by which we're going to back
-      # up the assets.
-      # 
-      # Options: rsync, s3cmd
-      # 
-      # You should make sure the method you're using is
-      # installed on your machine.
-      # -------------------
-      method: rsync
       # -------------------
       # From here, you can add as many keys as you want, and
-      # each can have their own remote ssh url.
+      # each can have their own remote ssh url. Each key
+      # creates a segmented backup within this project.
+      # 
+      # Note: There should be no value for this key
       # -------------------
-      files:  deploy@192.168.1.1:~/apps/my_app/shared/files
-      uploads: deploy@192.168.1.1:~/apps/my_app/shared/files
+      files: 
+        # -------------------
+        # `method` is the method by which we're going to
+        # back up the assets.
+        # 
+        # Options: rsync, s3cmd
+        # 
+        # You should make sure the method you're using is
+        # installed on your machine.
+        # -------------------
+        method: rsync
+        # -------------------
+        # The route is the full path to the directory to
+        # backup. For rsync, you can use shorthand methods.
+        # -------------------
+        route: deploy@192.168.1.1:~/apps/my_app/shared/files
+      uploads: 
+        # -------------------
+        # This is an example that uses s3cmd to backup an
+        # Amazon S3 bucket.
+        # -------------------
+        method: s3cmd
+        # -------------------
+        # When you use s3cmd, you can point to a custom
+        # configuration file. If you leave this key blank
+        # (or if it's missing), we assume the default
+        # location.
+        # -------------------
+        config: ~/.mys3cfg
+        # -------------------
+        # Although s3cmd routes look this this:
+        # 
+        #     s3://mybucket/path/to/my/files/
+        # 
+        # You should omit the protocol, as we add that
+        # automatically.
+        # -------------------
+        route: mybucket/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: palisade
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean C Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler