UserService={};
 
//All functions backed by HopJS should have a signature of (input,onComplete,request)
UserService.create=function(input,onComplete){
  // Here we would create a new user and call onComplete(err,result) when were done
}
 
UserService.authenticate=function(input,onComplete){
  // Here we would authenticate a user and call onComplete(err,result) when were done
}
 

 
//This will create a RESTful set of URLs which expose the following functions:
Hop.defineClass("UserService",UserService,function(api){
  api.post("create","/user").demand("email").demand("username");
  api.post("authenticate","/user/auth").demand("email").demand("username");
});
 
//Now tell HopJS to expose our API in express.js
Hop.exposeAPI("/api/",app)
 

 
Hop.defineTestCase("UserService.authenticate",function(test){
    var validUser = { email:"test@test.com", username:"TestUser" };
    test.do("UserService.create").with(validUser).noError();
    test.do("UserService.authenticate").with(validUser).noError();
    test.do("UserService.authenticate").with({password:"BOB"},validUser).hasError(/Permission denied/);
});
 

 
  /* 
      First let's tell HopJS that we want to use caching  
      log - log what is happening with our server side cache
      redisClient - the redisClient to use - HopJS will create a default one if not specified
  */
  Hop.enableCaching({ log:true, redisClient: myRedisClient });
 
   
  Hop.defineClass("UserService",UserService,function(api){
    api.usage("Manages users");
   
    //Cache users as they are loaded for 60 seconds, and try to force the client to cache the results as well!
    api.get("load","/user/:id").demand("id").cacheId("/user/:id",60,true);
   
    //Invalidate the cache when a user is deleted 
    api.del("delete","/user/:id").demand("id").cacheInvalidate("/user/:id");
    
    //Cache the search results for 5000 seconds
    api.get("list","/user/").optional("sortBy").cacheId("/users/:start/:size/",5000).demand("start").demand("size");
    
    
  });
 

  /* 
    Assuming the requested user was found Redis would return the cached object, otherwise HopJS would
    call the underlying API, and also keep a copy of the returned object
    under the id '/user/5' for a duration of 60 sections. HopJS would also add all the extra headers
    to get the HTTP agent on the other end to cache this result for the specified duration as well!
 
    Essentially
      - If we have the cached object return it
      - If not execute the call and cache the result 
 
    The id for the cached object is generated by plugging the result objects properties into "/user/:id" to compute "/user/5"
 
  */
  UserService.load({id:5}) 
 
  /*
    This would end up deleting the cached object from Redis
  */
  UserService.del({id:5})

 
  // This will define an interface which can the be applied to other objects later
  Hop.defineInterface("Notification",function(api){
      //#classname will cause the classname of the extending class to be substituted into the path
      api.post("send","#classname/send").usage("Sends a message").demand("msg").demand("subject").demand("to");
  });
 
  Hop.defineClass("Email",EmailService,function(api){
    //This will cause the interface defined above to be applied to this object
    // Now EmailService.send will exist on /email/send with all the associated demands, etc.
    api.extend("Notification");
  });  
 

    FileTest.sendFile=function(input,onComplete){
        return onComplete(null,Hop.sendFile("public/pig.png"));
    }	
 
    FileTest.sendAttachment=function(input,onComplete){
        return onComplete(null,Hop.sendAttachment("public/pig.png","image.png"));
    }
 
    FileTest.upload=function(input,onComplete){
        return onComplete(null,input);
    }	
 
 
    Hop.defineClass("FileTest",FileTest,function(api){
        api.get("sendFile","/file")
        api.get("sendAttachment","/attachment");
        api.post("upload","/upload").demandFile("required").optionalFile("optional");
    });  

    Hop.defineModel("User",function(user){
        user.field("id","UserID","The user's id").integer().ID();
        user.field("name","Username","The user's username").string().regexp(/[A-Za-z0-9\_\-]{3,10}/,"Usernames must be between 3 and 10 characters long, and can only contain alphanumeric characters");
        user.field("email","Email","The user's email address").string();
        user.field("password","Password","The user's password").password();
    });

    Hop.defineClass("UserService",UserService,function(api){
        api.usage("Manages users");
        api.post("create","/user").usage("Creates a user").demands("email","name","password").useModel("User");
        api.post("authenticate","/user/auth").usage("Authenticates a user").demands("password","name").useModel("User");
        api.get("currentUser","/user").usage("Returns the current user").outputModel("User");
        api.get("logout","/user/logout").usage("Logs the current user out");
        api.del("del","/user/:id").usage("Deletes the user").demand("id").inputModel("User");
    });

 
UserService.create.fromForm("#userForm",function(err,result){
 
});
 

UserService.load.toForm({ id: 3},"#userForm",function(err,res){
 
});