File Coverage

blib/lib/Net/Google/Analytics/MeasurementProtocol.pm

Criterion	Covered	Total	%
statement	27	66	40.9
branch	0	18	0.0
condition	0	6	0.0
subroutine	7	12	58.3
pod	3	3	100.0
total	37	105	35.2

use v5.20;
use warnings;
use feature 'signatures';
no warnings qw(experimental::signatures);

use Carp ();
use JSON ();

our $VERSION = 4.01;

package Net::Google::Analytics::MeasurementProtocol {

  sub new ($class, %args) {
    return bless {
      api_secret     => $args{api_secret},
      measurement_id => $args{measurement_id},
      client_id      => $args{client_id} // _gen_uuid_v4(),
      agent          => $args{agent}     // _build_user_agent(),
      debug          => $args{debug},
      _route         => _build_route(%args),
    }, $class;
  }

  sub send ($self, $name, $properties) {
    Carp::croak('properties must be a hashref') unless ref $properties eq 'HASH';
    return $self->send_multiple( [{ $name => $properties }] );
  }

  sub send_multiple ($self, $events) {
    Carp::croak('events must be an array reference') unless ref $events eq 'ARRAY';
    my @formatted_events;
    foreach my $e (@$events) {
      my ($name, $params) = each %$e;
      push @formatted_events, { name => $name, params => $params }
    }

    my $payload = JSON::encode_json({
      client_id => $self->{client_id},
      events    => \@formatted_events,
    });

    my $res = $self->{agent}->post( $self->{_route}, $self->{agent}->isa('Furl') ? undef : (), $payload );
    if ($res->is_success) {
      return $self->{debug} ? JSON::decode_json($res->decoded_content) : 1;
    }
    return { __PACKAGE__ => $res->decoded_content };
  }

  sub _build_route(%args) {
    if ($args{tid}) {
      Carp::croak('Looks like you are calling ' . __PACKAGE__ . ' with'
          . ' outdated arguments from Universal Analytics. Please update'
          . ' to Google Analytics 4 (GA4) accordingly');
    }
    if (!$args{api_secret}) {
      Carp::croak('api_secret is required. Create one in Admin > Data Streams'
          . ' > choose your stream > Measurement Protocol > Create');
    }
    if (!$args{measurement_id}) {
      Carp::croak('measurement_id is required. Find yours under Admin > Data'
          . ' Streams > choose your stream > Measurement ID');
    }

    my $debug = $args{debug} ? '/debug' : '';
    return 'https://www.google-analytics.com' . $debug . '/mp/collect'
         . '?measurement_id=' . $args{measurement_id}
         . '&api_secret=' . $args{api_secret};
  }

  sub _build_user_agent {
    require Furl;
    return Furl->new( agent => __PACKAGE__ . '/' . $VERSION, timeout => 5, headers => ['Content-Type' => 'application/json'] );
  }

  # UUID v4 (pseudo-random) generator based on UUID::Tiny
  sub _gen_uuid_v4 {
    my $uuid = '';
    for ( 1 .. 4 ) {
        my ($v1, $v2) = (int(rand(65536)) % 65536, int(rand(65536)) % 65536);
        my $rand_32bit = ($v1 << 16) | $v2;
        $uuid .= pack 'I', $rand_32bit;
    }
    substr $uuid, 6, 1, chr( ord( substr( $uuid, 6, 1 ) ) & 0x0f | 0x40 );
    substr $uuid, 8, 1, chr( ord( substr( $uuid, 8, 1 ) ) & 0x3f | 0x80 );

    # uuid is created. Convert to string:
    return join '-', map { unpack 'H*', $_ } map { substr $uuid, 0, $_, '' } ( 4, 2, 2, 2, 6 );
  }
};

1;

__END__