huginn/spec/models/agents/pushover_agent_spec.rb

require 'rails_helper'

describe Agents::PushoverAgent do
  before do
    @checker = Agents::PushoverAgent.new(name: 'Some Name',
                                         options: {
                                           token: 'x',
                                           user: 'x',
                                           message: "{{ message | default: text | default: 'Some Message' }}",
                                           device: "{{ device | default: 'Some Device' }}",
                                           title: "{{ title | default: 'Some Message Title' }}",
                                           url: "{{ url | default: 'http://someurl.com' }}",
                                           url_title: "{{ url_title | default: 'Some Url Title' }}",
                                           priority: "{{ priority | default: 0 }}",
                                           timestamp: "{{ timestamp | default: 'false' }}",
                                           sound: "{{ sound | default: 'pushover' }}",
                                           retry: "{{ retry | default: 0 }}",
                                           expire: "{{ expire | default: 0 }}",
                                           expected_receive_period_in_days: '1'
                                         })

    @checker.user = users(:bob)
    @checker.save!

    @event = Event.new
    @event.agent = agents(:bob_weather_agent)
    @event.payload = { message: 'Looks like its going to rain' }
    @event.save!

    @sent_notifications = []
    allow_any_instance_of(Agents::PushoverAgent).to receive(:send_notification) { |agent, notification| @sent_notifications << notification }
  end

  describe '#receive' do
    it 'should make sure multiple events are being received' do
      event1 = Event.new
      event1.agent = agents(:bob_rain_notifier_agent)
      event1.payload = { message: 'Some message' }
      event1.save!

      event2 = Event.new
      event2.agent = agents(:bob_weather_agent)
      event2.payload = { message: 'Some other message' }
      event2.save!

      @checker.receive([@event,event1,event2])
      expect(@sent_notifications[0]['message']).to eq('Looks like its going to rain')
      expect(@sent_notifications[1]['message']).to eq('Some message')
      expect(@sent_notifications[2]['message']).to eq('Some other message')
    end

    it 'should make sure event message overrides default message' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some new message'}
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['message']).to eq('Some new message')
    end

    it 'should make sure event text overrides default message' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { text: 'Some new text'}
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['message']).to eq('Some new text')
    end

    it 'should make sure event title overrides default title' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some message', title: 'Some new title' }
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['title']).to eq('Some new title')
    end

    it 'should make sure event url overrides default url' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some message', url: 'Some new url' }
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['url']).to eq('Some new url')
    end

    it 'should make sure event url_title overrides default url_title' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some message', url_title: 'Some new url_title' }
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['url_title']).to eq('Some new url_title')
    end

    it 'should make sure event priority overrides default priority' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some message', priority: '1' }
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['priority']).to eq('1')
    end

    it 'should make sure event timestamp overrides default timestamp' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some message', timestamp: 'false' }
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['timestamp']).to eq('false')
    end

    it 'should make sure event sound overrides default sound' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some message', sound: 'Some new sound' }
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['sound']).to eq('Some new sound')
    end

    it 'should make sure event retry overrides default retry' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some message', retry: 1 }
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['retry']).to eq('1')
    end

    it 'should make sure event expire overrides default expire' do
      event = Event.new
      event.agent = agents(:bob_rain_notifier_agent)
      event.payload = { message: 'Some message', expire: '60' }
      event.save!

      @checker.receive([event])
      expect(@sent_notifications[0]['expire']).to eq('60')
    end
  end

  describe '#working?' do
    it 'checks if events have been received within the expected receive period' do
      # No events received
      expect(@checker).not_to be_working
      Agents::PushoverAgent.async_receive @checker.id, [@event.id]

      # Just received events
      expect(@checker.reload).to be_working
      two_days_from_now = 2.days.from_now
      allow(Time).to receive(:now) { two_days_from_now }

      # More time has passed than the expected receive period without any new events
      expect(@checker.reload).not_to be_working
    end
  end

  describe "validation" do
    before do
      expect(@checker).to be_valid
    end

    it "should validate presence of token" do
      @checker.options[:token] = ""
      expect(@checker).not_to be_valid
    end

    it "should validate presence of user" do
      @checker.options[:user] = ""
      expect(@checker).not_to be_valid
    end

    it "should validate presence of expected_receive_period_in_days" do
      @checker.options[:expected_receive_period_in_days] = ""
      expect(@checker).not_to be_valid
    end

    it "should make sure device is optional" do
      @checker.options[:device] = ""
      expect(@checker).to be_valid
    end

    it "should make sure title is optional" do
      @checker.options[:title] = ""
      expect(@checker).to be_valid
    end

    it "should make sure url is optional" do
      @checker.options[:url] = ""
      expect(@checker).to be_valid
    end

    it "should make sure url_title is optional" do
      @checker.options[:url_title] = ""
      expect(@checker).to be_valid
    end

    it "should make sure priority is optional" do
      @checker.options[:priority] = ""
      expect(@checker).to be_valid
    end

    it "should make sure timestamp is optional" do
      @checker.options[:timestamp] = ""
      expect(@checker).to be_valid
    end

    it "should make sure sound is optional" do
      @checker.options[:sound] = ""
      expect(@checker).to be_valid
    end
  end
end