intranet-core 1.2.0 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b297a91ba8ca9fc6a44723c4f9f738d879193828
-  data.tar.gz: bc44f0b1858f045978da8d39824ad36a0a52c485
+SHA256:
+  metadata.gz: e1d7d91fa0a962e4835681a46f50c7e49b5aaa77327ab112d2999aa90b26a312
+  data.tar.gz: 3c67a863896c42b5b83de33863e372678bae92ee831c05f91a6484343ecff88e
 SHA512:
-  metadata.gz: a5094ed435333e80537e85603359276059b345554ae185cdb6c56e9d843ca385b31fc1e1e008e329114c3f5584e509d89087dab4e3e24423a2fbb35f0081457b
-  data.tar.gz: e06fea82c25af97e56230a51df3f4b4f9447fd2218d9ca7b28b0663f83d43d3713cda474aab06c15c45a5860680d02edf5adf95742ee552331e19755e01a19ad
+  metadata.gz: 2df2d7de87df4c1a267c6fa39f3188ec8231b265c7206351bcde3a1203ad4c4c5d6b163a747888f1967e783c8fd1e1d0a1bbf5d081bd8d5f864eee83ae67ef03
+  data.tar.gz: 0ca99259824749ffe9f08c3c8c32a0faa7b7f6afaa063c5e45072fe883355ed684beb35af5ab878f94ff2a037ca391bb9a4a05c918ec3e31ea9e817b716531b7

data/lib/intranet/abstract_responder.rb

@@ -22,6 +22,15 @@ module Intranet
       true
     end
 
+    # Specifies the absolute path to the resources directory for that module. This directory should
+    # contain three subdirectories: +haml/+, +locales/+ and +www/+.
+    # This method should be redefined to overwrite this default value with the actual resources
+    # directory path.
+    # @return [String] The absolute path to the resources directory for the module.
+    def resources_dir
+      File.join(__dir__, 'resources')
+    end
+
     # Destroys the responder instance.
     # This method gets called when server is shut down.
     def finalize
@@ -36,16 +45,20 @@ module Intranet
       [404, '', '']
     end
 
-    # Provides the list of Cascade Style Sheets (CSS) dependencies for this module.
+    # Provides the list of Cascade Style Sheets (CSS) dependencies for this module, either using
+    # absolute or relative (from the module root) paths.
     # If redefined, this method should probably append dependencies rather than overwriting them.
-    # @return [Array] The list of CSS dependencies, as URL path from server root
+    # @return [Array] The list of CSS dependencies, as absolute path or relative to the module root
+    #                 URL.
     def css_dependencies
       ['/design/style.css']
     end
 
-    # Provides the list of Javascript files (JS) dependencies for this module.
+    # Provides the list of Javascript files (JS) dependencies for this module, either using
+    # absolute or relative (from the module root) paths.
     # If redefined, this method should probably append dependencies rather than overwriting them.
-    # @return [Array] The list of JS dependencies, as URL path from server root
+    # @return [Array] The list of JS dependencies, as absolute path or relative to the module root
+    #                 URL.
     def js_dependencies
       ['/design/nav.js']
     end

data/lib/intranet/core.rb

@@ -40,22 +40,19 @@ module Intranet
       mount_default_servlets(www_dir)
     end
 
-    # Registers a new module to the core. The server must not be running. If +path+ is empty, the
-    # module will be used as Home module. Otherwise, the module will be accessible through the
-    # given +path+ under the web server root.
+    # Registers a new module to the core. The server must not be running. The module will then be
+    # accessible through the given +path+ under the web server root.
     # @param responder [Intranet::AbstractResponder] The module responder instance.
     # @param path [Array] The path, relative to the web server root, representing the module root
-    #                     directory. If empty, the responder will be registered as Home responder
-    #                     (to serve /index.html in particular). Subdirectories are allowed using
-    #                     an array element for each directory level. Each element must only contain
-    #                     the following characters: +-_a-z0-9+.
+    #                     directory. The path cannot be empty and have more than 2 elements. Each
+    #                     element must only contain the following characters: +-_a-z0-9+.
     # @param resources_dir [String] The path to the directory that contains additional resources
     #                               required by the module. This directory should contain three
-    #                               subdirectories: +haml/+, +locales/+ and +www/+.
-    # @raise [ArgumentError] If one of the element of the +path+ contains invalid characters.
+    #                               subdirectories: +haml/+, +locales/+ and +www/+. The +www/+ is
+    #                               mounted under +<path>/design+ on the web server.
+    # @raise [ArgumentError] If the +path+ is not valid.
     # @raise [Errno::EALREADY] If the server is already running.
-    def register_module(responder, path, resources_dir)
-      raise ArgumentError unless path.all?(&:urlized?)
+    def register_module(responder, path, resources_dir = responder.resources_dir)
       raise Errno::EALREADY if @server.status != :Stop
 
       @builder.register(responder, path)
@@ -64,6 +61,13 @@ module Intranet
       module_add_haml_templates(resources_dir)
     end
 
+    # Defines the URL of the home page.
+    # @param url [String] The absolute URL of the home page.
+    # @raise [ArgumentError] If the URL is not an absolute path.
+    def home_url=(url)
+      @builder.home_url = url
+    end
+
     # Starts the web server.
     def start
       @logger.info('Intranet::Core: using locale \'' + I18n.default_locale.to_s + '\'')
@@ -76,6 +80,8 @@ module Intranet
     def stop
       @logger.info('Intranet::Runner: requesting system shutdown...')
       @server.shutdown
+      while @server.status != :Stop
+      end
       @builder.finalize
       @logger.close
     end
@@ -109,7 +115,7 @@ module Intranet
     end
 
     def module_add_servlet(path, resources_dir)
-      @server.mount('/design/' + path.join('/'),
+      @server.mount('/' + path.join('/') + '/design',
                     WEBrick::HTTPServlet::FileHandler,
                     File.join(resources_dir, 'www'))
     end

data/lib/intranet/core/builder.rb

@@ -20,12 +20,17 @@ module Intranet
       # @return [Hash]
       attr_reader :modules
 
+      # The Home page URL
+      # @return [String]
+      attr_reader :home_url
+
       # Initializes a new builder.
       # @param logger [Object] The logger.
       def initialize(logger)
         @logger = logger
         @responders = CoreExtensions::Tree.new
         @modules = { NAME => { version: VERSION, homepage: HOMEPAGE_URL } }
+        @home_url = '/index.html'
       end
 
       # Finalizes the builder. Each registered responder is called for +finalize+.
@@ -47,13 +52,13 @@ module Intranet
       # @param query [Hash] The content of the GET parameters of the URL.
       # @return [Array] The HTTP return code, the MIME type and the answer body.
       def do_get(path, query = {})
-        responder, responder_path = get_responder(path)
-        status, mime_type, body = responder.generate_page(responder_path, query)
+        responder, parsed_path, unparsed_path = get_responder(path)
+        status, mime_type, body = responder.generate_page(unparsed_path, query)
 
         # Generate header and footer when partial content is returned by the responder
         if status == 206 && mime_type == 'text/html'
           body = to_markup('skeleton', body: body, css: responder.css_dependencies,
-                                       js: responder.js_dependencies)
+                                       js: responder.js_dependencies, current_path: parsed_path)
           status = 200
         end
         [status, mime_type, body]
@@ -65,35 +70,54 @@ module Intranet
       # one overrides the old one.
       # @param responder [Intranet::AbstractResponder] The responder instance of the module.
       # @param path [Array] The path, relative to the web server root, representing the module root
-      #                     directory. If empty, the responder will be registered as Home responder
-      #                     (to serve /index.html in particular). Subdirectories are allowed using
-      #                     an array element for each directory level.
+      #                     directory.
       # @raise [ArgumentError] If the +responder+ is not a valid responder instance.
-      # @raise [ArgumentError] If one of the element of the +path+ contains invalid characters.
+      # @raise [ArgumentError] If the +path+ is invalid.
       def register(responder, path = [])
         raise ArgumentError unless responder.class.superclass.to_s == 'Intranet::AbstractResponder'
-        raise ArgumentError unless path.all?(&:urlized?)
+        raise ArgumentError unless valid_path?(path)
 
         insert_responder(responder, path)
         store_module_metadata(responder)
       end
 
+      # Defines the URL of the home page.
+      # @param url [String] The absolute URL of the home page.
+      # @raise [ArgumentError] If the URL is not an absolute path.
+      def home_url=(url)
+        raise ArgumentError unless url.start_with?('/')
+
+        @home_url = url
+      end
+
       private
 
       # Get the responder instance associated with the given path.
       # @param path [String] The absolute URL path.
-      # @return [Array] The responder instance (possibly nil) and the remaining of the URL path that
-      #                 has not been parsed.
+      # @return [Intranet::AbstractResponder, String, String] The responder instance (possibly nil)
+      #                                                       the parsed part of the path, and the
+      #                                                       unparsed part of the path.
       def get_responder(path)
+        parsed_path = []
         current_treenode = @responders
-        relative_path = path[1..-1].split('/').delete_if do |part|
+        unparsed_path = path[1..-1].split('/').delete_if do |part|
           if current_treenode.child_exists?(part)
             current_treenode = current_treenode.child_node(part)
+            parsed_path << part
             true
           end
         end
 
-        [current_treenode.value, '/' + relative_path.join('/')]
+        [current_treenode.value, '/' + parsed_path.join('/'), '/' + unparsed_path.join('/')]
+      end
+
+      # Check whether a path is valid.
+      # @param path [Array] The path to test.
+      # @return [Boolean] True if the path is valid, False otherwise.
+      def valid_path?(path)
+        (path.size == 1 || path.size == 2) && path.none?(&:empty?) && path.all?(&:urlized?)
+      rescue NoMethodError
+        false
       end
 
       # Inserts a responder instance in the appropriate Tree node according the given +path+.

data/lib/intranet/core/servlet.rb

@@ -24,12 +24,14 @@ module Intranet
       def do_GET(request, response) # rubocop:disable Naming/MethodName
         # See https://github.com/nahi/webrick/blob/master/lib/webrick/httprequest.rb
         # We could use request.request_uri (which is a URI object) but its path is not normalized
-        # (it may contain '../' or event start with '..'). Hence we use request.past which has been
+        # (it may contain '../' or event start with '..'). Hence we use request.path which has been
         # normalized with HTTPUtils::normalize_path, and request.query for the URL parameters.
-        path = request.path
-        path += 'index.html' if path[-1] == '/' # path is normalized (ie. does not contain '../')
+        path = request.path.force_encoding('UTF-8')
+        path += 'index.html' if path.end_with?('/')
 
-        status, content_type, body = @builder.do_get(path, request.query)
+        handle_redirections(request, path, response, '/index.html' => @builder.home_url)
+
+        status, content_type, body = @builder.do_get(path, encode_query(request.query))
 
         raise WEBrick::HTTPStatus[status] if WEBrick::HTTPStatus.error?(status)
 
@@ -37,6 +39,25 @@ module Intranet
         response.content_type = content_type
         response.body = body
       end
+
+      private
+
+      # Issues an HTTP redirection (307) in +response+ if the +path+ associated to the +request+
+      # has an entry if the redirection table +redirects+.
+      def handle_redirections(request, path, response, redirects)
+        target = redirects.fetch(path)
+        location = URI.join(request.request_uri, target).to_s
+        response.set_redirect(WEBrick::HTTPStatus[307], location) if path != target
+      rescue KeyError
+        # nothing to do
+      end
+
+      # Reencodes the +query+ in UTF-8 strings for compatibility.
+      def encode_query(query)
+        query.map do |k, v|
+          { k.dup.force_encoding('UTF-8') => v.force_encoding('UTF-8') }
+        end.reduce({}, :merge)
+      end
     end
   end
 end

data/lib/intranet/core/version.rb

@@ -6,7 +6,7 @@ module Intranet
     NAME = 'intranet-core'
 
     # The version of the gem, according to semantic versionning.
-    VERSION = '1.2.0'
+    VERSION = '2.1.4'
 
     # The URL of the gem homepage.
     HOMEPAGE_URL = 'https://rubygems.org/gems/intranet-core'

data/lib/intranet/resources/haml/skeleton.haml

@@ -5,9 +5,15 @@
     %meta{charset: 'utf-8'}
     %link{rel: 'icon', type: 'image/x-icon', href: '/design/favicon.ico'}
     - css.each do |url|
-      %link{rel: 'stylesheet', type: 'text/css', href: url}
+      - if url.start_with?('/')
+        %link{rel: 'stylesheet', type: 'text/css', href: url}
+      - else
+        %link{rel: 'stylesheet', type: 'text/css', href: current_path + '/' + url}
     - js.each do |url|
-      %script{src: url, defer: 'defer'}
+      - if url.start_with?('/')
+        %script{src: url, defer: 'defer'}
+      - else
+        %script{src: current_path + '/' + url, defer: 'defer'}
   %body
     %header
       %a{id: 'openmenu', onclick: 'openNavMenu();'}= '☰'

data/lib/intranet/resources/www/nav.js

@@ -10,7 +10,8 @@ function openNavMenu() {
 }
 
 function closeNavMenu() {
-  document.querySelectorAll('header nav')[0].style.width = '0';
+  /* Remove value property set in openNavMenu() */
+  document.querySelectorAll('header nav')[0].style.width = '';
 }
 
 function openModal() {

data/lib/intranet/resources/www/style.css

@@ -45,7 +45,6 @@ header {
     top: 0px;
     width: 100%;
     margin: auto;
-    height: 57px;
     background-color: #1e262b;
     color: white;
     z-index: 2;

data/spec/intranet/core_spec.rb

@@ -82,18 +82,21 @@ RSpec.describe Intranet::Core do
         end
       end
     end
+  end
 
+  describe '#register_module' do
     context 'registering a module when the server is running' do
       it 'should fail' do
         begin
           @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
+          r = Intranet::TestResponder.new('/index.html' => [200, 'text/html', ''])
           thread = Thread.new do
             @intranet.start
           end
           while @intranet.instance_variable_get(:@server).status != :Running
           end
 
-          expect { @intranet.register_module(nil, [], '') }.to raise_error Errno::EALREADY
+          expect { @intranet.register_module(r, ['path'], '') }.to raise_error Errno::EALREADY
         ensure
           Thread.kill(thread)
           thread.join
@@ -104,119 +107,82 @@ RSpec.describe Intranet::Core do
     context 'registering a module with an invalid path' do
       it 'should fail' do
         @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
-        expect { @intranet.register_module(nil, ['Invalid'], '') }.to raise_error ArgumentError
+        r = Intranet::TestResponder.new('/index.html' => [200, 'text/html', ''])
+        expect { @intranet.register_module(r, [], '') }.to raise_error ArgumentError
+        expect { @intranet.register_module(r, %w[1 2 3], '') }.to raise_error ArgumentError
+        expect { @intranet.register_module(r, ['', 'valid'], '') }.to raise_error ArgumentError
+        expect { @intranet.register_module(r, ['Invalid'], '') }.to raise_error ArgumentError
+        expect { @intranet.register_module(r, 'fo', '') }.to raise_error ArgumentError
       end
     end
 
     context 'registering an invalid module' do
       it 'should fail' do
         @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
-        expect { @intranet.register_module(nil, [], '') }.to raise_error ArgumentError
+        expect { @intranet.register_module(nil, ['path'], '') }.to raise_error ArgumentError
       end
     end
 
-    context 'when a valid module is registered with no path (home module)' do
-      it 'should be used to serve all URI' do
-        begin
-          @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
-          responder = Intranet::TestResponder.new('/index.html' => [200, 'text/html', ''],
-                                                  '/folder/index.html' => [200, 'text/html', ''])
-          @intranet.register_module(responder, [], responder.resources_dir)
-          thread = Thread.new do
-            @intranet.start
-          end
-          while @intranet.instance_variable_get(:@server).status != :Running
-          end
-
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /index.html HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-          socket.close
-
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /folder/index.html HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-          socket.close
-
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /folder/subdir/index.html HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 404 Not Found')
-          socket.close
-
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /design/home/style.css HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-        ensure
-          socket.close
-          Thread.kill(thread)
-          thread.join
+    context 'when a valid module is registered' do
+      before(:each) do
+        @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
+        responder = Intranet::TestResponder.new('/index.html' => [200, 'text/html', ''])
+        # Third argument of register_module() is optional, so we test both cases.
+        @intranet.register_module(responder, %w[responder], responder.resources_dir)
+        @intranet.register_module(responder, %w[resp onder])
+        @thread = Thread.new do
+          @intranet.start
+        end
+        while @intranet.instance_variable_get(:@server).status != :Running
         end
       end
-    end
 
-    context 'when a valid module is registered with a path' do
+      after(:each) do
+        Thread.kill(@thread)
+        @thread.join
+      end
+
       it 'should be used to serve URI relative to the module root' do
-        begin
-          @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
-          responder = Intranet::TestResponder.new('/index.html' => [200, 'text/html', ''])
-          @intranet.register_module(responder, [], responder.resources_dir)
-          @intranet.register_module(responder, %w[responder], responder.resources_dir)
-          @intranet.register_module(responder, %w[resp onder], responder.resources_dir)
-          thread = Thread.new do
-            @intranet.start
-          end
-          while @intranet.instance_variable_get(:@server).status != :Running
-          end
+        socket = TCPSocket.new('localhost', @intranet.port)
+        socket.puts("GET /responder/index.html HTTP/1.1\r\n" \
+                    "Host: localhost:#{@intranet.port}\r\n\r\n")
+        expect(socket.gets).to include('HTTP/1.1 200 OK')
+        socket.close
 
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /index.html HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-          socket.close
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /design/home/style.css HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-          socket.close
+        socket = TCPSocket.new('localhost', @intranet.port)
+        socket.puts("GET /resp/onder/index.html HTTP/1.1\r\n" \
+                    "Host: localhost:#{@intranet.port}\r\n\r\n")
+        expect(socket.gets).to include('HTTP/1.1 200 OK')
+        socket.close
 
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /responder/index.html HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-          socket.close
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /design/responder/style.css HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-          socket.close
+        socket = TCPSocket.new('localhost', @intranet.port)
+        socket.puts("GET /resp/onder/index2.html HTTP/1.1\r\n" \
+                    "Host: localhost:#{@intranet.port}\r\n\r\n")
+        expect(socket.gets).to include('HTTP/1.1 404 Not Found')
+        socket.close
+      end
 
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /resp/onder/index.html HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-          socket.close
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /design/resp/onder/style.css HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-        ensure
-          socket.close
-          Thread.kill(thread)
-          thread.join
-        end
+      it 'should have its www/ directory available under the subfolder design/' do
+        socket = TCPSocket.new('localhost', @intranet.port)
+        socket.puts("GET /responder/design/style.css HTTP/1.1\r\n" \
+                    "Host: localhost:#{@intranet.port}\r\n\r\n")
+        expect(socket.gets).to include('HTTP/1.1 200 OK')
+        socket.close
+
+        socket = TCPSocket.new('localhost', @intranet.port)
+        socket.puts("GET /resp/onder/design/style.css HTTP/1.1\r\n" \
+                    "Host: localhost:#{@intranet.port}\r\n\r\n")
+        expect(socket.gets).to include('HTTP/1.1 200 OK')
+        socket.close
       end
     end
 
     context 'given a valid and registered module' do
-      it 'should be called with the URL path and query' do
+      it 'should be called with the decoded URL path and query in UTF-8 encoding' do
         begin
           @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
           responder = Intranet::TestResponder.new('/index.html' => [200, 'text/html', ''])
-          @intranet.register_module(responder, [], responder.resources_dir)
+          @intranet.register_module(responder, ['responder'], responder.resources_dir)
           thread = Thread.new do
             @intranet.start
           end
@@ -224,25 +190,17 @@ RSpec.describe Intranet::Core do
           end
 
           socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /query?var1=value1&var2=value2 HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 200 OK')
-          while (line = socket.gets.chomp) # consume HTTP response headers
-            break if line.empty?
-          end
-          line = socket.gets.chomp
-          expect(line).to eql({ 'var1' => 'value1', 'var2' => 'value2' }.to_s)
-          socket.close
-
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /query?foo=bar&baz=boz HTTP/1.1\r\n" \
+          socket.puts("GET /responder/query%20t?var1=value1&var2=value2 HTTP/1.1\r\n" \
                       "Host: localhost:#{@intranet.port}\r\n\r\n")
           expect(socket.gets).to include('HTTP/1.1 200 OK')
           while (line = socket.gets.chomp) # consume HTTP response headers
             break if line.empty?
           end
           line = socket.gets.chomp
-          expect(line).to eql({ 'foo' => 'bar', 'baz' => 'boz' }.to_s)
+          expect(line).to eql(
+            'PATH=/query t (UTF-8), ' \
+            'QUERY={var1 (UTF-8) => value1 (UTF-8),var2 (UTF-8) => value2 (UTF-8)}'
+          )
         ensure
           socket.close
           Thread.kill(thread)
@@ -262,7 +220,7 @@ RSpec.describe Intranet::Core do
             ['/responder.css', 'nav.css'],
             ['module.js', '/js/interactive.js']
           )
-          @intranet.register_module(responder, [], responder.resources_dir)
+          @intranet.register_module(responder, ['r'], responder.resources_dir)
           thread = Thread.new do
             @intranet.start
           end
@@ -270,7 +228,7 @@ RSpec.describe Intranet::Core do
           end
 
           socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /index.html HTTP/1.1\r\nHost: localhost:#{@intranet.port}\r\n\r\n")
+          socket.puts("GET /r/index.html HTTP/1.1\r\nHost: localhost:#{@intranet.port}\r\n\r\n")
 
           # Return code: HTTP error 200
           expect(socket.gets).to include('HTTP/1.1 200 OK')
@@ -290,17 +248,17 @@ RSpec.describe Intranet::Core do
           expect(html).to match(%r{<body>.*<h1>.*#{hostname.capitalize}.*</h1>.*</body>}m)
           expect(html).to match(%r{<footer>.*#{hostname}.*</footer>}m)
 
-          # Returned HTML document: includes all CSS dependencies
+          # Returned HTML document: includes all CSS dependencies, relative or absolute path
           expect(html).to match(%r{<link href='/responder.css' rel='stylesheet' type='text/css'})
-          expect(html).to match(%r{<link href='nav.css' rel='stylesheet' type='text/css'})
+          expect(html).to match(%r{<link href='/r/nav.css' rel='stylesheet' type='text/css'})
 
           # Returned HTML document: includes all JS dependencies
-          expect(html).to match(%r{<script defer='defer' src='module.js'></script>})
+          expect(html).to match(%r{<script defer='defer' src='/r/module.js'></script>})
           expect(html).to match(%r{<script defer='defer' src='/js/interactive.js'></script>})
 
           # Returned HTML document: includes Intranet Core name, version and URL
           expect(html).to match(
-            %r{<footer>.*<a href='#{Intranet::Core::HOMEPAGE_URL}'.*>#{Intranet::Core::NAME}</a>.*#{Intranet::Core::VERSION}.*</footer>}m # rubocop:disable Metrics/LineLength
+            %r{<footer>.*<a href='#{Intranet::Core::HOMEPAGE_URL}'.*>#{Intranet::Core::NAME}</a>.*#{Intranet::Core::VERSION}.*</footer>}m # rubocop:disable Layout/LineLength
           )
 
           # Returned HTML document: includes all registered modules version name, version and URL
@@ -320,7 +278,7 @@ RSpec.describe Intranet::Core do
             '/index.html' => [206, 'text/html', { content: 'PARTIAL_CONTENT', title: 'MyTitle' }]
           )
           other_responder = Intranet::TestResponder.new({}, [], [], true)
-          @intranet.register_module(responder, [], responder.resources_dir)
+          @intranet.register_module(responder, %w[r], responder.resources_dir)
           @intranet.register_module(responder, %w[dep_th1], responder.resources_dir)
           @intranet.register_module(responder, %w[depth2 res_p1], responder.resources_dir)
           @intranet.register_module(responder, %w[depth2 resp2], responder.resources_dir)
@@ -335,7 +293,7 @@ RSpec.describe Intranet::Core do
           end
 
           socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /index.html HTTP/1.1\r\nHost: localhost:#{@intranet.port}\r\n\r\n")
+          socket.puts("GET /r/index.html HTTP/1.1\r\nHost: localhost:#{@intranet.port}\r\n\r\n")
 
           # Return code: HTTP error 200
           expect(socket.gets).to include('HTTP/1.1 200 OK')
@@ -367,12 +325,47 @@ RSpec.describe Intranet::Core do
     end
   end
 
+  describe '#home_url=' do
+    context 'given a relative URL' do
+      it 'should fail' do
+        @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
+        expect { @intranet.home_url = 'foo/index.html' }.to raise_error ArgumentError
+      end
+    end
+
+    context 'given an absolute URL' do
+      it 'should set up a redirection from /index.html to the provided URL' do
+        begin
+          @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
+          @intranet.home_url = '/responder/index.html'
+          thread = Thread.new do
+            @intranet.start
+          end
+          while @intranet.instance_variable_get(:@server).status != :Running
+          end
+
+          socket = TCPSocket.new('localhost', @intranet.port)
+          socket.puts("GET /index.html HTTP/1.1\r\nHost: localhost:#{@intranet.port}\r\n\r\n")
+          expect(socket.gets).to include('HTTP/1.1 307 Temporary Redirect')
+          while (line = socket.gets.chomp) # search the HTTP response for the 'Location' header
+            break if line.start_with?('Location:')
+          end
+          expect(line).to include("http://localhost:#{@intranet.port}/responder/index.html")
+        ensure
+          socket.close
+          Thread.kill(thread)
+          thread.join
+        end
+      end
+    end
+  end
+
   describe '#stop' do
     it 'should stop the web server and finalize all registered responders' do
       begin
         @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
         responder = Intranet::TestResponder.new('/index.html' => [200, 'text/html', 'CONTENT'])
-        @intranet.register_module(responder, [], responder.resources_dir)
+        @intranet.register_module(responder, %w[r], responder.resources_dir)
         thread = Thread.new do
           @intranet.start
         end
@@ -380,7 +373,7 @@ RSpec.describe Intranet::Core do
         end
 
         socket = TCPSocket.new('localhost', @intranet.port)
-        socket.puts("GET /index.html HTTP/1.1\r\nHost: localhost:#{@intranet.port}\r\n\r\n")
+        socket.puts("GET /r/index.html HTTP/1.1\r\nHost: localhost:#{@intranet.port}\r\n\r\n")
         expect(socket.gets).to include('HTTP/1.1 200 OK')
         expect(responder.finalized).to be false
         socket.close

data/spec/test_responder/responder.rb

@@ -38,12 +38,12 @@ module Intranet
     end
 
     def resources_dir
-      __dir__
+      super
     end
 
     def generate_page(path, query)
-      if path == '/query'
-        [200, 'text/plain', query.to_s + "\r\n"]
+      if path.start_with?('/query')
+        [200, 'text/plain', dump_with_encoding(path, query)]
       else
         @responses.fetch(path)
       end
@@ -58,5 +58,13 @@ module Intranet
     def js_dependencies
       super + @extra_js
     end
+
+    private
+
+    def dump_with_encoding(path, query)
+      "PATH=#{path} (#{path.encoding}), QUERY={" +
+        query.map { |k, v| "#{k} (#{k.encoding}) => #{v} (#{v.encoding})" }.join(',') +
+        "}\r\n"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intranet-core
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.4
 platform: ruby
 authors:
 - Ebling Mis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -189,7 +189,6 @@ files:
 - spec/intranet/logger_spec.rb
 - spec/spec_helper.rb
 - spec/test_responder/responder.rb
-- spec/test_responder/www/style.css
 homepage: https://rubygems.org/gems/intranet-core
 licenses:
 - MIT
@@ -211,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Core component to build a custom intranet.

data/spec/test_responder/www/style.css

@@ -1,5 +0,0 @@
-/**
- * test_responder/www/style.css
- * Design for the Test Responder of the Intranet-Core.
- */
-