Annotation of HOPE/Net-OpenAMD/lib/Net/OpenAMD.pm, Revision 1.2
1.1 andrew 1: package Net::OpenAMD;
2:
1.2 ! andrew 3: # $AFresh1$
1.1 andrew 4:
5: use warnings;
6: use strict;
7: use Carp;
8:
9: use version; our $VERSION = qv('0.0.1');
10:
1.2 ! andrew 11: my $BASE_URL = 'https://api.hope.net/api/';
1.1 andrew 12:
1.2 ! andrew 13: use Class::Std::Utils;
1.1 andrew 14:
1.2 ! andrew 15: use LWP::UserAgent;
! 16: use Net::OAuth;
! 17: use JSON::Any;
1.1 andrew 18:
1.2 ! andrew 19: {
1.1 andrew 20:
1.2 ! andrew 21: my @attr_refs = \();
! 22:
! 23: sub new {
! 24: my ( $class, $options ) = @_;
! 25: my $self = bless anon_scalar(), $class;
! 26: my $ident = ident($self);
! 27:
! 28: return $self;
! 29: }
! 30:
! 31: sub _get { croak 'Unsupported' }
! 32:
! 33: sub location { my $self = shift; return $self->_get( 'location', @_ ) }
! 34: sub speakers { my $self = shift; return $self->_get( 'speakers', @_ ) }
! 35: sub talks { my $self = shift; return $self->_get( 'talks', @_ ) }
! 36: sub interests { my $self = shift; return $self->_get( 'interests', @_ ) }
! 37: sub users { my $self = shift; return $self->_get( 'users', @_ ) }
! 38: sub stats { croak 'Unused feature' }
! 39: }
! 40:
! 41: 1; # Magic true value required at end of module
1.1 andrew 42: __END__
43:
44: =head1 NAME
45:
1.2 ! andrew 46: Net::OpenAMD - Perl interface to the OpenAMD API
1.1 andrew 47:
48:
49: =head1 VERSION
50:
51: This document describes Net::OpenAMD version 0.0.1
52:
53:
54: =head1 SYNOPSIS
55:
56: use Net::OpenAMD;
57:
58: =for author to fill in:
59: Brief code example(s) here showing commonest usage(s).
60: This section will be as far as many users bother reading
61: so make it as educational and exeplary as possible.
62:
63:
64: =head1 DESCRIPTION
65:
1.2 ! andrew 66: This module is to make it easy to grab information from the OpenAMD project at
! 67: The Next Hope.
1.1 andrew 68:
1.2 ! andrew 69: http://amd.hope.net/
1.1 andrew 70:
71: =head1 INTERFACE
72:
73: =for author to fill in:
74: Write a separate section listing the public components of the modules
75: interface. These normally consist of either subroutines that may be
76: exported, or methods that may be called on objects belonging to the
77: classes provided by the module.
78:
79:
80: =head1 DIAGNOSTICS
81:
82: =for author to fill in:
83: List every single error and warning message that the module can
84: generate (even the ones that will "never happen"), with a full
85: explanation of each problem, one or more likely causes, and any
86: suggested remedies.
87:
88: =over
89:
90: =item C<< Error message here, perhaps with %s placeholders >>
91:
92: [Description of error here]
93:
94: =item C<< Another error message here >>
95:
96: [Description of error here]
97:
98: [Et cetera, et cetera]
99:
100: =back
101:
102:
103: =head1 CONFIGURATION AND ENVIRONMENT
104:
105: =for author to fill in:
106: A full explanation of any configuration system(s) used by the
107: module, including the names and locations of any configuration
108: files, and the meaning of any environment variables or properties
109: that can be set. These descriptions must also include details of any
110: configuration language used.
111:
112: Net::OpenAMD requires no configuration files or environment variables.
113:
114:
115: =head1 DEPENDENCIES
116:
1.2 ! andrew 117: =over
! 118:
! 119: =item LWP::UserAgent
! 120:
! 121: =item Net::OAuth
1.1 andrew 122:
1.2 ! andrew 123: =item JSON::Any
1.1 andrew 124:
1.2 ! andrew 125: =back
1.1 andrew 126:
127: =head1 INCOMPATIBILITIES
128:
129: =for author to fill in:
130: A list of any modules that this module cannot be used in conjunction
131: with. This may be due to name conflicts in the interface, or
132: competition for system or program resources, or due to internal
133: limitations of Perl (for example, many modules that use source code
134: filters are mutually incompatible).
135:
136: None reported.
137:
138:
139: =head1 BUGS AND LIMITATIONS
140:
141: =for author to fill in:
142: A list of known problems with the module, together with some
143: indication Whether they are likely to be fixed in an upcoming
144: release. Also a list of restrictions on the features the module
145: does provide: data types that cannot be handled, performance issues
146: and the circumstances in which they may arise, practical
147: limitations on the size of data sets, special cases that are not
148: (yet) handled, etc.
149:
150: No bugs have been reported.
151:
152: Please report any bugs or feature requests to
153: C<bug-net-openamd@rt.cpan.org>, or through the web interface at
154: L<http://rt.cpan.org>.
155:
156:
157: =head1 AUTHOR
158:
159: Andrew Fresh C<< <andrew@cpan.org> >>
160:
161:
162: =head1 LICENSE AND COPYRIGHT
163:
164: Copyright (c) 2010, Andrew Fresh C<< <andrew@cpan.org> >>. All rights reserved.
165:
166: This module is free software; you can redistribute it and/or
167: modify it under the same terms as Perl itself. See L<perlartistic>.
168:
169:
170: =head1 DISCLAIMER OF WARRANTY
171:
172: BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
173: FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
174: OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
175: PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
176: EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
177: WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
178: ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
179: YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
180: NECESSARY SERVICING, REPAIR, OR CORRECTION.
181:
182: IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
183: WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
184: REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
185: LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
186: OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
187: THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
188: RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
189: FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
190: SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
191: SUCH DAMAGES.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to OpenAMD.pm CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [local] / HOPE / Net-OpenAMD / lib / Net