From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

RITOU / Net-OATH-Server-0.02 / lib / Net / OATH / Server / Lite / DataHandler.pm 

            

              
1
2
3
4
—
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
—
32
33
34
35
36
37
38
39
40
41
42
43
44
—
45
46
47
48
49
50
51
52
53
54
55
56
57
—
58
59
60
61
62
63
64
65
66
67
68
—
69
70
71
72
73
74
75
76
77
78
79
80
81
—
82
83
84
85
86
87
88
89
90
91
92
93
94
—
95
96
97
98
99
100
101
102
103
104
105
106
107
—
108
109
110
111
112
113
114
115
116
117
118
—
119
120
121
122
123
124
125
126
127
128
129
130
131

              
package Net::OATH::Server::Lite::DataHandler;
use strict;
use warnings;
=head1 NAME
Net::OATH::Server::Lite::DataHandler - Base class that specifies interface for data handler for your server.
=head1 DESCRIPTION
This connects Net::OATH::Server::Lite library to your service.
This specifies an interface to handle data stored in your application. 
You must inherit this and implement the subroutines according to the interface contract.
=head1 SYNOPSIS
    package YourDataHandler;
    use strict;
    use warnings;
    use parent 'Net::OATH::Server::Lite::DataHandler';
=cut
sub new {
    my ($class, %args) = @_;
    my $self = bless { request => undef, %args }, $class;
    $self->init;
    $self;
}
=head1 METHODS
=head2 init
This method can be implemented to initialize your subclass.
=cut
sub init {
    my $self = shift;
    # template method
}
=head1 INTERFACES
=head2 request
Returns <Plack::Request> object.
=cut
sub request {
    my $self = shift;
    return $self->{request};
}
=head2 create_id
Returns identifier of new user object.
=cut
sub create_id {
    my ($self) = @_;
    die "abstract method";
}
=head2 create_secret
Returns raw secret of new user object.
=cut
sub create_secret {
    my ($self) = @_;
    die "abstract method";
}
# For Register
=head2 insert_user( $user )
Inserts new user object to your datastore and returnes result as a boolean.
=cut
sub insert_user {
    my ($self, $user) = @_;
    die "abstract method";
}
# For Login and User Object
=head2 select_user( $id )
Return user object which is found by $id.
=cut
sub select_user {
    my ($self, $id) = @_;
    die "abstract method";
}
# For User Object
=head2 update_user( $user )
Updates user object on your datastore and returnes result as a boolean.
=cut
sub update_user {
    my ($self, $user) = @_;
    die "abstract method";
}
=head2 delete_user( $id )
Deletes user object which is found by $id on your datastore and returnes result as a boolean.
=cut
sub delete_user {
    my ($self, $id) = @_;
    die "abstract method";
}
1;