huginn_openweathermap_agent 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec6ffdd01d7f47ab353f20a8dd191269c1dbfb90891942d7185430c706d0645c
+  data.tar.gz: f7071091bdc5a1fa0be03ac49dbf194d8131b812a8267b1379f785164e281cb9
+SHA512:
+  metadata.gz: 9dd85480fcef0ebfb0c436994063b2efce34ec4e44deb1f3ce6adc03d4cb8b30f662e10294f802db805a05c50e3b218e2e1c13d4654e2210d114e646914cf1c4
+  data.tar.gz: b6a381236fad69c8d3db626efeaf3a5559fff64ded5a6cf615effe093f1dacac7458af8776fad49e7d06f43a9b8f4dd60ff669dcbd168e5fea781685d3e338d1

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_openweathermap_agent/openweathermap_agent.rb

@@ -0,0 +1,213 @@
+module Agents
+  class OpenweathermapAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule "never"
+
+    description <<-MD
+      The Weather Agent creates an event for the day's weather at a given `location`.
+
+      I created this agent because about [Dark Sky](https://darksky.net/dev/) -> "We are no longer accepting new signups".
+
+      The weather forecast information is provided by Openweathermap. 
+
+      The `language` parameter to get the output in your language
+
+      The `lat` (latitude) and `lon` (longitude) must be configured for current_weather. For example, San Francisco would be `37.7771,-122.4196`.
+
+      You must set up an [API key for Openweathermap](https://home.openweathermap.org/api_keys) in order to use this Agent.
+
+      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.
+
+    MD
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "coord": {
+              "lon": 2.3333,
+              "lat": 48.8667
+            },
+            "weather": [
+              {
+                "id": 800,
+                "main": "Clear",
+                "description": "clear sky",
+                "icon": "01d"
+              }
+            ],
+            "base": "stations",
+            "main": {
+              "temp": 300.35,
+              "feels_like": 300.5,
+              "temp_min": 298.87,
+              "temp_max": 301.01,
+              "pressure": 1008,
+              "humidity": 46
+            },
+            "visibility": 10000,
+            "wind": {
+              "speed": 3.6,
+              "deg": 210
+            },
+            "clouds": {
+              "all": 0
+            },
+            "dt": 1656004271,
+            "sys": {
+              "type": 2,
+              "id": 2041230,
+              "country": "FR",
+              "sunrise": 1655956045,
+              "sunset": 1656014290
+            },
+            "timezone": 7200,
+            "id": 6545270,
+            "name": "Palais-Royal",
+            "cod": 200
+          }
+    MD
+
+    def default_options
+      {
+        'type' => '',
+        'token' => '',
+        'limit' => '',
+        'unit' => 'metric',
+        'lat' => '',
+        'lon' => '',
+        'language' => 'en',
+        'debug' => 'false',
+        'emit_events' => 'true',
+        'expected_receive_period_in_days' => '2',
+      }
+    end
+
+    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: ['current_weather', 'air_pollution', 'onecall', 'forecast5d']
+    form_configurable :unit, type: :array, values: ['metric', 'standard', 'imperial']
+    form_configurable :token, type: :string
+    form_configurable :limit, type: :string
+    form_configurable :language, type: :string
+    form_configurable :lat, type: :string
+    form_configurable :lon, type: :string
+    def validate_options
+      errors.add(:base, "type has invalid value: should be 'current_weather' 'air_pollution' 'onecall' 'forecast5d'") if interpolated['type'].present? && !%w(current_weather air_pollution onecall forecast5d).include?(interpolated['type'])
+
+      errors.add(:base, "unit has invalid value: should be 'metric' 'standard' 'imperial'") if interpolated['type'].present? && !%w(metric standard imperial).include?(interpolated['unit'])
+      errors.add(:base, "lon must be provided") if not interpolated['lon'].present? && ( interpolated['type'] == 'current_weather' or interpolated['type'] == 'air_pollution' or interpolated['type'] == 'onecall' or interpolated['type'] == 'forecast5d')
+
+      errors.add(:base, "lat must be provided") if not interpolated['lat'].present? && ( interpolated['type'] == 'current_weather' or interpolated['type'] == 'air_pollution' or interpolated['type'] == 'onecall' or interpolated['type'] == 'forecast5d')
+
+      unless options['language'].present?
+        errors.add(:base, "language is a required field")
+      end
+
+      unless options['token'].present?
+        errors.add(:base, "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 get_forecast5d()
+
+      uri = URI.parse("https://api.openweathermap.org/data/2.5/forecast?lat=#{interpolated['lat']}&units=#{interpolated['unit']}&lon=#{interpolated['lon']}&appid=#{interpolated['token']}&lang=#{interpolated['language']}")
+      response = Net::HTTP.get_response(uri)
+
+      log_curl_output(response.code,response.body)
+
+    end
+
+    def get_current_weather()
+
+      uri = URI.parse("https://api.openweathermap.org/data/2.5/weather?lat=#{interpolated['lat']}&units=#{interpolated['unit']}&lon=#{interpolated['lon']}&appid=#{interpolated['token']}&lang=#{interpolated['language']}")
+      response = Net::HTTP.get_response(uri)
+
+      log_curl_output(response.code,response.body)
+
+    end
+
+    def get_air_pollution()
+
+      uri = URI.parse("https://api.openweathermap.org/data/2.5/air_pollution?lat=#{interpolated['lat']}&units=#{interpolated['unit']}&lon=#{interpolated['lon']}&appid=#{interpolated['token']}&lang=#{interpolated['language']}")
+      response = Net::HTTP.get_response(uri)
+
+      log_curl_output(response.code,response.body)
+
+    end
+
+    def get_onecall()
+
+      uri = URI.parse("https://api.openweathermap.org/data/3.0/onecall?lat=#{interpolated['lat']}&units=#{interpolated['unit']}&lon=#{interpolated['lon']}&appid=#{interpolated['token']}&lang=#{interpolated['language']}")
+      response = Net::HTTP.get_response(uri)
+
+      log_curl_output(response.code,response.body)
+
+    end
+
+    def trigger_action
+
+      case interpolated['type']
+      when "current_weather"
+        get_current_weather()
+      when "air_pollution"
+        get_air_pollution()
+      when "onecall"
+        get_onecall()
+      when "forecast5d"
+        get_forecast5d()
+      else
+        log "Error: type has an invalid value (#{type})"
+      end
+    end
+  end
+end

data/lib/huginn_openweathermap_agent.rb

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

data/spec/openweathermap_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::OpenweathermapAgent do
+  before(:each) do
+    @valid_options = Agents::OpenweathermapAgent.new.default_options
+    @checker = Agents::OpenweathermapAgent.new(:name => "OpenweathermapAgent", :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_openweathermap_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.11
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-10-08 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_openweathermap_agent.rb
+- lib/huginn_openweathermap_agent/openweathermap_agent.rb
+- spec/openweathermap_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_openweathermap_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/openweathermap_agent_spec.rb