huginn_telegrambis_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7c7c81808707c35ff323750e967cf4904abde90e93e628777ba2a2126e91e24
+  data.tar.gz: d242265a461af80acea75a986d318dabe4126cceeea2909eaa718dfa5e3a41ae
+SHA512:
+  metadata.gz: 64cd02a0fcdb576bb2ef68f2f1aa213b9bc5508c3b38bd8666deff89ab97c126fdd5080510abfa5cc2f231a7a5e9209fc8d64ccb6d659722593b67b7ba89ff90
+  data.tar.gz: f5cf2d415bc53c746b0cc7fe33715f03845ef45061297b161a5238a0ba3a5b1f334ac0b3fc1c19df8bf180f72cd12227bdf64fa865ad8a3f9e6e6f2652d4df6b

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_telegrambis_agent/telegrambis_agent.rb

@@ -0,0 +1,183 @@
+module Agents
+  class TelegrambisAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_12h'
+
+    description do
+      <<-MD
+      The Telegrambis Agent complements the very good telegram agent, it adds other interactions with the Telegram api.
+
+      `chat_id` for the target channel.
+
+      `message_id` is needed to select the message for possible interactions like pinned message.
+
+      `debug` is used for verbose mode.
+
+      `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:
+
+          {
+            "ok": true,
+            "result": true
+          }
+    MD
+
+    def default_options
+      {
+        'chat_id' => '',
+        'message_id' => '',
+        'debug' => 'false',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '7',
+        'token' => ''
+      }
+    end
+
+    form_configurable :chat_id, type: :string
+    form_configurable :message_id, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :emit_events, type: :boolean
+    form_configurable :token, type: :string
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :type, type: :array, values: ['pin_chat_message', 'unpin_chat_message']
+
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'pin_chat_message', 'unpin_chat_message'") if interpolated['type'].present? && !%w(pin_chat_message unpin_chat_message).include?(interpolated['type'])
+
+      unless options['chat_id'].present? || !['pin_chat_message' 'unpin_chat_message'].include?(options['type'])
+        errors.add(:base, "chat_id is a required field")
+      end
+
+      unless options['message_id'].present? || !['pin_chat_message' 'unpin_chat_message'].include?(options['type'])
+        errors.add(:base, "message_id 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
+
+      if options.has_key?('emit_events') && boolify(options['emit_events']).nil?
+        errors.add(:base, "if provided, emit_events must be true or false")
+      end
+
+      unless options['token'].present?
+        errors.add(:base, "token is a required field")
+      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 log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def pin_chat_message
+
+      uri = URI.parse("https://api.telegram.org/bot#{interpolated['token']}/pinChatMessage")
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = "application/json"
+      request.body = JSON.dump({
+        "chat_id" => interpolated['chat_id'],
+        "message_id" => interpolated['message_id']
+      })
+
+      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'
+        payload['action'] = 'pinChatMessage'
+        payload['chat_id'] = interpolated['chat_id']
+        payload['message_id'] = interpolated['message_id']
+        create_event payload: payload
+      end
+
+    end
+
+    def unpin_chat_message
+
+      uri = URI.parse("https://api.telegram.org/bot#{interpolated['token']}/unpinChatMessage")
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = "application/json"
+      request.body = JSON.dump({
+        "chat_id" => interpolated['chat_id'],
+        "message_id" => interpolated['message_id']
+      })
+
+      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'
+        payload['action'] = 'unpinChatMessage'
+        payload['chat_id'] = interpolated['chat_id']
+        payload['message_id'] = interpolated['message_id']
+        create_event payload: payload
+      end
+
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "pin_chat_message"
+        pin_chat_message()
+      when "unpin_chat_message"
+        unpin_chat_message()
+      else
+        log "Error: type has an invalid value (#{interpolated['type']})"
+      end
+    end
+  end
+end

data/lib/huginn_telegrambis_agent.rb

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

data/spec/telegrambis_agent_spec.rb

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