huginn_todoist_agent 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28b393bab5ee709accf4c9e022f1243da9f60eb1
-  data.tar.gz: 0359dfb1bd62d99cd3dcd1a0121f89482700d279
+  metadata.gz: 5fa7c7d07478fe20d4e6615c5dc1888717fbea36
+  data.tar.gz: 85253fc515dcf5b317956a39e56ee5a3016db05f
 SHA512:
-  metadata.gz: 2065eced8210eea5861626fae160601facb7f5c56f8d606e044c44f229acffce6485b7d8a7a7c7f602ec523ad2e66b8ac5ed8a0599a02ce8b96566f6a7ab210f
-  data.tar.gz: 46c32cf84e855015e9177025570e2282f9604d8a823ad08510c9ef58c0542d2d7484ec370481503590a41a77bf1205bb5fb213936ad81de1db6258cccea4aad2
+  metadata.gz: df7be486f40ee95d74a4db03a8c98cc8a8b762a6d20f624aa28b07fe1d0a58192300e26cf61b14cab93862b3ed8c19eb06b3b74fa47dd4e98c6e5c067e7a3f87
+  data.tar.gz: 7bb8c657d62a72379b4c6034cca488482260466c3cf146024df4bf116087ba2f5a7f88e7ede6da20ff08c231692550102c0d5bd0c46e3e71583f28f383a26b97

data/lib/huginn_todoist_agent/todoist_agent.rb

@@ -9,10 +9,16 @@ module Agents
 
     description do
       <<-MD
-        The Todoist Agent will create one item on your Todoist for every event it receives.
+        The Todoist Agent creates items on your Todoist.
 
-        Specify your Todoist API token (from Todoist Settings > Account) as `token` and
-        provide some `content`.
+        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 `content` to whatever the new Todoist item should tell.  You can use liquid
+        templating to include parts from the incoming event in the new item.
+        Have a look at the [Wiki](https://github.com/cantino/huginn/wiki/Formatting-Events-using-Liquid)
+        to learn more about liquid templating.
 
         In order to set a due date provide a `date_string` (which may contain all date string
         features supported by Todoist).
@@ -28,16 +34,16 @@ module Agents
 
     def default_options
       {
-        'token' => '',
-        'content' => '{{ content }}',
-        'date_string' => 'today',
-        'project_id' => '',
-        'labels' => '',
-        'priority' => '',
+        "api_token" => "",
+        "content" => "{{ content }}",
+        "date_string" => "today",
+        "project_id" => "",
+        "labels" => "",
+        "priority" => "",
       }
     end
 
-    form_configurable :token
+    form_configurable :api_token
     form_configurable :content, type: :text
     form_configurable :date_string
     form_configurable :project_id
@@ -49,23 +55,23 @@ module Agents
     end
 
     def validate_options
-      errors.add(:base, 'you need to specify your Todoist token') unless options['token'].present?
+      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?
     end
 
     def receive(incoming_events)
       incoming_events.each do |event|
         interpolate_with(event) do
-          item = { 'content' => interpolated['content'] }
-          item['date_string'] = interpolated['date_string'] if interpolated['date_string'].present?
-          item['project_id'] = interpolated['project_id'].to_i if interpolated['project_id'].present?
-          item['priority'] = interpolated['priority'].to_i if interpolated['priority'].present?
+          item = { "content" => interpolated["content"] }
+          item["date_string"] = interpolated["date_string"] if interpolated["date_string"].present?
+          item["project_id"] = interpolated["project_id"].to_i if interpolated["project_id"].present?
+          item["priority"] = interpolated["priority"].to_i if interpolated["priority"].present?
 
-          if interpolated['labels'].present?
-            item['labels'] = interpolated['labels'].split(%r{,\s*}).map(&:to_i)
+          if interpolated["labels"].present?
+            item["labels"] = interpolated["labels"].split(%r{,\s*}).map(&:to_i)
           end
 
           log "creating item: #{item}"
-          todoist = Todoist::Client.new(interpolated['token'])
+          todoist = Todoist::Client.new(interpolated["api_token"].present? ? interpolated["api_token"] : credential("todoist_api_token"))
           todoist.items.create(item)
           todoist.process!
         end

data/spec/todoist_agent_spec.rb

@@ -1,13 +1,216 @@
-require 'rails_helper'
-require 'huginn_agent/spec_helper'
+require "rails_helper"
+require "huginn_agent/spec_helper"
+require "uri"
 
 describe Agents::TodoistAgent do
   before(:each) do
-    @valid_options = Agents::TodoistAgent.new.default_options
+    @valid_options = {
+      "api_token" => "some_token_here",
+      "content" => "foobar",
+    }
     @checker = Agents::TodoistAgent.new(:name => "TodoistAgent", :options => @valid_options)
     @checker.user = users(:bob)
     @checker.save!
+
+    @event = Event.new
+    @event.agent = agents(:bob_weather_agent)
+    @event.payload = {
+      "somekey" => "somevalue",
+      "some_date" => "May 23",
+      "some_project_id" => "2342",
+      "some_priority" => "2",
+      "a_single_label" => "42",
+      "some_labels" => "23,42,  5",
+    }
+
+    @expected_token = "some_token_here"
+    @sent_requests = Array.new
+    stub_request(:post, "https://todoist.com/API/v6/sync").
+      to_return { |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(@expected_token)
+
+	json_data = ActiveSupport::JSON.decode(form_data.assoc("commands").last)
+	expect(json_data.length).to eq(1)
+
+	@sent_requests << req = json_data[0]
+
+	case json_data[0]["type"]
+	when "item_add"
+	  json_response = {
+	    "TempIdMapping" => {
+	      json_data[0]["temp_id"] => 81662555
+	    },
+	    "seq_no_global" => 11248873939,
+	    "seq_no" => 11248873939,
+	    "UserId" => 9933517,
+	    "SyncStatus" => {
+	      json_data[0]["uuid"] => "oK"
+	    },
+	  }
+	else
+	  raise "Unexpected type: #{json_data[0]["type"]}"
+	end
+
+	{ status: 200, body: ActiveSupport::JSON.encode(json_response), headers: { "Content-type" => "application/json" } }
+      }
+  end
+
+  describe "#validate_options" do
+    before do
+      expect(@checker).to be_valid
+    end
+
+    it "should reject an empty token" do
+      @checker.options["api_token"] = nil
+      expect(@checker).not_to be_valid
+    end
+
+    it "should also allow a credential" 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
   end
 
-  pending "add specs here"
+  describe "#receive" do
+    describe "with static content configuration" do
+      it "can create a new static item" do
+	@checker.receive([@event])
+	expect(@sent_requests.length).to eq(1)
+	expect(@sent_requests[0]["type"]).to eq("item_add")
+	expect(@sent_requests[0]["args"]["content"]).to eq("foobar")
+      end
+
+      it "passes date_string to the new item" do
+	@checker.options["date_string"] = "today"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["date_string"]).to eq("today")
+      end
+
+      it "passes project_id to the new item" do
+	@checker.options["project_id"] = "23"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["project_id"]).to eq(23)
+      end
+
+      it "passes priority to the new item" do
+	@checker.options["priority"] = "3"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["priority"]).to eq(3)
+      end
+
+      it "passes a single label to the new item" do
+	@checker.options["labels"] = "23"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["labels"]).to eq([23])
+      end
+
+      it "passes multiple labels to the new item" do
+	@checker.options["labels"] = "23, 42"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["labels"]).to eq([23, 42])
+      end
+    end
+
+    describe "with content interpolation" do
+      it "content can be interpolated" do
+	@checker.options["content"] = "Event Data: {{ somekey }}"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["content"]).to eq("Event Data: somevalue")
+      end
+
+      it "date_string can be interpolated" do
+	@checker.options["date_string"] = "{{ some_date }}"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["date_string"]).to eq("May 23")
+      end
+
+      it "project_id can be interpolated" do
+	@checker.options["project_id"] = "{{ some_project_id }}"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["project_id"]).to eq(2342)
+      end
+
+      it "priority can be interpolated" do
+	@checker.options["priority"] = "{{ some_priority }}"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["priority"]).to eq(2)
+      end
+
+      it "single label can be interpolated" do
+	@checker.options["labels"] = "{{ a_single_label }}"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["labels"]).to eq([42])
+      end
+
+      it "multiple labels can be interpolated" do
+	@checker.options["labels"] = "{{ some_labels }}"
+	expect(@checker).to be_valid
+
+	@checker.receive([@event])
+	expect(@sent_requests[0]["args"]["labels"]).to eq([23, 42, 5])
+      end
+    end
+
+    it "creates two items for two events" do
+      @checker.receive([@event, @event])
+      expect(@sent_requests.length).to eq(2)
+    end
+
+    it "should use the credential token if no token is present" do
+      @checker.user.user_credentials.create :credential_name => "todoist_api_token", :credential_value => "some_credential_here"
+      @checker.options["api_token"] = nil
+
+      @expected_token = "some_credential_here"
+      @checker.receive([@event])
+
+      expect(@sent_requests.length).to eq(1)
+      expect(@sent_requests[0]["type"]).to eq("item_add")
+      expect(@sent_requests[0]["args"]["content"]).to eq("foobar")
+    end
+
+    it "should use the credential token if an empty token is given" do
+      @checker.user.user_credentials.create :credential_name => "todoist_api_token", :credential_value => "some_credential_here"
+      @checker.options["api_token"] = ""
+
+      @expected_token = "some_credential_here"
+      @checker.receive([@event])
+
+      expect(@sent_requests.length).to eq(1)
+      expect(@sent_requests[0]["type"]).to eq("item_add")
+      expect(@sent_requests[0]["args"]["content"]).to eq("foobar")
+    end
+
+    it "should use the provided token, if both a credential and immediate token are given" do
+      @checker.user.user_credentials.create :credential_name => "todoist_api_token", :credential_value => "some_credential_here"
+      @checker.receive([@event])
+
+      expect(@sent_requests.length).to eq(1)
+      expect(@sent_requests[0]["type"]).to eq("item_add")
+      expect(@sent_requests[0]["args"]["content"]).to eq("foobar")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_todoist_agent
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Stefan Siegl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler