rest_connection 0.1.1 → 0.1.2

data/README.rdoc

@@ -19,7 +19,7 @@ Copy the example from GEMHOME/rest_connection/examples/rest_api_config.yaml.samp
   "gem install gemedit"
   "gem edit rest_connection"
 
-== Usage: some IRB samples
+== Usage: some IRB samples for the RightScale API module
 
   $ irb
   ruby> require 'rubygems'; require 'rest_connection'

data/Rakefile

@@ -2,8 +2,8 @@ require 'rubygems'
 require 'jeweler'
 Jeweler::Tasks.new do |gemspec|
   gemspec.name = "rest_connection"
-  gemspec.summary = "lib for restful connections to the rightscale api"
-  gemspec.description = "provides rest_connection"
+  gemspec.summary = "Modular RESTful API library"
+  gemspec.description = "Current implemented modules: RightScale API"
   gemspec.email = ["jeremy@rubyonlinux.org", "tw.rodriguez@gmail.com"]
   gemspec.homepage = "http://github.com/twrodriguez/rest_connection"
   gemspec.authors = ["Jeremy Deininger", "Timothy Rodriguez"]
@@ -13,4 +13,3 @@ Jeweler::Tasks.new do |gemspec|
   gemspec.add_dependency('highline')
 end
 Jeweler::GemcutterTasks.new
-

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/git_hooks/post-commit

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+puts <<EOS
+                                      ..,ONMMMMMO.
+                                      NM8~:~:.,+NMM=
+                                     MO          .MM:
+                                    NM.           ,MN
+  ..                              .7MN         . . 8M,
+==. ?N:                           .MMN .,,..  8$ZZ.~MN
+.$.    N8    ,DD.                 ,MMN ...+:.      .MMM
+  D      8D.Z=  .$.               NMMM..,~8I  ,88+. MMMM:.
+   ,~...  ,MM   .N .              MMMM7.       .... MMMMM,
+ DZ.. .:OZ.:M. ..8=              .MMMM.            .OMMMMM
+ :7 .      8+$M:.D+              +MMMM,  .:N+,MMD:  7MMMMM.
+ .MM7:.... 8    .M.              7MMMMM. MMMMZMMMMO.7MMMMM.
+,?.  ..  ..8    ,M               =MMMMM MMN8$7O8DMM.OMMM~ +.
+ N..   .  .+    M,               .MMMMMOM M8. .OM.MIMMMZ  =,.
+ =NZI+~,  +    I8                .MMMMMMM= .=DD,  MMMMMI  ~~
+ O.      .N   + M.              IMMMMMMMMMD ~MN 7MMMMMMM  .Z
+ .MNZZNMZ.    . MM             7MMMMMMMMMMMMMMMMMMMMMMMM, .~M,.
+    ID=. .  .   MMI            MMMMMMMMMMMMMMMMMMMMMMMMMD.    .+N
+   .DMO,ZND+.   MMM.          :MMMMMMMMN =MMMMMMMMN:ZMMM,.    +M~,$OD$
+   .MMO...      MMM           OMMMMMMMM~ . ,I++O7.  OMMM= .IM7 . .=..+MNI.
+   .8MO        :MMM         .MMMMMMMMMM.            MMMMM=       ~D   ?MO:7MN...
+   +$ON.       $NMM        .NMMMMMMMMM7.           .MMMMM.   .8Z.      :7N...MM:
+   O7?N        M+MMNMMMMMMMMMMMMMMMMMN              MMMMMM8D. .   $,  .$8 M  ..,$MN~,,.
+   N$:=M.    .NM.MM.           ?MMMMMMO. ..         D IO$IM:D.,$O, ,.  O.I,Z       :M:  .+MI
+   MO, MMI ..NM8.MM. =.            MM..IMN7,.  .,IDN7~MMMMMM,      N  .Z N.M.       ,M.     =N.
+  .MO. MMMMMMMM::MM  .:             .    .M :+I?=D.~.MMMMMMM?,,~INMMNNM+ ~ ~.        D8.     ,8.
+  .M8. MMMMMMMM ZM$.  8                   7.     ~ M,MM+MMMMMMMMMMMMMMM.. , :        ,M.     .O+
+  .MO. MMMMMMMI.MM,   N                    = .....,IDI. MMMMMMMM8MMMMMM.. =           M+      .M.
+  .MZ~.MMMMMMM..MM .  N     .=.              ?M,NMMMMMM?~MM$IMMM7MMMMM7               :O       M
+   M7I.NMMMMM8.$MZ.~  8     .~,          : MMMMMMMMMMMMM.~OOIMMM+MMMMM,               .N       M
+   N=D OMMMMM, MM  O .I      .7.      MMMMMMMMMMMMMMMMMMMMMD7NMM:MMMMN                 D      .M
+   O:M,~MMMMD NM?  D.=,       8       OMMMMMMMMMMMMMMMMMMMMMZZMM?MMMM: ...             Z      .M
+   +=M$ MMMZ :MN  ~, D.       I.      ~MMMMMMM+,,~I,  .NMMMMMZ.MDNMM7   I.             .      .M.
+   .$NM .,.. MM  .M :N.       :~      .MMMMMM.          MMMMMMZ=M,MM.  .M.                    7M
+   .N.MM~  $MZ.  O. N?         N.    ,MMMMMMM.          MMMMMMMM+8Z:   NZ.            .      .MI.
+   .M.=MMMMN.. .+=..M.         M.    NMMMMMMMD         8MMMMMMM.MMM.  $M. .           ?,     ~M.
+    +. ~MM ..  $,  M:          N:    . 7MMMMMMN      .~MMMMMM8,MMMMMMMMMMM         ..M.     :MM
+     D   N . ,M N NN.          I8.      $MMMMMMM?.. .?MMMMMMM?OMMMMMMMMMMMMMMMMMMMMI   . ...MM$
+     7?   .?N.7O DM            ,M      ZMMMMMMMMMM7.IMMMMMMMMD$MMMMMMMMMMMMMMMMMMMMMMMMZ: IMMN.
+     .~MM?.=NM~DM8..            M        8MMMMMMMMMMMMMMMMM7=MMMMMMMMMMMMMMMMMD.IMMMNZZNMMN~
+EOS

data/git_hooks/pre-commit

@@ -1,39 +1,119 @@
 #!/bin/bash
 
+lod_message() {
+  cat <<EOS
+
+                 OMM                                              MM$
+                 MMMM                                             MMMM
+                   MMM                                              MMO
+                   =MM                                              MMM
+                   MMM                                              MMD
+MMMMMMMMMMMMMMMMMMMMM                           NMMMMMMMMMMMMMMMMMMMMM
+MMMMMMMMMMMMMMMMMMMM                            NMMMMMMMMMMMMMMMMMMM,
+   MMMM?      ?MMMM                                =MMMM       MMMMD
+ =MMM           ?MMM                              MMMM           MMMN
+:MMM              MMM                            NMM=             =MMD
+MMM               ,MMO                           MMM               DMM
+MMM      MMMD      MMM                          DMM?     ,MMM,      MMD
+MMM      MMM$      MMM                          NMM?      MMM       MMN
+MMM                MMM                          OMMM               =MMO
+MMMN              NMM$                           MMM               MMM
+ MMM?            MMMM                            DMMM             MMM$
+  MMMM:        :MMMM                              DMMMM         MMMM$
+   =MMMMMMMMMMMMMM?                                 MMMMMMMMMMMMMMM
+     MMMMMMMMMMM                                      MMMMMMMMMMM
+
+
+
+
+                       DMMMMMMMMMMMMMMMMMMMMMMM
+
+EOS
+}
+
 whitespace=""
+echo "Checking for syntax errors..."
 for FILE in `git diff-index --name-only HEAD --` ; do
-  if test -e $FILE; then
-    if [[ -n `grep "\\s\\s*$" $FILE` ]]; then whitespace="$whitespace $FILE"; fi
-    # Remove trailing whitespace
-    sed -i "s/\\s\\s*$//g" $FILE
-    # Remove tabs
-    sed -i "s/\t/  /g" $FILE
-    # If a file is ruby, check for syntax errors
-    if [[ -n `find $FILE -regex ".*\.rb$"` ]]; then
+  if test -f $FILE; then
+    filetype=`file -b $FILE`
+    if [[ "$filetype" =~ "text" ]]; then
+      if [[ -n `grep "\\s\\s*$" $FILE` ]]; then whitespace="$whitespace $FILE"; fi
+      # Remove trailing whitespace
+      sed -i "s/\\s\\s*$//g" $FILE
+      # Remove tabs
+      sed -i "s/\t/  /g" $FILE
+    fi
+
+    # If a file is ruby, check for syntax errors using ruby
+    if [[ "$FILE" =~ .*\.rb$ ]]; then
       if [[ "$fail" -eq 0 || -z "$fail" ]]; then
-        `ruby -c $FILE 1> /dev/null`; fail=$?
+        ruby -c "$FILE" 1> /dev/null; fail=$?
+        if [[ "$fail" -ne 0 ]]; then echo "Syntax Error found in '$FILE'"; fi
       else
-        `ruby -c $FILE 1> /dev/null`
+        ruby -c "$FILE" 1> /dev/null
+        if [[ "$?" -ne 0 ]]; then echo "Syntax Error found in '$FILE'"; fi
+      fi
+    fi
+
+    # If a file is json, check for syntax errors
+    if [[ "$FILE" =~ .*\.json$ ]]; then
+      if [[ "$fail" -eq 0 || -z "$fail" ]]; then
+        ruby -e "require 'rubygems'; require 'json'; JSON::parse(IO.read('$FILE'))" 1> /dev/null; fail=$?
+        if [[ "$fail" -ne 0 ]]; then echo "Syntax Error found in '$FILE'"; fi
+      else
+        ruby -e "require 'rubygems'; require 'json'; JSON::parse(IO.read('$FILE'))" 1> /dev/null
+        if [[ "$?" -ne 0 ]]; then echo "Syntax Error found in '$FILE'"; fi
+      fi
+    fi
+
+    # If a file is yaml, check for syntax errors
+    if [[ "$FILE" =~ .*\.yaml$ ]]; then
+      if [[ "$fail" -eq 0 || -z "$fail" ]]; then
+        ruby -e "require 'rubygems'; require 'yaml'; YAML::load(IO.read('$FILE'))" 1> /dev/null; fail=$?
+        if [[ "$fail" -ne 0 ]]; then echo "Syntax Error found in '$FILE'"; fi
+      else
+        ruby -e "require 'rubygems'; require 'yaml'; YAML::load(IO.read('$FILE'))" 1> /dev/null
+        if [[ "$?" -ne 0 ]]; then echo "Syntax Error found in '$FILE'"; fi
       fi
     fi
   fi
 done
+echo "Syntax check complete."
 
 # Built-in git checks
 git diff-index --check HEAD --
 
 if [[ "$fail" -ne 0 && -n "$fail" ]]; then
   echo "Syntax Errors Found. Aborting commit"
+  lod_message
+  exit 1
+fi
+
+# Check for warnings
+fail=0
+for FILE in `git diff-index --name-only HEAD --` ; do
+  if test -e $FILE; then
+    # If a file is ruby, check for syntax errors
+    if [[ -n `find $FILE -regex ".*\.rb$"` ]]; then
+      warnings=`ruby -c "$FILE" 2>&1 | grep -i warn`
+      if [[ -n "$warnings" ]]; then fail=1; fi
+    fi
+  fi
+done
+
+if [[ "$fail" -ne 0 && -n "$fail" ]]; then
+  echo "Syntax Warnings Found. Aborting commit"
+  lod_message
   exit 1
 fi
 
 for FILE in $whitespace; do
   echo "Whitespace problem fixed. Please re-add '$FILE' to your commit"
 done
-if [[ -n "$whitespace" ]]; then exit 1; fi
+if [[ -n "$whitespace" ]]; then lod_message; exit 1; fi
 
 # Check that project metadata files exist
-for FILE in "Rakefile" "README.rdoc" "VERSION" ".gitignore" "rest_connection.gemspec"; do
+for FILE in "README.rdoc" "VERSION" ".gitignore" "Rakefile"; do
   if test ! -e $FILE; then
     echo "$FILE not present. Aborting commit"
     exit 1
@@ -44,10 +124,14 @@ done
 username=`git config --get user.name`
 useremail=`git config --get user.email`
 emaildomain=`echo $useremail | grep -o "[^@]*$"`
-if [[ "$username" == "" ]]; then
+if [[ "$username" == "Put Your Name Here" || "$username" == "" ]]; then
   echo "Please set your git user.name by running 'git config user.name <your github username>'"
+  lod_message
   exit 1
-elif [[ "$useremail" == "" ]] || ! host "$emaildomain" &> /dev/null; then
+elif [[ "$useremail" == "setyouremail@rightscale.com" || "$useremail" == "" ]] || ! host "$emaildomain" &> /dev/null; then
   echo "Please set your git user.email by running 'git config user.email <your github email>'"
+  lod_message
   exit 1
 fi
+
+exit 0

data/lib/rest_connection.rb

@@ -132,17 +132,48 @@ module RestConnection
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
       headers = @settings[:common_headers]
-      headers.merge!("Cookie" => @cookie) if @cookie
       http.start do |http|
-        req = yield(uri, headers)
-        unless @cookie
-          req.basic_auth(@settings[:user], @settings[:pass]) if @settings[:user]
+        @max_retries = 3
+        ret = nil
+        begin
+          headers.delete("Cookie")
+          headers.merge!("Cookie" => @cookie) if @cookie
+          req = yield(uri, headers)
+          logger("#{req.method}: #{req.path}")
+          logger("\trequest body: #{req.body}") if req.body and req.body !~ /password/
+          req.basic_auth(@settings[:user], @settings[:pass]) if @settings[:user] unless @cookie
+
+          response, body = http.request(req)
+          ret = handle_response(response)
+        rescue Exception => e
+          raise unless error_handler(e)
+          retry
+        end
+        ret
+      end
+    end
+
+    def error_handler(e)
+      case e
+      when EOFError, Timeout::Error
+        if @max_retries >= 0
+          logger("Caught #{e}. Retrying...")
+          @max_retries -= 1
+          return true
+        end
+      when RestConnection::Errors::Forbidden
+        if @max_retries >= 0
+          if e.response.body =~ /(session|cookie).*(invalid|expired)/i
+            logger("Caught '#{e.response.body}'. Refreshing cookie...")
+            refresh_cookie if respond_to?(:refresh_cookie)
+          else
+            return false
+          end
+          @max_retries -= 1
+          return true
         end
-        logger("#{req.method}: #{req.path}")
-        logger("\trequest body: #{req.body}") if req.body and req.body !~ /password/
-        response, body = http.request(req)
-        handle_response(response)
       end
+      return false
     end
 
     # connection.get("/root/login", :test_header => "x", :test_header2 => "y")
@@ -151,9 +182,9 @@ module RestConnection
     # additional_parameters = Hash or String of parameters to pass to HTTP::Get
     def get(href, additional_parameters = "")
       rest_connect do |base_uri,headers|
-        href = "#{base_uri}/#{href}" unless begins_with_slash(href)
+        new_href = (href =~ /^\// ? href : "#{base_uri}/#{href}")
         params = requestify(additional_parameters) || ""
-        new_path = URI.escape(href + @settings[:extension] + "?") + params
+        new_path = URI.escape(new_href + @settings[:extension] + "?") + params
         Net::HTTP::Get.new(new_path, headers)
       end
     end
@@ -165,8 +196,8 @@ module RestConnection
     # additional_parameters = Hash or String of parameters to pass to HTTP::Post
     def post(href, additional_parameters = {})
       rest_connect do |base_uri, headers|
-        href = "#{base_uri}/#{href}" unless begins_with_slash(href)
-        res = Net::HTTP::Post.new(href , headers)
+        new_href = (href =~ /^\// ? href : "#{base_uri}/#{href}")
+        res = Net::HTTP::Post.new(new_href , headers)
         unless additional_parameters.empty?
           res.set_content_type('application/json')
           res.body = additional_parameters.to_json
@@ -183,8 +214,8 @@ module RestConnection
     # additional_parameters = Hash or String of parameters to pass to HTTP::Put
     def put(href, additional_parameters = {})
       rest_connect do |base_uri, headers|
-        href = "#{base_uri}/#{href}" unless begins_with_slash(href)
-        new_path = URI.escape(href)
+        new_href = (href =~ /^\// ? href : "#{base_uri}/#{href}")
+        new_path = URI.escape(new_href)
         req = Net::HTTP::Put.new(new_path, headers)
         req.set_content_type('application/json')
         req.body = additional_parameters.to_json
@@ -199,8 +230,8 @@ module RestConnection
     # additional_parameters = Hash or String of parameters to pass to HTTP::Delete
     def delete(href, additional_parameters = {})
       rest_connect do |base_uri, headers|
-        href = "#{base_uri}/#{href}" unless begins_with_slash(href)
-        new_path = URI.escape(href)
+        new_href = (href =~ /^\// ? href : "#{base_uri}/#{href}")
+        new_path = URI.escape(new_href)
         req = Net::HTTP::Delete.new(href, headers)
         req.set_content_type('application/json')
         req.body = additional_parameters.to_json
@@ -226,14 +257,10 @@ module RestConnection
           return res
         end
       else
-        raise "invalid response HTTP code: #{res.code.to_i}, #{res.code}, #{res.body}"
+        raise RestConnection::Errors.status_error(res)
       end
     end
 
-    def begins_with_slash(href)
-      href =~ /^\//
-    end
-
     def logger(message)
       init_message = "Initializing Logging using "
       if @@logger.nil?
@@ -250,7 +277,7 @@ module RestConnection
       if @settings.nil?
         @@logger.info(message)
       else
-        @@logger.info("[API v#{@settings[:common_headers]['X_API_VERSION']} ]" + message)
+        @@logger.info("[API v#{@settings[:common_headers]['X_API_VERSION']}] " + message)
       end
     end
 
@@ -272,6 +299,107 @@ module RestConnection
         "#{prefix}=#{CGI.escape(parameters.to_s)}"
       end
     end
+  end
+
+  module Errors
+    # HTTPStatusErrors, borrowed lovingly from the excon gem <3
+    class HTTPStatusError < StandardError
+      attr_reader :request, :response
+
+      def initialize(msg, response = nil, request = nil)
+        super(msg)
+        @request = request
+        @response = response
+      end
+    end
 
+    class Continue < HTTPStatusError; end                     # 100
+    class SwitchingProtocols < HTTPStatusError; end           # 101
+    class OK < HTTPStatusError; end                           # 200
+    class Created < HTTPStatusError; end                      # 201
+    class Accepted < HTTPStatusError; end                     # 202
+    class NonAuthoritativeInformation < HTTPStatusError; end  # 203
+    class NoContent < HTTPStatusError; end                    # 204
+    class ResetContent < HTTPStatusError; end                 # 205
+    class PartialContent < HTTPStatusError; end               # 206
+    class MultipleChoices < HTTPStatusError; end              # 300
+    class MovedPermanently < HTTPStatusError; end             # 301
+    class Found < HTTPStatusError; end                        # 302
+    class SeeOther < HTTPStatusError; end                     # 303
+    class NotModified < HTTPStatusError; end                  # 304
+    class UseProxy < HTTPStatusError; end                     # 305
+    class TemporaryRedirect < HTTPStatusError; end            # 307
+    class BadRequest < HTTPStatusError; end                   # 400
+    class Unauthorized < HTTPStatusError; end                 # 401
+    class PaymentRequired < HTTPStatusError; end              # 402
+    class Forbidden < HTTPStatusError; end                    # 403
+    class NotFound < HTTPStatusError; end                     # 404
+    class MethodNotAllowed < HTTPStatusError; end             # 405
+    class NotAcceptable < HTTPStatusError; end                # 406
+    class ProxyAuthenticationRequired < HTTPStatusError; end  # 407
+    class RequestTimeout < HTTPStatusError; end               # 408
+    class Conflict < HTTPStatusError; end                     # 409
+    class Gone < HTTPStatusError; end                         # 410
+    class LengthRequired < HTTPStatusError; end               # 411
+    class PreconditionFailed < HTTPStatusError; end           # 412
+    class RequestEntityTooLarge < HTTPStatusError; end        # 413
+    class RequestURITooLong < HTTPStatusError; end            # 414
+    class UnsupportedMediaType < HTTPStatusError; end         # 415
+    class RequestedRangeNotSatisfiable < HTTPStatusError; end # 416
+    class ExpectationFailed < HTTPStatusError; end            # 417
+    class UnprocessableEntity < HTTPStatusError; end          # 422
+    class InternalServerError < HTTPStatusError; end          # 500
+    class NotImplemented < HTTPStatusError; end               # 501
+    class BadGateway < HTTPStatusError; end                   # 502
+    class ServiceUnavailable < HTTPStatusError; end           # 503
+    class GatewayTimeout < HTTPStatusError; end               # 504
+
+    # Messages for nicer exceptions, from rfc2616
+    def self.status_error(response)
+      @errors ||= {
+        100 => [RestConnection::Errors::Continue, 'Continue'],
+        101 => [RestConnection::Errors::SwitchingProtocols, 'Switching Protocols'],
+        200 => [RestConnection::Errors::OK, 'OK'],
+        201 => [RestConnection::Errors::Created, 'Created'],
+        202 => [RestConnection::Errors::Accepted, 'Accepted'],
+        203 => [RestConnection::Errors::NonAuthoritativeInformation, 'Non-Authoritative Information'],
+        204 => [RestConnection::Errors::NoContent, 'No Content'],
+        205 => [RestConnection::Errors::ResetContent, 'Reset Content'],
+        206 => [RestConnection::Errors::PartialContent, 'Partial Content'],
+        300 => [RestConnection::Errors::MultipleChoices, 'Multiple Choices'],
+        301 => [RestConnection::Errors::MovedPermanently, 'Moved Permanently'],
+        302 => [RestConnection::Errors::Found, 'Found'],
+        303 => [RestConnection::Errors::SeeOther, 'See Other'],
+        304 => [RestConnection::Errors::NotModified, 'Not Modified'],
+        305 => [RestConnection::Errors::UseProxy, 'Use Proxy'],
+        307 => [RestConnection::Errors::TemporaryRedirect, 'Temporary Redirect'],
+        400 => [RestConnection::Errors::BadRequest, 'Bad Request'],
+        401 => [RestConnection::Errors::Unauthorized, 'Unauthorized'],
+        402 => [RestConnection::Errors::PaymentRequired, 'Payment Required'],
+        403 => [RestConnection::Errors::Forbidden, 'Forbidden'],
+        404 => [RestConnection::Errors::NotFound, 'Not Found'],
+        405 => [RestConnection::Errors::MethodNotAllowed, 'Method Not Allowed'],
+        406 => [RestConnection::Errors::NotAcceptable, 'Not Acceptable'],
+        407 => [RestConnection::Errors::ProxyAuthenticationRequired, 'Proxy Authentication Required'],
+        408 => [RestConnection::Errors::RequestTimeout, 'Request Timeout'],
+        409 => [RestConnection::Errors::Conflict, 'Conflict'],
+        410 => [RestConnection::Errors::Gone, 'Gone'],
+        411 => [RestConnection::Errors::LengthRequired, 'Length Required'],
+        412 => [RestConnection::Errors::PreconditionFailed, 'Precondition Failed'],
+        413 => [RestConnection::Errors::RequestEntityTooLarge, 'Request Entity Too Large'],
+        414 => [RestConnection::Errors::RequestURITooLong, 'Request-URI Too Long'],
+        415 => [RestConnection::Errors::UnsupportedMediaType, 'Unsupported Media Type'],
+        416 => [RestConnection::Errors::RequestedRangeNotSatisfiable, 'Request Range Not Satisfiable'],
+        417 => [RestConnection::Errors::ExpectationFailed, 'Expectation Failed'],
+        422 => [RestConnection::Errors::UnprocessableEntity, 'Unprocessable Entity'],
+        500 => [RestConnection::Errors::InternalServerError, 'InternalServerError'],
+        501 => [RestConnection::Errors::NotImplemented, 'Not Implemented'],
+        502 => [RestConnection::Errors::BadGateway, 'Bad Gateway'],
+        503 => [RestConnection::Errors::ServiceUnavailable, 'Service Unavailable'],
+        504 => [RestConnection::Errors::GatewayTimeout, 'Gateway Timeout']
+      }
+      error, message = @errors[response.code.to_i] || [RestConnection::Errors::HTTPStatusError, 'Unknown']
+      error.new("Invalid response HTTP code: #{response.code.to_i}: #{response.body}", response)
+    end
   end
 end