trunk/lib/Frey.pm

package Frey;
use Moose;

our $VERSION = "0.24";

use Data::Dump qw//;
sub dump {
        my ($self,$data) = @_;
        Data::Dump::dump( $data );
}

has 'debug' => (
        is => 'rw',
        isa => 'Int',
        default => 0,
);

=head1 NAME

Frey - hi-level web framework in spirit of 4GLs

=head1 DESCRIPTION

  n. Mythology.

  The Norse god who dispenses peace, good weather, prosperity, and bountiful
  crops; the brother of Freya.

Basically you write L<Moose> classes which become deirectly callable from
the Firefox using REST API. for gentle intoduction see L<Frey::Manual>.

This is just brief overview of concepts so you might check if they suite you
before you get into details.

=head1 Developer parts

=head2 Moose classes

All Moose classes have simple introspection API which use
L<Frey::Introspect> to show class and it's pod (using L<Frey::Pod>). 

Example of valid REST URL is

  http://localhost:16001/Frey

which will show L<Frey> class introspection.

You can also add method invocation and optonal parametars to C<new>
constructor like this:

  http://localhost:16001/Frey::Pod/as_markup?class=Frey

this is same using L<Frey::Pod> from perl as

  Frey::Pod->new( class => 'Frey' )->as_markup;

Forms to enter required parameters will be generated automatically, 
allowing you to explore your data while you are making interface for it.

=head2 Database

FIXME broken if not noted in C<TODO>

For database objects we support L<Fey> and when your objects are created
C<< with 'Frey::Collection' >> they will have basic CRUD functionality
implemented by L<Frey::ObjectBrowser>.

=head1 User parts

=head2 Pipes

See L<Frey::Pipe> for now.

=head1 SEE ALSO

L<Frey::Manual>

=cut

1;
1	dpavlin	24	package Frey;
2			use Moose;
3	dpavlin	17
4	dpavlin	730	our $VERSION = "0.24";
5	dpavlin	121
6	dpavlin	575	use Data::Dump qw//;
7	dpavlin	723	sub dump {
8			my ($self,$data) = @_;
9			Data::Dump::dump( $data );
10			}
11	dpavlin	575
12	dpavlin	24	has 'debug' => (
13			is => 'rw',
14	dpavlin	532	isa => 'Int',
15	dpavlin	56	default => 0,
16	dpavlin	24	);
17	dpavlin	17
18			=head1 NAME
19
20			Frey - hi-level web framework in spirit of 4GLs
21
22			=head1 DESCRIPTION
23
24	dpavlin	723	n. Mythology.
25	dpavlin	17
26	dpavlin	723	The Norse god who dispenses peace, good weather, prosperity, and bountiful
27			crops; the brother of Freya.
28	dpavlin	17
29	dpavlin	180	Basically you write L<Moose> classes which become deirectly callable from
30	dpavlin	723	the Firefox using REST API. for gentle intoduction see L<Frey::Manual>.
31	dpavlin	180
32	dpavlin	723	This is just brief overview of concepts so you might check if they suite you
33			before you get into details.
34	dpavlin	209
35	dpavlin	723	=head1 Developer parts
36	dpavlin	209
37	dpavlin	293	=head2 Moose classes
38
39			All Moose classes have simple introspection API which use
40			L<Frey::Introspect> to show class and it's pod (using L<Frey::Pod>).
41
42			Example of valid REST URL is
43
44			http://localhost:16001/Frey
45
46			which will show L<Frey> class introspection.
47
48			You can also add method invocation and optonal parametars to C<new>
49			constructor like this:
50
51	dpavlin	455	http://localhost:16001/Frey::Pod/as_markup?class=Frey
52	dpavlin	293
53			this is same using L<Frey::Pod> from perl as
54
55	dpavlin	455	Frey::Pod->new( class => 'Frey' )->as_markup;
56	dpavlin	293
57	dpavlin	723	Forms to enter required parameters will be generated automatically,
58			allowing you to explore your data while you are making interface for it.
59	dpavlin	293
60	dpavlin	209	=head2 Database
61
62	dpavlin	723	FIXME broken if not noted in C<TODO>
63
64	dpavlin	209	For database objects we support L<Fey> and when your objects are created
65			C<< with 'Frey::Collection' >> they will have basic CRUD functionality
66			implemented by L<Frey::ObjectBrowser>.
67
68	dpavlin	723	=head1 User parts
69
70			=head2 Pipes
71
72			See L<Frey::Pipe> for now.
73
74	dpavlin	697	=head1 SEE ALSO
75
76			L<Frey::Manual>
77
78	dpavlin	17	=cut
79
80			1;