1602 / railway-routes Goto Github PK

Rename repository to compound-map and cleanup code

Is there an example on how to use a middleware, for example if I want to load a user before executing a controller action, or if I want to add authentication to an action?

Thanks and great job!!

JB

I'm using compoundjs to serve a RESTful api. I'm using an 'api' namespace to handle the REST calls like this:

    map.namespace('api', function (api) {
        api.get('targets',          'targets#index');
        api.get('targets/:id',      'targets#show');
        api.post('targets',         'targets#create');
        api.put('targets/:id',      'targets#update');
        api.delete('targets/:id',   'targets#destroy');
    });

On the client I am trying to use a simple backbone single-page app using pushState=true.

I'm having trouble figuring out the routing to keep node/express/compound from getting involved with anything other than the api. I've heard some mention of a wildcard route like '*' used in low-level express, maybe something like this:

app.get("*", function(req, res){
  res.sendfile('index.html');
});

When I tried doing something like map.get('', ...) and checked the route table with 'compound routes' it seemed that the '' was being treated as a string literal and it was trying to map a path like '/*', rather than recognizing it as a wildcard.

Is there some equivalent in railway-routes/compoundjs for this? Ultimately I want to preserve a request such as '/targets' or '/targets/3', server should just ignore or serve index.html and let backbone read the '/targets/3' and handle it with its client-side routing. I'm also concerned that using something like "res.sendfile('index.html')" would change the url before the client see's it, stripping the 'targets/3' before backbone can respond to it.

I found some similar Q&A on Stack Overflow but nothing that seemed to be specific to compoundjs or railway-routes.

Any suggestions, or documentation links would be greatly appreciated. Thanks!

What is this for?

        if ('state' in params) {
            p.state = params.state;
        }

I am using it to pass options through to my resource handler - but I want to know if it will change in the future and what it is used for.

In express, I can add a certain filter just to check if a User has been logged in or not by doing something like this :-

app.get('/posts', ensureLoggedIn(), posts.index);

How do i induce the ensureLoggedIn() behaviour using railway-routes ?

http://compoundjs.com/docs/#routing-middleware
Wrong position for the middleware.

Expected :

map.get('/test', middle, 'home#test');

But it doesn't work.

Instead this work :

map.get('/test', 'home#test', middle);

after your commits to close #16
a few bugs are introdused to break the app again :)

nested routes in compund:

map.resources 'users', (usesr)->
    uses.resources 'posts', (posts)->
                posts.post 'rate.:format?', 'posts#rate'

it used to be

user = {id : 4}
post = {id: 2}
pathTo.user_post( user, post) to create /users/4/posts/2 
pathTo.user_post( 4, 2) to create /users/4/posts/2 
pathTo.user_post_rate( 4, 2) to create /users/4/posts/2/rate 

now it is:

pathTo.user_post( user, post) creates /users/4/posts/4 
pathTo.user_post( 4, 2) creates /users/4/posts/2 
pathTo.user_post_rate( 4, 2) creates /users/4/posts/2/rate
pathTo.user_post_rate( user, post) creates /users/4/posts/2/rate
pathTo.user_post_rate( {user_id: user.id, id : post.id}) creates /users/4/posts/undefined/rate

but i guess you wanted:

pathTo.user_post( {user_id: user.id, id : post.id}) to create /users/4/posts/4 

the problem is that API is not same now
and OLD code is broken .....
i think both methods should work
i like the idea to pass the object to pathTo method, but alse some times it is much better to pass each param separatly

For something like links/:id/collections instead of params.link_id allow params.linkId

https://github.com/1602/railway-routes/blob/master/lib/railway_routes.js#L344

Hey @1602 I noticed an issue wen routing invalid actions

If I do http://localhost:300/accounts the action of the accounts controller defaults to index, if I do http://localhost:300/accounts/index this also default to index but if I do http://localhost/accounts/invalid-action I get defaulted to the show action(which I think is weird) instead of getting the "Handler not found" error message, is this intentional or it is a bug?.

Any ideas?

Thank you!

JB

This is my test handler.

module.exports = function (app) {
    var map = new routing.Map(app, handler);    
    map.resources('accounts');  
};

function handler(ns, controller, action) {
    try {
        var ctlFile = './controllers/' + ns + controller + '_controller';
        var responseHandler =  {
            index: function (req, res) {
                res.send('IN INDEX');
            },

            show: function (req, res) {
                res.send('IN SHOW');
            },

            new: function (req, res) {
                res.send('IN NEW');
            },

            edit: function (req, res) {
                res.sed('IN EDIT');
            }

        }[action];
    } catch(e) {}
    return responseHandler || function (req, res) {
        res.send('Handler not found for ' + ns + controller + '#' + action);
    };
}

At least, not as I expected ;). The railway-routes test has the following:

map.resources('avatars', {as: 'images', path: 'pictures'});
test.equal(map.pathTo.pictures, '/pictures');

On my expectations that should fail. Since as: is being specified, pathTo.pictures should not exist, but instead we should have pathTo.images.

Would you accept patches to change this behavior?

If I call resources with {only: ['index', 'show', 'new', 'create']}, /resource/new is interpreted as a show request for id new.

If I do something like this:

api.resources 'collections', (collection) ->
      collection.resources 'links', controller: 'collectionLinks'

I wish to access the name of the resource (that is, "links"/"link") from the collectionLinks resource.

The callback receives the controllerName and there is no way to access the name of the resource.

By defining

map.get('/test/:p1?', 'home#test');

When I use path_to

map.pathTo.test()
// I get ''
map.pathTo.test('param1')
// I get '/test/param1?'

A cool feature would be to declare route parameters like that :

map.get('/test/:p1/:p2?', 'home#test');

And to map them like that :

map.pathTo.test({p1 : 'param1', p2 : 'param2'})

Anyway thanks for this very nice piece of code

Hi, can you add a History.md so it can be clearly seen what was changed between each release?

Hey! I just realized this npm module is completely decoupled from RailwayJS which I think it's great. Do you plan to develop it completely independently from RailwayJS? If so, why not rename the project or make it clear in the README.md. Thanks!