http-parser-lite 0.5.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2644da08c5a1999e20e3f05e28731050e6b393e9170f7d902783b3f601d5b71d
+  data.tar.gz: b0cd1d650e9fceea8e63b7323b8f61bb5f379af86295762af030a14845a6ada4
+SHA512:
+  metadata.gz: e145fe33cdba596bd7e2816533fb03f1458ddf3326ebe971b85dde6743baf6b7e4778e647f21258702065e2f0fe6d7ab0f539589b61271c445dbcc75d376f0aa
+  data.tar.gz: 9b53c39d4db51d76a06bd671ff621a795e5534b0207e32118e335d898706f7c9c86e29d8002d13a2a06fe6f054f5a2f554b3c4050f161d839cd3a257d17827df

data/CHANGELOG

@@ -1,3 +1,16 @@
+== 1.0.0 (2024-04-02)
+
+* Fixed compiler warnings in extension for Ruby 3.3.0 support.
+
+== 0.6.0 (2013-01-01)
+
+* Added on_status_complete callback (Oscar Del Ben).
+* Updated http_parser.c from joytent/http-parser.
+
+== 0.5.1 (2012-07-25)
+
+* Updated http_parser.c from joytent/http-parser.
+
 == 0.5.0 (2012-07-21)
 
 * merged in pull/118 upstream to support url parsing with username and password.

data/README.md

@@ -21,6 +21,10 @@ parser.on_message_complete do
   puts "message complete"
 end
 
+parser.on_status_complete do
+  puts "status complete"
+end
+
 parser.on_headers_complete do
   puts "headers complete"
 end
@@ -65,6 +69,7 @@ HTTP::Parser
     #on_message_begin(&block)
     #on_message_complete(&block)
     #on_url(&block)
+    #on_status_complete(&block)
     #on_header_field(&block)
     #on_header_value(&block)
     #on_headers_complete(&block)
@@ -92,6 +97,11 @@ Exceptions:
 * HTTP::Parser::Error
 ```
 
+## JRuby Support
+
+Based on [flyerhzm/http-parser.java](https://github.com/flyerhzm/http-parser.java), some code has been borrowed from
+[http_parser.rb](https://github.com/tmm1/http_parser.rb)
+
 ## License
 
 MIT

data/ext/http-parser/http_parser.c

@@ -37,19 +37,24 @@
 # define MIN(a,b) ((a) < (b) ? (a) : (b))
 #endif
 
+#ifndef ARRAY_SIZE
+# define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
+#endif
+
+#ifndef BIT_AT
+# define BIT_AT(a, i)                                                \
+  (!!((unsigned int) (a)[(unsigned int) (i) >> 3] &                  \
+   (1 << ((unsigned int) (i) & 7))))
+#endif
+
+#ifndef ELEM_AT
+# define ELEM_AT(a, i, v) ((unsigned int) (i) < ARRAY_SIZE(a) ? (a)[(i)] : (v))
+#endif
 
-#if HTTP_PARSER_DEBUG
-#define SET_ERRNO(e)                                                 \
-do {                                                                 \
-  parser->http_errno = (e);                                          \
-  parser->error_lineno = __LINE__;                                   \
-} while (0)
-#else
 #define SET_ERRNO(e)                                                 \
 do {                                                                 \
   parser->http_errno = (e);                                          \
 } while(0)
-#endif
 
 
 /* Run the notify callback FOR, returning ER if it fails */
@@ -94,7 +99,7 @@ do {                                                                 \
     FOR##_mark = NULL;                                               \
   }                                                                  \
 } while (0)
-
+  
 /* Run the data callback FOR and consume the current byte */
 #define CALLBACK_DATA(FOR)                                           \
     CALLBACK_DATA_(FOR, p - FOR##_mark, p - data + 1)
@@ -185,45 +190,45 @@ static const int8_t unhex[256] =
 
 
 #if HTTP_PARSER_STRICT
-# define T 0
+# define T(v) 0
 #else
-# define T 1
+# define T(v) v
 #endif
 
 
-static const uint8_t normal_url_char[256] = {
+static const uint8_t normal_url_char[32] = {
 /*   0 nul    1 soh    2 stx    3 etx    4 eot    5 enq    6 ack    7 bel  */
-        0,       0,       0,       0,       0,       0,       0,       0,
+        0    |   0    |   0    |   0    |   0    |   0    |   0    |   0,
 /*   8 bs     9 ht    10 nl    11 vt    12 np    13 cr    14 so    15 si   */
-        0,       T,       0,       0,       T,       0,       0,       0,
+        0    | T(2)   |   0    |   0    | T(16)  |   0    |   0    |   0,
 /*  16 dle   17 dc1   18 dc2   19 dc3   20 dc4   21 nak   22 syn   23 etb */
-        0,       0,       0,       0,       0,       0,       0,       0,
+        0    |   0    |   0    |   0    |   0    |   0    |   0    |   0,
 /*  24 can   25 em    26 sub   27 esc   28 fs    29 gs    30 rs    31 us  */
-        0,       0,       0,       0,       0,       0,       0,       0,
+        0    |   0    |   0    |   0    |   0    |   0    |   0    |   0,
 /*  32 sp    33  !    34  "    35  #    36  $    37  %    38  &    39  '  */
-        0,       1,       1,       0,       1,       1,       1,       1,
+        0    |   2    |   4    |   0    |   16   |   32   |   64   |  128,
 /*  40  (    41  )    42  *    43  +    44  ,    45  -    46  .    47  /  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /*  48  0    49  1    50  2    51  3    52  4    53  5    54  6    55  7  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /*  56  8    57  9    58  :    59  ;    60  <    61  =    62  >    63  ?  */
-        1,       1,       1,       1,       1,       1,       1,       0,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |   0,
 /*  64  @    65  A    66  B    67  C    68  D    69  E    70  F    71  G  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /*  72  H    73  I    74  J    75  K    76  L    77  M    78  N    79  O  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /*  80  P    81  Q    82  R    83  S    84  T    85  U    86  V    87  W  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /*  88  X    89  Y    90  Z    91  [    92  \    93  ]    94  ^    95  _  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /*  96  `    97  a    98  b    99  c   100  d   101  e   102  f   103  g  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /* 104  h   105  i   106  j   107  k   108  l   109  m   110  n   111  o  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /* 112  p   113  q   114  r   115  s   116  t   117  u   118  v   119  w  */
-        1,       1,       1,       1,       1,       1,       1,       1,
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
 /* 120  x   121  y   122  z   123  {   124  |   125  }   126  ~   127 del */
-        1,       1,       1,       1,       1,       1,       1,       0, };
+        1    |   2    |   4    |   8    |   16   |   32   |   64   |   0, };
 
 #undef T
 
@@ -364,12 +369,12 @@ enum http_host_state
 
 #if HTTP_PARSER_STRICT
 #define TOKEN(c)            (tokens[(unsigned char)c])
-#define IS_URL_CHAR(c)      (normal_url_char[(unsigned char) (c)])
+#define IS_URL_CHAR(c)      (BIT_AT(normal_url_char, (unsigned char)c))
 #define IS_HOST_CHAR(c)     (IS_ALPHANUM(c) || (c) == '.' || (c) == '-')
 #else
 #define TOKEN(c)            ((c == ' ') ? ' ' : tokens[(unsigned char)c])
 #define IS_URL_CHAR(c)                                                         \
-  (normal_url_char[(unsigned char) (c)] || ((c) & 0x80))
+  (BIT_AT(normal_url_char, (unsigned char)c) || ((c) & 0x80))
 #define IS_HOST_CHAR(c)                                                        \
   (IS_ALPHANUM(c) || (c) == '.' || (c) == '-' || (c) == '_')
 #endif
@@ -403,7 +408,7 @@ static struct {
 };
 #undef HTTP_STRERROR_GEN
 
-int http_message_needs_eof(http_parser *parser);
+int http_message_needs_eof(const http_parser *parser);
 
 /* Our URL parser.
  *
@@ -861,6 +866,7 @@ size_t http_parser_execute (http_parser *parser,
       case s_res_line_almost_done:
         STRICT_CHECK(ch != LF);
         parser->state = s_header_field_start;
+        CALLBACK_NOTIFY(status_complete);
         break;
 
       case s_start_req:
@@ -1841,7 +1847,7 @@ error:
 
 /* Does the parser need to see an EOF to find the end of the message? */
 int
-http_message_needs_eof (http_parser *parser)
+http_message_needs_eof (const http_parser *parser)
 {
   if (parser->type == HTTP_REQUEST) {
     return 0;
@@ -1864,7 +1870,7 @@ http_message_needs_eof (http_parser *parser)
 
 
 int
-http_should_keep_alive (http_parser *parser)
+http_should_keep_alive (const http_parser *parser)
 {
   if (parser->http_major > 0 && parser->http_minor > 0) {
     /* HTTP/1.1 */
@@ -1882,9 +1888,10 @@ http_should_keep_alive (http_parser *parser)
 }
 
 
-const char * http_method_str (enum http_method m)
+const char *
+http_method_str (enum http_method m)
 {
-  return method_strings[m];
+  return ELEM_AT(method_strings, m, "<unknown>");
 }
 
 
@@ -1956,7 +1963,7 @@ http_parse_host_char(enum http_host_state s, const char ch) {
 
     /* FALLTHROUGH */
     case s_http_host_v6_start:
-      if (IS_HEX(ch) || ch == ':') {
+      if (IS_HEX(ch) || ch == ':' || ch == '.') {
         return s_http_host_v6;
       }
 
@@ -2161,3 +2168,8 @@ http_parser_pause(http_parser *parser, int paused) {
     assert(0 && "Attempting to pause parser in error state");
   }
 }
+
+int
+http_body_is_final(const struct http_parser *parser) {
+    return parser->state == s_message_done;
+}

data/ext/http-parser/http_parser.h

@@ -24,12 +24,13 @@
 extern "C" {
 #endif
 
-#define HTTP_PARSER_VERSION_MAJOR 1
+#define HTTP_PARSER_VERSION_MAJOR 2
 #define HTTP_PARSER_VERSION_MINOR 0
 
 #include <sys/types.h>
 #if defined(_WIN32) && !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER<1600)
 #include <BaseTsd.h>
+#include <stddef.h>
 typedef __int8 int8_t;
 typedef unsigned __int8 uint8_t;
 typedef __int16 int16_t;
@@ -38,8 +39,6 @@ typedef __int32 int32_t;
 typedef unsigned __int32 uint32_t;
 typedef __int64 int64_t;
 typedef unsigned __int64 uint64_t;
-typedef SIZE_T size_t;
-typedef SSIZE_T ssize_t;
 #else
 #include <stdint.h>
 #endif
@@ -51,14 +50,6 @@ typedef SSIZE_T ssize_t;
 # define HTTP_PARSER_STRICT 1
 #endif
 
-/* Compile with -DHTTP_PARSER_DEBUG=1 to add extra debugging information to
- * the error reporting facility.
- */
-#ifndef HTTP_PARSER_DEBUG
-# define HTTP_PARSER_DEBUG 0
-#endif
-
-
 /* Maximium header size allowed */
 #define HTTP_MAX_HEADER_SIZE (80*1024)
 
@@ -77,7 +68,7 @@ typedef struct http_parser_settings http_parser_settings;
  * chunked' headers that indicate the presence of a body.
  *
  * http_data_cb does not return data chunks. It will be call arbitrarally
- * many times for each string. E.G. you might get 10 callbacks for "on_path"
+ * many times for each string. E.G. you might get 10 callbacks for "on_url"
  * each providing just a few characters more data.
  */
 typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);
@@ -141,7 +132,7 @@ enum flags
 
 
 /* Map for errno-related constants
- *
+ * 
  * The provided argument should be a macro that takes 2 arguments.
  */
 #define HTTP_ERRNO_MAP(XX)                                           \
@@ -150,6 +141,7 @@ enum flags
                                                                      \
   /* Callback-related errors */                                      \
   XX(CB_message_begin, "the on_message_begin callback failed")       \
+  XX(CB_status_complete, "the on_status_complete callback failed")   \
   XX(CB_url, "the on_url callback failed")                           \
   XX(CB_header_field, "the on_header_field callback failed")         \
   XX(CB_header_value, "the on_header_value callback failed")         \
@@ -196,13 +188,6 @@ enum http_errno {
 /* Get an http_errno value from an http_parser */
 #define HTTP_PARSER_ERRNO(p)            ((enum http_errno) (p)->http_errno)
 
-/* Get the line number that generated the current error */
-#if HTTP_PARSER_DEBUG
-#define HTTP_PARSER_ERRNO_LINE(p)       ((p)->error_lineno)
-#else
-#define HTTP_PARSER_ERRNO_LINE(p)       0
-#endif
-
 
 struct http_parser {
   /** PRIVATE **/
@@ -229,10 +214,6 @@ struct http_parser {
    */
   unsigned char upgrade : 1;
 
-#if HTTP_PARSER_DEBUG
-  uint32_t error_lineno;
-#endif
-
   /** PUBLIC **/
   void *data; /* A pointer to get hook to the "connection" or "socket" object */
 };
@@ -241,6 +222,7 @@ struct http_parser {
 struct http_parser_settings {
   http_cb      on_message_begin;
   http_data_cb on_url;
+  http_cb      on_status_complete;
   http_data_cb on_header_field;
   http_data_cb on_header_value;
   http_cb      on_headers_complete;
@@ -289,12 +271,12 @@ size_t http_parser_execute(http_parser *parser,
 
 
 /* If http_should_keep_alive() in the on_headers_complete or
- * on_message_complete callback returns true, then this should be
+ * on_message_complete callback returns 0, then this should be
  * the last message on the connection.
  * If you are the server, respond with the "Connection: close" header.
  * If you are the client, close the connection.
  */
-int http_should_keep_alive(http_parser *parser);
+int http_should_keep_alive(const http_parser *parser);
 
 /* Returns a string version of the HTTP method. */
 const char *http_method_str(enum http_method m);
@@ -313,6 +295,9 @@ int http_parser_parse_url(const char *buf, size_t buflen,
 /* Pause or un-pause the parser; a nonzero value pauses */
 void http_parser_pause(http_parser *parser, int paused);
 
+/* Checks if this is the final chunk of the body. */
+int http_body_is_final(const http_parser *parser);
+
 #ifdef __cplusplus
 }
 #endif

data/ext/http-parser/ruby_http_parser.c

@@ -41,6 +41,12 @@ int rb_parser_on_url(http_parser *parser, char *data, size_t length) {
     return 0;
 }
 
+int rb_parser_on_status_complete(http_parser *parser) {
+    VALUE self = (VALUE)parser->data;
+    rb_parser_callback_call(self, "on_status_complete", 0, 0);
+    return 0;
+}
+
 int rb_parser_on_header_field(http_parser *parser, char *data, size_t length) {
     VALUE self = (VALUE)parser->data;
     rb_parser_callback_call(self, "on_header_field", data, length);
@@ -81,6 +87,7 @@ VALUE rb_parser_parse(VALUE self, VALUE data) {
     http_parser *parser = rb_http_parser_handle(self);
     http_parser_settings settings = {
         .on_url              = (http_data_cb)rb_parser_on_url,
+        .on_status_complete  = (http_cb)rb_parser_on_status_complete,
         .on_header_field     = (http_data_cb)rb_parser_on_header_field,
         .on_header_value     = (http_data_cb)rb_parser_on_header_value,
         .on_headers_complete = (http_cb)rb_parser_on_headers_complete,
@@ -142,11 +149,11 @@ VALUE rb_parser_error_q(VALUE self) {
 
 VALUE rb_parser_error(VALUE self) {
     http_parser *parser = rb_http_parser_handle(self);
-    int errno = HTTP_PARSER_ERRNO(parser);
-    return errno != HPE_OK ? rb_str_new2(http_errno_description(errno)) : Qnil;
+    int http_errno = HTTP_PARSER_ERRNO(parser);
+    return http_errno != HPE_OK ? rb_str_new2(http_errno_description(http_errno)) : Qnil;
 }
 
-Init_http_parser() {
+void Init_http_parser() {
     mHTTP        = rb_define_module("HTTP");
     cParser      = rb_define_class_under(mHTTP,   "Parser", rb_cObject);
     eParserError = rb_define_class_under(cParser, "Error",  rb_eStandardError);

data/lib/http-parser.rb

@@ -1,11 +1,20 @@
-require 'http-parser/http_parser'
-
 module HTTP
   class Parser
+    VERSION = '1.0.0'.freeze
+
     TYPE_REQUEST  = 0
     TYPE_RESPONSE = 1
     TYPE_BOTH     = 2
-    CALLBACKS     = %w(on_url on_header_field on_header_value on_headers_complete on_body on_message_begin on_message_complete)
+    CALLBACKS     = %w(
+      on_body
+      on_header_field
+      on_header_value
+      on_headers_complete
+      on_message_begin
+      on_message_complete
+      on_status_complete
+      on_url
+    )
 
     CALLBACKS.each do |name|
       define_method(name) do |&block|
@@ -31,3 +40,11 @@ module HTTP
     end
   end
 end
+
+if RUBY_PLATFORM =~ /java/
+  require_relative '../ext/vendor/http-parser.jar'
+  require 'http-parser.jar'
+  require 'ruby_http_parser'
+else
+  require 'http-parser/http_parser'
+end

data/test/test_http_parser.rb

@@ -33,7 +33,7 @@ describe 'http-parser' do
   end
 
 
-  it 'should call callbacks' do
+  it 'should call callbacks on requests' do
     got = []
     parser.on_message_begin    {got << 's'}
     parser.on_message_complete {got << 'e'}
@@ -43,10 +43,30 @@ describe 'http-parser' do
     parser.on_headers_complete {got << 'h'}
     parser.on_body             {got << 'b'}
 
+    # Should not be called
+    parser.on_status_complete  {got << 'X'}
+
     parser << "POST / HTTP/1.0\r\nContent-Type: text/plain\r\nContent-Length: 5\r\n\r\nhello"
     assert_equal %w(s u f v f v h b e), got
   end
 
+  it 'should call callbacks on responses' do
+    got = []
+    parser.on_message_begin    {got << 's'}
+    parser.on_message_complete {got << 'e'}
+    parser.on_status_complete  {got << 'S'}
+    parser.on_header_field     {got << 'f'}
+    parser.on_header_value     {got << 'v'}
+    parser.on_headers_complete {got << 'h'}
+    parser.on_body             {got << 'b'}
+
+    # Should not be called
+    parser.on_url              {got << 'X'}
+
+    parser << "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 5\r\n\r\nhello"
+    assert_equal %w(s S f v f v h b e), got
+  end
+
   it 'should parse chunked response' do
     got = []
     parser.on_url          {|data| got << data}
@@ -78,6 +98,12 @@ describe 'http-parser' do
     assert_equal '1.1',     parser.http_version
   end
 
+  it 'should parse PATCH' do
+    parser << "PATCH http://example.com HTTP/1.1\r\nUser-Agent: X-Test-UA\r\n\r\n"
+
+    assert_equal 'PATCH', parser.http_method
+  end
+
   it 'should raise an error on invalid data' do
     assert_raises(HTTP::Parser::Error) { parser << "GET / foobar\r\n" }
   end
@@ -156,6 +182,7 @@ describe 'http-parser' do
   end
 
   it 'should parser urls with user:pass' do
+    skip 'Not implemented in JRuby yet, see issues/2' if RUBY_PLATFORM =~ /java/
     parser.reset(HTTP::Parser::TYPE_REQUEST)
 
     url  = 'http://foo:bar@example.org/test.cgi?param1=1'

metadata

@@ -1,30 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: http-parser-lite
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Bharanee Rathna
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-07-25 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A lite ruby wrapper around Joyent http-parser
@@ -35,40 +46,38 @@ extensions:
 - ext/http-parser/extconf.rb
 extra_rdoc_files: []
 files:
-- ext/http-parser/ruby_http_parser.c
+- CHANGELOG
+- README.md
+- ext/http-parser/extconf.rb
 - ext/http-parser/http_parser.c
 - ext/http-parser/http_parser.h
-- ext/http-parser/extconf.rb
+- ext/http-parser/ruby_http_parser.c
+- lib/http-parser-lite.rb
+- lib/http-parser.rb
 - test/helper.rb
 - test/test_http_parser.rb
-- lib/http-parser.rb
-- lib/http-parser-lite.rb
-- README.md
-- CHANGELOG
 homepage: http://github.com/deepfryed/http-parser-lite
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 - ext
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
 summary: Simple wrapper around Joyent http-parser
 test_files: []
-has_rdoc: