Skip to content

michal-josef-spacek/Plack-App-Login-Request

Repository files navigation

NAME
    Plack::App::Login::Request - Plack application for request of login
    information.

SYNOPSIS
     use Plack::App::Login::Request;

     my $obj = Plack::App::Login::Request->new(%parameters);
     my $psgi_ar = $obj->call($env);
     my $app = $obj->to_app;

METHODS
  "new"
     my $obj = Plack::App::Login::Request->new(%parameters);

    Constructor.

    *       "author"

            Author string to HTML head.

            Default value is undef.

    *       "content_type"

            Content type for output.

            Default value is 'text/html; charset=__ENCODING__'.

    *       "css"

            Instance of CSS::Struct::Output object.

            Default value is CSS::Struct::Output::Raw instance.

    *       "css_init"

            Reference to array with CSS::Struct structure.

            Default value is CSS initialization from Tags::HTML::Page::Begin
            like

             * {
                    box-sizing: border-box;
                    margin: 0;
                    padding: 0;
             }

    *       "encoding"

            Set encoding for output.

            Default value is 'utf-8'.

    *       "favicon"

            Link to favicon.

            Default value is undef.

    *       "flag_begin"

            Flag that means begin of html writing via
            Tags::HTML::Page::Begin.

            Default value is 1.

    *       "flag_end"

            Flag that means end of html writing via Tags::HTML::Page::End.

            Default value is 1.

    *       "generator"

            HTML generator string.

            Default value is 'Plack::App::Login; Version: __VERSION__'.

    *       "lang"

            Language in ISO 639-2 code.

            Default value is undef.

    *       "psgi_app"

            PSGI application to run instead of normal process. Intent of
            this is change application in "_process_actions" method.

            Default value is undef.

    *       "script_js"

            Reference to array with Javascript code strings.

            Default value is [].

    *       "script_js_src"

            Reference to array with Javascript URLs.

            Default value is [].

    *       "status_code"

            HTTP status code.

            Default value is 200.

    *       "tags"

            Instance of Tags::Output object.

            Default value is

             Tags::Output::Raw->new(
                     'xml' => 1,
                     'no_simple' => ['script', 'textarea'],
                     'preserved' => ['pre', 'style'],
             );

    *       "text"

            Hash reference with keys defined language in ISO 639-2 code and
            value with hash reference with texts.

            Required keys are 'login_request', 'email_label' and 'submit'.

            See more in Tags::HTML::Login::Request.

            Default value is undef.

    *       "title"

            Page title.

            Default value is 'Login page'.

    Returns instance of object.

  "call"
     my $psgi_ar = $obj->call($env);

    Implementation of login request page.

    Returns reference to array (PSGI structure).

  "to_app"
     my $app = $obj->to_app;

    Creates Plack application.

    Returns Plack::Component object.

EXAMPLE
     use strict;
     use warnings;

     use CSS::Struct::Output::Indent;
     use Plack::App::Login::Request;
     use Data::Message::Simple;
     use Plack::Builder;
     use Plack::Runner;
     use Plack::Session;
     use Tags::Output::Indent;
     use Unicode::UTF8 qw(decode_utf8);

     my $message_cb = sub {
             my ($env, $message_type, $message) = @_;
             my $session = Plack::Session->new($env);
             my $m = Data::Message::Simple->new(
                     'text' => $message,
                     'type' => $message_type,
             );
             my $messages_ar = $session->get('messages');
             if (defined $messages_ar) {
                     push @{$messages_ar}, $m;
             } else {
                     $session->set('messages', [$m]);
             }
             return;
     };

     # Run application.
     my $app = Plack::App::Login::Request->new(
             'css' => CSS::Struct::Output::Indent->new,
             'generator' => 'Plack::App::Login::Request',
             'login_request_cb' => sub {
                     my ($env, $email) = @_;
                     if ($email eq 'skim@skim.cz') {
                             return 1;
                     } else {
                             return 0;
                     }
             },
             'message_cb' => $message_cb,
             'redirect_login' => '/',
             'redirect_error' => '/',
             'tags' => Tags::Output::Indent->new(
                     'preserved' => ['style'],
                     'xml' => 1,
             ),
     )->to_app;
     my $builder = Plack::Builder->new;
     $builder->add_middleware('Session');
     my $app_with_session = $builder->wrap($app);
     Plack::Runner->new->run($app_with_session);

     # Workflows:
     # 1) Blank request.
     # 2) Fill skim@skim.cz email and request.
     # 3) Fill another email and request.

     # Output:
     # HTTP::Server::PSGI: Accepting connections at http://0:5000/

     # > curl http://localhost:5000/
     # <!DOCTYPE html>
     # <html lang="en">
     #   <head>
     #     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     #     <meta name="generator" content="Plack::App::Login::Request" />
     #     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     #     <title>
     #       Login request page
     #     </title>
     #     <style type="text/css">
     # * {
     #      box-sizing: border-box;
     #      margin: 0;
     #      padding: 0;
     # }
     # .container {
     #      display: flex;
     #      align-items: center;
     #      justify-content: center;
     #      height: 100vh;
     # }
     # .form-request {
     #      width: 300px;
     #      background-color: #f2f2f2;
     #      padding: 20px;
     #      border-radius: 5px;
     #      box-shadow: 0 0 10px rgba(0, 0, 0, 0.2);
     # }
     # .form-request .logo {
     #      height: 5em;
     #      width: 100%;
     # }
     # .form-request img {
     #      margin: auto;
     #      display: block;
     #      max-width: 100%;
     #      max-height: 5em;
     # }
     # .form-request fieldset {
     #      border: none;
     #      padding: 0;
     #      margin-bottom: 20px;
     # }
     # .form-request legend {
     #      font-weight: bold;
     #      margin-bottom: 10px;
     # }
     # .form-request p {
     #      margin: 0;
     #      padding: 10px 0;
     # }
     # .form-request label {
     #      display: block;
     #      font-weight: bold;
     #      margin-bottom: 5px;
     # }
     # .form-request input[type="email"] {
     #      width: 100%;
     #      padding: 8px;
     #      border: 1px solid #ccc;
     #      border-radius: 3px;
     # }
     # .form-request button[type="submit"] {
     #      width: 100%;
     #      padding: 10px;
     #      background-color: #4CAF50;
     #      color: #fff;
     #      border: none;
     #      border-radius: 3px;
     #      cursor: pointer;
     # }
     # .form-request button[type="submit"]:hover {
     #      background-color: #45a049;
     # }
     # .form-request .messages {
     #      text-align: center;
     # }
     # .error {
     #      color: red;
     # }
     # .info {
     #      color: blue;
     # }
     # </style>
     #   </head>
     #   <body>
     #     <div class="container">
     #       <div class="inner">
     #         <form class="form-request" method="post">
     #           <fieldset>
     #             <legend>
     #               Login request
     #             </legend>
     #             <p>
     #               <label for="email" />
     #               Email
     #               <input type="email" name="email" id="email" autofocus="autofocus"
     #                 />
     #             </p>
     #             <p>
     #               <button type="submit" name="login_request" value="login_request">
     #                 Request
     #               </button>
     #             </p>
     #           </fieldset>
     #         </form>
     #       </div>
     #     </div>
     #   </body>
     # </html>

     # Output screenshot is in images/ directory.

DEPENDENCIES
    Plack::Component::Tags::HTM, Plack::Request, Plack::Response,
    Plack::Session, Plack::Util::Accessor, Tags::HTML::Container,
    Tags::HTML::Login::Request.

SEE ALSO
    Plack::App::Login
        Plack login application.

    Plack::App::Login::Password
        Plack login/password application.

    Plack::App::Register
        Plack register application.

REPOSITORY
    <https://github.com/michal-josef-spacek/Plack-App-Login-Request>

AUTHOR
    Michal Josef Špaček <mailto:skim@cpan.org>

    <http://skim.cz>

LICENSE AND COPYRIGHT
    © 2024 Michal Josef Špaček

    BSD 2-Clause License

VERSION
    0.04

About

Plack application for request of login information.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages