statistrano 1.2.0

data/lib/statistrano/deployment/strategy.rb

@@ -0,0 +1,37 @@
+module Statistrano
+  module Deployment
+    module Strategy
+
+      class << self
+
+        def registered
+          @_registered ||= {}
+        end
+
+        def register deployment, name
+          registered[name.to_sym] = deployment
+        end
+
+        def find name
+          registered.fetch(name.to_sym) do
+            raise UndefinedStrategy, "no strategies are registered as :#{name}"
+          end
+        end
+
+      end
+
+      class UndefinedStrategy < StandardError
+      end
+
+    end
+  end
+end
+
+# strategy utils
+require_relative 'strategy/invoke_tasks'
+require_relative 'strategy/check_git'
+
+# strategies
+require_relative 'strategy/base'
+require_relative 'strategy/branches'
+require_relative 'strategy/releases'

data/lib/statistrano/deployment.rb

@@ -0,0 +1,10 @@
+# deployment utils
+require_relative 'deployment/manifest'
+require_relative 'deployment/log_file'
+require_relative 'deployment/rake_tasks'
+require_relative 'deployment/registerable'
+
+
+# deployment types
+require_relative 'deployment/strategy'
+require_relative 'deployment/releaser'

data/lib/statistrano/log/default_logger.rb

@@ -0,0 +1,105 @@
+module Statistrano
+  class Log
+
+
+    # Error, Warning and Message Logging
+    class DefaultLogger
+
+      def info *msg
+        status, msg = extract_status "", *msg
+
+        case status
+        when :success then
+          color = :green
+        else
+          color = :bright
+        end
+
+        to_stdout status, color, *msg
+      end
+      alias_method :debug, :info
+
+      def warn *msg
+        status, msg = extract_status "warning", *msg
+        to_stdout status, :yellow, *msg
+      end
+
+      def error *msg
+        status, msg = extract_status "error", *msg
+        to_stderr status, :red, *msg
+      end
+      alias_method :fatal, :error
+
+      private
+
+        def extract_status default, *msg
+          if msg.first.is_a? Symbol
+            status = msg.shift
+          else
+            status = default
+          end
+          [status, msg]
+        end
+
+        def to_stdout status, color, *msg
+          $stdout.puts "#{Formatter.new(status, color, *msg).output}"
+          $stdout.flush
+        end
+
+        def to_stderr status, color, *msg
+          $stderr.puts "#{Formatter.new(status, color, *msg).output}"
+          $stderr.flush
+        end
+
+      class Formatter
+        attr_reader :width, :status, :color, :msgs
+
+        def initialize status, color, *msg
+          @width  = 14
+          @status = status.to_s
+          @color  = color
+          @msgs   = msg
+        end
+
+        def output
+          Rainbow(anchor).bright + padding + Rainbow(status).public_send(color) + formatted_messages
+        end
+
+        private
+
+          def anchor
+            "-> "
+          end
+
+          def padding
+            num = (width - status.length)
+
+            if num < 0
+              @width = status.length + 1
+              return spaces(0)
+            else
+              return spaces num
+            end
+          end
+
+          def spaces num
+            Array.new(num).join(" ")
+          end
+
+          def formatted_messages
+            messages = []
+            msgs.each_with_index do |msg, idx|
+              if idx == 0
+                messages << " #{msg}"
+              else
+                messages << "#{spaces( anchor.length + width )} #{msg}"
+              end
+            end
+            messages.join("\n")
+          end
+      end
+
+    end
+
+  end
+end

data/lib/statistrano/log.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+require_relative 'log/default_logger'
+
+module Statistrano
+
+  # interface should match the ruby logger
+  # so we will implement:
+  #
+  # => fatal
+  # => error
+  # => warn
+  # => info
+  # => debug
+  #
+  # note that DefaultLogger does accept multiline logs
+  # as *args so you will need a wrapper for some logging libraries
+
+  class Log
+    extend SingleForwardable
+    def_delegators :logger_instance, :fatal, :error, :warn, :info, :debug
+
+    class << self
+      def set_logger logger
+        @_logger = logger
+      end
+
+      def logger_instance
+        @_logger ||= DefaultLogger.new
+      end
+    end
+  end
+
+end

data/lib/statistrano/remote/file.rb

@@ -0,0 +1,79 @@
+module Statistrano
+  class Remote
+
+    class File
+
+      attr_reader :path, :remote, :permissions
+
+      def initialize path, remote, permissions=644
+        @path   = path
+        @remote = remote
+        @permissions = permissions
+      end
+
+      def content
+        resp = remote.run "cat #{path}"
+        if resp.success?
+          resp.stdout
+        else
+          ""
+        end
+      end
+
+      def update_content! new_content
+        create_remote_file unless remote_file_exists?
+        resp = remote.run "echo '#{new_content}' > #{path}"
+
+        if resp.success?
+          Log.info :success, "file at #{path} on #{remote.config.hostname} saved"
+        else
+          Log.error "problem saving the file #{path} on #{remote.config.hostname}",
+                    resp.stderr
+        end
+      end
+
+      def append_content! new_content
+        create_remote_file unless remote_file_exists?
+        resp = remote.run "echo '#{new_content}' >> #{path}"
+
+        if resp.success?
+          Log.info :success, "appended content to file at #{path} on #{remote.config.hostname}"
+        else
+          Log.error "problem appending content to file at #{path} on #{remote.config.hostname}",
+                    resp.stderr
+        end
+      end
+
+      def destroy!
+        resp = remote.run "rm #{path}"
+        if resp.success?
+          Log.info :success, "file at #{path} on #{remote.config.hostname} removed"
+        else
+          Log.error "failed to remove #{path} on #{remote.config.hostname}",
+                    resp.stderr
+        end
+      end
+
+      private
+
+        def remote_file_exists?
+          resp = remote.run "[ -f #{path} ] && echo \"exists\""
+          resp.success? && resp.stdout.strip == "exists"
+        end
+
+        def create_remote_file
+          resp = remote.run "touch #{path} " +
+                            "&& chmod #{permissions} #{path}"
+
+          if resp.success?
+            Log.info :success, "created file at #{path} on #{remote.config.hostname}"
+          else
+            Log.error "problem creating file at #{path} on #{remote.config.hostname}",
+                      resp.stderr
+          end
+        end
+
+    end
+
+  end
+end

data/lib/statistrano/remote.rb

@@ -0,0 +1,111 @@
+require_relative 'remote/file'
+
+module Statistrano
+
+  # a remote is a databag of config specific for an
+  # individual target for deployment
+  # including it's own ssh connection to it's target server
+  class Remote
+
+    attr_reader :config
+
+    def initialize config
+      @config = config
+      raise ArgumentError, "a hostname is required" unless config.hostname
+    end
+
+    def test_connection
+      Log.info "testing connection to #{config.hostname}"
+
+      resp = run 'whoami'
+      done
+
+      if resp.success?
+        Log.info "#{config.hostname} says \"Hello #{resp.stdout.strip}\""
+        return true
+      else
+        Log.error "connection failed for #{config.hostname}",
+                  resp.stderr
+        return false
+      end
+    end
+
+    def run command
+      if config.verbose
+        Log.info :"#{config.hostname}", "running cmd: #{command}"
+      end
+
+      session.run command
+    end
+
+    def done
+      session.close_session
+    end
+
+    def create_remote_dir path
+      unless path[0] == "/"
+        raise ArgumentError, "path must be absolute"
+      end
+
+      Log.info "Setting up directory at '#{path}' on #{config.hostname}"
+      resp = run "mkdir -p -m #{config.dir_permissions} #{path}"
+      unless resp.success?
+        Log.error "Unable to create directory '#{path}' on #{config.hostname}",
+                  resp.stderr
+        abort()
+      end
+    end
+
+    def rsync_to_remote local_path, remote_path
+      local_path  = local_path.chomp("/")
+      remote_path = remote_path.chomp("/")
+
+      Log.info "Syncing files from '#{local_path}' to '#{remote_path}' on #{config.hostname}"
+
+      time_before = Time.now
+      resp = Shell.run_local "rsync #{rsync_options} " +
+                             "-e ssh #{local_path}/ " +
+                             "#{host_connection}:#{remote_path}/"
+      time_after = Time.now
+      total_time = (time_after - time_before).round(2)
+
+      if resp.success?
+        Log.info :success, "Files synced to remote on #{config.hostname} in #{total_time}s"
+      else
+        Log.error "Error syncing files to remote on #{config.hostname}",
+                  resp.stderr
+      end
+
+      resp
+    end
+
+    private
+
+      def session
+        @_ssh_session ||= HereOrThere::Remote.session ssh_options
+      end
+
+      def ssh_options
+        ssh_options = { hostname: config.hostname }
+        [ :user, :password, :keys, :forward_agent ].each do |key|
+          ssh_options[key] = config.public_send(key) if config.public_send(key)
+        end
+
+        return ssh_options
+      end
+
+      def host_connection
+        config.user ? "#{config.user}@#{config.hostname}" : config.hostname
+      end
+
+      def rsync_options
+        dir_perms  = Util::FilePermissions.new( config.dir_permissions ).to_chmod
+        file_perms = Util::FilePermissions.new( config.file_permissions ).to_chmod
+
+        "#{config.rsync_flags} --chmod=" +
+            "Du=#{dir_perms.user},Dg=#{dir_perms.group},Do=#{dir_perms.others}," +
+            "Fu=#{file_perms.user},Fg=#{file_perms.group},Fo=#{file_perms.others}"
+      end
+
+  end
+end

data/lib/statistrano/shell.rb

@@ -0,0 +1,17 @@
+module Statistrano
+  module Shell
+
+    class << self
+      include HereOrThere
+
+      # get input from the command line
+      # @return [String]
+      def get_input message
+        print message
+        $stdin.gets.chomp
+      end
+
+    end
+
+  end
+end

data/lib/statistrano/util/file_permissions.rb

@@ -0,0 +1,34 @@
+module Statistrano
+  module Util
+
+    class FilePermissions
+
+      attr_reader :user, :group, :others
+
+      def initialize int
+        @user, @group, @others = int.to_s.chars.to_a
+      end
+
+      def to_chmod
+        Struct.new(:user, :group, :others)
+              .new( chmod_map(user), chmod_map(group), chmod_map(others) )
+      end
+
+      private
+
+        def chmod_map num
+          {
+            "7" => "rwx",
+            "6" => "rw",
+            "5" => "rx",
+            "4" => "r",
+            "3" => "wx",
+            "2" => "w",
+            "1" => "x",
+            "0" => "-"
+          }.fetch num
+        end
+    end
+
+  end
+end

data/lib/statistrano/util.rb

@@ -0,0 +1,27 @@
+require_relative 'util/file_permissions'
+
+module Statistrano
+  module Util
+
+    class << self
+
+      def symbolize_hash_keys hash
+        hash.inject({}) do |out, (key, value)|
+          k = case key
+              when String then key.to_sym
+              else key
+              end
+          v = case value
+              when Hash  then symbolize_hash_keys(value)
+              when Array then value.map { |h| symbolize_hash_keys(h) }
+              else value
+              end
+          out[k] = v
+          out
+        end
+      end
+
+    end
+
+  end
+end

data/lib/statistrano/version.rb

@@ -0,0 +1,3 @@
+module Statistrano
+  VERSION = "1.2.0"
+end

data/lib/statistrano.rb

@@ -0,0 +1,55 @@
+# stdlib
+require 'json'
+require 'forwardable'
+require 'fileutils'
+require 'benchmark'
+
+# libraries
+require 'rainbow'
+require 'rake'
+require 'slugity/extend_string'
+require 'here_or_there'
+require 'asgit'
+
+# utility modules
+require_relative 'statistrano/util'
+require_relative 'statistrano/shell'
+require_relative 'statistrano/log'
+
+# deployment modules
+require_relative 'statistrano/config'
+require_relative 'statistrano/remote'
+require_relative 'statistrano/deployment'
+
+
+# DSL for defining deployments of static files
+#
+# == Define a server
+#
+#     define_deployment "foo" do |config|
+#       config.attribute = value
+#     end
+#
+module Statistrano::DSL
+
+  # Define a deployment
+  # @param [String] name of the deployment
+  # @param [Symbol] type of deployment
+  # @return [Statistrano::Deployment::Base]
+  def define_deployment name, type=:base, &block
+    deployment = ::Statistrano::Deployment::Strategy.find(type).new( name )
+
+    if block_given?
+      if block.arity == 1
+        yield deployment.config
+      else
+        deployment.config.instance_eval &block
+      end
+    end
+
+    return deployment
+  end
+
+end
+
+include Statistrano::DSL