File Coverage

blib/lib/ASP4/API.pm

Criterion	Covered	Total	%
statement	30	34	88.2
branch	2	4	50.0
condition			n/a
subroutine	11	15	73.3
pod	5	7	71.4
total	48	60	80.0

package ASP4::API;

use strict;
use warnings 'all';
use ASP4::ConfigLoader;
use ASP4::HTTPContext;
use ASP4::UserAgent;
use Data::Properties::YAML;
use ASP4::Test::Fixtures;

sub new
{
  my ($class) = @_;;

  my $config = ASP4::ConfigLoader->load;

  # Our test fixtures:
  my $test_data = ASP4::Test::Fixtures->new(
    properties_file => $config->web->application_root . '/etc/test_fixtures.yaml'
  ) if -f $config->web->application_root . '/etc/test_fixtures.yaml';

  # Our diagnostic messages:
  my $properties = Data::Properties::YAML->new(
    properties_file => $config->web->application_root . '/etc/properties.yaml'
  ) if -f $config->web->application_root . '/etc/properties.yaml';

  return bless {
    test_data   => $test_data,
    properties  => $properties,
    ua          => ASP4::UserAgent->new()
  }, $class;
}# end new()


sub test_data   { shift->{test_data} }
sub properties  { shift->{properties} }
sub ua          { shift->{ua} }
sub context     { ASP4::HTTPContext->current }
sub config      { ASP4::ConfigLoader->load }

sub data        { shift->test_data }    # Deprecated! - for Apache2::ASP compat only.


sub DESTROY
{
  my $s = shift;
  undef(%$s);
}# end DESTROY()

1;# return true:

=pod

=head1 NAME

ASP4::API - Your ASP4 Web App's Public API

=head1 SYNOPSIS

  #!/usr/bin/perl -w

  use strict;
  use warnings 'all';
  use ASP4::API;

  my $api; BEGIN { $api = ASP4::API->new }

  # Now you can use your other classes:
  use My::User;
  use My::Product;
  use My::Foo;

  # Use the API:

  my $res = $api->ua->get('/index.asp');
  if( $res->is_success ) {
    print $res->content;
  }

  # Access your test data:
  warn $res->test_data->contact_form->email;

  # Access your properties YAML:
  warn $res->properties->contact_form->email->is_missing;

  # Access the application config:
  warn $api->config->system->settings->foo;

=head1 DESCRIPTION

C is B - specifically when writing tests
for the actual web pages themselves.

=head2 Example Unit Test

  #!/usr/bin/perl -w

  use strict;
  use warnings 'all';
  use Test::More 'no_plan';

  use ASP4::API;

  ok(
    my $api = ASP4::API->new, "Got api"
  );
  is(
    $api->ua->get('/hello.asp')->content => 'Hello World!',
    'Website is friendly'
  );

=head1 PUBLIC PROPERTIES

=head2 ua

Returns an L that can be used to interact with pages on your website.

=head2 context

Returns the current instance of L in use.

=head2 config

Returns the L object for the web application.

=head2 properties

Returns an object representing your C file.

=head2 data

Returns an object representing your C file.

=cut