baboon 1.0.8 → 1.0.9

data/lib/baboon.rb

@@ -4,23 +4,10 @@
 # are persisted throughout the entire Baboon configuration and as well
 # as the config initializer baboon.rb file that is generated in the
 # standing Rails application.
-# 
-# option[:application]  String  => Has no berrance to the deployment, call it whatever.
-# option[:repository]   String  => For now baboon only supports Git. This should be the actual Git repository of the application baboon will deploy.
-# option[:deploy_path]  String  => The actual deploy path the application will sit at on the server. Exactly where the app's .git/ folder would be.
-# option[:deploy_user]  String/Symbol   => The user baboon will be authenticating with on the server. Should have your key stored for optimal authentication.
-# option[:branch]       String/Symbol   => The branch on your repository baboon will be pulling from.
-# option[:rails_env]    String/Symbol   => For rake tasks to be run properly on your server, baboon needs to know what env it will be running on your server.
-# option[:server]       Array[String]   => This will be an array of ip addresses of the servers baboon will deploy to.
-BABOON_CONFIGURATION_OPTIONS = [
-  :application,       # => This will be the name of the Application - not the directory
-  :repository,        # => This will be the :scm of the repository the application will be cloning
-  :deploy_path,       # => This will be the actual deploy path of the application, should have /home/#{user}/app
-  :deploy_user,       # => This will be the user the system will authenticate with to do the deploy, should have sudo
-  :branch,            # => Branch we will be cloning from on GIT
-  :rails_env,         # => The rails environment the sever will be running
-  :servers            # => An array of servers baboon will push to
-]
+
+# Nicely formatted output of the Baboon title
+BABOON_TITLE = "\033[22;31mB\033[22;35ma\033[22;36mb\033[22;32mo\033[01;31mo\033[01;33mn\033[22;37m"
+BABOON_ENVIRONMENT_SETTINGS = ['branch', 'deploy_path', 'deploy_user', 'rails_env', 'servers']
 
 require 'baboon/configuration'
 require 'baboon/cli'

data/lib/baboon/cli.rb

@@ -1,87 +1,18 @@
 require 'baboon'
 require 'baboon/configuration'
-require 'baboon/logger'
+require 'baboon/util'
 
 require 'find'
 require 'net/ssh'
 require 'thor'
+require 'yaml'
 
-module Baboon
-  class Error
-    class << self
-      # stop
-      # @param:
-      # @return: StandardError class, will halt execution of program
-      def stop reason
-        raise StandardError, reason
-      end
-    end
-  end
-  
-  class Util
-    class << self
-      # file_check!
-      # @param: String file path
-      # @return: Boolean || String depending on if file is found
-      def file_check! file
-        return false if file.nil? || !file
-        
-      end
-      
-      # locate_file
-      # Will try and locate the baboon.rb file it it does not exist. Great method
-      # used especially for testing Baboon.
-      # @param:
-      # @return: String[file path, used to locate and initialize the configuration file]
-      def locate_file
-        config_file = ''
-        default_baboon_file_path = "config/initializers/baboon.rb"
-        if File.exists?(default_baboon_file_path)
-          config_file = default_baboon_file_path
-        else
-          Find.find('.') do |path|
-            if path.include?('baboon.rb') 
-              next unless File.open(path, &:readline).include?('Baboon.configure do |config|')
-              config_file = path
-              break
-            end
-          end
-        end
-        config_file
-      end
-      
-      # read_configuration
-      # This will attempt to read the configuration file, only need until after the file
-      # is found in the application.
-      # @param: String[file path, relative to the directory of the configuration]
-      # @return: Hash[configuration options in the config file, use these to set Baboon.configuration]
-      def read_configuration(file)
-        configuration = []
-        line_number = 0
-        text = File.open(file).read
-        text.gsub!(/\r\n?/, '\n')
-
-        text.each_line do |line|
-          next if line.include?('Baboon.configure')
-          next if line.include?('end')
-          line.gsub!(/^(.*)\s=\s/, '')
-          line.gsub!('\'', '')
-          line.strip!
-          
-          configuration << { BABOON_CONFIGURATION_OPTIONS[line_number] => line }
-          line_number += 1
-        end
-        
-        return configuration.reduce({}, :merge)
-      end
-    end
-  end
-  
+module Baboon  
   class Cli < Thor
     # @logger: call an instance of the logger class, use throughout baboon
     # @configuration: holds the default baboon configuration set in config file
     # @configuration_file: the exact file location of baboon configuration
-    attr_accessor :logger, :configuration, :configuration_file, :block
+    attr_accessor :configuration, :configuration_file, :stop
 
     # initialize
     # @param: Array
@@ -89,92 +20,93 @@ module Baboon
     def initialize(*args)
       super
       $stdout.sync ||= true
-      @logger ||= Logger.new({level: 3, disable_formatters: false})
+      
+      # Set our yaml engine
+      YAML::ENGINE.yamler = 'syck'
       
       # Attempt to locate the configuration file in the project if it was not set.
       @configuration_file = Util.locate_file
       
       # Return if file not found
       if @configuration_file.nil? ||  @configuration_file == ''
-        printf "\033[22;31mB\033[22;35ma\033[22;36mb\033[22;32mo\033[01;31mo\033[01;33mn\033[22;37m - version #{Baboon::VERSION}\n"
-        printf "  \033[22;31mError:\033[22;37m no configuration file is present anywhere in the application or at config/initializers/baboon.rb\n"
+        printf "#{BABOON_TITLE}\n"
+        printf "  \033[22;31mError:\033[22;37m no configuration file is present anywhere in the application or at config/baboon.yml\n"
         printf "  \033[01;32mUsage:\033[22;37m rails g baboon:install\n"
-        @block = true
+        @stop = true  
         return
       end
       
-      # Load the users baboon configuration
-      if File.exists?(@configuration_file) # tad redundant
-        @configuration = Util.read_configuration(@configuration_file)
-        
-        # configure the servers
-        Baboon.configure do |config|
-          config.application  = @configuration[:application]
-          config.repository   = @configuration[:repository]
-          config.deploy_path  = @configuration[:deploy_path]
-          config.deploy_user  = @configuration[:deploy_user]
-          config.branch       = @configuration[:branch]
-          config.rails_env    = @configuration[:rails_env]
-          config.servers      = @configuration[:servers].gsub('[', '').gsub(']', '').split(',').collect(&:strip)
-        end      
-      else
-        printf "\033[22;31mB\033[22;35mA\033[22;36mB\033[22;32mO\033[01;31mO\033[01;33mN\033[22;37m - version #{Baboon::VERSION}\n"
-        printf "  \033[22;31mError:\033[22;37m no configuration file is present anywhere in the application or at config/initializers/baboon.rb\n"
-        printf "  \033[01;32mUsage:\033[22;37m rails g baboon:install\n"
-        @block = true
-        return
+      # Load the file now that we know its not nil
+      @configuration = YAML.load_file(@configuration_file)
+      
+      # Double check that configuration is setup properly
+      if @configuration['baboon'].has_key?('environments')
+        @configuration['baboon']['environments'].map do |environment|
+          hash = Hash[*environment]
+          key  = hash.keys.first
+          
+          # Must have all defined keys filled out
+          unless BABOON_ENVIRONMENT_SETTINGS.collect { |k| hash[key].has_key?(k) }.all?
+            printf "#{BABOON_TITLE}\n"
+            printf "  \033[22;31mError:\033[22;37m incorrect settings for the \"#{key}\" in config/baboon.yml\n"
+            printf "  \033[01;32mUsage:\033[22;37m rails g baboon:install\n"
+            @stop = true
+            return
+          end
+        end
       end
     end
     
-    desc "deploy", "Deploys the application to the configured servers."
-    def deploy
-      return if @block
-      printf @logger.format("== Baboon starting deploy", "32", 1)
+    desc "deploy ENVIRONMENT", "Deploys the application to the configured servers."
+    def deploy environment
+      return if @stop   
       
-      # Loop through each server and do deploy, we will add threading later to do simultaneous deploys
-      Baboon.configuration.servers.each do |server|     
-        current = server.to_s.strip
-        
-        printf @logger.format("== [#{current}]", "35", 1) 
+      # Double checked the user typed the correct key
+      unless @configuration['baboon']['environments'].has_key?(environment)
+        printf "#{BABOON_TITLE}\n"
+        printf "  \033[22;31mError:\033[22;37m looks like you typed an incorrect key for an environment you specified in your baboon.yml file\n"
+        printf "  \033[01;32mUsage:\033[22;37m try one of these #{@configuration['baboon']['environments'].keys}\n"
+        @stop = true
+        return
+      end
+      
+      # Get the current config for this environment
+      current_environment_configuration = @configuration['baboon']['environments'][environment]
+      
+      # Loop through the servers
+      current_environment_configuration['servers'].each do |host|
+        printf "Deploying[#{host}]"
         
-        # Essentially these are the instructions we need run for the Ubuntu 11.04 for rails
         # TODO: add lib of different instruction sets for Play framework, nodejs, etc
         instructions = [
-          "cd '#{Baboon.configuration.deploy_path}' && git fetch",
-          "cd '#{Baboon.configuration.deploy_path}' && git checkout #{Baboon.configuration.branch.to_s}",
-          "cd '#{Baboon.configuration.deploy_path}' && git merge origin/#{Baboon.configuration.branch.to_s}",
-          "cd '#{Baboon.configuration.deploy_path}' && bundle install --deployment",
-          "cd '#{Baboon.configuration.deploy_path}' && touch tmp/restart.txt"
+          "cd '#{current_environment_configuration['deploy_path']}' && git fetch",
+          "cd '#{current_environment_configuration['deploy_path']}' && git checkout #{current_environment_configuration['branch']}",
+          "cd '#{current_environment_configuration['deploy_path']}' && git merge origin/#{current_environment_configuration['branch']}",
+          "cd '#{current_environment_configuration['deploy_path']}' && bundle install --deployment",
+          "cd '#{current_environment_configuration['deploy_path']}' && touch tmp/restart.txt"
         ]
-      
+        
         # Vars for connecting via ssh to the server
         credentials = { 
-          user: Baboon.configuration.deploy_user.to_s, 
-          host: current
+          user: current_environment_configuration['deploy_user'], 
+          host: host
         }
-            
+        
+        # Start the connection and excute command
         Net::SSH.start(credentials[:host], credentials[:user]) do |session|
           instructions.each do |instruction|
-            printf "[#{current}]: #{instruction}\n"
+            printf "[#{host}]: #{instruction}\n"
             session.exec instruction
             session.loop
           end
         end
-      end # Looping servers
-      
-      printf @logger.format("== Baboon deploy Complete", "31", 1)
-    end
+      end   
+    end # def deploy
 
     desc "configuration", "Shows the current configuration for baboon."
     def configuration    
-      return if @block  
-      printf @logger.format("Baboon[Application]: #{Baboon.configuration.application}", "37", 1)
-      printf @logger.format("Baboon[Repository]: #{Baboon.configuration.repository}", "37", 1)
-      printf @logger.format("Baboon[Deploy_path]: #{Baboon.configuration.deploy_path}", "37", 1)
-      printf @logger.format("Baboon[Deploy_user]: #{Baboon.configuration.deploy_user}", "37", 1)
-      printf @logger.format("Baboon[Branch]: #{Baboon.configuration.branch}", "37", 1)
-      printf @logger.format("Baboon[Rails_env]: #{Baboon.configuration.rails_env}", "37", 1)
-      printf @logger.format("Baboon[Servers]: #{Baboon.configuration.servers}", "37", 1)
+      return if @stop
+      puts @configuration.inspect
     end
   end
 end

data/lib/baboon/exception.rb

@@ -0,0 +1,10 @@
+module Baboon
+  class Exception < StandardError
+    attr_reader :response
+
+    def initialize response
+      @response = response
+      super
+    end
+  end
+end

data/lib/baboon/instructions/rails.rb

@@ -0,0 +1,7 @@
+module Baboon
+  module Instructions
+    class Rails
+      
+    end
+  end
+end

data/lib/baboon/util.rb

@@ -0,0 +1,33 @@
+module Baboon
+  class Util
+    class << self
+      # file_check!
+      # @param: String file path
+      # @return: Boolean || String depending on if file is found
+      def file_check! file
+        return false if file.nil? || !file
+      end
+      
+      # locate_file
+      # Will try and locate the baboon.rb file it it does not exist. Great method
+      # used especially for testing Baboon.
+      # @param:
+      # @return: String[file path, used to locate and initialize the configuration file]
+      def locate_file
+        config_file = ''
+        default_baboon_file_path = "config/baboon.yml"
+        if File.exists?(default_baboon_file_path)
+          config_file = default_baboon_file_path
+        else
+          Find.find('.') do |path|
+            if path.include?('baboon.yml') 
+              config_file = path
+              break
+            end
+          end
+        end
+        config_file
+      end 
+    end # class << self
+  end # class Util
+end # module Baboon

data/lib/baboon/version.rb

@@ -1,3 +1,3 @@
 module Baboon
-  VERSION = '1.0.8'
+  VERSION = '1.0.9'
 end

data/lib/generators/baboon/install/install_generator.rb

@@ -3,14 +3,11 @@ require 'rails/generators/base'
 module Baboon
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      desc 'Creates an initializer for Baboon at config/initializers/baboon.rb'
-
-      def self.source_root
-        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
-      end
-
+      desc 'Creates an initializer for Baboon at config/baboon.yml'
+      source_root File.expand_path('../templates', __FILE__)
+      
       def create_initializer_file
-        template "baboon.rb", "config/initializers/baboon.rb"
+        template 'baboon.yml', 'config/baboon.yml'
       end
     end
   end

data/lib/generators/baboon/install/templates/baboon.yml

@@ -0,0 +1,52 @@
+baboon:
+  # Give you application a descriptive name, has no effect on the actual
+  # running path or location of your application. Can be different then
+  # what is stored in your scm.
+  application:  'Vacuum HQ'
+
+  # For now, Baboon will determine what scm the remote code is stored in
+  # based on the scm path. For now, GIT and SVN are the two supported 
+  # scm applications that are supported.
+  repository:   'git@github.com:amanelis/vacuum.git'
+
+  # Pass multiple environments in this section. When running a standard
+  # 'baboon deploy' all defined hosts here will be deployed to. You can
+  # specify which host you want to deploy to by typing that as a param
+  # in the command 'baboon deploy development'.
+  environments:
+    # Name each environment to your own standard. Baboon, will use the 
+    # settings defined after the env to to the deploy.
+    staging:
+      # Branch that the baboon will merge code in from the remote scm
+      # baboon['repository'] url that is defined in this file.
+      branch: 'staging'
+
+      # This is the actual path on the server where the root of the 
+      # application is stored, not where /public is in terms of a rails
+      # setup.
+      deploy_path: '/home/rails/vacuum'
+ 
+      # This is the actual user that baboon will use for SSH authentication
+      # into the servers that are defined here. 
+      deploy_user: 'rails'
+
+      # Env that we will run all rake/bundler commands with.
+      rails_env: 'staging'
+
+      # These are the host machines that baboon will ssh into on each deploy.
+      # They can be defined as an ip address or a host name
+      servers:
+        - '127.0.0.1'
+        - '127.0.0.2'
+          
+    # You can define as many different environments as needed to your application
+    production:
+      branch: 'production'
+      deploy_path: '/home/rails/vacuum'
+      deploy_user: 'rails'
+      rails_env: 'production'
+      servers:
+        - '10.0.0.1'
+        - '10.0.0.2'
+        - '10.0.0.3'
+        - 'production.node1.east.com'

data/spec/spec_helper.rb

@@ -11,8 +11,6 @@ Dir["spec/support/**/*.rb"].each { |f| require f }
 PROJECT_ROOT = File.expand_path('../..', __FILE__)
 $LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
 
-$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
-
 RSpec.configure do |config|
   config.color_enabled = true
   config.tty = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: baboon
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -248,14 +248,17 @@ files:
 - lib/baboon/cli/options.rb
 - lib/baboon/cli.rb
 - lib/baboon/configuration.rb
+- lib/baboon/exception.rb
+- lib/baboon/instructions/rails.rb
 - lib/baboon/logger.rb
+- lib/baboon/util.rb
 - lib/baboon/version.rb
 - lib/baboon.rb
 - lib/core_ext/string.rb
 - lib/generators/baboon/config/config_generator.rb
 - lib/generators/baboon/config/templates/baboon.yml
 - lib/generators/baboon/install/install_generator.rb
-- lib/generators/baboon/install/templates/baboon.rb
+- lib/generators/baboon/install/templates/baboon.yml
 - spec/lib/baboon/cli_spec.rb
 - spec/lib/baboon/configuration_spec.rb
 - spec/lib/baboon_spec.rb
@@ -277,7 +280,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4459336840231193725
+      hash: 1179810549053676199
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -286,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4459336840231193725
+      hash: 1179810549053676199
 requirements: []
 rubyforge_project: baboon
 rubygems_version: 1.8.24

data/lib/generators/baboon/install/templates/baboon.rb

@@ -1,9 +0,0 @@
-Baboon.configure do |config|
-  config.application  = 'NAME OF YOUR APPLICATION'
-  config.repository   = 'git@github.com:{some-project}.git'
-  config.deploy_path  = '{path_to_application_on_server}'
-  config.deploy_user  = 'rails'
-  config.branch       = 'master'
-  config.rails_env    = 'production'
-  config.servers      = ['server_1', 'server_2']
-end