File Coverage

blib/lib/WebService/Async/CustomerIO/Customer.pm

Criterion	Covered	Total	%
statement	49	49	100.0
branch	6	6	100.0
condition	5	8	62.5
subroutine	19	19	100.0
pod	15	15	100.0
total	94	97	96.9

package WebService::Async::CustomerIO::Customer;

use strict;
use warnings;

=head1 NAME

WebService::Async::CustomerIO::Customer - Class for working with customer.

=head1 SYNOPSIS

=head1 DESCRIPTION

=cut

use Carp qw();

our $VERSION = '0.001';    ## VERSION

=head2 new

Creates customer object. This method just creates an object, to sent this data to api, after creation should be called upsert method.

Usage: C<< new(%params) -> obj >>

parameters:

=over 4

=item * C - the unique identifier for the customer.

=item * C - optional. the email address of the user.

=item * C - optional. the unix timestamp from when the user was created in your system

=item * C - hashref which contains custom attributes to define the customer.

=back

=cut

sub new {
    my ($cls, %param) = @_;

    $param{$_} or Carp::croak "Missing required argument: $_" for (qw(id api_client));

    return bless \%param, $cls;
}

=head2 api

=cut

sub api { return shift->{api_client} }

=head2 id

=cut

sub id { return shift->{id} }

=head2 email

=cut

sub email { return shift->{email} }

=head2 created_at

=cut

sub created_at { return shift->{created_at} }

=head2 attributes

=cut

sub attributes { return shift->{attributes} }

=head2 upsert

Create or update a customer

Usage: C<< upsert() -> Future() >>

=cut

sub upsert {
    my ($self) = @_;
    my $user_id = $self->id;

    my $attr = $self->attributes // {};
    my %user_params =
        map  { $_ => $attr->{$_} }
        grep { defined $attr->{$_} }
        keys %$attr;

    @user_params{qw(email created_at)} = @{$self}{qw(email created_at)};

    return $self->api->tracking_request(
        PUT => $self->_get_uri,
        \%user_params
    );
}

=head2 set_attribute

Set a customer attribute

Usage: C<< set_attribute($name, $value) -> Future() >>

=cut

sub set_attribute {
    my ($self, $name, $val) = @_;

    return $self->api->tracking_request(
        PUT => $self->_get_uri,
        {$name => $val});
}

=head2 remove_attribute

Remove customer attribute

Usage: C<< remove_attribute($name, $value) -> Future() >>

=cut

sub remove_attribute {
    my ($self, $name) = @_;

    return $self->set_attribute($name, '');
}

=head2 suppress

Suppress the customer. All events related to this customer wil be ignored by API.

Usage: C<< suppress() -> Future() >>

=cut

sub suppress {
    my ($self) = @_;

    return $self->api->tracking_request(POST => $self->_get_uri('suppress'));
}

=head2 unsuppress

Unsuppress the customer.

Usage: C<< unsuppress() -> Future() >>

=cut

sub unsuppress {
    my ($self) = @_;

    return $self->api->tracking_request(POST => $self->_get_uri('unsuppress'));
}

=head2 upsert_device

Create or update a customer device

Usage: C<< upsert_device(%params) -> Future() >>

Parameters:

=over 4

=item * C - The unique token for the user device.

=item * C - The platform for the user device. Allowed values are 'ios' and 'android'.

=item * C - Optional. UNIX timestamp representing the last used time for the device. If this is not included we default to the time of the device identify.

=back

=cut

sub upsert_device {
    my ($self, %param) = @_;

    $param{$_} or Carp::croak "Missing required argument: $_" for (qw(device_id platform));

    Carp::croak 'Invalid value for platform: ' . $param{platform}
        if $param{platform} !~ /^(?:ios|android)$/;

    my $device = {
        id        => $param{device_id},
        platform  => $param{platform},
        last_used => $param{last_used},
    };

    return $self->api->tracking_request(
        PUT => $self->_get_uri('devices'),
        {device => $device});
}

=head2 delete_device

Delete a customer device

Usage: C<< delete_device($id) -> Future() >>

=cut

sub delete_device {
    my ($self, $device_id) = @_;

    $device_id or Carp::croak "Missing required argument: device_id";

    return $self->api->tracking_request(DELETE => $self->_get_uri('devices', $device_id));
}

=head2 emit_event

Track a customer event

Usage: C<< emit_event(%params) -> Future() >>

Parameters:

- name: The name of the event to track
- type: Optional. Used to change event type. For Page View events set to "page".
- data: Optional. Custom data to include with the event.

=cut

sub emit_event {
    my ($self, %param) = @_;

    Carp::croak 'Missing required argument: name' unless $param{name};

    return $self->api->tracking_request(
        POST => $self->_get_uri('events'),
        \%param
    );
}

=head2 delete_customer

Delete a customer

Usage: C<< delete_customer() -> Future() >>

=cut

sub delete_customer {
    my $self = shift;

    return $self->api->tracking_request(DELETE => $self->_get_uri());
}

sub _get_uri {
    my ($self, @path) = @_;

    return join q{/} => ('customers', $self->id, @path);
}

1;