huginn_todoist_agent 0.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fa7c7d07478fe20d4e6615c5dc1888717fbea36
-  data.tar.gz: 85253fc515dcf5b317956a39e56ee5a3016db05f
+  metadata.gz: ceaded2f438e7776737271ddd74d420635c51f6a
+  data.tar.gz: 65cc2cc94fffbe3b4295a63ade0b58e66b78bf10
 SHA512:
-  metadata.gz: df7be486f40ee95d74a4db03a8c98cc8a8b762a6d20f624aa28b07fe1d0a58192300e26cf61b14cab93862b3ed8c19eb06b3b74fa47dd4e98c6e5c067e7a3f87
-  data.tar.gz: 7bb8c657d62a72379b4c6034cca488482260466c3cf146024df4bf116087ba2f5a7f88e7ede6da20ff08c231692550102c0d5bd0c46e3e71583f28f383a26b97
+  metadata.gz: 6cbe9da9d7d30f012138d3d9dc934e0a16219dce2249443b64c6fd4f98b9ad09d38479894f66ae02ebbf46a89bac6238a8718af832715b934d3de5dd27c9bdcf
+  data.tar.gz: 9bc0e9eb66217d6b4566e5246df7694c51dde0e6800b643e357b80d903e90031c414e5ce73724f021f53e9bbff6c4d384ec6266e0d4c6f16602824a7efea316d

data/lib/huginn_todoist_agent.rb

@@ -4,8 +4,10 @@ require 'huginn_agent'
 # still starts up successfully, yet shows "Missing Gems" error in the frontend.
 begin
   require 'todoist'
+  require 'todoist_querynaut'
 rescue LoadError
 end
 
 #HuginnAgent.load 'huginn_todoist_agent/concerns/my_agent_concern'
 HuginnAgent.register 'huginn_todoist_agent/todoist_agent'
+HuginnAgent.register 'huginn_todoist_agent/todoist_query_agent'

data/lib/huginn_todoist_agent/todoist_query_agent.rb

@@ -0,0 +1,61 @@
+module Agents
+  class TodoistQueryAgent < Agent
+    include FormConfigurable
+
+    cannot_receive_events!
+
+    gem_dependency_check { defined?(Todoist::Client) && defined?(TodoistQuerynaut::Client) }
+
+    description do
+      <<-MD
+        The Todoist Query Agent allows to search 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 `query` to the [Todoist filter expression](https://support.todoist.com/hc/en-us/articles/205248842-Filters)
+        you'd like to be carried out. 
+      MD
+    end
+
+    default_schedule "every_1h"
+
+    def default_options
+      {
+        "api_token" => "",
+        "query" => "today | overdue",
+      }
+    end
+
+    form_configurable :api_token
+    form_configurable :query, type: :text
+
+    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?
+
+      if options["query"].present?
+        begin
+          TodoistQuerynaut::Parser.parse(options["query"])
+        rescue Exception
+          errors.add(:base, "query cannot be parsed correctly, check against Todoist filter expression manual")
+        end
+      else
+        errors.add(:base, "query must not be empty")
+      end
+    end
+
+    def check
+      todoist = Todoist::Client.new(interpolated["api_token"].present? ? interpolated["api_token"] : credential("todoist_api_token"))
+      result = TodoistQuerynaut::Client.new(todoist).run(options["query"])
+
+      result.each do |item|
+        create_event payload: item
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+def json_response_raw(fixture_name)
+  File.read(File.join(__dir__, "/fixtures/#{fixture_name}.json"))
+end

data/spec/todoist_query_agent_spec.rb

@@ -0,0 +1,56 @@
+require "rails_helper"
+require "huginn_agent/spec_helper"
+require "uri"
+
+require_relative "./spec_helper"
+
+describe Agents::TodoistQueryAgent do
+  before(:each) do
+    @valid_options = {
+      "api_token" => "some_token_here",
+      "query" => "overdue",
+    }
+    @checker = Agents::TodoistQueryAgent.new(:name => "TodoistQueryAgent", :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 query" do
+      @checker.options["query"] = nil
+      expect(@checker).not_to be_valid
+    end
+
+    it "should reject invalid query syntax" do
+      @checker.options["query"] = "some_invalid_query"
+      expect(@checker).not_to be_valid
+    end
+  end
+
+  describe "#check" do
+    before :each do
+      stub_request(:post, "https://todoist.com/API/v6/query").
+        with(:body => {"queries" => "[\"overdue\"]", "token" => "some_token_here"}).
+        to_return(:status => 200, :body => json_response_raw("query_overdue"), :headers => {})
+    end
+
+    it "should execute the query and emit events for every item" do
+      expect { @checker.check }.to change {Event.count}.by(2)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_todoist_agent
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.4.0
 platform: ruby
 authors:
 - Stefan Siegl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: todoist_querynaut
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: The Todoist Agent will create one item on your Todoist for every Huginn
   event it receives.
 email:
@@ -77,7 +91,10 @@ files:
 - LICENSE.txt
 - lib/huginn_todoist_agent.rb
 - lib/huginn_todoist_agent/todoist_agent.rb
+- lib/huginn_todoist_agent/todoist_query_agent.rb
+- spec/spec_helper.rb
 - spec/todoist_agent_spec.rb
+- spec/todoist_query_agent_spec.rb
 homepage: https://github.com/stesie/huginn_todoist_agent
 licenses:
 - MIT
@@ -104,3 +121,5 @@ specification_version: 4
 summary: Huginn agent to add items to your Todoist.
 test_files:
 - spec/todoist_agent_spec.rb
+- spec/todoist_query_agent_spec.rb
+- spec/spec_helper.rb