acquia_toolbelt 2.3.1 → 2.3.2

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-  - "1.9.2"
-  - "1.9.3"
-  - "2.0.0"
-script: "bundle exec rspec spec"
-before_install: "ruby ./script/setup_build"
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+script: bundle exec rspec spec
+before_install: ruby ./script/setup_build

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acquia_toolbelt (2.3.1)
+    acquia_toolbelt (2.3.2)
       faraday (= 0.8.8)
       highline (= 1.6.19)
       json (= 1.8.0)

data/lib/acquia_toolbelt/cli/api.rb

@@ -1,14 +1,14 @@
-require "netrc"
-require "faraday"
-require "json"
-require "acquia_toolbelt/version"
+require 'netrc'
+require 'faraday'
+require 'json'
+require 'acquia_toolbelt/version'
 
 module AcquiaToolbelt
   class CLI
     class API
       USER_AGENT       = "AcquiaToolbelt/#{AcquiaToolbelt::VERSION}"
-      ENDPOINT         = "https://cloudapi.acquia.com"
-      ENDPOINT_VERSION = "v1"
+      ENDPOINT         = 'https://cloudapi.acquia.com'
+      ENDPOINT_VERSION = 'v1'
 
       # Internal: Send a request to the Acquia API.
       #
@@ -25,59 +25,64 @@ module AcquiaToolbelt
       #                 for the application.
       #
       # Retuns JSON object from the response body.
-      def self.request(resource, method = "GET", data = {}, parse_request = true)
-        n = Netrc.read
+      def self.request(resource, method = 'GET', data = {}, parse_request = true)
+        # If the netrc file has incorrect permissions, let the user know.
+        begin
+          n = Netrc.read
+        rescue => e
+          puts e.message
+        end
 
         # 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`"
+        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"]
+        @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 = (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}"
+        conn.headers['User-Agent'] = "#{AcquiaToolbelt::CLI::API::USER_AGENT}"
 
         case method
-        when "GET"
+        when 'GET'
           response = conn.get "#{endpoint_uri}/#{resource}.json"
-          is_successful_response? response
+          successful_response? response
 
           if parse_request == true
             JSON.parse(response.body)
           else
             response
           end
-        when "POST"
+        when 'POST'
           response = conn.post "#{endpoint_uri}/#{resource}.json", data.to_json
-          is_successful_response? response
+          successful_response? response
 
           if parse_request == true
             JSON.parse(response.body)
           else
             response
           end
-        when "QUERY-STRING-POST"
+        when 'QUERY-STRING-POST'
           response = conn.post "#{endpoint_uri}/#{resource}.json?#{data[:key]}=#{data[:value]}", data.to_json
-          is_successful_response? response
+          successful_response? response
 
           if parse_request == true
             JSON.parse(response.body)
           else
             response
           end
-        when "DELETE"
+        when 'DELETE'
           response = conn.delete "#{endpoint_uri}/#{resource}.json"
-          is_successful_response? response
+          successful_response? response
 
           if parse_request == true
             JSON.parse(response.body)
@@ -94,13 +99,13 @@ module AcquiaToolbelt
       # a subscription and returns them for use in other methods.
       #
       # Returns an array of environments.
-      def self.get_environments
+      def self.environments
         subscription = default_subscription
         env_data = request "sites/#{subscription}/envs"
 
         envs = []
         env_data.each do |env|
-          envs << env["name"]
+          envs << env['name']
         end
 
         envs
@@ -114,7 +119,7 @@ module AcquiaToolbelt
       #
       # Returns the first subscription name.
       def self.default_subscription
-        sites = request "sites"
+        sites = request 'sites'
         sites.first
       end
 
@@ -133,7 +138,7 @@ module AcquiaToolbelt
       #
       # Return boolean based on whether HTTPS_PROXY is set.
       def self.using_proxy?
-        ENV["HTTPS_PROXY"] ? true : false
+        ENV['HTTPS_PROXY'] ? true : false
       end
 
       # Internal: Show the error message from the response.
@@ -143,7 +148,7 @@ module AcquiaToolbelt
       #
       # Returns string of the message.
       def self.display_error(response)
-        "Oops, an error occurred! Reason: #{response["message"]}"
+        "Oops, an error occurred! Reason: #{response['message']}"
       end
 
       # Internal: Ensure the response returns a HTTP 200.
@@ -153,7 +158,7 @@ module AcquiaToolbelt
       # that won't complete.
       #
       # Returns false if the response code isn't a HTTP 200.
-      def self.is_successful_response?(response)
+      def self.successful_response?(response)
         if response.status != 200
           puts display_error(JSON.parse(response.body))
           return

data/lib/acquia_toolbelt/cli/auth.rb

@@ -1,6 +1,6 @@
-require "highline/import"
-require "netrc"
-require "acquia_toolbelt/cli"
+require 'highline/import'
+require 'netrc'
+require 'acquia_toolbelt/cli'
 
 module AcquiaToolbelt
   class CLI
@@ -11,20 +11,20 @@ module AcquiaToolbelt
       # requests.
       #
       # Returns a status message.
-      desc "login", "Login to your Acquia account."
+      desc 'login', 'Login to your Acquia account.'
       def login
         cli = HighLine.new
-        user = cli.ask("Enter your username: ")
-        password = cli.ask("Enter your password: ") { |q| q.echo = false }
+        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['cloudapi.acquia.com'] = user, password
         n.save
 
-        ui.success "Your user credentials have been successfully set."
+        ui.success 'Your user credentials have been successfully set.'
       end
     end
   end

data/lib/acquia_toolbelt/cli/database.rb

@@ -12,20 +12,20 @@ module AcquiaToolbelt
         #
         # 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"]}"
+          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."
+      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]
@@ -34,11 +34,11 @@ module AcquiaToolbelt
         end
 
         database     = options[:database]
-        add_database = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs", "POST", :db => "#{database}"
+        add_database = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs", 'POST', :db => "#{database}"
 
         puts "#{add_database}"
 
-        if add_database["id"]
+        if add_database['id']
           ui.success "Database '#{database}' has been successfully created."
         else
           ui.fail AcquiaToolbelt::CLI::API.display_error(add_database)
@@ -48,13 +48,13 @@ module AcquiaToolbelt
       # Public: Copy a database from one environment to another.
       #
       # Returns a status message.
-      desc "copy", "Copy a database from one environment to another."
+      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."
+        :desc => 'Name of the database to copy.'
       method_option :origin, :type => :string, :aliases => %w(-o), :required => true,
-        :desc => "Origin of the database to copy."
+        :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."
+        :desc => 'Target of where to copy the database.'
       def copy
         if options[:subscription]
           subscription = options[:subscription]
@@ -65,7 +65,7 @@ module AcquiaToolbelt
         database      = options[:database]
         origin        = options[:origin]
         target        = options[:target]
-        copy_database = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs/#{database}/db-copy/#{origin}/#{target}", "POST"
+        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}."
@@ -80,9 +80,9 @@ module AcquiaToolbelt
       # 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."
+      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]
@@ -91,9 +91,9 @@ module AcquiaToolbelt
         end
 
         database  = options[:database]
-        delete_db = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs/#{database}", "DELETE"
+        delete_db = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs/#{database}", 'DELETE'
 
-        if delete_db["id"]
+        if delete_db['id']
           ui.success "Database '#{database}' has been successfully deleted."
         else
           ui.fail AcquiaToolbelt::CLI::API.display_error(delete_database)
@@ -103,9 +103,9 @@ module AcquiaToolbelt
       # Public: List all databases available within a subscription.
       #
       # Returns a database listing.
-      desc "list", "List all databases."
+      desc 'list', 'List all databases.'
       method_option :database, :type => :string, :aliases => %w(-d),
-        :desc => "Name of the database to view."
+        :desc => 'Name of the database to view.'
       def list
         if options[:subscription]
           subscription = options[:subscription]
@@ -128,7 +128,7 @@ module AcquiaToolbelt
           databases = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs"
           databases.each do |db|
             ui.say
-            ui.say "#{db["name"]}"
+            ui.say "#{db['name']}"
             output_database_instance(db)
           end
 
@@ -137,7 +137,7 @@ module AcquiaToolbelt
           databases = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs"
           ui.say
           databases.each do |db|
-            say "> #{db["name"]}"
+            say "> #{db['name']}"
           end
         end
       end
@@ -145,9 +145,9 @@ module AcquiaToolbelt
       # 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."
+      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]
@@ -157,7 +157,7 @@ module AcquiaToolbelt
 
         database      = options[:database]
         environment   = options[:environment]
-        create_backup = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs/#{database}/backups", "POST"
+        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
@@ -168,9 +168,9 @@ module AcquiaToolbelt
       # 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."
+      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?
@@ -189,24 +189,24 @@ module AcquiaToolbelt
         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)}"
+          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."
+      desc 'restore', 'Restore a database from a backup.'
       method_option :id, :type => :string, :aliases => %w(-i),
-        :desc => "Backup ID to restore."
+        :desc => 'Backup ID to restore.'
        method_option :database, :type => :string, :aliases => %w(-d),
-        :desc => "Name of the database to restore."
+        :desc => 'Name of the database to restore.'
       def restore
         # Ensure we have an environment defined.
         if options[:environment].nil?
@@ -224,9 +224,9 @@ module AcquiaToolbelt
         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"
+        restore_db  = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs/#{database}/backups/#{backup_id}/restore", 'POST'
 
-        if restore_db["id"]
+        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)

data/lib/acquia_toolbelt/cli/deploy.rb

@@ -4,9 +4,9 @@ module AcquiaToolbelt
       # Public: Deploy a VCS branch or tag.
       #
       # Returns a status message.
-      desc "code", "Deploy a VCS branch or tag to an environment."
+      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."
+        :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'"
@@ -21,9 +21,9 @@ module AcquiaToolbelt
 
         environment = options[:environment]
         release     = options[:release]
-        data        = { :key => "path", :value => "#{release}" }
+        data        = { :key => 'path', :value => "#{release}" }
 
-        deploy_code = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/code-deploy", "QUERY-STRING-POST", data
+        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}."

data/lib/acquia_toolbelt/cli/domain.rb

@@ -8,13 +8,13 @@ module AcquiaToolbelt
         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."
+            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"
+          purge_request = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/domains/#{domain}/cache", 'DELETE'
 
-          if purge_request["id"]
+          if purge_request['id']
             ui.success "#{domain} has been successfully purged."
           else
             ui.fail AcquiaToolbelt::CLI::API.display_error(purge_request)
@@ -25,7 +25,7 @@ module AcquiaToolbelt
       # Public: List all domains on a subscription.
       #
       # Returns all domains.
-      desc "list", "List all domains."
+      desc 'list', 'List all domains.'
       def list
         # Set the subscription if it has been passed through, otherwise use the
         # default.
@@ -40,7 +40,7 @@ module AcquiaToolbelt
           environments = []
           environments << options[:environment]
         else
-          environments = AcquiaToolbelt::CLI::API.get_environments
+          environments = AcquiaToolbelt::CLI::API.environments
         end
 
         environments.each do |environment|
@@ -49,7 +49,7 @@ module AcquiaToolbelt
           ui.say "Environment: #{environment}" unless options[:environment]
 
           domains.each do |domain|
-            ui.say "> #{domain["name"]}"
+            ui.say "> #{domain['name']}"
           end
         end
       end
@@ -57,9 +57,9 @@ module AcquiaToolbelt
       # Public: Add a domain to the subscription.
       #
       # Returns a status message.
-      desc "add", "Add a domain."
+      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."
+        :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'"
@@ -74,9 +74,9 @@ module AcquiaToolbelt
 
         environment = options[:environment]
         domain      = options[:domain]
-        add_domain  = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/domains/#{domain}", "POST"
+        add_domain  = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/domains/#{domain}", 'POST'
 
-        if add_domain["id"]
+        if add_domain['id']
           ui.success "Domain #{domain} has been successfully added to #{environment}."
         else
           ui.fail AcquiaToolbelt::CLI::API.display_error(add_domain)
@@ -86,9 +86,9 @@ module AcquiaToolbelt
       # Public: Delete a domain from an environment.
       #
       # Returns a status message.
-      desc "delete", "Delete a domain."
+      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."
+        :desc => 'Full URL of the domain to delete - No slashes or protocols required.'
       def delete
         if options[:subscription]
           subscription = options[:subscription]
@@ -98,7 +98,7 @@ module AcquiaToolbelt
 
         environment   = options[:environment]
         domain        = options[:domain]
-        delete_domain = AcquiaToolbelt::CLI::API.request "/sites/#{subscription}/envs/#{environment}/domains/#{domain}", "DELETE"
+        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}."
@@ -110,9 +110,9 @@ module AcquiaToolbelt
       # Public: Purge a domains web cache.
       #
       # Returns a status message.
-      desc "purge", "Purge a domain's web cache."
+      desc 'purge', 'Purge a domain\'s web cache.'
       method_option :domain, :type => :string, :aliases => %w(-d),
-        :desc => "URL of the domain to purge."
+        :desc => 'URL of the domain to purge.'
       def purge
         if options[:subscription]
           subscription = options[:subscription]
@@ -135,10 +135,10 @@ module AcquiaToolbelt
           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"]}")
+              purge_domain("#{subscription}", "#{environment}", "#{domain['name']}")
             end
           else
-            ui.info "Ok, no action has been taken."
+            ui.info 'Ok, no action has been taken.'
           end
         end
       end
@@ -146,13 +146,13 @@ module AcquiaToolbelt
       # Public: Move domains from one environment to another.
       #
       # Returns a status message.
-      desc "move", "Move a domain to another environment."
+      desc 'move', 'Move a domain to another environment.'
       method_option :domains, :type => :string, :aliases => %w(-d),
-        :desc => "List of comma separated domains to move."
+        :desc => 'List of comma separated domains to move.'
       method_option :origin, :type => :string, :aliases => %w(-o),
-        :desc => "Origin environment to move the domains from."
+        :desc => 'Origin environment to move the domains from.'
       method_option :target, :type => :string, :aliases => %w(-t),
-        :desc => "Target environment to move the domains to."
+        :desc => 'Target environment to move the domains to.'
       def move
         if options[:subscription]
           subscription = options[:subscription]
@@ -160,13 +160,13 @@ module AcquiaToolbelt
           subscription = AcquiaToolbelt::CLI::API.default_subscription
         end
 
-        domains = options[:domains].split(",")
+        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"]
+        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)