acquia_sdk_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8210a7ea2066ad8da88280c4e8ddc879ce08d634
+  data.tar.gz: 7cce14d03026589de66e6b33fbf5aa83ea12718f
+SHA512:
+  metadata.gz: 1408dbcb924e951f422fb7903ae582c731ab4f7333d82fbcec3819771d3a85b7c718ab2fbb133d6a8ab4ada19b47776397182edbf07250a7e2f8228333e67068
+  data.tar.gz: 6a4d5206361accda30df276ceabf41ab585788f5176ae3eb5d8235e48653aaaa45c8794ee3c315151689df530af88f172985046cc81a782707c67641f09d3344

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jacob Bednarz
+
+MIT License
+
+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,57 @@
+# Acquia Ruby SDK
+
+The Acquia Ruby SDK allows developers to interact and build tools using the
+Acquia platform.
+
+## Requirements
+
+- Ruby 2.0+
+
+## Installation
+
+Pop the following into your Gemfile.
+
+```rb
+gem 'acquia_sdk_ruby'
+```
+
+Or if you would like to install it yourself, try this:
+
+```sh
+$ gem install acquia_sdk_ruby
+```
+
+## Usage examples
+
+### Cloud API
+
+```rb
+# Initiate a connection by passing in the user credentials.
+client = Acquia::CloudApi::Client.new({
+  username: 'my_user@example.com',
+  password: 'topsecretpassword',
+  site: 'devcloud:example'
+})
+
+# If you wish to leverage an existing cloudapi.conf or netrc entry, that is
+# supported as well - just don't pass in the details and it will find it for 
+# you.
+client = Acquia::CloudApi::Client.new
+```
+
+## Using a proxy or firewall?
+
+No problem! The Acquia gem includes the ability to leverage environment
+variables for defining proxies or firewall rules. Just define your gateway using
+the `HTTPS_PROXY` variable and it will be included for all requests.
+
+## Contributing
+
+- Fork this repository.
+- Create a new feature branch (`git checkout -b my-awesome-feature`).
+- Make your proposed changes.
+- Commit them to the feature branch.
+- Push up your changes and open a new pull request.
+
+_NB: If you are making code changes, they will require tests to accompany them
+otherwise your changes may accidently break in future releases._

data/lib/acquia_sdk_ruby/cloudapi/client.rb

@@ -0,0 +1,111 @@
+require 'netrc'
+require 'faraday'
+require 'json'
+
+module Acquia
+  module CloudApi
+    class Client
+      def initialize(options = {})
+        # Providing that we have both the username and the password, use it
+        # otherwise we will run through the available authentication sources to
+        # find our user details.
+        options[:username] ||= user_credentials[:username]
+        options[:password] ||= user_credentials[:password]
+       
+        # Build our connection using a proxy and correct SSL options.
+        connection = Faraday.new(url: Acquia.cloud_api_endpoint, ssl: ssl_opts) do |c|
+          c.adapter Faraday.default_adapter
+          c.headers['User-Agent'] = "Acquia SDK (#{Acquia::VERSION})"
+          c.basic_auth(options[:username], options[:password])
+          c.proxy = proxy_opts if proxy?
+        end
+        
+        response = connection.get 'sites.json'
+        fail InvalidUserCredentials, 'Invalid user credentials' if response.status == 401
+        
+        # Haven't made a site selection? Looks like you get the first one we
+        # find.
+        options[:site] ||= JSON.parse(response.body).first
+      end
+
+      # Internal: Determine if the user is behind a firewall or proxy.
+      #
+      # Returns a boolean based on whether the environment variable is found.
+      def proxy?
+        (ENV['HTTPS_PROXY'].nil?) ? false : true
+      end
+    
+      # Internal: Define the proxy options for requests.
+      #
+      # Returns hash of proxy options.
+      def proxy_opts
+        { uri: ENV['HTTPS_PROXY'] }
+      end
+      
+      # Internal: Build the SSL options for requests.
+      #
+      # Returns a hash of the SSL options to apply to requests.
+      def ssl_opts
+        { verify: true, ca_file: File.expand_path('etc/ca.pem') }
+      end
+      
+      # Internal: Get the user credentials from available sources.
+      #
+      # This method is responsible for checking the available sources and
+      # providing the user credentials back in a hash.
+      #
+      # Returns a hash of the user credentials keyed with 'username' and
+      # 'password'.
+      def user_credentials
+        acquia_conf_auth if File.exist? acquia_conf_path
+        netrc_auth if File.exist? netrc_path
+      end
+
+      # Internal: Pull the details out of the Acquia configuration file.
+      #
+      # This will find the Acquia Cloud configuration file and extract the
+      # username and password from the JSON object.
+      #
+      # Returns a hash of the username and password.
+      def acquia_conf_auth
+        user_data = JSON.parse(File.read(acquia_conf_path))
+        { username: user_data['email'], password: user_data['key'] }
+      end
+
+      # Internal: Fetch the user credentials from a netrc file.
+      #
+      # Check and see if the user has a local netrc entry for the Cloud API and
+      # should it be found, use it.
+      #
+      # Returns a hash of the username and password.
+      def netrc_auth
+        n = Netrc.read
+
+        # While netrc file may exist, we cannot always be certain that the Cloud
+        # API credentials are present.
+        if n['cloudapi.acquia.com'].nil?
+          fail MissingNetrcConfiguration, "No entry for cloudapi.acquia.com found in #{netrc_path}"
+        end
+
+        username = n['cloudapi.acquia.com'].login
+        password = n['cloudapi.acquia.com'].password
+
+        { username: username, password: password }
+      end
+
+      # Internal: Path to the Acquia Cloud configuration file.
+      #
+      # Returns a string of the file path to the cloudapi.conf file.
+      def acquia_conf_path
+        "#{Dir.home}/.acquia/cloudapi.conf"
+      end
+
+      # Internal: Path to the user's netrc.
+      #
+      # Returns a string of the file path to the users netrc file.
+      def netrc_path
+        "#{Dir.home}/.netrc"
+      end
+    end
+  end
+end

data/lib/acquia_sdk_ruby/cloudapi.rb

@@ -0,0 +1 @@
+require 'acquia_sdk_ruby/cloudapi/client'

data/lib/acquia_sdk_ruby/exceptions.rb

@@ -0,0 +1,6 @@
+module Acquia
+  class MissingCloudApiCredentials < StandardError; end
+  class MissingNetrcConfiguration < StandardError; end
+  class InvalidUserCredentials < StandardError; end
+  class ApiRequestError < StandardError; end
+end

data/lib/acquia_sdk_ruby/version.rb

@@ -0,0 +1,6 @@
+module Acquia
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR, MINOR, PATCH].join '.'
+end

data/lib/acquia_sdk_ruby.rb

@@ -0,0 +1,26 @@
+require 'acquia_sdk_ruby/version'
+require 'acquia_sdk_ruby/cloudapi'
+require 'acquia_sdk_ruby/exceptions'
+
+module Acquia
+  # Internal: The Cloud API endpoint as a full URI.
+  #
+  # Returns a string of the endpoint.
+  def self.cloud_api_endpoint
+    "#{cloud_api_uri}/#{cloud_api_version}/"
+  end
+
+  # Internal: The base URI of the Acquia Cloud API.
+  #
+  #  Returns a string of the base URI.
+  def self.cloud_api_uri
+    'https://cloudapi.acquia.com'
+  end
+
+  # Internal: Current version of the Cloud API.
+  #
+  # Returns a string which indicates the current version of the Cloud API.
+  def self.cloud_api_version
+    'v1'
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: acquia_sdk_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jacob Bednarz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A Ruby based SDK for interacting with the Acquia Hosting platform
+email:
+- jacob.bednarz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/acquia_sdk_ruby.rb
+- lib/acquia_sdk_ruby/cloudapi.rb
+- lib/acquia_sdk_ruby/cloudapi/client.rb
+- lib/acquia_sdk_ruby/exceptions.rb
+- lib/acquia_sdk_ruby/version.rb
+homepage: http://github.com/jacobbednarz/acquia-sdk-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Acquia Ruby SDK
+test_files: []