esod-client 0.2.1 → 0.3.0

data/lib/{rest-client-1.2.0 → rest-client-1.4.2}/lib/restclient.rb

@@ -9,12 +9,12 @@ rescue LoadError => e
   raise LoadError, "no such file to load -- net/https. Try running apt-get install libopenssl-ruby"
 end
 
+require File.dirname(__FILE__) + '/restclient/exceptions'
 require File.dirname(__FILE__) + '/restclient/request'
-require File.dirname(__FILE__) + '/restclient/mixin/response'
+require File.dirname(__FILE__) + '/restclient/abstract_response'
 require File.dirname(__FILE__) + '/restclient/response'
 require File.dirname(__FILE__) + '/restclient/raw_response'
 require File.dirname(__FILE__) + '/restclient/resource'
-require File.dirname(__FILE__) + '/restclient/exceptions'
 require File.dirname(__FILE__) + '/restclient/payload'
 require File.dirname(__FILE__) + '/restclient/net_http_ext'
 
@@ -64,40 +64,38 @@ require File.dirname(__FILE__) + '/restclient/net_http_ext'
 #
 module RestClient
 
-  def self.get(url, headers={})
-    Request.execute(:method => :get, :url => url, :headers => headers)
+  def self.get(url, headers={}, &block)
+    Request.execute(:method => :get, :url => url, :headers => headers, &block)
   end
 
-  def self.post(url, payload, headers={})
-    Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers)
+  def self.post(url, payload, headers={}, &block)
+    Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers, &block)
   end
 
-  def self.put(url, payload, headers={})
-    Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers)
+  def self.put(url, payload, headers={}, &block)
+    Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers, &block)
   end
 
-  def self.delete(url, headers={})
-    Request.execute(:method => :delete, :url => url, :headers => headers)
+  def self.delete(url, headers={}, &block)
+    Request.execute(:method => :delete, :url => url, :headers => headers, &block)
   end
 
-  def self.head(url, headers={})
-    Request.execute(:method => :head, :url => url, :headers => headers)
+  def self.head(url, headers={}, &block)
+    Request.execute(:method => :head, :url => url, :headers => headers, &block)
   end
 
   class << self
     attr_accessor :proxy
   end
 
-  # Print log of RestClient calls.  Value can be stdout, stderr, or a filename.
+  # Setup the log for RestClient calls.
+  # Value should be a logger but can can be stdout, stderr, or a filename.
   # You can also configure logging by the environment variable RESTCLIENT_LOG.
-  def self.log=(log)
-    @@log = log
-  end
-
-  def self.log # :nodoc:
-    return ENV['RESTCLIENT_LOG'] if ENV['RESTCLIENT_LOG']
-    return @@log if defined? @@log
-    nil
+  def self.log= log
+    if log.is_a? String
+      warn "[warning] You should set the log with a logger"
+    end
+    @@log = create_log log
   end
 
   def self.version
@@ -105,4 +103,62 @@ module RestClient
     return File.read(version_path).chomp if File.file?(version_path)
     "0.0.0"
   end
+
+  # Create a log that respond to << like a logger
+  # param can be 'stdout', 'stderr', a string (then we will log to that file) or a logger (then we return it)
+  def self.create_log param
+    if param
+      if param.is_a? String
+        if param == 'stdout'
+          stdout_logger = Class.new do
+            def << obj
+              STDOUT.puts obj
+            end
+          end
+          stdout_logger.new
+        elsif param == 'stderr'
+          stderr_logger = Class.new do
+            def << obj
+              STDERR.puts obj
+            end
+          end
+          stderr_logger.new
+        else
+          file_logger = Class.new do
+            attr_writer :target_file
+
+            def << obj
+              File.open(@target_file, 'a') { |f| f.puts obj }
+            end
+          end
+          logger = file_logger.new
+          logger.target_file = param
+          logger
+        end
+      else
+        param
+      end
+    end
+  end
+
+  @@env_log = create_log ENV['RESTCLIENT_LOG']
+
+  @@log = nil
+
+  def self.log # :nodoc:
+    @@env_log || @@log
+  end
+
+  @@before_execution_procs = []
+
+  # Add a Proc to be called before each request in executed.
+  # The proc parameters will be the http request and the request params.
+  def self.add_before_execution_proc &proc
+    @@before_execution_procs << proc
+  end
+
+  def self.before_execution_procs # :nodoc:
+    @@before_execution_procs
+  end
+
 end

data/lib/rest-client-1.4.2/lib/restclient/abstract_response.rb

@@ -0,0 +1,87 @@
+module RestClient
+
+  class AbstractResponse
+
+    attr_reader :net_http_res, :args
+
+    def initialize net_http_res, args
+      @net_http_res = net_http_res
+      @args = args
+    end
+
+    # HTTP status code
+    def code
+      @code ||= @net_http_res.code.to_i
+    end
+
+    # A hash of the headers, beautified with symbols and underscores.
+    # e.g. "Content-type" will become :content_type.
+    def headers
+      @headers ||= self.class.beautify_headers(@net_http_res.to_hash)
+    end
+
+    # The raw headers.
+    def raw_headers
+      @raw_headers ||= @net_http_res.to_hash
+    end
+
+    # Hash of cookies extracted from response headers
+    def cookies
+      @cookies ||= (self.headers[:set_cookie] || []).inject({}) do |out, cookie_content|
+        # correctly parse comma-separated cookies containing HTTP dates (which also contain a comma)
+        cookie_content.split(/,\s*/).inject([""]) { |array, blob|
+          blob =~ /expires=.+?$/ ? array.push(blob) : array.last.concat(blob)
+          array
+        }.each do |cookie|
+          next if cookie.empty?
+          key, *val = cookie.split(";").first.split("=")
+          out[key] = val.join("=")
+        end
+        out
+      end
+    end
+
+    # Return the default behavior corresponding to the response code:
+    # the response itself for code in 200..206, redirection for 301 and 302 in get and head cases, redirection for 303 and an exception in other cases
+    def return! &block
+      if (200..206).include? code
+        self
+      elsif [301, 302].include? code
+        unless [:get, :head].include? args[:method]
+          raise Exceptions::EXCEPTIONS_MAP[code], self
+        else
+          follow_redirection &block
+        end
+      elsif code == 303
+        args[:method] = :get
+        args.delete :payload
+        follow_redirection &block
+      elsif Exceptions::EXCEPTIONS_MAP[code]
+        raise Exceptions::EXCEPTIONS_MAP[code], self
+      else
+        raise RequestFailed, self
+      end
+    end
+
+    def inspect
+      "#{code} #{STATUSES[code]} | #{(headers[:content_type] || '').gsub(/;.*$/, '')} #{size} bytes\n"
+    end
+
+    # Follow a redirection
+    def follow_redirection &block
+      url = headers[:location]
+      if url !~ /^http/
+        url = URI.parse(args[:url]).merge(url).to_s
+      end
+      args[:url] = url
+      Request.execute args, &block
+    end
+
+    def AbstractResponse.beautify_headers(headers)
+      headers.inject({}) do |out, (key, value)|
+        out[key.gsub(/-/, '_').downcase.to_sym] = %w{set-cookie}.include?(key.downcase) ? value : value.first
+        out
+      end
+    end
+  end
+end

data/lib/rest-client-1.4.2/lib/restclient/exceptions.rb

@@ -0,0 +1,146 @@
+module RestClient
+
+  STATUSES = {100 => 'Continue',
+              101 => 'Switching Protocols',
+              200 => 'OK',
+              201 => 'Created',
+              202 => 'Accepted',
+              203 => 'Non-Authoritative Information',
+              204 => 'No Content',
+              205 => 'Reset Content',
+              206 => 'Partial Content',
+              300 => 'Multiple Choices',
+              301 => 'Moved Permanently',
+              302 => 'Found',
+              303 => 'See Other',
+              304 => 'Not Modified',
+              305 => 'Use Proxy',
+              400 => 'Bad Request',
+              401 => 'Unauthorized',
+              403 => 'Forbidden',
+              404 => 'Resource Not Found',
+              405 => 'Method Not Allowed',
+              406 => 'Not Acceptable',
+              407 => 'Proxy Authentication Required',
+              408 => 'Request Timeout',
+              409 => 'Conflict',
+              410 => 'Gone',
+              411 => 'Length Required',
+              412 => 'Precondition Failed',
+              413 => 'Request Entity Too Large',
+              414 => 'Request-URI Too Long',
+              415 => 'Unsupported Media Type',
+              416 => 'Requested Range Not Satisfiable',
+              417 => 'Expectation Failed',
+              500 => 'Internal Server Error',
+              501 => 'Not Implemented',
+              502 => 'Bad Gateway',
+              503 => 'Service Unavailable',
+              504 => 'Gateway Timeout',
+              505 => 'HTTP Version Not Supported'}
+
+  # Compatibility : make the Response act like a Net::HTTPResponse when needed
+  module ResponseForException
+    def method_missing symbol, *args
+      if net_http_res.respond_to? symbol
+        warn "[warning] The response contained in an RestClient::Exception is now a RestClient::Response instead of a Net::HTTPResponse, please update your code"
+        net_http_res.send symbol, *args
+      else
+        super
+      end
+    end
+  end
+
+  # This is the base RestClient exception class. Rescue it if you want to
+  # catch any exception that your request might raise
+  # You can get the status code by e.http_code, or see anything about the
+  # response via e.response.
+  # For example, the entire result body (which is
+  # probably an HTML error page) is e.response.
+  class Exception < RuntimeError
+    attr_accessor :message, :response
+
+    def initialize response = nil
+      @response = response
+
+      # compatibility: this make the exception behave like a Net::HTTPResponse
+      response.extend ResponseForException if response
+    end
+
+    def http_code
+      # return integer for compatibility
+      @response.code.to_i if @response
+    end
+
+    def http_body
+      @response.body
+    end
+
+    def inspect
+      "#{self.class} : #{http_code} #{message}"
+    end
+
+  end
+
+  # Compatibility
+  class ExceptionWithResponse < Exception
+  end
+
+  # The request failed with an error code not managed by the code
+  class RequestFailed < ExceptionWithResponse
+
+    def message
+      "HTTP status code #{http_code}"
+    end
+
+    def to_s
+      message
+    end
+  end
+
+  # We will a create an exception for each status code, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+  module Exceptions
+    # Map http status codes to the corresponding exception class
+    EXCEPTIONS_MAP = {}
+  end
+
+  STATUSES.each_pair do |code, message|
+
+    # Compatibility
+    superclass = ([304, 401, 404].include? code) ? ExceptionWithResponse : RequestFailed
+    klass = Class.new(superclass) do
+      send(:define_method, :message) {message}
+    end
+    klass_constant = const_set message.gsub(/ /, '').gsub(/-/, ''), klass
+    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
+  end
+
+  # A redirect was encountered; caught by execute to retry with the new url.
+  class Redirect < Exception
+
+    message = 'Redirect'
+
+    attr_accessor :url
+
+    def initialize(url)
+      @url = url
+    end
+  end
+
+  # The server broke the connection prior to the request completing.  Usually
+  # this means it crashed, or sometimes that your network connection was
+  # severed before it could complete.
+  class ServerBrokeConnection < Exception
+    message = 'Server broke connection'
+  end
+
+
+
+end
+
+# backwards compatibility
+class RestClient::Request
+  Redirect = RestClient::Redirect
+  Unauthorized = RestClient::Unauthorized
+  RequestFailed = RestClient::RequestFailed
+end

data/lib/{rest-client-1.2.0 → rest-client-1.4.2}/lib/restclient/payload.rb

@@ -54,14 +54,17 @@ module RestClient
       # Flatten parameters by converting hashes of hashes to flat hashes
       # {keys1 => {keys2 => value}} will be transformed into {keys1[key2] => value}
       def flatten_params(params, parent_key = nil)
-        result = {}
-        params.keys.map do |key|
+        result = []
+        params.each do |key, value|
           calculated_key = parent_key ? "#{parent_key}[#{escape key}]" : escape(key)
-          value = params[key]
           if value.is_a? Hash
-            result.merge!(flatten_params(value, calculated_key))
+            result += flatten_params(value, calculated_key)
+          elsif value.is_a? Array
+            value.each do |elem|
+              result << ["#{calculated_key}[]", elem]
+            end
           else
-            result[calculated_key] = value
+            result << [calculated_key, value]
           end
         end
         result
@@ -88,15 +91,15 @@ module RestClient
       end
 
       def short_inspect
-        (size > 100 ? "#{size} byte length" : inspect)
+        (size > 100 ? "#{size} byte(s) length" : inspect)
       end
 
     end
 
     class UrlEncoded < Base
       def build_stream(params = nil)
-        @stream = StringIO.new(flatten_params(params).map do |k, v|
-          "#{k}=#{escape(v)}"
+        @stream = StringIO.new(flatten_params(params).collect do |entry|
+          "#{entry[0]}=#{escape(entry[1])}"
         end.join("&"))
         @stream.seek(0)
       end
@@ -116,9 +119,9 @@ module RestClient
         @stream.write(b + EOL)
 
         if params.is_a? Hash
-          x = flatten_params(params).to_a
+          x = flatten_params(params)
         else
-          x = params.to_a
+          x = params
         end
 
         last_index = x.length - 1
@@ -138,7 +141,7 @@ module RestClient
       end
 
       def create_regular_field(s, k, v)
-        s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"")
+        s.write("Content-Disposition: form-data; name=\"#{k}\"")
         s.write(EOL)
         s.write(EOL)
         s.write(v)
@@ -146,7 +149,7 @@ module RestClient
 
       def create_file_field(s, k, v)
         begin
-          s.write("Content-Disposition: multipart/form-data; name=\"#{k}\"; filename=\"#{v.respond_to?(:original_filename) ? v.original_filename : File.basename(v.path)}\"#{EOL}")
+          s.write("Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{v.respond_to?(:original_filename) ? v.original_filename : File.basename(v.path)}\"#{EOL}")
           s.write("Content-Type: #{v.respond_to?(:content_type) ? v.content_type : mime_for(v.path)}#{EOL}")
           s.write(EOL)
           while data = v.read(8124)

data/lib/{rest-client-1.2.0 → rest-client-1.4.2}/lib/restclient/raw_response.rb

@@ -1,5 +1,3 @@
-require File.dirname(__FILE__) + '/mixin/response'
-
 module RestClient
   # The response from RestClient on a raw request looks like a string, but is
   # actually one of these.  99% of the time you're making a rest call all you
@@ -11,13 +9,12 @@ module RestClient
   # In addition, if you do not use the response as a string, you can access
   # a Tempfile object at res.file, which contains the path to the raw
   # downloaded request body.
-  class RawResponse
-    include RestClient::Mixin::Response
+  class RawResponse < AbstractResponse
 
     attr_reader :file
 
-    def initialize(tempfile, net_http_res)
-      @net_http_res = net_http_res
+    def initialize tempfile, net_http_res, args
+      super net_http_res, args
       @file = tempfile
     end
 
@@ -26,5 +23,9 @@ module RestClient
       @file.read
     end
 
+    def size
+      File.size file
+    end
+
   end
 end