huginn_airparif_agent 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0404c2a71258b58c9a2616f186494619bf4419ad331d3352220e4f6e2b393ff7
+  data.tar.gz: 8637bc1dbb3ed449ba4126c646b3815df77c91e2464e3f6148ad72d668818433
+SHA512:
+  metadata.gz: f3eebe5ce06dca8dec547bc95380015788acbbe5812280d995d35f69ef4306bbc810c80894fc8e89edc5a53675808a5830f590a98e9733254cda7dd172ecf141
+  data.tar.gz: aaf4614cbdbb8f986eba9f6afc6d6661eb7f10ebf2ef216ff6b224f4016878bb8fc95e554ba1b81ecaca471ac684c0549a9289a9317cea8f20219a16a70b1d61

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_airparif_agent/airparif_agent.rb

@@ -0,0 +1,264 @@
+module Agents
+  class AirparifAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1h'
+
+    description do
+      <<-MD
+      The Airparif Agent interacts with Airparif API.
+
+      `debug` is used for verbose mode.
+
+      `apikey` is needed for authenticated endpoint.
+
+      `insee` is needed for the city ( see `https://www.dcode.fr/code-commune-insee`).
+
+      `type` is for the wanted action like planned_pollution_indices.
+
+      `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:
+
+          {
+            "75101": [
+              {
+                "date": "2021-01-15",
+                "no2": "Bon",
+                "o3": "Mauvais",
+                "pm10": "Moyen",
+                "pm25": "Dégradé",
+                "so2": "Bon",
+                "indice": "Dégradé"
+              },
+              {
+                "date": "2021-01-16",
+                "no2": "Bon",
+                "o3": "Mauvais",
+                "pm10": "Moyen",
+                "pm25": "Dégradé",
+                "so2": "Bon",
+                "indice": "Dégradé"
+              }
+            ]
+          }
+    MD
+
+    def default_options
+      {
+        'apikey' => '',
+        'insee' => '',
+        'type' => 'planned_pollution_indices',
+        'debug' => 'false',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    form_configurable :apikey, type: :string
+    form_configurable :insee, 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: ['planned_pollution_indices', 'version', 'prevision_bulletin', 'pollens_bulletin']
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'planned_pollution_indices', 'version', 'prevision_bulletin', 'pollens_bulletin'") if interpolated['type'].present? && !%w(planned_pollution_indices version prevision_bulletin pollens_bulletin).include?(interpolated['type'])
+
+      unless options['insee'].present? || !['planned_pollution_indices'].include?(options['type'])
+        errors.add(:base, "insee is a required field")
+      end
+
+      unless options['apikey'].present? || !['planned_pollution_indices', 'prevision_bulletin', 'pollens_bulletin'].include?(options['type'])
+        errors.add(:base, "apikey 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 version()
+
+      uri = URI.parse("https://api.airparif.asso.fr/version")
+      request = Net::HTTP::Get.new(uri)
+      request["Accept"] = "application/json"
+      
+      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)
+
+      if !memory['version']
+        if interpolated['emit_events'] == 'true'
+          create_event payload: payload
+        end
+      else
+        last_status = memory['version']
+        if payload != last_status
+          create_event payload: response.body
+        end
+      end  
+      memory['version'] = payload
+
+    end
+
+    def planned_pollution_colors()
+
+      uri = URI.parse("https://api.airparif.asso.fr/indices/prevision/couleurs")
+      request = Net::HTTP::Get.new(uri)
+      request["Accept"] = "application/json"
+      request["X-Api-Key"] = interpolated['apikey']
+
+      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)
+
+      return payload
+
+    end
+
+    def prevision_bulletin()
+
+      uri = URI.parse("https://api.airparif.asso.fr/indices/prevision/bulletin")
+      request = Net::HTTP::Get.new(uri)
+      request["Accept"] = "application/json"
+      request["X-Api-Key"] = interpolated['apikey']
+
+      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)
+
+      if interpolated['emit_events'] == 'true'
+        create_event payload: payload
+      end
+
+    end
+
+    def pollens_bulletin()
+
+      uri = URI.parse("https://api.airparif.asso.fr/pollens/bulletin")
+      request = Net::HTTP::Get.new(uri)
+      request["Accept"] = "application/json"
+      request["X-Api-Key"] = interpolated['apikey']
+
+      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)
+
+      if interpolated['emit_events'] == 'true'
+        create_event payload: payload
+      end
+
+    end
+
+    def planned_pollution_indices()
+
+      uri = URI.parse("https://api.airparif.asso.fr/indices/prevision/commune?insee=#{interpolated['insee']}")
+      request = Net::HTTP::Get.new(uri)
+      request["Accept"] = "application/json"
+      request["X-Api-Key"] = interpolated['apikey']
+      
+      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)
+
+      if interpolated['emit_events'] == 'true'
+        create_event payload: payload
+      end
+
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "planned_pollution_indices"
+        planned_pollution_indices()
+      when "version"
+        version()
+      when "prevision_bulletin"
+        prevision_bulletin()
+      when "pollens_bulletin"
+        pollens_bulletin()
+      else
+        log "Error: type has an invalid value (#{interpolated['type']})"
+      end
+    end
+  end
+end

data/lib/huginn_airparif_agent.rb

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

data/spec/airparif_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::AirparifAgent do
+  before(:each) do
+    @valid_options = Agents::AirparifAgent.new.default_options
+    @checker = Agents::AirparifAgent.new(:name => "AirparifAgent", :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_airparif_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-11 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_airparif_agent.rb
+- lib/huginn_airparif_agent/airparif_agent.rb
+- spec/airparif_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_airparif_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/airparif_agent_spec.rb