huginn_elks46_mms_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bacb90895ee3229f7e187be5e92c7af424b581ea68b5f1a3dbbf2cde2c0be8e0
+  data.tar.gz: c93ae24c541d1011822989138dbb8cde6ba38126bdabcea52889bdf619909f08
+SHA512:
+  metadata.gz: aa9abab11053bcb55b41b8a64dfa414321bc352109acf90eb2c4e066b0c7d54d903777d8799fae58c7368b4636558922537fda68c7b64809d3064aaeacb43f97
+  data.tar.gz: 455471a6adb25022bc7616c46ffe7ba2a7b3d8a350a8d135afd68d4c1e226b2168b2731c20e5e1750dd443a9eaf3645c1f3d3b52ce2aba7e18bace47ec33b83b

data/lib/huginn_elks46_mms_agent.rb

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

data/lib/huginn_elks46_mms_agent/elks46_mms_agent.rb

@@ -0,0 +1,90 @@
+require 'net/http'
+
+module Agents
+  class Elks46MmsAgent < Agent
+    no_bulk_receive!
+    cannot_create_events!
+    cannot_be_scheduled!
+    description <<-MD
+      Integration that enables you to **send** MMS from Huginn.
+
+      Define your API credentials (`api_username` and `api_password`) which you can find at your [46elks account](https://46elks.com).
+
+      Options:
+
+      * `from` - The phone number to send from. Must be an MMS-enabled [Virtual Phone Number](https://46elks.com/products/virtual-numbers) or the text "noreply". We will replace the sender id with a random phone number if "noreply" is used.
+
+      * `to` - The phone number of the recipient in [E.164 format](https://46elks.com/kb/e164).
+
+      * `message` - A message to be sent with the MMS. Either message or image must be present in the API request.
+
+      * `image` - Either a data URL or a publicly accessible URL that points to an image. GIF, PNG and JPEG images are supported. Either image or message must be present in the API request.
+    MD
+
+    def default_options
+      {
+          'api_username' => 'u6xxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+          'api_password' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+          'from' => 'noreply',
+          'to' => ['+46700000000'],
+          'image' => 'https://46elks.com/press/46elks-blue-png',
+          'message' => 'Hello this is Huginn using 46elks.',
+      }
+    end
+
+    def validate_options
+      unless options['api_username'].present?
+        errors.add(:base, '`api_username` is required.')
+      end
+      unless options['api_password'].present?
+        errors.add(:base, '`api_password` is required.')
+      end
+      unless interpolated['from'].present?
+        errors.add(:base, '`from` is required.')
+      end
+      unless interpolated['to'].present?
+        errors.add(:base, '`to` is required.')
+      end
+      unless interpolated['message'].present? || interpolated['image'].present?
+        errors.add(:base, 'At least one of `image` or `message` must be present.')
+      end
+    end
+
+    def working?
+      !recent_error_logs?
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        interpolate_with event do
+          send_mms(interpolated)
+        end
+      end
+    end
+
+    def send_mms(payload)
+      payload['to'].each do |to_recipient|
+        uri = URI('https://api.46elks.com/a1/mms')
+        req = Net::HTTP::Post.new(uri)
+        req.basic_auth options['api_username'], options['api_password']
+        req.set_form_data(
+          :from => payload['from'],
+          :to => to_recipient,
+          :image => payload['image'],
+          :message => payload['message']
+        )
+
+        res = Net::HTTP.start(
+            uri.host,
+            uri.port,
+            :use_ssl => uri.scheme == 'https') do |http|
+          http.request req
+        end
+
+        unless res.is_a?(Net::HTTPSuccess)
+          error("Error: #{res.body}")
+        end
+      end
+    end
+  end
+end

data/spec/elks46_mms_agent_spec.rb

@@ -0,0 +1,91 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::Elks46MmsAgent do
+    before do
+        default_options = {
+            'api_username' => 'u6xxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+            'api_password' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+            'from' => 'noreply',
+            'to' => ['+46700000000'],
+            'image' => 'https://46elks.com/press/46elks-blue-png',
+            'message' => 'Hello this is Huginn using 46elks.',
+        }
+
+        @checker = Agents::Elks46MmsAgent.new name: 'elks46 MMS Tester', options: default_options
+        @checker.user = users(:bob)
+        @checker.save!
+    end
+
+    def event_with_payload(payload)
+        event = Event.new
+        event.agent = agents(:bob_manual_event_agent)
+        event.payload = payload
+        event.save!
+        event
+    end
+
+
+    def stub_methods
+        stub.any_instance_of(Agents::Elks46MmsAgent).send_mms do |params|
+            @sent_messages << params
+        end
+    end
+
+    describe 'validation' do
+        before do
+            expect(@checker).to be_valid
+        end
+
+        it "should validate the presence of api_username" do
+            @checker.options[:api_username] = ''
+            expect(@checker).not_to be_valid
+        end
+
+        it "should validate the presence of api_password" do
+            @checker.options[:api_password] = ''
+            expect(@checker).not_to be_valid
+        end
+
+        it "should validate the presence of from" do
+            @checker.options[:from] = ''
+            expect(@checker).not_to be_valid
+        end
+
+        it "should validate the presence of to" do
+            @checker.options[:to] = ''
+            expect(@checker).not_to be_valid
+        end
+
+        it "should validate the presence of message or image" do
+            @checker.options[:message] = ''
+            @checker.options[:image] = ''
+            expect(@checker).not_to be_valid
+        end
+    end
+
+    describe '#receive' do
+        before do
+            stub_methods
+            @sent_messages = []
+
+            expect(@checker).to be_valid
+        end
+        it "should receive event" do
+            event = event_with_payload from: "noreply", to: ["+46700000000"], image: "https://46elks.com/press/46elks-blue-png", message: "Hello this is Huginn using 46elks."
+            @checker.receive [event]
+
+            expect(@sent_messages).to eq([
+                {
+                    "api_username": 'u6xxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                    "api_password": 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                    "from": 'noreply',
+                    "to": ["+46700000000"],
+                    "image": 'https://46elks.com/press/46elks-blue-png',
+                    "message": 'Hello this is Huginn using 46elks.',
+                }.stringify_keys
+                ])
+            end
+
+    end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: huginn_elks46_mms_agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- antonmyr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-30 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:
+- anton@46elks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/huginn_elks46_mms_agent.rb
+- lib/huginn_elks46_mms_agent/elks46_mms_agent.rb
+- spec/elks46_mms_agent_spec.rb
+homepage: https://github.com/antonmyr/huginn_elks46_mms_agent
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Send MMS from Huginn using 46elks.
+test_files:
+- spec/elks46_mms_agent_spec.rb