acquia_toolbelt 2.3.0 → 2.3.1

data/lib/acquia_toolbelt/cli/ssh.rb

@@ -0,0 +1,78 @@
+require "sshkey"
+
+module AcquiaToolbelt
+  class CLI
+    class SSH < AcquiaToolbelt::Thor
+      # Public: List all SSH users.
+      #
+      # Returns a list of users and their SSH keys truncated.
+      desc "list", "List all SSH users."
+      def list
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        users = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/sshkeys"
+        users.each do |user|
+          say
+          say "> ID: #{user["id"]}"
+          say "> Name: #{user["nickname"]}"
+          say "> Fingerprint: #{SSHKey.fingerprint user["ssh_pub_key"]}"
+        end
+      end
+
+      # Public: Delete a SSH key.
+      #
+      # Returns a status message.
+      desc "delete", "Delete a SSH key."
+      method_option :id, :type => :string, :aliases => %w(-i), :required => true,
+        :desc => "User ID to delete from SSH users."
+      def delete
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        id = options[:id]
+
+        delete_ssh_request = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/sshkeys/#{id}", "DELETE"
+
+        if delete_ssh_request["id"]
+          ui.success "SSH key #{id} has been successfully deleted."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(delete_ssh_key)
+        end
+      end
+
+      # Public: Add a SSH key to a subscription.
+      #
+      # Returns a status message.
+      desc "add", "Add a SSH key."
+      method_option :nickname, :type => :string, :aliases => %w(-n), :required => true,
+        :desc => "Nickname to ."
+      method_option :key, :type => :string, :aliases => %w(-k), :required => true,
+        :desc => "Public SSH key to add."
+      def add
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        key      = options[:key]
+        nickname = options[:nickname]
+        data     = { :key => "nickname", :value => "#{nickname}", :ssh_pub_key => "#{key}" }
+
+        add_ssh_key = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/sshkeys", "QUERY-STRING-POST", data
+        if add_ssh_key["id"]
+          ui.success "SSH key '#{nickname}' has been successfully added."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(add_ssh_key)
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/svn.rb

@@ -0,0 +1,73 @@
+module AcquiaToolbelt
+  class CLI
+    class SVN < AcquiaToolbelt::Thor
+      # Public: List all SVN users.
+      #
+      # Returns a list of available users.
+      desc "list", "List all SVN users."
+      def list
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        svn_users = AcquiaToolbelt::CLI::API.request  "sites/#{subscription}/svnusers"
+        svn_users.each do |user|
+          ui.say
+          ui.say "> ID: #{user["id"]}"
+          ui.say "> Name: #{user["username"]}"
+        end
+      end
+
+      # Public: Create a new SVN user.
+      #
+      # Returns a status message.
+      desc "add", "Add a SVN user."
+      method_option :username, :type => :string, :aliases => %w(-u), :required => true,
+        :desc => "Username you wish to set."
+      method_option :password, :type => :string, :aliases => %w(-p), :required => true,
+        :desc => "Password you wish to set."
+      def add
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        username = options[:username]
+        password = options[:password]
+
+        add_svn_user = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/svnusers/#{username}", "POST", :password => "#{password}"
+        if add_svn_user["id"]
+          ui.success "User '#{username}' has been successfully created."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(add_svn_user)
+        end
+      end
+
+      # Public: Delete a SVN user.
+      #
+      # Returns a status message.
+      desc "delete", "Delete an SVN user."
+      method_option :id, :type => :string, :aliases => %w(-i), :required => true,
+        :desc => "User ID to delete from SVN users."
+      def delete
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        userid = options[:id]
+
+        svn_user_removal = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/svnusers/#{userid}", "DELETE"
+        if svn_user_removal["id"]
+          ui.success "#{userid} has been removed from the SVN users."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(svn_user_removal)
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/task.rb

@@ -0,0 +1,74 @@
+module AcquiaToolbelt
+  class CLI
+    class Tasks < AcquiaToolbelt::Thor
+      no_tasks do
+        # Internal: Output information for a single task item.
+        #
+        # task - The task object that contains all the information about the
+        #        task.
+        def output_task_item(task)
+          completion_time = (task["completed"].to_i - task["started"].to_i) / 60
+          ui.say
+          ui.say "Task ID: #{task["id"].to_i}"
+          ui.say "Description: #{task["description"]}"
+          ui.say "Status: #{task["state"]}"
+
+          # If the completion time is greater then 0, output it in minutes
+          # otherwise just say it was less then a minute.
+          if completion_time > 0
+            ui.say "Compeletion time: About #{completion_time} minutes"
+          else
+            ui.say "Compeletion time: Less than 1 minute"
+          end
+
+          ui.say "Queue: #{task["queue"]}"
+        end
+      end
+
+      # Public: List all tasks from the Acquia tasks queue(s).
+      #
+      # Returns a task listing.
+      desc "list", "List all tasks."
+      method_option :queue, :type => :string, :aliases => %w(-q),
+        :desc => "Task queue to target."
+      method_option :count, :type => :string, :aliases => %w(-c),
+        :desc => "Limit the tasks returned."
+      def list
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        queue = options[:queue]
+        count = options[:count]
+
+        all_tasks = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/tasks"
+        tasks = []
+
+        # Fetch a single queue from the tasks list if the queue parameter is set
+        # otherwise just add all the tasks.
+        if queue
+          all_tasks.each do |task|
+            if task["queue"] == queue
+              tasks << task
+            end
+          end
+        else
+          all_tasks.each do |task|
+            tasks << task
+          end
+        end
+
+        # If there is a count to return, restrict it to that required amount.
+        if count && tasks.any?
+          tasks = tasks.last(count.to_i)
+        end
+
+        tasks.each do |task|
+          output_task_item(task)
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/ui.rb

@@ -0,0 +1,44 @@
+require "highline/import"
+require "rainbow"
+
+module AcquiaToolbelt
+  class CLI
+    class UI < Thor::Base.shell
+      # Internal: Used for outputting a pretty success message.
+      #
+      # text - The text to run through and output to the end user.
+      #
+      # Returns the string coloured and formatted.
+      def success(text)
+        puts "#{text}".foreground(:green)
+      end
+
+      # Internal: Used for outputting a pretty error message.
+      #
+      # text - The text to run through and output to the end user.
+      #
+      # Returns the string coloured and formatted.
+      def fail(text)
+        puts "#{text}".foreground(:red)
+      end
+
+      # Internal: Used for outputting a pretty info message.
+      #
+      # text - The text to run through and output to the end user.
+      #
+      # Returns the string coloured and formatted.
+      def info(text)
+        puts "#{text}".foreground(:cyan)
+      end
+
+      # Internal: Used for outputting a pretty debug message.
+      #
+      # text - The text to run through and output to the end user.
+      #
+      # Returns the string coloured and formatted.
+      def debug(text)
+        puts "#{text}".foreground(:yellow)
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli.rb

@@ -0,0 +1,103 @@
+require "acquia_toolbelt"
+require "acquia_toolbelt/error"
+require "acquia_toolbelt/thor"
+
+module AcquiaToolbelt
+  class CLI < AcquiaToolbelt::Thor
+    require "acquia_toolbelt/cli/ui"
+    require "acquia_toolbelt/cli/api"
+    require "acquia_toolbelt/cli/auth"
+    require "acquia_toolbelt/cli/database"
+    require "acquia_toolbelt/cli/server"
+    require "acquia_toolbelt/cli/ssh"
+    require "acquia_toolbelt/cli/svn"
+    require "acquia_toolbelt/cli/task"
+    require "acquia_toolbelt/cli/site"
+    require "acquia_toolbelt/cli/domain"
+    require "acquia_toolbelt/cli/deploy"
+    require "acquia_toolbelt/cli/file"
+    require "acquia_toolbelt/cli/environment"
+
+    include Thor::Actions
+
+    def self.start(given_args = ARGV, config = {})
+      Thor::Base.shell = AcquiaToolbelt::CLI::UI
+      ui = AcquiaToolbelt::CLI::UI.new
+
+      # Use a custom symbol to separate the commands. Useful for rake styled
+      # commands.
+      if given_args[0].include? ":"
+        commands = given_args.shift.split(":")
+        given_args = given_args.unshift(commands).flatten
+      end
+
+      super(given_args, {:shell => ui}.merge(config))
+    rescue AcquiaToolbelt::Error
+      ui.print_exception(e)
+      raise
+    rescue Interrupt => e
+      puts
+      ui.print_exception(e)
+      ui.say("Quitting...")
+      raise
+    rescue SystemExit, Errno::EPIPE
+      # Don't print a message for safe exits.
+      raise
+    rescue Exception => e
+      ui.print_exception(e)
+      raise
+    end
+
+    # Define some options that are available to all commands.
+    class_option :subscription, :type => :string, :aliases => %w(-s),
+      :desc => "Name of a subscription you would like to target."
+    class_option :environment, :type => :string, :aliases => %w(-e),
+      :desc => "Environment to target for commands."
+    class_option :verbose, :type => :boolean, :aliases => %w(-v),
+      :desc => "Increase the verbose output from the commands."
+
+    # Authentication.
+    desc "auth", ""
+    subcommand "auth", AcquiaToolbelt::CLI::Auth
+
+    # Databases.
+    desc "databases", ""
+    subcommand "databases", AcquiaToolbelt::CLI::Databases
+
+    # Servers.
+    desc "servers", ""
+    subcommand "servers", AcquiaToolbelt::CLI::Servers
+
+    # SSH.
+    desc "ssh", ""
+    subcommand "ssh", AcquiaToolbelt::CLI::SSH
+
+    # SVN.
+    desc "svn", ""
+    subcommand "svn", AcquiaToolbelt::CLI::SVN
+
+    # Tasks.
+    desc "tasks", ""
+    subcommand "tasks", AcquiaToolbelt::CLI::Tasks
+
+    # Sites.
+    desc "sites", ""
+    subcommand "sites", AcquiaToolbelt::CLI::Sites
+
+    # Domains.
+    desc "domains", ""
+    subcommand "domains", AcquiaToolbelt::CLI::Domains
+
+    # Deployments.
+    desc "deploy", ""
+    subcommand "deploy", AcquiaToolbelt::CLI::Deploy
+
+    # Files.
+    desc "files", ""
+    subcommand "files", AcquiaToolbelt::CLI::Files
+
+    # Environments.
+    desc "environments", ""
+    subcommand "environments", AcquiaToolbelt::CLI::Environments
+  end
+end

data/lib/acquia_toolbelt/error.rb

@@ -0,0 +1,4 @@
+module AcquiaToolbelt
+  class Error < RuntimeError
+  end
+end

data/lib/acquia_toolbelt/thor.rb

@@ -0,0 +1,95 @@
+$:.unshift(File.expand_path('../vendor/thor/lib/', File.dirname(__FILE__)))
+require 'thor'
+
+module AcquiaToolbelt
+   module UtilityMethods
+    protected
+
+    # Alias Thor's shell to UI instead.
+    def ui
+      shell
+    end
+  end
+
+  class Thor < ::Thor
+    include UtilityMethods
+    no_tasks do
+      def self.help(shell, subcommand = false)
+        list = printable_commands(true, subcommand).sort!{ |a,b| a[0] <=> b[0] }
+
+        shell.say "Type 'acquia [COMMAND] help' for more details on subcommands or to show example usage."
+
+        if @package_name
+          shell.say "#{@package_name} commands:"
+        else
+          shell.say
+          shell.say "Commands:"
+        end
+
+        shell.print_table(list, :indent => 2, :truncate => true)
+        shell.say unless subcommand
+        class_options_help(shell)
+      end
+
+      def self.printable_commands(all = true, subcommand = true)
+        (all ? all_commands : commands).map do |_, command|
+          # Don't show the hidden commands or the help commands.
+          next if command.hidden? || next if command.name.include? 'help'
+          item = []
+          item << banner(command, false, subcommand)
+          item << (command.description ? "# #{command.description.gsub(/\s+/m,' ')}" : "") unless command.description.empty?
+          item
+        end.compact
+      end
+
+      # Define a base for the commands.
+      def self.banner_base
+        "acquia"
+      end
+
+      def self.banner(task, task_help = false, subcommand = false)
+        subcommand_banner = to_s.split(/::/).map{|s| s.downcase}[2..-1]
+        subcommand_banner = if subcommand_banner.size > 0
+                              subcommand_banner.join(" ")
+                            else
+                              nil
+                            end
+
+        task = (task_help ? task.formatted_usage(self, false, subcommand) : task.name)
+        banner_base + " " + [subcommand_banner, task].compact.join(":")
+      end
+
+      def self.handle_no_task_error(task)
+        raise UndefinedTaskError, "Could not find command #{task.inspect}."
+      end
+
+      def self.subcommand(name, klass)
+        @@subcommand_class_for ||= {}
+        @@subcommand_class_for[name] = klass
+        super
+      end
+
+      def self.subcommand_class_for(name)
+        @@subcommand_class_for ||= {}
+        @@subcommand_class_for[name]
+      end
+
+    end
+
+    protected
+
+    def self.exit_on_failure?
+      true
+    end
+  end
+
+  # Patch handle_no_method_error? to work with rubinius' error text.
+  class ::Thor::Task
+    def handle_no_method_error?(instance, error, caller)
+      not_debugging?(instance) && (
+        error.message =~ /^undefined method `#{name}' for #{Regexp.escape(instance.to_s)}$/ ||
+        error.message =~ /undefined method `#{name}' on an instance of #{Regexp.escape(instance.class.name)}/
+      )
+    end
+  end
+end

data/lib/acquia_toolbelt/version.rb

@@ -0,0 +1,3 @@
+module AcquiaToolbelt
+  VERSION = '2.3.1'
+end

data/lib/acquia_toolbelt.rb

@@ -0,0 +1,4 @@
+require "acquia_toolbelt/version"
+
+module AcquiaToolbelt
+end

data/lib/vendor/thor/CHANGELOG.md

@@ -0,0 +1,139 @@
+## 0.18.1, release 2013-03-30
+* Revert regressions found in 0.18.0
+
+## 0.18.0, release 2013-03-26
+* Remove rake2thor
+* Only display colors if output medium supports colors
+* Pass parent_options to subcommands
+* Fix non-dash-prefixed aliases
+* Make error messages more helpful
+* Rename "task" to "command"
+* Add the method to allow for custom package name
+
+## 0.17.0, release 2013-01-24
+* Add better support for tasks that accept arbitrary additional arguments (e.g. things like `bundle exec`)
+* Add #stop_on_unknown_option!
+* Only strip from stdin.gets if it wasn't ended with EOF
+* Allow "send" as a task name
+* Allow passing options as arguments after "--"
+* Autoload Thor::Group
+
+## 0.16.0, release 2012-08-14
+* Add enum to string arguments
+
+## 0.15.4, release 2012-06-29
+* Fix regression when destination root contains reserved regexp characters
+
+## 0.15.3, release 2012-06-18
+* Support strict_args_position! for backwards compatibility
+* Escape Dir glob characters in paths
+
+## 0.15.2, released 2012-05-07
+* Added print_in_columns
+* Exposed terminal_width as a public API
+
+## 0.15.1, release 2012-05-06
+* Fix Ruby 1.8 truncation bug with unicode chars
+* Fix shell delegate methods to pass their block
+* Don't output trailing spaces when printing the last column in a table
+
+## 0.15, released 2012-04-29
+* Alias method_options to options
+* Refactor say to allow multiple colors
+* Exposed error as a public API
+* Exposed file_collision as a public API
+* Exposed print_wrapped as a public API
+* Exposed set_color as a public API
+* Fix number-formatting bugs in print_table
+* Fix "indent" typo in print_table
+* Fix Errno::EPIPE when piping tasks to `head`
+* More friendly error messages
+
+## 0.14, released 2010-07-25
+* Added CreateLink class and #link_file method
+* Made Thor::Actions#run use system as default method for system calls
+* Allow use of private methods from superclass as tasks
+* Added mute(&block) method which allows to run block without any output
+* Removed config[:pretend]
+* Enabled underscores for command line switches
+* Added Thor::Base.basename which is used by both Thor.banner and Thor::Group.banner
+* Deprecated invoke() without arguments
+* Added :only and :except to check_unknown_options
+
+## 0.13, released 2010-02-03
+* Added :lazy_default which is only triggered if a switch is given
+* Added Thor::Shell::HTML
+* Added subcommands
+* Decoupled Thor::Group and Thor, so it's easier to vendor
+* Added check_unknown_options! in case you want error messages to be raised in valid switches
+* run(command) should return the results of command
+
+## 0.12, released 2010-01-02
+* Methods generated by attr_* are automatically not marked as tasks
+* inject_into_file does not add the same content twice, unless :force is set
+* Removed rr in favor to rspec mock framework
+* Improved output for thor -T
+* [#7] Do not force white color on status
+* [#8] Yield a block with the filename on directory
+
+## 0.11, released 2009-07-01
+* Added a rake compatibility layer. It allows you to use spec and rdoc tasks on
+  Thor classes.
+* BACKWARDS INCOMPATIBLE: aliases are not generated automatically anymore
+  since it may cause wrong behavior in the invocation system.
+* thor help now show information about any class/task. All those calls are
+  possible:
+
+      thor help describe
+      thor help describe:amazing
+  Or even with default namespaces:
+
+      thor help :spec
+* Thor::Runner now invokes the default task if none is supplied:
+
+      thor describe # invokes the default task, usually help
+* Thor::Runner now works with mappings:
+
+      thor describe -h
+* Added some documentation and code refactoring.
+
+## 0.9.8, released 2008-10-20
+* Fixed some tiny issues that were introduced lately.
+
+## 0.9.7, released 2008-10-13
+* Setting global method options on the initialize method works as expected:
+  All other tasks will accept these global options in addition to their own.
+* Added 'group' notion to Thor task sets (class Thor); by default all tasks
+  are in the 'standard' group. Running 'thor -T' will only show the standard
+  tasks - adding --all will show all tasks. You can also filter on a specific
+  group using the --group option: thor -T --group advanced
+
+## 0.9.6, released 2008-09-13
+* Generic improvements
+
+## 0.9.5, released 2008-08-27
+* Improve Windows compatibility
+* Update (incorrect) README and task.thor sample file
+* Options hash is now frozen (once returned)
+* Allow magic predicates on options object. For instance: `options.force?`
+* Add support for :numeric type
+* BACKWARDS INCOMPATIBLE: Refactor Thor::Options. You cannot access shorthand forms in options hash anymore (for instance, options[:f])
+* Allow specifying optional args with default values: method_options(:user => "mislav")
+* Don't write options for nil or false values. This allows, for example, turning color off when running specs.
+* Exit with the status of the spec command to help CI stuff out some.
+
+## 0.9.4, released 2008-08-13
+* Try to add Windows compatibility.
+* BACKWARDS INCOMPATIBLE: options hash is now accessed as a property in your class and is not passed as last argument anymore
+* Allow options at the beginning of the argument list as well as the end.
+* Make options available with symbol keys in addition to string keys.
+* Allow true to be passed to Thor#method_options to denote a boolean option.
+* If loading a thor file fails, don't give up, just print a warning and keep going.
+* Make sure that we re-raise errors if they happened further down the pipe than we care about.
+* Only delete the old file on updating when the installation of the new one is a success
+* Make it Ruby 1.8.5 compatible.
+* Don't raise an error if a boolean switch is defined multiple times.
+* Thor::Options now doesn't parse through things that look like options but aren't.
+* Add URI detection to install task, and make sure we don't append ".thor" to URIs
+* Add rake2thor to the gem binfiles.
+* Make sure local Thorfiles override system-wide ones.

data/lib/vendor/thor/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gem 'rake', '>= 0.9'
+gem 'rdoc', '>= 3.9'
+
+group :development do
+  gem 'pry'
+  gem 'pry-debugger', :platforms => :mri_19
+end
+
+group :test do
+  gem 'childlabor'
+  gem 'coveralls', '>=0.5.7', :require => false
+  gem 'fakeweb', '>= 1.3'
+  gem 'rspec', '>= 2.14'
+  gem 'rspec-mocks', '>= 2.12.2'
+  gem 'simplecov', :require => false
+end
+
+gemspec

data/lib/vendor/thor/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
+
+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.