File Coverage

blib/lib/Data/GUID/URLSafe.pm

Criterion	Covered	Total	%
statement	21	21	100.0
branch	1	2	50.0
condition			n/a
subroutine	6	6	100.0
pod	2	2	100.0
total	30	31	96.7

use strict;
use warnings;
package Data::GUID::URLSafe 0.007;
# ABSTRACT: url-safe base64-encoded GUIDs

#pod =head1 SYNOPSIS
#pod
#pod   use Data::GUID::URLSafe;
#pod
#pod   my $guid = Data::GUID->new;
#pod
#pod   my $string = $guid->as_base64_urlsafe;
#pod
#pod   my $same_guid = Data::GUID->from_base64_urlsafe;
#pod
#pod This module provides methods for L that provide for
#pod URL-safe base64 encoded GUIDs, as described by
#pod L.
#pod
#pod These strings are also safer for email addresses.  While the forward slash is
#pod legal in email addresses, some broken email address validators reject it.
#pod (Also, without the trailing equals signs, these strings will be shorter.)
#pod
#pod When Data::GUID::URLSafe is C'd, it installs methods into Data::GUID using
#pod L.
#pod
#pod =cut

use Data::GUID ();
use Sub::Exporter -setup => {
  into    => 'Data::GUID',
  exports => [ qw(as_base64_urlsafe from_base64_urlsafe) ],
  groups  => [ default => [ -all ] ],
};

#pod =method as_base64_urlsafe
#pod
#pod   my $string = $guid->as_base64_urlsafe;
#pod
#pod This method returns the URL-safe base64 encoded representation of the GUID.
#pod
#pod =cut

sub as_base64_urlsafe {
  my ($self) = @_;
  my $base64 = $self->as_base64;
  $base64 =~ tr{+/=}{-_}d;

  return $base64;
}

#pod =method from_base64_urlsafe
#pod
#pod   my $guid = Data::GUID->from_base64_urlsafe($string);
#pod
#pod =cut

sub from_base64_urlsafe {
  my ($self, $string) = @_;

  # +/ should not be handled, so convert them to invalid chars
  # also, remove spaces (\t..\r and SP) so as to calc padding len
  $string =~ tr{-_\t-\x0d }{+/}d;
  if (my $mod4 = length($string) % 4) {
    $string .= substr('====', $mod4);
  }

  return $self->from_base64($string);
}

1;

__END__