todoist-ruby 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7daad29d7cd0d65b9368bd878565885bcd2a6f32
-  data.tar.gz: b50c774800956866d824b8ec19f65821ccde9a29
+  metadata.gz: 8b6ced7c5a25859fde744ff6603d95f9a0f02459
+  data.tar.gz: 13701d11be2371933b127389374aa7cbd4c416ad
 SHA512:
-  metadata.gz: c9bccb4c9920626e43af53b1171f404c91c60813aaf422f77ddcebfd2a19448dad04a4599b8b993c356503c4827dde6b87bf0e0b4b00ef2c73af0d12b82bb1ab
-  data.tar.gz: 31fa4e9e42d0ed96829fb107ad2323832f70c774f8ae0cccde9d800b5dcab9d0cb09df9999c828b4ed614be0181c7410d762c1a8be54d66c3867afb9cd1ee472
+  metadata.gz: a405c89d19faae1b894944d98f16af25d8f913f982723001d3bffcae53492683569231a35a6d5c3fe7f42ff8e9c0e0e76c2161117d8a994ef8300db5a22c18b1
+  data.tar.gz: a7bdfbc8f96f72636ff0796e81ac94cbee93a606e27d2fed8c4654875644c6c6e63b276c02aaab8b5efed5d38dc95674579ff724398198394aebec20c968d471

data/README.md

@@ -4,7 +4,7 @@ This is an unofficial client library that interfaces with the [Todoist API](http
 
 ## What's implemented
 
-### sync API
+### Sync API
 
 The "sync" API is almost fully implemented with the exception of collaboration features.  
 
@@ -62,67 +62,60 @@ Or install it yourself as:
 This section provides some simple scenarios to get started.  To use the library make sure you include the library as follows:
 
 ```ruby
-require todoist
+require 'todoist'
 ```
 
 ### Logging in and setting tokens
 
-Before you make any API calls, you **must** login.  The library supports two methods:
+Before you make any API calls, you **must** create a client using one of two methods.  The library supports two methods:
 
 #### Email and password
 
 ```ruby
-user_manager = Todoist::Misc::User.new
-user = user_manager.login("hello@example.com", "123")
-user.email
- => "hello@example.com" 
+@client = Todoist::Client.create_client_by_login("hello@example.com", "123")
 ```
 
-Upon calling the login method, an object is returned implemented through an [OpenStruct](http://ruby-doc.org/stdlib-2.0.0/libdoc/ostruct/rdoc/OpenStruct.html) that represents a variety of fields that may be useful to you.
-
 #### Token
 
-New tokens can be generated at the [Todoist App Management portal](https://developer.todoist.com/appconsole.html).  Once a token has been acquired simply set it as so:
+New tokens can be generated at the [Todoist App Management portal](https://developer.todoist.com/appconsole.html).  Once a token has been acquired you can create a client by calling:
 
 ```ruby
-Todoist::Config.token = "my token"
+@client = Todoist::Client.create_client_by_token("my token")
 ```
 
-### Using the sync API
-
-The Todoist sync API enables you to mimic how the actual Todoist client retrieves information.  Among other nuances, the sync API minimizes network traffic by batching a series of calls together.  It supports dependencies between as-yet-created objects through temporary IDs.
+### Using the API
 
-Because of the way the API is designed, it is likely your application will need to use some combination of the sync api along with the other, lighterweight methods also provided.
+The Todoist API enables you to mimic how the actual Todoist client retrieves information.  Among other nuances, the "sync" API minimizes network traffic by batching a series of calls together.  It supports dependencies between as-yet-created objects through temporary IDs.  In addition to the sync API, Todoist also has several other methods that are lighterweight.  For many light use cases, the lightweight methods will suffice but for more complex cases you will likely need to use both approaches.
 
-Managers provides in the sync API all exist in the module ```Todoist::Sync```.
+All APIs can be accessed through the client.  In general, the naming convention to access the service is ```[api_type]_[api]```.
 
 There are two ways to force a sync in the API:
 
-1.  ```manager_object.collection```:  Calling collection forces the library to sync with the Todoist server to retrieve the latest.  This method stores an internal in-memory copy of the result for incremental syncs but the caller should store a copy of the result in its own variable for query purposes.
-2.  ```Todoist::Util::CommandSynchronizer.sync```: Calling this method forcibly syncs the side-effects that have been queued.
+1.  ```collection```:  Calling collection forces the library to sync with the Todoist server to retrieve the latest.  This method stores an internal in-memory copy of the result for incremental syncs but the caller should store a copy of the result in its own variable for query purposes.  The following call syncs all items and returns a collection of the items:  ```@client.sync_items.collection```.
+2.  ```sync```: Calling the sync method on the client object forces a sync which can be called like ```@client.sync```
 
-When objects are called using the ```manager.object.add``` methods, a shallow object is created with a temporary id accessible by sending an ```id``` message.  Once any of the above synchronization methods are called above, the ids are updated via a callback with their actual ids so they can be used in subsequent calls.
+When objects are called using the ```add``` methods, a shallow object is created with a temporary id accessible by sending an ```id``` message.  Once any of the above synchronization methods are called above, the ids are updated via a callback with their actual ids so they can be used in subsequent calls.
 
 #### Creating an item 
 
 ```ruby 
-update_item = @item_manager.add({content: "Item3"})     
+update_item = @client.sync_items.add({content: "Item3"})     
 ## At this time update_item has a temporary id
 
 update_item.priority = 2
-result = @item_manager.update(update_item)
+result = @client.sync_items.update(update_item)
 # Up until this point update_item has not been created yet
 
-items_list =  @item_manager.collection
+items_list =  @client.sync_items.collection
 # Update item is created and a query is issued to sync up the existing items.  The actual id of the newly created item is updated and so now update_item should have the actual id.
 
 queried_object = items_list[update_item.id]
 # update_item remains a shallow value object.  To fully inflate the object, you will need to retrieve the item from the list.  At this point, queried_object has a fully inflated copy of the object
 
-@item_manager.delete([update_item])
+@client.sync_items.delete([update_item])
 # As is the case with other side-effects, issuing the call does not send the request immediately.  
 
-Todoist::Util::CommandSynchronizer.sync     
+@client.sync     
 # Manually calling sync deletes the item 
 ```
 
@@ -135,8 +128,7 @@ The rest of the APIs are available in the ```Todoist::Misc``` module.  For light
 #### Creating an item using the "quick" API
 
 ```ruby
-@misc_quick_manager = Todoist::Misc::Quick.new
-item = @misc_quick_manager.add_item("Test quick add content today")
+item = @client.misc_quick.add_item("Test quick add content today")
 # Unlike the sync API the item is already created after this method call and fully inflated
 ```
 ### Rate limiting
@@ -192,7 +184,8 @@ Once tests pass cleanly, subsquent runs that do not change the network requests
 
 ## Version History
 
-* 0.1.3: Changed Todoist::Sync managers so that the update method uses a hash instead of an OpenStruct.  The OpenStruct creates errors when an OpenStruct passed from a previous call is used.  The hash helps the caller make fewer mistakes.
+* 0.2.1: Major refactoring of library to support implementations that require multi-user support in a concurrent environment (e.g. Rails app).  The previous implementation relied heavily on class singletons.  Internally, the code has been cleaned up significantly.  Due to the scale of changes, 0.2.1 is not compatible 0.1.x versions of the library.
+* 0.1.3: Changed ```Todoist::Sync``` managers so that the update method uses a hash instead of an OpenStruct.  The OpenStruct creates errors when an OpenStruct passed from a previous call is used.  The hash helps the caller make fewer mistakes.
 * 0.1.2: Renamed method ```Todoist::Util::ParseHelper.make_objects_as_array``` to ```Todoist::Util::ParseHelper.make_objects_as_hash``` to reflect the fact that it was actually returning hashes.  Added the aforementioned deleted method to return arrays and finally altered ```Todoist::Misc::Completed``` to return objects as arrays instead of hashes due to the fact that recurring completed items were being de-duped unintentionally and data was being lost as a result.
 * 0.1.1: Initial release.
 

data/lib/todoist.rb

@@ -1,6 +1,10 @@
 require "todoist/version"
+require "todoist/config"
 require "todoist/util/api_helper"
 require "todoist/util/network_helper"
+require "todoist/service"
+require "todoist/client"
+
 require "todoist/sync/items"
 require "todoist/sync/labels"
 require "todoist/sync/projects"
@@ -15,7 +19,6 @@ require "todoist/misc/items"
 require "todoist/misc/quick"
 require "todoist/misc/activity"
 require "todoist/misc/backups"
-require "todoist/misc/user"
 require "todoist/misc/query"
 
 module Todoist

data/lib/todoist/client.rb

@@ -0,0 +1,119 @@
+module Todoist
+    class Client    
+
+      def self.create_client_by_token(token)
+        client = Client.new
+        client.token = token 
+        client
+      end
+
+      # TODO:  Need to write a unit test for this
+      def self.create_client_by_login(email, password)
+        client = Client.new
+        result = client.api_helper.get_response(Config::TODOIST_USER_LOGIN_COMMAND, {email: email, password: password}, false)
+        user = Todoist::Util::ParseHelper.make_object(result)
+        client.token = user.token
+        client
+      end
+
+      def token=(token)
+        @token = token
+      end
+      
+      def token
+        @token
+      end
+      
+      def sync
+        @api_helper.sync
+      end
+
+      def misc_activity
+        @misc_activity = Todoist::Misc::Activity.new(self) unless @misc_activity
+        @misc_activity
+      end
+
+      def misc_backups
+        @misc_backups = Todoist::Misc::Backups.new(self) unless @misc_backups
+        @misc_backups
+      end
+
+      def misc_completed
+        @misc_completed = Todoist::Misc::Completed.new(self) unless @misc_completed
+        @misc_completed
+      end
+
+      def misc_items
+        @misc_items = Todoist::Misc::Items.new(self) unless @misc_items
+        @misc_items
+      end
+
+      def misc_projects
+        @misc_projects = Todoist::Misc::Projects.new(self) unless @misc_projects
+        @misc_projects
+      end
+
+      def misc_query
+        @misc_query = Todoist::Misc::Query.new(self) unless @misc_query
+        @misc_query
+      end
+
+      def misc_quick
+        @misc_quick = Todoist::Misc::Quick.new(self) unless @misc_quick
+        @misc_quick
+      end
+
+      def misc_templates
+        @misc_templates = Todoist::Misc::Templates.new(self) unless @misc_templates
+        @misc_templates
+      end
+
+      def misc_uploads
+        @misc_uploads = Todoist::Misc::Uploads.new(self) unless @misc_uploads
+        @misc_uploads
+      end
+
+      def sync_filters
+        @sync_filters = Todoist::Sync::Filters.new(self) unless @sync_filters
+        @sync_filters
+      end
+
+      def sync_items
+        @sync_items = Todoist::Sync::Items.new(self) unless @sync_items
+        @sync_items
+      end
+
+      def sync_labels
+        @sync_labels = Todoist::Sync::Labels.new(self) unless @sync_labels
+        @sync_labels
+      end
+
+      def sync_notes
+        @sync_notes = Todoist::Sync::Notes.new(self) unless @sync_notes
+        @sync_notes
+      end
+
+      def sync_projects
+        @sync_projects = Todoist::Sync::Projects.new(self) unless @sync_projects
+        @sync_projects
+      end
+
+      def sync_reminders
+        @sync_reminders = Todoist::Sync::Reminders.new(self) unless @sync_reminders
+        @sync_reminders
+      end
+
+      def api_helper
+        @api_helper
+      end
+
+      protected
+
+      def initialize
+        @api_helper = Todoist::Util::ApiHelper.new(self)
+      end
+      
+
+
+    end
+end

data/lib/todoist/config.rb

@@ -0,0 +1,65 @@
+module Todoist
+  class Config
+    TODOIST_API_URL = "https://todoist.com/API/v7"
+    
+    # List of commands supported
+    @@command_list = [
+      TODOIST_SYNC_COMMAND = "/sync",
+      TODOIST_QUERY_COMMAND = "/query",
+      TODOIST_TEMPLATES_IMPORT_INTO_PROJECT_COMMAND = "/templates/import_into_project",
+      TODOIST_TEMPLATES_EXPORT_AS_FILE_COMMAND = "/templates/export_as_file",
+      TODOIST_TEMPLATES_EXPORT_AS_URL_COMMAND = "/templates/export_as_url",
+      TODOIST_UPLOADS_ADD_COMMAND = "/uploads/add",
+      TODOIST_UPLOADS_GET_COMMAND = "/uploads/get",
+      TODOIST_UPLOADS_DELETE_COMMAND = "/uploads/delete",
+      TODOIST_COMPLETED_GET_STATS_COMMAND = "/completed/get_stats",
+      TODOIST_COMPLETED_GET_ALL_COMMAND = "/completed/get_all",
+      TODOIST_PROJECTS_GET_ARCHIVED_COMMAND = "/projects/get_archived",
+      TODOIST_PROJECTS_GET_COMMAND = "/projects/get",
+      TODOIST_PROJECTS_GET_DATA_COMMAND = "/projects/get_data",
+      TODOIST_ITEMS_ADD_COMMAND = "/items/add",
+      TODOIST_ITEMS_GET_COMMAND = "/items/get",
+      TODOIST_QUICK_ADD_COMMAND = "/quick/add",
+      TODOIST_ACTIVITY_GET_COMMAND = "/activity/get",
+      TODOIST_BACKUPS_GET_COMMAND = "/backups/get",
+      TODOIST_USER_LOGIN_COMMAND = "/user/login"
+    ]
+    
+    # Map of commands to URIs
+    @@uri = nil
+    
+    # Artificial delay between requests to avoid API throttling
+    @@delay_between_requests = 0
+    
+    # Should API throttling happen (HTTP Error 429), retry_time between requests
+    # with exponential backoff
+    @@retry_time = 20
+
+    def self.retry_time=(retry_time)
+      @@retry_time = retry_time
+    end
+
+    def self.retry_time
+      @@retry_time
+    end
+    
+    def self.delay_between_requests=(delay_between_requests)
+      @@delay_between_requests = delay_between_requests
+    end
+    
+    def self.delay_between_requests
+      @@delay_between_requests
+    end
+
+    def self.getURI
+      if @@uri == nil
+        @@uri = {}
+        @@command_list.each do |command|
+          @@uri[command] =  URI.parse(TODOIST_API_URL + command)
+        end
+      end
+      return @@uri
+    end
+
+  end
+end

data/lib/todoist/misc/activity.rb

@@ -1,6 +1,6 @@
 module Todoist
   module Misc
-    class Activity
+    class Activity < Todoist::Service
         include Todoist::Util  
         
         # Returns the activity logs for a user.  Full list of supported 
@@ -16,11 +16,11 @@ module Todoist
         
         def get(params={})
           if params["until"]
-            params["until"] = ParseHelper.formatTime(params["until"])
+            params["until"] = ParseHelper.format_time(params["until"])
           end
           
           if params["since"]
-            params["since"] = ParseHelper.formatTime(params["since"])
+            params["since"] = ParseHelper.format_time(params["since"])
           end
           
           if params["object"]
@@ -43,7 +43,7 @@ module Todoist
             params.delete("initiator")
           end
             
-          result = NetworkHelper.getResponse(Config::TODOIST_ACTIVITY_GET_COMMAND, params)
+          result = @client.api_helper.get_response(Config::TODOIST_ACTIVITY_GET_COMMAND, params)
           ParseHelper.make_objects_as_hash(result)
         end
     end

data/lib/todoist/misc/backups.rb

@@ -1,11 +1,11 @@
 module Todoist
   module Misc
-    class Backups
+    class Backups < Todoist::Service
         include Todoist::Util  
         
         # Returns the backups for a user.
         def get()
-          result = NetworkHelper.getResponse(Config::TODOIST_BACKUPS_GET_COMMAND, {})
+          result = @client.api_helper.get_response(Config::TODOIST_BACKUPS_GET_COMMAND, {})
           ParseHelper.make_objects_as_hash(result)
         end
     end

data/lib/todoist/misc/completed.rb

@@ -1,12 +1,12 @@
 module Todoist
   module Misc
-    class Completed
+    class Completed < Todoist::Service
         include Todoist::Util  
         
         # Get productivity stats.  Returns a hash of statistics as documented
         # at https://developer.todoist.com/#get-productivity-stats
         def get_productivity_stats()
-          NetworkHelper.getResponse(Config::TODOIST_COMPLETED_GET_STATS_COMMAND)
+          @client.api_helper.get_response(Config::TODOIST_COMPLETED_GET_STATS_COMMAND, {})
         end
         
         # Retrieves all completed items as documented at 
@@ -17,13 +17,13 @@ module Todoist
         
         def get_all_completed_items(params = {})
           if params["until"]
-            params["until"] = ParseHelper.formatTime(params["until"])
+            params["until"] = ParseHelper.format_time(params["until"])
           end
           if params["since"]
-            params["since"] = ParseHelper.formatTime(params["since"])
+            params["since"] = ParseHelper.format_time(params["since"])
           end
           
-          result = NetworkHelper.getResponse(Config::TODOIST_COMPLETED_GET_ALL_COMMAND, params)
+          result = @client.api_helper.get_response(Config::TODOIST_COMPLETED_GET_ALL_COMMAND, params)
           items = ParseHelper.make_objects_as_array(result["items"])
           projects = ParseHelper.make_objects_as_array(result["projects"])
           return {"items" => items, "projects" => projects}

data/lib/todoist/misc/items.rb

@@ -1,6 +1,6 @@
 module Todoist
   module Misc
-    class Items
+    class Items < Todoist::Service
         include Todoist::Util  
         
         # Add a new task to a project. Note, that this is provided as a
@@ -30,7 +30,7 @@ module Todoist
           end
 
           params.merge(optional_params)
-          result = NetworkHelper.getResponse(Config::TODOIST_ITEMS_ADD_COMMAND, params)
+          result = @client.api_helper.get_response(Config::TODOIST_ITEMS_ADD_COMMAND, params)
           item = ParseHelper.make_object(result)
           return item
         end
@@ -43,7 +43,7 @@ module Todoist
         def get_item(item, all_data = true)
           params = {item_id: item.id, all_data: all_data}
           
-          result = NetworkHelper.getResponse(Config::TODOIST_ITEMS_GET_COMMAND, params)
+          result = @client.api_helper.get_response(Config::TODOIST_ITEMS_GET_COMMAND, params)
           item = ParseHelper.make_object(result["item"])
           project = ParseHelper.make_object(result["project"])
           notes = result["notes"] ? ParseHelper.make_objects_as_hash(result["notes"]) : nil

data/lib/todoist/misc/projects.rb

@@ -1,18 +1,18 @@
 module Todoist
   module Misc
-    class Projects
+    class Projects < Todoist::Service
         include Todoist::Util  
         
         # Get archived projects.  Returns projects as documented here.
         def get_archived_projects()
-          result = NetworkHelper.getResponse(Config::TODOIST_PROJECTS_GET_ARCHIVED_COMMAND)
+          result = @client.api_helper.get_response(Config::TODOIST_PROJECTS_GET_ARCHIVED_COMMAND)
           return ParseHelper.make_objects_as_hash(result)
         end
         
         # Gets project information including all notes.
         
         def get_project_info(project, all_data = true)
-          result = NetworkHelper.getResponse(Config::TODOIST_PROJECTS_GET_COMMAND, {project_id: project.id, all_data: true})
+          result = @client.api_helper.get_response(Config::TODOIST_PROJECTS_GET_COMMAND, {project_id: project.id, all_data: true})
           
           project = result["project"] ? ParseHelper.make_object(result["project"]) : nil
           notes = result["notes"] ? ParseHelper.make_objects_as_hash(result["notes"]) : nil
@@ -21,7 +21,7 @@ module Todoist
         
         # Gets a project's uncompleted items
         def get_project_data(project)
-          result = NetworkHelper.getResponse(Config::TODOIST_PROJECTS_GET_DATA_COMMAND, {project_id: project.id})
+          result = @client.api_helper.get_response(Config::TODOIST_PROJECTS_GET_DATA_COMMAND, {project_id: project.id})
           project = result["project"] ? ParseHelper.make_object(result["project"]) : nil
           items = result["items"] ? ParseHelper.make_objects_as_hash(result["items"]) : nil
           return {"project" => project, "items" => items}