Changes and simple fix

[cascardo/www-eztv.git] / lib / WWW / EZTV.pm

diff --git a/lib/WWW/EZTV.pm b/lib/WWW/EZTV.pm
index 67debca..d2bde1f 100644 (file)
--- a/lib/WWW/EZTV.pm
+++ b/lib/WWW/EZTV.pm
@@ -3,18 +3,21 @@ use Moose;
 with 'WWW::EZTV::UA';
 use WWW::EZTV::Show;
 
+# ABSTRACT: EZTV scrapper
+
 has url       => ( is => 'ro', lazy => 1, default => sub { Mojo::URL->new('http://eztv.it/') } );
 has url_shows => ( is => 'ro', lazy => 1, default => sub { shift->url->clone->path('/showlist/') } );
+
 has shows => 
     is      => 'ro',
     lazy    => 1,
-    default => \&build_shows,
+    builder => '_build_shows',
     handles => {
         find_show    => 'first',
         has_shows    => 'size',
     };
 
-sub build_shows {
+sub _build_shows {
     my $self = shift;
 
     $self->get_response( $self->url_shows )->dom->find('table.forum_header_border tr[name="hover"]')->map(sub {
@@ -30,3 +33,63 @@ sub build_shows {
 }
 
 1;
+
+=head1 SYNOPSIS
+
+First create a WWW::EZTV object to navigate.
+
+    use WWW::EZTV;
+
+    my $eztv = WWW::EZTV->new;
+
+    my $show = $eztv->find_show(sub{ $_->name =~ /Walking dead/i });
+
+    my $episode = $show->find_episode(sub{ 
+        $_->season == 3 && 
+        $_->number == 8 && 
+        $_->quality eq 'standard' 
+    });
+
+=attr url
+
+EZTV URL.
+
+=cut
+
+=attr url_shows
+
+EZTV shows URL.
+
+=cut
+
+=attr shows
+
+L<Mojo::Collection> of L<WWW::EZTV::Show> objects.
+
+=cut
+
+=attr has_shows
+
+How many shows exists.
+
+=cut
+
+=method find_show
+
+Find first L<WWW::EZTV::Show> object matching the given criteria. 
+This method accept an anon function.
+
+=cut
+
+=head1 BUGS
+
+This is an early release, so probable there are plenty of bugs around.
+If you found one, please report it on RT or at the github repo:
+
+L<https://github.com/diegok/www-eztv>
+
+Pull requests are also very welcomed, but please include tests demostrating
+what you've fixed.
+
+=cut
+