webbynode 0.2.5.beta2 → 1.0.0

data/Manifest

@@ -1,6 +1,4 @@
-History.txt
 Manifest
-Manifest.txt
 PostInstall.txt
 README.rdoc
 Rakefile
@@ -9,7 +7,6 @@ bin/webbynode
 bin/wn
 changelog.rdoc
 cucumber.yml.old
-devver.rake
 inactive_features/bootstrap.feature
 inactive_features/step_definitions/command_steps.rb
 inactive_features/support/env.rb
@@ -27,6 +24,7 @@ lib/webbynode/attribute_accessors.rb
 lib/webbynode/command.rb
 lib/webbynode/commands/add_backup.rb
 lib/webbynode/commands/add_key.rb
+lib/webbynode/commands/addons.rb
 lib/webbynode/commands/alias.rb
 lib/webbynode/commands/apps.rb
 lib/webbynode/commands/change_dns.rb
@@ -34,6 +32,7 @@ lib/webbynode/commands/config.rb
 lib/webbynode/commands/delete.rb
 lib/webbynode/commands/help.rb
 lib/webbynode/commands/init.rb
+lib/webbynode/commands/open.rb
 lib/webbynode/commands/push.rb
 lib/webbynode/commands/remote.rb
 lib/webbynode/commands/restart.rb
@@ -79,6 +78,10 @@ spec/fixtures/git/config/67.23.79.31
 spec/fixtures/git/config/67.23.79.32
 spec/fixtures/git/config/config
 spec/fixtures/git/config/config_5
+spec/fixtures/git/config/new_210.11.13.12
+spec/fixtures/git/config/new_67.23.79.31
+spec/fixtures/git/config/new_67.23.79.32
+spec/fixtures/git/config/new_config
 spec/fixtures/git/status/clean
 spec/fixtures/git/status/dirty
 spec/fixtures/pushand
@@ -89,6 +92,7 @@ spec/webbynode/application_spec.rb
 spec/webbynode/command_spec.rb
 spec/webbynode/commands/add_backup_spec.rb
 spec/webbynode/commands/add_key_spec.rb
+spec/webbynode/commands/addons_spec.rb
 spec/webbynode/commands/alias_spec.rb
 spec/webbynode/commands/apps_spec.rb
 spec/webbynode/commands/change_dns_spec.rb
@@ -96,6 +100,7 @@ spec/webbynode/commands/config_spec.rb
 spec/webbynode/commands/delete_spec.rb
 spec/webbynode/commands/help_spec.rb
 spec/webbynode/commands/init_spec.rb
+spec/webbynode/commands/open_spec.rb
 spec/webbynode/commands/push_spec.rb
 spec/webbynode/commands/remote_spec.rb
 spec/webbynode/commands/tasks_spec.rb
@@ -112,7 +117,9 @@ spec/webbynode/git_spec.rb
 spec/webbynode/io_spec.rb
 spec/webbynode/option_spec.rb
 spec/webbynode/parameter_spec.rb
+spec/webbynode/properties_spec.rb
 spec/webbynode/push_and_spec.rb
 spec/webbynode/remote_executor_spec.rb
 spec/webbynode/server_spec.rb
+spec/webbynode/ssh_spec.rb
 webbynode.gemspec

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 
 require 'echoe'  
   
-Echoe.new('webbynode', '0.2.5.beta2') do |p|  
+Echoe.new('webbynode', '1.0.0') do |p|  
   p.description     = "Webbynode Deployment Gem"  
   p.url             = "http://webbynode.com"  
   p.author          = "Felipe Coury"
@@ -15,6 +15,7 @@ Echoe.new('webbynode', '0.2.5.beta2') do |p|
     ['net-ssh', '>=2.0.20'],
     ['highline', '>=1.5.2'],
     ['httparty', '>=0.4.5'],
+    ['launchy',  '>=0.3.7'],
     ['domainatrix','>=0.0.7'],
   ]
   # p.dependencies = [
@@ -29,11 +30,12 @@ Echoe.new('webbynode', '0.2.5.beta2') do |p|
       Webbynode Rapid Deployment Gem
 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
-This deployment engine is highly experimental and
-should be considered beta code for now.
+Thank you for installing Webbynode gem. You're now
+able to deploy and manage your applications from
+the comfort of your command line.
 
-For a quickstart:
-http://guides.webbynode.com/articles/rapidapps
+Please read our guide for a quickstart:
+http://guides.webbynode.com/articles/rapidapps/
 
 "
 end

data/changelog.rdoc

@@ -1,13 +1,96 @@
 = CHANGELOG
 
+== 2010-08-04 Felipe Coury
+
+* Properties class properly saves array values. Fixes #23
+
+== 2010-08-03 Felipe Coury
+
+* Fixed a failing test by pending it with explanatory message.
+* Fixed bug where database.yml was not being excluded from git.
+
+== 2010-07-28 Felipe Coury
+
+* Added Beanstalk
+
+== 2010-07-22 Felipe Coury
+
+* Fixed spelling in addons command
+* New installation message
+
+== 2010-07-21 Felipe Coury
+
+* Prevents errors if addons param is malformed
+
+== 2010-07-20 Felipe Coury
+
+* Added `wn open' command. Closes #22
+* Adds SSH key when initializing. Closes #15
+* Added support for addons. Closes #20
+
+== 2010-07-04 Felipe Coury
+
+* Error message when using Django engine and settings.py isn't found
+* Updated gemspec and Manifest
+* Now all commands work with an alternate SSH port when wn init --port=PORT is used. Fixed a small bug on options validation. Fixes #19
+* Handles connection refused when attempting to run commands
+* Changed AWS S3 back help text to point to the correct URL. Fixes #17
+
+== 2010-07-01 Felipe Coury
+
+* Bumped gem version to 0.2.5.beta2.
+* Added Django initialization code for handling .gitignore and settings.template.py creation.
+* Taken Rails-specific code out of init command.
+* Added prepare to Engine and extracted Gemfile detection code to Rails3 engine class.
+* Added engine_id, engine_name and git_excluded specs for engines
+* Invalid engine shows error message and triggers interactive engine selection.
+* Starting of Engine-specific preparation and validation code (WIP)
+* Refactoring on the Engine detection methods.
+* Engine detection refactoring (work in progress).
+
+== 2010-06-30 Felipe Coury
+
+* Fixed order of settings
+* Detects pontential problems before engine detection
+* Engine detection refactoring
+* Marked gem as 0.2.5.beta1. Closes #12. Closes #13.
+
+== 2010-06-29 Felipe Coury
+
+* Made webbynode gem compatible with Windows.
+
+== 2010-06-28 Felipe Coury
+
+* Merge commit '0.2.4.1'
+* Removed jcode as a dependency. Fixes #8.
+* Removed cucumber.yml for the time being
+* Improved wn init feedback
+
+== 2010-06-27 Felipe Coury
+
+* When user has only one Webby, assumes it when `init' command is used. When user has multiple Webbies and the param is omitted, shows a list of user's Webbies.
+* Removed features temporarily
+* Init command now takes DNS entry as an option (--dns=xyz) and started simplification of wn init, making the webby parameter optional if user only have one Webby.
+* Fixed option parsing to allow xyz.abc.def
+* Renamed feature for the time being
+
+== 2010-06-26 Felipe Coury
+
+* Rapp automatic updates support Command `wn apps' - lists all the current apps on a Webby Bumped Gem version
+
 == 2010-06-24 Felipe Coury
 
+* Added changelog
 * Rails 3 autodetection
 * Small typo on Gemfile error message
 * Uses bundler to check for sqlite3-ruby dependency in Gemfile. If found, issues an error message with proper instructions. Closes #6.
 * Fixed version command
 * Stops tracking db/schema.rb and config/database.yml if there is an existing git repo. Closes #7. Doesn't allow init to run if current app in on a dirty git state.
 
+== 2010-06-24 Michael van Rooijen
+
+* Adjusted the Gemfile error text.
+
 == 2010-06-23 Felipe Coury
 
 * Adds db/schema.rb and config/database.yml to .gitignore. Closes #7.

data/lib/templates/backup

@@ -3,7 +3,7 @@ Webbynode Rapid App Backup
 This service will backup a dump of your application Database and the contents
 of your application folder to a bucket on Amazon S3. If you don't have an 
 Amazon S3 account or if you don't know how to create one, please check our 
-guide on http://guides.webbynode.com/rapid.
+guide on http://guides.webbynode.com/articles/rapidapps/backup.html.
 
 DISCLAIMER: Backing up to S3 will incur on a charge by Amazon according to the
 terms of the services contract you accepted when signing up to their services.

data/lib/webbynode/command.rb

@@ -204,7 +204,8 @@ module Webbynode
     end
     
     def remote_executor
-      @remote_executor ||= Webbynode::RemoteExecutor.new(git.parse_remote_ip)
+      git.parse_remote_ip
+      @remote_executor ||= Webbynode::RemoteExecutor.new(git.remote_ip, git.remote_port)
     end
     
     def pushand
@@ -311,6 +312,7 @@ module Webbynode
       end
 
       settings[:parameters].each { |p| p.validate! }
+      settings[:options].each { |p| p.validate! }
     end
     
     def handle_dns(dns)

data/lib/webbynode/commands/add_key.rb

@@ -1,3 +1,5 @@
+LocalSshKey = "#{ENV['HOME']}/.ssh/id_rsa.pub"
+
 module Webbynode::Commands
   class AddKey < Webbynode::Command
     requires_initialization!
@@ -5,8 +7,6 @@ module Webbynode::Commands
     summary "Adds your ssh public key to your Webby, making deployments easy"
     option :passphrase, "If present, passphrase will be used when creating a new SSH key", :take => :words
 
-    LocalSshKey = "#{ENV['HOME']}/.ssh/id_rsa.pub"
-    
     add_alias "addkey"
     
     def execute

data/lib/webbynode/commands/addons.rb

@@ -0,0 +1,84 @@
+module Webbynode::Commands
+  class Addons < Webbynode::Command
+    SUPPORTED_ADDONS = ["mongodb", "redis", "memcached", "beanstalkd"]
+
+    summary "Manages you application's add-ons"
+    parameter :action, "add, remove or show", 
+      :required => false, :validate => { :in => ['add', 'remove', 'show']}
+    parameter :addon, "name of the addon", 
+      :required => false, :validate => { :in => SUPPORTED_ADDONS }
+
+    add_alias "addon"
+    
+    def execute
+      show_summary and return unless action = param(:action)
+      send(action)
+    end
+    
+    private
+    
+    def add
+      return unless validate_addon('add')
+      
+      if @addons.include?(@addon)
+        io.log("Add-on '#{@addon}' was already included")
+      else
+        @addons << @addon
+        io.add_multi_setting 'addons', @addons
+        io.log("Add-on '#{@addon}' added")
+      end
+    end
+    
+    def remove
+      return unless validate_addon('remove')
+      
+      if @addons.include?(@addon)
+        @addons.delete(@addon)
+        io.add_multi_setting 'addons', @addons
+        io.log("Add-on '#{@addon}' removed")
+      else
+        io.log("Add-on '#{@addon}' not installed")
+      end
+    end
+    
+    def validate_addon(verb)
+      unless @addon = param(:addon)
+        io.log("Missing addon to #{verb}. Type 'wn addons' for a list of available addons.")
+        return false
+      end
+      
+      unless SUPPORTED_ADDONS.include?(@addon)
+        io.log("Addon #{@addon} doesn't exist. Type 'wn addons' for a list of available addons.")
+        return false
+      end
+      
+      @addons = io.load_setting('addons') || []
+      @addons = [] unless @addons.is_a?(Array)
+      @addons
+    end
+    
+    def show_summary
+      io.log('Available add-ons:')
+      io.log("")
+      io.log('   Key          Name        Description')
+      io.log('  ------------ ----------- ------------------------')
+      io.log('   beanstalkd   Beanstalk   Simple, fast workqueue service')
+      io.log('   memcached    Memcached   Distributed memory object caching system')
+      io.log('   mongodb      MongoDB     Document based database engine')
+      io.log('   redis        Redis       Advanced key-value store')
+      io.log("")
+      
+      addons = io.load_setting("addons")
+      if addons && addons.is_a?(Array) && addons.any?
+        io.log('Currently selected add-ons:')
+        io.log('')
+        io.log("   #{addons.join(', ')}")
+      else        
+        io.log("No add-ons currently selected. Use 'wn addons add <name>' to add.")
+      end
+      io.log('')
+      
+      true
+    end
+  end
+end

data/lib/webbynode/commands/init.rb

@@ -4,6 +4,7 @@ module Webbynode::Commands
     parameter :webby, String, "Name or IP of the Webby to deploy to", :required => false
     option :dns, String, "The DNS used for this application"
     option :adddns, "Creates the DNS entries for the domain"
+    option :port, "Specifies an alternate SSH port to connect to Webby", :validate => :integer
     option :engine, "Sets the application engine for the app", :validate => { :in => ['php', 'rack', 'rails', 'rails3'] }
     
     def execute
@@ -74,11 +75,22 @@ module Webbynode::Commands
       end
       
       io.log "Adding webbynode as git remote..."
-      git.add_remote "webbynode", webby_ip, app_name
+      options = ["webbynode", webby_ip, app_name]
+      options << option(:port).to_i if option(:port)
+
+      Webbynode::Server.new(webby_ip).add_ssh_key LocalSshKey, nil
+
+      git.add_remote *options
       
       handle_dns option(:dns) if option(:adddns)
       
       io.log "Application #{app_name} ready for Rapid Deployment", :finish
+    rescue Webbynode::InvalidAuthentication
+      io.log "Could not connect to webby: invalid authentication.", true
+
+    rescue Webbynode::PermissionError
+      io.log "Could not create an SSH key: permission error.", true
+
     rescue Webbynode::GitRemoteAlreadyExistsError
       io.log "Application already initialized."
     end

data/lib/webbynode/commands/open.rb

@@ -0,0 +1,21 @@
+require 'launchy'
+
+module Webbynode::Commands
+  class Open < Webbynode::Command
+    requires_initialization!
+
+    summary "Opens the current application in your browser"
+   
+    def execute
+      mapping = "/var/webbynode/mappings/#{io.app_name}.conf"
+      url = remote_executor.exec("test -f #{mapping} && cat #{mapping}", false).strip.chomp
+      
+      if url && !url.empty?
+        url = "http://#{url}"
+        Launchy.open url
+      else
+        io.log "Application not found or not deployed."
+      end
+    end
+  end
+end

data/lib/webbynode/engines/django.rb

@@ -5,6 +5,11 @@ module Webbynode::Engines
     git_excludes 'settings.py', '*.pyc', '*.pyo', 'docs/_build'
     
     def prepare
+      unless io.file_exists?('settings.py')
+        raise Webbynode::Command::CommandError, 
+          "Couldn't create the settings template because settings.py was not found. Please check and try again."
+      end
+      
       unless io.file_exists?('settings.template.py')
         io.log 'Creating settings.template.py from your settings.py...'
         io.copy_file 'settings.py', 'settings.template.py'

data/lib/webbynode/engines/rails3.rb

@@ -10,6 +10,7 @@ module Webbynode::Engines
     
     def prepare
       check_gemfile
+      super
     end
     
     private

data/lib/webbynode/git.rb

@@ -6,7 +6,7 @@ module Webbynode
   class GitRemoteCouldNotRemoveError < StandardError; end
 
   class Git
-    attr_accessor :config, :remote_ip
+    attr_accessor :config, :remote_ip, :remote_port
     
     def present?
       io.directory?(".git")
@@ -45,8 +45,10 @@ module Webbynode
       exec "git add #{what}"
     end
     
-    def add_remote(name, host, repo)
-      exec("git remote add #{name} git@#{host}:#{repo}") do |output|
+    def add_remote(name, host, repo, port=22)
+      home = RemoteExecutor.new(host, port).remote_home
+
+      exec("git remote add #{name} ssh://git@#{host}:#{port}#{home}/#{repo}") do |output|
         # raise an exception if remote already exists
         raise GitRemoteAlreadyExistsError, output if output =~ /remote \w+ already exists/
         
@@ -108,9 +110,31 @@ module Webbynode
       end
     end
     
+    def init_config
+      @config ||= parse_config
+    end
+    
+    def parse_remote_url
+      init_config
+      @remote_url ||= @config["remote"]["webbynode"]["url"]
+    end
+    
     def parse_remote_ip
-      @config     ||= parse_config
-      @remote_ip  ||= ($2 if @config["remote"]["webbynode"]["url"] =~ /^(\w+)@(.+):(.+)$/) if @config
+      init_config
+      
+      # new remote format
+      if parse_remote_url =~ /^ssh:\/\/(\w+)@(.+)\/(.+)$/
+        if $2 =~ /(.*):(\d*)\/(.*)$/
+          @remote_ip   ||= $1
+          @remote_port ||= $2.to_i
+          @remote_home ||= "/#{$3}"
+        end
+      else
+        @remote_ip   ||= ($2 if @config["remote"]["webbynode"]["url"] =~ /^(\w+)@(.+):(.+)$/) if @config
+        @remote_port ||= 22
+      end
+      
+      @remote_ip
     end
     
     def remote_exists?(remote)

data/lib/webbynode/io.rb

@@ -137,8 +137,8 @@ module Webbynode
     end
     
     def create_local_key(passphrase="")
-      unless File.exists?(Webbynode::Commands::AddKey::LocalSshKey)
-        exec "ssh-keygen -t rsa -N \"#{passphrase}\" -f #{Webbynode::Commands::AddKey::LocalSshKey}"
+      unless File.exists?(LocalSshKey)
+        exec "ssh-keygen -t rsa -N \"#{passphrase}\" -f #{LocalSshKey}"
       end
     end
     
@@ -207,6 +207,14 @@ module Webbynode
       with_setting { |s| s[key] = value }
     end
     
+    def add_multi_setting(key, values)
+      with_setting { |s| s[key] = "(#{values.join(" ")})" }
+    end
+    
+    def load_setting(key)
+      properties(".webbynode/settings")[key]
+    end
+    
     def config_multi_add(key, new_value)
       raise "Missing Webbynode config file" unless file_exists?(".webbynode/config")
       config = read_yaml(".webbynode/config")

data/lib/webbynode/option.rb

@@ -14,7 +14,9 @@ module Webbynode
       @value = nil
       @options = args.pop if args.last.is_a?(Hash)
       @options ||= {}
-      @options[:required] = true if @options[:required].nil?
+
+      @original_options = @options.clone
+      @options[:required] = false if @options[:required].nil?
       
       @name = args[0]
       if args[1].is_a?(String)
@@ -33,15 +35,28 @@ module Webbynode
     end
     
     def valid?
+      return true if !required? and value.nil?
       @errors = []
       if (validations = @options[:validate])
-        validations.each_pair do |key, value|
-          @errors << send("#{key}_error", value) unless send(key, value)
+        if validations.is_a?(Hash)
+          validations.each_pair do |key, value|
+            @errors << send("#{key}_error", value) unless send(key, value)
+          end
+        else
+          @errors << send("#{validations}_error", value) unless send(validations, value)
         end
       end
       @errors.empty?
     end
     
+    def integer(value)
+      Integer(value) rescue false
+    end
+    
+    def integer_error(value)
+      "Invalid value '#{value}' for #{self.class.name.split("::").last.downcase} '#{self.name}'. It should be an integer."
+    end
+    
     def in(allowed_values)
       allowed_values.include?(self.value)
     end
@@ -70,7 +85,7 @@ module Webbynode
     end
     
     def required?
-      @options[:required]
+      @options[:required] == true
     end
     
     def take

data/lib/webbynode/parameter.rb

@@ -2,7 +2,7 @@ module Webbynode
   class Parameter < Webbynode::Option
     def initialize(*args)
       super
-      @options[:required] = true if @options[:required].nil?
+      @options[:required] = true if @original_options[:required].nil?
     end
     
     def validate!

data/lib/webbynode/properties.rb

@@ -12,12 +12,21 @@ module Webbynode
 
       begin
         IO.foreach(file) do |line|
-          self[$1.strip.to_s] = $2.strip if line = ~ /([^=]*)=(.*)\/\/(.*)/ || line =~ /([^=]*)=(.*)/
+          if line = ~ /([^=]*)=(.*)\/\/(.*)/ || line =~ /([^=]*)=(.*)/
+            key = $1.strip.to_s
+            value = $2.strip 
+            
+            if value =~ /^\((.*)\)$/
+              value = $1.split(' ')
+            end
+            
+            self[key] = value
+          end
         end
       rescue
       end
     end
-
+    
     def to_s
       output = "File name #{@file}\n"
       self.each { |key, value| output += " #{key} = #{value}\n" }
@@ -36,8 +45,18 @@ module Webbynode
 
     def save
       file = File.new(@file, "w+")
-      self.each { |key, value| file.puts "#{key}=#{value}\n" }
+      self.converted.each { |key, value| file.puts "#{key}=#{value}\n" }
       file.close
     end
+    
+    def converted
+      hash = self.clone
+      hash.each do |k, v|
+        if v.is_a?(Array)
+          hash[k] = "(#{v.join(" ")})"
+        end
+      end
+      hash
+    end
   end
 end

data/lib/webbynode/remote_executor.rb

@@ -1,21 +1,31 @@
 module Webbynode  
   class RemoteExecutor
-    attr_accessor :ip
+    attr_accessor :ip, :port
         
-    def initialize(ip)
+    def initialize(ip, port=nil)
       @ip = ip
+      @port = port
     end
     
     def ssh
-      @ssh ||= Ssh.new(ip)
+      @ssh ||= Ssh.new(ip, port)
     end
     
     def create_folder(folder)
       ssh.execute "mkdir -p #{folder}"
     end
     
+    def remote_home
+      exec('pwd').strip
+    end
+    
     def exec(cmd, echo=false, exit_code=false)
-      ssh.execute(cmd, echo, exit_code)
+      begin
+        ssh.execute(cmd, echo, exit_code)
+      rescue Errno::ECONNREFUSED
+        raise Webbynode::Command::CommandError,
+          "Could not connect to #{@ip}. Please check your settings and your network connection and try again."
+      end
     end
   end
 end

data/lib/webbynode/server.rb

@@ -28,7 +28,7 @@ module Webbynode
       remote_executor.create_folder("~/.ssh")
       
       key_contents = io.read_file(key_file)
-      remote_executor.exec "echo \"#{key_contents}\" >> ~/.ssh/authorized_keys; chmod 644 ~/.ssh/authorized_keys"
+      remote_executor.exec "grep \"#{key_contents}\" ~/.ssh/authorized_keys || (echo \"#{key_contents}\" >> ~/.ssh/authorized_keys; chmod 644 ~/.ssh/authorized_keys)"
     end
     
     def application_pushed?

data/lib/webbynode/ssh.rb

@@ -1,7 +1,10 @@
 module Webbynode
   class Ssh
-    def initialize(remote_ip)
+    attr_accessor :remote_ip, :port
+    
+    def initialize(remote_ip, port=22)
       @remote_ip = remote_ip
+      @port = port
     end
     
     def io
@@ -11,13 +14,13 @@ module Webbynode
     def connect
       raise "No IP given" unless @remote_ip
       @conn = nil if @conn and @conn.closed?
-      @conn ||= Net::SSH.start(@remote_ip, 'git', :auth_methods => %w(publickey hostbased))
+      @conn ||= Net::SSH.start(@remote_ip, 'git', :port => @port, :auth_methods => %w(publickey hostbased))
     rescue Net::SSH::AuthenticationFailed
       HighLine.track_eof = false
       
       begin
         @password ||= ask("Enter your deployment password for #{@remote_ip}: ") { |q| q.echo = '' }
-        @conn     ||= Net::SSH.start(@remote_ip, 'git', :password => @password)  
+        @conn     ||= Net::SSH.start(@remote_ip, 'git', :port => @port, :password => @password)  
       rescue Net::SSH::AuthenticationFailed
         io.log "Could not connect to server: invalid authentication.", true
         exit