From 0784391a21b75ca52892e992a614b0f927ade00e Mon Sep 17 00:00:00 2001 From: Azul Date: Mon, 29 Aug 2016 11:59:54 +0200 Subject: refactor: split EmailHandler in 3 InvalidEmailHandler - handle emails with an invalid format LocalEmailHandler - handle emails on the local domain EmailHandler - handle all other emails by using hkp This is a preparation to add leap provider email lookup and remove hkp eventually. But for now we keep the behaviour the same and only refactor. --- lib/nickserver/dispatcher.rb | 4 ++ lib/nickserver/request_handlers/email_handler.rb | 40 ++---------- .../request_handlers/invalid_email_handler.rb | 15 +++++ .../request_handlers/local_email_handler.rb | 32 ++++++++++ test/integration/dispatcher_test.rb | 73 ++++++++++++++++++++++ test/unit/dispatcher_test.rb | 73 ---------------------- .../request_handlers/local_email_handler_test.rb | 65 +++++++++++++++++++ 7 files changed, 193 insertions(+), 109 deletions(-) create mode 100644 lib/nickserver/request_handlers/invalid_email_handler.rb create mode 100644 lib/nickserver/request_handlers/local_email_handler.rb create mode 100644 test/integration/dispatcher_test.rb delete mode 100644 test/unit/dispatcher_test.rb create mode 100644 test/unit/request_handlers/local_email_handler_test.rb diff --git a/lib/nickserver/dispatcher.rb b/lib/nickserver/dispatcher.rb index 833a2ad..8bcfd05 100644 --- a/lib/nickserver/dispatcher.rb +++ b/lib/nickserver/dispatcher.rb @@ -14,6 +14,8 @@ # require 'nickserver/request' +require 'nickserver/request_handlers/invalid_email_handler' +require 'nickserver/request_handlers/local_email_handler' require 'nickserver/request_handlers/email_handler' require 'nickserver/request_handlers/fingerprint_handler' @@ -45,6 +47,8 @@ module Nickserver def handler_chain [ + RequestHandlers::InvalidEmailHandler.new, + RequestHandlers::LocalEmailHandler.new, RequestHandlers::EmailHandler.new, RequestHandlers::FingerprintHandler.new, Proc.new { Nickserver::Response.new(404, "Not Found\n") } diff --git a/lib/nickserver/request_handlers/email_handler.rb b/lib/nickserver/request_handlers/email_handler.rb index b163b27..96fcaf3 100644 --- a/lib/nickserver/request_handlers/email_handler.rb +++ b/lib/nickserver/request_handlers/email_handler.rb @@ -1,7 +1,5 @@ require 'nickserver/email_address' -require 'nickserver/error_response' require 'nickserver/hkp/source' -require 'nickserver/couch_db/source' module Nickserver module RequestHandlers @@ -9,46 +7,16 @@ module Nickserver def call(request) return unless request.email - handle_request(request) - end - - protected - - def handle_request(request) email = EmailAddress.new(request.email) - if email.invalid? - ErrorResponse.new("Not a valid address") - else - send_key(email, request) - end - end - - def send_key(email, request) - if local_address?(email, request) - source = Nickserver::CouchDB::Source.new - else - source = Nickserver::Hkp::Source.new - end source.query(email) - rescue MissingHostHeader - ErrorResponse.new("HTTP request must include a Host header.") end - # - # Return true if the user address is for a user of this service provider. - # e.g. if the provider is example.org, then alice@example.org returns true. - # - # If 'domain' is not configured, we rely on the Host header of the HTTP request. - # - def local_address?(email, request) - domain = Config.domain || request.domain - raise MissingHostHeader if domain == '' - email.domain? domain - end - end + protected + def source + Nickserver::Hkp::Source.new + end - class MissingHostHeader < StandardError end end end diff --git a/lib/nickserver/request_handlers/invalid_email_handler.rb b/lib/nickserver/request_handlers/invalid_email_handler.rb new file mode 100644 index 0000000..eaf8156 --- /dev/null +++ b/lib/nickserver/request_handlers/invalid_email_handler.rb @@ -0,0 +1,15 @@ +require 'nickserver/email_address' +require 'nickserver/error_response' + +module Nickserver + module RequestHandlers + class InvalidEmailHandler + def call(request) + return unless request.email + email = EmailAddress.new(request.email) + ErrorResponse.new("Not a valid address") if email.invalid? + end + + end + end +end diff --git a/lib/nickserver/request_handlers/local_email_handler.rb b/lib/nickserver/request_handlers/local_email_handler.rb new file mode 100644 index 0000000..1f2abc2 --- /dev/null +++ b/lib/nickserver/request_handlers/local_email_handler.rb @@ -0,0 +1,32 @@ +require 'nickserver/email_address' +require 'nickserver/error_response' +require 'nickserver/couch_db/source' + +module Nickserver + module RequestHandlers + class LocalEmailHandler + + def call(request) + return nil unless request.email + domain = Config.domain || request.domain + return missing_domain_response if domain.nil? || domain == '' + email = EmailAddress.new(request.email) + return nil unless email.domain?(domain) + source.query email + end + + protected + + attr_reader :domain + + def source + Nickserver::CouchDB::Source.new + end + + def missing_domain_response + ErrorResponse.new "HTTP request must include a Host header." + end + + end + end +end diff --git a/test/integration/dispatcher_test.rb b/test/integration/dispatcher_test.rb new file mode 100644 index 0000000..60d252b --- /dev/null +++ b/test/integration/dispatcher_test.rb @@ -0,0 +1,73 @@ +require 'test_helper' +require 'nickserver/dispatcher' + +class Nickserver::DispatcherTest < Minitest::Test + + def test_empty_query + handle + assert_response status: 404, content: "404 Not Found\n" + end + + def test_invalid_query + handle address: ['asdf'] + assert_response status: 500, content: "500 Not a valid address\n" + end + + def test_missing_domain + handle address: ['valid@email.tld'] + assert_response status: 500, content: "500 HTTP request must include a Host header.\n" + end + + def test_email_from_hkp + handle address: ['valid@email.tld'], headers: { "Host" => "http://nickserver.me" } + source = Minitest::Mock.new + source.expect :query, Nickserver::Response.new(200, "fake content"), [Nickserver::EmailAddress] + Nickserver::Hkp::Source.stub :new, source do + assert_response status: 200, content: "200 fake content" + end + end + + def test_fingerprint_to_short + handle fingerprint: ['44F2F455E28'] + assert_response status: 500, content: "500 Fingerprint invalid: 44F2F455E28\n" + end + + def test_fingerprint_is_not_hex + handle fingerprint: ['X36E738D69173C13Z709E44F2F455E2824D18DDX'] + assert_response status: 500, + content: "500 Fingerprint invalid: X36E738D69173C13Z709E44F2F455E2824D18DDX\n" + end + + def test_get_key_with_fingerprint_from_hkp + handle fingerprint: ['E36E738D69173C13D709E44F2F455E2824D18DDF'] + source = Minitest::Mock.new + source.expect :get_key_by_fingerprint, + Nickserver::Response.new(200, "fake fingerprint"), + ['E36E738D69173C13D709E44F2F455E2824D18DDF'] + Nickserver::Hkp::Source.stub :new, source do + assert_response status: 200, content: "200 fake fingerprint" + end + end + + protected + + def handle(params = {}) + @headers = params.delete(:headers) || {} + @params = Hash[ params.map{ |k,v| [k.to_s, v] } ] + end + + def assert_response(args) + responder.expect :respond, nil, [args[:status], args[:content]] + dispatcher.respond_to @params, @headers + responder.verify + end + + def dispatcher + Nickserver::Dispatcher.new responder + end + + def responder + @responder ||= Minitest::Mock.new + end + +end diff --git a/test/unit/dispatcher_test.rb b/test/unit/dispatcher_test.rb deleted file mode 100644 index 60d252b..0000000 --- a/test/unit/dispatcher_test.rb +++ /dev/null @@ -1,73 +0,0 @@ -require 'test_helper' -require 'nickserver/dispatcher' - -class Nickserver::DispatcherTest < Minitest::Test - - def test_empty_query - handle - assert_response status: 404, content: "404 Not Found\n" - end - - def test_invalid_query - handle address: ['asdf'] - assert_response status: 500, content: "500 Not a valid address\n" - end - - def test_missing_domain - handle address: ['valid@email.tld'] - assert_response status: 500, content: "500 HTTP request must include a Host header.\n" - end - - def test_email_from_hkp - handle address: ['valid@email.tld'], headers: { "Host" => "http://nickserver.me" } - source = Minitest::Mock.new - source.expect :query, Nickserver::Response.new(200, "fake content"), [Nickserver::EmailAddress] - Nickserver::Hkp::Source.stub :new, source do - assert_response status: 200, content: "200 fake content" - end - end - - def test_fingerprint_to_short - handle fingerprint: ['44F2F455E28'] - assert_response status: 500, content: "500 Fingerprint invalid: 44F2F455E28\n" - end - - def test_fingerprint_is_not_hex - handle fingerprint: ['X36E738D69173C13Z709E44F2F455E2824D18DDX'] - assert_response status: 500, - content: "500 Fingerprint invalid: X36E738D69173C13Z709E44F2F455E2824D18DDX\n" - end - - def test_get_key_with_fingerprint_from_hkp - handle fingerprint: ['E36E738D69173C13D709E44F2F455E2824D18DDF'] - source = Minitest::Mock.new - source.expect :get_key_by_fingerprint, - Nickserver::Response.new(200, "fake fingerprint"), - ['E36E738D69173C13D709E44F2F455E2824D18DDF'] - Nickserver::Hkp::Source.stub :new, source do - assert_response status: 200, content: "200 fake fingerprint" - end - end - - protected - - def handle(params = {}) - @headers = params.delete(:headers) || {} - @params = Hash[ params.map{ |k,v| [k.to_s, v] } ] - end - - def assert_response(args) - responder.expect :respond, nil, [args[:status], args[:content]] - dispatcher.respond_to @params, @headers - responder.verify - end - - def dispatcher - Nickserver::Dispatcher.new responder - end - - def responder - @responder ||= Minitest::Mock.new - end - -end diff --git a/test/unit/request_handlers/local_email_handler_test.rb b/test/unit/request_handlers/local_email_handler_test.rb new file mode 100644 index 0000000..8f303ec --- /dev/null +++ b/test/unit/request_handlers/local_email_handler_test.rb @@ -0,0 +1,65 @@ +require 'test_helper' +require 'nickserver/request_handlers/local_email_handler' + +class LocalEmailHandlerTest < MiniTest::Test + + def test_no_email + assert_refuses + end + + def test_remote_email + assert_refuses email: 'me@remote.tld', domain: 'local.tld' + end + + def test_local_email + assert_handles email: 'me@local.tld', domain: 'local.tld' + end + + def test_missing_host_header + Nickserver::Config.stub :domain, nil do + assert_responds_with_error "HTTP request must include a Host header.", + email: 'me@local.tld' + end + end + + protected + + def handler + Nickserver::RequestHandlers::LocalEmailHandler.new + end + + def source + source = Minitest::Mock.new + source.expect :query, + 'response', + [Nickserver::EmailAddress] + source + end + + def assert_handles(opts) + Nickserver::CouchDB::Source.stub :new, source do + assert_equal 'response', handle(request(opts)) + end + end + + def assert_responds_with_error(msg, opts) + response = handle(request(opts)) + assert_equal 500, response.status + assert_equal "500 #{msg}\n", response.content + end + + def assert_refuses(opts = {}) + assert_nil handle(request(opts)) + end + + def handle(request) + handler.call(request) + end + + def request(opts = {}) + params = {'address' => [opts[:email]]} + headers = {'Host' => opts[:domain]} + Nickserver::Request.new params, headers + end + +end -- cgit v1.2.3