huginn_twitch_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1cc82e7e80cc2e2aa423f0243c01d9e919e1039a0523a2f49419d219496986a
+  data.tar.gz: bb675dcce1e88d61650dcf9f0548d5c174db25d9c47cb4aeda32ed283814c45a
+SHA512:
+  metadata.gz: 3052680728fe48f0a355c9ef3f5d09fee0cea334cd5729f21185a1e00de464fbec247290ffceba1dc9e003c62b8c03b965df51aaba8c1351e71e5e2b4beda303
+  data.tar.gz: 3b9322ebb8a64aaaebeac4356ac408d6cf29938f4fe9ab86ec3f5dad8d7e6f5345a5e95d34b49b1e502a6defcc295a2062446dcdb6360c1b3903060f127cc30c

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_twitch_agent/twitch_agent.rb

@@ -0,0 +1,222 @@
+module Agents
+  class TwitchAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule "never"
+
+    description do
+      <<-MD
+      The Twitch Agent is able to find information about users, checking live steam, others.
+
+      `debug` is used for verbose mode.
+
+      `user_id` is the id of the user.
+
+      `client_secret` is the secret of your app.
+
+      `access_token` is token created for your app.
+
+      `client_id` is the id of your app.
+
+      `type` is for the wanted action like get_user_informations/active_streams.
+
+      `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": [
+              {
+                "id": "187039841",
+                "login": "xtivalia",
+                "display_name": "xTivalia",
+                "type": "",
+                "broadcaster_type": "affiliate",
+                "description": "Streameuse multigaming de 24ans, joueuse PC depuis 9 ans. Chill, bonne humeur et fun uniquement. ",
+                "profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/1deae406-248d-40e0-9775-5e67da5eafd9-profile_image-300x300.png",
+                "offline_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/f7b1b1da-f573-4c01-b9e2-f8c9d84c08cc-channel_offline_image-1920x1080.jpeg",
+                "view_count": 1227,
+                "created_at": "2017-12-23T18:56:07Z"
+              }
+            ]
+          }
+    MD
+
+    def default_options
+      {
+        'client_id' => '',
+        'user_id' => '',
+        'client_secret' => '',
+        'access_token' => '',
+        'debug' => 'false',
+        'emit_events' => 'false',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :user_id, type: :string
+    form_configurable :client_id, type: :string
+    form_configurable :client_secret, type: :string
+    form_configurable :access_token, type: :string
+    form_configurable :debug, type: :boolean
+    form_configurable :emit_events, type: :boolean
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :type, type: :array, values: ['get_user_informations', 'active_streams']
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'get_user_informations', 'active_streams'") if interpolated['type'].present? && !%w(get_user_informations active_streams).include?(interpolated['type'])
+
+      unless options['user_id'].present?
+        errors.add(:base, "user_id is a required field")
+      end
+
+      unless options['client_id'].present?
+        errors.add(:base, "client_id is a required field")
+      end
+
+      unless options['client_secret'].present?
+        errors.add(:base, "client_secret is a required field")
+      end
+
+      unless options['access_token'].present?
+        errors.add(:base, "access_token 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?(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
+
+      if interpolated['emit_events'] == 'true'
+        create_event payload: body
+      end
+
+    end
+
+    def active_streams()
+
+      uri = URI.parse("https://api.twitch.tv/helix/streams?user_id=#{interpolated['user_id']}")
+      request = Net::HTTP::Get.new(uri)
+      request["Authorization"] = "Bearer #{interpolated['access_token']}"
+      request["Client-Id"] = "#{interpolated['client_id']}"
+      
+      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 "request status : #{response.code}"
+      payload = JSON.parse(response.body)
+      if payload.to_s != memory['last_status']
+        if "#{memory['last_status']}" == ''
+          payload['data'].each do |stream|
+             log_curl_output(response.code,stream)
+          end
+        else
+          last_status = memory['last_status'].gsub("=>", ": ").gsub(": nil,", ": null,")
+          last_status = JSON.parse(last_status)
+          payload['data'].each do |stream|
+            found = false
+            if interpolated['debug'] == 'true'
+              log "stream"
+              log stream
+            end
+            last_status['data'].each do |streambis|
+              if stream == streambis
+                found = true
+              end
+              if interpolated['debug'] == 'true'
+                log "streambis"
+                log streambis
+                log "found is #{found}!"
+              end
+            end
+            if found == false
+              log_curl_output(response.code,stream)
+            end
+          end
+        end
+        memory['last_status'] = payload.to_s
+      end
+    end
+
+    def get_user_informations()
+      
+      uri = URI.parse("https://api.twitch.tv/helix/users?id=#{interpolated['user_id']}")
+      request = Net::HTTP::Get.new(uri)
+      request["Authorization"] = "Bearer #{interpolated['access_token']}"
+      request["Client-Id"] = "#{interpolated['client_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)
+
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "get_user_informations"
+        get_user_informations()
+      when "active_streams"
+        active_streams()
+      else
+        log "Error: type has an invalid value (#{interpolated['type']})"
+      end
+    end
+  end
+end

data/lib/huginn_twitch_agent.rb

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

data/spec/twitch_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::TwitchAgent do
+  before(:each) do
+    @valid_options = Agents::TwitchAgent.new.default_options
+    @checker = Agents::TwitchAgent.new(:name => "TwitchAgent", :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_twitch_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_twitch_agent.rb
+- lib/huginn_twitch_agent/twitch_agent.rb
+- spec/twitch_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_twitch_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/twitch_agent_spec.rb