tilia-http 4.1.0

data/lib/tilia/http/request.rb

@@ -0,0 +1,235 @@
+require 'cgi'
+module Tilia
+  module Http
+    # The Request class represents a single HTTP request.
+    #
+    # You can either simply construct the object from scratch, or if you need
+    # access to the current HTTP request, use Sapi::getRequest.
+    class Request
+      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
+      def initialize(method = nil, url = nil, headers = nil, body = nil)
+        initialize_message
+        @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
+        update_headers(headers) if headers
+        self.body = body if body
+      end
+
+      # Returns the current HTTP method
+      #
+      # @return [String]
+      attr_reader :method
+
+      # Sets the HTTP method
+      #
+      # @param [String] method
+      # @return [void]
+      attr_writer :method
+
+      # Returns the request url.
+      #
+      # @return [String]
+      attr_reader :url
+
+      # Sets the request url.
+      #
+      # @param [String] url
+      # @return [void]
+      attr_writer :url
+
+      # Returns the list of query parameters.
+      #
+      # This is equivalent to PHP's $_GET superglobal.
+      #
+      # @return array
+      def query_parameters
+        url = self.url
+
+        if !(index = url.index('?'))
+          {}
+        else
+          query_params = CGI.parse(url[index + 1..-1])
+          query_params.keys.each do |key|
+            query_params[key] = query_params[key][0] if query_params[key].size == 1
+            query_params[key] = nil if query_params[key].size == 0
+          end
+          query_params
+        end
+      end
+
+      # Sets the absolute url.
+      #
+      # @param [String] url
+      # @return [void]
+      attr_writer :absolute_url
+
+      # Returns the absolute url.
+      #
+      # @return [String]
+      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]
+      attr_writer :base_url
+
+      # Returns the current base url.
+      #
+      # @return [String]
+      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]
+      def path
+        # Removing duplicated slashes.
+        uri = url.gsub('//', '/')
+
+        uri = Tilia::Uri.normalize(uri)
+        base_uri = Tilia::Uri.normalize(base_url)
+
+        if uri.index(base_uri) == 0
+          # We're not interested in the query part (everything after the ?).
+          uri = uri.split('?').first
+          return Tilia::Http::UrlUtil.decode_path(uri[base_uri.size..-1]).gsub(%r{^/+|/+$}, '')
+        elsif uri + '/' == base_uri
+          # A special case, if the baseUri was accessed without a trailing
+          # slash, we'll accept it as well.
+          return ''
+        end
+
+        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]
+      attr_writer :post_data
+
+      # Returns the POST data.
+      #
+      # This is equivalent to PHP's $_POST superglobal.
+      #
+      # @return array
+      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]
+      def raw_server_value(value_name)
+        @raw_server_data[value_name]
+      end
+
+      # Sets the _SERVER array.
+      #
+      # @param array data
+      # @return [void]
+      def raw_server_data=(data)
+        @raw_server_data = data.dup
+      end
+
+      # Serializes the request object as a string.
+      #
+      # This is useful for debugging purposes.
+      #
+      # @return [String]
+      def to_s
+        out = "#{method} #{url} HTTP/#{http_version}\r\n"
+
+        headers.each do |key, value|
+          value.each do |v|
+            if key == 'Authorization'
+              v = v.split(' ').first
+              v << ' REDACTED'
+            end
+            out << "#{key}: #{v}\r\n"
+          end
+        end
+
+        out << "\r\n"
+        out << body_as_string
+
+        out
+      end
+    end
+  end
+end

data/lib/tilia/http/request_decorator.rb

@@ -0,0 +1,160 @@
+module Tilia
+  module Http
+    # Request Decorator
+    #
+    # This helper class allows you to easily create decorators for the Request
+    # object.
+    class RequestDecorator
+      include Tilia::Http::RequestInterface
+      include Tilia::Http::MessageDecoratorTrait
+
+      # Constructor.
+      #
+      # @param RequestInterface inner
+      def initialize(inner)
+        @inner = inner
+      end
+
+      # Returns the current HTTP method
+      #
+      # @return [String]
+      def method
+        @inner.method
+      end
+
+      # Sets the HTTP method
+      #
+      # @param [String] method
+      # @return [void]
+      def method=(method)
+        @inner.method = method
+      end
+
+      # Returns the request url.
+      #
+      # @return [String]
+      def url
+        @inner.url
+      end
+
+      # Sets the request url.
+      #
+      # @param [String] url
+      # @return [void]
+      def url=(url)
+        @inner.url = url
+      end
+
+      # Returns the absolute url.
+      #
+      # @return [String]
+      def absolute_url
+        @inner.absolute_url
+      end
+
+      # Sets the absolute url.
+      #
+      # @param [String] url
+      # @return [void]
+      def absolute_url=(url)
+        @inner.absolute_url = url
+      end
+
+      # Returns the current base url.
+      #
+      # @return [String]
+      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]
+      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]
+      def path
+        @inner.path
+      end
+
+      # Returns the list of query parameters.
+      #
+      # This is equivalent to PHP's $_GET superglobal.
+      #
+      # @return array
+      def query_parameters
+        @inner.query_parameters
+      end
+
+      # Returns the POST data.
+      #
+      # This is equivalent to PHP's $_POST superglobal.
+      #
+      # @return array
+      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]
+      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]
+      def raw_server_value(value_name)
+        @inner.raw_server_value(value_name)
+      end
+
+      # Sets the _SERVER array.
+      #
+      # @param array data
+      # @return [void]
+      def raw_server_data=(data)
+        @inner.raw_server_data = data
+      end
+
+      # Serializes the request object as a string.
+      #
+      # This is useful for debugging purposes.
+      #
+      # @return [String]
+      def to_s
+        @inner.to_s
+      end
+    end
+  end
+end

data/lib/tilia/http/request_interface.rb

@@ -0,0 +1,126 @@
+module Tilia
+  module Http
+    # The RequestInterface represents a HTTP request.
+    module RequestInterface
+      include Tilia::Http::MessageInterface
+
+      # Returns the current HTTP method
+      #
+      # @return [String]
+      def method
+      end
+
+      # Sets the HTTP method
+      #
+      # @param [String] method
+      # @return [void]
+      def method=(_method)
+      end
+
+      # Returns the request url.
+      #
+      # @return [String]
+      def url
+      end
+
+      # Sets the request url.
+      #
+      # @param [String] url
+      # @return [void]
+      def url=(_url)
+      end
+
+      # Returns the absolute url.
+      #
+      # @return [String]
+      def absolute_url
+      end
+
+      # Sets the absolute url.
+      #
+      # @param [String] url
+      # @return [void]
+      def absolute_url=(_url)
+      end
+
+      # Returns the current base url.
+      #
+      # @return [String]
+      def 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]
+      def 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]
+      def path
+      end
+
+      # Returns the list of query parameters.
+      #
+      # This is equivalent to PHP's $_GET superglobal.
+      #
+      # @return array
+      def query_parameters
+      end
+
+      # Returns the POST data.
+      #
+      # This is equivalent to PHP's $_POST superglobal.
+      #
+      # @return array
+      def 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]
+      def 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]
+      def raw_server_value(_value_name)
+      end
+
+      # Sets the _SERVER array.
+      #
+      # @param array data
+      # @return [void]
+      def raw_server_data=(_data)
+      end
+    end
+  end
+end

data/lib/tilia/http/response.rb

@@ -0,0 +1,164 @@
+module Tilia
+  module Http
+    # This class represents a single HTTP response.
+    class Response
+      include Tilia::Http::Message
+      include Tilia::Http::ResponseInterface
+
+      # This is the list of currently registered HTTP status codes.
+      #
+      # @return array
+      def self.status_codes
+        {
+          100 => 'Continue',
+          101 => 'Switching Protocols',
+          102 => 'Processing',
+          200 => 'OK',
+          201 => 'Created',
+          202 => 'Accepted',
+          203 => 'Non-Authorative Information',
+          204 => 'No Content',
+          205 => 'Reset Content',
+          206 => 'Partial Content',
+          207 => 'Multi-Status', # RFC 4918
+          208 => 'Already Reported', # RFC 5842
+          226 => 'IM Used', # RFC 3229
+          300 => 'Multiple Choices',
+          301 => 'Moved Permanently',
+          302 => 'Found',
+          303 => 'See Other',
+          304 => 'Not Modified',
+          305 => 'Use Proxy',
+          307 => 'Temporary Redirect',
+          308 => 'Permanent Redirect',
+          400 => 'Bad Request',
+          401 => 'Unauthorized',
+          402 => 'Payment Required',
+          403 => 'Forbidden',
+          404 => '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',
+          418 => 'I\'m a teapot', # RFC 2324
+          421 => 'Misdirected Request', # RFC7540 (HTTP/2)
+          422 => 'Unprocessable Entity', # RFC 4918
+          423 => 'Locked', # RFC 4918
+          424 => 'Failed Dependency', # RFC 4918
+          426 => 'Upgrade Required',
+          428 => 'Precondition Required', # RFC 6585
+          429 => 'Too Many Requests', # RFC 6585
+          431 => 'Request Header Fields Too Large', # RFC 6585
+          451 => 'Unavailable For Legal Reasons', # draft-tbray-http-legally-restricted-status
+          500 => 'Internal Server Error',
+          501 => 'Not Implemented',
+          502 => 'Bad Gateway',
+          503 => 'Service Unavailable',
+          504 => 'Gateway Timeout',
+          505 => 'HTTP Version not supported',
+          506 => 'Variant Also Negotiates',
+          507 => 'Insufficient Storage', # RFC 4918
+          508 => 'Loop Detected', # RFC 5842
+          509 => 'Bandwidth Limit Exceeded', # non-standard
+          510 => 'Not extended',
+          511 => 'Network Authentication Required' # RFC 6585
+        }
+      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
+      # @return [void]
+      def initialize(status = nil, headers = nil, body = nil)
+        initialize_message # RUBY
+
+        self.status = status if status
+        update_headers(headers) if headers
+        self.body = body if body
+      end
+
+      # Returns the current HTTP status code.
+      #
+      # @return int
+      attr_reader :status
+
+      # Returns the human-readable status string.
+      #
+      # In the case of a 200, this may for example be 'OK'.
+      #
+      # @return [String]
+      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]
+      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'
+        else
+          (
+            status_code,
+            status_text
+          ) = 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 = status_code.to_i
+        @status_text = status_text
+      end
+
+      # Serializes the response object as a string.
+      #
+      # This is useful for debugging purposes.
+      #
+      # @return [String]
+      def to_s
+        str = "HTTP/#{http_version} #{status} #{status_text}\r\n"
+        headers.each do |key, value|
+          value.each do |v|
+            str << "#{key}: #{v}\r\n"
+          end
+        end
+
+        str << "\r\n"
+        str << body_as_string
+        str
+      end
+    end
+  end
+end