src/org/loststone/toodledo/exception/IncorrectUserPasswordException.java src/org/loststone/toodledo/exception/MissingPasswordException.java src/org/loststone/toodledo/exception/ToodledoApiException.java src/org/loststone/toodledo/request/GetUserIdRequest.java src/org/loststone/toodledo/response/GetUserIdResponse.java src/org/loststone/toodledo/xml/GetUserIdParser.java @@ -58,6 +58,8 @@ Then, more advanced stuff: </ul> <h3><a name="authentif"> Authentification </a></h3> As this is a library, every program that uses it should be able to deal with more than one user concurrently. So, if you use the <code>initialize</code> method in the interface you'll get a <code>AuthToken</code>, this is an object which contains a key that will be valid for 4 hours, so, for every user you must cache or serialize or whatever that object. If you try to authenticate several times the same user (use the <code>initialize</code> method for the same user) that user will be banned temporarily from using the API, and that's not good. So, use that call or get an <code>AuthToken</code> manually and save that key for future use. +<p> +The <code>initialize</code> method needs the userid, not the username, you can get the userid from the toodledo webpage, it's always a 15 or 16 hexadecimal string. If for any reason you cannot log into the webpage and get the userid for a user you can user the <code>getUserId</code> method in the API. This method only requires the user e-mail and password. Take care using this method as it's sending the password in plain text format over the net as an http parameter. So, use it only if necessary. <h3><a name="utapi"> Using the API </a></h3> No problem here, the API is very straightforward and easy to use, if you've got any doubt you can check the toodledo API documentation <a href="http://www.toodledo.com/info/api_doc.php">here</a>. <h3><a name="ucstd"> Using the components as standalone </a></h3> @@ -67,8 +69,9 @@ All the requests use the commons-http package to do HTTP GET's to the REST API. You can contact me at: <p> <ul> <li> e-mail / jabber: phlegias@gmail.com + <li> irc (freenode): grind_lant </ul> <hr> -<i>Last modified: </i> 14/3/2009 +<i>Last modified: </i> 20/3/2009 </body> </html> doc/tutorial/index.html @@ -1,5 +1,7 @@ package org.loststone.toodledo; +import org.loststone.toodledo.exception.ToodledoApiException; + /** * This class represents the goal in toodledo. * @author lant src/org/loststone/toodledo/Goal.java @@ -2,6 +2,9 @@ package org.loststone.toodledo; import java.util.List; +import org.loststone.toodledo.exception.IncorrectUserPasswordException; +import org.loststone.toodledo.exception.MissingPasswordException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.util.AuthToken; /** @@ -124,5 +127,17 @@ public interface ToodledoApi { */ List<Goal> getGoals(AuthToken auth) throws ToodledoApiException; + /** + * Get a userId. + * <b>Warning</b>. Please note that this call sends the password in PLAIN TEXT over the net + * as an HTTP parameter. + * @param e-mail. + * @param password + * @return The userId + * @throws MissingPasswordException + * @throws IncorrectUserPasswordException + */ + String getUserId(String eMail, String password) throws ToodledoApiException, + IncorrectUserPasswordException, MissingPasswordException; } src/org/loststone/toodledo/ToodledoApi.java @@ -2,6 +2,9 @@ package org.loststone.toodledo; import java.util.List; +import org.loststone.toodledo.exception.IncorrectUserPasswordException; +import org.loststone.toodledo.exception.MissingPasswordException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.request.AddContextRequest; import org.loststone.toodledo.request.AddFolderRequest; import org.loststone.toodledo.request.AddGoalRequest; @@ -12,6 +15,7 @@ import org.loststone.toodledo.request.GetContextsRequest; import org.loststone.toodledo.request.GetFoldersRequest; import org.loststone.toodledo.request.GetGoalsRequest; import org.loststone.toodledo.request.GetTodosRequest; +import org.loststone.toodledo.request.GetUserIdRequest; import org.loststone.toodledo.request.ModifyTodoRequest; import org.loststone.toodledo.request.Request; import org.loststone.toodledo.response.AddContextResponse; @@ -24,11 +28,13 @@ import org.loststone.toodledo.response.GetContextsResponse; import org.loststone.toodledo.response.GetFoldersResponse; import org.loststone.toodledo.response.GetGoalsResponse; import org.loststone.toodledo.response.GetTodosResponse; +import org.loststone.toodledo.response.GetUserIdResponse; import org.loststone.toodledo.response.ModifyTodoResponse; import org.loststone.toodledo.util.AuthToken; import org.loststone.toodledo.xml.ContextsParser; import org.loststone.toodledo.xml.FolderParser; import org.loststone.toodledo.xml.GetTodosParser; +import org.loststone.toodledo.xml.GetUserIdParser; import org.loststone.toodledo.xml.GoalsParser; public class ToodledoApiImpl implements ToodledoApi { @@ -165,4 +171,15 @@ public class ToodledoApiImpl implements ToodledoApi { return -1; } + @Override + public String getUserId(String mail, String password) + throws ToodledoApiException, IncorrectUserPasswordException, MissingPasswordException { + GetUserIdRequest request = new GetUserIdRequest(mail,password); + GetUserIdResponse response = (GetUserIdResponse)request.exec(); + if(response.succeeded()) + return new GetUserIdParser(response.getResponseContent()).getUserId(); + else + return null; + } + } src/org/loststone/toodledo/ToodledoApiImpl.java @@ -7,7 +7,7 @@ import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; import org.loststone.toodledo.Context; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.AddContextResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/AddContextRequest.java @@ -7,7 +7,7 @@ import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; import org.loststone.toodledo.Folder; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.AddFolderResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/AddFolderRequest.java @@ -7,7 +7,7 @@ import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; import org.loststone.toodledo.Goal; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.AddGoalResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/AddGoalRequest.java @@ -7,7 +7,7 @@ import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; import org.loststone.toodledo.Todo; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.AddTodoResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/AddTodoRequest.java @@ -6,7 +6,7 @@ import org.apache.commons.httpclient.HttpClient; import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.DeleteResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/DeleteTodoRequest.java @@ -6,7 +6,7 @@ import org.apache.commons.httpclient.HttpClient; import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.GetContextsResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/GetContextsRequest.java @@ -6,7 +6,7 @@ import org.apache.commons.httpclient.HttpClient; import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.GetFoldersResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/GetFoldersRequest.java @@ -6,7 +6,7 @@ import org.apache.commons.httpclient.HttpClient; import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.GetGoalsResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/GetGoalsRequest.java @@ -7,7 +7,7 @@ import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; import org.loststone.toodledo.Todo; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.GetTodosResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/GetTodosRequest.java @@ -7,7 +7,7 @@ import org.apache.commons.httpclient.HttpException; import org.apache.commons.httpclient.HttpMethod; import org.apache.commons.httpclient.methods.GetMethod; import org.loststone.toodledo.Todo; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.loststone.toodledo.response.ModifyTodoResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; src/org/loststone/toodledo/request/ModifyTodoRequest.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class AddContextResponse extends Response { src/org/loststone/toodledo/response/AddContextResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class AddFolderResponse extends Response { src/org/loststone/toodledo/response/AddFolderResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class AddGoalResponse extends Response { src/org/loststone/toodledo/response/AddGoalResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class AddTodoResponse extends Response { src/org/loststone/toodledo/response/AddTodoResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class AuthorizeResponse extends Response { src/org/loststone/toodledo/response/AuthorizeResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class DeleteResponse extends Response { src/org/loststone/toodledo/response/DeleteResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class GetContextsResponse extends Response { src/org/loststone/toodledo/response/GetContextsResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class GetFoldersResponse extends Response { src/org/loststone/toodledo/response/GetFoldersResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class GetGoalsResponse extends Response { src/org/loststone/toodledo/response/GetGoalsResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class GetTodosResponse extends Response { src/org/loststone/toodledo/response/GetTodosResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; public class ModifyTodoResponse extends Response { src/org/loststone/toodledo/response/ModifyTodoResponse.java @@ -1,6 +1,6 @@ package org.loststone.toodledo.response; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; /** * This class holds a response from the server. src/org/loststone/toodledo/response/Response.java @@ -9,7 +9,7 @@ import javax.xml.parsers.SAXParser; import javax.xml.parsers.SAXParserFactory; import org.loststone.toodledo.Goal; -import org.loststone.toodledo.ToodledoApiException; +import org.loststone.toodledo.exception.ToodledoApiException; import org.xml.sax.Attributes; import org.xml.sax.SAXException; import org.xml.sax.helpers.DefaultHandler; src/org/loststone/toodledo/xml/GoalsParser.java src/org/loststone/toodledo/ToodledoApiException.java d65b7f1f4f2ee0ee9b282e905d59bd1978c5d888 Marc phlegias@gmail.com http://github.com/lant/toodledo-java/commit/27461b936fa005201efa5212fcfff4f15651d71d 27461b936fa005201efa5212fcfff4f15651d71d 2009-03-20T16:00:46-07:00 2009-03-20T16:00:46-07:00 - Added a new method to get the userid from the REST service - Updated documentation. 71d848002dbf606ab583fe806d897903833ed5d6 Marc phlegias@gmail.com