todoist_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daaf0e3c2b23ff8f526a58e0c4bcaba96d7c8ab0
-  data.tar.gz: 7801782fffd4985061175702c616c43dcad303e7
+  metadata.gz: c2b2d7aee3f1adc50907f02b6e661a49b62a5b52
+  data.tar.gz: d19483330538c142f0c6a4b372e9a9a3bb514760
 SHA512:
-  metadata.gz: c4b7df3adb7bf4ba4ca3c7f96585a9376796086c5aac866d27aa3432dd043fdd772a8267f2a70a531b0ff3b6128d69d7677b4b4f7c73c909f5418dd59783a61b
-  data.tar.gz: bc0641e163de0eb16f1b761143b4817df1cccceb2a3b219734d3a4bbd3e948658c42eef88b1edf4d29f8f8797dc42c887234d3f35f89f42c26640059c121a222
+  metadata.gz: 7b0ec160b53fee8a9d4b61c02bbd279b177f0da891932bd90cdc0f8fd2912ea5425ea9f8a0fb10942aee4cf11771355515858803b3ff9fdc413be5f92d88485c
+  data.tar.gz: d811f07f039f85fc7396182b83dc155804815872cf598d506e9670e76c488cb9aa2adb48167d76d0c95a4651d3d31fb8e2f12aed06cd19c225538d0597b28c58

data/README.md

@@ -1,6 +1,8 @@
 # TodoistClient
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/todoist_client.svg)](http://badge.fury.io/rb/todoist_client)
+
+Todoist API Client.
 
 ## Installation
 
@@ -18,7 +20,57 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### API Token
+
+Copy from account setting in Todoist.
+
+```
+TodoistClient.api_token = 'some_api_token'
+```
+
+#### Project
+
+```
+# create project
+project = TodoistClient::Project.create(name: "SomeProject")
+puts [project.id, project.name].join(":") # => 123:SomeProject
+
+project = TodoistClient::Project.find(some_id)
+project.name = "OtherProject"
+project.save # => update
+project.delete # => delete
+
+TodoistClient::Project.all.each do |project|
+  # number of uncompleted tasks
+  puts project.uncompleted_items.size
+end
+```
+
+#### Item
+
+```
+# create item
+item = TodoistClient::Item.create(content: "SomeTask")
+puts [item.id, item.content] # => 123:SomeTask
+
+item = TodoistClient::Item.find(some_id)
+item.finished? # => false (if incomplete item)
+item.content = "OtherTask"
+item.save # => update
+item.complete # => to complete
+item.uncomplete # => to uncomplete
+item.delete # => delete
+
+project = TodoistClient::Project.find(some_id)
+TodoistClient::Item.uncompleted(project).each do |item|
+  item.complete
+end
+
+# only premium user
+TodoistClient::Item.completed_items.each do |completed_item|
+  puts [completed_item.completed_date.to_s, completed_item.content].join(":")
+end
+```
 
 ## Contributing
 

data/lib/todoist_client/api_client.rb

@@ -6,15 +6,27 @@ module TodoistClient
       klass.extend ClassMethods
     end
 
+    def with_remote_object(&block)
+      if id
+        block.call if block_given?
+      else
+        raise RemoteObjectNotExists
+      end
+    end
+
+    def set_params(params)
+      params.each do |k,v|
+        self.send "#{k}=", v if self.respond_to? "#{k}="
+      end
+    end
+
     module ClassMethods
       def request(method, endpoint, params = nil)
-        p "#{BASE_URI}#{endpoint}"
-        p query_string(params)
         JSON.load RestClient.send(method, "#{BASE_URI}#{endpoint}", query_string(params))
       end
       
       def query_string(params = nil)
-        raise NoApiToken, "API Token not find" unless TodoistClient.api_token
+        raise NoApiToken unless TodoistClient.api_token
         params ||= {}
         {
           params: {

data/lib/todoist_client/completed_item.rb

@@ -0,0 +1,39 @@
+module TodoistClient
+  # only premium user
+  class CompletedItem
+    include ApiClient
+
+    VALID_PARAMS = [
+      :content,
+      :meta_data,
+      :user_id,
+      :task_id,
+      :note_count,
+      :project_id,
+      :completed_date,
+      :id
+    ].freeze
+
+    attr_accessor *VALID_PARAMS
+
+    def initialize(params)
+      raise ArgumentError if params["id"].nil?
+      set_params(params)
+    end
+
+    def completed_date=(date_string)
+      @completed_date = case
+      when date_string.is_a?(String)
+        Time.parse(date_string)
+      when date_string.is_a?(Time)
+        date_string
+      else
+        raise ArgumentError
+      end
+    end
+
+    def to_item
+      Item.find(@task_id)
+    end
+  end
+end

data/lib/todoist_client/errors.rb

@@ -1,4 +1,5 @@
 module TodoistClient
   class TodoistClientError < StandardError; end
   class NoApiToken < TodoistClientError; end
+  class RemoteObjectNotExists < TodoistClientError; end
 end

data/lib/todoist_client/item.rb

@@ -22,6 +22,7 @@ module TodoistClient
     module Paths
       UNCOMPLETED = [:get, "/API/getUncompletedItems"]
       COMPLETED = [:get, "/API/getCompletedItems"]
+      ALL_COMPLETED = [:get, "/API/getAllCompletedItems"]
       FIND = [:get, "/API/getItemsById"]
       ADD = [:get, "/API/addItem"]
       UPDATE = [:get, "/API/updateItem"]
@@ -31,59 +32,87 @@ module TodoistClient
     end
 
     def initialize(params = nil)
-      set_params(params) if params
+      case
+      when params.is_a?(String)
+        @content = params
+      when params.is_a?(Hash)
+        set_params(params)
+      end
     end
 
     def save
       if id
         json = self.class.request *Paths::UPDATE, {
-          id: id,
-          content: content
-        }
+          id: @id, # required
+          content: @content,
+          priority: @priority,
+          indent: @indent,
+          item_order: @item_order,
+          collapsed: @collapsed
+        }.select {|k,v| !v.nil?}
       else
         json = self.class.request *Paths::ADD, {
-          content: content,
-          project_id: project_id
-        }
+          content: @content, # required
+          project_id: @project_id,
+          date_string: @date_string,
+          priority: @priority,
+          indent: @indent,
+          item_order: @item_order
+        }.select {|k,v| !v.nil?}
       end
       set_params(json)
+      self
     end
 
     def delete
-      self.class.request *Paths::DELETE, {ids: JSON.generate([id])} if id
+      with_remote_object do
+        self.class.request *Paths::DELETE, {ids: JSON.generate([id])}
+      end
     end
 
     def complete
-      self.class.request *Paths::COMPLETE, {ids: JSON.generate([id])} if id
+      with_remote_object do
+        self.class.request *Paths::COMPLETE, {ids: JSON.generate([id])}
+      end
     end
 
     def uncomplete
-      self.class.request *Paths::UNCOMPLETE, {ids: JSON.generate([id])} if id
+      with_remote_object do
+        self.class.request *Paths::UNCOMPLETE, {ids: JSON.generate([id])}
+      end
     end
 
-    def set_params(params)
-      params.each do |k,v|
-        self.send "#{k}=", v if self.respond_to? "#{k}="
-      end
+    def finished?
+      checked == 1
     end
 
     class << self
-      def uncompleted(project_id)
-        request(*Paths::UNCOMPLETED, {project_id: project_id}).map { |item|
-          self.new(item)
-        }
+      def uncompleted(project)
+        project_id = project.is_a?(Project) ? project.id : project
+        request(*Paths::UNCOMPLETED, {project_id: project_id}).map {|item| self.new(item)}
+      end
+
+      def completed(project)
+        project_id = project.is_a?(Project) ? project.id : project
+        request(*Paths::COMPLETED, {project_id: project_id}).map {|item| self.new(item)}
       end
 
-      def completed(project_id)
-        request(*Paths::COMPLETED, {project_id: project_id}).map { |item|
-          self.new(item)
+      # only premium user
+      def completed_items(project = nil)
+        project_id = project.is_a?(Project) ? project.id : project
+        request(*Paths::ALL_COMPLETED, {project_id: project_id})["items"].map {|item|
+          CompletedItem.new(item)
         }
       end
 
       def find(ids)
-        request(*Paths::FIND, {ids: json_ids(ids)}).map { |item|
-          self.new(item)
-        }
+        items = request(*Paths::FIND, {ids: json_ids(ids)}).map {|item| self.new(item)}
+        # return nil or Item object if item does not exist multiple.
+        items.size > 1 ? items : items.first
+      end
+
+      def create(params)
+        self.new(params).save
       end
 
       def delete_all(ids)

data/lib/todoist_client/project.rb

@@ -22,57 +22,70 @@ module TodoistClient
       ADD = [:get, "/API/addProject"]
       UPDATE = [:get, "/API/updateProject"]
       DELETE = [:get, "/API/deleteProject"]
-      # ARCHIVE = [:get, "/API/archiveProject"]
-      # UNARCHIVE = [:get, "/API/unarchiveProject"]
+      ARCHIVE = [:get, "/API/archiveProject"]
+      UNARCHIVE = [:get, "/API/unarchiveProject"]
     end
 
     def initialize(params = nil)
-      set_params(params) if params
+      case
+      when params.is_a?(String)
+        @name = params
+      when params.is_a?(Hash)
+        set_params(params)
+      end
     end
 
     def save
       if id
         json = self.class.request *Paths::UPDATE, {
-          project_id: id,
-          name: name,
-          color: color,
-          indent: indent,
-          order: item_order
-        }
+          project_id: @id, # required
+          name: @name,
+          color: @color,
+          indent: @indent,
+          order: @item_order
+        }.select {|k,v| !v.nil?}
       else
         json = self.class.request *Paths::ADD, {
-          name: name,
-          color: color,
-          indent: indent,
-          order: item_order
-        }
+          name: @name, # required
+          color: @color,
+          indent: @indent,
+          order: @item_order
+        }.select {|k,v| !v.nil?}
       end
       set_params(json)
+      self
     end
 
     def delete
-      self.class.request *Paths::DELETE, {project_id: id} if id
+      with_remote_object do
+        self.class.request *Paths::DELETE, {project_id: id}
+      end
     end
 
-    # def archive
-    #   self.class.request *Paths::ARCHIVE, {project_id: id} if id
-    # end
+    # only premium user
+    def archive
+      with_remote_object do
+        self.class.request *Paths::ARCHIVE, {project_id: id}
+      end
+    end
 
-    # def unarchive
-    #   self.class.request *Paths::UNARCHIVE, {project_id: id} if id
-    # end
+    # only premium user
+    def unarchive
+      with_remote_object do
+        self.class.request *Paths::UNARCHIVE, {project_id: id}
+      end
+    end
 
     def uncompleted_items
-      Item.uncompleted(id) if id
+      with_remote_object do
+        Item.uncompleted(id)
+      end
     end
 
+    # only premium user
     def completed_items
-      Item.completed(id) if id
-    end
-
-    def set_params(params)
-      params.each do |k,v|
-        self.send "#{k}=", v if self.respond_to? "#{k}="
+      with_remote_object do
+        Item.completed_items(id)
       end
     end
 
@@ -85,8 +98,8 @@ module TodoistClient
         self.new(request(*Paths::FIND, {project_id: id}))
       end
 
-      def create(name)
-        self.new(name).save
+      def create(params)
+        self.new(params).save
       end
     end
   end

data/lib/todoist_client/version.rb

@@ -1,3 +1,3 @@
 module TodoistClient
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/todoist_client.rb

@@ -6,4 +6,5 @@ require "todoist_client/errors"
 require "todoist_client/api_client"
 require "todoist_client/project"
 require "todoist_client/item"
+require "todoist_client/completed_item"
 require "todoist_client/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todoist_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - i2bskn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-01 00:00:00.000000000 Z
+date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - lib/todoist_client.rb
 - lib/todoist_client/api_client.rb
 - lib/todoist_client/base.rb
+- lib/todoist_client/completed_item.rb
 - lib/todoist_client/errors.rb
 - lib/todoist_client/item.rb
 - lib/todoist_client/project.rb