fishwife 1.7.1-java → 1.8.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49ba88942b20584f44b25aefd7bf7e89b7aca866
-  data.tar.gz: 852715381ce87883a6eb97faf83e3bf79721ff48
+  metadata.gz: dde09a0a87fbd2aa589d44a02616cb08993cca24
+  data.tar.gz: b88680fc0b5dfa5ab36e111310fec7a087ead6c1
 SHA512:
-  metadata.gz: 05b6d43b0a0322c543c81d8adb212fa56f6f4104d2f70234af482e2cec75c35e7901952d92c25df9f39be9280ca40fe1a1e5b80e138994247f761e82aecf63e5
-  data.tar.gz: f96dfb3a3322d399189362c76ac84befa24348c2b82ffc7343ef2e83d1c0768022aed4f3992073dcf7a782895ae5ce53b17f626216804a6e3b1be56b3fd5aba9
+  metadata.gz: 1bdd3ba4110e324a8a5b678102c25edab31872633f29ffab82fc523f1f964eb3c9d3d750ed09fda8832edbcb3f6aa82018a7485824c22f4420b9bff55307fb68
+  data.tar.gz: df9ce253c9096bf6db08b5f058a1c377b408dd4f8b781a42d73ac7014b15f4a8eec920d71ee480ff3b66b7753cbb04d88634a29086ef5aef3db8d31a8cc89266

data/History.rdoc

@@ -1,3 +1,11 @@
+=== 1.8.0 (2015-5-3)
+* Added Fishwife::HttpServer::new :connections configuration, allowing
+  multiple connectors and including SSL support. (#10 with Gregory
+  Huczynski)
+* Upgrade/broaden to rjack-jetty [9.2.11, 9.4), for SSL/connections
+  support. Tested with 9.3.0.0 (M2 prerelease). Note that 9.2.11 is
+  awaiting upstream release and backport of the same features.
+
 === 1.7.1 (2015-3-30)
 * Add missing StringIO require from 1.7.0 rewind feature
   changes (Theo Hultberg, #8)

data/Manifest.txt

@@ -7,6 +7,7 @@ pom.xml
 bin/fishwife
 example/config.ru
 example/giant.ru
+example/ssl.ru
 lib/fishwife/base.rb
 lib/fishwife.rb
 lib/fishwife/http_server.rb
@@ -16,5 +17,6 @@ spec/fishwife_spec.rb
 spec/spec_helper.rb
 spec/test_app.rb
 spec/data/hello.txt
+spec/data/localhost.keystore
 spec/data/reddit-icon.png
-lib/fishwife/fishwife-1.7.1.jar
+lib/fishwife/fishwife-1.8.0.jar

data/README.rdoc

@@ -40,15 +40,21 @@ unique features:
 To use Fishwife with your Rack app and config.ru:
 
     gem install fishwife
-
     cd /path/to/my/rack/app
+
+Then:
+
     fishwife
 
 -or-
 
     rackup -s Fishwife
 
-See included example/config.ru and the note below on logging.
+See also:
+
+* Fishwife::HttpServer::new supported options
+* example/config.ru
+* Notes below on Logging and Process Monitoring
 
 == Logging
 
@@ -82,6 +88,8 @@ using:
   desired. For an example see:
   {boxed-geminabox}[https://github.com/dekellum/boxed-geminabox#readme].
 
+* Linux systemd
+
 All options also support redirecting log output (including any
 JVM-level errors) to a file. Iyyov supports log rotation internally.
 Unix-like logrotate(8) may be used with the former process monitors.

data/example/ssl.ru

@@ -0,0 +1,10 @@
+# -*- ruby -*-
+#\ -s Fishwife -O connections=tcp://127.0.0.1:9292|ssl://0.0.0.0:9433?key_store_path=spec/data/localhost.keystore&key_store_password=password
+
+# We don't assume SLF4J log output handler when launching via
+# 'rackup', so you should do something like this here.
+# If launching via bin/fishwife, this isn't required.
+require 'rjack-logback'
+RJack::Logback.config_console( :stderr => true, :thread => true )
+
+run proc { [ 200, {"Content-Type" => "text/plain"}, ["Hello", " world!\n"] ] }

data/lib/fishwife/base.rb

@@ -15,6 +15,6 @@
 #++
 
 module Fishwife
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
   LIB_DIR = File.dirname( __FILE__ )
 end

data/lib/fishwife/http_server.rb

@@ -17,17 +17,20 @@
 module Fishwife
   class HttpServer < RJack::Jetty::ServerFactory
 
-    attr_accessor :host
-
     # Create the server with specified options:
     #
     # :host::
-    #     String specifying the IP address to bind to (default: 0.0.0.0)
+    #     The interface to bind to (default: 0.0.0.0 -> all)
     #
     # :port::
-    #     String or integer with the port to bind to (default: 9292).
-    #     Jetty picks if given port 0 (and port can be read on return
-    #     from start.)
+    #     The local port to bind to, for the first connection. Jetty
+    #     picks if given port 0, and first connection port can be read
+    #     on return from start. (default: 9292)
+    #
+    # :connections::
+    #     An array, or a string that will be split on '|', where each
+    #     element is a connection URI String or a hash of
+    #     parameters. See details below.
     #
     # :min_threads::
     #     Minimum number of threads to keep in pool (default: 5)
@@ -54,11 +57,29 @@ module Fishwife
     #     request will be rejected with status 413. This limit is
     #     provided to avoid pathologic resource exhaustion. (default: 8 MiB)
     #
+    # === Options in connections
+    #
+    # Each member of the connections array is either a hash with
+    # the following properties or an equivalent URI string:
+    #
+    # :scheme:: Values 'tcp' or 'ssl'
+    # :host:: The local interface to bind
+    #         (default: top level #host or 0.0.0.0)
+    # :port:: Port number or 0 to select an available port
+    #         (default: top level #port for first connection or 0)
+    # :max_idle_time_ms:: See above
+    # :key_store_path:: For ssl, the path to the (Java JKS) keystore
+    # :key_store_password:: For ssl, the password to the keystore
+    #
+    # URI examples:
+    #
+    #  tcp://127.0.0.1
+    #  ssl://0.0.0.0:8443?key_store_path=keystore&key_store_password=399as8d9
+    #
     def initialize( options = {} )
       super()
 
       @server = nil
-      @host = nil
 
       self.min_threads = 5
       self.max_threads = 50
@@ -76,6 +97,9 @@ module Fishwife
       v = options[ :request_log_file ]
       options[ :request_log_file ] = v.to_sym if v == 'stderr'
 
+      v = options[ :connections ]
+      options[ :connections ] = v.split('|') if v.is_a?( String )
+
       # Split out servlet options.
       @servlet_options = {}
       [ :request_body_ram, :request_body_tmpdir, :request_body_max ].each do |k|
@@ -111,12 +135,5 @@ module Fishwife
     def stop
       @server.stop if @server
     end
-
-    def create_connectors( *args )
-      super.tap do |ctrs|
-        ctrs.first.host = @host if ctrs.first
-      end
-    end
-
   end
 end

data/pom.xml

@@ -4,7 +4,7 @@
   <groupId>fishwife</groupId>
   <artifactId>fishwife</artifactId>
   <packaging>jar</packaging>
-  <version>1.7.1</version>
+  <version>1.8.0</version>
   <name>Fishwife Java Extension</name>
 
   <properties>

data/spec/fishwife_spec.rb

@@ -23,203 +23,228 @@ require 'base64'
 require 'json'
 
 describe Fishwife do
-  def get(path, headers = {})
-    Net::HTTP.start(@options[:host], @options[:port]) do |http|
-      request = Net::HTTP::Get.new(path, headers)
-      http.request(request)
-    end
-  end
 
-  def post(path, params = nil, headers = {}, body = nil)
-    Net::HTTP.start(@options[:host], @options[:port]) do |http|
-      request = Net::HTTP::Post.new(path, headers)
-      request.form_data = params if params
-      if body
-        if body.respond_to?( :read )
-          request.body_stream = body
-        else
-          request.body = body
+  [:http, :https].each do |scheme|
+
+    describe "for #{scheme.to_s} scheme" do
+
+      def get(path, headers = {})
+        Net::HTTP.start(@options[:host], @options[:port],
+                        nil, nil, nil, nil, #Irrelevant http proxy parameters
+                        @https_client_opts) do |http|
+          request = Net::HTTP::Get.new(path, headers)
+          http.request(request)
         end
       end
-      http.request(request)
-    end
-  end
 
-  before(:all) do
-    @lock = Mutex.new
-    @app = Rack::Lint.new(TestApp.new)
-    @options = { :host => '127.0.0.1',
-                 :port => 9201,
-                 :request_body_ram => 256,
-                 :request_body_max => 96 * 1024,
-                 :request_body_tmpdir => File.dirname( __FILE__ ) }
-    Net::HTTP.version_1_2
-    @server = Fishwife::HttpServer.new(@options)
-    @server.start(@app)
-  end
+      def post(path, params = nil, headers = {}, body = nil)
+        Net::HTTP.start(@options[:host], @options[:port],
+                        nil, nil, nil, nil, #Irrelevant http proxy parameters
+                        @https_client_opts) do |http|
+          request = Net::HTTP::Post.new(path, headers)
+          request.form_data = params if params
+          if body
+            if body.respond_to?( :read )
+              request.body_stream = body
+            else
+              request.body = body
+            end
+          end
+          http.request(request)
+        end
+      end
 
-  after(:all) do
-    @server.stop
-    @server.join
-  end
+      before(:all) do
+        @scheme = scheme
+        @options = { :host => '127.0.0.1',
+                     :port => 9201,
+                     :request_body_ram => 256,
+                     :request_body_max => 96 * 1024,
+                     :request_body_tmpdir => File.dirname( __FILE__ ) }
+        @https_client_opts = {}
+        if @scheme == :https
+          @https_client_opts = {
+            :use_ssl => true,
+            :verify_mode => OpenSSL::SSL::VERIFY_NONE }
+          @options[:connections] = [ {
+            :scheme => 'ssl',
+            :key_store_path => 'spec/data/localhost.keystore',
+            :key_store_password => 'password' } ]
+        end
 
-  it "returns 200 OK" do
-    response = get("/ping")
-    response.code.should == "200"
-  end
+        @lock = Mutex.new
+        @app = Rack::Lint.new(TestApp.new)
+        Net::HTTP.version_1_2
+        @server = Fishwife::HttpServer.new(@options)
+        @server.start(@app)
+      end
 
-  it "returns 403 FORBIDDEN" do
-    response = get("/error/403")
-    response.code.should == "403"
-  end
+      after(:all) do
+        @server.stop
+        @server.join
+      end
 
-  it "returns 404 NOT FOUND" do
-    response = get("/jimmy/hoffa")
-    response.code.should == "404"
-  end
+      it "returns 200 OK" do
+        response = get("/ping")
+        response.code.should == "200"
+      end
 
-  it "sets Rack headers" do
-    response = get("/echo")
-    response.code.should == "200"
-    content = JSON.parse(response.body)
-    content["rack.multithread"].should be_true
-    content["rack.multiprocess"].should be_false
-    content["rack.run_once"].should be_false
-  end
+      it "returns 403 FORBIDDEN" do
+        response = get("/error/403")
+        response.code.should == "403"
+      end
 
-  it "passes form variables via GET" do
-    response = get("/echo?answer=42")
-    response.code.should == "200"
-    content = JSON.parse(response.body)
-    content['request.params']['answer'].should == '42'
-  end
+      it "returns 404 NOT FOUND" do
+        response = get("/jimmy/hoffa")
+        response.code.should == "404"
+      end
 
-  it "passes form variables via POST" do
-    question = "What is the answer to life, the universe, and everything?"
-    response = post("/echo", 'question' => question)
-    response.code.should == "200"
-    content = JSON.parse(response.body)
-    content['request.params']['question'].should == question
-  end
+      it "sets Rack headers" do
+        response = get("/echo")
+        response.code.should == "200"
+        content = JSON.parse(response.body)
+        content["rack.multithread"].should be_true
+        content["rack.multiprocess"].should be_false
+        content["rack.run_once"].should be_false
+      end
 
-  it "Passes along larger non-form POST body" do
-    body = '<' + "f" * (93*1024) + '>'
-    headers = { "Content-Type" => "text/plain" }
-    response = post("/dcount", nil, headers, body)
-    response.code.should == "200"
-    response.body.to_i.should == body.size * 2
-  end
+      it "passes form variables via GET" do
+        response = get("/echo?answer=42")
+        response.code.should == "200"
+        content = JSON.parse(response.body)
+        content['request.params']['answer'].should == '42'
+      end
 
-  it "Passes along larger non-form POST body when chunked" do
-    body = '<' + "f" * (93*1024) + '>'
-    headers = { "Content-Type" => "text/plain",
-                "Transfer-Encoding" => "chunked" }
-    response = post("/dcount", nil, headers, StringIO.new( body ) )
-    response.code.should == "200"
-    response.body.to_i.should == body.size * 2
- end
-
-  it "Rejects request body larger than maximum" do
-    body = '<' + "f" * (100*1024) + '>'
-    headers = { "Content-Type" => "text/plain" }
-    response = post("/count", nil, headers, body)
-    response.code.should == "413"
-  end
+      it "passes form variables via POST" do
+        question = "What is the answer to life, the universe, and everything?"
+        response = post("/echo", 'question' => question)
+        response.code.should == "200"
+        content = JSON.parse(response.body)
+        content['request.params']['question'].should == question
+      end
 
-  it "Rejects request body larger than maximum in chunked request" do
-    body = '<' + "f" * (100*1024) + '>'
-    headers = { "Content-Type" => "text/plain",
-                "Transfer-Encoding" => "chunked" }
-    response = post("/count", nil, headers, StringIO.new( body ) )
-    response.code.should == "413"
-  end
+      it "Passes along larger non-form POST body" do
+        body = '<' + "f" * (93*1024) + '>'
+        headers = { "Content-Type" => "text/plain" }
+        response = post("/dcount", nil, headers, body)
+        response.code.should == "200"
+        response.body.to_i.should == body.size * 2
+      end
 
-  it "passes custom headers" do
-    response = get("/echo", "X-My-Header" => "Pancakes")
-    response.code.should == "200"
-    content = JSON.parse(response.body)
-    content["HTTP_X_MY_HEADER"].should == "Pancakes"
-  end
+      it "Passes along larger non-form POST body when chunked" do
+        body = '<' + "f" * (93*1024) + '>'
+        headers = { "Content-Type" => "text/plain",
+                    "Transfer-Encoding" => "chunked" }
+        response = post("/dcount", nil, headers, StringIO.new( body ) )
+        response.code.should == "200"
+        response.body.to_i.should == body.size * 2
+     end
+
+      it "Rejects request body larger than maximum" do
+        body = '<' + "f" * (100*1024) + '>'
+        headers = { "Content-Type" => "text/plain" }
+        response = post("/count", nil, headers, body)
+        response.code.should == "413"
+      end
 
-  it "returns multiple values of the same header" do
-    response = get("/multi_headers")
-    response['Warning'].should == "warn-1, warn-2"
-    # Net::HTTP handle multiple headers with join( ", " )
-  end
+      it "Rejects request body larger than maximum in chunked request" do
+        body = '<' + "f" * (100*1024) + '>'
+        headers = { "Content-Type" => "text/plain",
+                    "Transfer-Encoding" => "chunked" }
+        response = post("/count", nil, headers, StringIO.new( body ) )
+        response.code.should == "413"
+      end
 
-  it "lets the Rack app know it's running as a servlet" do
-    response = get("/echo", 'answer' => '42')
-    response.code.should == "200"
-    content = JSON.parse(response.body)
-    content['rack.java.servlet'].should be_true
-  end
+      it "passes custom headers" do
+        response = get("/echo", "X-My-Header" => "Pancakes")
+        response.code.should == "200"
+        content = JSON.parse(response.body)
+        content["HTTP_X_MY_HEADER"].should == "Pancakes"
+      end
 
-  it "is clearly Jetty" do
-    response = get("/ping")
-    response['server'].should =~ /jetty/i
-  end
+      it "returns multiple values of the same header" do
+        response = get("/multi_headers")
+        response['Warning'].should == "warn-1, warn-2"
+        # Net::HTTP handle multiple headers with join( ", " )
+      end
 
-  it "sets the server port and hostname" do
-    response = get("/echo")
-    content = JSON.parse(response.body)
-    content["SERVER_PORT"].should == "9201"
-    content["SERVER_NAME"].should == "127.0.0.1"
-  end
+      it "lets the Rack app know it's running as a servlet" do
+        response = get("/echo", 'answer' => '42')
+        response.code.should == "200"
+        content = JSON.parse(response.body)
+        content['rack.java.servlet'].should be_true
+      end
 
-  it "passes the URI scheme" do
-    response = get("/echo")
-    content = JSON.parse(response.body)
-    content['rack.url_scheme'].should == 'http'
-  end
+      it "is clearly Jetty" do
+        response = get("/ping")
+        response['server'].should =~ /jetty/i
+      end
 
-  it "supports file downloads" do
-    response = get("/download")
-    response.code.should == "200"
-    response['Content-Type'].should == 'image/png'
-    checksum = Digest::MD5.hexdigest(response.body)
-    checksum.should == '8da4b60a9bbe205d4d3699985470627e'
-  end
+      it "sets the server port and hostname" do
+        response = get("/echo")
+        content = JSON.parse(response.body)
+        content["SERVER_PORT"].should == "9201"
+        content["SERVER_NAME"].should == "127.0.0.1"
+      end
 
-  it "supports file uploads" do
-    boundary = '349832898984244898448024464570528145'
-    content = []
-    content << "--#{boundary}"
-    content << 'Content-Disposition: form-data; name="file"; ' +
-      'filename="reddit-icon.png"'
-    content << 'Content-Type: image/png'
-    content << 'Content-Transfer-Encoding: base64'
-    content << ''
-    content <<
-      Base64.encode64( File.read('spec/data/reddit-icon.png') ).strip
-    content << "--#{boundary}--"
-    body = content.map { |l| l + "\r\n" }.join('')
-    headers = { "Content-Type" =>
-      "multipart/form-data; boundary=#{boundary}" }
-    response = post("/upload", nil, headers, body)
-    response.code.should == "200"
-    response.body.should == '8da4b60a9bbe205d4d3699985470627e'
-  end
+      it "passes the URI scheme" do
+        response = get("/echo")
+        content = JSON.parse(response.body)
+        content['rack.url_scheme'].should == @scheme.to_s
+      end
 
-  it "handles async requests" do
-    pending "Causes intermittent 30s pauses, TestApp.push/pull is sketchy"
-    lock = Mutex.new
-    buffer = Array.new
-
-    clients = 10.times.map do |index|
-      Thread.new do
-        Net::HTTP.start(@options[:host], @options[:port]) do |http|
-          response = http.get("/pull")
-          lock.synchronize {
-            buffer << "#{index}: #{response.body}" }
+      it "supports file downloads" do
+        response = get("/download")
+        response.code.should == "200"
+        response['Content-Type'].should == 'image/png'
+        checksum = Digest::MD5.hexdigest(response.body)
+        checksum.should == '8da4b60a9bbe205d4d3699985470627e'
+      end
+
+      it "supports file uploads" do
+        boundary = '349832898984244898448024464570528145'
+        content = []
+        content << "--#{boundary}"
+        content << 'Content-Disposition: form-data; name="file"; ' +
+          'filename="reddit-icon.png"'
+        content << 'Content-Type: image/png'
+        content << 'Content-Transfer-Encoding: base64'
+        content << ''
+        content <<
+          Base64.encode64( File.read('spec/data/reddit-icon.png') ).strip
+        content << "--#{boundary}--"
+        body = content.map { |l| l + "\r\n" }.join('')
+        headers = { "Content-Type" =>
+          "multipart/form-data; boundary=#{boundary}" }
+        response = post("/upload", nil, headers, body)
+        response.code.should == "200"
+        response.body.should == '8da4b60a9bbe205d4d3699985470627e'
+      end
+
+      it "handles async requests" do
+        pending "Causes intermittent 30s pauses, TestApp.push/pull is sketchy"
+        lock = Mutex.new
+        buffer = Array.new
+
+        clients = 10.times.map do |index|
+          Thread.new do
+            Net::HTTP.start(@options[:host], @options[:port]) do |http|
+              response = http.get("/pull")
+              lock.synchronize {
+                buffer << "#{index}: #{response.body}" }
+            end
+          end
         end
+
+        lock.synchronize { buffer.should be_empty }
+        post("/push", 'message' => "one")
+        clients.each { |c| c.join }
+        lock.synchronize { buffer.should_not be_empty }
+        lock.synchronize { buffer.count.should == 10 }
       end
+
     end
 
-    lock.synchronize { buffer.should be_empty }
-    post("/push", 'message' => "one")
-    clients.each { |c| c.join }
-    lock.synchronize { buffer.should_not be_empty }
-    lock.synchronize { buffer.count.should == 10 }
   end
 
 end

data/spec/spec_helper.rb

@@ -26,6 +26,7 @@ RJack::Logback.root.level = RJack::Logback::DEBUG if ENV['DEBUG_LOG']
 # All dependencies for testing.
 require 'yaml'
 require 'net/http'
+require 'openssl'
 require 'rack/urlmap'
 require 'rack/lint'
 require 'fishwife'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fishwife
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: java
 authors:
 - David Kellum
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -35,10 +35,10 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 9.1.3
+        version: 9.2.11
     - - <
       - !ruby/object:Gem::Version
-        version: '9.3'
+        version: '9.4'
   name: rjack-jetty
   prerelease: false
   type: :runtime
@@ -46,10 +46,10 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 9.1.3
+        version: 9.2.11
     - - <
       - !ruby/object:Gem::Version
-        version: '9.3'
+        version: '9.4'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -138,14 +138,16 @@ files:
 - bin/fishwife
 - example/config.ru
 - example/giant.ru
+- example/ssl.ru
 - lib/fishwife.rb
 - lib/fishwife/base.rb
-- lib/fishwife/fishwife-1.7.1.jar
+- lib/fishwife/fishwife-1.8.0.jar
 - lib/fishwife/http_server.rb
 - lib/fishwife/rack_servlet.rb
 - lib/rack/handler/fishwife.rb
 - pom.xml
 - spec/data/hello.txt
+- spec/data/localhost.keystore
 - spec/data/reddit-icon.png
 - spec/fishwife_spec.rb
 - spec/spec_helper.rb