huginn_google_calendar_event_checker_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78038dac4d5a6cb199e500c9eaca8b462762eca345a420f09518f9b3293a6cb5
+  data.tar.gz: 007a49bf1c8858d6ef3a4de4c9a4dc0f9baaf4b2f9ca2589425dbba79d4599b3
+SHA512:
+  metadata.gz: b0af8fd2c1b8b6e6362d09f26bfaa288c6188c3b035b06be1a9709f77e71d345183d1418ee6d043c2e0329502762c922dff775087b7f0a68419030134e6c7300
+  data.tar.gz: 3bc7799a2512f243978e0c3b453a7904d93e16edee8db20d9006359b32c8ea3fb5b85aa48213dff57d68959a35b3292cd05f9164ec87b22a2f120dc692e06dfa

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_google_calendar_event_checker_agent/google_calendar_event_checker_agent.rb

@@ -0,0 +1,167 @@
+module Agents
+  class GoogleCalendarEventCheckerAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The GoogleCalendarEventChecker Agent interacts with Google calendar's api.
+
+      `debug` is used for verbose mode.
+
+      `time_max` is needed to limit the result.
+
+      `calendar_id` is the wanted id of the calendar you want to check.
+
+      `service_acount_credentials` is needed for auth.
+
+      `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:
+
+         {
+           "created": "2024-06-02T10:05:50.000+00:00",
+           "creator": {
+             "email": "XXXXXXXXXX@gmail.com"
+           },
+           "end": {
+             "dateTime": "2024-06-02T14:00:00.000+02:00",
+             "timeZone": "Europe/Paris"
+           },
+           "etag": "\"XXXXXXXXXXXXXXXX\"",
+           "htmlLink": "https://www.google.com/calendar/event?eid=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+           "iCalUID": "XXXXXXXXXXXXXXXXXXXXXXXXXX@google.com",
+           "id": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
+           "kind": "calendar#event",
+           "organizer": {
+             "displayName": "XXXXXXXXXXXXX",
+             "email": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX@group.calendar.google.com",
+             "self": true
+           },
+           "reminders": {
+             "useDefault": true
+           },
+           "sequence": 0,
+           "start": {
+             "dateTime": "2024-06-02T13:00:00.000+02:00",
+             "timeZone": "Europe/Paris"
+           },
+           "status": "confirmed",
+           "summary": "test new event",
+           "updated": "2024-06-02T10:05:50.005+00:00"
+         }
+
+    MD
+
+    def default_options
+      {
+        'calendar_id' => '',
+        'time_max' => '10',
+        'service_acount_credentials' => '',
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '31',
+      }
+    end
+
+    form_configurable :calendar_id, type: :string
+    form_configurable :time_max, type: :string
+    form_configurable :service_acount_credentials, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    def validate_options
+
+      unless options['calendar_id'].present?
+        errors.add(:base, "calendar_id is a required field")
+      end
+
+      unless options['service_acount_credentials'].present?
+        errors.add(:base, "service_acount_credentials is a required field")
+      end
+
+      unless options['time_max'].present?
+        errors.add(:base, "time_max is a required field")
+      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 check
+      check_events
+    end
+
+    private
+
+    def already_notified(id)
+      memory['notified'].include?(id)
+    end
+
+    def clean_notified(response)
+      current_event_ids = response.items.map(&:id)
+      memory['notified'].reject! { |id| !current_event_ids.include?(id) }
+      memory['notified'].uniq!
+    end
+    
+    def check_events()
+      calendar = Google::Apis::CalendarV3::CalendarService.new
+      calendar.client_options.application_name = 'App Name'
+      calendar.client_options.application_version = 'App Version'
+
+      #deal with possible service account in huginn
+      Tempfile.create(['service_acount_credentials_google_calendar', '.json']) do |file|
+        file.write(interpolated['service_acount_credentials'])
+        file.rewind
+        ENV['GOOGLE_APPLICATION_CREDENTIALS'] = file.path
+        scopes = [Google::Apis::CalendarV3::AUTH_CALENDAR]
+        calendar.authorization = Google::Auth.get_application_default(scopes)
+      end
+      time_max = (Time.now + interpolated['time_max'].to_i * 24 * 60 * 60).iso8601
+      begin
+        response = calendar.list_events(interpolated['calendar_id'],
+                                        max_results: 10,
+                                        single_events: true,
+                                        order_by: 'startTime',
+                                        time_min: Time.now.iso8601,
+                                        time_max: time_max)
+    
+        if response.items.empty?
+          memory['notified'] = []
+          if interpolated['debug'] == 'true'
+            puts 'No upcoming events found'
+          end
+        else
+          response.items.each do |event|
+            memory['notified'] = [] if memory['notified'].nil?
+            if event.id && !already_notified(event.id)
+              if interpolated['debug'] == 'true'
+                log "not already notified"
+              end
+              create_event payload: event.to_json
+              memory['notified'] << event.id
+            else
+              if interpolated['debug'] == 'true'
+                log "already notified"
+              end
+            end
+          end
+          clean_notified(response)
+        end
+      end
+    end
+  end
+end

data/lib/huginn_google_calendar_event_checker_agent.rb

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

data/spec/google_calendar_event_checker_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::GoogleCalendarEventCheckerAgent do
+  before(:each) do
+    @valid_options = Agents::GoogleCalendarEventCheckerAgent.new.default_options
+    @checker = Agents::GoogleCalendarEventCheckerAgent.new(:name => "GoogleCalendarEventCheckerAgent", :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_google_calendar_event_checker_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-06-02 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_google_calendar_event_checker_agent.rb
+- lib/huginn_google_calendar_event_checker_agent/google_calendar_event_checker_agent.rb
+- spec/google_calendar_event_checker_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_google_calendar_event_checker_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/google_calendar_event_checker_agent_spec.rb