http-parser 1.0.5 → 1.2.0

data/http-parser.gemspec

@@ -1,33 +1,35 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "http-parser/version"
-
-Gem::Specification.new do |s|
-  s.name        = "http-parser"
-  s.version     = HttpParser::VERSION
-  s.authors     = ["Stephen von Takach"]
-  s.email       = ["steve@cotag.me"]
-  s.license     = 'MIT'
-  s.homepage    = "https://github.com/cotag/http-parser"
-  s.summary     = "Ruby bindings to joyent/http-parser"
-  s.description = <<-EOF
-    A super fast http parser for ruby.
-    Cross platform and multiple ruby implementation support thanks to ffi.
-  EOF
-
-
-  s.add_dependency 'ffi-compiler', '>= 0.0.2'
-  s.add_dependency 'rake'
-
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'yard'
-  
-
-  s.files = Dir["{lib}/**/*"] + %w(Rakefile http-parser.gemspec README.md LICENSE)
-  s.files += ["ext/http-parser/http_parser.c", "ext/http-parser/http_parser.h"]
-  s.test_files = Dir["spec/**/*"]
-  s.extra_rdoc_files = ["README.md"]
-
-  s.extensions << "ext/Rakefile"
-  s.require_paths = ["lib"]
-end
+# frozen_string_literal: true
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "http-parser/version"
+
+Gem::Specification.new do |s|
+  s.name        = "http-parser"
+  s.version     = HttpParser::VERSION
+  s.authors     = ["Stephen von Takach"]
+  s.email       = ["steve@cotag.me"]
+  s.license     = 'MIT'
+  s.homepage    = "https://github.com/cotag/http-parser"
+  s.summary     = "Ruby bindings to joyent/http-parser"
+  s.description = <<-EOF
+    A super fast http parser for ruby.
+    Cross platform and multiple ruby implementation support thanks to ffi.
+  EOF
+
+
+  s.add_dependency 'ffi-compiler', '>= 1.0', '< 2.0'
+
+  s.add_development_dependency 'rake',  '~> 11.2'
+  s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'yard',  '~> 0.9'
+  
+
+  s.files = Dir["{lib}/**/*"] + %w(Rakefile http-parser.gemspec README.md LICENSE)
+  s.files += ["ext/http-parser/http_parser.c", "ext/http-parser/http_parser.h"]
+  s.test_files = Dir["spec/**/*"]
+  s.extra_rdoc_files = ["README.md"]
+
+  s.extensions << "ext/Rakefile"
+  s.require_paths = ["lib"]
+end

data/lib/http-parser.rb

@@ -1,9 +1,11 @@
-require "ffi"       # Bindings to C libraries
-
-require "http-parser/ext"       # Loads http-parser ext
-require "http-parser/errors"    # http-parser error definitions
-require "http-parser/types"     # http-parser data structures
-require "http-parser/parser"    # the core http-parser abstraction
-
-module HttpParser
-end
+# frozen_string_literal: true
+
+require "ffi"       # Bindings to C libraries
+
+require "http-parser/ext"       # Loads http-parser ext
+require "http-parser/errors"    # http-parser error definitions
+require "http-parser/types"     # http-parser data structures
+require "http-parser/parser"    # the core http-parser abstraction
+
+module HttpParser
+end

data/lib/http-parser/errors.rb

@@ -1,74 +1,77 @@
-
-module HttpParser
-    class Error < StandardError
-        class OK < Error; end
-
-        # Any callback-related errors
-        class CALLBACK < Error; end
-
-        # Parsing-related errors
-        class INVALID_EOF_STATE < Error; end
-        class HEADER_OVERFLOW < Error; end
-        class CLOSED_CONNECTION < Error; end
-
-        class INVALID_VERSION < Error; end
-        class INVALID_STATUS < Error; end
-        class INVALID_METHOD < Error; end
-        class INVALID_URL < Error; end
-        class INVALID_HOST < Error; end
-        class INVALID_PORT < Error; end
-        class INVALID_PATH < Error; end
-        class INVALID_QUERY_STRING < Error; end
-        class INVALID_FRAGMENT < Error; end
-        class LF_EXPECTED < Error; end
-        class INVALID_HEADER_TOKEN < Error; end
-        class INVALID_CONTENT_LENGTH < Error; end
-        class INVALID_CHUNK_SIZE < Error; end
-        class INVALID_CONSTANT < Error; end
-        class INVALID_INTERNAL_STATE < Error; end
-        class STRICT < Error; end
-        class PAUSED < Error; end
-
-        class UNKNOWN < Error; end
-    end
-
-    ERRORS = {
-        :OK => Error::OK,
-
-        :CB_message_begin => Error::CALLBACK,
-        :CB_url => Error::CALLBACK,
-        :CB_header_field => Error::CALLBACK,
-        :CB_header_value => Error::CALLBACK,
-        :CB_headers_complete => Error::CALLBACK,
-        :CB_body => Error::CALLBACK,
-        :CB_message_complete => Error::CALLBACK,
-        :CB_status => Error::CALLBACK,
-
-        :INVALID_EOF_STATE => Error::INVALID_EOF_STATE,
-        :HEADER_OVERFLOW => Error::HEADER_OVERFLOW,
-        :CLOSED_CONNECTION => Error::CLOSED_CONNECTION,
-        :INVALID_VERSION => Error::INVALID_VERSION,
-        :INVALID_STATUS => Error::INVALID_STATUS,
-        :INVALID_METHOD => Error::INVALID_METHOD,
-        :INVALID_URL => Error::INVALID_URL,
-        :INVALID_HOST => Error::INVALID_HOST,
-        :INVALID_PORT => Error::INVALID_PORT,
-        :INVALID_PATH => Error::INVALID_PATH,
-        :INVALID_QUERY_STRING => Error::INVALID_QUERY_STRING,
-        :INVALID_FRAGMENT => Error::INVALID_FRAGMENT,
-        :LF_EXPECTED => Error::LF_EXPECTED,
-        :INVALID_HEADER_TOKEN => Error::INVALID_HEADER_TOKEN,
-        :INVALID_CONTENT_LENGTH => Error::INVALID_CONTENT_LENGTH,
-        :INVALID_CHUNK_SIZE => Error::INVALID_CHUNK_SIZE,
-        :INVALID_CONSTANT => Error::INVALID_CONSTANT,
-        :INVALID_INTERNAL_STATE => Error::INVALID_INTERNAL_STATE,
-        :STRICT => Error::STRICT,
-        :PAUSED => Error::PAUSED,
-
-        :UNKNOWN => Error::UNKNOWN
-    }
-
-    attach_function :err_desc, :http_errno_description, [:int], :string, :blocking => true
-    attach_function :err_name, :http_errno_name, [:int], :string, :blocking => true
-end
-
+# frozen_string_literal: true
+
+module HttpParser
+    class Error < StandardError
+        class OK < Error; end
+
+        # Any callback-related errors
+        class CALLBACK < Error; end
+
+        # Parsing-related errors
+        class INVALID_EOF_STATE < Error; end
+        class HEADER_OVERFLOW < Error; end
+        class CLOSED_CONNECTION < Error; end
+
+        class INVALID_VERSION < Error; end
+        class INVALID_STATUS < Error; end
+        class INVALID_METHOD < Error; end
+        class INVALID_URL < Error; end
+        class INVALID_HOST < Error; end
+        class INVALID_PORT < Error; end
+        class INVALID_PATH < Error; end
+        class INVALID_QUERY_STRING < Error; end
+        class INVALID_FRAGMENT < Error; end
+        class LF_EXPECTED < Error; end
+        class INVALID_HEADER_TOKEN < Error; end
+        class INVALID_CONTENT_LENGTH < Error; end
+        class INVALID_CHUNK_SIZE < Error; end
+        class INVALID_CONSTANT < Error; end
+        class INVALID_INTERNAL_STATE < Error; end
+        class STRICT < Error; end
+        class PAUSED < Error; end
+
+        class UNKNOWN < Error; end
+    end
+
+    ERRORS = {
+        :OK => Error::OK,
+
+        :CB_message_begin => Error::CALLBACK,
+        :CB_url => Error::CALLBACK,
+        :CB_header_field => Error::CALLBACK,
+        :CB_header_value => Error::CALLBACK,
+        :CB_headers_complete => Error::CALLBACK,
+        :CB_body => Error::CALLBACK,
+        :CB_message_complete => Error::CALLBACK,
+        :CB_status => Error::CALLBACK,
+        :CB_chunk_header => Error::CALLBACK,
+        :CB_chunk_complete => Error::CALLBACK,
+
+        :INVALID_EOF_STATE => Error::INVALID_EOF_STATE,
+        :HEADER_OVERFLOW => Error::HEADER_OVERFLOW,
+        :CLOSED_CONNECTION => Error::CLOSED_CONNECTION,
+        :INVALID_VERSION => Error::INVALID_VERSION,
+        :INVALID_STATUS => Error::INVALID_STATUS,
+        :INVALID_METHOD => Error::INVALID_METHOD,
+        :INVALID_URL => Error::INVALID_URL,
+        :INVALID_HOST => Error::INVALID_HOST,
+        :INVALID_PORT => Error::INVALID_PORT,
+        :INVALID_PATH => Error::INVALID_PATH,
+        :INVALID_QUERY_STRING => Error::INVALID_QUERY_STRING,
+        :INVALID_FRAGMENT => Error::INVALID_FRAGMENT,
+        :LF_EXPECTED => Error::LF_EXPECTED,
+        :INVALID_HEADER_TOKEN => Error::INVALID_HEADER_TOKEN,
+        :INVALID_CONTENT_LENGTH => Error::INVALID_CONTENT_LENGTH,
+        :INVALID_CHUNK_SIZE => Error::INVALID_CHUNK_SIZE,
+        :INVALID_CONSTANT => Error::INVALID_CONSTANT,
+        :INVALID_INTERNAL_STATE => Error::INVALID_INTERNAL_STATE,
+        :STRICT => Error::STRICT,
+        :PAUSED => Error::PAUSED,
+
+        :UNKNOWN => Error::UNKNOWN
+    }
+
+    attach_function :err_desc, :http_errno_description, [:int], :string
+    attach_function :err_name, :http_errno_name, [:int], :string
+end
+

data/lib/http-parser/ext.rb

@@ -1,7 +1,9 @@
-require 'ffi'
-require 'ffi-compiler/loader'
-
-module HttpParser
-    extend FFI::Library
-    ffi_lib FFI::Compiler::Loader.find('http-parser-ext')
-end
+# frozen_string_literal: true
+
+require 'ffi'
+require 'ffi-compiler/loader'
+
+module HttpParser
+    extend FFI::Library
+    ffi_lib FFI::Compiler::Loader.find('http-parser-ext')
+end

data/lib/http-parser/parser.rb

@@ -1,224 +1,258 @@
-
-module HttpParser
-    class Parser
-        CALLBACKS = [:on_message_begin, :on_url, :on_status, :on_header_field, :on_header_value, :on_headers_complete, :on_body, :on_message_complete]
-
-        #
-        # Returns a new request/response instance variable
-        #
-        def self.new_instance &block
-            ::HttpParser::Instance.new &block
-        end
-
-
-        #
-        # Initializes the Parser instance.
-        #
-        def initialize(callback_obj = nil)
-            @settings = ::HttpParser::Settings.new
-            @callbacks = {} # so GC doesn't clean them up on java
-
-            if not callback_obj.nil?
-                CALLBACKS.each do |callback|
-                    self.__send__(callback, &callback_obj.method(callback)) if callback_obj.respond_to? callback
-                end
-            end
-
-            yield self if block_given?
-        end
-
-        #
-        # Registers an `on_message_begin` callback.
-        #
-        # @yield [instance]
-        #   The given block will be called when the HTTP message begins.
-        #
-        # @yieldparam [HttpParser::Instance] instance
-        #   The state so far of the request / response being processed.
-        #
-        def on_message_begin(&block)
-            cb = Callback.new(&block)
-            @callbacks[:on_message_begin] = cb
-            @settings[:on_message_begin] = cb
-        end
-
-        #
-        # Registers an `on_url` callback.
-        #
-        # @yield [instance, url]
-        #   The given block will be called when the Request URI is recognized
-        #   within the Request-Line.
-        #
-        # @yieldparam [HttpParser::Instance] instance
-        #   The state so far of the request / response being processed.
-        #
-        # @yieldparam [String] url
-        #   The recognized Request URI.
-        #
-        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2
-        #
-        def on_url(&block)
-            cb = DataCallback.new(&block)
-            @callbacks[:on_url] = cb
-            @settings[:on_url] = cb
-        end
-
-        #
-        # Registers an `on_status_complete` callback.
-        #
-        # @yield [instance]
-        #   The given block will be called when the status is recognized.
-        #
-        # @yieldparam [HttpParser::Instance] instance
-        #   The state so far of the request / response being processed.
-        #
-        def on_status(&block)
-            cb = DataCallback.new(&block)
-            @callbacks[:on_status] = cb
-            @settings[:on_status] = cb
-        end
-
-        #
-        # Registers an `on_header_field` callback.
-        #
-        # @yield [instance, field]
-        #   The given block will be called when a Header name is recognized
-        #   in the Headers.
-        #
-        # @yieldparam [HttpParser::Instance] instance
-        #   The state so far of the request / response being processed.
-        #
-        # @yieldparam [String] field
-        #   A recognized Header name.
-        #
-        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.5
-        #
-        def on_header_field(&block)
-            cb = DataCallback.new(&block)
-            @callbacks[:on_header_field] = cb
-            @settings[:on_header_field] = cb
-        end
-
-        #
-        # Registers an `on_header_value` callback.
-        #
-        # @yield [instance, value]
-        #   The given block will be called when a Header value is recognized
-        #   in the Headers.
-        #
-        # @yieldparam [HttpParser::Instance] instance
-        #   The state so far of the request / response being processed.
-        #
-        # @yieldparam [String] value
-        #   A recognized Header value.
-        #
-        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.5
-        #
-        def on_header_value(&block)
-            cb = DataCallback.new(&block)
-            @callbacks[:on_header_value] = cb
-            @settings[:on_header_value] = cb
-        end
-
-        #
-        # Registers an `on_headers_complete` callback.
-        #
-        # @yield [instance]
-        #   The given block will be called when the Headers stop.
-        #
-        # @yieldparam [HttpParser::Instance] instance
-        #   The state so far of the request / response being processed.
-        #
-        def on_headers_complete(&block)
-            cb = Callback.new(&block)
-            @callbacks[:on_headers_complete] = cb
-            @settings[:on_headers_complete] = cb
-        end
-
-        #
-        # Registers an `on_body` callback.
-        #
-        # @yield [instance, body]
-        #   The given block will be called when the body is recognized in the
-        #   message body.
-        #
-        # @yieldparam [HttpParser::Instance] instance
-        #   The state so far of the request / response being processed.
-        #
-        # @yieldparam [String] body
-        #   The full body or a chunk of the body from a chunked
-        #   Transfer-Encoded stream.
-        #
-        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.5
-        #
-        def on_body(&block)
-            cb = DataCallback.new(&block)
-            @callbacks[:on_body] = cb
-            @settings[:on_body] = cb
-        end
-
-        #
-        # Registers an `on_message_begin` callback.
-        #
-        # @yield [instance]
-        #   The given block will be called when the message completes.
-        #
-        # @yieldparam [HttpParser::Instance] instance
-        #   The state so far of the request / response being processed.
-        #
-        def on_message_complete(&block)
-            cb = Callback.new(&block)
-            @callbacks[:on_message_complete] = cb
-            @settings[:on_message_complete] = cb
-        end
-
-        #
-        # Parses data.
-        #
-        # @param [HttpParser::Instance] inst
-        #   The state so far of the request / response being processed.
-        #
-        # @param [String] data
-        #   The data to parse against the instance specified.
-        #
-        # @return [Boolean]
-        #   Returns true if the data was parsed successfully.
-        #
-        def parse(inst, data)
-            ::HttpParser.http_parser_execute(inst, @settings, data, data.length)
-            return inst.error?
-        end
-
-
-        protected
-
-
-        class Callback < ::FFI::Function
-            #
-            # Creates a new Parser callback.
-            #
-            def self.new(&block)
-                super(:int, [::HttpParser::Instance.ptr]) do |parser|
-                    begin
-                        catch(:return) { yield(parser); 0 }
-                    rescue
-                        -1
-                    end
-                end
-            end
-        end
-
-        class DataCallback < ::FFI::Function
-            def self.new(&block)
-                super(:int, [::HttpParser::Instance.ptr, :pointer, :size_t]) do |parser, buffer, length|
-                    begin
-                        data = buffer.get_bytes(0, length)
-                        catch(:return) { yield(parser, data); 0 }
-                    rescue
-                        -1
-                    end
-                end
-            end
-        end
-    end
-end
+# frozen_string_literal: true
+
+module HttpParser
+    class Parser
+        CALLBACKS = [
+            :on_message_begin, :on_url, :on_status, :on_header_field, :on_header_value,
+            :on_headers_complete, :on_body, :on_message_complete, :on_chunk_header, :on_chunk_complete
+        ]
+
+        #
+        # Returns a new request/response instance variable
+        #
+        def self.new_instance &block
+            ::HttpParser::Instance.new &block
+        end
+
+
+        #
+        # Initializes the Parser instance.
+        #
+        def initialize(callback_obj = nil)
+            @settings = ::HttpParser::Settings.new
+            @callbacks = {} # so GC doesn't clean them up on java
+
+            if not callback_obj.nil?
+                CALLBACKS.each do |callback|
+                    self.__send__(callback, &callback_obj.method(callback)) if callback_obj.respond_to? callback
+                end
+            end
+
+            yield self if block_given?
+        end
+
+        #
+        # Registers an `on_message_begin` callback.
+        #
+        # @yield [instance]
+        #   The given block will be called when the HTTP message begins.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        def on_message_begin(&block)
+            cb = Callback.new(&block)
+            @callbacks[:on_message_begin] = cb
+            @settings[:on_message_begin] = cb
+        end
+
+        #
+        # Registers an `on_url` callback.
+        #
+        # @yield [instance, url]
+        #   The given block will be called when the Request URI is recognized
+        #   within the Request-Line.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        # @yieldparam [String] url
+        #   The recognized Request URI.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2
+        #
+        def on_url(&block)
+            cb = DataCallback.new(&block)
+            @callbacks[:on_url] = cb
+            @settings[:on_url] = cb
+        end
+
+        #
+        # Registers an `on_status_complete` callback.
+        #
+        # @yield [instance]
+        #   The given block will be called when the status is recognized.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        def on_status(&block)
+            cb = DataCallback.new(&block)
+            @callbacks[:on_status] = cb
+            @settings[:on_status] = cb
+        end
+
+        #
+        # Registers an `on_header_field` callback.
+        #
+        # @yield [instance, field]
+        #   The given block will be called when a Header name is recognized
+        #   in the Headers.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        # @yieldparam [String] field
+        #   A recognized Header name.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.5
+        #
+        def on_header_field(&block)
+            cb = DataCallback.new(&block)
+            @callbacks[:on_header_field] = cb
+            @settings[:on_header_field] = cb
+        end
+
+        #
+        # Registers an `on_header_value` callback.
+        #
+        # @yield [instance, value]
+        #   The given block will be called when a Header value is recognized
+        #   in the Headers.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        # @yieldparam [String] value
+        #   A recognized Header value.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.5
+        #
+        def on_header_value(&block)
+            cb = DataCallback.new(&block)
+            @callbacks[:on_header_value] = cb
+            @settings[:on_header_value] = cb
+        end
+
+        #
+        # Registers an `on_headers_complete` callback.
+        #
+        # @yield [instance]
+        #   The given block will be called when the Headers stop.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        def on_headers_complete(&block)
+            cb = Callback.new(&block)
+            @callbacks[:on_headers_complete] = cb
+            @settings[:on_headers_complete] = cb
+        end
+
+        #
+        # Registers an `on_body` callback.
+        #
+        # @yield [instance, body]
+        #   The given block will be called when the body is recognized in the
+        #   message body.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        # @yieldparam [String] body
+        #   The full body or a chunk of the body from a chunked
+        #   Transfer-Encoded stream.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.5
+        #
+        def on_body(&block)
+            cb = DataCallback.new(&block)
+            @callbacks[:on_body] = cb
+            @settings[:on_body] = cb
+        end
+
+        #
+        # Registers an `on_message_begin` callback.
+        #
+        # @yield [instance]
+        #   The given block will be called when the message completes.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        def on_message_complete(&block)
+            cb = Callback.new(&block)
+            @callbacks[:on_message_complete] = cb
+            @settings[:on_message_complete] = cb
+        end
+
+        #
+        # Registers an `on_chunk_header` callback.
+        #
+        # @yield [instance]
+        #   The given block will be called when a new chunk header is received.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        def on_chunk_header(&block)
+            cb = Callback.new(&block)
+            @callbacks[:on_message_complete] = cb
+            @settings[:on_message_complete] = cb
+        end
+
+        #
+        # Registers an `on_chunk_complete` callback.
+        #
+        # @yield [instance]
+        #   The given block will be called when the current chunk completes.
+        #
+        # @yieldparam [HttpParser::Instance] instance
+        #   The state so far of the request / response being processed.
+        #
+        def on_chunk_complete(&block)
+            cb = Callback.new(&block)
+            @callbacks[:on_message_complete] = cb
+            @settings[:on_message_complete] = cb
+        end
+
+        #
+        # Parses data.
+        #
+        # @param [HttpParser::Instance] inst
+        #   The state so far of the request / response being processed.
+        #
+        # @param [String] data
+        #   The data to parse against the instance specified.
+        #
+        # @return [Boolean]
+        #   Returns true if the data was parsed successfully.
+        #
+        def parse(inst, data)
+            ::HttpParser.http_parser_execute(inst, @settings, data, data.length)
+            return inst.error?
+        end
+
+
+        protected
+
+
+        class Callback < ::FFI::Function
+            #
+            # Creates a new Parser callback.
+            #
+            def self.new(&block)
+                super(:int, [::HttpParser::Instance.ptr]) do |parser|
+                    begin
+                        catch(:return) { yield(parser); 0 }
+                    rescue
+                        -1
+                    end
+                end
+            end
+        end
+
+        class DataCallback < ::FFI::Function
+            def self.new(&block)
+                super(:int, [::HttpParser::Instance.ptr, :pointer, :size_t]) do |parser, buffer, length|
+                    begin
+                        data = buffer.get_bytes(0, length)
+                        catch(:return) { yield(parser, data); 0 }
+                    rescue
+                        -1
+                    end
+                end
+            end
+        end
+    end
+end