huginn_mastodon_publish_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c475df82b48cabc746a3e19aac8494f2f811f41e26c22e8bdf55c28fa24ea5c3
+  data.tar.gz: 1562b2eaaa9cb6559a6619e82faef68204359b43056966f27ac449f0f8815c34
+SHA512:
+  metadata.gz: 78bff76a459732a26211ba3cb92b8c6462448d4376484d5b2772320b9cacac85d299201c18cfce784d3ed281e45b31e7db4eb71336da3601512e828e72841114
+  data.tar.gz: f27fc9a849f9d76073f6bd562e2474114538d2b32daa48b7ea956ebdb20921045374816e0d3ae3aed6d595cd9091da251faadb9a96727293d20af4a057c2f7f2

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2022 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_mastodon_publish_agent/mastodon_publish_agent.rb

@@ -0,0 +1,168 @@
+module Agents
+  class MastodonPublishAgent < Agent
+    include FormConfigurable
+
+    cannot_be_scheduled!
+
+    description do
+      <<-MD
+      The Mastodon Publish Agent publishes status from the events it receives.
+
+      To be able to use this Agent you need to authenticate with Mastodon in the [Applications](https://mastodon.social/settings/applications) section first.
+
+      You must also specify a `status` parameter, you can use [Liquid](https://github.com/huginn/huginn/wiki/Formatting-Events-using-Liquid) to format the status.
+      Additional parameters can be passed via `parameters`.
+
+      Set `expected_update_period_in_days` to the maximum amount of time that you'd expect to pass between Events being created by this Agent.
+
+      If `output_mode` is set to `merge`, the emitted Event will be merged into the original contents of the received Event.
+      MD
+    end
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "id": "XXXXXXXXXXXXXXXXXX",
+            "created_at": "2022-04-30T10:43:17.130Z",
+            "in_reply_to_id": null,
+            "in_reply_to_account_id": null,
+            "sensitive": false,
+            "spoiler_text": "",
+            "visibility": "public",
+            "language": "fr",
+            "uri": "https://mastodon.social/users/toto/statuses/XXXXXXXXXXXXXXXXXX",
+            "url": "https://mastodon.social/@toto/XXXXXXXXXXXXXXXXXX",
+            "replies_count": 0,
+            "reblogs_count": 0,
+            "favourites_count": 0,
+            "edited_at": null,
+            "favourited": false,
+            "reblogged": false,
+            "muted": false,
+            "bookmarked": false,
+            "pinned": false,
+            "content": "<p>test</p>",
+            "reblog": null,
+            "application": {
+              "name": "huginn",
+              "website": "https://toto.com"
+            },
+            "account": {
+              "id": "XXXXXXXXXXXXXXXXXX",
+              "username": "toto",
+              "acct": "toto",
+              "display_name": "toto",
+              "locked": false,
+              "bot": false,
+              "discoverable": false,
+              "group": false,
+              "created_at": "2022-04-29T00:00:00.000Z",
+              "note": "",
+              "url": "https://mastodon.social/@toto",
+              "avatar": "https://mastodon.social/avatars/original/missing.png",
+              "avatar_static": "https://mastodon.social/avatars/original/missing.png",
+              "header": "https://mastodon.social/headers/original/missing.png",
+              "header_static": "https://mastodon.social/headers/original/missing.png",
+              "followers_count": 0,
+              "following_count": 0,
+              "statuses_count": 1,
+              "last_status_at": "2022-04-30",
+              "emojis": [],
+              "fields": []
+            },
+            "media_attachments": [],
+            "mentions": [],
+            "tags": [],
+            "emojis": [],
+            "card": null,
+            "poll": null
+          }
+    MD
+
+    def default_options
+      {
+        'status' => '',
+        'access_token' => '',
+        'debug' => 'false',
+        'emit_events' => 'false',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :access_token, type: :string
+    form_configurable :status, 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['access_token'].present?
+        errors.add(:base, "access_token is a required field")
+      end
+
+      unless options['status'].present?
+        errors.add(:base, "status is a required field")
+      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?(interpolated['expected_update_period_in_days']) && most_recent_event && most_recent_event.payload['success'] == true && !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 publish
+
+      uri = URI.parse("https://mastodon.social/api/v1/statuses")
+      request = Net::HTTP::Post.new(uri)
+      request.set_form_data(
+        "status" => "#{interpolated['status']}",
+      )
+      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
+
+      if interpolated['debug'] == 'true'
+        log "response.body"
+        log response.body
+      end
+
+      log "fetch status request status : #{response.code}"
+      if interpolated['emit_events'] == 'true'
+        create_event payload: response.body
+      end
+    end
+  end
+end

data/lib/huginn_mastodon_publish_agent.rb

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

data/spec/mastodon_publish_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::MastodonPublishAgent do
+  before(:each) do
+    @valid_options = Agents::MastodonPublishAgent.new.default_options
+    @checker = Agents::MastodonPublishAgent.new(:name => "MastodonPublishAgent", :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_mastodon_publish_agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-30 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_mastodon_publish_agent.rb
+- lib/huginn_mastodon_publish_agent/mastodon_publish_agent.rb
+- spec/mastodon_publish_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_mastodon_publish_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.1.6
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/mastodon_publish_agent_spec.rb