File Coverage

blib/lib/Labyrinth/Plugin/Survey/API.pm

Criterion	Covered	Total	%
statement	15	15	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod			n/a
total	20	20	100.0

package Labyrinth::Plugin::Survey::API;

use warnings;
use strict;
use utf8;

use vars qw($VERSION);
$VERSION = '0.08';

=head1 NAME

Labyrinth::Plugin::Survey::API - YAPC Surveys' API plugin via Labyrinth framework

=head1 DESCRIPTION

Provides all the interfaces needed by external event instances to access data
from the current YAPC Surveys.

=cut

# -------------------------------------
# Library Modules

use base qw(Labyrinth::Plugin::Base);

use Labyrinth::Audit;
use Labyrinth::DBUtils;
use Labyrinth::Support;
use Labyrinth::Users;
use Labyrinth::Variables;

#----------------------------------------------------------
# Variables

# -------------------------------------
# The Subs

=head1 PUBLIC INTERFACE METHODS

=head2 User Methods

=over 4

=item GetUserLink

Returns the login link for a specific user.

=item DisableUser

Disables the user login and any communication via announcements for a specific
user.

=back

=cut

sub GetUserLink {
    my @users = $dbi->GetQuery('hash','FindUserByAct',$cgiparams{actuserid});
    return  unless(@users);             # act user not registered
    return  unless($users[0]->{code});  # if no code, not a logged in user
    $tvars{act}{link} = sprintf "http://%s.yapc-surveys.org/key/%s/%d", $settings{icode}, $users[0]->{code}, $users[0]->{userid};
}

sub DisableUser {
    my @users = $dbi->GetQuery('hash','FindUserByAct',$cgiparams{actuserid});
    return  unless(@users);             # act user not registered
    $dbi->DoQuery('hash','DisableUser',$cgiparams{actuserid});
    $tvars{act}{disabled} = 1;
}

=head2 Talk Methods

=over 4

=item GetTalkLink

Returns the talk link for a specific talk/course.

For an open user, i.e. for anyone watching the video stream, these users will
need to register and login. Feedback from these users is stored separately.

=item DisableTalk

Disables the ability to receive evaluations for the given talk.

=back

=cut

sub GetTalkLink {
    my @talks = $dbi->GetQuery('hash','FindCourseByAct',$cgiparams{acttalkid});
    return  unless(@talks);             # act talk not registered
    $tvars{act}{link} = sprintf "http://%s.yapc-surveys.org/talk/%d", $settings{icode}, $talks[0]->{talkid};
}

sub DisableTalk {
    my @talks = $dbi->GetQuery('hash','FindCourseByAct',$cgiparams{acttalkid});
    return  unless(@talks);             # act talk not registered
    $dbi->DoQuery('hash','DisableTalk',$cgiparams{acttalkid});
    $tvars{act}{disabled} = 1;
}

1;

__END__