h1p 0.6 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f7937fd6bcefdd1627c208bf73054fb3fb03a855666c7247f04aac4398d280
-  data.tar.gz: ab6a866b843beaf92137b991048db9af006f4cb5e510e211dc6ba6652bbc84a2
+  metadata.gz: 2d2493b6fc11d7deb1231f9a2d0bf1c6dc59b00a01065da7086e8c65326f74df
+  data.tar.gz: e30bf2c5a3213a4744a66a412e2db34a2b26b05baa8073409a18c7e0bd314de3
 SHA512:
-  metadata.gz: 101e6e13aeed0cf2250dbe962c0c9c9edc5bf69e6ff2a59ee0d02018992c9b76dcaa4be3ddb44bbcb2272e355278a0b717c51050a2786cc95c00fbdb23bc40fa
-  data.tar.gz: 2d3130c067d51f173873d6181b76999dd897c241dcafc5fa3f69ec0837404b2fd7e292cadc2fbf9e27003e3dfd933dc394799abf03f12187d6c80e4f2dab83d6
+  metadata.gz: 2adc85f461d3a41e7e67f9c199be486b85fd46407e60455329ac065a5779c60d62328a049091bb9d4b7d0be2f1610db38a8744c35f7071b06991ec837235a981
+  data.tar.gz: 926acbd38590f74666e8d774b6f54d3b610cbf0570495727049b2c2ba628a80888d30e2e0bd83ac26b3897c9a0875be42ce336a439a9e07a2dfb8160aebc8441

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0 2023-06-07
+
+- Add support for array as header value (#2)
+
+## 0.6.1 2023-05-28
+
+- Fix sending response with frozen headers hash
+
 ## 0.6 2023-01-05
 
 - Add documentation

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    h1p (0.6)
+    h1p (1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.17.0)
+    minitest (5.18.0)
     rake (13.0.6)
-    rake-compiler (1.2.1)
+    rake-compiler (1.2.3)
       rake
 
 PLATFORMS
@@ -16,9 +16,9 @@ PLATFORMS
 
 DEPENDENCIES
   h1p!
-  minitest (~> 5.17.0)
+  minitest (~> 5.18.0)
   rake (~> 13.0.6)
-  rake-compiler (= 1.2.1)
+  rake-compiler (= 1.2.3)
 
 BUNDLED WITH
    2.2.26

data/README.md

@@ -230,15 +230,22 @@ arbitrary IO instances. To write a response with or without a body, use
 
 ```ruby
 H1P.send_response(socket, { 'Some-Header' => 'header value'}, 'foobar')
-#=> "HTTP/1.1 200 OK\r\nSome-Header: header value\r\n\r\nfoobar"
+# HTTP/1.1 200 OK
+# Some-Header: header value
+# 
+# foobar
 
 # The :protocol pseudo header sets the protocol in the status line:
 H1P.send_response(socket, { ':protocol' => 'HTTP/0.9' })
-#=> "HTTP/0.9 200 OK\r\n\r\n"
+# HTTP/0.9 200 OK
+#
+#
 
 # The :status pseudo header sets the response status:
 H1P.send_response(socket, { ':status' => '418 I\'m a teapot' })
-#=> "HTTP/1.1 418 I'm a teapot\r\n\r\n"
+# HTTP/1.1 418 I'm a teapot
+#
+#
 ```
 
 To send responses using chunked transfer encoding use
@@ -246,7 +253,13 @@ To send responses using chunked transfer encoding use
 
 ```ruby
 H1P.send_chunked_response(socket, {}, "foobar")
-#=> "HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\n\r\n6\r\nfoobar\r\n0\r\n\r\n"
+# HTTP/1.1 200 OK
+# Transfer-Encoding: chunked
+# 6
+# foobar
+# 0
+#
+#
 ```
 
 You can also call `H1P.send_chunked_response` with a block that provides the
@@ -263,10 +276,14 @@ To send individual chunks use `H1P.send_body_chunk`:
 
 ```ruby
 H1P.send_body_chunk(socket, 'foo')
-#=> "3\r\nfoo\r\n"
+# 3
+# foo
+#
 
 H1P.send_body_chunk(socket, nil)
-#=> "0\r\n\r\n"
+# 0
+#
+#
 ```
 
 ## Parser Design

data/ext/h1p/h1p.c

@@ -22,6 +22,7 @@ ID ID_call;
 ID ID_downcase;
 ID ID_eof_p;
 ID ID_eq;
+ID ID_join;
 ID ID_read_method;
 ID ID_read;
 ID ID_readpartial;
@@ -56,6 +57,7 @@ VALUE STR_transfer_encoding_capitalized;
 
 VALUE STR_CRLF;
 VALUE STR_EMPTY_CHUNK;
+VALUE STR_COMMA_SPACE;
 
 VALUE SYM_backend_read;
 VALUE SYM_backend_recv;
@@ -1176,12 +1178,24 @@ void send_response_write_status_line(send_response_ctx *ctx, VALUE protocol, VAL
   ctx->buffer_len += partlen + 2;
 }
 
+inline static VALUE format_comma_separated_header_values(VALUE array) {
+  return rb_funcall(array, ID_join, 1, STR_COMMA_SPACE);
+}
+
 int send_response_write_header(VALUE key, VALUE val, VALUE arg) {
   if (TYPE(key) != T_STRING) key = rb_funcall(key, ID_to_s, 0);
   char *keyptr = RSTRING_PTR(key);
   if (RSTRING_LEN(key) < 1 || keyptr[0] == ':') return 0;
 
-  if (TYPE(val) != T_STRING) val = rb_funcall(val, ID_to_s, 0);
+  switch (TYPE(val)) {
+    case T_STRING:
+      break;
+    case T_ARRAY:
+      val = format_comma_separated_header_values(val);
+      break;
+    default:
+      val = rb_funcall(val, ID_to_s, 0);
+  }
   unsigned int keylen = RSTRING_LEN(key);
   char *valptr = RSTRING_PTR(val);
   unsigned int vallen = RSTRING_LEN(val);
@@ -1236,10 +1250,11 @@ VALUE H1P_send_response(int argc,VALUE *argv, VALUE self) {
 
     bodyptr = RSTRING_PTR(body);
     bodylen = RSTRING_LEN(body);
-    rb_hash_aset(headers, STR_content_length_capitalized, INT2FIX(bodylen));
+    // rb_hash_aset(headers, STR_content_length_capitalized, INT2FIX(bodylen));
   }
 
   rb_hash_foreach(headers, send_response_write_header, (VALUE)&ctx);
+  send_response_write_header(STR_content_length_capitalized, INT2FIX(bodylen), (VALUE)&ctx);
 
   char *endptr = ctx.buffer_ptr + ctx.buffer_len;
   endptr[0] = '\r';
@@ -1309,8 +1324,8 @@ VALUE H1P_send_chunked_response(VALUE self, VALUE io, VALUE headers) {
   if (status == Qnil) status = STR_pseudo_status_default;
   send_response_write_status_line(&ctx, protocol, status);
 
-  rb_hash_aset(headers, STR_transfer_encoding_capitalized, STR_chunked);
   rb_hash_foreach(headers, send_response_write_header, (VALUE)&ctx);
+  send_response_write_header(STR_transfer_encoding_capitalized, STR_chunked, (VALUE)&ctx);
 
   ctx.buffer_ptr[ctx.buffer_len] = '\r';
   ctx.buffer_ptr[ctx.buffer_len + 1] = '\n';
@@ -1376,6 +1391,7 @@ void Init_H1P(void) {
   ID_downcase               = rb_intern("downcase");
   ID_eof_p                  = rb_intern("eof?");
   ID_eq                     = rb_intern("==");
+  ID_join                   = rb_intern("join");
   ID_read_method            = rb_intern("__read_method__");
   ID_read                   = rb_intern("read");
   ID_readpartial            = rb_intern("readpartial");
@@ -1404,8 +1420,9 @@ void Init_H1P(void) {
   GLOBAL_STR(STR_transfer_encoding,             "transfer-encoding");
   GLOBAL_STR(STR_transfer_encoding_capitalized, "Transfer-Encoding");
 
-  GLOBAL_STR(STR_CRLF,                        "\r\n");
-  GLOBAL_STR(STR_EMPTY_CHUNK,                 "0\r\n\r\n");
+  GLOBAL_STR(STR_CRLF,                          "\r\n");
+  GLOBAL_STR(STR_EMPTY_CHUNK,                   "0\r\n\r\n");
+  GLOBAL_STR(STR_COMMA_SPACE,                   ", ");
 
   SYM_backend_read  = ID2SYM(ID_backend_read);
   SYM_backend_recv  = ID2SYM(ID_backend_recv);

data/h1p.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 2.7'
 
-  s.add_development_dependency  'rake-compiler',        '1.2.1'
+  s.add_development_dependency  'rake-compiler',        '1.2.3'
   s.add_development_dependency  'rake',               '~>13.0.6'
-  s.add_development_dependency  'minitest',           '~>5.17.0'
+  s.add_development_dependency  'minitest',           '~>5.18.0'
 end

data/lib/h1p/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module H1P
-  VERSION = '0.6'
+  VERSION = '1.0'
 end

data/test/test_h1p.rb

@@ -9,30 +9,38 @@ class SendResponseTest < MiniTest::Test
     H1P.send_response(o, { ':status' => '418 I\'m a teapot' })
     o.close
     response = i.read
-    assert_equal "HTTP/1.1 418 I'm a teapot\r\n\r\n", response
+    assert_equal "HTTP/1.1 418 I'm a teapot\r\nContent-Length: 0\r\n\r\n", response
 
     i, o = IO.pipe
     count = H1P.send_response(o, { ':protocol' => 'HTTP/1.0' })
     o.close
     response = i.read
-    assert_equal "HTTP/1.0 200 OK\r\n\r\n", response
-    assert_equal "HTTP/1.0 200 OK\r\n\r\n".bytesize, count
+    assert_equal "HTTP/1.0 200 OK\r\nContent-Length: 0\r\n\r\n", response
+    assert_equal "HTTP/1.0 200 OK\r\nContent-Length: 0\r\n\r\n".bytesize, count
   end
 
   def test_send_response_string_headers
     i, o = IO.pipe
-    H1P.send_response(o, { 'Foo' => 'Bar', 'Content-Length' => '123' })
+    H1P.send_response(o, { 'Foo' => 'Bar', 'X-Blah' => '123' })
     o.close
     response = i.read
-    assert_equal "HTTP/1.1 200 OK\r\nFoo: Bar\r\nContent-Length: 123\r\n\r\n", response
+    assert_equal "HTTP/1.1 200 OK\r\nFoo: Bar\r\nX-Blah: 123\r\nContent-Length: 0\r\n\r\n", response
   end
 
   def test_send_response_non_string_headers
     i, o = IO.pipe
-    H1P.send_response(o, { :Foo => 'Bar', 'Content-Length' => 123 })
+    H1P.send_response(o, { :Foo => 'Bar', 'X-Blah' => 123 })
     o.close
     response = i.read
-    assert_equal "HTTP/1.1 200 OK\r\nFoo: Bar\r\nContent-Length: 123\r\n\r\n", response
+    assert_equal "HTTP/1.1 200 OK\r\nFoo: Bar\r\nX-Blah: 123\r\nContent-Length: 0\r\n\r\n", response
+  end
+
+  def test_send_response_multiple_header_values
+    i, o = IO.pipe
+    H1P.send_response(o, { :Foo => ['Bar', 'Baz'], 'X-Blah' => 123 })
+    o.close
+    response = i.read
+    assert_equal "HTTP/1.1 200 OK\r\nFoo: Bar, Baz\r\nX-Blah: 123\r\nContent-Length: 0\r\n\r\n", response
   end
 
   def test_send_response_with_body
@@ -43,6 +51,15 @@ class SendResponseTest < MiniTest::Test
     assert_equal "HTTP/1.1 200 OK\r\nContent-Length: 6\r\n\r\nfoobar", response
   end
 
+  def test_send_response_with_frozen_headers_hash
+    i, o = IO.pipe
+    h = {Foo: 'bar'}.freeze
+    H1P.send_response(o, h, 'foo')
+    o.close
+    response = i.read
+    assert_equal "HTTP/1.1 200 OK\r\nFoo: bar\r\nContent-Length: 3\r\n\r\nfoo", response
+  end
+
   def test_send_response_with_big_body
     i, o = IO.pipe
     body = "abcdefg" * 10000
@@ -111,4 +128,21 @@ class SendChunkedResponseTest < MiniTest::Test
     assert_equal "HTTP/1.1 200 OK\r\nFoo: bar\r\nTransfer-Encoding: chunked\r\n\r\n3\r\nfoo\r\n3\r\nbar\r\n3\r\nbaz\r\n0\r\n\r\n", response
     assert_equal len, response.bytesize
   end
+
+  def test_send_chunked_response_with_frozen_headers_hash
+    isrc, osrc = IO.pipe
+    osrc << 'foobarbaz'
+    osrc.close
+
+    i, o = IO.pipe
+    h = { 'Foo' => 'bar' }.freeze
+    len = H1P.send_chunked_response(o, h) do
+      isrc.read(3)
+    end
+    o.close
+
+    response = i.read
+    assert_equal "HTTP/1.1 200 OK\r\nFoo: bar\r\nTransfer-Encoding: chunked\r\n\r\n3\r\nfoo\r\n3\r\nbar\r\n3\r\nbaz\r\n0\r\n\r\n", response
+    assert_equal len, response.bytesize
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: h1p
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '1.0'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.17.0
+        version: 5.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.17.0
+        version: 5.18.0
 description: 
 email: sharon@noteflakes.com
 executables: []