File Coverage

blib/lib/Yahoo/Music/Ratings.pm

Criterion	Covered	Total	%
statement	4	6	66.6
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	6	8	75.0

package Yahoo::Music::Ratings;

use LWP::UserAgent;
use XML::Simple;
use strict;
use warnings;

our $VERSION = '2.00';


# Preloaded methods go here.

sub new {
    my $class = shift;
    my $this = bless {}, $class;

    # Set sessions options
    $this->{options} = shift;

    print '-' x 80,
          "\nYahoo::Music::Ratings Progress Output Enabled\n",
          '-' x 80,
          "\n" if $this->{options}->{progress};

    return $this;
}

sub findMemberId {
    my $this = shift;

    unless ( $this->{memberid} ){
        my $ua = LWP::UserAgent->new;
        $ua->timeout(10);
        $ua->env_proxy;

        $ua->max_redirect(0);

        my $url = 'http://music.yahoo.com/launchcast/membersearch.asp?memberName='.$this->{options}->{memberName};
        print "Fetching web page\n" if $this->{options}->{progress};
        my $response = $ua->get( $url );

        if ($response->is_success) {
            #print $response->status_line;
            $this->{errorMessage} = "\nLooks like either Yahoo is down, the membername provided is down or they've changed their site which means this module no longer works. Sorry :(";
            print "$this->{errorMessage}\n" if $this->{options}->{progress};
            return( 0 );
        }
        else {
            ($this->{memberid}) = $response->header('Location') =~ m/station\.asp\?u=(\d+)/g;
            print "Found $this->{options}->{memberName}'s memberId: $this->{memberid}\n" if $this->{options}->{progress};
            return( $this->{memberid} );
        }
    }
}

# Backward Compatibility with version 1.00
sub getRatings {
    my $this = shift;
    return $this->getSongs();
}

# Display a list of Song Rankings
sub getSongs {
    my $this = shift;

    # Check if we have a member id, if not, return 0
    return 0 unless $this->_checkIfMemberId() ;

    # Reset the data hash as to not colide with old data
    undef($this->{data});

    print "Loading Ratings Pages\n" if $this->{options}->{progress};
    if ( $this->_parseRatings( 0, 1 ) ){
        for(my $i=1; $i < $this->{totalPages}; $i++){
            $this->_parseRatings( $i, 1 );
        }

        return( $this->{data} );
    }
    else {
        return( 0 );
    }

}

# Display a list of Album Rankings
sub getAlbums {
    my $this = shift;

    # Check if we have a member id, if not, return 0
    return 0 unless $this->_checkIfMemberId() ;

    # Reset the data hash as to not colide with old data
    undef($this->{data});

    print "Loading Ratings Pages\n" if $this->{options}->{progress};
    if ( $this->_parseRatings( 0, 2 ) ){
        for(my $i=1; $i < $this->{totalPages}; $i++){
            $this->_parseRatings( $i, 2 );
        }

        return( $this->{data} );
    }
    else {
        return( 0 );
    }

}

# Display a list of Artist Rankings
sub getArtists {
    my $this = shift;

    # Check if we have a member id, if not, return 0
    return 0 unless $this->_checkIfMemberId() ;

    # Reset the data hash as to not colide with old data
    undef($this->{data});

    print "Loading Ratings Pages\n" if $this->{options}->{progress};
    if ( $this->_parseRatings( 0, 3 ) ){
        for(my $i=1; $i < $this->{totalPages}; $i++){
            $this->_parseRatings( $i, 3 );
        }

        return( $this->{data} );
    }
    else {
        return( 0 );
    }

}

# Display a list of Song Rankings
sub getGenres {
    my $this = shift;

    # Check if we have a member id, if not, return 0
    return 0 unless $this->_checkIfMemberId() ;

    $this->{errorMessage} = "Genre Listing Is not Yet Enabled. This is partly becuase Yahoo has yet to provide much of usfulness.";
    print "$this->{errorMessage}\n" if $this->{options}->{progress};

    return( 0 );

}

# Internal Function to check if we have a member ID yet.
sub _checkIfMemberId {
    my $this = shift;

    # check to see if we have a memberId for this user,
    # if not fetch one
    unless ( $this->{memberid} ){
        unless ( $this->findMemberId() ){
            # if we were unable to fetch a memberId then return negativly
            # User should check $foo->error_message() for errors
            return( 0 );
        }
    }
}

# Parse Yahoo XML feed
# Arguments:
#	int, pageNumber
#	int, search type - 1 = song
#                      2 = album
#                      3 = artist
#                      4 = genre
sub _parseRatings {
    my $this = shift;
    my $page = shift;
    my $type = shift;

    my $xs = new XML::Simple();
    my $ua = LWP::UserAgent->new;
    $ua->timeout(10);
    $ua->env_proxy;

    my $url = 'http://yme.us.music.yahoo.com/profile/rating_xml.asp?type='. $type .'&uid='. $this->{memberid} .'&p='. $page .'&g=undefined>=1';
    print "Fetching web page " if $this->{options}->{progress};

    my $response = $ua->get( $url );

    if ($response->is_success) {
        my $ref = $xs->XMLin( $response->content );

        # Search for type 1, songs
        if ($type == 1){
            $this->{totalPages} = $ref->{SONG_RATINGS}->{SONG_RATING_LIST}->{POSITION}->{PAGES}->{TOTAL};
            $this->{currentPage} = $ref->{SONG_RATINGS}->{SONG_RATING_LIST}->{POSITION}->{PAGES}->{CURRENT};
            print "$this->{currentPage} of $this->{totalPages}\n" if $this->{options}->{progress};

            foreach my $elem (@{$ref->{SONG_RATINGS}->{SONG_RATING_LIST}->{LIST}->{LIST_ROW}}) {
                #  {
                #	'VIEWER_RATING' => {
                #					   'VALUE' => '-1'
                #					 },
                #	'SONG' => {
                #			  'ID' => '319952',
                #			  'ALBUM' => {
                #						 'ID' => '115213',
                #						 'NAME' => 'The Slim Shady LP (Edited)'
                #					   },
                #			  'NAME' => 'My Name Is',
                #			  'HAS_SAMPLE' => {},
                #			  'ARTIST' => {
                #						  'ID' => '289114',
                #						  'NAME' => 'Eminem'
                #						},
                #			  'HAS_TETHDOWNLOAD' => {},
                #			  'HAS_ODSTREAM' => {},
                #			  'HAS_PERMDOWNLOAD' => {}
                #			},
                #	'USER_RATING' => {
                #					 'VALUE' => '100'
                #				   }
                #  },

                push(@{$this->{data}}, [
                             $elem->{SONG}->{ARTIST}->{NAME},
                             $elem->{SONG}->{NAME},
                             $elem->{SONG}->{ALBUM}->{NAME},
                             $elem->{USER_RATING}->{VALUE},
                             ]);
            }

            return( 1 );
        }
        # Search for type 2, albums
        elsif ( $type == 2 ){
            $this->{totalPages} = $ref->{ALBUM_RATINGS}->{ALBUM_RATING_LIST}->{POSITION}->{PAGES}->{TOTAL};
            $this->{currentPage} = $ref->{ALBUM_RATINGS}->{ALBUM_RATING_LIST}->{POSITION}->{PAGES}->{CURRENT};
            print "$this->{currentPage} of $this->{totalPages}\n" if $this->{options}->{progress};

            foreach my $elem (@{$ref->{ALBUM_RATINGS}->{ALBUM_RATING_LIST}->{LIST}->{LIST_ROW}}) {
                #{
                #  'ALBUM' => {
                #               'ID' => '48792',
                #               'NAME' => 'New Adventures In Hi-Fi',
                #               'ARTIST' => {
                #                             'ID' => '261307',
                #                             'NAME' => 'R.E.M.'
                #                           }
                #             },
                #  'VIEWER_RATING' => {
                #                       'VALUE' => '-1'
                #                     },
                #  'USER_RATING' => {
                #                     'VALUE' => '90'
                #                   }
                #},

                push(@{$this->{data}}, [
                             $elem->{ALBUM}->{ARTIST}->{NAME},
                             $elem->{ALBUM}->{NAME},
                             $elem->{USER_RATING}->{VALUE},
                             ]);
            }

            return( 1 );
        }
        # Search for type 3, artist
        elsif ( $type == 3 ){
            $this->{totalPages} = $ref->{ARTIST_RATINGS}->{ARTIST_RATING_LIST}->{POSITION}->{PAGES}->{TOTAL};
            $this->{currentPage} = $ref->{ARTIST_RATINGS}->{ARTIST_RATING_LIST}->{POSITION}->{PAGES}->{CURRENT};
            print "$this->{currentPage} of $this->{totalPages}\n" if $this->{options}->{progress};

            foreach my $elem (@{$ref->{ARTIST_RATINGS}->{ARTIST_RATING_LIST}->{LIST}->{LIST_ROW}}) {
                #{
                #  'VIEWER_RATING' => {
                #                       'VALUE' => '-1'
                #                     },
                #  'ARTIST' => {
                #                'ID' => '314672',
                #                'NAME' => 'Bill Engvall'
                #              },
                #  'USER_RATING' => {
                #                     'VALUE' => '60'
                #                   }
                #},

                push(@{$this->{data}}, [
                             $elem->{ARTIST}->{NAME},
                             $elem->{USER_RATING}->{VALUE},
                             ]);
            }

            return( 1 );
        }
        # Search for type 4, genre
        elsif ( $type == 4 ){
            return( 0 );
        }
    }
    else {
        $this->{errorMessage} = "\nLooks like either Yahoo is down or they've changed their site which means this module no longer works. Sorry :(";
        print "$this->{errorMessage}\n" if $this->{options}->{progress};
        return( 0 );
    }
}

sub tab_output {
    my $this = shift;

    my @tabbed;

    foreach my $row (sort {uc($a->[0]) cmp uc($b->[0])} @{$this->{data}}){
        push(@tabbed, join("\t", @{$row} ) );
    }

    my $tabbed = join("\n", @tabbed);
    undef(@tabbed);
    return( $tabbed );
}

sub error_message {
    my $this = shift;
    return( $this->{errorMessage} );
}


1;
__END__