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

HEYTRAV / WebService-Raygun-0.030 / lib / WebService / Raygun / Message / User.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
132
133
134
135
136
—
137
138
139
140
141
142
143
144
145
146
147
148
149

              
package WebService::Raygun::Message::User;
$WebService::Raygun::Message::User::VERSION = '0.030';
use Mouse;
=head1 NAME
WebService::Raygun::Message::User - Represent the I<User> data in a raygun request.
=head1 SYNOPSIS
    use WebService::Raygun::Message::User;
    my $user = WebService::Raygun::User->new(
        identifier   => "123456",
        email        => 'test@test.com',
        is_anonymous => undef,
        full_name    => 'Firstname Lastname',
        first_name   => 'Firstname',
        uuid         => '783491e1-d4a9-46bc-9fde-9b1dd9ef6c6e'
    );
=head1 DESCRIPTION
The user data is all optional and may be left blank. This class just
initialises them with empty strings or 1s or 0s depending on the context. The
L<prepare_raygun> method may be called to retreive the structure in a form
that can be converted directly to JSON.
=head1 INTERFACE
=cut
use Data::GUID 'guid_string';
use Mouse::Util::TypeConstraints;
subtype 'RaygunUser' => as 'Object' => where {
    $_->isa('WebService::Raygun::Message::User');
};
coerce 'RaygunUser' => from 'Str' => via {
    return WebService::Raygun::Message::User->new(email => $_, identifier => $_) if $_ =~ /[^@]+\@[^\.]+\..*/;
    return WebService::Raygun::Message::User->new(identifier => $_);
} => from 'Int' => via {
    return WebService::Raygun::Message::User->new(identifier => "$_");
} =>  from 'HashRef' => via {
    return WebService::Raygun::Message::User->new(%{$_});
};
no Mouse::Util::TypeConstraints;
=head2 identifier
Something to identify the user.
=cut
has identifier => (
    is      => 'rw',
    isa     => 'Str',
    required => 1,
    default => '',
);
=head2 email
Email address of logged in user.
=cut
has email => (
    is      => 'rw',
    isa     => 'Str',
    default => '',
);
=head2 is_anonymous
Indicates whether or not the user is logged into your app.
=cut
has is_anonymous =>
  ( is => 'rw', isa => 'Bool', default => sub { return 1; } );
=head2 full_name
User's full name.
=cut
has full_name => (
    is      => 'rw',
    isa     => 'Str',
    default => ''
);
=head2 first_name
User's first name.
=cut
has first_name => (
    is      => 'rw',
    isa     => 'Str',
    default => '',
);
=head2 uuid
Device unique identifier. Useful if sending from mobile device.
=cut
has uuid =>
  ( is => 'rw', isa => 'Str', default => sub { return guid_string; } );
=head2 prepare_raygun
Return the data structure that will be sent to raygun.io
=cut
sub prepare_raygun {
    my $self = shift;
    return {
        identifier => $self->identifier,
        isAnonymous => $self->is_anonymous,
        email => $self->email,
        fullName => $self->full_name,
        firstName => $self->first_name,
        uuid => $self->uuid,
    };
}
=head1 DEPENDENCIES
=head1 SEE ALSO
=cut
__PACKAGE__->meta->make_immutable();
1;
__END__