ruby-todoist-api 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b507fa8fca73baa2ead62502e01e13594845643
+  data.tar.gz: 247941d5ae67bb886031300163bf8dde9d03d786
+SHA512:
+  metadata.gz: 15b90aaed52b0088af9d8b646fefd58ea3600d2722dd6347b9c7ac3976d2fb66ce1205c7a991e01d8698deef38154d951b0c436090abdcae715b5234f696b195
+  data.tar.gz: b0ac8033d9612ad994ca382a83452df7d6801cac805d437527a2c5620849b7fea047f89d6d2fea1c183cb31fe15a34fd18b327538bbea0fdf486a1395812f42c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.kick

@@ -0,0 +1,18 @@
+require 'set'
+require 'benchmark'
+
+process do |file, flags|
+  test_files = Set.new
+  case file
+  when %r(^spec/.*_spec.rb$)
+    test_files << file
+  when %r(^lib/(.*).rb)
+    test_files << 'spec/lib/' + $1 + '_spec.rb'
+  when %r(^spec/helpers/expected)
+    test_files.merge Dir['spec/helpers/**/*_spec.rb']
+  end
+  test_files = test_files.select { |filename| File.exist?(filename) }
+  unless test_files.empty?
+    watcher.execute("bundle exec rspec --fail-fast #{test_files.to_a.join(' ')}")
+  end
+end

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--profile
+--order rand

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.1.0
+  - 2.2.0
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in todoist-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Maarten van Vliet
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+[![Build Status](https://travis-ci.org/maartenvanvliet/ruby-todoist-api.svg)](https://travis-ci.org/maartenvanvliet/ruby-todoist-api)
+
+# Todoist::Api
+
+Gem to wrap the Todoist Api v6 as described on https://developer.todoist.com/
+
+*Note:* Until a more complete coverage of the all Todoist features is achieved the api is unstable and no semantic versioning will be applied.
+
+## Goals
+
+* To provide an easy to use, well tested, wrapper for the Todoist Api
+* Use a minimal set of dependencies apart from the Ruby standard library (exception for development dependencies, although also bare minimum).
+* Ruby 2.1 and up
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'todoist-api', git: 'https://github.com/maartenvanvliet/ruby-todoist-api', branch: 'master', require: 'todoist'
+
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+    todoist = Todoist::Client.new(todoist_token)
+    todoist.items.create(content: 'Some new todo')
+    todoist.process!
+
+## Future
+
+Possible spinoff would be a gem to do provide a CLI interface to Todoist.
+
+## Contributing
+
+1. Fork it ( https://github.com/maartenvanvliet/ruby-todoist-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/todoist.rb

@@ -0,0 +1,27 @@
+require "net/http"
+require 'securerandom'
+
+module Todoist; end
+
+require 'todoist/client'
+require 'todoist/command'
+require 'todoist/resource'
+require 'todoist/error'
+require 'todoist/filter'
+require 'todoist/item'
+require 'todoist/label'
+require 'todoist/note'
+require 'todoist/project'
+require 'todoist/query'
+require 'todoist/queue'
+require 'todoist/user'
+require 'todoist/reminder'
+require 'todoist/request'
+require 'todoist/service/base_service'
+require 'todoist/service/filter'
+require 'todoist/service/item'
+require 'todoist/service/label'
+require 'todoist/service/note'
+require 'todoist/service/project'
+require 'todoist/service/reminder'
+require 'todoist/version'

data/lib/todoist/client.rb

@@ -0,0 +1,94 @@
+module Todoist
+  class Client
+    attr_reader :token, :queue, :_last_response
+    attr_writer :seq_no, :seq_no_global
+    attr_accessor :errors
+
+    SUCCES_STATUS_CODE = 200
+
+    def initialize(token)
+      @token = token
+    end
+
+    def base_url
+      "https://todoist.com"
+    end
+
+    def filters
+      @filters ||= Service::Filter.new(self)
+    end
+
+    def items
+      @items ||= Service::Item.new(self)
+    end
+
+    def labels
+      @labels ||= Service::Label.new(self)
+    end
+
+    def notes
+      @notes ||= Service::Note.new(self)
+    end
+
+    def projects
+      @projects ||= Service::Project.new(self)
+    end
+
+    def reminders
+      @reminders ||= Service::Reminder.new(self)
+    end
+
+    def query
+      @query ||= Query.new(self)
+    end
+
+    def queue
+      @queue ||= Queue.new(self)
+    end
+
+    def seq_no
+      @seq_no ||= 0
+    end
+
+    def seq_no_global
+      @seq_no_global ||= 0
+    end
+
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = 'todoist-api'
+      end
+    end
+
+    def post(path, payload)
+      post_request = Request.post(path, payload.merge(token: token))
+
+      response = @_last_response = post_request.execute(base_url)
+
+      if response.code.to_i != SUCCES_STATUS_CODE
+        self.errors = JSON.parse(@_last_response.body.to_s)
+        return false
+      else
+        parsed_response = JSON.parse(response.body)
+
+        self.seq_no_global = parsed_response['seq_no_global'] if parsed_response.is_a?(Hash) && parsed_response['seq_no_global']
+
+        parsed_response
+      end
+    end
+
+    def process!
+      queue.process!
+    end
+
+    def process_queue
+      logger.warn 'Deprecated process_queue'
+      queue.process!
+    end
+
+    def add_to_queue(command)
+      logger.warn 'Deprecated process_queue'
+      queue.add(command)
+    end
+  end
+end

data/lib/todoist/command.rb

@@ -0,0 +1,24 @@
+module Todoist
+  class Command
+    attr_accessor :type, :object, :temp_id, :uuid
+
+    def initialize(type, object, temp_id = nil, uuid = nil)
+      @type = type
+      @object = object
+      @temp_id = object.temp_id
+      @uuid = uuid || SecureRandom.uuid
+    end
+
+    def arguments
+      object.to_submittable_hash
+    end
+
+    def to_hash
+      {
+        type: type,
+        uuid: uuid,
+        args: object.to_submittable_hash
+      }.merge(temp_id ? { temp_id: temp_id} : {})
+    end
+  end
+end

data/lib/todoist/filter.rb

@@ -0,0 +1,16 @@
+module Todoist
+  class Filter
+    include Todoist::Resource
+    extend Todoist::Resource::ClassMethods
+
+    define_attributes %w(
+      id
+      user_id
+      name
+      query
+      color
+      item_order
+      is_deleted
+    )
+  end
+end

data/lib/todoist/item.rb

@@ -0,0 +1,54 @@
+module Todoist
+  class Item
+    include Todoist::Resource
+    extend Todoist::Resource::ClassMethods
+
+    define_attributes %w(
+      id
+      user_id
+      project_id
+      content
+      date_string
+      date_lang
+      priority
+      indent
+      item_order
+      day_order
+      collapsed
+      children
+      labels
+      assigned_by_uid
+      responsible_uid
+      checked
+      in_history
+      is_deleted
+      is_archived
+      sync_id
+      due_date_utc
+      due_date
+      date_added
+      postpone_count
+      complete_count
+      mm_offset
+      seq_no
+      has_notifications
+    )
+
+    define_read_only_attributes %w(
+      has_notifications
+      postpone_count
+      complete_count
+      mm_offset
+      seq_no
+    )
+
+    def project=(project)
+      self.project_id = project.to_hash['id']
+    end
+
+    def user=(user)
+      self.user_id = user.to_hash['id']
+    end
+
+  end
+end

data/lib/todoist/label.rb

@@ -0,0 +1,15 @@
+module Todoist
+  class Label
+    include Todoist::Resource
+    extend Todoist::Resource::ClassMethods
+
+    define_attributes %w(
+      id
+      uid
+      name
+      color
+      item_order
+      is_deleted
+    )
+  end
+end

data/lib/todoist/note.rb

@@ -0,0 +1,19 @@
+module Todoist
+  class Note
+    include Todoist::Resource
+    extend Todoist::Resource::ClassMethods
+
+    define_attributes %w(
+      id
+      item_id
+      posted_uid
+      project_id
+      content
+      is_deleted
+      is_archived
+      file_attachment
+      uids_to_notify
+      posted
+    )
+  end
+end

data/lib/todoist/project.rb

@@ -0,0 +1,32 @@
+module Todoist
+  class Project
+    include Todoist::Resource
+    extend Todoist::Resource::ClassMethods
+
+    define_attributes %w(
+      id
+      user_id
+      name
+      color
+      indent
+      item_order
+      collapsed
+      shared
+      is_deleted
+      is_archived
+      archived_date
+      archived_timestamp
+      inbox_project
+    )
+
+    define_read_only_attributes %w(
+      inbox_project
+    )
+
+    def items
+      @items ||= Service::Item.new(client)
+    end
+
+
+  end
+end

data/lib/todoist/query.rb

@@ -0,0 +1,47 @@
+module Todoist
+  class Result
+    include Enumerable
+
+    attr_reader :data
+
+    def initialize(result)
+      @query = result['query']
+      @data = result['data']
+    end
+
+    def each(&block)
+      data.each do |object|
+        block.call(Todoist::Item.new(object))
+      end
+    end
+
+    def size
+      data.size
+    end
+
+  end
+
+  class Query
+    def initialize(client)
+      @client = client
+    end
+
+    def query_path
+      '/API/v6/query'
+    end
+
+    def search(queries)
+      if queries.is_a?(String)
+        queries = [queries]
+      end
+
+      parsed_response = @client.post(query_path, { queries: queries.to_json})
+
+      result_set = parsed_response.inject({}) do |results, query|
+        results[query['query']] = Todoist::Result.new(query)
+        results
+      end
+      result_set
+    end
+  end
+end