tilia-http 4.1.0.8 → 4.2.1

data/lib/tilia/http/http_exception.rb

@@ -7,7 +7,7 @@ module Tilia
     #
     # If you'd like to use this, create a new exception class, extending Exception
     # and implementing this interface.
-    class HttpException < Exception
+    class HttpException < StandardError
       # The http status code for the error.
       #
       # This may either be just the number, or a number and a human-readable

data/lib/tilia/http/message.rb

@@ -7,35 +7,9 @@ module Tilia
     module Message
       include Tilia::Http::MessageInterface
 
-      protected
-
-      # Request body
-      #
-      # This should be a stream resource
-      #
-      # @return resource
-      attr_accessor :body
-
-      # Contains the list of HTTP headers
-      #
-      # @return array
-      attr_accessor :headers
-
-      # HTTP message version (1.0 or 1.1)
-      #
-      # @return [String]
-      attr_accessor :http_version
-
-      public
-
-      # Returns the body as a readable stream resource.
-      #
-      # Note that the stream may not be rewindable, and therefore may only be
-      # read once.
-      #
-      # @return resource
+      # (see MessageInterface#body_as_stream)
       def body_as_stream
-        body = self.body
+        body = @body
         if body.is_a?(String) || body.nil?
           stream = StringIO.new
           stream.write body
@@ -45,44 +19,31 @@ module Tilia
         body
       end
 
-      # Returns the body as a string.
-      #
-      # Note that because the underlying data may be based on a stream, this
-      # method could only work correctly the first time.
-      #
-      # @return [String]
+      # (see MessageInterface#body_as_string)
       def body_as_string
-        body = self.body
+        body = @body
         if body.is_a?(String)
           body
         elsif body.nil?
           ''
         else
-          body.read
+          content_length = header('Content-Length')
+
+          if content_length.present?
+            body.read(content_length.to_i)
+          else
+            body.read
+          end
         end
       end
 
-      # Returns the message body, as it's internal representation.
-      #
-      # This could be either a string or a stream.
-      #
-      # @return resource|string
-      def body
-        @body
-      end
+      # (see MessageInterface#body)
+      attr_reader :body
 
-      # Replaces the body resource with a new stream or string.
-      #
-      # @param resource|string body
-      def body=(body)
-        @body = body
-      end
+      # (see MessageInterface#body=)
+      attr_writer :body
 
-      # Returns all the HTTP headers as an array.
-      #
-      # Every header is returned as an array, with one or more values.
-      #
-      # @return array
+      # (see MessageInterface#headers)
       def headers
         result = {}
         @headers.values.each do |header_info|
@@ -91,28 +52,12 @@ module Tilia
         result
       end
 
-      # Will return true or false, depending on if a HTTP header exists.
-      #
-      # @param [String] name
-      # @return bool
+      # (see MessageInterface#header?)
       def header?(name)
         @headers.key? name.downcase
       end
 
-      # Returns a specific HTTP header, based on it's name.
-      #
-      # The name must be treated as case-insensitive.
-      # If the header does not exist, this method must return null.
-      #
-      # If a header appeared more than once in a HTTP request, this method will
-      # concatenate all the values with a comma.
-      #
-      # Note that this not make sense for all headers. Some, such as
-      # `Set-Cookie` cannot be logically combined with a comma. In those cases
-      # you *should* use header_as_array.
-      #
-      # @param [String] name
-      # @return [String, nil]
+      # (see MessageInterface#header)
       def header(name)
         name = name.downcase
 
@@ -121,15 +66,7 @@ module Tilia
         nil
       end
 
-      # Returns a HTTP header as an array.
-      #
-      # For every time the HTTP header appeared in the request or response, an
-      # item will appear in the array.
-      #
-      # If the header did not exists, this method will return an empty array.
-      #
-      # @param [String] name
-      # @return [String][]
+      # (see MessageInterface#header_as_array)
       def header_as_array(name)
         name = name.downcase
 
@@ -138,44 +75,20 @@ module Tilia
         []
       end
 
-      # Updates a HTTP header.
-      #
-      # The case-sensitity of the name value must be retained as-is.
-      #
-      # If the header already existed, it will be overwritten.
-      #
-      # @param [String] name
-      # @param [String, Array<String>] value
-      # @return [void]
+      # (see MessageInterface#update_header)
       def update_header(name, value)
         value = [value] unless value.is_a?(Array)
         @headers[name.downcase] = [name, value]
       end
 
-      # Sets a new set of HTTP headers.
-      #
-      # The headers array should contain headernames for keys, and their value
-      # should be specified as either a string or an array.
-      #
-      # Any header that already existed will be overwritten.
-      #
-      # @param array headers
-      # @return [void]
+      # (see MessageInterface#update_headers)
       def update_headers(headers)
         headers.each do |name, value|
           update_header(name, value)
         end
       end
 
-      # Adds a HTTP header.
-      #
-      # This method will not overwrite any existing HTTP header, but instead add
-      # another value. Individual values can be retrieved with
-      # getHeadersAsArray.
-      #
-      # @param [String] name
-      # @param [String] value
-      # @return [void]
+      # (see MessageInterface#add_header)
       def add_header(name, value)
         l_name = name.downcase
         value = [value] unless value.is_a?(Array)
@@ -187,25 +100,14 @@ module Tilia
         end
       end
 
-      # Adds a new set of HTTP headers.
-      #
-      # Any existing headers will not be overwritten.
-      #
-      # @param array headers
-      # @return [void]
+      # (see MessageInterface#add_headers)
       def add_headers(headers)
         headers.each do |name, value|
           add_header(name, value)
         end
       end
 
-      # Removes a HTTP header.
-      #
-      # The specified header name must be treated as case-insenstive.
-      # This method should return true if the header was successfully deleted,
-      # and false if the header did not exist.
-      #
-      # @return bool
+      # (see MessageInterface#remove_header)
       def remove_header(name)
         name = name.downcase
         return false unless @headers.key?(name)
@@ -213,31 +115,22 @@ module Tilia
         true
       end
 
-      # Sets the HTTP version.
-      #
-      # Should be 1.0 or 1.1.
-      #
-      # @param [String] version
-      # @return [void]
-      def http_version=(version)
-        @http_version = version
-      end
+      # (see MessageInterface#http_version)
+      attr_writer :http_version
 
-      # Returns the HTTP version.
-      #
-      # @return [String]
-      def http_version
-        @http_version
-      end
+      # (see MessageInterface#http_version=)
+      attr_reader :http_version
 
-      # TODO: document
-      def initialize_message
+      # Initializes the instance vars of Message
+      def initialize(*args)
         @body = nil
         @headers = {}
         @http_version = '1.1'
+
+        super
       end
 
-      # TODO: document
+      # creates a deep copy of the headers hash when cloning
       def initialize_copy(_original)
         @headers = @headers.deep_dup
       end

data/lib/tilia/http/message_decorator_trait.rb

@@ -6,175 +6,77 @@ module Tilia
     # Didn't seem needed to create a full class for this, so we're just
     # implementing it as a trait.
     module MessageDecoratorTrait
-      protected
-
-      # The inner request object.
-      #
-      # All method calls will be forwarded here.
-      #
-      # @return MessageInterface
-      attr_accessor :inner
-
-      public
-
-      # Returns the body as a readable stream resource.
-      #
-      # Note that the stream may not be rewindable, and therefore may only be
-      # read once.
-      #
-      # @return resource
+      # (see MessageInterface#body_as_stream)
       def body_as_stream
         @inner.body_as_stream
       end
 
-      # Returns the body as a string.
-      #
-      # Note that because the underlying data may be based on a stream, this
-      # method could only work correctly the first time.
-      #
-      # @return [String]
+      # (see MessageInterface#body_as_string)
       def body_as_string
         @inner.body_as_string
       end
 
-      # Returns the message body, as it's internal representation.
-      #
-      # This could be either a string or a stream.
-      #
-      # @return resource|string
+      # (see MessageInterface#body)
       def body
         @inner.body
       end
 
-      # Updates the body resource with a new stream.
-      #
-      # @param resource body
-      # @return [void]
+      # (see MessageInterface#body=)
       def body=(body)
         @inner.body = body
       end
 
-      # Returns all the HTTP headers as an array.
-      #
-      # Every header is returned as an array, with one or more values.
-      #
-      # @return array
+      # (see MessageInterface#headers)
       def headers
         @inner.headers
       end
 
-      # Will return true or false, depending on if a HTTP header exists.
-      #
-      # @param [String] name
-      # @return bool
+      # (see MessageInterface#header?)
       def header?(name)
         @inner.header?(name)
       end
 
-      # Returns a specific HTTP header, based on it's name.
-      #
-      # The name must be treated as case-insensitive.
-      # If the header does not exist, this method must return null.
-      #
-      # If a header appeared more than once in a HTTP request, this method will
-      # concatenate all the values with a comma.
-      #
-      # Note that this not make sense for all headers. Some, such as
-      # `Set-Cookie` cannot be logically combined with a comma. In those cases
-      # you *should* use header_as_array.
-      #
-      # @param [String] name
-      # @return [String, nil]
+      # (see MessageInterface#header)
       def header(name)
         @inner.header(name)
       end
 
-      # Returns a HTTP header as an array.
-      #
-      # For every time the HTTP header appeared in the request or response, an
-      # item will appear in the array.
-      #
-      # If the header did not exists, this method will return an empty array.
-      #
-      # @param [String] name
-      # @return [String][]
+      # (see MessageInterface#header_as_array)
       def header_as_array(name)
         @inner.header_as_array(name)
       end
 
-      # Updates a HTTP header.
-      #
-      # The case-sensitity of the name value must be retained as-is.
-      #
-      # If the header already existed, it will be overwritten.
-      #
-      # @param [String] name
-      # @param [String, Array<String>] value
-      # @return [void]
+      # (see MessageInterface#update_header)
       def update_header(name, value)
         @inner.update_header(name, value)
       end
 
-      # Sets a new set of HTTP headers.
-      #
-      # The headers array should contain headernames for keys, and their value
-      # should be specified as either a string or an array.
-      #
-      # Any header that already existed will be overwritten.
-      #
-      # @param array headers
-      # @return [void]
+      # (see MessageInterface#update_headers)
       def update_headers(headers)
         @inner.update_headers(headers)
       end
 
-      # Adds a HTTP header.
-      #
-      # This method will not overwrite any existing HTTP header, but instead add
-      # another value. Individual values can be retrieved with
-      # getHeadersAsArray.
-      #
-      # @param [String] name
-      # @param [String] value
-      # @return [void]
+      # (see MessageInterface#add_header)
       def add_header(name, value)
         @inner.add_header(name, value)
       end
 
-      # Adds a new set of HTTP headers.
-      #
-      # Any existing headers will not be overwritten.
-      #
-      # @param array headers
-      # @return [void]
+      # (see MessageInterface#add_headers)
       def add_headers(headers)
         @inner.add_headers(headers)
       end
 
-      # Removes a HTTP header.
-      #
-      # The specified header name must be treated as case-insenstive.
-      # This method should return true if the header was successfully deleted,
-      # and false if the header did not exist.
-      #
-      # @return bool
+      # (see MessageInterface#remove_header)
       def remove_header(name)
         @inner.remove_header(name)
       end
 
-      # Sets the HTTP version.
-      #
-      # Should be 1.0 or 1.1.
-      #
-      # @param [String] version
-      # @return [void]
+      # (see MessageInterface#http_version=)
       def http_version=(version)
         @inner.http_version = version
       end
 
-      # Returns the HTTP version.
-      #
-      # @return [String]
+      # (see MessageInterface#http_version)
       def http_version
         @inner.http_version
       end

data/lib/tilia/http/message_interface.rb

@@ -8,7 +8,7 @@ module Tilia
       # Note that the stream may not be rewindable, and therefore may only be
       # read once.
       #
-      # @return resource
+      # @return [IO, StringIO]
       def body_as_stream
       end
 
@@ -25,30 +25,30 @@ module Tilia
       #
       # This could be either a string or a stream.
       #
-      # @return resource|string
+      # @return [String, IO, StringIO]
       def body
       end
 
       # Updates the body resource with a new stream.
       #
-      # @param resource body
+      # @param [String, #read] body
       # @return [void]
-      def body=(_body)
+      def body=(body)
       end
 
       # Returns all the HTTP headers as an array.
       #
       # Every header is returned as an array, with one or more values.
       #
-      # @return array
+      # @return [Hash]
       def headers
       end
 
       # Will return true or false, depending on if a HTTP header exists.
       #
       # @param [String] name
-      # @return bool
-      def header?(_name)
+      # @return [Boolean]
+      def header?(name)
       end
 
       # Returns a specific HTTP header, based on it's name.
@@ -65,7 +65,7 @@ module Tilia
       #
       # @param [String] name
       # @return [String, nil]
-      def header(_name)
+      def header(name)
       end
 
       # Returns a HTTP header as an array.
@@ -76,8 +76,8 @@ module Tilia
       # If the header did not exists, this method will return an empty array.
       #
       # @param [String] name
-      # @return [String][]
-      def header_as_array(_name)
+      # @return [Array<String>]
+      def header_as_array(name)
       end
 
       # Updates a HTTP header.
@@ -89,7 +89,7 @@ module Tilia
       # @param [String] name
       # @param [String, Array<String>] value
       # @return [void]
-      def update_header(_name, _value)
+      def update_header(name, value)
       end
 
       # Sets a new set of HTTP headers.
@@ -99,9 +99,9 @@ module Tilia
       #
       # Any header that already existed will be overwritten.
       #
-      # @param array headers
+      # @param [Hash] headers
       # @return [void]
-      def update_headers(_headers)
+      def update_headers(headers)
       end
 
       # Adds a HTTP header.
@@ -113,16 +113,16 @@ module Tilia
       # @param [String] name
       # @param [String] value
       # @return [void]
-      def add_header(_name, _value)
+      def add_header(name, value)
       end
 
       # Adds a new set of HTTP headers.
       #
       # Any existing headers will not be overwritten.
       #
-      # @param array headers
+      # @param [Hash] headers
       # @return [void]
-      def add_headers(_headers)
+      def add_headers(headers)
       end
 
       # Removes a HTTP header.
@@ -131,8 +131,9 @@ module Tilia
       # This method should return true if the header was successfully deleted,
       # and false if the header did not exist.
       #
+      # @param [String] name
       # @return bool
-      def remove_header(_name)
+      def remove_header(name)
       end
 
       # Sets the HTTP version.
@@ -141,7 +142,7 @@ module Tilia
       #
       # @param [String] version
       # @return [void]
-      def http_version=(_version)
+      def http_version=(version)
       end
 
       # Returns the HTTP version.