huginn_themoviedb_agent 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8deeeaa4ad2ba1c85a4d264b36f14fa377ad6162e2157885e895f50086aa18ae
+  data.tar.gz: 746760c49574992bb3ac74a83146e29a549bbc1c70bef5bce0488cbc2382fac0
+SHA512:
+  metadata.gz: 7b3407d0123096ab6deffbed5e97b61da6635e7d65ee3aa366968b4149c179583b6529fe42abc4c84329e196cee7afd24ffad377dbbd8c075d18fd308a888ac5
+  data.tar.gz: fc03cb9f61d510bb997ebd815cdf1113e24ec99a784da296db2c39d655d5f4d132f980be38f891aa297d6683382b566537e3042810967999ee202c28b9e1d468

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_themoviedb_agent/themoviedb_agent.rb

@@ -0,0 +1,227 @@
+module Agents
+  class ThemoviedbAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The moviedb Agent interacts with Themoviedb API.
+
+      `debug` is used for verbose mode.
+
+      `token` is used for authentication.
+
+      `type` is for the wanted action like tv_show_details.
+
+      `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:
+
+          {
+            "id": 3718988,
+            "name": "Jibaro",
+            "overview": "A deaf knight and a siren of myth become entwined in a deadly dance. A fatal attraction infused with blood, death and treasure.",
+            "vote_average": 8.123,
+            "vote_count": 65,
+            "air_date": "2022-05-21",
+            "episode_number": 9,
+            "episode_type": "finale",
+            "production_code": "",
+            "runtime": 18,
+            "season_number": 3,
+            "show_id": 86831,
+            "still_path": "/qWHGEsBFoh0Cq3AEWoMsxLZOayx.jpg",
+            "original_name": "Love, Death & Robots",
+            "event_type": "last episode"
+          }
+    MD
+
+    def default_options
+      {
+        'type' => 'tv_show_details',
+        'token' => '',
+        'series_id' => '',
+        'debug' => 'false',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :token, type: :string
+    form_configurable :series_id, 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: ['tv_show_details']
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'tv_show_details'") if interpolated['type'].present? && !%w(tv_show_details).include?(interpolated['type'])
+
+      unless options['token'].present? || !['tv_show_details'].include?(options['type'])
+        errors.add(:base, "token is a required field")
+      end
+
+      unless options['series_id'].present? || !['tv_show_details'].include?(options['type'])
+        errors.add(:base, "series_id 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
+
+    end
+
+    def season_details(original_name,season_number,language)
+
+      url = URI("https://api.themoviedb.org/3/tv/#{interpolated['series_id']}/season/#{season_number}?language=#{language}")
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Get.new(url)
+      request["accept"] = 'application/json'
+      request["Authorization"] = "Bearer #{interpolated['token']}"
+
+      response = http.request(request)
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+
+      payload['episodes'].each do |episode|
+        if interpolated['emit_events'] == 'true'
+          event_created = episode.dup
+          event_created['original_name'] = original_name
+          event_created['event_type'] = 'new episode'
+          create_event payload: event_created
+        end
+      end
+
+    end
+
+    def account_details()
+
+      url = URI("https://api.themoviedb.org/3/account/null")
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Get.new(url)
+      request["accept"] = 'application/json'
+      request["Authorization"] = "Bearer #{interpolated['token']}"
+
+      response = http.request(request)
+
+      log_curl_output(response.code,response.body)
+
+      return response.body
+
+    end
+
+    def tv_show_details()
+
+      your_details = JSON.parse(account_details())
+      language = "#{your_details['iso_639_1']}" + "-" + "#{your_details['iso_3166_1']}"
+      url = URI("https://api.themoviedb.org/3/tv/#{interpolated['series_id']}?language=#{language}")
+      
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      
+      request = Net::HTTP::Get.new(url)
+      request["accept"] = 'application/json'
+      request["Authorization"] = "Bearer #{interpolated['token']}"
+
+      response = http.request(request)
+
+      log_curl_output(response.code,response.body)
+
+      payload = JSON.parse(response.body)
+
+      if payload.to_s != memory['last_status']
+        if "#{memory['last_status']}" == ''
+          create_event payload: payload
+        else
+          last_status = memory['last_status']
+          if payload['last_air_date'] != last_status['last_air_date']
+            event_created = payload['last_episode_to_air'].dup
+            event_created['original_name'] = payload['original_name']
+            event_created['event_type'] = 'last episode'
+            create_event payload: event_created
+          end
+          payload['seasons'].each do | season |
+            found = false
+            last_status['seasons'].each do | seasonbis |
+              if season == seasonbis || season['id'] == seasonbis['id']
+                found = true
+              end
+            end
+            if interpolated['debug'] == 'true'
+              log found
+            end
+            if found == false
+              event_created = season.dup
+              event_created['original_name'] = payload['original_name']
+              event_created['event_type'] = 'new season'
+              create_event :payload => event_created
+              season_details(payload['original_name'],payload['number_of_seasons'],language)
+            end
+          end
+        end
+        memory['last_status'] = payload
+      end
+
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "tv_show_details"
+        tv_show_details()
+      else
+        log "Error: type has an invalid value (#{interpolated['type']})"
+      end
+    end
+  end
+end

data/lib/huginn_themoviedb_agent.rb

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

data/spec/themoviedb_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::ThemoviedbAgent do
+  before(:each) do
+    @valid_options = Agents::ThemoviedbAgent.new.default_options
+    @checker = Agents::ThemoviedbAgent.new(:name => "ThemoviedbAgent", :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_themoviedb_agent
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+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_themoviedb_agent.rb
+- lib/huginn_themoviedb_agent/themoviedb_agent.rb
+- spec/themoviedb_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_themoviedb_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/themoviedb_agent_spec.rb