jaguar-dart / jaguar

Jaguar, a server framework built for speed, simplicity and extensible. ORM, Session, Authentication & Authorization, OAuth

Jaguar

Jaguar is a full-stack production ready HTTP server framework built to be fast, simple and intuitive.

Getting started

Familiar way to write routes

Jaguar class provides methods get, put, post, delete and options to quickly add route handlers for specific HTTP methods.

main() async {
  final server = Jaguar();  // Serves the API at localhost:8080 by default
  // Add a route handler for 'GET' method at path '/hello'
  server.get('/hello', (Context ctx) => 'Hello world!');
  await server.serve();
}

Powerful route matching

Easily define and access Path parameters

Path segments prefixed with : can match any value and are also captured as path variables. Path variables can be accessed using pathParams member of Context object.

main(List<String> args) async {
  final quotes = <String>[
    'But man is not made for defeat. A man can be destroyed but not defeated.',
    'When you reach the end of your rope, tie a knot in it and hang on.',
    'Learning never exhausts the mind.',
  ];

  final server = Jaguar();
  server.get('/api/quote/:index', (ctx) { // The magic!
    final int index = ctx.pathParams.getInt('index', 1);  // The magic!
    return quotes[index + 1];
  });
  await server.serve();
}

• A path can have multiple path variables.
• A path variable can appear at any position in the path.
• A path variable can be matched against a Regular expression.
• getInt, getDouble, getNum and getBool methods can be used to easily typecast path variables.
• Using * as the final path segment captures/matches all following segments.

Easily access Query parameters

Query parameters can be accessed using queryParams member of Context object.

main(List<String> args) async {
  final quotes = <String>[
    'But man is not made for defeat. A man can be destroyed but not defeated.',
    'When you reach the end of your rope, tie a knot in it and hang on.',
    'Learning never exhausts the mind.',
  ];

  final server = Jaguar();
  server.get('/api/quote', (ctx) {
    final int index = ctx.queryParams.getInt('index', 1); // The magic!
    return quotes[index + 1];
  });
  await server.serve();
}

getInt, getDouble, getNum and getBool methods can be used to easily typecast query parameters into desired type.

One liner to access Forms

A single line is all it takes to obtain a form as a Map<String, String> using method bodyAsUrlEncodedForm on Request object.

main(List<String> arguments) async {
  final server = Jaguar(port: 8005);

  server.postJson('/api/add', (ctx) async {
      final Map<String, String> map = await ctx.req.bodyAsUrlEncodedForm(); // The magic!
      contacts.add(Contact.create(map));
      return contacts.map((ct) => ct.toMap).toList();
    });


  await server.serve();
}

One liner to serve static files

The method staticFiles adds static files to Jaguar server. The first argument determines the request Uri that much be matched and the second argument determines the directory from which the target files are fetched.

main() async {
  final server = Jaguar();
  server.staticFiles('/static/*', 'static'); // The magic!
  await server.serve();
}

JSON serialization with little effort

Decoding JSON requests can't be simpler than using one of the built-in bodyAsJson, bodyAsJsonMap or bodyAsJsonList methods on Request object.

Future<void> main(List<String> args) async {
  final server = Jaguar();
  server.postJson('/api/book', (Context ctx) async {
    // Decode request body as JSON Map
    final Map<String, dynamic> json = await ctx.req.bodyAsJsonMap();
    Book book = Book.fromMap(json);
    return book; // Automatically encodes Book to JSON
  });

  await server.serve();
}

Out-of-the-box Sessions support

main() async {
  final server = Jaguar();
  server.get('/api/add/:item', (ctx) async {
    final Session session = await ctx.req.session;
    final String newItem = ctx.pathParams.item;

    final List<String> items = (session['items'] ?? '').split(',');

    // Add item to shopping cart stored on session
    if (!items.contains(newItem)) {
      items.add(newItem);
      session['items'] = items.join(',');
    }

    return Response.redirect('/');
  });
  server.get('/api/remove/:item', (ctx) async {
    final Session session = await ctx.req.session;
    final String newItem = ctx.pathParams.item;

    final List<String> items = (session['items'] ?? '').split(',');

    // Remove item from shopping cart stored on session
    if (items.contains(newItem)) {
      items.remove(newItem);
      session['items'] = items.join(',');
    }

    return Response.redirect('/');
  });
  await server.serve();
}

jaguar's Issues

unused variable

Should be could to not create the queryParams variable if not needed.

Add Ban IP interceptors

Response should know how to write List<int>

Response should handle writing List properly using httpResponse.add(value)

Documentation for Path variables

Facebook OAuth authenticator

Facebook OAuth authenticator that plays well with jaguar_session and jaguar_auth

Add the following to README

• Organise route handlers in an API class
• Session management
• Authentication and Authorization
• Mongo
• SQL ORM

importing class and use it with Group result with no route

in api.dart

import "users.dart";

part 'api.g.dart';

@Api(path: 'api')
class ExampleApi extends Object with _$JaguarMedisApi {
  @Group(path: 'users')
  UsersGroup users = new UsersGroup();
}

in users.dart

class UsersGroup {
  @Route('/')
  String get() => "user";
}

Mustache template rendering support

An interceptor to support rendering of Mustache templates

Better error message when Inputs to routes and interceptors do not match

Display route name and input name when inputs dont match for routes and interceptors.

Also display source line info of the route.

JWT authetication support

Interceptor to support JWT authentication

Response should have separate content-type and charset properties

Cookie and header inputs to routes and injectors

An Input requester to request cookie and header as parameters to routes and injectors

Headers and status code on route annotation must have higher precedence than interceptors

Automatically URL decode URL encoded form data

Default value for String query parameter is not quoted

  @Get(path: '/defStringParam')
  String defStringParam({String strParam: 'default'}) => strParam;

In the generated code, the string 'default' is not quoted.

OAuth 2.0 authentication injector

An injector that supports authentication through OAuth 2.0

Add package for CORS

Create a separate package to handle CORS

Support serving static files

default queryparam for num equal to num

@Get(path: '/ping')
String ping({num test: 1, int test1: 3, double test2: 4.0}) {
  return "pong $test $test1 $test2";
}

if you don't provide test in the query param test will be null instead of 1

RouteWrapper's template type `WrapperType` must extend `Interceptor`

RouteWrapper's template type WrapperType must extend Interceptor

Exception thrown only when multithread is active

Hi.

Today i was implementing he autogenerated beans and changed somo code and when you try to execute it ikt throws this exception.

Dumping native stack trace for thread 174d
  [0x00000000008dc1ca] dart::SnapshotReader::ProcessDeferredCanonicalizations()
  [0x00000000008dc1ca] dart::SnapshotReader::ProcessDeferredCanonicalizations()
  [0x00000000008dc594] dart::SnapshotReader::ReadObject()
  [0x0000000000745ff0] Unknown symbol
  [0x0000000000750581] Unknown symbol
  [0x00000000007713b4] dart::MessageHandlerTask::Run()
-- End of DumpStackTrace

This is the main

import 'package:jaguar/jaguar.dart' as jaguar;

import 'package:campusAPI/api.dart';

main(List<String> args) async {
  ExampleApi ea = new ExampleApi();

  jaguar.Configuration configuration =
      new jaguar.Configuration(multiThread: false,port:8756);
  configuration.addApi(ea);

  await jaguar.serve(configuration);
}

and this is the api part

library api;

import 'dart:async';
import 'dart:io';

import 'package:jaguar/jaguar.dart';
import 'package:jaguar/interceptors.dart';
import 'package:campusAPI/db/db.dart';

part 'api.g.dart';

@RouteGroup(path: '/media')
class ExampleRouteGroup extends _$JaguarExampleRouteGroup {
  ContenidoBean CB = new ContenidoBean(new PgAdapter('asdasdasdasdasda'));

  @Get()
  @WrapEncodeJsonableList()
  Future<List> mediaAll() => CB.findAll();

  @Get(path: '/:id', pathRegEx: const {'id': r'^[0-9]+$'})
  @WrapEncodeJsonableList()
  Future<List> mediaOne() => CB.findAll();
}

@Api(path: '/campus')
class ExampleApi extends _$JaguarExampleApi {
  @Group()
  final ExampleRouteGroup exampleRoutes = new ExampleRouteGroup();

  @Route(path: '/version', methods: const ['GET'])
  num version() => 0.1;
}

Add convinient route annotations for common methods

Add convenient route annotations for common methods: Get, Put, Post, Delete

jaguar generator crashes if query parameter has no default value

jaguar generator crashes if query parameter has no default value.

@Api(path: '/api')
class ExampleApi implements ApiInterface {
  @Route('/user')
  String user({String id}) => "{'Id': $id}";
}

Json interceptor removes custom headers

Hi.
As talked on gitter when u use @WrapEncodeToJson() it removes the headers and the client dont know wath type of encode uses

Example code where it happens

@Get(
      headers: const {'Content-Language': 'es-ES','charset':'UTF-8'})
  @WrapPostgresDb(campusConnection)
  @WrapEncodeToJson()
  Future<List<Map>> getAll(@Input(PostgresDb) Connection db,
      {int offset: 0,
      int limit: 10,
      int formato,
      int evento,
      int plataforma,
      String aparece,
      int tema}) async {
    Adapter _adapter = new PgAdapter.FromConnection(db);
    bean = await new ContenidoBean(_adapter);
    Map parameters = {
      'formato': formato,
      'evento': evento,
      'plataforma': plataforma,
      'aparece': aparece,
      'tema': tema
    };
    return bean.findWithOptionals(limit, offset, parameters);
  }

Body writing interceptors must only set content-type. Charset must be set through route annotations

Support for Nested interceptors

We need a way to fold multiple interceptors into one to save a lot of lines

@InterceptorClass()
class Auth extends Interceptor {
  void pre() {}

  void post() {}
}

@InterceptorClass()
class FetchLogedInUser extends Interceptor {
  void pre() {}

  void post() {}
}

//TODO somehow this should wrap Auth and FetchLogedInUser
@InterceptorClass()
class AuthAndFetchUser extends Interceptor {
  void pre() {}

  void post() {}
}

Google OAuth authenticator

Google OAuth authenticator that plays well with jaguar_session and jaguar_auth

An example showing how to use HTTPS with Jaguar

Implement redirect on HTTP response

Add path variable less glob syntax to route's URL matching

Add possibility to match routes based on wild cards that do not require defining path variables.

/base/url/* must match all paths with prefix segments ['base', 'url']

Finish wiki entry for PODO JSON serialization

A way for interceptors to release its resources during exception

Right now interceptors cannot release its resources during exception

Upgrade args package dependency version to 1.2.0

Add throttle interceptors

Preserve order of request handlers

class with Api annotation without Route annotation inside crash the build process

Something like that is not accepted and should be

@Api(path: 'api')
class MedisApi extends Object with _$JaguarMedisApi {
  @Group(path: 'users')
  UsersResource users = new UsersResource();
}

Websocket support

A way to upgrade Http connection to websocket and injecting the upgraded websocket to route.

Should this need @Websocket() annotation, instead of @Route()

Add wiki entry for Cookies

Add request logging/diagnostics

Generic ORM support

A separate package for generic ORM

Example for serializer

Needs infrastructure to mock Websocket requests for testing

Needs a MockWebsocket class similar to MockHttpRequest to mock and test websocket api.

Shelf integration

Integrate shelf into jaguar so that shelf handlers can be added to jaguar configuration and shelf middleware can be added to jaguar routes.

Support `Input` annotation on method parameters

@Get()
Future<User> getUser(
  @Input(MongoDb) Db db,
  @Input(UserAuthorizer) User user
) {
  //TODO ...
} 

Improve docs for `Request` class members

Generate Swagger API specification

Swagger API specification must be generated from metadata parsed during code generation

Video demos of Jaguar features

Create video demos to showcase jaguar features

• Setting up Jaguar
• Routes
• Path variables input
• Query parameters input
• Header input
• Cookie input
• JSON encoding
• JSON decoding
• Session
• Authetication and Authorization
• JWT Authetication and Authorization
• Serialization using jaguar_serializer
• Using MongoDb
• Using PostgreSql
• Using MySQL
• Writing Interceptors
• Interceptor output
• Multi-server configuration
• Settings
• Logging using scribe
• Serving static files
• Mustach template rendering
• Facebook OAuth authentication
• Github OAuth authentication
• Google OAuth authentication
• Twitter OAuth authentication
• Using snapshot for deployment
• Deploying using Nginx
• Deploying using Apache

Complete Doc for serializer

RegExp are not working

RegExp are not working because in the generated code they are missing inside the Route instanciation.

List<Route> _routes = <Route>[
  new Route(r"/:file", methods: ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"]),
];

should be:

List<Route> _routes = <Route>[
  new Route(r"/:file", methods: ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"], pathRegEx: {"file": "whatever here"}),
];

Finish basic documentation

Hi,

I liked the project and I am studying it as an alternative to redstone.
We need the documentation.
How do we mock a request?
How do we use session? Are variables zoned?
etc.

thanks