alphonse 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 398b75123e0cb97898362fac3068fc5a37400e8b
+  data.tar.gz: e1cb01ef1ed109c4ad532291f1da1f1e95325452
+SHA512:
+  metadata.gz: eac1048f2ab0ac42171c61e9b8184c19015482d4bda0735dcd32003cfb1d9201987301a2d05224128b1ca571d7265db0a6d226697efc2cfca5aa7154f2cc1855
+  data.tar.gz: 03fcd3ecfc1244bd2b38f9e3f0740593a97c736a9176ed7ee563d702c54edf4fa270592cd5425456e75b13429794a1c16ec296d2ec03dafb9e4e281894a34aa6

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Fonzfile

data/.ruby-gemset

@@ -0,0 +1 @@
+alphonse

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alphonse.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Simon Jones
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Alphonse
+
+Deployment gem
+
+## Installation
+
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## Note
+
+Chances are you will experience issues with PATH variables and rubygems etc. So here's a quick solution:
+
+Log in to your deployment server, as a root user, add the following line to /etc/ssh/sshd_config:
+
+    PermitUserEnvironment yes
+
+Don’t forget to restart ssh:
+
+    /etc/init.d/ssh restart
+
+Now, log in as the deployment user, and create ‘~/.ssh/environment’ with the following content:
+
+    PATH=/usr/local/rvm/gems/ruby-2.0.0-p247/bin:/bin:/usr/local/rvm/rubies/ruby-2.0.0-p247/bin:/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+    GEM_HOME=/usr/local/rvm/gems/ruby-2.0.0-p247
+
+*The above paths are for your reference only, obviously you need to work them out for your server environment. The only thing you need to make sure is that the GEM_HOME's path matches one from the PATH.*
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+![May the Fonz be with you](http://lovablelabelsblog.com/wp-content/uploads/2010/03/fonz1.jpg)

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  #spec.rspec_opts = '--order random' need to fix some test to make this randow :( bad tests!
+end
+
+desc 'Default: Run all specs.'
+task :default => :spec

data/alphonse.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alphonse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alphonse"
+  spec.version       = Alphonse::Version::STRING
+  spec.authors       = ["Simon Jones"]
+  spec.email         = ["spj3rd@googlemail.com"]
+  spec.description   = "Deploy like The Fonz"
+  spec.summary       = "Rails deployment made easy."
+  spec.homepage      = "http://simonjones.github.com/alphonse"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "pry", "~> 0.9"
+
+  spec.add_runtime_dependency "net-ssh-session"
+end

data/bin/alphonse

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+
+$:.push File.expand_path("../../lib", __FILE__)
+
+require 'alphonse'
+require 'alphonse/cli'
+
+Alphonse::Cli.start

data/lib/alphonse/cli.rb

@@ -0,0 +1,73 @@
+require 'optparse'
+require 'alphonse/config'
+
+module Alphonse
+  class Cli
+
+    attr_reader :command, :options, :argv
+    attr_accessor :config
+
+    def self.start(argv = ARGV)
+      cli = self.new(argv)
+      cli.execute
+      cli
+    end
+
+    def initialize(argv = [])
+      @argv = argv
+      @options = { :environment => :production }
+
+      @command = option_parser.parse!(@argv).delete_at(0)
+      
+      if @command
+        @command = @command.to_sym
+      else
+        raise CliArgumentError, "An operation is required"
+      end
+    end
+
+    def execute
+      case command
+      when :init
+        Config.init
+      else
+        config = Config.new(options)
+        config.operator.execute(command)
+      end
+    end
+
+    private
+
+    def option_parser
+      @option_parser ||= ::OptionParser.new do |op|
+        op.banner = 'Usage: alphonse <command> [options]'      
+        op.separator ''
+
+        op.on "-e", "--env ENV", "Environment" do |e|
+          @options[:environment] = e.to_sym
+        end
+
+        op.on "--verbose", "Verbose" do
+          $alphonse_log_level = ::Logger::DEBUG
+          @options[:verbose] = true
+        end
+
+        op.on "-f", "--file FONZFILE", "Load a different Fonzfile" do |f|
+          @options[:file_name] = f || 'Fonzfile' 
+        end
+
+        op.on_tail "-h", "--help", "Help" do 
+          puts @option_parser
+          exit
+        end
+
+        op.on_tail "-v", "--version", "Show version" do
+          puts "Alphonse v#{Alphonse::Version::STRING}"
+          exit
+        end
+
+      end
+    end
+
+  end
+end

data/lib/alphonse/config.rb

@@ -0,0 +1,70 @@
+require 'alphonse/operator'
+require 'alphonse/configs/setting'
+require 'alphonse/configs/operation'
+
+module Alphonse
+  class Config < Hash
+    include Alphonse::Configs::Setting
+    include Alphonse::Configs::Operation
+
+    FONZFILE = "./Fonzfile"
+    attr_reader :loaded
+
+    # Initialise the Fonzfile
+    def self.init
+      puts "Fonzie Initialise!"
+
+      pwd = File.dirname(__FILE__)
+      if RUBY_VERSION == /1.8/
+        require 'ftools'
+        File.copy("#{pwd}/default/fonzfile.rb", FONZFILE)
+      else
+        require 'fileutils'
+        ::FileUtils.copy("#{pwd}/default/fonzfile.rb", FONZFILE)
+      end
+    end
+
+    def initialize(options = {})
+      @loaded = false
+      self.merge! options
+      run_fonzfile
+    end
+
+    def operator
+      Operator.new(self)
+    end
+
+
+    def set_attr(hash)
+      config.merge! hash
+    end
+
+    def config
+      self
+    end
+
+    def config_loaded?
+      loaded
+    end
+
+    private
+
+    def run_fonzfile
+      if fonzfile?
+        eval fonzfile.read
+        @loaded = true
+      else
+        raise NoFonzfileError, "No Fonzfile has been found"
+      end
+    end
+
+    def fonzfile?
+      File.exists? config[:file_name] || FONZFILE
+    end
+
+    def fonzfile
+      File.open config[:file_name] || FONZFILE
+    end
+
+  end
+end

data/lib/alphonse/configs/bundler.rb

@@ -0,0 +1,28 @@
+module Alphonse
+  module Configs
+    module Bundler
+      def bundle_exec(command)
+        use_bundle = using_bundler? ? "#{ruby_bin_path}bundle exec " : ""
+        "#{use_bundle}#{command}"
+      end
+
+      def bundle_install
+        "#{ruby_bin_path}bundle install --deployment --without development test" if using_bundler?
+      end
+
+      def rake(command)
+        bundle_exec "rake #{command}"
+      end
+      
+      private
+      
+      def using_bundler?
+        File.exists? "Gemfile"
+      end
+
+      def ruby_bin_path
+        config[:ruby_bin_path] rescue nil
+      end
+    end
+  end
+end

data/lib/alphonse/configs/operation.rb

@@ -0,0 +1,90 @@
+module Alphonse
+  module Configs
+    module Operation
+      
+      attr_reader :command, :description
+
+      def operation(name, description, &block)
+        @command = name
+        set_attr "#{command}_description".to_sym => description
+        block.call if block_given?
+      end
+
+      def tasks(*args)
+        set_attr command.to_sym => args.flatten
+      end
+
+    end
+
+    module Tasks
+      # For testing only
+      def list
+        "ls -a"
+      end
+      alias :ls :list
+
+      def branch
+        config[:branch] || 'master'
+      end
+
+      def repository
+        config[:git_repo]
+      end
+
+      def set_path_variable
+        ["export PATH=#{config[:env_path]}"]
+      end
+
+      def source_shell_rc
+        "source ~/.bashrc"
+      end
+
+      def start_app
+        (config[:start_command] || 'touch tmp/restart.txt')
+      end
+
+      def restart_app
+        (config[:restart_command] || 'touch tmp/restart.txt')
+      end
+
+      def mkdir_path
+        "mkdir -p #{config[:path]}"
+      end
+      alias :setup_directory :mkdir_path
+
+      def cd_to_path
+        "cd #{config[:path]}"
+      end
+      alias :cd :cd_to_path
+
+      def git_pull
+        ["git checkout #{branch} -q", "git pull origin #{branch} -q", "git gc --aggressive"]
+      end
+      alias :gl :git_pull
+      alias :update_repository :git_pull
+
+      def git_clone
+        "git clone #{repository} #{config[:path]}"
+      end
+      alias :gc :git_clone
+      alias :clone_repository :git_clone
+
+      def bundle
+        bundle_install
+      end
+      alias :install_gems :bundle
+
+      def db_setup
+        rake("db:setup RAILS_ENV=#{config[:environment]}")
+      end
+      alias :setup_database :db_setup
+
+      def db_migrate
+        rake("db:migrate RAILS_ENV=#{config[:environment]}")
+      end
+      alias :update_database :db_migrate
+
+
+    end
+  end
+end

data/lib/alphonse/configs/setting.rb

@@ -0,0 +1,48 @@
+module Alphonse
+  module Configs
+    module Setting
+
+      # TODO: evaluate attributes so allow attribute reuse
+      # E.g.
+      #   user = "user_name"
+      #   path = "/full/path/to/#{user}" => "/full/path/to/user_name"
+
+      def user(value)
+        set_attr :user => value
+      end
+
+      def hosts(*value)
+        set_attr :hosts => [*value].flatten
+      end
+
+      def path(value)
+        set_attr :path => value
+      end
+
+      def git_repo(value)
+        set_attr :git_repo => value
+      end
+
+      def branch(value)
+        set_attr :branch => value
+      end
+
+      def env_path(value)
+        set_attr :env_path => value
+      end
+
+      def ruby_bin_path(value)
+        set_attr :ruby_bin_path => value
+      end
+
+      def start_command(value)
+        set_attr :start_command => value
+      end
+
+      def restart_command(value)
+        set_attr :restart_command => value
+      end
+
+    end
+  end
+end

data/lib/alphonse/connection.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require "net/ssh/session"
+
+module Alphonse
+  class Connection
+
+    attr_reader :host, :user, :session, :config
+    def initialize(host, user, config)
+      @config = config
+      @host = host
+      @user = user
+      
+      raise Alphonse::MissingUserError, "User has not been specified" unless user
+      raise Alphonse::MissingHostError, "Host has not been specified" unless host
+      
+      @session = Net::SSH::Session.new(host, user)
+    end
+
+    def connection_string
+      "#{user}@#{host}"
+    end
+
+    def send_and_execute(command = "")
+      commands = parse(command)
+
+      session.open(10)
+      
+      results = []
+      commands.each do |cmd|
+        Alphonse.logger.task cmd
+        result = session.run(cmd)
+        results << result
+        if result.failure?
+          Alphonse.logger.error result.output
+          break
+        else
+          Alphonse.logger.debug result.output if config[:verbose]
+          Alphonse.logger.info "Completed in #{result.duration}s"
+        end
+        
+      end
+      results
+    end
+
+
+    def close
+      session.close
+    end
+    
+    private 
+    
+    def parse(command)
+      case command.class.name
+      when 'String'
+        command == '' ? [] : [command.chomp]
+      when 'Array'
+        command.compact.flatten
+      else
+        raise Alphonse::MissingCommandError, "Command Not a String or Array: #{command.inspect}"
+      end
+    end
+
+  end
+end

data/lib/alphonse/default/fonzfile.rb

@@ -0,0 +1,33 @@
+# Settings
+user 'remote_user'
+hosts 'stage.example.com'
+path "/fullpath/to/folder"
+git_repo 'git@gitaddress:repository.git'
+branch 'master'
+ruby_bin_path '/path/to/ruby/'
+
+operation :setup, 'Setup server' do
+  tasks :setup_directory
+end
+
+operation :deploy, 'Deploy repository' do
+  tasks :clone_repository, :install_gems, :setup_database, :restart_app
+end
+
+operation :update, 'Update the repository on the server' do
+  tasks :update_repository, :install_gems, :update_database, :restart_app
+end
+
+operation :restart, 'Restart application' do
+  tasks :restart_app
+end
+
+
+# Tasks
+  # setup_directory
+  # clone_repository
+  # update_repository
+  # install_gems
+  # setup_database
+  # update_database
+  # restart_app

data/lib/alphonse/logger.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+require 'logger'
+
+module Alphonse
+
+  class Logger < ::Logger
+    TASK = 6
+    SUCCESS = 7
+    OPERATION = 8
+
+    LABELS = %w(DEBUG INFO WARN ERROR FATAL ANY TASK SUCCESS OPERATION)
+
+    def task(progname = nil, &block)
+      add(TASK, nil, progname, &block)
+    end
+
+    def success(progname = nil, &block)
+      add(SUCCESS, nil, progname, &block)
+    end
+
+    def operation(progname = nil, &block)
+      add(OPERATION, nil, progname, &block)
+    end
+
+    private
+
+    def format_severity(severity)
+      LABELS[severity] || 'ANY'
+    end
+
+  end
+  
+
+  class LogFormat
+
+    COLOURS = { 
+      :black    => 30,
+      :red      => 31, 
+      :green    => 32, 
+      :yellow   => 33,
+      :blue     => 34,
+      :magenta  => 35,
+      :cyan     => 36,
+      :white    => 37
+    }
+
+    def call(severity, datetime, progname, message)
+      
+      case severity
+      when "DEBUG"
+        colour("#{progname}::#{severity} - #{message}\n", :yellow)
+      when "WARN"
+        colour("#{progname}::#{severity} - #{message}\n", :yellow)
+      when "TASK"
+        colour("#{progname}::#{severity} - #{underline(message)}\n", :magenta)
+      when "SUCCESS"
+        colour("#{progname}::#{severity} - #{underline(message)}\n", :green)
+      when "OPERATION"
+        colour("#{progname}::#{severity} - #{underline(message)}\n", :cyan)
+      when "ERROR", "FATAL"
+        colour("#{progname}::#{severity} - #{underline(message)}\n", :red)
+      else
+        "#{progname}::#{severity} - #{message}\n\n"
+      end
+    end
+
+    private
+
+    def colour(msg, clr = :black)
+      "\e[#{COLOURS[clr]}m#{msg}\e[0m"
+    end
+
+    def underline(message)
+      "\e[4m#{message}\e[0m"
+    end
+    
+  end
+
+  def self.logger
+    @logger ||= begin
+      logger = Logger.new($stdout)
+      logger.level = $alphonse_log_level || ::Logger::INFO
+      logger.progname = 'Alphonse'
+      logger.formatter = LogFormat.new
+      logger
+    end
+  end
+
+
+end