ffi-http-parser 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,2 @@
+doc/
+pkg/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "FFI::HTTP::Parser Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,11 @@
+### 0.1.0 / 2012-06-23
+
+* Initial release:
+  * Provides the same API as [http-parser-lite].
+  * Supports:
+    * Ruby 1.8.7
+    * Ruby >= 1.9.1
+    * JRuby >= 1.6.7
+
+[http-parser]: https://github.com/joyent/http-parser#readme
+[http-parser-lite]: https://github.com/deepfryed/http-parser-lite#readme

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# ffi-http-parser
+
+* [Homepage](https://github.com/postmodern/ffi-http-parser#readme)
+* [Issues](https://github.com/postmodern/ffi-http-parser/issues)
+* [Documentation](http://rubydoc.info/gems/ffi-http-parser/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+Ruby FFI bindings to the [http-parser][1] library.
+
+## Features
+
+* Provides the same API as [http-parser-lite][2].
+* Supports:
+  * Ruby 1.8.7
+  * Ruby >= 1.9.1
+  * JRuby >= 1.6.7
+
+## Examples
+
+    require 'ffi/http/parser'
+
+    parser = FFI::HTTP::Parser.new do |parser|
+      parser.on_message_begin do
+        puts "message begin"
+      end
+
+      parser.on_message_complete do
+        puts "message end"
+      end
+
+      parser.on_url do |data|
+        puts "url: #{data}"
+      end
+
+      parser.on_header_field do |data|
+        puts "field: #{data}"
+      end
+
+      parser.on_header_value do |data|
+        puts "value: #{data}"
+      end
+
+      parser.on_body do |data|
+        puts "body: #{data}"
+      end
+    end
+
+## Requirements
+
+* [http-parser](https://github.com/joyent/http-parser#readme) 1.0
+* [ffi](https://github.com/ffi/ffi#readme) ~> 1.0
+
+## Install
+
+    $ gem install ffi-http-parser
+
+## Copyright
+
+Copyright (c) 2012 Hal Brodigan
+
+See {file:LICENSE.txt} for details.
+
+[1]: https://github.com/joyent/http-parser#readme
+[2]: https://github.com/deepfryed/http-parser-lite#readme

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.7'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard

data/ffi-http-parser.gemspec

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'ffi/http/parser/version'
+                  FFI::HTTP::Parser::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/gemspec.yml

@@ -0,0 +1,17 @@
+name: ffi-http-parser
+summary: FFI bindings for http-parser
+description: Ruby FFI bindings to the http-parser library.
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/ffi-http-parser#readme
+
+requirements: http-parser 1.0
+
+dependencies:
+  ffi: ~> 1.0
+
+development_dependencies:
+  rubygems-tasks: ~> 0.2
+  rspec: ~> 2.4
+  yard: ~> 0.7

data/lib/ffi/http/parser.rb

@@ -0,0 +1,2 @@
+require 'ffi/http/parser/parser'
+require 'ffi/http/parser/version'

data/lib/ffi/http/parser/instance.rb

@@ -0,0 +1,398 @@
+require 'ffi/http/parser/parser'
+require 'ffi/http/parser/settings'
+
+require 'ffi'
+
+module FFI
+  module HTTP
+    module Parser
+      class Instance < FFI::Struct
+
+        layout :type_flags,   :uchar,
+               :state,        :uchar,
+               :header_state, :uchar,
+               :index,        :uchar,
+
+               :nread,          :uint32,
+               :content_length, :int64,
+
+               # READ-ONLY
+               :http_major,  :ushort,
+               :http_minor,  :ushort,
+               :status_code, :ushort, # responses only
+               :method,      :uchar,  # requests only
+
+               # 1 = Upgrade header was present and the parser has exited because of that.
+               # 0 = No upgrade header present.
+               #
+               # Should be checked when http_parser_execute() returns in addition to
+               # error checking.
+               :upgrade,     :char,
+
+               # PUBLIC
+               :data, :pointer
+
+        # The parser type (`:request`, `:response` or `:both`)
+        attr_accessor :type
+
+        #
+        # Initializes the Parser instance.
+        #
+        # @param [FFI::Pointer] ptr
+        #   Optional pointer to an existing `http_parser` struct.
+        #
+        def initialize(ptr=nil)
+          if ptr then super(ptr)
+          else        super()
+          end
+
+          @settings = Settings.new
+
+          yield self if block_given?
+
+          Parser.http_parser_init(self,type) unless ptr
+        end
+
+        #
+        # Registers an `on_message_begin` callback.
+        #
+        # @yield []
+        #   The given block will be called when the HTTP message begins.
+        #
+        def on_message_begin(&block)
+          @settings[:on_message_begin] = wrap_callback(block)
+        end
+
+        #
+        # Registers an `on_path` callback.
+        #
+        # @yield [path]
+        #   The given block will be called when the path is recognized within
+        #   the Request URI.
+        #
+        # @yieldparam [String] path
+        #   The recognized URI path.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2
+        #
+        def on_path(&block)
+          @settings[:on_path] = wrap_data_callback(block)
+        end
+
+        #
+        # Registers an `on_query_string` callback.
+        #
+        # @yield [query]
+        #   The given block will be called when the query-string is recognized
+        #   within the Request URI.
+        #
+        # @yieldparam [String] query
+        #   The recognized URI query-string.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2
+        #
+        def on_query_string(&block)
+          @settings[:on_query_string] = wrap_data_callback(block)
+        end
+
+        #
+        # Registers an `on_fragment` callback.
+        #
+        # @yield [fragment]
+        #   The given block will be called when the fragment is recognized
+        #   within the Request URI.
+        #
+        # @yieldparam [String] fragment
+        #   The recognized URI fragment.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2
+        #
+        def on_fragment(&block)
+          @settings[:on_fragment] = wrap_data_callback(block)
+        end
+
+        #
+        # Registers an `on_url` callback.
+        #
+        # @yield [url]
+        #   The given block will be called when the Request URI is recognized
+        #   within the Request-Line.
+        #
+        # @yieldparam [String] url
+        #   The recognized Request URI.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2
+        #
+        def on_url(&block)
+          @settings[:on_url] = wrap_data_callback(block)
+        end
+
+        #
+        # Registers an `on_header_field` callback.
+        #
+        # @yield [field]
+        #   The given block will be called when a Header name is recognized
+        #   in the Headers.
+        #
+        # @yieldparam [String] field
+        #   A recognized Header name.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.5
+        #
+        def on_header_field(&block)
+          @settings[:on_header_field] = wrap_data_callback(block)
+        end
+
+        #
+        # Registers an `on_header_value` callback.
+        #
+        # @yield [value]
+        #   The given block will be called when a Header value is recognized
+        #   in the Headers.
+        #
+        # @yieldparam [String] value
+        #   A recognized Header value.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.5
+        #
+        def on_header_value(&block)
+          @settings[:on_header_value] = wrap_data_callback(block)
+        end
+
+        #
+        # Registers an `on_headers_complete` callback.
+        #
+        # @yield []
+        #   The given block will be called when the Headers stop.
+        #
+        def on_headers_complete(&block)
+          @settings[:on_headers_complete] = proc { |parser|
+            case block.call()
+            when :error then -1
+            when :stop  then  1
+            else              0
+            end
+          }
+        end
+
+        #
+        # Registers an `on_body` callback.
+        #
+        # @yield [body]
+        #   The given block will be called when the body is recognized in the
+        #   message body.
+        #
+        # @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)
+          @settings[:on_body] = wrap_data_callback(block)
+        end
+
+        #
+        # Registers an `on_message_begin` callback.
+        #
+        # @yield []
+        #   The given block will be called when the message completes.
+        #
+        def on_message_complete(&block)
+          @settings[:on_message_complete] = wrap_callback(block)
+        end
+
+        #
+        # Parses data.
+        #
+        # @param [String] data
+        #   The data to parse.
+        #
+        # @return [Integer]
+        #   The number of bytes parsed. `0` will be returned if the parser
+        #   encountered an error.
+        #
+        def parse(data)
+          Parser.http_parser_execute(self,@settings,data,data.length)
+        end
+
+        #
+        # Parses data.
+        #
+        # @param [String] data
+        #   The data to parse.
+        #
+        # @return [Instance]
+        #   The Instance parser.
+        #
+        def <<(data)
+          parse(data)
+          return self
+        end
+
+        #
+        # Resets the parser.
+        #
+        def reset!
+          Parser.http_parser_init(self,type)
+        end
+
+        alias reset reset!
+
+        #
+        # The type of the parser.
+        #
+        # @return [:request, :response, :both]
+        #   The parser type.
+        #
+        def type
+          TYPES[self[:type_flags] & 0x3]
+        end
+
+        #
+        # Sets the type of the parser.
+        #
+        # @param [:request, :response, :both] new_type
+        #   The new parser type.
+        #
+        def type=(new_type)
+          self[:type_flags] = ((flags << 2) | TYPES[new_type])
+        end
+
+        #
+        # Flags for the parser.
+        #
+        # @return [Integer]
+        #   Parser flags.
+        #
+        def flags
+          (self[:type_flags] & 0xfc) >> 2
+        end
+
+        #
+        # The parsed HTTP major version number.
+        #
+        # @return [Integer]
+        #   The HTTP major version number.
+        #
+        def http_major
+          self[:http_major]
+        end
+
+        #
+        # The parsed HTTP minor version number.
+        #
+        # @return [Integer]
+        #   The HTTP minor version number.
+        #
+        def http_minor
+          self[:http_minor]
+        end
+
+        #
+        # The parsed HTTP version.
+        #
+        # @return [String]
+        #   The HTTP version.
+        #
+        def http_version
+          "%d.%d" % [self[:http_major], self[:http_minor]]
+        end
+
+        #
+        # The parsed HTTP response Status Code.
+        #
+        # @return [Integer]
+        #   The HTTP Status Code.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1
+        #
+        def http_status
+          self[:status_code]
+        end
+
+        #
+        # The parsed HTTP Method.
+        #
+        # @return [Symbol]
+        #   The HTTP Method name.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.1
+        #
+        def http_method
+          METHODS[self[:method]]
+        end
+
+        #
+        # Determines whether the `Upgrade` header has been parsed.
+        #
+        # @return [Boolean]
+        #   Specifies whether the `Upgrade` header has been seen.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.42
+        #
+        def upgrade?
+          self[:upgrade] == 1
+        end
+
+        #
+        # Additional data attached to the parser.
+        #
+        # @return [FFI::Pointer]
+        #   Pointer to the additional data.
+        #
+        def data
+          self[:data]
+        end
+
+        #
+        # Determines whether the `Connection: keep-alive` header has been
+        # parsed.
+        #
+        # @return [Boolean]
+        #   Specifies whether the Connection should be kept alive.
+        #
+        # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.10
+        #
+        def keep_alive?
+          Parser.http_should_keep_alive(self) > 0
+        end
+
+        protected
+
+        #
+        # Wraps a callback, so if it returns `:error`, `-1` will be returned.
+        # `0` will be returned by default.
+        #
+        # @param [Proc] callback
+        #   The callback to wrap.
+        #
+        # @return [Proc]
+        #   The wrapped callback.
+        #
+        def wrap_callback(callback)
+          proc { |parser| (callback.call() == :error) ? -1 : 0 }
+        end
+
+        #
+        # Wraps a data callback, so if it returns `:error`, `-1` will be
+        # returned. `0` will be returned by default.
+        #
+        # @param [Proc] callback
+        #   The callback to wrap.
+        #
+        # @return [Proc]
+        #   The wrapped callback.
+        #
+        def wrap_data_callback(callback)
+          proc { |parser,buffer,length|
+            data = buffer.get_bytes(0,length)
+
+            (callback.call(data) == :error) ? -1 : 0
+          }
+        end
+
+      end
+    end
+  end
+end