Flickr::Simple2 - A XML::Simple based Perl Flickr API.

  use Flickr::Simple2;
  my $flickr =
    Flickr::Simple2->new({
        api_key => $cfg->param('Flickr.API_KEY'),
        api_secret => $cfg->param('Flickr.API_SHARED_SECRET'),
        auth_token => $cfg->param('Flickr.auth_token')
    });

 api_key is your Flickr API key given by Flickr api_secret is your Flickr API secret key given by Flickr.  It is used to sign certain Flickr API methods

 auth_token is optional for public/safe access to photos but is required for nonsafe/private photos or any Flickr API method requiring authentication

 A simple method to send a message to Flickr and receive it back as a hash reference.

 Requires: hash reference containing valid name/value pairs, api_key
 Returns: hash reference containing the response from Flickr

 An internal method that sets the simple error object hash reference.  The hash ref will be undefined if no error exists.  

 An internal method that clears the simple error object hash reference.  The hash ref will be undefined if no error exists.  

 An internal method to sign the Flickr API method call with your Flickr API secret key.

 Requires: arguments to sign, flickr_api and flickr_api_secret
 Returns: String containing the signed arguments

 A method to retrieve a Flickr frob, used for authentication.

 Requires: api_key and api_secret
 Returns: String containing the frob  

 A method to retrieve the url (webpage) for a Flickr user to authorize your application to use their account.

 Requires: frob, permissions (read/write), api_key and api_secret
 Returns: String containing the URL

 A method to retrieve a Flickr authorization token.  Called after a user authorizes your application with the url returned from get_auth_url().

 Requires: frob, api_key and api_secret
 Returns: String containing the authorization token

 A method to validate a Flickr auth_token.

 Requires: auth_token, api_key and api_secret
 Returns: true (1) if auth_token is valid else undef

 Retrieves the NSID of a Flickr user when given an email address

 Requires: email address, api_key
 Returns: String containing the NSID of the user

 Retrieves the NSID of a Flickr user when given a Flickr username

 Requires: Flickr username, api_key
 Returns: String containing the NSID of the user

 Retrieves the NSID of a Flickr user when given any URL (from Flickr website) associated with the user

 Requires:  URL, api_key
 Returns: String containing the NSID of the user

 Retrieves extensive information regarding a Flickr user

 Requires: NSID, api_key
 Returns: Hash reference containing information about the user

 Requires: api_key
 Returns: Hash reference containing the license information

 Retrieve the EXIF tags about a particular photo.  Primarily used by get_photo_detail but can be used separately

 Requires: photo id, photo secret and api_key
 Returns: Hash reference containing the EXIF tags  

 Retrieves extensive information regarding a particular photo.

 Requires: photo id, photo secret, api_key
 Optional: api_secret for none safe/public photos
 Returns: Hash reference containing photo information

 Retrieves a "page" of photos from Flickr. Flickr groups photos in pages similar to their website.  

 Returns: a hash reference for the current page of photos

 Retrieves a list of a Flickr user's public photos (simple info) 

 Requires: NSID, hash reference containing the number of photos (per page) to retrieve at a time
 Optional: Within the hash reference:  safe_search, extras and page of photos to return

 From Flickr API:
    safe_search (Optional)
        Safe search setting:

            * 1 for safe.
            * 2 for moderate.
            * 3 for restricted.

        (Please note: Un-authed calls can only see Safe content.)
    extras (Optional)
        A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media.
    per_page (Optional)
        Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
    page (Optional)
        The page of results to return. If this argument is omitted, it defaults to 1.

 Returns: Hash reference containing photos and simple photo details (photo secret for example)

 From Flickr API:
    http://farm{farm-id}.static.flickr.com/{server-id}/{id}_{secret}.jpg
    http://farm{farm-id}.static.flickr.com/{server-id}/{id}_{secret}_[mstb].jpg
    http://farm{farm-id}.static.flickr.com/{server-id}/{id}_{o-secret}_o.(jpg|gif|png)
        s	small square 75x75
        t	thumbnail, 100 on longest side
        m	small, 240 on longest side
        -	medium, 500 on longest side
        b	large, 1024 on longest side (only exists for very large original images)
        o	original image, either a jpg, gif or png, depending on source format

 An internal method that builds the various size photo URLs for a particular photo.  Called primarily from get_public_photos.  Does not guarantee that the photo URLs are valid.

 Requires: photo id, reference containing details of the photo, api_key
 Returns: Hash reference containing the photo URLs

 Requires: photo id, api_key
 Returns: Hash reference containing URLs and other information regarding the sizes of the photo

 Requires: photo id, api_key
 Returns: Hash reference regarding the contexts of the photo

 Sanitizes the tags structure that is part of the flickr.photos.getInfo response.  Used by get_photo_detail subroutine.

 Requires tags structure returned by flickr.photos.getInfo 
 Returns a hash ref with tag_name => "tagged by NSID" structure.

 Requires: user_id, api_key
 Returns: Hash reference containing a list and limited info of photosets for a user.  

 Retrieves a list of a Flickr user's photoset photos (simple info) 

 Requires: NSID, hash reference containing the number of photos (per page) to retrieve at a time
 Optional: Within the hash reference:  safe_search, extras and page of photos to return

 From Flickr API:
    safe_search (Optional)
        Safe search setting:

            * 1 for safe.
            * 2 for moderate.
            * 3 for restricted.

        (Please note: Un-authed calls can only see Safe content.)
    extras (Optional)
        A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media.
    per_page (Optional)
        Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
    page (Optional)
        The page of results to return. If this argument is omitted, it defaults to 1.

 Returns: Hash reference containing photos and simple photo details (photo secret for example)

 Requires: photoset_id, api_key
 Returns: Hash reference containing information regarding a photo set.  

 Retrieves a list of YOUR photos not currently in a photoset (simple info) 

 Requires: 
 Optional: Within the hash reference:  safe_search, extras and page of photos to return

 From Flickr API:
    safe_search (Optional)
        Safe search setting:

            * 1 for safe.
            * 2 for moderate.
            * 3 for restricted.

        (Please note: Un-authed calls can only see Safe content.)
    extras (Optional)
        A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media.
    per_page (Optional)
        Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
    page (Optional)
        The page of results to return. If this argument is omitted, it defaults to 1.

 Returns: Hash reference containing photos and simple photo details (photo secret for example)

package Flickr::Simple2;

use 5.008000;
use strict;
use warnings;

our $VERSION = '0.03';

our @ISA = qw(Exception::Class::TCF);

use Carp;
use Digest::MD5 qw(md5_hex);
use Exception::Class::TCF;
use Iterator::Simple qw(iterator);
use LWP::Simple;
use URI;
use XML::Simple;

sub new {
  my $proto      = shift;
  my $params_ref = shift;

  my $class = ref($proto) || $proto;

  my $self = {};

  %{ $self->{params} } = map { $_ => $params_ref->{$_} } keys %$params_ref;

  bless( $self, $class );
  return $self;
}

sub NEXTVAL {
  $_[0]->();
}

#-------------------------------------

sub request {
  my $self = shift;
  my ( $flickr_method, $args, $xml_simple_args ) = @_;

  $xml_simple_args = {} unless $xml_simple_args;

  my $uri;
  my @flickr_args =
    ( 'method', $flickr_method, 'api_key', $self->{params}->{api_key} );

  foreach my $key ( sort { lc $a cmp lc $b } keys %$args ) {
    next if ( $key =~ /^(?:api_key|method)/ );
    push( @flickr_args, ( $key, $args->{$key} ) ) if defined $args->{$key};
  }

  $uri = URI->new('http://api.flickr.com/services/rest');
  $uri->query_form( \@flickr_args );
  my $content = get($uri);

  if ($content) {
    my $response = XMLin( $content, %$xml_simple_args );
    return $response if $response;
  }
}

#------------------------------

#------------------------------

sub echo {
  my $self = shift;
  my $args = shift;

  return unless ($args);

  my $response =
    $self->request( 'flickr.test.echo', $args,
    { forcearray => 0, keeproot => 0 } );

  if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
    my %echo = map { $_ => $response->{$_} }
      grep { !/^(?:method|api_key|stat)$/ } keys %$response;
    return \%echo;
  }
  else {
    $self->raise_error( $response, 'echo', 1 );
    return;
  }
}

#------------------------------

sub raise_error {
  my $self = shift;
  my ( $response, $calling_sub, $exit_now ) = @_;

  if ( defined $response->{err} ) {
    $self->{'error'} = {
      calling_sub => $calling_sub,
      message     => $response->{err}->{msg},
      code        => $response->{err}->{code}
    };
  }
  else {
    $self->{'error'} = { calling_sub => $calling_sub };
  }

  return;
}

sub clear_error {
  my $self = shift;

  $self->{'error'} = undef;
}

#------------------------------

sub flickr_sign {
  my $self            = shift;
  my $flickr_hash_ref = shift;

  my $sign;

  if ( $self->{params}->{api_secret} ) {
    $sign = $self->{params}->{api_secret};
    $flickr_hash_ref->{api_key} = $self->{params}->{api_key};

    foreach my $arg ( sort { $a cmp $b } keys %{$flickr_hash_ref} ) {
      if ( defined( $flickr_hash_ref->{$arg} ) ) {
        $sign .= $arg . $flickr_hash_ref->{$arg};
      }
      else {
        $sign .= $arg . "";
      }
    }
  }

  try {
    if ($sign) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' => sub { $self->raise_error( undef, 'flickr_sign', 1 ) };

  return md5_hex($sign) unless defined $self->{error};
}

#------------------------------

sub get_auth_frob {
  my $self = shift;

  my $sign;
  my $response;

  $sign = $self->flickr_sign( { method => 'flickr.auth.getFrob' } );
  $response = $self->request(
    'flickr.auth.getFrob',
    { api_sig    => $sign },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_auth_frob', 1 ) };

  return $response->{frob} unless defined $self->{error};
}

sub get_auth_url {
  my $self = shift;
  my ( $frob, $permissions ) = @_;

  my $uri;

  if ( $frob && $permissions ) {
    my %args = (
      'frob'  => $frob,
      'perms' => $permissions
    );

    $args{api_sig} =
      $self->flickr_sign( { frob => $frob, perms => $permissions } );
    $args{api_key} = $self->{params}->{api_key};

    $uri = URI->new('http://flickr.com/services/auth');
    $uri->query_form(%args);
  }

  try {
    if ($uri) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' => sub { $self->raise_error( undef, 'get_auth_url', 1 ) };

  return $uri unless $self->{error};
}

sub get_auth_token {
  my $self = shift;
  my $frob = shift;

  my $sign =
    $self->flickr_sign( { frob => $frob, method => 'flickr.auth.getToken' } );
  my $response = $self->request(
    'flickr.auth.getToken',
    { api_sig    => $sign, frob     => $frob },
    { forcearray => 0,     keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
      $self->{params}->{'auth_token'} = $response->{'auth'}->{'token'};
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_auth_token', 1 ) };

  return $response->{'auth'}->{'token'} unless defined $self->{error};
}

sub check_auth_token {
  my $self = shift;

  my $sign = $self->flickr_sign(
    {
      auth_token => $self->{params}->{auth_token},
      method     => 'flickr.auth.checkToken'
    }
  );
  my $response = $self->request(
    'flickr.auth.checkToken',
    { api_sig    => $sign, auth_token => $self->{params}->{auth_token} },
    { forcearray => 0,     keeproot   => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'check_auth_token', 1 ) };

  return 1 unless defined $self->{error};
}

#------------------------------

sub get_user_byEmail {
  my $self       = shift;
  my $user_email = shift;

  my $response = $self->request(
    'flickr.people.findByEmail',
    { find_email => $user_email },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_user_byEmail', 1 ) };

  return $self->get_user_info( $response->{user}->{nsid} )
    unless $self->{error};
}

sub get_user_byUserName {
  my $self     = shift;
  my $username = shift;

  my $response = $self->request(
    'flickr.people.findByUsername',
    { username   => $username },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_user_byUserName', 1 ) };

  return $self->get_user_info( $response->{user}->{nsid} )
    unless $self->{error};
}

sub get_user_byURL {
  my $self = shift;
  my $url  = shift;

  my $response = $self->request(
    'flickr.urls.lookupUser',
    { url        => $url },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();

    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_user_byUserName', 1 ) };

  return $self->get_user_info( $response->{user} ) unless $self->{error};
}

sub get_user_info {
  my $self = shift;
  my $user = shift;

  my $response = $self->request(
    'flickr.people.getInfo',
    { user_id    => $user->{id} },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_user_info', 1 ) };

  return $response->{person} unless $self->{error};
}

#------------------------------

sub get_license_info {
  my $self = shift;

  my $response = $self->request( 'flickr.photos.licenses.getInfo',
    undef, { forcearray => ['id'], keeproot => 0, keyattr => ['id'] } );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_license_info', 1 ) };

  return $response->{licenses}->{license} unless $self->{error};
}

#------------------------------

sub get_photo_exif {
  my $self = shift;
  my ( $photo_id, $photo_secret ) = @_;

  my $exif_ref;
  my $response = $self->request(
    'flickr.photos.getExif',
    { photo_id   => $photo_id, secret   => $photo_secret },
    { forcearray => 0,         keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();

      foreach my $hash_ref ( @{ $response->{photo}->{exif} } ) {
        $exif_ref->{ $hash_ref->{tagspace} }->{ $hash_ref->{tag} } =
          $hash_ref->{raw};
      }
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_photo_exif', 1 ) };

  return $exif_ref unless $self->{error};
}

sub get_photo_detail {
  my $self = shift;
  my ( $photo_id, $photo_secret ) = @_;

  my $response = $self->request(
    'flickr.photos.getInfo',
    { photo_id   => $photo_id, secret   => $photo_secret },
    { forcearray => 0,         keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();

      $response->{photo}->{exif} =
        $self->get_photo_exif( $photo_id, $photo_secret );
      $response->{photo}->{tags} =
        $self->get_photo_tags( $response->{photo}->{tags} );
      $response->{photo}->{urls} =
        $self->build_photo_urls( $photo_id, $response->{photo} );
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_photo_detail', 1 ) };

  return $response->{photo} unless $self->{error};
}

sub get_photos_page {
  my $self = shift;
  my ( $user, $flickr_method, $params_ref ) = @_;

  my $args;
  my $max_pages = 1;
  my $auth_token;
  my %temp_hash = ();

  $auth_token = $params_ref->{auth_token} if $params_ref->{auth_token};

  if ( $params_ref->{per_page} ) {
    $max_pages = ( int $user->{photos}->{count} / $params_ref->{per_page} ) + 1;
  }

  $args->{user_id} = $user->{nsid};

  if ( $params_ref->{photoset_id} ) {
    $args->{photoset_id} = $params_ref->{photoset_id};
  }

  if ( $params_ref->{safe_search} ) {
    if ( $params_ref->{safe_search} eq 'safe' ) {
      $args->{safe_search} = 1;
    }
    elsif ( $params_ref->{safe_search} eq 'moderate' ) {
      $args->{safe_search} = 2;
    }
    elsif ( $params_ref->{safe_search} eq 'restricted' ) {
      $args->{safe_search} = 3;
    }
  }

  if ( $params_ref->{extras} ) {
    $args->{extras} = $params_ref->{extras};
  }
  else {
    $args->{extras} =
"license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,o_dims,views,media";
  }

  $args->{per_page} = $params_ref->{per_page} if $params_ref->{per_page};

  if ( $params_ref->{page} ) {
    $args->{page} = $params_ref->{page};
  }
  else {
    $args->{page} = 1;
  }

  if ($auth_token) {
    $args->{auth_token} = $auth_token;
    %temp_hash          = %$args;
    $temp_hash{method}  = $flickr_method;
  }

  iterator {
    if ($auth_token) {
      $temp_hash{page} = $args->{page};
      $args->{api_sig} = $self->flickr_sign( \%temp_hash );
    }

    my $response =
      $self->request( $flickr_method, $args,
      { forcearray => 0, keeproot => 0 } );

    try {
      if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
        $self->clear_error();
      }
      else {
        throw 'Error';
      }
    }
    catch 'Default' =>
      sub { $self->raise_error( $response, 'get_photos_page', 1 ) };

    $max_pages = $response->{photos}->{pages}
      if ( exists $response->{photos} && exists $response->{photos}->{pages} );

    $args->{page}++ if ( $args->{page} < $max_pages );
    return $response unless $self->{error};
  }
}

sub get_public_photos {
  my $self       = shift;
  my $user       = shift;
  my $params_ref = shift;

  ${ $self->{licenses} } = $self->get_license_info() unless $self->{licenses};

  my $photos_iterator =
    $self->get_photos_page( $user, 'flickr.people.getPublicPhotos',
    $params_ref );

  $self->{error} = undef;
  my $photo_page = $photos_iterator->next;
  my @photo_ids  = keys %{ $photo_page->{photos}->{photo} };

  iterator {
    my $photo_id = shift @photo_ids;

    unless ( defined $photo_id ) {
      $photo_page = $photos_iterator->next;

      if ( defined $photo_page ) {
        @photo_ids = keys %{ $photo_page->{photos}->{photo} };
        $photo_id  = shift @photo_ids;
      }
    }

    if ( defined $photo_id ) {
      $photo_page->{photos}->{photo}->{$photo_id}->{urls} =
        $self->build_photo_urls( $photo_id,
        $photo_page->{photos}->{photo}->{$photo_id} );

      $photo_page->{photos}->{photo}->{$photo_id}->{photo_id} = $photo_id;

      return $photo_page->{photos}->{photo}->{$photo_id};
    }
  }
}

sub build_photo_urls {
  my $self = shift;
  my ( $photo_id, $photo_ref ) = @_;

  my $urls = {};

  my $base_url = sprintf "http://farm%s.static.flickr.com/%s/%s_",
    $photo_ref->{farm},
    $photo_ref->{server},
    $photo_id;

  $urls->{smallsquare} = sprintf "%s%s_s.jpg", $base_url, $photo_ref->{secret};
  $urls->{thumbnail}   = sprintf "%s%s_t.jpg", $base_url, $photo_ref->{secret};
  $urls->{small}       = sprintf "%s%s_m.jpg", $base_url, $photo_ref->{secret};
  $urls->{medium}      = sprintf "%s%s.jpg",   $base_url, $photo_ref->{secret};
  $urls->{large}       = sprintf "%s%s_b.jpg", $base_url, $photo_ref->{secret};

  if ( $base_url
    && $photo_ref->{originalsecret}
    && $photo_ref->{originalformat} )
  {
    $urls->{original} = sprintf "%s%s_o.%s", $base_url,
      $photo_ref->{originalsecret}, $photo_ref->{originalformat};
  }

  return $urls;
}

sub get_photo_sizes {
  my $self     = shift;
  my $photo_id = shift;

  my $url      = {};
  my $response = $self->request(
    'flickr.photos.getSizes',
    { photo_id   => $photo_id },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_photo_detail', 1 ) };

  return $response->{sizes}->{size} unless $self->{error};
}

sub get_photo_contexts {
  my $self     = shift;
  my $photo_id = shift;

  my $context  = {};
  my $response = $self->request(
    'flickr.photos.getAllContexts',
    { photo_id   => $photo_id },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();

      foreach my $tmp_context ( keys %$response ) {
        next unless ( $tmp_context =~ /^(?:set|pool)$/ );
        $context->{$tmp_context}->{ $response->{$tmp_context}->{title} } =
          $response->{$tmp_context}->{id};
      }
    }
    else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_photo_detail', 1 ) };

  return $context unless $self->{error};
}

sub get_photo_tags {
  my $self = shift;
  my $tags = shift;

  my $tmp_tags;

  foreach my $tag_id ( keys %{ $tags->{tag} } ) {
    if ( exists $tags->{tag}->{$tag_id}
      && UNIVERSAL::isa( $tags->{tag}->{$tag_id}, "HASH" ) )
    {
      $tmp_tags->{$tag_id} = {
        'content' => $tags->{tag}->{$tag_id}->{content},
        'author'  => $tags->{tag}->{$tag_id}->{author},
        'raw'     => $tags->{tag}->{$tag_id}->{raw}
      };
    }
    else {

# some Flickr accounts don't seem to be missing the tag id so we have to pretend we have one:
      $tmp_tags->{1234567890} = {
        'content' => $tags->{tag}->{content},
        'author'  => $tags->{tag}->{author},
        'raw'     => $tags->{tag}->{raw}
      };
    }
  }

  return $tmp_tags;
}

#------------------------------

sub get_photoset_list {
  my $self    = shift;
  my $user_id = shift;

  my $tmp_photoset_list_ref;
  my $response = $self->request(
    'flickr.photosets.getList',
    { user_id    => $user_id },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();

      foreach my $photoset_id ( keys %{ $response->{photosets}->{photoset} } ) {
        $tmp_photoset_list_ref->{ $photoset_id } = {
          'id' => $photoset_id,
          'title' => $response->{photosets}->{photoset}->{$photoset_id}->{title},
          'primary' =>
            $response->{photosets}->{photoset}->{$photoset_id}->{primary},
          'photos' =>
            $response->{photosets}->{photoset}->{$photoset_id}->{photos},
          'secret' =>
            $response->{photosets}->{photoset}->{$photoset_id}->{secret},
          'farm' => $response->{photosets}->{photoset}->{$photoset_id}->{farm},
          'description' =>
            $response->{photosets}->{photoset}->{$photoset_id}->{description},
          'videos' =>
            $response->{photosets}->{photoset}->{$photoset_id}->{videos},
          'server' =>
            $response->{photosets}->{photoset}->{$photoset_id}->{server},
            };
      }
    } else {
      throw 'Error';
    }
  } catch 'Default' => sub { $self->raise_error( $response, 'get_photoset_list', 1 ) };

  return $tmp_photoset_list_ref unless $self->{error};
}

sub get_photoset_photos {
  my $self       = shift;
  my $user       = shift;
  my $params_ref = shift;

  ${ $self->{licenses} } = $self->get_license_info() unless $self->{licenses};

  my $photos_iterator =
    $self->get_photos_page( $user, 'flickr.photosets.getPhotos', $params_ref );

  $self->{error} = undef;
  my $photo_page = $photos_iterator->next;
  my @photo_ids  = keys %{ $photo_page->{photoset}->{photo} };

  iterator {
    my $photo_id = shift @photo_ids;

    while ( defined $photo_id && $photo_id !~ m/^[[:digit:]]+$/ ) {
      $photo_id = shift @photo_ids;
    }

    unless ( defined $photo_id ) {
      $photo_page = $photos_iterator->next;

      if ( defined $photo_page ) {
        @photo_ids = keys %{ $photo_page->{photoset}->{photo} };
        $photo_id  = shift @photo_ids;
      }
    }

    if ( defined $photo_id
      && defined $photo_page->{photoset}->{photo}->{$photo_id} )
    {
      $photo_page->{photoset}->{photo}->{$photo_id}->{urls} =
        $self->build_photo_urls( $photo_id,
        $photo_page->{photoset}->{photo}->{$photo_id} );

      $photo_page->{photoset}->{photo}->{$photo_id}->{photo_id} = $photo_id;

      return $photo_page->{photoset}->{photo}->{$photo_id};
    }
  }
}

sub get_photoset_info {
  my $self    = shift;
  my $photoset_id = shift;

  my $tmp_photoset_info_ref;
  my $response = $self->request(
    'flickr.photosets.getInfo',
    { photoset_id    => $photoset_id },
    { forcearray => 0, keeproot => 0 }
  );

  try {
    if ( defined $response->{'stat'} && $response->{'stat'} eq 'ok' ) {
      $self->clear_error();
      $tmp_photoset_info_ref = $response->{'photoset'};
    } else {
      throw 'Error';
    }
  }
  catch 'Default' =>
    sub { $self->raise_error( $response, 'get_photoset_info', 1 ) };

  return $tmp_photoset_info_ref unless $self->{error};
}

#--------------------------

sub get_your_photos_not_in_set {
  my $self       = shift;
  my $user       = shift;
  my $params_ref = shift;

  ${ $self->{licenses} } = $self->get_license_info() unless $self->{licenses};
  $params_ref->{auth_token} = $self->{params}->{auth_token};

  my $photos_iterator =
    $self->get_photos_page( $user, 'flickr.photos.getNotInSet', $params_ref );
  $self->{error} = undef;
  my $photo_page = $photos_iterator->next;
  my @photo_ids  = keys %{ $photo_page->{photos}->{photo} };

  iterator {
    my $photo_id = shift @photo_ids;

    while ( defined $photo_id && $photo_id !~ m/^[[:digit:]]+$/ ) {
      $photo_id = shift @photo_ids;
    }

    unless ( defined $photo_id ) {
      $photo_page = $photos_iterator->next;

      if ( defined $photo_page ) {
        @photo_ids = keys %{ $photo_page->{photos}->{photo} };
        $photo_id  = shift @photo_ids;
      }
    }

    if ( defined $photo_id
      && defined $photo_page->{photos}->{photo}->{$photo_id} )
    {
      $photo_page->{photos}->{photo}->{$photo_id}->{urls} =
        $self->build_photo_urls( $photo_id,
        $photo_page->{photos}->{photo}->{$photo_id} );

      $photo_page->{photos}->{photo}->{$photo_id}->{photo_id} = $photo_id;

      return $photo_page->{photos}->{photo}->{$photo_id};
    }
  }
}

#------------------------------
1;