huginn_todoist_agent 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ca365adb5f28bda8ef577fa8a4017aab9a6172b
-  data.tar.gz: d28f19d9cfb515f1ce60a0f20f012d4856fbeb3c
+  metadata.gz: 8d8c15f6621a564f83f036dee3c3e979df08d0ee
+  data.tar.gz: 9f340be304f7ab80ef1aa3ba0b9fa2e41dd5dc49
 SHA512:
-  metadata.gz: 7194225fa429faa9934a4708a7c4195f10c33314535bd7b311020c8b8fcafee621e3c51e9e0a23c7fc5b105a21e9fe9111ea62f7baca1b690bc1ff8cd52a711e
-  data.tar.gz: da84042d9438f59b6b03dbf199b22da6de4b6e185a8f137614e83e5fc877a2840d831b815d09472f0a55f2eee8b79b04440977c8bcd545071b596e69a7c25eb3
+  metadata.gz: bbe20813067886e217031d70d5f88d97bd249231cb00e855dd0c7ec43ed988abda84dd9c6d36be8a4f69b8bbf0c463e0615747172d8443a7013f9fb9390401dd
+  data.tar.gz: 52703f25afebc3f72ffdcb138a1405e7f72a30dcf71321a2209a39632dff156f6372b2fafec81fd1ab2f8a06907a0d48f4c25962520d66407e6c98f2878d0bc5

data/lib/huginn_todoist_agent.rb

@@ -10,4 +10,5 @@ end
 
 #HuginnAgent.load 'huginn_todoist_agent/concerns/my_agent_concern'
 HuginnAgent.register 'huginn_todoist_agent/todoist_agent'
+HuginnAgent.register 'huginn_todoist_agent/todoist_close_item_agent'
 HuginnAgent.register 'huginn_todoist_agent/todoist_query_agent'

data/lib/huginn_todoist_agent/todoist_close_item_agent.rb

@@ -0,0 +1,66 @@
+module Agents
+  class TodoistCloseItemAgent < Agent
+    include FormConfigurable
+
+    cannot_create_events!
+
+    gem_dependency_check { defined?(Todoist::Client) }
+
+    description do
+      <<-MD
+        The Todoist Close Item Agent closes items on your Todoist.
+
+        To authenticate you need to either set `api_token` or provide a credential named
+        `todoist_api_token` to your Todoist API token.  You can find it within the
+        Todoist web frontend from "Gear Menu" > Todoist Settings > Account tab.
+
+	Change `id` to whatever the ID of the item you would want to be closed is.  You
+	can also route query results from "Todoist Query Agent" to this agent and
+	interpolate it using `{{ id }}` to close all items included in the search result.
+      MD
+    end
+
+    default_schedule "never"
+
+    def default_options
+      {
+        "api_token" => "",
+        "id" => "",
+      }
+    end
+
+    form_configurable :api_token
+    form_configurable :id
+
+    def working?
+      !recent_error_logs?
+    end
+
+    def validate_options
+      errors.add(:base, "you need to specify your Todoist API token or provide a credential named todoist_api_token") unless options["api_token"].present? || credential("todoist_api_token").present?
+      errors.add(:base, "id must not be empty, use `{{ id }}` if you'd like Huginn to use the id from the incoming event") unless options["id"].present?
+    end
+
+    def check
+      log "closing item: #{interpolated["id"]}"
+      todoist = Todoist::Client.new(interpolated["api_token"].present? ? interpolated["api_token"] : credential("todoist_api_token"))
+      todoist.items.close(interpolated["id"])
+      todoist.queue.process!
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        interpolate_with(event) do
+
+          log "closing item: #{interpolated["id"]}"
+          todoist = Todoist::Client.new(interpolated["api_token"].present? ? interpolated["api_token"] : credential("todoist_api_token"))
+          todoist.items.close(interpolated["id"])
+	  todoist.queue.process!
+        end
+      end
+    end
+
+  end
+end
+
+

data/spec/todoist_agent_spec.rb

@@ -25,7 +25,7 @@ describe Agents::TodoistAgent do
 
     @expected_token = "some_token_here"
     @sent_requests = Array.new
-    stub_request(:post, "https://todoist.com/API/v6/sync").
+    stub_request(:post, "https://todoist.com/API/v7/sync").
       to_return { |request|
 	expect(request.headers["Content-Type"]).to eq("application/x-www-form-urlencoded")
 

data/spec/todoist_close_item_agent_spec.rb

@@ -0,0 +1,82 @@
+require "rails_helper"
+require "huginn_agent/spec_helper"
+require "uri"
+
+require_relative "./spec_helper"
+
+describe Agents::TodoistCloseItemAgent do
+  before(:each) do
+    @valid_options = {
+        "api_token" => "some_token_here",
+        "id" => "1234",
+    }
+    @checker = Agents::TodoistCloseItemAgent.new(:name => "TodoistCloseItemAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  describe "#validate_options" do
+    before do
+      expect(@checker).to be_valid
+    end
+
+    it "should reject an empty api_token" do
+      @checker.options["api_token"] = nil
+      expect(@checker).not_to be_valid
+    end
+
+    it "should allow a credential (instead of api_token)" do
+      @checker.user.user_credentials.create :credential_name => "todoist_api_token", :credential_value => "some_credential_here"
+      @checker.options["api_token"] = nil
+      expect(@checker).to be_valid
+    end
+
+    it "should reject an empty id field" do
+      @checker.options["id"] = nil
+      expect(@checker).not_to be_valid
+    end
+  end
+
+  def assert_item_close(item_id)
+    expect(WebMock).to have_requested(:post, "https://todoist.com/API/v7/sync").
+    with { |request|
+      expect(request.headers["Content-Type"]).to eq("application/x-www-form-urlencoded")
+
+      form_data = URI.decode_www_form(request.body)
+      expect(form_data.assoc("token").last).to eq("some_token_here")
+
+      json_data = ActiveSupport::JSON.decode(form_data.assoc("commands").last)
+      expect(json_data.length).to eq(1)
+
+      expect(json_data[0]["type"]).to eq("item_close")
+      expect(json_data[0]["args"]["id"]).to eq(item_id)
+    }
+  end
+
+  describe "#check" do
+    it "should close the referenced item" do
+      stub_request(:post, "https://todoist.com/API/v7/sync").to_return(:status => 200, :body => '{}')
+
+      @checker.check
+      assert_item_close "1234"
+    end
+
+  end
+
+  describe "#receive" do
+    it "should close the referenced item via interpolation" do
+      stub_request(:post, "https://todoist.com/API/v7/sync").to_return(:status => 200, :body => '{}')
+
+      event = Event.new
+      event.agent = agents(:bob_weather_agent)
+      event.payload = {
+        "id" => "2345",
+      }
+
+      @checker.options["id"] = "{{ id }}"
+
+      @checker.receive([event])
+      assert_item_close "2345"
+    end
+  end
+end

data/spec/todoist_query_agent_spec.rb

@@ -45,7 +45,7 @@ describe Agents::TodoistQueryAgent do
 
   describe "#check" do
     before :each do
-      stub_request(:post, "https://todoist.com/API/v6/query").
+      stub_request(:post, "https://todoist.com/API/v7/query").
         with(:body => {"queries" => "[\"overdue\"]", "token" => "some_token_here"}).
         to_return(:status => 200, :body => json_response_raw("query_overdue"), :headers => {})
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_todoist_agent
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stefan Siegl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-todoist-api
+  name: ruby-todoist-api-v7
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: todoist_querynaut
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description: The Todoist Agent will create one item on your Todoist for every Huginn
-  event it receives.
+description: The Todoist Agents allow to create new as well as query and close existing
+  items on your Todoist.
 email:
 - stesie@brokenpipe.de
 executables: []
@@ -91,10 +91,12 @@ files:
 - LICENSE.txt
 - lib/huginn_todoist_agent.rb
 - lib/huginn_todoist_agent/todoist_agent.rb
+- lib/huginn_todoist_agent/todoist_close_item_agent.rb
 - lib/huginn_todoist_agent/todoist_query_agent.rb
 - spec/fixtures/query_overdue.json
 - spec/spec_helper.rb
 - spec/todoist_agent_spec.rb
+- spec/todoist_close_item_agent_spec.rb
 - spec/todoist_query_agent_spec.rb
 homepage: https://github.com/stesie/huginn_todoist_agent
 licenses:
@@ -116,12 +118,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
-summary: Huginn agent to add items to your Todoist.
+summary: Huginn agent to add, query and close items on your Todoist.
 test_files:
 - spec/fixtures/query_overdue.json
-- spec/todoist_agent_spec.rb
-- spec/todoist_query_agent_spec.rb
 - spec/spec_helper.rb
+- spec/todoist_query_agent_spec.rb
+- spec/todoist_close_item_agent_spec.rb
+- spec/todoist_agent_spec.rb