palisade 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a162b4ca0bdff784635203afb9a5b7a1ce81e0ef
-  data.tar.gz: f7c796718c580058c54ecd8e24f17848f5bd7052
+  metadata.gz: 6be72549c6a94a8a615a45b64ff95cd7903f8ed9
+  data.tar.gz: a82ad1ca51611fdf1dabe77394ac4dd3757f0fed
 SHA512:
-  metadata.gz: 190ee698ade4b69cd481f041892e649441bbab8d19e84c3fdc63cf899de22223fcccab401b2d8d5ccde64eb0c1c6459bb1dcc7f2e448515a268d8b81afd805d8
-  data.tar.gz: 07e662bb8dd030665dd3e830b5e64fb0d2a4af4987cd84682d81151d7fe01687c75af524a7b227a1d7fb23cbd6cca514a629a3352736f6a534e464d97e2a3fb5
+  metadata.gz: 9355ba9498ccc78f80a3ee28cd409b75a2c2ccf226eeb6d1d389561e73290177384a18000a6bf0fa9068280e115e5ca12d0ed8e45e6ae097ad75933383e8e6ae
+  data.tar.gz: 90d516bffa251b4aa31909f27cba7ba48644bdf9f449db717c49c0637a297d51e2456cea2d0b6c25863eaba9663025c0adfa6ef142796cc560e4b37dc7b744f9

data/.gitignore

@@ -12,3 +12,6 @@
 *.o
 *.a
 mkmf.log
+
+# Test backups
+test/backups/

data/bin/palisade

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'palisade/install'
+require 'palisade/backup'
+
+action = ARGV[0]
+
+case action
+when 'install'
+  Palisade::Install.add_config
+when 'backup'
+  Palisade::Backup.backup
+else
+  puts "Usage: palisade [ACTION]"
+end

data/lib/messages/install.txt

@@ -0,0 +1,10 @@
+
+------------------------------
+
+Palisade added a config file here:
+
+    #{@vars[:config_file]}
+
+Edit this file and then start building your wall!
+
+------------------------------

data/lib/palisade/backup.rb

@@ -0,0 +1,110 @@
+require 'yaml'
+require 'fileutils'
+
+module Palisade
+  class Backup
+
+    def initialize
+    end
+
+    def self.backup
+      Palisade::Backup.new.backup
+    end
+
+    def backup
+      do_the_backup
+    end
+
+    private
+
+      def do_the_backup
+        projects.each do |name, config|
+          verify_project_dir(name)
+          if config['db']
+            verify_db_dir(name)
+            rsync(config['db'], db_dir(name))
+          end
+          if config['assets']
+            method = config['assets']['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
+            end
+          end
+        end
+      end
+
+      def rsync(src, dest)
+        system("rsync #{rsync_options} #{src} #{dest}")
+      end
+
+      # ------------------------------------------ Directory Management
+
+      def project_dir(name)
+        "#{dest_root}/#{name}"
+      end
+
+      def db_dir(name)
+        "#{project_dir(name)}/db"
+      end
+
+      # def asset_dir(project_name, asset_name)
+      #   "#{project_dir(project_name)}/#{asset_name}"
+      # end
+
+      def verify_project_dir(name)
+        unless Dir.exists?(project_dir(name))
+          FileUtils.mkdir_p(project_dir(name))
+        end
+      end
+
+      def verify_db_dir(name)
+        unless Dir.exists?(db_dir(name))
+          FileUtils.mkdir_p(db_dir(name))
+        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
+
+      # ------------------------------------------ Configuration / Options
+
+      def config_file
+        @config_file ||= "#{`echo $HOME`.strip}/.palisade/config.yml"
+      end
+
+      def load_config
+        @load_config ||= YAML.load_file(config_file)
+      end
+
+      def config
+        @config ||= load_config['config']
+      end
+
+      def projects
+        @projects ||= load_config['projects']
+      end
+
+      def dest_root
+        @dest_root ||= config['root']
+      end
+
+      def rsync_options
+        @rsync_options ||= '-chavz --stats'
+      end
+
+      def daystamp
+        @daystamp ||= Time.now.strftime('%d')
+      end
+
+  end
+end

data/lib/palisade/install.rb

@@ -0,0 +1,60 @@
+require 'fileutils'
+require 'palisade/message'
+
+module Palisade
+  class Install
+
+    def initialize
+    end
+
+    def self.add_config
+      Palisade::Install.new.add_config
+    end
+
+    def add_config
+      mk_config_dir
+      copy_config_file
+      print_install_message
+    end
+
+    private
+
+      def home_dir
+        `echo $HOME`.strip
+      end
+
+      def config_dir
+        "#{home_dir}/.palisade"
+      end
+
+      def config_file
+        "#{config_dir}/config.yml"
+      end
+
+      def config_template
+        File.expand_path('../../templates/config.yml', __FILE__)
+      end
+
+      def mk_config_dir
+        unless Dir.exists?(config_dir)
+          FileUtils.mkdir(config_dir)
+        end
+      end
+
+      def copy_config_file
+        unless File.exists?(config_file)
+          system("cp #{config_template} #{config_file}")
+        end
+      end
+
+      def print_install_message
+        Palisade::Message.print(
+          :install, 
+          {
+            :config_file => config_file 
+          }
+        )
+      end
+
+  end
+end

data/lib/palisade/message.rb

@@ -0,0 +1,28 @@
+module Palisade
+  class Message
+
+    def initialize(name, vars = {})
+      @name = name
+      @vars = vars
+    end
+
+    def self.print(name, vars = {})
+      Palisade::Message.new(name.to_s, vars).print
+    end
+
+    def print
+      puts template_contents
+    end
+
+    private
+
+      def template_file
+        File.expand_path("../../messages/#{@name}.txt", __FILE__)
+      end
+
+      def template_contents
+        eval('"' + File.read(template_file) + '"')
+      end
+
+  end
+end

data/lib/palisade/version.rb

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

data/lib/palisade.rb

@@ -1,5 +1,4 @@
 require "palisade/version"
 
 module Palisade
-  # Your code goes here...
 end

data/lib/templates/config.yml

@@ -0,0 +1,54 @@
+# -------------------
+# This is your main configuration file for Palisade. It
+# drives the backups run by Palisade. Edit this to your
+# liking and then start backing up!
+# -------------------
+config:
+  # -------------------
+  # This is the root path to where your backups should be
+  # stored.
+  # 
+  # This path should be accessible whenever the computer is
+  # on. So, if it's an external drive, you'll need to make
+  # sure it's always connected.
+  # -------------------
+  root: /path/to/my/backups
+# -------------------
+# This is where you store your backup settings. Each backup
+# is broken down as a project, which can have assets (files)
+# and a database. See the example below.
+# -------------------
+projects:
+  # -------------------
+  # The key should be a unique identifier for the project. 
+  # -------------------
+  my_first_project:
+    # -------------------
+    # `db` is the path to the database. If it is remote, use
+    # a full ssh url. You can use ssh config shorthand
+    # methods.
+    # 
+    # Note: You'll need a nightly dump of this database for
+    # this to work.
+    # -------------------
+    db: myserver.com:~/backups/my_app_production.sql
+    # -------------------
+    # `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.
+      # -------------------
+      files:  deploy@192.168.1.1:~/apps/my_app/shared/files
+      uploads: deploy@192.168.1.1:~/apps/my_app/shared/files

data/palisade.gemspec

@@ -18,6 +18,21 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.post_install_message = "
+  ------------------------------
+
+  Thanks for installing Palisade! 
+
+  Before you start building your wall, you need to install a
+  config file. Don't forget to run this command:
+
+      palisade install
+
+  And then edit the config file!
+
+  ------------------------------
+  "
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: palisade
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sean C Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -41,7 +41,8 @@ dependencies:
 description: Automate regular backups of remote data.
 email:
 - scdavis41@gmail.com
-executables: []
+executables:
+- palisade
 extensions: []
 extra_rdoc_files: []
 files:
@@ -50,14 +51,23 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/palisade
+- lib/messages/install.txt
 - lib/palisade.rb
+- lib/palisade/backup.rb
+- lib/palisade/install.rb
+- lib/palisade/message.rb
 - lib/palisade/version.rb
+- lib/templates/config.yml
 - palisade.gemspec
 homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n  ------------------------------\n\n  Thanks for installing
+  Palisade! \n\n  Before you start building your wall, you need to install a\n  config
+  file. Don't forget to run this command:\n\n      palisade install\n\n  And then
+  edit the config file!\n\n  ------------------------------\n  "
 rdoc_options: []
 require_paths:
 - lib