llhttp 0.0.2 → 0.0.3

data/lib/llhttp/delegate.rb

@@ -1,36 +1,64 @@
 # frozen_string_literal: true
 
 module LLHttp
-  # Delegate for handling callbacks. Subclass this, implementing the necessary methods.
+  # [public] Delegate for handling callbacks. Subclass this object and implement necessary methods.
+  #
+  #   class Delegate < LLHttp::Delegate
+  #     def on_message_begin
+  #       ...
+  #     end
+  #
+  #     ...
+  #   end
   #
   class Delegate
+    # [public]
+    #
     def on_message_begin
     end
 
+    # [public]
+    #
     def on_url(url)
     end
 
+    # [public]
+    #
     def on_status(status)
     end
 
+    # [public]
+    #
     def on_header_field(field)
     end
 
+    # [public]
+    #
     def on_header_value(value)
     end
 
+    # [public]
+    #
     def on_headers_complete
     end
 
+    # [public]
+    #
     def on_body(body)
     end
 
+    # [public]
+    #
     def on_message_complete
     end
 
+    # [public]
+    #
     def on_chunk_header
     end
 
+    # [public]
+    #
     def on_chunk_complete
     end
   end

data/lib/llhttp/error.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module LLHttp
+  # [public] LLHttp's standard error object.
+  #
   class Error < StandardError
   end
 end

data/lib/llhttp/parser.rb

@@ -1,21 +1,38 @@
 # frozen_string_literal: true
 
 module LLHttp
-  # Wraps an llhttp context for parsing http requests and responses.
+  # [public] Wraps an llhttp context for parsing http requests and responses.
   #
-  # = Finishing
+  #   class Delegate < LLHttp::Delegate
+  #     def on_message_begin
+  #       ...
+  #     end
   #
-  # Call `LLHttp::Parser#finish` when processing is complete for the current request or response.
+  #     ...
+  #   end
   #
-  # = Introspection
+  #   parser = LLHttp::Parser.new(Delegate.new, type: :request)
+  #   parser << "GET / HTTP/1.1\r\n\r\n"
+  #   parser.finish
   #
-  # * `LLHttp::Parser#content_length` returns the content length of the current request.
-  # * `LLHttp::Parser#method` returns the method of the current response.
-  # * `LLHttp::Parser#keep_alive?` returns `true` if there might be any other messages following the last that was successfuly parsed.
+  #   ...
+  #
+  # Introspection
+  #
+  #   * `LLHttp::Parser#content_length` returns the content length of the current request.
+  #   * `LLHttp::Parser#method` returns the method of the current response.
+  #   * `LLHttp::Parser#status_code` returns the status code of the current response.
+  #   * `LLHttp::Parser#keep_alive?` returns `true` if there might be more messages.
+  #
+  # Finishing
+  #
+  #   Call `LLHttp::Parser#finish` when processing is complete for the current request or response.
   #
   class Parser
     LLHTTP_TYPES = {both: 0, request: 1, response: 2}.freeze
 
+    # [public] The parser type; one of: `both`, `request`, or `response`.
+    #
     attr_reader :type
 
     def initialize(delegate, type: :both)
@@ -26,4 +43,4 @@ module LLHttp
   end
 end
 
-require_relative "llhttp_ext"
+require_relative "../llhttp_ext"

data/lib/llhttp/version.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module LLHttp
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
+  # [public] LLHttp's current version.
+  #
   def self.version
     VERSION
   end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: llhttp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies: []
 description: Ruby bindings for llhttp.
-email: bryan@bryanp.org
+email: bryan@metabahn.com
 executables: []
 extensions:
 - ext/llhttp/extconf.rb
@@ -20,11 +20,15 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- ext/llhttp/api.c
 - ext/llhttp/extconf.rb
+- ext/llhttp/http.c
+- ext/llhttp/llhttp.c
+- ext/llhttp/llhttp.h
+- ext/llhttp/llhttp_ext.c
 - lib/llhttp.rb
 - lib/llhttp/delegate.rb
 - lib/llhttp/error.rb
-- lib/llhttp/llhttp_ext.bundle
 - lib/llhttp/parser.rb
 - lib/llhttp/version.rb
 homepage: https://github.com/metabahn/llhttp/
@@ -46,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Ruby bindings for llhttp.