acquia_sdk_ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8210a7ea2066ad8da88280c4e8ddc879ce08d634
-  data.tar.gz: 7cce14d03026589de66e6b33fbf5aa83ea12718f
+  metadata.gz: efe078910a12b97cf314f3cb7b0a8754c8fc974f
+  data.tar.gz: 8ea0e1df7fd9eb0d43f970f741e17f115dfe35d9
 SHA512:
-  metadata.gz: 1408dbcb924e951f422fb7903ae582c731ab4f7333d82fbcec3819771d3a85b7c718ab2fbb133d6a8ab4ada19b47776397182edbf07250a7e2f8228333e67068
-  data.tar.gz: 6a4d5206361accda30df276ceabf41ab585788f5176ae3eb5d8235e48653aaaa45c8794ee3c315151689df530af88f172985046cc81a782707c67641f09d3344
+  metadata.gz: 556c298a7142154f4c229aff8d3ebcc443d8aad42017716661f863a01d6cd72d38e2c54618a9947149cb66cb510d9dd845bc71a300a7ff13a907a02832b45e2f
+  data.tar.gz: eeeea6faac539db0f956c4b6d2cfb815cd0a784c3cede394281d5f25c0364b6948c256de4df6ec07408164c62e1557c650aabe2cb1cecbe8fca5fd1feac1b52e

data/README.md

@@ -34,11 +34,21 @@ client = Acquia::CloudApi::Client.new({
 })
 
 # 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 
+# supported as well - just don't pass in the details and it will find it for
 # you.
 client = Acquia::CloudApi::Client.new
 ```
 
+### Make a request
+
+```rb
+client = Acquia::CloudApi::Client.new
+
+# Make a request to the 'sites.json' endpoint. This URL is relative to the
+# https://cloudapi.acquia.com/v1/ path.
+client.get 'sites.json'
+```
+
 ## Using a proxy or firewall?
 
 No problem! The Acquia gem includes the ability to leverage environment

data/lib/acquia_sdk_ruby/cloudapi/client.rb

@@ -5,27 +5,61 @@ require 'json'
 module Acquia
   module CloudApi
     class Client
+      attr_accessor :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?
+
+        @options = options
+      end
+
+      # Text representation of the client, masking sensitive information.
+      #
+      # Returns a string.
+      def inspect
+        inspected = super
+
+        # Mask the password.
+        if @options[:password]
+          inspected = inspected.gsub! @options[:password], conceal(@options[:password])
         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
+
+        inspected
+      end
+
+      # Internal: Get the default site for the user.
+      #
+      # Returns a string containing the users first site.
+      def default_site
+        response = get 'sites.json'
+        response.first
+      end
+
+      # Public: Make a GET HTTP request.
+      #
+      # url - The URL to request.
+      #
+      # Returns a Faraday::Connection object.
+      def get(url)
+        request :get, url
+      end
+
+      # Internal: Conceal parts of the string.
+      #
+      # Example:
+      #
+      #   conceal "thisismysensitivestring"
+      #   # => "this****ring"
+      #
+      # Returns a string with only the first and last 4 characters visible.
+      def conceal(string)
+        front = string[0, 4]
+        back  = string[-4, 4]
+        "#{front}****#{back}"
       end
 
       # Internal: Determine if the user is behind a firewall or proxy.
@@ -34,21 +68,21 @@ module Acquia
       def proxy?
         (ENV['HTTPS_PROXY'].nil?) ? false : true
       end
-    
+
       # Internal: Define the proxy options for requests.
       #
-      # Returns hash of proxy options.
+      # Returns hash of proxy options or nil if not in use.
       def proxy_opts
-        { uri: ENV['HTTPS_PROXY'] }
+        (proxy?) ? { uri: ENV['HTTPS_PROXY'] } : nil
       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
@@ -106,6 +140,31 @@ module Acquia
       def netrc_path
         "#{Dir.home}/.netrc"
       end
+
+      private
+
+      # Private: Make a HTTP request.
+      #
+      # url     - The relative URL of the resource to request.
+      # options - Hash of options to pass through to the request.
+      #
+      # Returns a JSON string of the body.
+      def request(method, url, options = {})
+        request = 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
+          c.use Faraday::Response::RaiseError
+        end
+
+        case method
+        when :get
+          response = request.get url
+        end
+
+        JSON.parse(response.body)
+      end
     end
   end
 end

data/lib/acquia_sdk_ruby/exceptions.rb

@@ -1,6 +1,7 @@
 module Acquia
   class MissingCloudApiCredentials < StandardError; end
   class MissingNetrcConfiguration < StandardError; end
-  class InvalidUserCredentials < StandardError; end
+
+  # Generic response error.
   class ApiRequestError < StandardError; end
 end

data/lib/acquia_sdk_ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acquia_sdk_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jacob Bednarz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler