Merge pull request #204 from waterkip/deprecation-id-in-sp

Add deprecation warning to id() method

Author: waterkip

lib/Net/SAML2/SP.pm

@@ -162,8 +162,14 @@ Consumer Services.
 
 has 'url'    => (isa => Uri, is => 'ro', required => 1, coerce => 1);
 
-has 'id'        => (isa => XsdID, is => 'ro', builder => '_build_id');
-has 'issuer'    => (isa => 'Str', is => 'ro', required => 1);
+has '_id' => (
+    isa      => XsdID,
+    is       => 'ro',
+    builder  => '_build_id',
+    init_arg => 'id'
+);
+
+has 'issuer' => (isa => 'Str', is => 'ro', required => 1);
 
 has 'cert'   => (isa => 'Str', is => 'ro', required => 1, predicate => 'has_cert');
 has 'key'    => (isa => 'Str', is => 'ro', required => 1);
@@ -298,6 +304,14 @@ sub _build_id {
     return Net::SAML2::Util::generate_id();
 }
 
+sub id {
+    my $self = shift;
+    Net::SAML2::Util::deprecation_warning
+      "id() has been renamed to issuer()";
+    return $self->issuer;
+}
+
+
 sub _build_encryption_key_text {
     my ($self) = @_;
 
@@ -590,7 +604,7 @@ sub generate_metadata {
         $md,
         {
             entityID => $self->issuer,
-            ID       => $self->id,
+            ID       => $self->_id,
         },
         $x->SPSSODescriptor(
             $md,

lib/Net/SAML2/Util.pm

@@ -19,7 +19,7 @@ sub generate_id {
 }
 
 sub deprecation_warning {
-    warn "NET::SAML2 deprecation warning: " . shift . "\n";
+    warn "Net::SAML2 deprecation warning: " . shift . "\n";
 }
 
 

t/02-create-sp.t

@@ -490,4 +490,18 @@ use URN::OASIS::SAML2 qw(:bindings :urn);
     is($child[1]->getAttribute('isRequired'), '1', ".. and requiredness");
 }
 
+{
+    my $sp = net_saml2_sp();
+
+    my @warns;
+    local $SIG{__WARN__} = sub { push(@warns, shift); };
+    my $id = $sp->id;
+    is($id, $sp->issuer, "id is still the issuer");
+    cmp_deeply(
+        \@warns,
+        ["Net::SAML2 deprecation warning: id() has been renamed to issuer()\n"],
+        "We have our deprecation warning"
+    );
+}
+
 done_testing;

t/09-authn-request.t

@@ -174,7 +174,7 @@ $override->override('Net::SAML2::Protocol::AuthnRequest::_build_id' =>
         is_passive  => 0,
     );
 
-    my $req = $sp->authn_request($sp->id, '', %params,);
+    my $req = $sp->authn_request($sp->issuer, '', %params,);
 
     my $xp = get_xpath(
         $req->as_xml,