huginn_twitter_publishv2_agent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 592693f79f50d6ac8a1de08a312afd25e31c1fdb8a93f5a6fe01e7de01f5f37f
+  data.tar.gz: 0a8d1a4cf94ced294b3fcc098c2224e06f9f4f2b7ae0779bb2db153e86b96bcc
+SHA512:
+  metadata.gz: 69637a40ca8238e801fa6143969a289a5de32072554e8335cd7cebd5adf2e772b051d0d79817de6e27f0d9268ba907f87ff11c350411fcaaa390e40a3bb31232
+  data.tar.gz: fab4c4bb2ae18080920e8ca7717fff9b6a3b70c2a4d5b5e53d35eee6c140d43b293e91325d4b06d6211970a4740429c826480a89c86a6660d19cdd865a20cece

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2023 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_twitter_publishv2_agent/twitter_publishv2_agent.rb

@@ -0,0 +1,156 @@
+module Agents
+  class TwitterPublishv2Agent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Twitter Publishv2 Agent publishes tweets from the events it receives.
+
+      #{twitter_dependencies_missing if dependencies_missing?}
+
+      To be able to use this Agent you need to authenticate with Twitter with [twurl](https://github.com/twitter/twurl).
+
+      You must also specify a `message` parameter, you can use [Liquid](https://github.com/huginn/huginn/wiki/Formatting-Events-using-Liquid) to format the message.
+      Additional parameters can be passed via `parameters`.
+
+      `debug` is used for verbose mode.
+
+      `consumer_key` is mandatory for oauth.
+
+      `consumer_secret` is mandatory for oauth.
+
+      `access_token` is mandatory for oauth.
+
+      `token_secret` is mandatory for oauth.
+
+      `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:
+
+          {
+            "data": {
+              "edit_history_tweet_ids": [
+                "XXXXXXXXXXXXXXXXXXX"
+              ],
+              "id": "XXXXXXXXXXXXXXXXXXX",
+              "text": "test huginn agentv2 part3 with created event"
+            }
+          }
+    MD
+
+    def default_options
+      {
+        'message' => "{{text}}",
+        'debug' => 'false',
+        'consumer_key' => '',
+        'consumer_secret' => '',
+        'access_token' => '',
+        'token_secret' => '',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :message, type: :string
+    form_configurable :consumer_key, type: :string
+    form_configurable :consumer_secret, type: :string
+    form_configurable :access_token, type: :string
+    form_configurable :token_secret, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :emit_events, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    def validate_options
+      unless options['consumer_key'].present?
+        errors.add(:base, "consumer_key is a required field")
+      end
+
+      unless options['consumer_secret'].present?
+        errors.add(:base, "consumer_secret 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['access_token'].present?
+        errors.add(:base, "access_token must be true or false")
+      end
+
+      unless options['token_secret'].present?
+        errors.add(:base, "token_secret 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
+          publish()
+        end
+      end
+    end
+
+    def check
+      publish()
+    end
+
+    private
+
+    def log_curl_output(code,body)
+
+      log "request status : #{code}"
+
+      if interpolated['debug'] == 'true'
+        log "body"
+        log body
+      end
+
+    end
+
+    def publish()
+
+      url = URI.parse('https://api.twitter.com/2/tweets')
+      data = { 'text' => interpolated['message'] }
+      json_data = data.to_json
+      
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      
+      request = Net::HTTP::Post.new(url.path,
+        { 'Content-Type' => 'application/json' })
+      
+      consumer = OAuth::Consumer.new(interpolated['consumer_key'], interpolated['consumer_secret'])
+      token = OAuth::AccessToken.new(consumer, interpolated['access_token'], interpolated['token_secret'])
+      
+      request.oauth! http, consumer, token
+      request.body = json_data
+      response = http.request(request)
+      
+      log_curl_output(response.code,response.body)
+
+      if interpolated['emit_events'] == 'true'
+        create_event payload: response.body
+      end
+    end
+
+  end
+end

data/lib/huginn_twitter_publishv2_agent.rb

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

data/spec/twitter_publishv2_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::TwitterPublishv2Agent do
+  before(:each) do
+    @valid_options = Agents::TwitterPublishv2Agent.new.default_options
+    @checker = Agents::TwitterPublishv2Agent.new(:name => "TwitterPublishv2Agent", :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_twitter_publishv2_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-27 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_twitter_publishv2_agent.rb
+- lib/huginn_twitter_publishv2_agent/twitter_publishv2_agent.rb
+- spec/twitter_publishv2_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_twitter_publishv2_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/twitter_publishv2_agent_spec.rb