huginn_outlook_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d6fb7195c08ef6d5a95fdb6f8b8c4bbe7025ee86ed9bb8e387de7bf08877da8
+  data.tar.gz: 3a22e3439c3f45ca62b0e8e40bf78fbf7280c4bd63c6a5b1c351e7c52968d25c
+SHA512:
+  metadata.gz: 5fc5699e4cb621181a13a66991f4d65ad2c2b6d73758dcbd6394a4ce93267ab9a4143c9d6cbb7823b8361a4cec553239067bac19ef159990bc05417c0cfe91bc
+  data.tar.gz: 724d9f0e4a0f2c4daced17fca1f06e28a18273572f9023e5abe4956ca93db00050ff80f9cc8d2ed1395e8f174ab0dce32221ddb1a726728ac4ca99b9d2b293b3

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Nicolas Germain
+
+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/lib/huginn_outlook_agent/outlook_agent.rb

@@ -0,0 +1,392 @@
+module Agents
+  class OutlookAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule '5m'
+
+    description do
+      <<-MD
+      The Outlook Agent interacts with the graph api to check the arrival of new emails, send them, etc...
+
+      `debug` is used for verbose mode.
+
+      `client_id` is the id of your app.
+
+      `client_secret` is the secret of your app.
+
+      `access_token` is a token created for your app.
+
+      `refresh_token` is needed to refresh access_token.
+
+      `folder` is the wanted folder where you want to check new emails.
+
+      `raw_email` if you want MIME format content.
+
+      `emit_events` is for creating an event.
+
+      `type` is for the wanted action like get_new_emails / send_email.
+
+      `expected_receive_period_in_days` is used to determine if the Agent is working. Set it to the maximum number of days
+      that you anticipate passing without this Agent receiving an incoming Event.
+      MD
+    end
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('XXXXXXXXXXXXXXXXX')/messages/$entity",
+            "@odata.etag": "W/\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"",
+            "id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "createdDateTime": "2024-09-27T21:29:15Z",
+            "lastModifiedDateTime": "2024-09-27T21:29:15Z",
+            "changeKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "categories": [
+          
+            ],
+            "receivedDateTime": "2024-09-27T21:29:15Z",
+            "sentDateTime": "2024-09-27T21:29:09Z",
+            "hasAttachments": false,
+            "internetMessageId": "<XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX>",
+            "subject": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "bodyPreview": "XXXXXXXXXXXXXXX",
+            "importance": "normal",
+            "parentFolderId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "conversationId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "conversationIndex": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "isDeliveryReceiptRequested": null,
+            "isReadReceiptRequested": false,
+            "isRead": false,
+            "isDraft": false,
+            "webLink": "https://outlook.live.com/owa/?ItemID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+            "inferenceClassification": "focused",
+            "body": {
+              "contentType": "html",
+              "content": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX>"
+            },
+            "sender": {
+              "emailAddress": {
+                "name": "XXXXXXXXXXXXXXX",
+                "address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+              }
+            },
+            "from": {
+              "emailAddress": {
+                "name": "XXXXXXXXXXXXXXX",
+                "address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+              }
+            },
+            "toRecipients": [
+              {
+                "emailAddress": {
+                  "name": "XXXXXXXXXXXXXXXXXXXXXXXX",
+                  "address": "XXXXXXXXXXXXXXXXXXXXXXXX"
+                }
+              }
+            ],
+            "ccRecipients": [
+              {
+                "emailAddress": {
+                  "name": "XXXXXXXXXXXXXXXXXXXXXXXX",
+                  "address": "XXXXXXXXXXXXXXXXXXXXXXXX"
+                }
+              }
+            ],
+            "bccRecipients": [
+          
+            ],
+            "replyTo": [
+          
+            ],
+            "flag": {
+              "flagStatus": "notFlagged"
+            }
+          }
+    MD
+
+    def default_options
+      {
+        'client_id' => '{% credential outlook_client_id %}',
+        'client_secret' => '{% credential outlook_client_secret %}',
+        'access_token' => '{% credential outlook_access_token %}',
+        'refresh_token' => '',
+        'folder' => '',
+        'debug' => 'false',
+        'raw_email' => 'false',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :client_id, type: :string
+    form_configurable :client_secret, type: :string
+    form_configurable :refresh_token, type: :string
+    form_configurable :access_token, type: :string
+    form_configurable :folder, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :raw_email, type: :boolean
+    form_configurable :emit_events, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :type, type: :array, values: ['get_new_emails', 'send_email']
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'get_new_emails', 'send_email'") if interpolated['type'].present? && !%w(get_new_emails send_email).include?(interpolated['type'])
+
+      unless options['client_id'].present?
+        errors.add(:base, "client_id is a required field")
+      end
+
+      unless options['client_secret'].present?
+        errors.add(:base, "client_secret is a required field")
+      end
+
+      unless options['folder'].present?
+        errors.add(:base, "folder is a required field")
+      end
+
+      unless options['access_token'].present?
+        errors.add(:base, "access_token is a required field")
+      end
+
+      unless options['refresh_token'].present?
+        errors.add(:base, "refresh_token is a required field")
+      end
+
+      if options.has_key?('raw_email') && boolify(options['raw_email']).nil?
+        errors.add(:base, "if provided, raw_email must be true or false")
+      end
+
+      if options.has_key?('emit_events') && boolify(options['emit_events']).nil?
+        errors.add(:base, "if provided, emit_events must be true or false")
+      end
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      end
+
+      unless options['expected_receive_period_in_days'].present? && options['expected_receive_period_in_days'].to_i > 0
+        errors.add(:base, "Please provide 'expected_receive_period_in_days' to indicate how many days can pass before this Agent is considered to be not working")
+      end
+    end
+
+    def working?
+      event_created_within?(options['expected_receive_period_in_days']) && !recent_error_logs?
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        interpolate_with(event) do
+          log event
+          trigger_action
+        end
+      end
+    end
+
+    def check
+      trigger_action
+    end
+
+    private
+
+    def set_credential(name, value)
+      c = user.user_credentials.find_or_initialize_by(credential_name: name)
+      c.credential_value = value
+      c.save!
+    end
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def token_refresh()
+
+      uri = URI.parse("https://login.microsoftonline.com/consumers/oauth2/v2.0/token")
+      request = Net::HTTP::Post.new(uri)
+      request.body = "client_id=#{interpolated['client_id']}&client_secret=#{interpolated['client_secret']}&refresh_token=#{interpolated['refresh_token']}&grant_type=refresh_token&scope=https://graph.microsoft.com/Mail.Read offline_access"
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+      if interpolated['access_token'] != payload['access_token']
+        set_credential("outlook_access_token", payload['access_token'])
+        if interpolated['debug'] == 'true'
+          log "outlook_access_token credential updated"
+        end
+      end
+      current_timestamp = Time.now.to_i
+      memory['expires_at'] = payload['expires_in'] + current_timestamp
+
+    end
+
+    def check_token_validity()
+
+      if memory['expires_at'].nil?
+        token_refresh()
+      else
+        timestamp_to_compare = memory['expires_at']
+        current_timestamp = Time.now.to_i
+#        difference_in_hours = (timestamp_to_compare - current_timestamp) / 3600.0
+#        if difference_in_hours < 2
+        difference_in_minutes = (timestamp_to_compare - current_timestamp) / 60.0
+        if difference_in_minutes < 10
+          token_refresh()
+        else
+          log "refresh not needed"
+        end
+      end
+    end
+
+    def get_email(email_id)
+      url = "https://graph.microsoft.com/v1.0/me/messages/#{email_id}"
+      if interpolated['raw_email'] == 'true'
+        url = url + '/$value'
+      end
+      uri = URI.parse(url)
+      request = Net::HTTP::Get.new(uri)
+      request.content_type = "application/json"
+      request["Authorization"] = "Bearer  #{interpolated['access_token']}"
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      if interpolated['raw_email'] == 'true'
+        result = {}
+        result['id'] = email_id
+#        result['raw_mail'] = response.body.gsub(/(?:\n\r?|\r\n?)/, '<br>')
+        result['raw_mail'] = response.body
+        log "raw_mail"
+        log result['raw_mail']
+
+        return result
+      else
+        payload = JSON.parse(response.body)
+        return payload
+      end
+    end
+
+    def send_email()
+
+      check_token_validity()
+      uri = URI.parse("https://graph.microsoft.com/v1.0/me/messages")
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = "application/json"
+      request.body = JSON.dump({
+        "subject" => "Did you see last night's game?",
+        "importance" => "Low",
+        "body" => {
+          "contentType" => "HTML",
+          "content" => "They were <b>awesome</b>!"
+        },
+        "toRecipients" => [
+          {
+            "emailAddress" => {
+              "address" => "AdeleV@contoso.com"
+            }
+          }
+        ]
+      })
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+
+      if interpolated['emit_events'] == 'true'
+        create_event payload: payload
+      end
+    end
+
+    def get_new_emails()
+
+      check_token_validity()
+      uri = URI.parse("https://graph.microsoft.com/v1.0/me/mailFolders/#{interpolated['folder']}/messages?$format=json&$top=20&$select=id")
+      request = Net::HTTP::Get.new(uri)
+      request.content_type = "application/json"
+      request["Authorization"] = "Bearer  #{interpolated['access_token']}"
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+      if payload != memory['last_status']
+        payload['value'].each do |email_data|
+          found = false
+          if !memory['last_status'].nil? and memory['last_status'].present?
+            last_status = memory['last_status']
+            if interpolated['debug'] == 'true'
+              log "email_data"
+              log email_data
+            end
+            last_status['value'].each do |email_databis|
+              if email_data['id'] == email_databis['id']
+                found = true
+              end
+              if interpolated['debug'] == 'true'
+                log "found is #{found}!"
+                log "email_databis"
+                log email_databis
+              end
+            end
+          end
+          if found == false
+            create_event payload: get_email(email_data['id'])
+          else
+            if interpolated['debug'] == 'true'
+              log "found is #{found}"
+            end
+          end
+        end
+        memory['last_status'] = payload
+      end
+
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "get_new_emails"
+        get_new_emails()
+      when "send_email"
+        send_email()
+      else
+        log "Error: type has an invalid value (#{interpolated['type']})"
+      end
+    end
+  end
+end

data/lib/huginn_outlook_agent.rb

@@ -0,0 +1,4 @@
+require 'huginn_agent'
+
+#HuginnAgent.load 'huginn_outlook_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_outlook_agent/outlook_agent'

data/spec/outlook_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::OutlookAgent do
+  before(:each) do
+    @valid_options = Agents::OutlookAgent.new.default_options
+    @checker = Agents::OutlookAgent.new(:name => "OutlookAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  pending "add specs here"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_outlook_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description or delete this line.
+email:
+- ngermain@hihouhou.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_outlook_agent.rb
+- lib/huginn_outlook_agent/outlook_agent.rb
+- spec/outlook_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_outlook_agent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/outlook_agent_spec.rb