tilia-http 4.1.0.8 → 4.2.1

data/lib/tilia/http/request.rb

@@ -9,67 +9,40 @@ module Tilia
       include Tilia::Http::Message
       include Tilia::Http::RequestInterface
 
-      protected
-
-      # HTTP Method
-      #
-      # @return [String]
-      attr_accessor :method
-
-      # Request Url
-      #
-      # @return [String]
-      attr_accessor :url
-
-      public
-
       # Creates the request object
       #
       # @param [String] method
       # @param [String] url
-      # @param array headers
-      # @param resource body
+      # @param [Hash] headers
+      # @param [String, IO] body
       def initialize(method = nil, url = nil, headers = nil, body = nil)
-        initialize_message
+        super()
+
         @base_url = '/' # RUBY
         @post_data = {}
         @raw_server_data = {}
 
         fail ArgumentError, 'The first argument for this constructor should be a string or null, not an array. Did you upgrade from sabre/http 1.0 to 2.0?' if method.is_a?(Array)
 
-        self.method = method if method
-        self.url = url if url
+        @method = method if method
+        @url = url if url
         update_headers(headers) if headers
-        self.body = body if body
+        @body = body if body
       end
 
-      # Returns the current HTTP method
-      #
-      # @return [String]
+      # (see RequestInterface#method)
       attr_reader :method
 
-      # Sets the HTTP method
-      #
-      # @param [String] method
-      # @return [void]
+      # (see RequestInterface#method=)
       attr_writer :method
 
-      # Returns the request url.
-      #
-      # @return [String]
+      # (see RequestInterface#url)
       attr_reader :url
 
-      # Sets the request url.
-      #
-      # @param [String] url
-      # @return [void]
+      # (see RequestInterface#url=)
       attr_writer :url
 
-      # Returns the list of query parameters.
-      #
-      # This is equivalent to PHP's $_GET superglobal.
-      #
-      # @return array
+      # (see RequestInterface#query_parameters)
       def query_parameters
         url = self.url
 
@@ -85,54 +58,19 @@ module Tilia
         end
       end
 
-      # Sets the absolute url.
-      #
-      # @param [String] url
-      # @return [void]
+      # (see RequestInterface#absolute_url=)
       attr_writer :absolute_url
 
-      # Returns the absolute url.
-      #
-      # @return [String]
+      # (see RequestInterface#absolute_url)
       attr_reader :absolute_url
 
-      protected
-
-      # Base url
-      #
-      # @return [String]
-      attr_accessor :base_url
-
-      public
-
-      # Sets a base url.
-      #
-      # This url is used for relative path calculations.
-      #
-      # @param [String] url
-      # @return [void]
+      # (see RequestInterface#base_url=)
       attr_writer :base_url
 
-      # Returns the current base url.
-      #
-      # @return [String]
+      # (see RequestInterface#base_url)
       attr_reader :base_url
 
-      # Returns the relative path.
-      #
-      # This is being calculated using the base url. This path will not start
-      # with a slash, so it will always return something like
-      # 'example/path.html'.
-      #
-      # If the full path is equal to the base url, this method will return an
-      # empty string.
-      #
-      # This method will also urldecode the path, and if the url was incoded as
-      # ISO-8859-1, it will convert it to UTF-8.
-      #
-      # If the path is outside of the base url, a LogicException will be thrown.
-      #
-      # @return [String]
+      # (see RequestInterface#path)
       def path
         # Removing duplicated slashes.
         uri = (url || '').gsub('//', '/')
@@ -153,56 +91,18 @@ module Tilia
         fail "Requested uri (#{url}) is out of base uri (#{base_url})"
       end
 
-      protected
-
-      # Equivalent of PHP's $_POST.
-      #
-      # @return array
-      attr_accessor :post_data
-
-      public
-
-      # Sets the post data.
-      #
-      # This is equivalent to PHP's $_POST superglobal.
-      #
-      # This would not have been needed, if POST data was accessible as
-      # php://input, but unfortunately we need to special case it.
-      #
-      # @param array post_data
-      # @return [void]
+      # (see RequestInterface#post_data=)
       attr_writer :post_data
 
-      # Returns the POST data.
-      #
-      # This is equivalent to PHP's $_POST superglobal.
-      #
-      # @return array
+      # (see RequestInterface#post_data)
       attr_reader :post_data
 
-      protected
-
-      # An array containing the raw _SERVER array.
-      #
-      # @return array
-      attr_accessor :raw_server_data
-
-      public
-
-      # Returns an item from the _SERVER array.
-      #
-      # If the value does not exist in the array, null is returned.
-      #
-      # @param [String] value_name
-      # @return [String, nil]
+      # (see RequestInterface#raw_server_value)
       def raw_server_value(value_name)
         @raw_server_data[value_name]
       end
 
-      # Sets the _SERVER array.
-      #
-      # @param array data
-      # @return [void]
+      # (see RequestInterface#raw_server_data=)
       def raw_server_data=(data)
         @raw_server_data = data.dup
       end

data/lib/tilia/http/request_decorator.rb

@@ -10,139 +10,77 @@ module Tilia
 
       # Constructor.
       #
-      # @param RequestInterface inner
+      # @param [RequestInterface] inner
       def initialize(inner)
         @inner = inner
       end
 
-      # Returns the current HTTP method
-      #
-      # @return [String]
+      # (see RequestInterface#method)
       def method
         @inner.method
       end
 
-      # Sets the HTTP method
-      #
-      # @param [String] method
-      # @return [void]
+      # (see RequestInterface#method=)
       def method=(method)
         @inner.method = method
       end
 
-      # Returns the request url.
-      #
-      # @return [String]
+      # (see RequestInterface#url)
       def url
         @inner.url
       end
 
-      # Sets the request url.
-      #
-      # @param [String] url
-      # @return [void]
+      # (see RequestInterface#url=)
       def url=(url)
         @inner.url = url
       end
 
-      # Returns the absolute url.
-      #
-      # @return [String]
+      # (see RequestInterface#absolute_url)
       def absolute_url
         @inner.absolute_url
       end
 
-      # Sets the absolute url.
-      #
-      # @param [String] url
-      # @return [void]
+      # (see RequestInterface#absolute_url=)
       def absolute_url=(url)
         @inner.absolute_url = url
       end
 
-      # Returns the current base url.
-      #
-      # @return [String]
+      # (see RequestInterface#base_url)
       def base_url
         @inner.base_url
       end
 
-      # Sets a base url.
-      #
-      # This url is used for relative path calculations.
-      #
-      # The base url should default to /
-      #
-      # @param [String] url
-      # @return [void]
+      # (see RequestInterface#base_url=)
       def base_url=(url)
         @inner.base_url = url
       end
 
-      # Returns the relative path.
-      #
-      # This is being calculated using the base url. This path will not start
-      # with a slash, so it will always return something like
-      # 'example/path.html'.
-      #
-      # If the full path is equal to the base url, this method will return an
-      # empty string.
-      #
-      # This method will also urldecode the path, and if the url was incoded as
-      # ISO-8859-1, it will convert it to UTF-8.
-      #
-      # If the path is outside of the base url, a LogicException will be thrown.
-      #
-      # @return [String]
+      # (see RequestInterface#path)
       def path
         @inner.path
       end
 
-      # Returns the list of query parameters.
-      #
-      # This is equivalent to PHP's $_GET superglobal.
-      #
-      # @return array
+      # (see RequestInterface#query_parameters)
       def query_parameters
         @inner.query_parameters
       end
 
-      # Returns the POST data.
-      #
-      # This is equivalent to PHP's $_POST superglobal.
-      #
-      # @return array
+      # (see RequestInterface#post_data)
       def post_data
         @inner.post_data
       end
 
-      # Sets the post data.
-      #
-      # This is equivalent to PHP's $_POST superglobal.
-      #
-      # This would not have been needed, if POST data was accessible as
-      # php://input, but unfortunately we need to special case it.
-      #
-      # @param array post_data
-      # @return [void]
+      # (see RequestInterface#post_data=)
       def post_data=(post_data)
         @inner.post_data = post_data
       end
 
-      # Returns an item from the _SERVER array.
-      #
-      # If the value does not exist in the array, null is returned.
-      #
-      # @param [String] value_name
-      # @return [String, nil]
+      # (see RequestInterface#raw_server_value)
       def raw_server_value(value_name)
         @inner.raw_server_value(value_name)
       end
 
-      # Sets the _SERVER array.
-      #
-      # @param array data
-      # @return [void]
+      # (see RequestInterface#raw_server_data=)
       def raw_server_data=(data)
         @inner.raw_server_data = data
       end

data/lib/tilia/http/request_interface.rb

@@ -14,7 +14,7 @@ module Tilia
       #
       # @param [String] method
       # @return [void]
-      def method=(_method)
+      def method=(method)
       end
 
       # Returns the request url.
@@ -27,7 +27,7 @@ module Tilia
       #
       # @param [String] url
       # @return [void]
-      def url=(_url)
+      def url=(url)
       end
 
       # Returns the absolute url.
@@ -40,7 +40,7 @@ module Tilia
       #
       # @param [String] url
       # @return [void]
-      def absolute_url=(_url)
+      def absolute_url=(url)
       end
 
       # Returns the current base url.
@@ -57,7 +57,7 @@ module Tilia
       #
       # @param [String] url
       # @return [void]
-      def base_url=(_url)
+      def base_url=(url)
       end
 
       # Returns the relative path.
@@ -82,7 +82,7 @@ module Tilia
       #
       # This is equivalent to PHP's $_GET superglobal.
       #
-      # @return array
+      # @return [Hash]
       def query_parameters
       end
 
@@ -90,7 +90,7 @@ module Tilia
       #
       # This is equivalent to PHP's $_POST superglobal.
       #
-      # @return array
+      # @return [Hash]
       def post_data
       end
 
@@ -101,9 +101,9 @@ module Tilia
       # This would not have been needed, if POST data was accessible as
       # php://input, but unfortunately we need to special case it.
       #
-      # @param array post_data
+      # @param [Hash] post_data
       # @return [void]
-      def post_data=(_post_data)
+      def post_data=(post_data)
       end
 
       # Returns an item from the _SERVER array.
@@ -112,14 +112,14 @@ module Tilia
       #
       # @param [String] value_name
       # @return [String, nil]
-      def raw_server_value(_value_name)
+      def raw_server_value(value_name)
       end
 
       # Sets the _SERVER array.
       #
-      # @param array data
+      # @param [Hash] data
       # @return [void]
-      def raw_server_data=(_data)
+      def raw_server_data=(data)
       end
     end
   end

data/lib/tilia/http/response.rb

@@ -74,61 +74,31 @@ module Tilia
         }
       end
 
-      protected
-
-      # HTTP status code
-      #
-      # @return int
-      attr_accessor :status
-
-      # HTTP status text
-      #
-      # @return [String]
-      attr_accessor :status_text
-
-      public
-
       # Creates the response object
       #
       # @param [String, Fixnum] status
-      # @param array headers
-      # @param resource body
+      # @param [Hash] headers
+      # @param [String, IO] body
       # @return [void]
       def initialize(status = nil, headers = nil, body = nil)
-        initialize_message # RUBY
+        super()
 
-        self.status = status if status
+        self.status = status if status # Don't set @status directly!
         update_headers(headers) if headers
-        self.body = body if body
+        @body = body if body
       end
 
-      # Returns the current HTTP status code.
-      #
-      # @return int
+      # (see ResponseInterface#status)
       attr_reader :status
 
-      # Returns the human-readable status string.
-      #
-      # In the case of a 200, this may for example be 'OK'.
-      #
-      # @return [String]
+      # (see ResponseInterface#status_text)
       attr_reader :status_text
 
-      # Sets the HTTP status code.
-      #
-      # This can be either the full HTTP status code with human readable string,
-      # for example: "403 I can't let you do that, Dave".
-      #
-      # Or just the code, in which case the appropriate default message will be
-      # added.
-      #
-      # @param [String, Fixnum] status
-      # @throws \InvalidArgumentExeption
-      # @return [void]
+      # (see ResponseInterface#status=)
       def status=(status)
         if status.is_a?(Fixnum) || status =~ /^\d+$/
           status_code = status
-          status_text = self.class.status_codes.key?(status.to_i) ? self.class.status_codes[status.to_i] : 'Unkown'
+          status_text = Response.status_codes.key?(status.to_i) ? Response.status_codes[status.to_i] : 'Unkown'
         else
           (
             status_code,
@@ -136,9 +106,11 @@ module Tilia
           ) = status.split(' ', 2)
         end
 
-        fail ArgumentError, 'The HTTP status code must be exactly 3 digits' if status_code.to_i < 100 || status_code.to_i > 999
+        status_code = status_code.to_i unless status_code.is_a?(Fixnum)
+
+        fail ArgumentError, 'The HTTP status code must be exactly 3 digits' if status_code < 100 || status_code > 999
 
-        @status = status_code.to_i
+        @status = status_code
         @status_text = status_text
       end
 

data/lib/tilia/http/response_decorator.rb

@@ -10,37 +10,22 @@ module Tilia
 
       # Constructor.
       #
-      # @param ResponseInterface inner
+      # @param [ResponseInterface] inner
       def initialize(inner)
         @inner = inner
       end
 
-      # Returns the current HTTP status code.
-      #
-      # @return int
+      # (see ResponseInterface#status)
       def status
         @inner.status
       end
 
-      # Returns the human-readable status string.
-      #
-      # In the case of a 200, this may for example be 'OK'.
-      #
-      # @return [String]
+      # (see ResponseInterface#status_text)
       def status_text
         @inner.status_text
       end
 
-      # Sets the HTTP status code.
-      #
-      # This can be either the full HTTP status code with human readable string,
-      # for example: "403 I can't let you do that, Dave".
-      #
-      # Or just the code, in which case the appropriate default message will be
-      # added.
-      #
-      # @param [String, Fixnum] status
-      # @return [void]
+      # (see ResponseInterface#status=)
       def status=(status)
         @inner.status = status
       end

data/lib/tilia/http/response_interface.rb

@@ -6,7 +6,7 @@ module Tilia
 
       # Returns the current HTTP status code.
       #
-      # @return int
+      # @return [Fixnum]
       def status
       end
 
@@ -27,9 +27,9 @@ module Tilia
       # added.
       #
       # @param [String, Fixnum] status
-      # @throws \InvalidArgumentExeption
+      # @raise [ArgumentError] if the status code deoes not have 3 digits
       # @return [void]
-      def status=(_status)
+      def status=(status)
       end
     end
   end

data/lib/tilia/http/sapi.rb

@@ -26,7 +26,7 @@ module Tilia
       # This static method will create a new Request object, based on the
       # current PHP request.
       #
-      # @return Request
+      # @return [Request]
       def self.request
         fail NotImplementedError, 'This object method now is an instance method'
       end
@@ -35,7 +35,7 @@ module Tilia
       #
       # This calls php's header function and streams the body to php://output.
       #
-      # @param ResponseInterface response
+      # @param [ResponseInterface] response
       # @return [void]
       def self.send_response(response)
         # RUBY: Rack does not support HTTP Version (?)
@@ -62,8 +62,8 @@ module Tilia
       # This static method will create a new Request object, based on a PHP
       # $_SERVER array.
       #
-      # @param array server_array
-      # @return Request
+      # @param [Hash] server_array
+      # @return [Request]
       def self.create_from_server_array(server_array)
         headers = {}
         method = nil

data/lib/tilia/http/url_util.rb

@@ -5,7 +5,7 @@ module Tilia
     # Note: this class is deprecated. All its functionality moved to functions.php
     # or sabre\uri.
     #
-    # @deprectated
+    # @deprecated
     module UrlUtil
       # Encodes the path of a url.
       #
@@ -51,7 +51,7 @@ module Tilia
       #
       # @deprecated Use Sabre\Uri\split.
       # @param [String] path
-      # @return array
+      # @return [Array]
       def self.split_path(path)
         Tilia::Uri.split(path)
       end

data/lib/tilia/http/util.rb

@@ -8,7 +8,7 @@ module Tilia
       #
       # @deprecated Use Tilia::Http::negotiate_content_type
       # @param [String, nil] accept_header_value
-      # @param array available_options
+      # @param [Array<String>] available_options
       # @return [String, nil]
       def self.negotiate_content_type(accept_header_value, available_options)
         Http.negotiate_content_type(accept_header_value, available_options)
@@ -17,8 +17,8 @@ module Tilia
       # Deprecated! Use negotiateContentType.
       #
       # @deprecated Use Tilia::Http::negotiate_content_type
-      # @param [String, nil] accept_header
-      # @param array available_options
+      # @param [String, nil] accept_header_value
+      # @param [Array<String>] available_options
       # @return [String, nil]
       def self.negotiate(accept_header_value, available_options)
         Http.negotiate_content_type(accept_header_value, available_options)
@@ -30,7 +30,7 @@ module Tilia
       #
       # @deprecated Use Tilia::Http::parse_date
       # @param [String] date_header
-      # @return bool|DateTime
+      # @return [Time, nil]
       def self.parse_http_date(date_header)
         Http.parse_date(date_header)
       end
@@ -41,7 +41,7 @@ module Tilia
       # specified as GMT.
       #
       # @deprecated Use Tilia::Http::to_date
-      # @param \DateTime date_time
+      # @param [Time] date_time
       # @return [String]
       def self.to_http_date(date_time)
         Http.to_date(date_time)

data/lib/tilia/http/version.rb

@@ -3,7 +3,7 @@ module Tilia
     # This class contains the version number for the HTTP package
     class Version
       # Full version number
-      VERSION = '4.1.0.8'
+      VERSION = '4.2.1'.freeze
     end
   end
 end