acquia_toolbelt 2.3.0 → 2.3.1

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.tmp
+*.swp
+*.gem
+
+coverage/*
+tmp/*

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

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

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Submitting a Pull Request
+
+* Check out the README guide for getting the project setup and running locally.
+* Fork the repository.
+* Create a topic branch.
+* Add specs for your unimplemented feature or bug fix.
+* Run `script/test` from the repository root. If your specs and tests pass,
+  continue on, otherwise fix them.
+* Add documentation for your feature or bug fix.
+* Add, commit, and push your changes.
+* Submit a pull request.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    acquia_toolbelt (2.3.1)
+      faraday (= 0.8.8)
+      highline (= 1.6.19)
+      json (= 1.8.0)
+      multi_json (= 1.8.2)
+      netrc (= 0.7.7)
+      rainbow (= 1.1.4)
+      sshkey (= 1.6.0)
+      thor (= 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    highline (1.6.19)
+    json (1.8.0)
+    multi_json (1.8.2)
+    multipart-post (1.2.0)
+    netrc (0.7.7)
+    rainbow (1.1.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (0.9.7)
+    sshkey (1.6.0)
+    thor (0.18.1)
+    vcr (2.7.0)
+    webmock (1.15.2)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acquia_toolbelt!
+  bundler (~> 1.3)
+  rake (= 10.1.0)
+  rspec (= 2.14.1)
+  vcr (= 2.7.0)
+  webmock (= 1.15.2)

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Jacob Bednarz.
+
+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.

data/README.md

@@ -0,0 +1,149 @@
+# Acquia Toolbelt 
+
+The Acquia Toolbelt is a CLI tool for using the Acquia Cloud API. Some of the
+features include getting information around your servers, subscription,
+databases, tasks and domains.
+
+## Installation
+
+Installation is available (and recommended) via Ruby Gems.
+
+```bash
+$ gem install acquia_toolbelt
+```
+
+Once installed, the toolbelt is accessible via invoking `acquia` within the
+command line.
+
+## Usage
+You can see all available commands by running `acquia help`. Additonally, more
+information on each command is available via `acquia [COMMAND] help`.
+
+```bash
+$ acquia help
+
+Type 'acquia [COMMAND] help' for more details on subcommands or to show example usage.
+
+Commands:
+  acquia auth
+  acquia databases
+  acquia deploy
+  acquia domains
+  acquia environments
+  acquia files
+  acquia servers
+  acquia sites
+  acquia ssh
+  acquia svn
+  acquia tasks
+
+Options:
+  -s, [--subscription=SUBSCRIPTION]  # Name of a subscription you would like to target.
+  -e, [--environment=ENVIRONMENT]    # Environment to target for commands.
+  -v, [--verbose]                    # Increase the verbose output from the commands.
+```
+
+#### Example commands
+
+Without parameters:
+
+```bash
+$ acquia databases:list
+
+> mydb
+> mydb2
+```
+
+With parameters:
+
+```bash
+$ acquia databases:list -e dev -d mydb
+
+> Username: exampledb
+> Password: h5hKN4v2nc*1nd
+> Host: staging-1234
+> DB cluster: 1111
+> Instance name: mydb8717
+```
+
+## Getting started
+
+Before you can start using any commands, you need to first run
+`acquia auth:login`. This will write your login details to a local netrc file so
+that you won't be prompted for login details every time a request is made. After
+that, the sky is the limit!
+
+## FAQ
+
+**Q: Is there support for proxies and corporate firewalls?**
+
+**A:** By god yes. Proxies and corporate firewalls are the bane of my existence
+so there was no way this toolbelt _wasn't_ going to support it. To use a proxy,
+all you need to do is set your HTTPS_PROXY environment variable to the required
+value. Example:
+
+```bash
+$ export HTTPS_PROXY="http://myproxy.url.internal:1234"
+```
+
+Then to check the value was correctly set:
+
+```bash
+$ echo $HTTPS_PROXY
+$ http://myproxy.url.internal:1234
+```
+
+**Q: Is there somewhere I can see all the commands with required parameters?**
+
+**A:** Yep. Check out the
+[commands listing](https://github.com/jacobbednarz/acquia-toolbelt/wiki/Commands)
+in the [wiki](https://github.com/jacobbednarz/acquia-toolbelt/wiki).
+
+## Hacking on the Acquia Toolbelt
+
+The Acquia Toolbelt uses [VCR](https://github.com/vcr/vcr) for recording and
+replaying API fixtures during test runs - doing this allows the tests to stay
+fast and easy for anyone to run.
+
+Authenticated requests are currently using the user credentials from the netrc
+file on your local system. It is a good idea to have this setup first (simply
+by running `acquia auth:login`) as if you are recording new cassettes you will
+need to be able to make actual requests. Don't worry about your user credentials
+being stored in the fixtures as they are removed during the request and they
+will appear as ACQUIA_USERNAME and ACQUIA_PASSWORD in the requests
+respectively.
+
+Since the cassettes are periodically refreshed to match changes to the API,
+remember the keep the following in mind when making cassettes.
+
+* **Specs should be idempotent.** The HTTP calls made during a spec should be
+  able to be run over and over. This means deleting a known resource prior to
+  creating it if the name has to be unique.
+* **Specs should be able to be run in random order.** If a spec depends on
+  another resource as a fixture, make sure that's created in the scope of the
+  spec and not depend on a previous spec to create the data needed.
+* **Do not depend on authenticated user info.** Instead of asserting actual
+  values in resources, try to assert the existence of a key or that a response
+  is an Array. We're testing the client, not the API.
+
+### Running and writing new tests
+
+The testing is mainly done via [RSpec](https://github.com/rspec/rspec). To run
+the test suite, execute the `script/test` script in the root of the repository:
+
+```bash
+$ script/test
+```
+
+This will ensure all dependencies are installed and kick off the test suite.
+
+### Supported versions
+
+This library aims to support and is [tested against](https://travis-ci.org/jacobbednarz/acquia-toolbelt) the following Ruby implementations:
+
+* Ruby 1.9.2
+* Ruby 1.9.3
+* Ruby 2.0.0
+
+If you would like support for other implementations or versions, please open an
+issue and it can be looked into.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/acquia_toolbelt.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acquia_toolbelt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acquia_toolbelt'
+  spec.version       = AcquiaToolbelt::VERSION
+  spec.authors       = ['Jacob Bednarz']
+  spec.email         = ['jacob.bednarz@gmail.com']
+  spec.summary       = %q{A CLI tool for interacting with Acquia's hosting services.}
+  spec.description   = %q{The Acquia Toolbelt allows you to interact with the Acquia Cloud API via the CLI.}
+  spec.homepage      = 'https://github.com/jacobbednarz/acquia-toolbelt'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor', '0.18.1'
+  spec.add_runtime_dependency 'netrc', '0.7.7'
+  spec.add_runtime_dependency 'highline', '1.6.19'
+  spec.add_runtime_dependency 'faraday', '0.8.8'
+  spec.add_runtime_dependency 'json', '1.8.0'
+  spec.add_runtime_dependency 'rainbow', '1.1.4'
+  spec.add_runtime_dependency 'sshkey', '1.6.0'
+  spec.add_runtime_dependency 'multi_json', '1.8.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '10.1.0'
+  spec.add_development_dependency 'rspec', '2.14.1'
+  spec.add_development_dependency 'vcr', '2.7.0'
+  spec.add_development_dependency 'webmock', '1.15.2'
+end

data/bin/acquia

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'acquia_toolbelt/cli'
+
+begin
+  AcquiaToolbelt::CLI.start
+rescue
+  exit(1)
+end

data/lib/acquia_toolbelt/cli/api.rb

@@ -0,0 +1,164 @@
+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"
+
+      # Internal: Send a request to the Acquia API.
+      #
+      # Build a HTTP request to connect to the Acquia API and handle the JSON
+      # response accordingly.
+      #
+      # resource      - The resource URI that is after the version in the API
+      #                 URI.
+      # method        - HTTP verb to use on the request.
+      # data          - Data to send to the endpoint.
+      # parse_request - Whether to JSON parse the body before returning or just
+      #                 return the whole request object. The whole request is
+      #                 returned during tests whereas only the body is required
+      #                 for the application.
+      #
+      # Retuns JSON object from the response body.
+      def self.request(resource, method = "GET", data = {}, parse_request = true)
+        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"
+          is_successful_response? response
+
+          if parse_request == true
+            JSON.parse(response.body)
+          else
+            response
+          end
+        when "POST"
+          response = conn.post "#{endpoint_uri}/#{resource}.json", data.to_json
+          is_successful_response? response
+
+          if parse_request == true
+            JSON.parse(response.body)
+          else
+            response
+          end
+        when "QUERY-STRING-POST"
+          response = conn.post "#{endpoint_uri}/#{resource}.json?#{data[:key]}=#{data[:value]}", data.to_json
+          is_successful_response? response
+
+          if parse_request == true
+            JSON.parse(response.body)
+          else
+            response
+          end
+        when "DELETE"
+          response = conn.delete "#{endpoint_uri}/#{resource}.json"
+          is_successful_response? response
+
+          if parse_request == true
+            JSON.parse(response.body)
+          else
+            response
+          end
+        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
+
+      # Internal: Show the error message from the response.
+      #
+      # If the API request fails, this will get the "message" and allow that to
+      # be outputted to the end user to be a little more helpful.
+      #
+      # Returns string of the message.
+      def self.display_error(response)
+        "Oops, an error occurred! Reason: #{response["message"]}"
+      end
+
+      # Internal: Ensure the response returns a HTTP 200.
+      #
+      # If the response status isn't a HTTP 200, we need to find out why. This
+      # helps identify the issues earlier on and will prevent extra API calls
+      # that won't complete.
+      #
+      # Returns false if the response code isn't a HTTP 200.
+      def self.is_successful_response?(response)
+        if response.status != 200
+          puts display_error(JSON.parse(response.body))
+          return
+        end
+      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
+      # Public: Login to an Acquia account.
+      #
+      # Save the login details in a netrc file for use for all authenticated
+      # requests.
+      #
+      # Returns a status message.
+      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 }
+
+        # 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