@@ -1,5 +1,6 @@ *.class *.jar .project -.settings .classpath +src/org/loststone/toodledo/client +doc/javadoc .gitignore @@ -6,6 +6,7 @@ <property name="jar.dir" value="${build.dir}/jar"/> <property name="main-class" value="org.loststone.toodledo.client.Client"/> <property name="lib.dir" value="lib"/> +<property name="javadoc.dir" value="doc/javadoc"/> <path id="classpath"> <fileset dir="${lib.dir}" includes="**/*.jar"/> @@ -41,4 +42,18 @@ </java> </target> +<target name="javadoc"> +<mkdir dir="${javadoc.dir}"/> + +<javadoc packagenames="org.loststone.toodledo.*" +sourcepath="src" +defaultexcludes="yes" +destdir="${javadoc.dir}" +author="true" +version="true" +use="true" +windowtitle="Toodledo Java API"> +</javadoc> +</target> + </project> build.xml @@ -2,7 +2,6 @@ package org.loststone.toodledo; public class Context { int id; - // TODO up to 32 chars String name; boolean hasName = false; @@ -28,12 +27,17 @@ public class Context { public String getName() { return name; } + /** - * @param name the name to set - * TODO up to 32 chars + * Sets the name for this context. + * @param Sets the name for the context. This is 32 chars maximum, names with more that that will be cropped. */ public void setName(String name) { - this.name = name; + if (name.length() > 32) + this.name = name.substring(0,31); + else + this.name = name; + this.hasName = true; } src/org/loststone/toodledo/Context.java @@ -5,7 +5,6 @@ public class Folder { boolean bPrivate; boolean archived; int order; - // TODO up to 32 charts String sName; boolean hasName = false; @@ -74,12 +73,17 @@ public class Folder { public String getSName() { return sName; } + /** - * @param name the sName to set - * TODO up to 32 chars + * Set the name of the folder. + * @param name the folder. If the name is longer than 32 chars it will be cropped. */ public void setSName(String name) { - sName = name; + if (name.length() > 32) + sName = name.substring(0,31); + else + sName = name; + this.hasName = true; } src/org/loststone/toodledo/Folder.java @@ -6,7 +6,6 @@ public class Goal { int level; int contributes; boolean archive; - // TODO up to 255 String name; boolean hasName = false; @@ -80,11 +79,16 @@ public class Goal { public String getName() { return name; } + /** - * @param name the name to set + * Sets the name for that goal. + * @param name for this goal. If the name is longer than 255 it will be cropped. */ public void setName(String name) { - this.name = name; + if (name.length() > 255) + this.name = name.substring(0,254); + else + this.name = name; this.hasName = true; } src/org/loststone/toodledo/Goal.java @@ -77,12 +77,15 @@ public class Todo { } /** - * @param title the title to set + * Sets the title for the task. + * @param title the title to set. If the title is longer than 255 charts it will be cropped. */ public void setTitle(String title) { - // TODO up to 255 chars - - this.title = title; + if (title.length() > 254) + this.title = title.substring(0,254); + else + this.title = title; + this.hasTitle = true; } src/org/loststone/toodledo/Todo.java @@ -20,14 +20,109 @@ public interface ToodledoApi { */ AuthToken initialize(String username, String password) throws ToodledoApiException; + /** + * Adds a Todo ( a task ) to toodledo. + * @param auth Authorization token for that user + * @param todo Todo object to add. + * @return the id of the new task added. -1 if it fails. + * @throws ToodledoApiException + */ int addTodo(AuthToken auth, Todo todo) throws ToodledoApiException; + + /** + * Adds a folder to toodledo. + * @param auth Authorization token for that user. + * @param fold Folder to add. + * @return id of the folder, -1 if it fails. + * @throws ToodledoApiException + */ + int addFolder(AuthToken auth, Folder fold) throws ToodledoApiException; + + /** + * Adds a context to toodledo. + * @param auth Authorization token for that user. + * @param context Context to add. + * @return id of the new context, -1 if it fails. + * @throws ToodledoApiException + */ + int addContext(AuthToken auth, Context context) throws ToodledoApiException; + + /** + * Adds a goal to toodledlo. + * @param auth Authorization token for that user. + * @param goal Goal to add. + * @return id of the new goal, -1 if it fails. + * @throws ToodledoApiException + */ + int addGoal(AuthToken auth, Goal goal) throws ToodledoApiException; + + /** + * Gets a given task. + * @param auth Authorization token for that user. + * @param id id of the task to get. + * @return Todo object with the task, null if it fails to retrieve it. + */ Todo getTodo(AuthToken auth, int id) throws ToodledoApiException; + + /** + * Modify a given Task + * @param auth Authorization token for that user. + * @param newOne Task with the modifications. + * @return true if that task was updated succesfully, false otherwise. + * @throws ToodledoApiException + */ boolean modifyTodo(AuthToken auth, Todo newOne) throws ToodledoApiException; + + /** + * Deletes a Todo. This method will <b>delete</b> the task. If you want to tag + * this task as <b>done</b> you should use the <i>modifyTodo</i> method instead. + * @param auth Authorization token to use. + * @param id id of the Task to delete. + * @return true upon succesfull deletion, false otherwise. + * @throws ToodledoApiException + */ boolean deleteTodo(AuthToken auth, int id) throws ToodledoApiException; - List<String> getTodosList(AuthToken auth) throws ToodledoApiException; - List<String> getFolders(AuthToken auth) throws ToodledoApiException; - List<String> getContexts(AuthToken auth) throws ToodledoApiException; - List<String> getGoals(AuthToken auth) throws ToodledoApiException; + + /** + * Gets all the Tasks for that user. + * @param auth Authorization token for that user. + * @return A list containing all the tasks for that user. + * @throws ToodledoApiException + */ + List<Todo> getTodosList(AuthToken auth) throws ToodledoApiException; + + /** + * Gets all the tasks that match the given task. + * @param auth Authorization token for that user. + * @param filter This task is a dummy task. It's used as a filter for the search. + * @return A list containing the tasks that match the filter. + * @throws ToodledoApiException + */ + List<Todo> getTodosList(AuthToken auth, Todo filter) throws ToodledoApiException; + + /** + * Gets all the folders + * @param auth Authorization token for that user. + * @return A list of Folders. + * @throws ToodledoApiException + */ + List<Folder> getFolders(AuthToken auth) throws ToodledoApiException; + + /** + * Gets all the contexts for that user. + * @param auth Authorization token for that user. + * @return A list with all the contexts. + * @throws ToodledoApiException + */ + List<Context> getContexts(AuthToken auth) throws ToodledoApiException; + + /** + * Gets all the goals for that user. + * @param auth Authorization token for that user. + * @return A list containing all the goals for that user. + * @throws ToodledoApiException + */ + List<Goal> getGoals(AuthToken auth) throws ToodledoApiException; } src/org/loststone/toodledo/ToodledoApi.java @@ -7,9 +7,7 @@ public class ToodledoApiException extends Exception { super(substring); } - /** - * - */ + private static final long serialVersionUID = 1L; } src/org/loststone/toodledo/ToodledoApiException.java @@ -2,12 +2,34 @@ package org.loststone.toodledo; import java.util.List; +import org.loststone.toodledo.request.AddContextRequest; +import org.loststone.toodledo.request.AddFolderRequest; +import org.loststone.toodledo.request.AddGoalRequest; import org.loststone.toodledo.request.AddTodoRequest; import org.loststone.toodledo.request.AuthorizeRequest; +import org.loststone.toodledo.request.DeleteTodoRequest; +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.ModifyTodoRequest; import org.loststone.toodledo.request.Request; +import org.loststone.toodledo.response.AddContextResponse; +import org.loststone.toodledo.response.AddFolderResponse; +import org.loststone.toodledo.response.AddGoalResponse; import org.loststone.toodledo.response.AddTodoResponse; import org.loststone.toodledo.response.AuthorizeResponse; +import org.loststone.toodledo.response.DeleteResponse; +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.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.GoalsParser; public class ToodledoApiImpl implements ToodledoApi { @@ -22,15 +44,30 @@ public class ToodledoApiImpl implements ToodledoApi { } @Override - public Todo getTodo(AuthToken auth, int id) { - // TODO Auto-generated method stub - return null; + public Todo getTodo(AuthToken auth, int id) throws ToodledoApiException { + Todo filter = new Todo(); + filter.setId(id); + List<Todo> res = getTodosList(auth,filter); + if (res != null && res.size() > 0) { + return res.get(0); + } else { + return null; + } } @Override - public List<String> getTodosList(AuthToken auth) { - // TODO Auto-generated method stub - return null; + public List<Todo> getTodosList(AuthToken auth) throws ToodledoApiException { + return getTodosList(auth,null); + } + + @Override + public List<Todo> getTodosList(AuthToken auth, Todo filter) throws ToodledoApiException { + Request getTodosRequest = new GetTodosRequest(auth, filter); + GetTodosResponse response = (GetTodosResponse)getTodosRequest.exec(); + if (response.succeeded()) + return new GetTodosParser(response.getResponseContent()).getTodos(); + else + return null; } @Override @@ -39,38 +76,93 @@ public class ToodledoApiImpl implements ToodledoApi { // response gives back the token, now create the AuthToken AuthorizeResponse resp = (AuthorizeResponse) initReq.exec(); AuthToken token = new AuthToken(password, username, resp.getResponseContent()); - return token; } @Override public boolean modifyTodo(AuthToken auth, Todo newOne) throws ToodledoApiException{ - // TODO Auto-generated method stub - return false; + ModifyTodoRequest modifyRequest = new ModifyTodoRequest(auth,newOne); + ModifyTodoResponse resp = (ModifyTodoResponse)modifyRequest.exec(); + if (resp.succeeded()) { + Integer _t = Integer.parseInt(resp.getResponseContent()); + if (_t == 1) return true; + else return false; + } else + return false; } @Override public boolean deleteTodo(AuthToken auth, int id) throws ToodledoApiException{ - // TODO Auto-generated method stub - return false; + DeleteTodoRequest request = new DeleteTodoRequest(auth, id); + DeleteResponse resp = (DeleteResponse)request.exec(); + if (resp.succeeded()) { + Integer _t = Integer.parseInt(resp.getResponseContent()); + if (_t == 1) return true; + else return false; + } else + return false; + } + + @Override + public List<Context> getContexts(AuthToken auth) throws ToodledoApiException{ + GetContextsRequest request = new GetContextsRequest(auth); + GetContextsResponse resp = (GetContextsResponse)request.exec(); + if (resp.succeeded()) + return new ContextsParser(resp.getResponseContent()).getContexts(); + else + return null; + } + + @Override + public List<Folder> getFolders(AuthToken auth) throws ToodledoApiException{ + GetFoldersRequest request = new GetFoldersRequest(auth); + GetFoldersResponse resp = (GetFoldersResponse)request.exec(); + if (resp.succeeded()) + return new FolderParser(resp.getResponseContent()).getFolders(); + else + return null; + } + + @Override + public List<Goal> getGoals(AuthToken auth) throws ToodledoApiException{ + GetGoalsRequest request = new GetGoalsRequest(auth); + GetGoalsResponse resp = (GetGoalsResponse)request.exec(); + if (resp.succeeded()) + return new GoalsParser(resp.getResponseContent()).getGoals(); + else + return null; } @Override - public List<String> getContexts(AuthToken auth) throws ToodledoApiException{ - // TODO Auto-generated method stub - return null; + public int addFolder(AuthToken auth, Folder fold) + throws ToodledoApiException { + AddFolderRequest request = new AddFolderRequest(auth,fold); + AddFolderResponse response = (AddFolderResponse)request.exec(); + if (response.succeeded()) + return Integer.parseInt(response.getResponseContent()); + else + return -1; } @Override - public List<String> getFolders(AuthToken auth) throws ToodledoApiException{ - // TODO Auto-generated method stub - return null; + public int addContext(AuthToken auth, Context context) + throws ToodledoApiException { + AddContextRequest request = new AddContextRequest(auth, context); + AddContextResponse response = (AddContextResponse)request.exec(); + if (response.succeeded()) + return Integer.parseInt(response.getResponseContent()); + else + return -1; } @Override - public List<String> getGoals(AuthToken auth) throws ToodledoApiException{ - // TODO Auto-generated method stub - return null; + public int addGoal(AuthToken auth, Goal goal) throws ToodledoApiException { + AddGoalRequest request = new AddGoalRequest(auth, goal); + AddGoalResponse response = (AddGoalResponse)request.exec(); + if (response.succeeded()) + return Integer.parseInt(response.getResponseContent()); + else + return -1; } } src/org/loststone/toodledo/ToodledoApiImpl.java @@ -16,9 +16,9 @@ public class AddTodoRequest extends Request { public AddTodoRequest(AuthToken token, Todo todo) throws ToodledoApiException { super(); - this.url = "http://api.toodledo.com/api.php?method=addTask;key="+token.getKey()+";"; + this.url = "http://api.toodledo.com/api.php?method=addTask;key="+token.getKey(); StringBuffer buff = new StringBuffer(); - if (todo.hasTitle()) { buff.append("title=").append(todo.getTitle()); + if (todo.hasTitle()) { buff.append(";title=").append(todo.getTitle()); } else { throw new ToodledoApiException("Todo object at least must have a title!"); } src/org/loststone/toodledo/request/AddTodoRequest.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.ToodledoApiException; -import org.loststone.toodledo.response.GetContextsResponse; +import org.loststone.toodledo.response.GetGoalsResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; @@ -25,7 +25,7 @@ public class GetGoalsRequest extends Request { Response addResp = null; try { client.executeMethod(method); - addResp = new GetContextsResponse(method.getResponseBodyAsString()); + addResp = new GetGoalsResponse(method.getResponseBodyAsString()); } catch (HttpException e) { e.printStackTrace(); } catch (IOException e) { src/org/loststone/toodledo/request/GetGoalsRequest.java @@ -8,7 +8,7 @@ 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.response.AddTodoResponse; +import org.loststone.toodledo.response.ModifyTodoResponse; import org.loststone.toodledo.response.Response; import org.loststone.toodledo.util.AuthToken; @@ -51,7 +51,7 @@ public class ModifyTodoRequest extends Request { Response addResp = null; try { client.executeMethod(method); - addResp = new AddTodoResponse(method.getResponseBodyAsString()); + addResp = new ModifyTodoResponse(method.getResponseBodyAsString()); } catch (HttpException e) { e.printStackTrace(); } catch (IOException e) { src/org/loststone/toodledo/request/ModifyTodoRequest.java @@ -1,5 +1,12 @@ package org.loststone.toodledo.request; +import java.io.IOException; + +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.response.GetFoldersResponse; import org.loststone.toodledo.response.Response; public abstract class Request { @@ -10,7 +17,22 @@ public abstract class Request { //public abstract void buildRequest(); - public abstract Response exec(); + public Response exec() { + HttpClient client = new HttpClient(); + HttpMethod method = new GetMethod(this.url); + Response addResp = null; + try { + client.executeMethod(method); + addResp = new GetFoldersResponse(method.getResponseBodyAsString()); + } catch (HttpException e) { + e.printStackTrace(); + } catch (IOException e) { + e.printStackTrace(); + } finally { + method.releaseConnection(); + } + return addResp; + } public String getAuthToken() { return authToken; src/org/loststone/toodledo/request/Request.java @@ -7,6 +7,10 @@ public class AddTodoResponse extends Response { public AddTodoResponse(String resp) { super(resp); + if (response.contains("error")) + this.succeed = false; + else + this.succeed = true; } @Override src/org/loststone/toodledo/response/AddTodoResponse.java @@ -21,6 +21,11 @@ public abstract class Response { return succeed; } + /** + * This method returns the value if it's a simple value or the xml for further parsing. + * @return + * @throws ToodledoApiException + */ public abstract String getResponseContent() throws ToodledoApiException; src/org/loststone/toodledo/response/Response.java @@ -33,7 +33,7 @@ public class ContextsParser extends DefaultHandler { //get a new instance of parser SAXParser sp = spf.newSAXParser(); //parse the string and also register this class for call backs - sp.parse(new ByteArrayInputStream(xml.getBytes()), this); + sp.parse(new ByteArrayInputStream(xml.getBytes("UTF-8")), this); }catch(SAXException se) { se.printStackTrace(); @@ -54,7 +54,7 @@ public class ContextsParser extends DefaultHandler { if(qName.equalsIgnoreCase("context")) { tmp_ = new Context(); - tmp_.setId(Integer.getInteger(attributes.getValue("id"))); + tmp_.setId(Integer.parseInt(attributes.getValue("id"))); } } src/org/loststone/toodledo/xml/ContextsParser.java @@ -33,7 +33,7 @@ public class FolderParser extends DefaultHandler { //get a new instance of parser SAXParser sp = spf.newSAXParser(); //parse the string and also register this class for call backs - sp.parse(new ByteArrayInputStream(xml.getBytes()), this); + sp.parse(new ByteArrayInputStream(xml.getBytes("UTF-8")), this); }catch(SAXException se) { se.printStackTrace(); @@ -55,18 +55,18 @@ public class FolderParser extends DefaultHandler { if(qName.equalsIgnoreCase("folder")) { tmp_ = new Folder(); //create a new instance of employee - tmp_.setId(Integer.getInteger(attributes.getValue("id"))); - int tmpBool = Integer.getInteger(attributes.getValue("private")); + tmp_.setId(Integer.parseInt(attributes.getValue("id"))); + int tmpBool = Integer.parseInt(attributes.getValue("private")); if (tmpBool == 1) tmp_.setBPrivate(true); else tmp_.setBPrivate(false); - tmpBool = Integer.getInteger(attributes.getValue("archived")); + tmpBool = Integer.parseInt(attributes.getValue("archived")); if (tmpBool == 1) tmp_.setArchived(true); else tmp_.setArchived(false); - tmp_.setOrder(Integer.getInteger(attributes.getValue("order"))); + tmp_.setOrder(Integer.parseInt(attributes.getValue("order"))); } } src/org/loststone/toodledo/xml/FolderParser.java @@ -33,7 +33,7 @@ public class GetTodosParser extends DefaultHandler { //get a new instance of parser SAXParser sp = spf.newSAXParser(); //parse the string and also register this class for call backs - sp.parse(new ByteArrayInputStream(xml.getBytes()), this); + sp.parse(new ByteArrayInputStream(xml.getBytes("UTF-8")), this); }catch(SAXException se) { se.printStackTrace(); src/org/loststone/toodledo/xml/GetTodosParser.java @@ -33,7 +33,7 @@ public class GoalsParser extends DefaultHandler { //get a new instance of parser SAXParser sp = spf.newSAXParser(); //parse the string and also register this class for call backs - sp.parse(new ByteArrayInputStream(xml.getBytes()), this); + sp.parse(new ByteArrayInputStream(xml.getBytes("UTF-8")), this); }catch(SAXException se) { se.printStackTrace(); @@ -55,10 +55,10 @@ public class GoalsParser extends DefaultHandler { if(qName.equalsIgnoreCase("goal")) { tmp_ = new Goal(); //create a new instance of employee - tmp_.setId(Integer.getInteger(attributes.getValue("id"))); - tmp_.setLevel(Integer.getInteger(attributes.getValue("level"))); - tmp_.setContributes(Integer.getInteger(attributes.getValue("contributes"))); - int tmpBool = Integer.getInteger(attributes.getValue("archived")); + tmp_.setId(Integer.parseInt(attributes.getValue("id"))); + tmp_.setLevel(Integer.parseInt(attributes.getValue("level"))); + tmp_.setContributes(Integer.parseInt(attributes.getValue("contributes"))); + int tmpBool = Integer.parseInt(attributes.getValue("archived")); if (tmpBool == 1) tmp_.setArchive(true); else src/org/loststone/toodledo/xml/GoalsParser.java c5e927a9fd0fe0b9cd708c8ef7e5ac02a22b3885 Marc phlegias@gmail.com http://github.com/lant/toodledo-java/commit/c2dfbc9d3bb6b7eaa54b5018ca238eebc3384674 c2dfbc9d3bb6b7eaa54b5018ca238eebc3384674 2009-03-14T13:44:05-07:00 2009-03-14T13:44:05-07:00 Bugs solving + lots of more things. yeah, documentation. 8ecb7b1ba4020a65968079d115ba76422182a530 Marc phlegias@gmail.com