Permalink
Browse files

Converted distribution to dzil

  • Loading branch information...
1 parent 680f781 commit 912d4d343d7cc6a845b492fc131bbee0dd1c13c8 @xdg xdg committed Aug 18, 2011
Showing with 15 additions and 1,005 deletions.
  1. +2 −7 .gitignore
  2. +0 −39 Build.PL
  3. +0 −28 INSTALL
  4. +0 −201 LICENSE
  5. +0 −26 MANIFEST
  6. +0 −33 MANIFEST.SKIP
  7. +0 −33 META.yml
  8. +0 −22 Makefile.PL
  9. +0 −188 README
  10. +9 −0 dist.ini
  11. +0 −62 inc/Module/Build/WikiDoc.pm
  12. +4 −43 lib/POE/Component/Client/NNTP/Tail.pm
  13. +0 −231 lib/POE/Component/Client/NNTP/Tail.pod
  14. 0 xt/perlcriticrc → perlcritic.rc
  15. +0 −15 xt/critic.t
  16. +0 −29 xt/pod-coverage.t
  17. +0 −13 xt/pod-format.t
  18. +0 −21 xt/spelling.t
  19. +0 −14 xt/stopwords.txt
View
9 .gitignore
@@ -1,8 +1,3 @@
-Build
-_build/*
-Makefile
-blib/*
-pm_to_blib
-MANIFEST.bak
-Makefile.old
+/.build
+/POE-Component-Client-NNTP-Tail-*
cover_db
View
39 Build.PL
@@ -1,39 +0,0 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-use 5.006;
-use strict;
-use warnings;
-use lib 'inc';
-eval "require Pod::WikiDoc";
-my $class = $@ ? "Module::Build" : "Module::Build::WikiDoc";
-eval "require $class";
-my $build = $class->new(
- module_name => 'POE::Component::Client::NNTP::Tail',
- dist_author => 'David Golden <dagolden@cpan.org>',
- license => 'apache',
- create_readme => 1,
- create_makefile_pl => 'traditional',
- requires => {
- 'perl' => '5.006',
- 'Carp::POE' => 0,
- 'Params::Validate' => 0,
- 'POE' => 1.0,
- 'POE::Component::Client::NNTP' => 2.10,
- },
- build_requires => {
- 'Test::More' => 0.62,
- 'Email::Date::Format' => 1.002,
- 'Email::Simple' => 2.003,
- 'POE::Component::Server::NNTP' => 1.02,
- },
- meta_add => {
- no_index => {
- directory => [ qw/ examples inc t /],
- }
- },
-);
-$build->create_build_script;
View
28 INSTALL
@@ -1,28 +0,0 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-INSTALLATION
-
-This distribution may be installed via one of the following
-methods:
-
-
-1. If Build.PL exists and Module::Build is installed:
-
- perl Build.PL
- perl Build
- perl Build test
- perl Build install
-
-2. If Makefile.PL exists:
-
- perl Makefile.PL
- make
- make test
- make install
-
-If you are on a Windows machine you should use
-'nmake' or 'dmake' rather than 'make'.
View
201 LICENSE
@@ -1,201 +0,0 @@
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
View
26 MANIFEST
@@ -1,26 +0,0 @@
-Build.PL
-Changes
-examples/follow-cpan-testers.pl
-examples/remailer.pl
-examples/synopsis.pl
-inc/Module/Build/WikiDoc.pm
-INSTALL
-lib/POE/Component/Client/NNTP/Tail.pm
-lib/POE/Component/Client/NNTP/Tail.pod
-LICENSE
-Makefile.PL
-MANIFEST
-MANIFEST.SKIP
-META.yml
-README
-t/01-POE-Component-Client-NNTP-Tail.t
-t/dummy-server.t
-t/lib/DummyServer.pm
-t/optional-names.t
-Todo
-xt/critic.t
-xt/perlcriticrc
-xt/pod-coverage.t
-xt/pod-format.t
-xt/spelling.t
-xt/stopwords.txt
View
33 MANIFEST.SKIP
@@ -1,33 +0,0 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-# Version control files and dirs.
-\bRCS\b
-\bCVS\b
-,v$
-.svn/
-^.git
-
-# Generated by Perl module toolchain
-^MANIFEST\.(?!SKIP)
-^Makefile$
-^blib/
-^blibdirs$
-^PM_to_blib$
-^MakeMaker-\d
-^Build$
-^_build
-^cover_db
-^.*\.bat$
-
-# Temp, old, vi and emacs files.
-~$
-\.old$
-\#\.*\#$
-\.\#$
-\.swp$
-\.bak$
-^pod.*\.tmp$
View
33 META.yml
@@ -1,33 +0,0 @@
----
-name: POE-Component-Client-NNTP-Tail
-version: 0.01
-author:
- - 'David Golden <dagolden@cpan.org>'
-abstract: Sends events for new articles posted to an NNTP newsgroup
-license: apache
-resources:
- license: http://apache.org/licenses/LICENSE-2.0
-requires:
- Carp::POE: 0
- POE: 1
- POE::Component::Client::NNTP: 2.1
- Params::Validate: 0
- perl: 5.006
-build_requires:
- Email::Date::Format: 1.002
- Email::Simple: 2.003
- POE::Component::Server::NNTP: 1.02
- Test::More: 0.62
-provides:
- POE::Component::Client::NNTP::Tail:
- file: lib/POE/Component/Client/NNTP/Tail.pm
- version: 0.01
-generated_by: Module::Build version 0.280801
-meta-spec:
- url: http://module-build.sourceforge.net/META-spec-v1.2.html
- version: 1.2
-no_index:
- directory:
- - examples
- - inc
- - t
View
22 Makefile.PL
@@ -1,22 +0,0 @@
-# Note: this file was auto-generated by Module::Build::Compat version 0.2808_01
-require 5.006;
-use ExtUtils::MakeMaker;
-WriteMakefile
-(
- 'PL_FILES' => {},
- 'INSTALLDIRS' => 'site',
- 'NAME' => 'POE::Component::Client::NNTP::Tail',
- 'EXE_FILES' => [],
- 'VERSION_FROM' => 'lib/POE/Component/Client/NNTP/Tail.pm',
- 'PREREQ_PM' => {
- 'POE::Component::Client::NNTP' => '2.1',
- 'Email::Date::Format' => '1.002',
- 'Test::More' => '0.62',
- 'Params::Validate' => 0,
- 'POE::Component::Server::NNTP' => '1.02',
- 'Email::Simple' => '2.003',
- 'POE' => '1',
- 'Carp::POE' => 0
- }
- )
-;
View
188 README
@@ -1,188 +0,0 @@
-NAME
- POE::Component::Client::NNTP::Tail - Sends events for new articles
- posted to an NNTP newsgroup
-
-VERSION
- This documentation describes version 0.01.
-
-SYNOPSIS
- use POE qw( Component::Client::NNTP::Tail );
- use Email::Simple;
-
- POE::Component::Client::NNTP::Tail->spawn(
- NNTPServer => 'nntp.perl.org',
- Group => 'perl.cpan.testers',
- );
-
- POE::Session->create(
- package_states => [
- main => [qw(_start new_header got_article)]
- ],
- );
-
- POE::Kernel->run;
-
- # register for NNTP tail events
- sub _start {
- $_[KERNEL]->post( 'perl.cpan.testers' => 'register' );
- return;
- }
-
- # get articles with subject 'FAIL' as 'got_article' events
- sub new_header {
- my ($article_id, $lines) = @_[ARG0, ARG1];
- my $article = Email::Simple->new( join("\r\n", @$lines) );
- if ( $article->header('Subject') =~ /^FAIL/ ) {
- $_[KERNEL]->post(
- 'perl.cpan.testers' => 'get_article' => $article_id
- );
- }
- return;
- }
-
- # find and print perl version components to terminal
- sub got_article {
- my ($article_id, $lines) = @_[ARG0, ARG1];
- for my $text ( reverse @$lines ) {
- if ( $text =~ /^Summary of my perl5 \(([^)]+)\)/ ) {
- print "$1\n";
- last;
- }
- }
- return;
- }
-
-DESCRIPTION
- This component periodically polls an NNTP newsgroup and posts POE events
- to component listeners as new articles are available. These events
- contains the article ID and header text for the given articles. This
- component also facilitates retrieving the full text of a particular
- article of interest.
-
- Internally, it uses POE::Component::Client::NNTP to manage the NNTP
- session.
-
-USAGE
- Spawn a new component session for each newsgroup to follow. Send the
- "register" event to specify an event to sent back when new articles
- arrive. Handle the new article event. Optionally, send the "get_article"
- event to request the full text of the article.
-
- spawn
- POE::Component::Client::NNTP::Tail->spawn(
- NNTPServer => 'nntp.perl.org',
- Group => 'perl.cpan.testers',
- );
-
- The "spawn" class method launches a new POE::Session to follow a given
- newsgroup. The "NNTPServer" and "Group" arguments are required, all
- other arguments are optional:
-
- * NNTPServer (required) -- name or IP address of the NNTP server
-
- * Group (required) -- newsgroup to follow
-
- * Interval -- minimum number of seconds between checks for new
- messages (defaults to 60)
-
- * Alias -- POE::Session alias name (defaults to the newsgroup name)
-
- * Port -- server port for NNTP connections
-
- * LocalAddr -- local address for outbound IP connection
-
- * Debug -- if true, a trace of events and arguments will be printed to
- STDERR
-
- You must spawn multiple times to follow multiple newsgroups.
-
-INPUT EVENTS
- The component will respond to the following events.
-
- register
- $_[KERNEL]->post( 'perl.cpan.testers' => register => $event_name );
-
- This event notifies the component to post a "new_header" event to the
- sender when new articles arrive. The event will be sent using the
- $event_name provided, or will default to 'new_header'. Multiple sessions
- may register with a single POE::Component::Client::NNTP::Tail session.
-
- unregister
- $_[KERNEL]->post( 'perl.cpan.testers' => unregister );
-
- This event will stop the component from posting new_header events to the
- sender.
-
- get_article
- $_[KERNEL]->post(
- 'perl.cpan.testers' => get_article => $article_id => $event_name
- );
-
- This event requests that the full text of $article_id be returned in a
- "got_article" event. The event will be sent using the $event_name
- provided, or will default to 'got_article'.
-
- shutdown
- $_[KERNEL]->post( 'perl.cpan.testers' => 'shutdown' );
-
- This event requests that the component stop broadcasting events,
- disconnect from the NNTP server and generally stop processing.
-
-OUTPUT EVENTS
- The component sends the following events types, though the actual event
- name may be different depending on what is specified in the "register"
- and "get_article" events.
-
- new_header
- ($article_id, $lines) = @_[ARG0, ARG1];
-
- The "new_header" event is sent when new articles are found in the
- newsgroup. The $lines argument is a reference to an array of lines that
- contain the article header. Lines have had newlines removed.
-
- got_article
- ($article_id, $lines) = @_[ARG0, ARG1];
-
- The "got_article" event is sent when the full text of an article is
- retrieved. The $lines argument is a reference to an array of lines that
- contain the full article, including header and body text. Lines have had
- newlines removed.
-
-BUGS
- Please report any bugs or feature using the CPAN Request Tracker. Bugs
- can be submitted through the web interface at
- <http://rt.cpan.org/Dist/Display.html?Queue=POE-Component-Client-NNTP-Ta
- il>
-
- When submitting a bug or request, please include a test-file or a patch
- to an existing test-file that illustrates the bug or desired feature.
-
-SEE ALSO
- * POE
-
- * POE::Component::Client::NNTP
-
-AUTHOR
- David A. Golden (DAGOLDEN)
-
- Portions based on or inspired by code in
- POE::Component::SmokeBox::Uploads::NNTP by Chris Williams.
-
-COPYRIGHT AND LICENSE
- Copyright (c) 2008 by David A. Golden. All rights reserved.
-
- Licensed under Apache License, Version 2.0 (the "License"). You may not
- use this file except in compliance with the License. A copy of the
- License was distributed with this file or you may obtain a copy of the
- License from http://www.apache.org/licenses/LICENSE-2.0
-
- Files produced as output though the use of this software, shall not be
- considered Derivative Works, but shall be considered the original work
- of the Licensor.
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
View
9 dist.ini
@@ -0,0 +1,9 @@
+name = POE-Component-Client-NNTP-Tail
+author = David Golden <dagolden@cpan.org>
+license = Apache_2_0
+copyright_holder = David Golden
+
+[@DAGOLDEN]
+:version = 0.018
+
+[CriticTests]
View
62 inc/Module/Build/WikiDoc.pm
@@ -1,62 +0,0 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-package Module::Build::WikiDoc;
-use strict;
-use base qw/Module::Build/;
-use File::Spec;
-
-sub ACTION_wikidoc {
- my $self = shift;
- eval "use Pod::WikiDoc";
- if ( $@ eq '' ) {
- my $parser = Pod::WikiDoc->new({
- comment_blocks => 1,
- keywords => { VERSION => $self->dist_version },
- });
- for my $src ( keys %{ $self->find_pm_files() } ) {
- (my $tgt = $src) =~ s{\.pm$}{.pod};
- $parser->filter( {
- input => $src,
- output => $tgt,
- });
- print "Creating $tgt\n";
- $tgt =~ s{\\}{/}g;
- $self->_add_to_manifest( 'MANIFEST', $tgt );
- }
- }
- else {
- warn "Pod::WikiDoc not available. Skipping wikidoc.\n";
- }
-}
-
-sub ACTION_test {
- my $self = shift;
- my $missing_pod;
- for my $src ( keys %{ $self->find_pm_files() } ) {
- (my $tgt = $src) =~ s{\.pm$}{.pod};
- $missing_pod = 1 if ! -e $tgt;
- }
- if ( $missing_pod ) {
- $self->depends_on('wikidoc');
- $self->depends_on('build');
- }
- $self->SUPER::ACTION_test;
-}
-
-sub ACTION_testpod {
- my $self = shift;
- $self->depends_on('wikidoc');
- $self->SUPER::ACTION_testpod;
-}
-
-sub ACTION_distmeta {
- my $self = shift;
- $self->depends_on('wikidoc');
- $self->SUPER::ACTION_distmeta;
-}
-
-1;
View
47 lib/POE/Component/Client/NNTP/Tail.pm
@@ -1,16 +1,9 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
package POE::Component::Client::NNTP::Tail;
use 5.006;
use strict;
use warnings;
-
-our $VERSION = '0.01';
-$VERSION = eval $VERSION; ## no critic
+# ABSTRACT: Sends events for new articles posted to an NNTP newsgroup
+# VERSION
use Carp::POE;
use Params::Validate;
@@ -326,15 +319,9 @@ sub _nntp_got_article {
__END__
-=begin wikidoc
-
-= NAME
+=pod
-POE::Component::Client::NNTP::Tail - Sends events for new articles posted to an NNTP newsgroup
-
-= VERSION
-
-This documentation describes version %%VERSION%%.
+=begin wikidoc
= SYNOPSIS
@@ -495,32 +482,6 @@ existing test-file that illustrates the bug or desired feature.
* [POE]
* [POE::Component::Client::NNTP]
-= AUTHOR
-
-David A. Golden (DAGOLDEN)
-
-Portions based on or inspired by code in
-POE::Component::SmokeBox::Uploads::NNTP by Chris Williams.
-
-= COPYRIGHT AND LICENSE
-
-Copyright (c) 2008 by David A. Golden. All rights reserved.
-
-Licensed under Apache License, Version 2.0 (the "License").
-You may not use this file except in compliance with the License.
-A copy of the License was distributed with this file or you may obtain a
-copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-Files produced as output though the use of this software, shall not be
-considered Derivative Works, but shall be considered the original work of the
-Licensor.
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
=end wikidoc
=cut
View
231 lib/POE/Component/Client/NNTP/Tail.pod
@@ -1,231 +0,0 @@
-# Generated by Pod::WikiDoc version 0.18
-
-=pod
-
-=head1 NAME
-
-POE::Component::Client::NNTP::Tail - Sends events for new articles posted to an NNTP newsgroup
-
-=head1 VERSION
-
-This documentation describes version 0.01.
-
-=head1 SYNOPSIS
-
- use POE qw( Component::Client::NNTP::Tail );
- use Email::Simple;
-
- POE::Component::Client::NNTP::Tail->spawn(
- NNTPServer => 'nntp.perl.org',
- Group => 'perl.cpan.testers',
- );
-
- POE::Session->create(
- package_states => [
- main => [qw(_start new_header got_article)]
- ],
- );
-
- POE::Kernel->run;
-
- # register for NNTP tail events
- sub _start {
- $_[KERNEL]->post( 'perl.cpan.testers' => 'register' );
- return;
- }
-
- # get articles with subject 'FAIL' as 'got_article' events
- sub new_header {
- my ($article_id, $lines) = @_[ARG0, ARG1];
- my $article = Email::Simple->new( join("\r\n", @$lines) );
- if ( $article->header('Subject') =~ /^FAIL/ ) {
- $_[KERNEL]->post(
- 'perl.cpan.testers' => 'get_article' => $article_id
- );
- }
- return;
- }
-
- # find and print perl version components to terminal
- sub got_article {
- my ($article_id, $lines) = @_[ARG0, ARG1];
- for my $text ( reverse @$lines ) {
- if ( $text =~ /^Summary of my perl5 \(([^)]+)\)/ ) {
- print "$1\n";
- last;
- }
- }
- return;
- }
-
-=head1 DESCRIPTION
-
-This component periodically polls an NNTP newsgroup and posts POE events to
-component listeners as new articles are available. These events contains the
-article ID and header text for the given articles. This component also
-facilitates retrieving the full text of a particular article of interest.
-
-Internally, it uses L<POE::Component::Client::NNTP> to manage the NNTP session.
-
-=head1 USAGE
-
-Spawn a new component session for each newsgroup to follow. Send the
-C<<< register >>> event to specify an event to sent back when new articles arrive.
-Handle the new article event. Optionally, send the C<<< get_article >>> event to
-request the full text of the article.
-
-=head2 spawn
-
- POE::Component::Client::NNTP::Tail->spawn(
- NNTPServer => 'nntp.perl.org',
- Group => 'perl.cpan.testers',
- );
-
-The C<<< spawn >>> class method launches a new POE::Session to follow a given
-newsgroup. The C<<< NNTPServer >>> and C<<< Group >>> arguments are required, all other
-arguments are optional:
-
-=over
-
-=item *
-
-NNTPServer (required) -- name or IP address of the NNTP server
-
-=item *
-
-Group (required) -- newsgroup to follow
-
-=item *
-
-Interval -- minimum number of seconds between checks for new messages
-(defaults to 60)
-
-=item *
-
-Alias -- POE::Session alias name (defaults to the newsgroup name)
-
-=item *
-
-Port -- server port for NNTP connections
-
-=item *
-
-LocalAddr -- local address for outbound IP connection
-
-=item *
-
-Debug -- if true, a trace of events and arguments will be printed to STDERR
-
-=back
-
-You must spawn multiple times to follow multiple newsgroups.
-
-=head1 INPUT EVENTS
-
-The component will respond to the following events.
-
-=head2 register
-
- $_[KERNEL]->post( 'perl.cpan.testers' => register => $event_name );
-
-This event notifies the component to post a C<<< new_header >>> event to the sender
-when new articles arrive. The event will be sent using the C<<< $event_name >>>
-provided, or will default to 'new_header'. Multiple sessions may register
-with a single POE::Component::Client::NNTP::Tail session.
-
-=head2 unregister
-
- $_[KERNEL]->post( 'perl.cpan.testers' => unregister );
-
-This event will stop the component from posting new_header events to the
-sender.
-
-=head2 get_article
-
- $_[KERNEL]->post(
- 'perl.cpan.testers' => get_article => $article_id => $event_name
- );
-
-This event requests that the full text of C<<< $article_id >>> be returned in a
-C<<< got_article >>> event. The event will be sent using the C<<< $event_name >>>
-provided, or will default to 'got_article'.
-
-=head2 shutdown
-
- $_[KERNEL]->post( 'perl.cpan.testers' => 'shutdown' );
-
-This event requests that the component stop broadcasting events,
-disconnect from the NNTP server and generally stop processing.
-
-=head1 OUTPUT EVENTS
-
-The component sends the following events types, though the actual event
-name may be different depending on what is specified in the C<<< register >>> and
-C<<< get_article >>> events.
-
-=head2 new_header
-
- ($article_id, $lines) = @_[ARG0, ARG1];
-
-The C<<< new_header >>> event is sent when new articles are found in the newsgroup.
-The C<<< $lines >>> argument is a reference to an array of lines that contain the
-article header. Lines have had newlines removed.
-
-=head2 got_article
-
- ($article_id, $lines) = @_[ARG0, ARG1];
-
-The C<<< got_article >>> event is sent when the full text of an article is retrieved.
-The C<<< $lines >>> argument is a reference to an array of lines that contain the full
-article, including header and body text. Lines have had newlines removed.
-
-=head1 BUGS
-
-Please report any bugs or feature using the CPAN Request Tracker.
-Bugs can be submitted through the web interface at
-L<http://rt.cpan.org/Dist/Display.html?Queue=POE-Component-Client-NNTP-Tail>
-
-When submitting a bug or request, please include a test-file or a patch to an
-existing test-file that illustrates the bug or desired feature.
-
-=head1 SEE ALSO
-
-=over
-
-=item *
-
-L<POE>
-
-=item *
-
-L<POE::Component::Client::NNTP>
-
-=back
-
-=head1 AUTHOR
-
-David A. Golden (DAGOLDEN)
-
-Portions based on or inspired by code in
-POE::Component::SmokeBox::Uploads::NNTP by Chris Williams.
-
-=head1 COPYRIGHT AND LICENSE
-
-Copyright (c) 2008 by David A. Golden. All rights reserved.
-
-Licensed under Apache License, Version 2.0 (the "License").
-You may not use this file except in compliance with the License.
-A copy of the License was distributed with this file or you may obtain a
-copy of the License from http:E<sol>E<sol>www.apache.orgE<sol>licensesE<sol>LICENSE-2.0
-
-Files produced as output though the use of this software, shall not be
-considered Derivative Works, but shall be considered the original work of the
-Licensor.
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-
View
0 xt/perlcriticrc → perlcritic.rc
File renamed without changes.
View
15 xt/critic.t
@@ -1,15 +0,0 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-use strict;
-use warnings;
-use File::Spec;
-use Test::More;
-require Test::Perl::Critic;
-
-my $rcfile = File::Spec->catfile( 'xt', 'perlcriticrc' );
-Test::Perl::Critic->import( -profile => $rcfile );
-all_critic_ok( 'lib', 'examples' );
View
29 xt/pod-coverage.t
@@ -1,29 +0,0 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-use Test::More;
-
-my $min_tpc = 1.08;
-eval "use Test::Pod::Coverage $min_tpc";
-plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage"
- if $@;
-
-my $min_pc = 0.17;
-eval "use Pod::Coverage $min_pc";
-plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage"
- if $@;
-
-my @modules = all_modules('lib');
-
-plan tests => scalar @modules;
-
-for my $mod ( @modules ) {
- my $doc = "lib/$mod";
- $doc =~ s{::}{/}g;
- $doc = -f "$doc\.pod" ? "$doc\.pod" : "$doc\.pm" ;
- pod_coverage_ok( $mod, { pod_from => $doc } );
-}
-
View
13 xt/pod-format.t
@@ -1,13 +0,0 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-use Test::More;
-
-my $min_tp = 1.22;
-eval "use Test::Pod $min_tp";
-plan skip_all => "Test::Pod $min_tp required for testing POD" if $@;
-
-all_pod_files_ok();
View
21 xt/spelling.t
@@ -1,21 +0,0 @@
-# Copyright (c) 2008 by David Golden. All rights reserved.
-# Licensed under Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License.
-# A copy of the License was distributed with this file or you may obtain a
-# copy of the License from http://www.apache.org/licenses/LICENSE-2.0
-
-use Test::More;
-use IO::File;
-
-my $min_tps = 0.11;
-eval "use Test::Spelling $min_tps";
-plan skip_all => "Test::Spelling $min_tps required for testing POD" if $@;
-system( "ispell -v" ) and plan skip_all => "No ispell";
-
-set_spell_cmd( "ispell -l" );
-
-my $swf = IO::File->new('xt/stopwords.txt');
-my @stopwords = grep { length } map { chomp; $_ } <$swf>;
-add_stopwords( @stopwords );
-
-all_pod_files_spelling_ok();
View
14 xt/stopwords.txt
@@ -1,14 +0,0 @@
-CPAN
-CTRL
-DAGOLDEN
-Foo
-Html
-IP
-LocalAddr
-MSWin
-NNTP
-NNTPServer
-README
-STDERR
-STDOUT
-XS

0 comments on commit 912d4d3

Please sign in to comment.