huginn_reddit_agent 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 725e1a3245b9ee68ffa38a10e7f56dc97b3d9ec9f23bb1c27191ac60cbe58e3f
+  data.tar.gz: e4fef1c4e0a3800c05865a6dda9472ac3add9a5077b2598f131819c450f1d1b0
+SHA512:
+  metadata.gz: 4d33330f9f0864f786c4ddb78cd8c16528a8c98707073c68c8e46d321765f8eed97b99fc7f6007eb6aeffa74885b6066cdebec8cacc7c7ed531f42acb7f0bf03
+  data.tar.gz: dfe69966507362cae6ee79265432a447f536acacd4fec4f01275f1e155c358505081a501a3633d627cfcd3ffa5f520b6d587bd563cc2cd347435ddef8d8767c7

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_reddit_agent/reddit_agent.rb

@@ -0,0 +1,311 @@
+module Agents
+  class RedditAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Reddit Agent interacts with Reddit API.
+
+      `debug` is used for verbose mode.
+
+      `subreddit` is for hottest post (use space to separate subreddits).
+
+      `username` is mandatory for auth endpoints.
+
+      `password` is mandatory for auth endpoints.
+
+      `bearer_token` is mandatory for authentication (to avoid issue when refresh is needed, continue to use the default value for this field).
+
+      `client_id` is mandatory for auth endpoints.
+
+      `secret_key` is mandatory for auth endpoints.
+
+      `type` is for the wanted action like read_unreadmessage.
+
+      `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:
+
+          {
+            "kind": "t4",
+            "data": {
+              "first_message": XXXXXXXXXX,
+              "first_message_name": "XXXXXXXXXX",
+              "subreddit": "huginn",
+              "likes": null,
+              "replies": "",
+              "author_fullname": null,
+              "id": "XXXXXXX",
+              "subject": "re: [join] I would like to join huginn",
+              "associated_awarding_id": null,
+              "score": 0,
+              "author": null,
+              "num_comments": null,
+              "parent_id": "XXXXXXXXXX",
+              "subreddit_name_prefixed": "r/huginn",
+              "new": true,
+              "type": "unknown",
+              "body": "You're approved - welcome to the sub!",
+              "dest": "hihouhou",
+              "was_comment": false,
+              "body_html": "&lt;!-- SC_OFF --&gt;&lt;div class=\"md\"&gt;&lt;p&gt;You&amp;#39;re approved - welcome to the sub!&lt;/p&gt;\n&lt;/div&gt;&lt;!-- SC_ON --&gt;",
+              "name": "t4_1vxz7ox",
+              "created": 1686931931,
+              "created_utc": 1686931931,
+              "context": "",
+              "distinguished": "moderator"
+            }
+          }
+    MD
+
+    def default_options
+      {
+        'type' => 'read_unreadmessage',
+        'debug' => 'false',
+        'password' => '',
+        'username' => '',
+        'client_id' => '',
+        'secret_key' => '',
+        'bearer_token' => '{% credential reddit_bearer_token %}',
+        'subreddit' => '',
+        'limit' => '',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :type, type: :array, values: ['read_unreadmessage', 'hottest_post_subreddit']
+    form_configurable :username, type: :string
+    form_configurable :password, type: :string
+    form_configurable :client_id, type: :string
+    form_configurable :secret_key, type: :string
+    form_configurable :bearer_token, type: :string
+    form_configurable :limit, type: :string
+    form_configurable :subreddit, 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
+      errors.add(:base, "type has invalid value: should be 'read_unreadmessage' 'hottest_post_subreddit'") if interpolated['type'].present? && !%w(read_unreadmessage hottest_post_subreddit).include?(interpolated['type'])
+
+      unless options['subreddit'].present? || !['hottest_post_subreddit'].include?(options['type'])
+        errors.add(:base, "subreddit is a required field")
+      end
+
+      unless options['password'].present? || !['read_unreadmessage', 'hottest_post_subreddit'].include?(options['type'])
+        errors.add(:base, "password is a required field")
+      end
+
+      unless options['username'].present? || !['read_unreadmessage', 'hottest_post_subreddit'].include?(options['type'])
+        errors.add(:base, "username is a required field")
+      end
+
+      unless options['client_id'].present? || !['read_unreadmessage', 'hottest_post_subreddit'].include?(options['type'])
+        errors.add(:base, "client_id is a required field")
+      end
+
+      unless options['secret_key'].present? || !['read_unreadmessage', 'hottest_post_subreddit'].include?(options['type'])
+        errors.add(:base, "secret_key is a required field")
+      end
+
+      unless options['bearer_token'].present?
+        errors.add(:base, "bearer_token is a required field")
+      end
+
+      unless options['limit'].present? || !['hottest_post_subreddit'].include?(options['type'])
+        errors.add(:base, "limit 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?('details') && boolify(options['details']).nil?
+        errors.add(:base, "if provided, details 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 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
+          token_refresh()
+        else
+          log "refresh not needed"
+        end
+      end
+    end
+
+    def token_refresh()
+      url = URI('https://ssl.reddit.com/api/v1/access_token')
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+    
+      request = Net::HTTP::Post.new(url)
+      request.basic_auth(interpolated['client_id'], interpolated['secret_key'])
+      request.set_form_data(
+        'grant_type' => 'password',
+        'username' => interpolated['username'],
+        'password' => interpolated['password']
+      )
+    
+      response = http.request(request)
+      log_curl_output(response.code,response.body)
+    
+      if response.is_a?(Net::HTTPSuccess)
+        payload = JSON.parse(response.body)
+        if interpolated['bearer_token'] != payload['access_token']
+          set_credential("reddit_bearer_token", payload['access_token'])
+          if interpolated['debug'] == 'true'
+            log "reddit_bearer_token credential updated"
+          end
+        end
+        memory['expires_at'] = payload['expires_in'] + Time.now.to_i
+      end
+    end
+
+    def read_all_messages(base_url,token)
+
+      check_token_validity()
+      uri = URI.parse("#{base_url}/api/read_all_messages")
+      request = Net::HTTP::Post.new(uri)
+      request["Authorization"] = "Bearer #{interpolated['bearer_token']}"
+      request["User-Agent"] = "huginn/1"
+
+      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)
+
+    end
+
+    def fetch_hottest_post(base_url,subreddit)
+      url = URI("https://www.reddit.com/r/#{subreddit}/hot.json?limit=#{interpolated['limit']}")
+      req = Net::HTTP::Get.new(url)
+      req["User-Agent"] = "huginn/1"
+
+      res = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+
+      log_curl_output(res.code,res.body)
+
+      payload = JSON.parse(res.body)
+      payload['data']['children'].each do |message|
+        create_event payload: message
+      end
+
+    end
+
+    def check_hottest_post_subreddit(base_url)
+      subreddit_list = interpolated['subreddit'].split(" ")
+      subreddit_list.each do |wanted_subreddit|
+        fetch_hottest_post(base_url,wanted_subreddit)
+      end
+
+    end
+
+    def check_unreadmessage(base_url)
+
+      check_token_validity()
+      uri = URI.parse("#{base_url}/message/unread")
+      request = Net::HTTP::Get.new(uri)
+      request["Authorization"] = "Bearer #{interpolated['bearer_token']}"
+      request["User-Agent"] = "huginn/1"
+
+      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)
+      payload['data']['children'].each do |message|
+        if interpolated['emit_events'] == 'true'
+          create_event payload: message
+        end
+      end
+      if !payload['data']['children'].empty?
+        read_all_messages(base_url,token)
+      end
+    end
+
+    def trigger_action
+
+      base_url = 'https://oauth.reddit.com'
+      case interpolated['type']
+      when "read_unreadmessage"
+        check_unreadmessage(base_url)
+      when "hottest_post_subreddit"
+        check_hottest_post_subreddit(base_url)
+      else
+        log "Error: type has an invalid value (#{interpolated['type']})"
+      end
+    end
+  end
+end

data/lib/huginn_reddit_agent.rb

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

data/spec/reddit_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::RedditAgent do
+  before(:each) do
+    @valid_options = Agents::RedditAgent.new.default_options
+    @checker = Agents::RedditAgent.new(:name => "RedditAgent", :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_reddit_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.11
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-22 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_reddit_agent.rb
+- lib/huginn_reddit_agent/reddit_agent.rb
+- spec/reddit_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_reddit_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/reddit_agent_spec.rb