duostack 0.1.0 → 0.2.0

data/Rakefile

@@ -8,6 +8,7 @@ Jeweler::Tasks.new do |gem|
   gem.version = `bin/duostack version`.chomp
   gem.summary = %Q{Duostack command line client}
   gem.description = %Q{Duostack command line client: create and manage Duostack apps}
+  gem.homepage = "http://www.duostack.com/"
   gem.email = "todd@toddeichel.com"
   gem.authors = "Todd Eichel"
   gem.require_paths = ['.'] # default is ["lib"] but we don't have that

data/bin/duostack

@@ -28,12 +28,16 @@ $client = File.basename(__FILE__)
 module Duostack
   class Client
     
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
     DEPENDENCIES_LAST_MODIFIED = 1297154481
-    DEFAULT_CREDENTIALS_LOCATION = '~/.duostack'
     USER_AGENT = "duostack-#{VERSION}"
     
-    FLAGS = [                        # app is one too but gets special handling
+    DEFAULTS = {
+      :credentials_location => '~/.duostack',
+      :remote_name => 'duostack'
+    }
+    
+    FLAGS = [                        # app and remote get special handling
       'confirm',
       'long',
       'skip-dependency-checks'
@@ -56,7 +60,8 @@ module Duostack
         'rake',
         'config',
         'env',
-        'access'
+        'access',
+        'domains'
       ],
       :compound => [                 # mult-part commands that expect subsequent arguments, must validate extra args on their own
         'help',
@@ -64,7 +69,8 @@ module Duostack
         'rake',
         'config',
         'env',
-        'access'
+        'access',
+        'domains'
       ]
     }
     
@@ -74,8 +80,10 @@ module Duostack
     end
     
     def run
-      @creds_file = get_flag_arg('creds') || DEFAULT_CREDENTIALS_LOCATION
-      @app_name   = get_flag_arg('app') # attempt to get app from args. will also try git repo inference later.
+      @creds_file = get_flag_arg('creds')  || DEFAULTS[:credentials_location]
+      @remote     = get_flag_arg('remote') || DEFAULTS[:remote_name]
+      # get app from args if we can, otherwise it will be extracted from git remotes during require_app
+      @app_name   = get_flag_arg('app')
       @flags      = parse_flags
       @command    = @args.shift || COMMANDS[:default]
       
@@ -179,12 +187,6 @@ module Duostack
       # curl SSL
       # handled inside api_host method
       
-      # expect (only if running console)
-      # TODO: just use ruby expect lib
-      if @command == 'console' && `which expect`.empty?
-        exit_with "missing dependency, please install Expect"
-      end
-      
       # touch .duostack so we know when deps were last checked (but don't create it if it doesn't exist)
       require 'fileutils'
       FileUtils.touch(filename) if File.exist?(filename)
@@ -194,7 +196,7 @@ module Duostack
     # ensures the app can be identified from inspecting the git repo or command line args
     def require_app
       require_user # all app commands require a user
-      @app_name ||= extract_app_name
+      @app_name ||= app_name_from_git_remotes
       unless @app_name
         exit_with "run this command from a Duostack app folder or pass an app name with the --app argument"
       end
@@ -209,7 +211,7 @@ module Duostack
         ssh_key = require_ssh_key # all user commands require an SSH key
         
         puts "First-time Duostack client setup"
-        print "Email Address: "
+        print "Email: "
         username = $stdin.gets.chomp
         password = `bash -c 'read -sp "Password: " passwd; echo $passwd'`.chomp
         puts '' # clears the line after
@@ -245,7 +247,7 @@ module Duostack
       # NOTE: @confirmed is set above in 'run' so we can be assured the app_name came from the --app flag
       # if assessed confirmation here, the app could have been extracted from the git repo
       unless @confirmed
-        exit_with "command requires confirmation, run again with '--confirm --app <appname>'"
+        exit_with "command requires confirmation, run again with '--confirm --app #{@app_name}'"
       end
     end
     
@@ -253,9 +255,103 @@ module Duostack
     # utility methods
     #########################################################################
     
-    def extract_app_name
-      name = `git remote -v 2>&1 | grep -m1 git@duostack.net | grep ".git" | cut -f 2 -d: | cut -f 1 -d.`.chomp
-      return name.empty? ? nil : name # ensures nil gets returned instead of an empty string
+    def process_crud_command(opts)
+      
+      # get action
+      action = @args.shift || 'list'      # list is the default
+      action = 'list'   if action == 'ls' # normalize shorthand for list
+      action = 'remove' if action == 'rm' # normalize shorthand for remove
+      
+      # extract important things from opts, otherwise merge defaults
+      resource  = opts[:resource]
+      resources = "#{resource}s" # may eventually need a better pluralizer
+      
+      # default settings for opts. priority is:
+      #  1. hash under each action (e.g. opts[:actions][:list][:param])
+      #  2. general opts (e.g. opts[:param])
+      #  3. generic defaults specified here (e.g. `resources`, the pluralized resource name)
+      defaults = {
+        :error_message     => opts[:error_message]    || "<#{resource}>",
+        :param             => opts[:param]            || resources,
+        :additional_params => opts[:additonal_params] || nil,
+        :args_processor    => opts[:args_processor]   || lambda { |args| args }
+      }
+      
+      # actions can be either a hash (containing action-specific options) or an array (accept the defaults)
+      if opts[:actions].respond_to?(:keys)
+        valid_actions = opts[:actions].keys.map { |x| x.to_s }
+        opts = defaults.merge(opts[:actions][action.to_sym])
+      else
+        valid_actions = opts[:actions]
+        opts = defaults.merge(opts)
+      end
+      
+      
+      # ensure action is valid
+      unless valid_actions.include?(action)
+        exit_with "invalid argument for '#{@command}', try #{sentencize(valid_actions)}"
+      end
+      
+      # ensure we have an argument for add/remove actions which require it
+      if %w(add remove).include?(action)
+        # gather up and compose remaining args for add/remove operations
+        argument = opts[:args_processor].call(@args).join(' ')
+        @args.clear # clean up, since we processed every remaining arg
+        
+        # warn and exit unless we have an argument to pass
+        if argument.empty?
+          exit_with "'#{@command} #{action}' requires an argument, try '#{@command} #{action} #{opts[:error_message]}'"
+        end
+        
+        # clean up argument
+        argument = CGI::escape(argument)
+      end
+      
+      # finally, process action
+      case action
+      when 'list'
+        print api_get("list_#{resources}", opts[:additional_params])
+      when 'add'
+        puts api_get("add_#{resource}",    ["#{opts[:param]}=#{argument}", opts[:additional_params]].compact.join('&'))
+      when 'remove'
+        puts api_get("remove_#{resource}", ["#{opts[:param]}=#{argument}", opts[:additional_params]].compact.join('&'))
+      when 'clear'
+        require_confirmation
+        puts api_get("clear_#{resources}", opts[:additional_params])
+      end
+    end
+    
+    
+    # attempts to get the app name out of git remotes
+    # if --remote is specified, it will use that assuming it's valid
+    # if not, it will look for any remote name that references duostack.net
+    def app_name_from_git_remotes
+      remotes = `git remote -v 2>/dev/null`.split("\n")
+      remotes.reject! { |line| line.split.last == '(fetch)' } # filter out fetch remotes (careful, does not exist in older git versions)
+      
+      # find url of remote of specified name
+      valid_remotes = remotes.reject do |line|
+        line.split.first != @remote
+      end
+      remote_url = valid_remotes.first.split[1] unless valid_remotes.empty?
+      
+      # correct url will be in the form "git@duostack.net:appname.git"
+      # if remote of specified name is a duostack remote, set app_name
+      if !remote_url.to_s.empty? && remote_url[0..16] == "git@duostack.net:" && remote_url[-4..-1] == ".git"
+        app_name = remote_url[17..-5]
+      else # the specified remote isn't for duostack; look for another (take first match)
+        remotes.each do |line|
+          result = line.scan(/git@duostack\.net:(\w+)\.git/)
+          if result.length > 0 && result[0].length > 0
+            app_name = result[0][0]
+            remote_name = line.split.first
+            warn_with "remote '#{@remote}' does not refer to Duostack, using remote '#{remote_name}' instead"
+            break
+          end
+        end
+      end
+      
+      return app_name ||= nil
     end
     
     def ssh_key_location
@@ -324,6 +420,18 @@ module Duostack
       end
     end
     
+    def sentencize(array, conjunction='or')
+      # http://stackoverflow.com/questions/2038787/join-array-contents-into-an-english-list
+      case array.length
+      when 0, 1
+        array.first.to_s
+      when 2
+        "#{array.first} #{conjunction} #{array.last}"
+      else
+        "#{array[0..-2].join(', ')}, #{conjunction} #{array.last}"
+      end
+    end
+    
     def debug(message)
       puts message if ENV['DSDEBUG']
     end
@@ -374,16 +482,15 @@ module Duostack
         exit_with "current directory is not a Git repository, run 'git init' first"
       end
       
-      # ensure no existing duostack remote
-      if extract_app_name
-        exit_with "current directory already initialized for Duostack, remove any Git remotes referencing Duostack first"
+      # make sure we're not going to step on an existing git remote
+      if `git remote`.chomp.split("\n").include?(@remote)
+        exit_with "there is already a Git remote named '#{@remote}', please remove it or pass a \ndifferent name with the --remote argument"
       end
       
-      # create!
-      # TODO: ensure there is not already a remote named duostack
+      # create, add remote
       puts api_get('create_app', "app_name=#{name}")
-      `git remote add duostack git@duostack.net:#{name}.git 2>/dev/null`
-      puts "Git remote added, to push: 'git push duostack master'"
+      `git remote add #{@remote} git@duostack.net:#{name}.git 2>/dev/null`
+      puts "Git remote added, to push: 'git push #{@remote} master'"
     end
     
     
@@ -420,6 +527,13 @@ module Duostack
     
     
     def console
+      # TODO: just use ruby expect lib
+      
+      # first check for expect dependency
+      if `which expect`.empty?
+        exit_with "missing dependency, please install Expect (http://expect.sourceforge.net/)"
+      end
+      
       exec("#{$dir}/.duostack-console-expect #{@app_name}")
     end
     
@@ -454,104 +568,59 @@ module Duostack
     
     
     def env
-      
-      # get command
-      command = @args.shift
-      command ||= 'list' # list is the default
-      
-      # ensure command is valid
-      unless %w(add remove rm list ls clear).include?(command)
-        exit_with "invalid argument for 'env', try list, add, remove, or clear"
-      end
-      
-      # ensure we have an argument for add/remove commands which require it
-      if %w(add remove rm).include?(command)
-        # gather up and compose subsequent args for add/remove operations
-        # takes all remaining arguments. recompose strings because ruby strips out quotation marks in the args.
-        argument = @args.collect do |arg|
-          if arg.include?('=')
-            result = arg.split('=',2)
-            %Q(#{result[0]}="#{result[1].gsub('"', '\"')}")
-          else
-            arg
-          end
-        end.join(' ')
-        @args.clear # clean up, since we processed every remaining arg
-        
-        # warn and exit unless we have an argument to pass
-        if argument.empty?
-          case command
-          when 'add'
-            exit_with "'env add' requires an argument, try 'env add <name>=<value>'"
-          when 'remove', 'rm'
-            exit_with "'env #{command}' requires an argument, try 'env #{command} <name>'"
-          end
-        end
-        
-        # clean up argument
-        argument = CGI::escape(argument)
-      end
-      
-      # finally, process command
-      case command
-      when 'list', 'ls'
-        truncate = !@flags.include?('long')
-        print api_get("list_envs", "truncate=#{truncate}")
-      when 'add'
-        puts api_get("add_env", "input=#{argument}")
-      when 'remove', 'rm'
-        puts api_get("remove_env", "name=#{argument}")
-      when 'clear'
-        require_confirmation
-        puts api_get("clear_envs")
-      end
+      process_crud_command({
+        :resource => 'env',
+        :actions => {
+          :list => {
+            :additional_params => "truncate=#{!@flags.include?('long')}"
+          },
+          :add => {
+            :error_message => '<name>=<value>',
+            :param => 'input',
+            :args_processor => lambda { |args|
+              # recompose strings and quote values because ruby strips out quotation marks in the args.
+              args.collect do |arg|
+                if arg.include?('=')
+                  result = arg.split('=',2)
+                  %Q(#{result[0]}="#{result[1].gsub('"', '\"')}")
+                else
+                  arg
+                end
+              end
+            }
+          },
+          :remove => {
+            :error_message => '<name>',
+            :param => 'name'
+          },
+          :clear => {}
+        }
+      })
     end
     
     
     def access
-      
-      # get command
-      command = @args.shift
-      command ||= 'list' # list is the default
-      
-      # ensure command is valid
-      unless %w(add list ls).include?(command)
-        exit_with "invalid argument for 'access', try list or add"
-      end
-      
-      # ensure we have an argument for add/remove commands which require it
-      if %w(add).include?(command)
-        # gather up and compose remaining args for add/remove operations
-        argument = @args.join(' ')
-        @args.clear # clean up, since we processed every remaining arg
-        
-        # warn and exit unless we have an argument to pass
-        if argument.empty?
-          case command
-          when 'add'
-            exit_with "'access add' requires an argument, try 'access add <email>'"
-          end
-        end
-        
-        # clean up argument
-        argument = CGI::escape(argument)
-      end
-      
-      # finally, process command
-      case command
-      when 'list', 'ls'
-        print api_get("list_collabs")
-      when 'add'
-        puts api_get("add_collab", "emails=#{argument}")
-      end
+      process_crud_command({
+        :resource => 'collab',
+        :param => 'emails',
+        :error_message => '<email>',
+        :actions => %w(list add)
+      })
     end
     
     
+    def domains
+      process_crud_command({
+        :resource => 'domain',
+        :actions => %w(list add remove)
+      })
+    end
+    
     
     module Help
       
-      # available help sections. first will be used as the default.
-      SECTIONS = %w(help create list version logs restart ps destroy config env access console rake)
+      # available help sections. first will be used as the default, so unshift 'help' into first position.
+      SECTIONS = (COMMANDS[:general] + COMMANDS[:user] + COMMANDS[:app]).unshift('help')
       
       class << self
         
@@ -569,33 +638,39 @@ module Duostack
         def help
           <<-EOF
             
-            Usage: #{$client} <command> [<args>] [--app <appname>]
+            Usage: #{$client} <command> [<args>] [--app <appname>] [--remote <remotename>]
             
             App commands must be either run from an app folder (a Git repository with a
             Duostack remote) or have the app specified with the "--app <appname>" flag. If
             both are present, the "--app" flag takes precedence.
             
-            The most common commands are listed below.
-            For additional information on any of them, run: #{$client} help <command>
+            You can also use the "--remote" flag to set the app based on a specific Git 
+            remote name. This is common when you run two Duostack Apps (e.g. staging and
+            production) from the same folder. This flag can also be used when running 
+            "create" to have the client set up a custom remote name (default is "duostack").
+            
+            The most common commands are listed below. For additional information on any of
+            them, run: #{$client} help <command>
             
             General Commands:
-              help [<command>]            Show this help, or detailed help on <command>
-              create <appname>            Initialize a Git repository as a Duostack App
-              list                        Show all apps associated with your account
-              version                     Show version of this Duostack client
+              help [<command>]              Show this help, or detailed help on <command>
+              create <appname>              Initialize a Git repository as a Duostack App
+              list                          Show all apps associated with your account
+              version                       Show version of this Duostack client
             
             App Commands:
-              logs                        Retrieve server logs
-              restart                     Restart instances
-              ps                          List instances with current status
-              destroy                     Destroy Duostack App and associated data
-              config [<name> [<setting>]] Show or set configuration options
-              env [<operation>]           Manage environment variables
-              access [<operation>]        Manage app collaborator access
+              logs                          Retrieve server logs
+              restart                       Restart instances
+              ps                            List instances with current status
+              destroy                       Destroy Duostack App and associated data
+              config [<name> [<setting>]]   Show or set configuration options
+              env [<operation>]             Manage environment variables
+              access [<operation>]          Manage app collaborator access
+              domains [<operation>]         Manage custom domains
             
             App Commands - Ruby:
-              console                     Connect to IRB/Rails console
-              rake [<command>]            Run a Rake command
+              console                       Connect to IRB/Rails console
+              rake [<command>]              Run a Rake command
             
           EOF
         end
@@ -603,18 +678,25 @@ module Duostack
         def create
           <<-EOF
             
-            Usage:   #{$client} create <appname>
-            Example: #{$client} create myappname
+            Usage:
+              #{$client} create <appname>
+              #{$client} create <appname> --remote <remotename>
+              
+            Example:
+              #{$client} create myappname
+              #{$client} create myappname --remote staging
             
             Arguments:
               <appname>       A name for your app (restrictions apply, see below)
+              <remotename>    An optional name for the created Git remote
             
             Creates a new Duostack App from the current directory with the given name.
             
             The current directory must be initialized as a Git repository (run 'git init').
             Upon running 'create', the app will be created on Duostack and a Git remote with
             the name 'duostack' will be added to the local repository, which you can push to
-            to deploy your app: git push duostack master.
+            to deploy your app: git push duostack master. If a custom remote name is
+            specified with the '--remote' flag, that will be used instead.
             
             The app name must be 4-16 characters long, alphanumeric, and must not start with
             a number. The use of hyphens, underscores, or any other special characters is
@@ -767,8 +849,7 @@ module Duostack
               #{$client} access                          lists app collaborators
               #{$client} access add name@example.com     grants access for name@example.com
             
-            Lists and adds app collaborator access for users (identified by
-            emails).
+            Lists and adds app collaborator access for users (identified by emails).
             
             List: Lists collaborator emails who currently have access to the app. If none
             are set, output will be blank.
@@ -779,6 +860,34 @@ module Duostack
           EOF
         end
         
+        def domains
+          <<-EOF
+            
+            Usage:
+              #{$client} domains                          lists all custom domains
+              #{$client} domains add <domain>             adds <domain> as a custom domain
+              #{$client} domains remove <domain>          removes custom domain <domain>
+            
+            Examples:
+              #{$client} domains                          lists all env vars
+              #{$client} domains add app.example.com      adds app.example.com to app
+              #{$client} domains remove app.example.com   removes app.example.com from app
+            
+            Lists, adds, and removes custom domains
+            (http://docs.duostack.com/custom-domains).
+            
+            List: Lists custom domains currently set on the app. If none are set, output
+            will be blank.
+            
+            Add: Add one or more custom domains to the app. Add multiple by supplying
+            additional <domain> arguments separated by spaces.
+            
+            Remove: Removes one or more custom domains from the app. Remove multiple by
+            supplying additional <domain> arguments separated by spaces.
+            
+          EOF
+        end
+        
         def console
           <<-EOF
             

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: duostack
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Todd Eichel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-11 00:00:00 -05:00
+date: 2011-02-17 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -34,7 +34,7 @@ files:
 - bin/bash/.duostack-console-expect
 - bin/duostack
 has_rdoc: true
-homepage: 
+homepage: http://www.duostack.com/
 licenses: []
 
 post_install_message: