acquia_toolbelt 2.3.0 → 2.3.1

data/lib/acquia_toolbelt/cli/database.rb

@@ -0,0 +1,237 @@
+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.
+        #
+        # database - The name of the database you wish to fetch the information
+        #            about.
+        #
+        # 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}"
+
+        puts "#{add_database}"
+
+        if add_database["id"]
+          ui.success "Database '#{database}' has been successfully created."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(add_database)
+        end
+      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"
+
+        if copy_database["id"]
+          ui.success "Database '#{database}' has been copied from #{origin} to #{target}."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(copy_database)
+        end
+      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"
+
+        if delete_db["id"]
+          ui.success "Database '#{database}' has been successfully deleted."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(delete_database)
+        end
+      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"
+        if create_backup["id"]
+          ui.success "The backup for '#{database}' in #{environment} has been started."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(create_backup)
+        end
+      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"
+
+        if restore_db["id"]
+          ui.success "Database backup #{backup_id} has been restored to '#{database}' in #{environment}."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(restore_db)
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/deploy.rb

@@ -0,0 +1,36 @@
+module AcquiaToolbelt
+  class CLI
+    class Deploy < AcquiaToolbelt::Thor
+      # Public: Deploy a VCS branch or tag.
+      #
+      # Returns a status message.
+      desc "code", "Deploy a VCS branch or tag to an environment."
+      method_option :release, :type => :string, :aliases => %w(-r), :required => true,
+        :desc => "Name of the release to deploy to the environment."
+      def code
+        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
+
+        environment = options[:environment]
+        release     = options[:release]
+        data        = { :key => "path", :value => "#{release}" }
+
+        deploy_code = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/code-deploy", "QUERY-STRING-POST", data
+
+        if deploy_code["id"]
+          ui.success "#{release} has been deployed to #{environment}."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(deploy_code)
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/domain.rb

@@ -0,0 +1,177 @@
+module AcquiaToolbelt
+  class CLI
+    class Domains < AcquiaToolbelt::Thor
+      no_tasks do
+        # Internal: Purge a web cache for a domain.
+        #
+        # Returns a status message.
+        def purge_domain(subscription, environment, domain)
+          # Ensure all the required fields are available.
+          if subscription.nil? || environment.nil? || domain.nil?
+            ui.fail "Purge request is missing a required parameter."
+            return
+          end
+
+          purge_request = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/domains/#{domain}/cache", "DELETE"
+
+          if purge_request["id"]
+            ui.success "#{domain} has been successfully purged."
+          else
+            ui.fail AcquiaToolbelt::CLI::API.display_error(purge_request)
+          end
+        end
+      end
+
+      # Public: List all domains on a subscription.
+      #
+      # Returns all domains.
+      desc "list", "List all domains."
+      def list
+        # Set the subscription if it has been passed through, otherwise use the
+        # default.
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        # Get all the environments to loop over unless the environment is set.
+        if options[:environment]
+          environments = []
+          environments << options[:environment]
+        else
+          environments = AcquiaToolbelt::CLI::API.get_environments
+        end
+
+        environments.each do |environment|
+          domains = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/domains"
+          ui.say
+          ui.say "Environment: #{environment}" unless options[:environment]
+
+          domains.each do |domain|
+            ui.say "> #{domain["name"]}"
+          end
+        end
+      end
+
+      # Public: Add a domain to the subscription.
+      #
+      # Returns a status message.
+      desc "add", "Add a domain."
+      method_option :domain, :type => :string, :aliases => %w(-d), :required => true,
+        :desc => "Full URL of the domain to add - No slashes or protocols required."
+      def add
+        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
+
+        environment = options[:environment]
+        domain      = options[:domain]
+        add_domain  = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/domains/#{domain}", "POST"
+
+        if add_domain["id"]
+          ui.success "Domain #{domain} has been successfully added to #{environment}."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(add_domain)
+        end
+      end
+
+      # Public: Delete a domain from an environment.
+      #
+      # Returns a status message.
+      desc "delete", "Delete a domain."
+      method_option :domain, :type => :string, :aliases => %w(-d), :required => true,
+        :desc => "Full URL of the domain to delete - No slashes or protocols required."
+      def delete
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        environment   = options[:environment]
+        domain        = options[:domain]
+        delete_domain = AcquiaToolbelt::CLI::API.request "/sites/#{subscription}/envs/#{environment}/domains/#{domain}", "DELETE"
+
+        if delete_domain["id"]
+          ui.success "Domain #{domain} has been successfully deleted from #{environment}."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(delete_domain)
+        end
+      end
+
+      # Public: Purge a domains web cache.
+      #
+      # Returns a status message.
+      desc "purge", "Purge a domain's web cache."
+      method_option :domain, :type => :string, :aliases => %w(-d),
+        :desc => "URL of the domain to purge."
+      def purge
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        domain      = options[:domain]
+        environment = options[:environment]
+
+        # If the domain is not defined, we are going to clear a whole
+        # environment. This can have severe performance impacts on your
+        # environments. We need to be sure this is definitely what you want to
+        # do.
+        if domain
+          purge_domain(subscription, environment, domain)
+        else
+          all_env_clear = ui.ask "You are about to clear all domains in the #{environment} environment. Are you sure? (y/n)"
+          # Last chance to bail out.
+          if all_env_clear == "y"
+            domains = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/domains"
+            domains.each do |domain|
+              purge_domain("#{subscription}", "#{environment}", "#{domain["name"]}")
+            end
+          else
+            ui.info "Ok, no action has been taken."
+          end
+        end
+      end
+
+      # Public: Move domains from one environment to another.
+      #
+      # Returns a status message.
+      desc "move", "Move a domain to another environment."
+      method_option :domains, :type => :string, :aliases => %w(-d),
+        :desc => "List of comma separated domains to move."
+      method_option :origin, :type => :string, :aliases => %w(-o),
+        :desc => "Origin environment to move the domains from."
+      method_option :target, :type => :string, :aliases => %w(-t),
+        :desc => "Target environment to move the domains to."
+      def move
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        domains = options[:domains].split(",")
+        origin  = options[:origin]
+        target  = options[:target]
+        data    = { :domains => domains }
+
+        move_domain = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/domain-move/#{origin}/#{target}", "POST", data
+        if move_domain["id"]
+          ui.success "Domain move from #{origin} to #{target} has been successfully completed."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(move_domain)
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/environment.rb

@@ -0,0 +1,71 @@
+module AcquiaToolbelt
+  class CLI
+    class Environments < AcquiaToolbelt::Thor
+      # Public: List environments on a subscription.
+      #
+      # Output environment information.
+      #
+      # Returns enviroment data.
+      desc "list", "List all environment data."
+      def list
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        environment = options[:environment]
+
+        # If the environment option is set, just fetch a single environment.
+        if environment
+          environments = [environment]
+        else
+          environments = AcquiaToolbelt::CLI::API.get_environments
+        end
+
+        environments.each do |environment|
+          env_info = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}"
+          ui.say
+          ui.say "> Host: #{env_info["ssh_host"]}"
+          ui.say "> Environment: #{env_info["name"]}"
+          ui.say "> Current release: #{env_info["vcs_path"]}"
+          ui.say "> DB clusters: #{env_info["db_clusters"].join(', ')}"
+          ui.say "> Default domain: #{env_info["default_domain"]}"
+        end
+      end
+
+      # Public: Toggle whether live development is enabled on an environment.
+      #
+      # Valid actions are enable or disable.
+      #
+      # Returns a status message.
+      desc "live-development", "Enable/disbale live development on an environment."
+      method_option :action, :type => :string, :aliases => %w(-a), :required => true,
+        :desc => "Status of live development (enable/disable).",
+        :enum => ["enable", "disable"]
+      def live_development
+        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
+
+        action      = options[:action]
+        environment = options[:environment]
+
+        live_development_set = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/livedev/#{action}", "POST"
+
+        if live_development_set["id"]
+          ui.success "Live development has been successfully #{action}d on #{environment}."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(live_development_set)
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/file.rb

@@ -0,0 +1,31 @@
+module AcquiaToolbelt
+  class CLI
+    class Files < AcquiaToolbelt::Thor
+      # Public: Copy files from one environment to another.
+      #
+      # Returns a status message from the task.
+      desc "copy", "Copy files from one environment to another."
+       method_option :origin, :type => :string, :aliases => %w(-o), :required => true,
+        :desc => "Source environment for the file copy."
+      method_option :target, :type => :string, :aliases => %w(-t), :required => true,
+        :desc => "Target environment for the file copy."
+      def copy
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        source    = options[:origin]
+        target    = options[:target]
+        file_copy = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/files-copy/#{source}/#{target}", "POST"
+
+        if file_copy["id"]
+          ui.success "File copy from #{source} to #{target} has started."
+        else
+          ui.fail AcquiaToolbelt::CLI::API.display_error(file_copy)
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/server.rb

@@ -0,0 +1,67 @@
+module AcquiaToolbelt
+  class CLI
+    class Servers < AcquiaToolbelt::Thor
+      desc "list", "List all servers."
+      def list
+        if options[:subscription]
+          subscription = options[:subscription]
+        else
+          subscription = AcquiaToolbelt::CLI::API.default_subscription
+        end
+
+        environment = options[:environment]
+        # Determine if we want just a single environment, or all of them at once.
+        if environment
+          environments = [environment]
+        else
+          environments = AcquiaToolbelt::CLI::API.get_environments
+        end
+
+        # Loop over each environment and get all the associated server data.
+        environments.each do |environment|
+          ui.say
+          ui.say "Environment: #{environment}"
+
+          server_env = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/servers"
+          server_env.each do |server|
+            ui.say
+            ui.say "> Host: #{server["fqdn"]}"
+            ui.say "> Region: #{server["ec2_region"]}"
+            ui.say "> Instance type: #{server["ami_type"]}"
+            ui.say "> Availability zone: #{server["ec2_availability_zone"]}"
+
+            # Show how many PHP processes this node can have. Note, this is only
+            # available on the web servers.
+            if server["services"] && server["services"]["php_max_procs"]
+              ui.say "> PHP max processes: #{server["services"]["php_max_procs"]}"
+            end
+
+            if server["services"] && server["services"]["status"]
+              ui.say "> Status: #{server["services"]["status"]}"
+            end
+
+            if server["services"] && server["services"]["web"]
+              ui.say "> Web status: #{server["services"]["web"]["status"]}"
+            end
+
+            # The state of varnish.
+            if server["services"] && server["services"]["varnish"]
+              ui.say "> Varnish status: #{server["services"]["varnish"]["status"]}"
+            end
+
+            # Only load balancers will have the "external IP" property.
+            if server["services"] && server["services"]["external_ip"]
+              ui.say "> External IP: #{server["services"]["external_ip"]}"
+            end
+
+            # If running a dedicated load balancer, there will be a ELB domain
+            # associated with the load balancing tier.
+            if server["services"] && server["services"]["elb_domain_name"]
+              ui.say "> ELB hostname: #{server["services"]["elb_domain_name"]}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acquia_toolbelt/cli/site.rb

@@ -0,0 +1,28 @@
+module AcquiaToolbelt
+  class CLI
+    class Sites < AcquiaToolbelt::Thor
+      # Public: List all subscriptions the user has access to.
+      #
+      # Returns a list of subscriptions.
+      desc "list", "List all subscriptions you have access to."
+      def list
+        sites = AcquiaToolbelt::CLI::API.request "sites"
+
+        sites.each do |site|
+          ui.say
+          # Get the individual subscription information.
+          site_data = AcquiaToolbelt::CLI::API.request "sites/#{site}"
+
+          ui.say "#{site_data["title"]}"
+          ui.say "> Username: #{site_data["unix_username"]}"
+          ui.say "> Subscription: #{site_data["name"]}"
+
+          # If the VCS type is SVN, we want it in all uppercase, otherwise just
+          # capitilise it.
+          vcs_name = (site_data["vcs_type"] == "svn") ? site_data["vcs_type"].upcase : site_data["vcs_type"].capitalize
+          ui.say "> #{vcs_name} URL: #{site_data["vcs_url"]}"
+        end
+      end
+    end
+  end
+end