/ 
Bot-ChatBots-0.014
River stage one • 4 direct dependents • 4 total dependents
/ Bot::ChatBots::Auth

NAME

Bot::ChatBots::Auth - Simple class for authorization

SYNOPSIS

use Bot::ChatBots::Auth;

my $auth_obj = Bot::ChatBots::Auth->new(

   # you can assign a name, used in log messages
   name => 'my authorization object',

   channels => {
      blacklist => {
         evil => 1, # whatever you set marks blacklisting
      },
      whitelist => {
         good => 1, # any value goes, only key is considered
      },
   },

   users => {
      blacklist => {
         fascist => 1,
      },
      whitelist => {
         nice => 1,
      },
   },

);

my $tube_compatible_sub = $auth_obj->processor;

DESCRIPTION

This class provides you a simple authorization mechanism for blocking or allowing records based on specific internal fields.

Two mechanisms are provided: blacklisting and whitelisting. These two mechanisms can be applied to either users identifiers or to channel identifiers.

Blacklists are hash references whose keys mark elements that are blocked. Whitelists are hash references whose keys mark elements that are allowed. Most probably you will just want to use only one of the two, because:

    *

    whatever is blacklisted is blocked, even if it is then whitelisted;

    *

    if you pass any whitelist (even an empty one), everything not contained in it as a key is automatically blocked.

It can make sense to use one mechanism with users and the other one with channels though.

This module logs the operation on the log channel (acquired via Log::Any) at the INFO level.

METHODS

This class composes role Bot::ChatBots::Role::Processor to expose its "processor" in Bot::ChatBots::Role::Processor. In addition, it also has the methods described in the following subsections.

channels

my $channels_hashref = $obj->channels;
$obj->channels(\%spec);

Accessor for setting black/white lists for channel identifiers.

name

my $name = $obj->name;
$obj->name('Foo Bar');

Accessor for the name, which appears in the logs.

new

my $auth = Bot::ChatBots::Auth->new(%args); # OR
   $auth = Bot::ChatBots::Auth->new(\%args);

Constructor. Accepted keys correspond to methods "channels", "name" and "users".

process

my @outcome = $objet->process($record);

Perform authorization on the provided input $record. The output @outcome will be empty if the authorization fails (due to blacklisting of whitelisting), otherwise it will contain $record. This is compatible with Data::Tubes.

The input $record will be analyzed for the following elements:

  • $record->{sender}{id} is checked against "users";

  • $record->{channel}{fqid} is checked against "channels". The key is assumed to hold the fully qualified identifier for the channel (e.g. in Telegram it might be the type of chat and the chat identifier, separated by a slash character).

The contents of those fields have to be filled in before this method is called, either by the specific protocol adapters or by a previous operation.

users

my $users_hashref = $obj->users;
$obj->users(\%spec);

Accessor for setting black/white lists for user (sender) identifiers.

SEE ALSO

Bot::ChatBots, Data::Tubes.

AUTHOR

Flavio Poletti <polettix@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2016 by Flavio Poletti <polettix@cpan.org>

This module is free software. You can redistribute it and/or modify it under the terms of the Artistic License 2.0.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.