InfoSys::FreeDB::Response::Stat - FreeDB stat response

 require InfoSys::FreeDB;

 # Create a HTTP connection
 my $fact = InfoSys::FreeDB->new();
 my $conn = $fact->create_connection( {
     client_name => 'testing-InfoSys::FreeDB',
     client_version => $InfoSys::FreeDB::VERSION,
 } );

 # Get stat from FreeDB
 my $res = $conn->stat();

 # Write a bit of stat to STDERR
 use IO::Handle;
 my $fh = IO::Handle->new_from_fd( fileno(STDERR), 'w' );
 $fh->print( "\n", $res->get_proto_cur(), "\n" );

package InfoSys::FreeDB::Response::Stat;

use 5.006;
use base qw( InfoSys::FreeDB::Response );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);

our $STAT_DB_ENTRIES_RX = '^\s*database\s+entries\s*:\s*(\S+)';

our $STAT_GETS_RX = '^\s*gets\s*:\s*(\S+)';

our $STAT_POSTING_RX = '^\s*posting\s*:\s*(\S+)';

our $STAT_PROTO_CUR_RX = '^\s*current\s+proto\s*:\s*(\S+)';

our $STAT_PROTO_MAX_RX = '^\s*max\s+proto\s*:\s*(\S+)';

our $STAT_QUOTES_RX = '^\s*quotes\s*:\s*(\S+)';

our $STAT_STRIP_EXT = '^\s*strip\s+ext\s*:\s*(\S+)';

our $STAT_UPDATES_RX = '^\s*updates\s*:\s*(\S+)';

our $STAT_USERS_CUR_RX = '^\s*current\s+users\s*:\s*(\S+)';

our $STAT_USERS_MAX_RX = '^\s*max\s+users\s*:\s*(\S+)';

# Package version
our ($VERSION) = '$Revision: 0.92 $' =~ /\$Revision:\s+([^\s]+)/;

1;

__END__

sub new_from_content_ref {
    my $class = shift;
    my $content_ref = shift;

    # Convert $opt->{content_ref} to @content_ref
    my @content_ref = split(/[\n\r]+/, ${$content_ref} );

    # Parse first line
    my $line = shift(@content_ref);
    my ($code) = $line =~ /^\s*(\d{3})\s/;
    defined ($code) ||
        throw Error::Simple ('ERROR: InfoSys::FreeDB::Response::Stat::new_from_content_ref, first line of specified \'content_ref\' does not contain a code.');
    my %opt;
    if ($code == 210) {
        pop(@content_ref);
        %opt = (
            code => $code,
            result => 'Ok',
            message_text => join("\n", @content_ref),
        );

        foreach my $line (@content_ref) {
            my $val;
            if ( ($val) = $line =~ /$STAT_DB_ENTRIES_RX/i ) {
                $opt{database_entries} = $val;
                last;
            }
            elsif ( ($val) = $line =~ /$STAT_GETS_RX/i ) {
                $opt{gets} = $val =~ /yes/i;
                next;
            }
            elsif ( ($val) = $line =~ /$STAT_POSTING_RX/i ) {
                $opt{posting} = $val =~ /yes/i;
                next;
            }
            elsif ( ($val) = $line =~ /$STAT_PROTO_CUR_RX/i ) {
                $opt{proto_cur} = $val;
                next;
            }
            elsif ( ($val) = $line =~ /$STAT_PROTO_MAX_RX/i ) {
                $opt{proto_max} = $val;
                next;
            }
            elsif ( ($val) = $line =~ /$STAT_QUOTES_RX/i ) {
                $opt{quotes} = $val =~ /yes/i;
                next;
            }
            elsif ( ($val) = $line =~ /$STAT_STRIP_EXT/i ) {
                $opt{strip_ext} = $val =~ /yes/i;
                next;
            }
            elsif ( ($val) = $line =~ /$STAT_USERS_CUR_RX/i ) {
                $opt{users_cur} = $val;
                next;
            }
            elsif ( ($val) = $line =~ /$STAT_USERS_MAX_RX/i ) {
                $opt{users_max} = $val;
                next;
            }
        }
    }
    else {
        throw Error::Simple ("ERROR: InfoSys::FreeDB::Response::Stat::new_from_content_ref, unknown code '$code' returned. Allowed code is 210.");
    }

    # Create a new object and return it
    return( $class->new( \%opt ) );
}

sub _initialize {
    my $self = shift;
    my $opt = defined($_[0]) ? shift : {};

    # Check $opt
    ref($opt) eq 'HASH' || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::Stat::_initialize, first argument must be 'HASH' reference.");

    # database_entries, SINGLE
    exists( $opt->{database_entries} ) && $self->set_database_entries( $opt->{database_entries} );

    # gets, BOOLEAN
    exists( $opt->{gets} ) && $self->set_gets( $opt->{gets} );

    # posting, BOOLEAN
    exists( $opt->{posting} ) && $self->set_posting( $opt->{posting} );

    # proto_cur, SINGLE
    exists( $opt->{proto_cur} ) && $self->set_proto_cur( $opt->{proto_cur} );

    # proto_max, SINGLE
    exists( $opt->{proto_max} ) && $self->set_proto_max( $opt->{proto_max} );

    # quotes, BOOLEAN
    exists( $opt->{quotes} ) && $self->set_quotes( $opt->{quotes} );

    # strip_ext, BOOLEAN
    exists( $opt->{strip_ext} ) && $self->set_strip_ext( $opt->{strip_ext} );

    # updates, BOOLEAN
    exists( $opt->{updates} ) && $self->set_updates( $opt->{updates} );

    # users_cur, SINGLE
    exists( $opt->{users_cur} ) && $self->set_users_cur( $opt->{users_cur} );

    # users_max, SINGLE
    exists( $opt->{users_max} ) && $self->set_users_max( $opt->{users_max} );

    # Call the superclass' _initialize
    $self->SUPER::_initialize($opt);

    # Return $self
    return($self);
}

sub _value_is_allowed {
    return(1);
}

sub get_database_entries {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response_Stat}{database_entries} );
}

sub get_proto_cur {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response_Stat}{proto_cur} );
}

sub get_proto_max {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response_Stat}{proto_max} );
}

sub get_users_cur {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response_Stat}{users_cur} );
}

sub get_users_max {
    my $self = shift;

    return( $self->{InfoSys_FreeDB_Response_Stat}{users_max} );
}

sub is_gets {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response_Stat}{gets} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_posting {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response_Stat}{posting} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_quotes {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response_Stat}{quotes} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_strip_ext {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response_Stat}{strip_ext} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_updates {
    my $self = shift;

    if ( $self->{InfoSys_FreeDB_Response_Stat}{updates} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub set_database_entries {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'database_entries', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::Stat::set_database_entries, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response_Stat}{database_entries} = $val;
}

sub set_gets {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response_Stat}{gets} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response_Stat}{gets} = 0;
    }
}

sub set_posting {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response_Stat}{posting} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response_Stat}{posting} = 0;
    }
}

sub set_proto_cur {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'proto_cur', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::Stat::set_proto_cur, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response_Stat}{proto_cur} = $val;
}

sub set_proto_max {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'proto_max', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::Stat::set_proto_max, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response_Stat}{proto_max} = $val;
}

sub set_quotes {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response_Stat}{quotes} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response_Stat}{quotes} = 0;
    }
}

sub set_strip_ext {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response_Stat}{strip_ext} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response_Stat}{strip_ext} = 0;
    }
}

sub set_updates {
    my $self = shift;

    if (shift) {
        $self->{InfoSys_FreeDB_Response_Stat}{updates} = 1;
    }
    else {
        $self->{InfoSys_FreeDB_Response_Stat}{updates} = 0;
    }
}

sub set_users_cur {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'users_cur', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::Stat::set_users_cur, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response_Stat}{users_cur} = $val;
}

sub set_users_max {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'users_max', $val ) || throw Error::Simple("ERROR: InfoSys::FreeDB::Response::Stat::set_users_max, the specified value '$val' is not allowed.");

    # Assignment
    $self->{InfoSys_FreeDB_Response_Stat}{users_max} = $val;
}