todoist-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eae81f26048e5304824cb26dbb794166ecffcb90
+  data.tar.gz: 9a3c4c2bdd624e0c5f9c1b387a7014b4b1138ac1
+SHA512:
+  metadata.gz: f3fd6042062b81c40304c84608acd333c17309e7a2cac47d09203741147a5d8037a66209b40a583915d83826bfe44baeb2061ea8de11736d051018048a9dcc91
+  data.tar.gz: 6ab12386bcaff94b62512deca61d10088482bb8317987d29f83f4a97ca0877c71539ab17caf74233410712596fad8e5ea86b6b2e36d88be437a5b9c24daf13af

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+coverage
+/spec/token

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Han Yuan
+
+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,201 @@
+# Todoist Ruby
+
+This is an unofficial client library that interfaces with the [Todoist API](https://developer.todoist.com/).  
+
+## What's implemented
+
+### sync API
+
+The "sync" API is almost fully implemented with the exception of collaboration features.  
+
+* [Projects](https://developer.todoist.com/#projects)
+* [Templates](https://developer.todoist.com/#templates)
+* [Items](https://developer.todoist.com/#items)
+* [Labels](https://developer.todoist.com/#labels)
+* [Notes](https://developer.todoist.com/#notes)
+* [Filters](https://developer.todoist.com/#filters)
+* [Reminders](https://developer.todoist.com/#reminders)
+
+### Other APIs
+
+* [Miscellaneous](https://developer.todoist.com/#miscellaneous)
+* [Quick](https://developer.todoist.com/#quick)
+* [Activity](https://developer.todoist.com/#activity)
+* [Uploads](https://developer.todoist.com/#uploads)
+* [Backups](https://developer.todoist.com/#backups)
+
+In addition to the above mentioned APIs, there is also an implementation of the "query" method call provided (with limitations documented).
+
+## What's not implemented
+
+Generally speaking collaboration features are not supported through this API but contributions are welcome and encouraged primarily due to testing limitations and the requirement to have multiple accounts.  This includes:
+
+* [Emails](https://developer.todoist.com/#emails)
+* [User](https://developer.todoist.com/#user)
+* [Sharing](https://developer.todoist.com/#sharing)
+* [Live notifications](https://developer.todoist.com/#live-notifications)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'todoist-ruby'
+```
+
+or install from source
+
+```ruby
+gem "todoist-ruby", :git => "git://github.com/h6y3/todoist-ruby.git"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install todoist-ruby
+
+## Usage
+
+This section provides some simple scenarios to get started.  To use the library make sure you include the library as follows:
+
+```ruby
+require todoist
+```
+
+### Logging in and setting tokens
+
+Before you make any API calls, you **must** login.  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" 
+```
+
+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:
+
+```ruby
+Todoist::Config.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.
+
+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.
+
+Managers provides in the sync API all exist in the module ```Todoist::Sync```.
+
+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.
+
+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.
+
+#### Creating an item 
+
+```ruby 
+update_item = @item_manager.add({content: "Item3"})     
+## At this time update_item has a temporary id
+
+update_item.priority = 2
+result = @item_manager.update(update_item)
+# Up until this point update_item has not been created yet
+
+items_list =  @item_manager.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])
+# As is the case with other side-effects, issuing the call does not send the request immediately.  
+
+Todoist::Util::CommandSynchronizer.sync     
+# Manually calling sync deletes the item 
+```
+
+For more detailed examples, please review the unit tests located in the ```spec``` directory.
+
+### Other APIs
+
+The rest of the APIs are available in the ```Todoist::Misc``` module.  For lighterweight use cases, there are several interesting APIs of interest.  See Todoist documentation linked above.
+
+#### 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")
+# Unlike the sync API the item is already created after this method call and fully inflated
+```
+### Rate limiting
+
+According to the Todoist API documentation, the following limitations exist:
+
+  The maximum number of commands is 100 per request, and this is done to prevent timeouts and other problems when dealing with big requests.
+
+  There’s also a maximum number of 50 sync requests per minute for each user, in order to prevent clients from accidentally overloading our servers.
+
+In practice, the rate limit is much more aggressive than 50 sync requests per minute as far as I can tell.  Because of this, the unit tests make use of [vcr](https://github.com/vcr/vcr) to cache HTTP requests.  While it is unlikely clients will hit the rate limit besides unit test scenarios, it can be possible.
+
+The library provides two defenses against this.
+
+#### HTTP 429 Protection
+If an ```HTTP 429 Too Many Requests``` is received, the library can wait for a period of time and then retry with an exponential backoff.  To configure this parameter:
+
+```ruby
+Todoist::Util::Config.retry_time = 40
+# Default is 20s, adds a 40s delay
+```
+
+#### Delay between sync requests
+
+To set an artifical delay between sync requests:
+
+```ruby
+Todoist::Util::Config.delay_between_requests = 2
+# Default is 0, adds a 2s delay
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.  You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To run the unit tests, a development token is needed and should be stored on the first line of a file located at ```spec/token```.
+
+Due to rate limiting, running ```rake``` will result in HTTP 429 codes.  Instead, it is recommended that tests be run individually for the area that you wish to develop:
+
+```
+rspec spec/misc_items_spec.rb
+```
+
+The unit tests generate a set of 100 UUIDs for both temporary ids and command_uuids.  This is done so that when the VCR gem records the user interaction, the HTTP requests match.  When there are bugs in the test that propogate to problematic network calls, you will need to clean both the generated UUIDs and the VCR recordings.  To do this, a rake command is provided:
+
+```
+rake spec:clean["misc_items"]
+# Cleans up VCR and UUIDs for artifacts with the "misc_items" prefix
+```
+
+Once tests pass cleanly, subsquent runs that do not change the network requests run quickly since no network calls are made and in fact ```rake``` can be run with no issues.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/h6y3/todoist-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :spec do 
+  desc "Delete VCR and pre-generated UUID files"
+  task :clean_all do
+    FileUtils.rm Dir.glob('fixtures/uuid/*.yml')
+    FileUtils.rm Dir.glob('fixtures/vcr_cassettes/*.yml')
+  end
+  desc "Delete VCR and pre-generated UUID files for a specific resource"
+  task :clean, [:resource] do |t, args|
+    FileUtils.rm Dir.glob("fixtures/uuid/#{args[:resource]}*.yml")
+    FileUtils.rm Dir.glob("fixtures/vcr_cassettes/#{args[:resource]}*.yml")
+  end
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "todoist"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fixtures/.gitignore

@@ -0,0 +1,6 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore
+!uuid
+!vcr_cassettes

data/fixtures/uuid/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

data/fixtures/vcr_cassettes/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

data/lib/todoist.rb

@@ -0,0 +1,23 @@
+require "todoist/version"
+require "todoist/util/api_helper"
+require "todoist/util/network_helper"
+require "todoist/sync/items"
+require "todoist/sync/labels"
+require "todoist/sync/projects"
+require "todoist/sync/notes"
+require "todoist/sync/reminders"
+require "todoist/sync/filters"
+require "todoist/misc/templates"
+require "todoist/misc/uploads"
+require "todoist/misc/completed"
+require "todoist/misc/projects"
+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
+
+end

data/lib/todoist/misc/activity.rb

@@ -0,0 +1,51 @@
+module Todoist
+  module Misc
+    class Activity
+        include Todoist::Util  
+        
+        # Returns the activity logs for a user.  Full list of supported 
+        # parameters outlined in the API here: https://developer.todoist.com/#activity
+        # The following objects are converted into parameters as appropriate:
+        #
+        # * object
+        # * parent_project
+        # * parent_item
+        # * initiator
+        # * until
+        # * since
+        
+        def get(params={})
+          if params["until"]
+            params["until"] = ParseHelper.formatTime(params["until"])
+          end
+          
+          if params["since"]
+            params["since"] = ParseHelper.formatTime(params["since"])
+          end
+          
+          if params["object"]
+            params["object_id"] = params["object"].id
+            params.delete("object")
+          end
+          
+          if params["parent_object"]
+            params["parent_object_id"] = params["parent_object"].id
+            params.delete("parent_object")
+          end
+          
+          if params["parent_item"]
+            params["parent_item_id"] = params["parent_item"].id
+            params.delete("parent_item")
+          end
+          
+          if params["initiator"]
+            params["initiator_id"] = params["initiator"].id
+            params.delete("initiator")
+          end
+            
+          result = NetworkHelper.getResponse(Config::TODOIST_ACTIVITY_GET_COMMAND, params)
+          ParseHelper.make_objects_as_array(result)
+        end
+    end
+  end
+end