huginn_time_filter_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92342e4bdc63cda2208359dbb7d013fb8e0eec29c6ad9893cdcef616d113ed5f
+  data.tar.gz: cafc671f5c71152f00fda4cbcb80563b8d092b6e496c2fed5d71e5625769cfb2
+SHA512:
+  metadata.gz: 3518a73a74d3ddab49eb7b6dc4d8aa30b1e63a23710a4cf45d765b260f36318088a13cff49cee00c06dfa3a5b91745299abd5bfc0698124951e9249e122bebad
+  data.tar.gz: 6138d9cc2662c129e7f6e2157de1739703614f6fedc5860cc107b50bf5f83645ad9f3bac30a3d9c669e3f2eea25e9c4ea3fee07315548ae4ac5d94b67e884fb9

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2019 Adrian Schoenig
+
+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_time_filter_agent.rb

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

data/lib/huginn_time_filter_agent/time_filter_agent.rb

@@ -0,0 +1,59 @@
+require 'time'
+
+module Agents
+  class TimeFilterAgent < Agent
+    cannot_be_scheduled!
+
+    description <<-MD
+      The Time Filter Agent filters events based on whether a 24h or AM/PM time in them is within a provided range.
+
+      `time_path` should be set to where in the event's payload the time information is, default is `time`
+
+      `earliest` should be set to earliest allowed time, default is `08:00`
+
+      `latest` should be set to the latest allowed time, default is `20:00`
+    MD
+
+    def default_options
+      {
+        "earliest": "08:00",
+        "latest": "20:00",
+        "time_path": "time"
+      }
+    end
+
+    def validate_options
+      errors.add(:base, "time_path needs to be present") if options['time_path'].blank?
+      errors.add(:base, "earliest and/or latest needs to be present") if options['earliest'].blank? or options['latest'].blank?
+    end
+
+    def working?
+      checked_without_error?
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        event_time = get_time(event.payload[options['time_path']])
+        return if event_time.nil?
+
+        earliest_time = get_time(options['earliest'])        
+        latest_time = get_time(options['latest'])
+        return unless earliest_time.nil? or event_time >= earliest_time
+        return unless latest_time.nil? or event_time <= latest_time
+
+        create_event payload: event.payload
+      end
+    end
+
+    private
+
+    def get_time(string)
+      return if string.blank?
+      begin
+        Time.parse(string)
+      rescue
+        nil
+      end
+    end
+  end
+end

data/spec/time_filter_agent_spec.rb

@@ -0,0 +1,97 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::TimeFilterAgent do
+  before(:each) do
+    @valid_options = Agents::TimeFilterAgent.new.default_options
+    @checker = Agents::TimeFilterAgent.new(:name => "TimeFilterAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  it 'renders the event description without errors' do
+    expect { @checker.event_description }.not_to raise_error
+  end
+
+  context '#validate_options' do
+    it 'is valid with the default options' do
+      expect(@checker).to be_valid
+    end
+
+    it 'requires either time to be set' do
+      @checker.options['earliest'] = ""
+      @checker.options['latest'] = ""
+      expect(@checker).not_to be_valid
+    end
+
+    it 'requires time_path to be set' do
+      @checker.options['time_path'] = ""
+      expect(@checker).not_to be_valid
+    end
+  end  
+
+  context '#receive' do
+    it "accepts an AM/PM time in timeframe" do
+      event = Event.new(payload: {"time" => "5:30PM"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(1)
+    end
+
+    it "accepts an AM/PM time in timeframe for alternative path" do
+      event = Event.new(payload: {"my_time" => "5:30PM"})
+      @checker.options['time_path'] = "my_time"
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(1)
+    end
+
+
+    it "rejects an AM/PM time after timeframe" do
+      event = Event.new(payload: {"time" => "11:30PM"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(0)
+    end
+
+    it "rejects an AM/PM time before timeframe" do
+      event = Event.new(payload: {"time" => "7:30AM"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(0)
+    end
+
+    it "accepts a 24h time in timeframe" do
+      event = Event.new(payload: {"time" => "20:00"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(1)
+    end
+
+    it "accepts a 24h time with seconds in timeframe" do
+      event = Event.new(payload: {"time" => "8:00:00"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(1)
+    end
+
+    it "rejects a 24h time after timeframe" do
+      event = Event.new(payload: {"time" => "23:30"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(0)
+    end
+
+    it "rejects a 24h time before timeframe" do
+      event = Event.new(payload: {"time" => "3:30"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(0)
+    end
+
+    it "rejects an event without a time" do
+      event = Event.new(payload: {"no_time" => "for you"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(0)
+    end
+
+    it "rejects an event without a bad time" do
+      event = Event.new(payload: {"time" => "not a time"})
+
+      expect { @checker.receive([event]) }.to change(Event, :count).by(0)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_time_filter_agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Adrian Schoenig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: 
+email:
+- adrian.schoenig@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_time_filter_agent.rb
+- lib/huginn_time_filter_agent/time_filter_agent.rb
+- spec/time_filter_agent_spec.rb
+homepage: https://github.com/nighthawk/huginn_time_filter_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.0.2
+signing_key: 
+specification_version: 4
+summary: Huginn agent that filters events based on their time information
+test_files:
+- spec/time_filter_agent_spec.rb