| 1 | |||
| 2 | package Net::OpenID::Extension::SimpleRegistration; | ||
| 3 | BEGIN { | ||
| 4 | $Net::OpenID::Extension::SimpleRegistration::VERSION = '1.030099_004'; | ||
| 5 | } | ||
| 6 | |||
| 7 | use base qw(Net::OpenID::Extension); | ||
| 8 | use strict; | ||
| 9 | use Carp; | ||
| 10 | |||
| 11 | use constant namespace_uris => { | ||
| 12 | 'http://openid.net/extensions/sreg/1.1' => 'sreg', | ||
| 13 | }; | ||
| 14 | |||
| 15 | sub new_request { | ||
| 16 | my ($class, %opts) = @_; | ||
| 17 | |||
| 18 | return Net::OpenID::Extension::SimpleRegistration::Request->new(%opts); | ||
| 19 | } | ||
| 20 | |||
| 21 | sub received_request { | ||
| 22 | my ($class, $args) = @_; | ||
| 23 | |||
| 24 | return Net::OpenID::Extension::SimpleRegistration::Request->received($args); | ||
| 25 | } | ||
| 26 | |||
| 27 | sub new_response { | ||
| 28 | my ($class, %opts) = @_; | ||
| 29 | |||
| 30 | return Net::OpenID::Extension::SimpleRegistration::Request->new(%opts); | ||
| 31 | } | ||
| 32 | |||
| 33 | sub received_response { | ||
| 34 | my ($class, $args) = @_; | ||
| 35 | |||
| 36 | return Net::OpenID::Extension::SimpleRegistration::Request->received($args); | ||
| 37 | } | ||
| 38 | |||
| 39 | package Net::OpenID::Extension::SimpleRegistration::Request; | ||
| 40 | BEGIN { | ||
| 41 | $Net::OpenID::Extension::SimpleRegistration::Request::VERSION = '1.030099_004'; | ||
| 42 | } | ||
| 43 | |||
| 44 | use base qw(Net::OpenID::ExtensionMessage); | ||
| 45 | use strict; | ||
| 46 | |||
| 47 | sub new { | ||
| 48 | my ($class, %opts) = @_; | ||
| 49 | |||
| 50 | my $self = bless {}, $class; | ||
| 51 | |||
| 52 | $self->required_fields(delete $opts{required_fields}); | ||
| 53 | $self->optional_fields(delete $opts{optional_fields}); | ||
| 54 | $self->policy_url(delete $opts{policy_url}); | ||
| 55 | |||
| 56 | $self->{required_fields} = [ split(',', $self->{required_fields}) ] unless ref $self->{required_fields}; | ||
| 57 | $self->{optional_fields} = [ split(',', $self->{optional_fields}) ] unless ref $self->{optional_fields}; | ||
| 58 | |||
| 59 | Carp::croak("Unsupported options: ".join(',', keys %opts)) if %opts; | ||
| 60 | |||
| 61 | return $self; | ||
| 62 | } | ||
| 63 | |||
| 64 | sub received { | ||
| 65 | my ($class, $args) = @_; | ||
| 66 | |||
| 67 | my $self = $class->new(); | ||
| 68 | my $args = $args->{sreg} || {}; | ||
| 69 | |||
| 70 | $self->required_fields($args->{required}); | ||
| 71 | $self->optional_fields($args->{optional}); | ||
| 72 | |||
| 73 | return $self; | ||
| 74 | } | ||
| 75 | |||
| 76 | sub extension_arguments { | ||
| 77 | my ($self) = @_; | ||
| 78 | |||
| 79 | my $ret = {}; | ||
| 80 | |||
| 81 | $ret->{required} = join(',', @{$self->required_fields}) if @{$self->required_fields}; | ||
| 82 | $ret->{optional} = join(',', @{$self->optional_fields}) if @{$self->optional_fields}; | ||
| 83 | $ret->{policy_url} = $self->policy_url if $self->policy_url; | ||
| 84 | |||
| 85 | return { | ||
| 86 | sreg => $ret, | ||
| 87 | }; | ||
| 88 | } | ||
| 89 | |||
| 90 | sub required_fields { | ||
| 91 | my ($self, $value) = @_; | ||
| 92 | |||
| 93 | if (defined $value) { | ||
| 94 | $value = [] unless $value; | ||
| 95 | $value = [ split(',', $value) ] unless ref $value; | ||
| 96 | $self->{required_fields} = $value; | ||
| 97 | } | ||
| 98 | else { | ||
| 99 | return $self->{required_fields}; | ||
| 100 | } | ||
| 101 | } | ||
| 102 | |||
| 103 | sub optional_fields { | ||
| 104 | my ($self, $value) = @_; | ||
| 105 | |||
| 106 | if (defined $value) { | ||
| 107 | $value = [] unless $value; | ||
| 108 | $value = [ split(',', $value) ] unless ref $value; | ||
| 109 | $self->{optional_fields} = $value; | ||
| 110 | } | ||
| 111 | else { | ||
| 112 | return $self->{optional_fields}; | ||
| 113 | } | ||
| 114 | } | ||
| 115 | |||
| 116 | sub add_required_field { | ||
| 117 | my ($self, $value) = @_; | ||
| 118 | |||
| 119 | push @{$self->{required_fields}}, $value; | ||
| 120 | } | ||
| 121 | |||
| 122 | sub add_optional_field { | ||
| 123 | my ($self, $value) = @_; | ||
| 124 | |||
| 125 | push @{$self->{optional_fields}}, $value; | ||
| 126 | } | ||
| 127 | |||
| 128 | sub policy_url { | ||
| 129 | my ($self, $value) = @_; | ||
| 130 | |||
| 131 | if (defined $value) { | ||
| 132 | $self->{policy_url} = $value; | ||
| 133 | } | ||
| 134 | else { | ||
| 135 | return $self->{optional_fields}; | ||
| 136 | } | ||
| 137 | } | ||
| 138 | |||
| 139 | package Net::OpenID::Extension::SimpleRegistration::Response; | ||
| 140 | BEGIN { | ||
| 141 | $Net::OpenID::Extension::SimpleRegistration::Response::VERSION = '1.030099_004'; | ||
| 142 | } | ||
| 143 | |||
| 144 | use base qw(Net::OpenID::ExtensionMessage); | ||
| 145 | use strict; | ||
| 146 | |||
| 147 | use constant FIELDS => [qw(nickname email fullname dob gender postcode country language timezone)]; | ||
| 148 | use fields FIELDS(); | ||
| 149 | |||
| 150 | BEGIN { | ||
| 151 | # Create an accessor for each of the fields | ||
| 152 | foreach my $field_name (@{FIELDS()}) { | ||
| 153 | no strict qw(refs); | ||
| 154 | *{'Net::OpenID::Extension::SimpleRegistration::Response::'.$field_name} = sub { | ||
| 155 | my ($self, $value) = @_; | ||
| 156 | |||
| 157 | if (defined $value) { | ||
| 158 | $self->{$field_name} = $value; | ||
| 159 | } | ||
| 160 | else { | ||
| 161 | return $self->{$field_name}; | ||
| 162 | } | ||
| 163 | }; | ||
| 164 | } | ||
| 165 | } | ||
| 166 | |||
| 167 | sub new { | ||
| 168 | my ($class, %opts) = @_; | ||
| 169 | |||
| 170 | my $self = fields::new($class); | ||
| 171 | |||
| 172 | foreach my $field_name (@{FIELDS()}) { | ||
| 173 | $self->{$field_name} = delete $opts{$field_name}; | ||
| 174 | } | ||
| 175 | |||
| 176 | Carp::croak("Unrecognised options: ".join(',', %opts)) if %opts; | ||
| 177 | |||
| 178 | return $self; | ||
| 179 | } | ||
| 180 | |||
| 181 | sub received { | ||
| 182 | my ($class, $args) = @_; | ||
| 183 | |||
| 184 | my $args = $args->{sreg} || {}; | ||
| 185 | my %opts = (); | ||
| 186 | |||
| 187 | foreach my $field_name (@{FIELDS()}) { | ||
| 188 | $opts{$field_name} = $args->{$field_name} if $args->{$field_name}; | ||
| 189 | } | ||
| 190 | |||
| 191 | return $class->new(%opts); | ||
| 192 | } | ||
| 193 | |||
| 194 | sub extension_arguments { | ||
| 195 | my ($self) = @_; | ||
| 196 | |||
| 197 | # De-reference and then re-reference the hash to shake off the blessedness | ||
| 198 | my $ret = { %$self }; | ||
| 199 | |||
| 200 | return { | ||
| 201 | sreg => $ret, | ||
| 202 | }; | ||
| 203 | } | ||
| 204 | |||
| 205 | =pod | ||
| 206 | |||
| 207 | =head1 NAME | ||
| 208 | |||
| 209 | Net::OpenID::Extension::SimpleRegistration - Support for the Simple Registration extension (SREG) | ||
| 210 | |||
| 211 | =head1 VERSION | ||
| 212 | |||
| 213 | version 1.030099_004 | ||
| 214 | |||
| 215 | =head1 SYNOPSIS | ||
| 216 | |||
| 217 | In Consumer... | ||
| 218 | |||
| 219 | my $sreg_req = $claimed_identity->add_extension_request('Net::OpenID::Extension::SimpleRegistration', ( | ||
| 220 | required_fields => [qw(nickname email)], | ||
| 221 | optional_fields => [qw(country language timezone)], | ||
| 222 | policy_url => "http://example.com/policy.html", | ||
| 223 | )); | ||
| 224 | |||
| 225 | Then, in Server, when handling the authentication request... | ||
| 226 | |||
| 227 | # FIXME: What object do we have in ::Server that can hold this method? | ||
| 228 | my $sreg_req = $something->get_extension_request('Net::OpenID::Extension::SimpleRegistration'); | ||
| 229 | my $required_fields = $sreg_req->required_fields; | ||
| 230 | my $optional_fields = $sreg_req->optional_fields; | ||
| 231 | my $policy_url = $sreg_req->policy_url; | ||
| 232 | |||
| 233 | When Server sends back its response... | ||
| 234 | |||
| 235 | # FIXME: Again, what object do we have to hold this method? | ||
| 236 | my $sreg_res = $something->add_extension_response('Net::OpenID::Extension::SimpleRegistration', ( | ||
| 237 | nickname => $nickname, | ||
| 238 | email => $email, | ||
| 239 | )); | ||
| 240 | |||
| 241 | And finally, when back in Consumer recieving the response: | ||
| 242 | |||
| 243 | my $sreg_res = $verified_identity->get_extension_response('Net::OpenID::Extension::SimpleRegistration'); | ||
| 244 | my $nickname = $sreg_res->nickname; | ||
| 245 | my $email = $sreg_res->email; | ||
| 246 | my $country = $sreg_res->country; | ||
| 247 | my $language = $sreg_res->language; | ||
| 248 | my $timezone = $sreg_res->timezone; | ||
| 249 | |||
| 250 | =cut | ||
| 251 | |||
| 252 | 1; |