acquia_toolbelt 1.5.1 → 2.0.0

data/lib/acquia_toolbelt/cli.rb

@@ -0,0 +1,102 @@
+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? ":"
+        given_args = given_args.flat_map {|e| e.split(':')}
+      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/cli/api.rb

@@ -0,0 +1,106 @@
+require "netrc"
+require "faraday"
+require "json"
+
+module AcquiaToolbelt
+  class CLI
+    class API
+      USER_AGENT       = "AcquiaToolbelt/#{AcquiaToolbelt::VERSION}"
+      ENDPOINT         = "https://cloudapi.acquia.com"
+      ENDPOINT_VERSION = "v1"
+
+      # Internal: Send a request to the Acquia API.
+      #
+      # Build a HTTP request to connect to the Acquia API and handle the JSON
+      # response accordingly.
+      #
+      # Retuns JSON object from the response body.
+      def self.request(resource, method = "GET", data = {})
+        n = Netrc.read
+
+        # Make sure there is an entry for the Acquia API before generating the
+        # requests.
+        if n["cloudapi.acquia.com"].nil?
+          puts "No entry for cloudapi.acquia.com within your netrc file."
+          puts "You can login/reset your user credentials by running 'acquia auth:login'"
+          return
+        end
+
+        @acquia_user, @acquia_password = n["cloudapi.acquia.com"]
+
+        # Check if the user is behind a proxy and add the proxy settings if
+        # they are.
+        conn = (using_proxy?) ? Faraday.new(:proxy => ENV["HTTPS_PROXY"]) : Faraday.new
+        conn.basic_auth(@acquia_user, @acquia_password)
+
+        # Be nice and send a user agent - help tracking and issue detection on
+        # Acquia's end as well as the client.
+        conn.headers["User-Agent"] = "#{AcquiaToolbelt::CLI::API::USER_AGENT}"
+
+        case method
+        when "GET"
+          response = conn.get "#{endpoint_uri}/#{resource}.json"
+          JSON.parse response.body
+        when "POST"
+          response = conn.post "#{endpoint_uri}/#{resource}.json", data.to_json
+          JSON.parse response.body
+        when "QUERY-STRING-POST"
+          response = conn.post "#{endpoint_uri}/#{resource}.json?#{data[:key]}=#{data[:value]}", data.to_json
+          JSON.parse response.body
+        when "DELETE"
+          response = conn.delete "#{endpoint_uri}/#{resource}.json"
+          JSON.parse response.body
+        else
+        end
+      end
+
+      # Internal: Get defined subscription environments.
+      #
+      # This is a helper method that fetches all the available environments for
+      # a subscription and returns them for use in other methods.
+      #
+      # Returns an array of environments.
+      def self.get_environments
+        subscription = default_subscription
+        env_data = request "sites/#{subscription}/envs"
+
+        envs = []
+        env_data.each do |env|
+          envs << env["name"]
+        end
+
+        envs
+      end
+
+      # Internal: Use the default environment the user has access to.
+      #
+      # If the -s (subscription) flag is not set, just use the first
+      # subscription the user has access to. This is handy for users that
+      # primarily only deal with a specific subscription.
+      #
+      # Returns the first subscription name.
+      def self.default_subscription
+        sites = request "sites"
+        sites.first
+      end
+
+      # Internal: Build the endpoint URI.
+      #
+      # By building the URI here, we ensure that it is consistent throughout the
+      # application and also allows a single point to update should it be
+      # needed.
+      #
+      # Returns a URI string.
+      def self.endpoint_uri
+        "#{AcquiaToolbelt::CLI::API::ENDPOINT}/#{AcquiaToolbelt::CLI::API::ENDPOINT_VERSION}"
+      end
+
+      # Internal: Check whether a proxy is in use.
+      #
+      # Return boolean based on whether HTTPS_PROXY is set.
+      def self.using_proxy?
+        ENV["HTTPS_PROXY"] ? true : false
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/auth.rb

@@ -0,0 +1,31 @@
+require "highline/import"
+require "netrc"
+require "acquia_toolbelt/cli"
+
+module AcquiaToolbelt
+  class CLI
+    class Auth < AcquiaToolbelt::Thor
+      desc "login", "Login to your Acquia account."
+      # Public: Login to an Acquia account.
+      #
+      # Save the login details in a netrc file for use for all authenticated
+      # requests.
+      #
+      # Returns a status message.
+      def login
+        cli = HighLine.new
+        user = cli.ask("Enter your username: ")
+        password = cli.ask("Enter your password: ") { |q| q.echo = false }
+
+        # Update (or create if needed) the netrc file that will contain the user
+        # authentication details.
+        n = Netrc.read
+        n.new_item_prefix = "# This entry was added for connecting to the Acquia Cloud API\n"
+        n["cloudapi.acquia.com"] = user, password
+        n.save
+
+        ui.success "Your user credentials have been successfully set."
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/database.rb

@@ -0,0 +1,208 @@
+module AcquiaToolbelt
+  class CLI
+    class Databases < AcquiaToolbelt::Thor
+      no_tasks do
+        # Internal: Build the database output.
+        #
+        # Output the database information exposing all the available fields and
+        # data to the end user.
+        #
+        # Returns multiple lines.
+        def output_database_instance(database)
+          ui.say "> Username: #{database["username"]}"
+          ui.say "> Password: #{database["password"]}"
+          ui.say "> Host: #{database["host"]}"
+          ui.say "> DB cluster: #{database["db_cluster"]}"
+          ui.say "> Instance name: #{database["instance_name"]}"
+        end
+      end
+
+      # Public: Add a database to the subscription.
+      #
+      # Returns a status message.
+      desc "add", "Add a database."
+      method_option :database, :type => :string, :aliases => %w(-d), :required => true,
+        :desc => "Name of the database to create."
+      def add
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        database     = options[:database]
+        add_database = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs", "POST", :db => "#{database}"
+        ui.success "Database '#{database}' has been successfully created." if add_database["id"]
+      end
+
+      # Public: Copy a database from one environment to another.
+      #
+      # Returns a status message.
+      desc "copy", "Copy a database from one environment to another."
+      method_option :database, :type => :string, :aliases => %w(-d), :required => true,
+        :desc => "Name of the database to copy."
+      method_option :origin, :type => :string, :aliases => %w(-o), :required => true,
+        :desc => "Origin of the database to copy."
+      method_option :target, :type => :string, :aliases => %w(-t), :required => true,
+        :desc => "Target of where to copy the database."
+      def copy
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        database      = options[:database]
+        origin        = options[:origin]
+        target        = options[:target]
+        copy_database = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs/#{database}/db-copy/#{origin}/#{target}", "POST"
+        ui.success "Database '#{database}' has been copied from #{origin} to #{target}." if copy_database["id"]
+      end
+
+      # Public: Delete a database from a subscription.
+      #
+      # NB: This will delete all instances of the database across all
+      # environments.
+      #
+      # Returns a status message.
+      desc "delete", "Delete a database."
+      method_option :database, :type => :string, :aliases => %w(-d), :required => true,
+        :desc => "Name of the database to delete."
+      def delete
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        database  = options[:database]
+        delete_db = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs/#{database}", "DELETE"
+        ui.success "Database '#{database}' has been successfully deleted." if delete_db["id"]
+      end
+
+      # Public: List all databases available within a subscription.
+      #
+      # Returns a database listing.
+      desc "list", "List all databases."
+      method_option :database, :type => :string, :aliases => %w(-d),
+        :desc => "Name of the database to view."
+      def list
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        database    = options[:database]
+        environment = options[:environment]
+
+        # Output a single database where the name and environment are specified.
+        if database && environment
+          database = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs/#{database}"
+          ui.say
+          output_database_instance(database)
+
+        # Only an environment was set so get all expanded data for the requested
+        # environment.
+        elsif environment
+          databases = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs"
+          databases.each do |db|
+            ui.say
+            ui.say "#{db["name"]}"
+            output_database_instance(db)
+          end
+
+        # Just a general listing of the databases, no in depth details.
+        else
+          databases = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs"
+          ui.say
+          databases.each do |db|
+            say "> #{db["name"]}"
+          end
+        end
+      end
+
+      # Public: Create a database instance backup.
+      #
+      # Returns a status message.
+      desc "backup", "Create a new backup for a database."
+      method_option :database, :type => :string, :aliases => %w(-d), :required => true,
+        :desc => "Name of the database to backup."
+      def backup
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        database      = options[:database]
+        environment   = options[:environment]
+        create_backup = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs/#{database}/backups", "POST"
+        ui.success "The backup for '#{database}' in #{environment} has been started." if create_backup["id"]
+      end
+
+      # Public: List available database backups.
+      #
+      # Returns all database backups.
+      desc "list-backups", "List all database backups."
+      method_option :database, :type => :string, :aliases => %w(-d), :required => true,
+        :desc => "Name of the database to get the backup for."
+      def list_backups
+        # Ensure we have an environment defined.
+        if options[:environment].nil?
+          ui.say "No value provided for required options '--environment'"
+          return
+        end
+
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        database    = options[:database]
+        environment = options[:environment]
+        backups     = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs/#{database}/backups"
+        backups.each do |backup|
+          ui.say
+          ui.say "> ID: #{backup["id"]}"
+          ui.say "> MD5: #{backup["checksum"]}"
+          ui.say "> Type: #{backup["type"]}"
+          ui.say "> Path: #{backup["path"]}"
+          ui.say "> Link: #{backup["link"]}"
+          ui.say "> Started: #{Time.at(backup["started"].to_i)}"
+          ui.say "> Completed: #{Time.at(backup["completed"].to_i)}"
+        end
+      end
+
+      # Public: Restore a database backup.
+      #
+      # Returns a status message.
+      desc "restore", "Restore a database from a backup."
+      method_option :id, :type => :string, :aliases => %w(-i),
+        :desc => "Backup ID to restore."
+       method_option :database, :type => :string, :aliases => %w(-d),
+        :desc => "Name of the database to restore."
+      def restore
+        # Ensure we have an environment defined.
+        if options[:environment].nil?
+          ui.say "No value provided for required options '--environment'"
+          return
+        end
+
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        database    = options[:database]
+        environment = options[:environment]
+        database    = options[:database]
+        backup_id   = options[:id]
+        restore_db  = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs/#{database}/backups/#{backup_id}/restore", "POST"
+        ui.success "Database backup #{backup_id} has been restored to #{database} in #{environment}." if restore_db["id"]
+      end
+    end
+  end
+end