huginn_elks46_sms_agent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42c24bf6d807ef54c659e02cc43ebe4eece472610185f584601b7c175de320b6
+  data.tar.gz: c74dd69fd88a8c795145c6e21cec9da22b39fd112bd443e041ef139953f62e54
+SHA512:
+  metadata.gz: 36ea26a678411140fc56600f25dc0e9643b1b56148c9ed209a654537786c80ce56764454d6967e6f5843d100a4c4009aec4bd7eca8c692d04ed54a992833dbfd
+  data.tar.gz: ce97df389032cde21a1406d6092ca40b7dd87b964299df42048904a7c191a741f96f47b1c5ac18a93b22a4316f900285769c3c7617640c2705e482102a45958e

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2020 antonmyr
+
+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_elks46_sms_agent.rb

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

data/lib/huginn_elks46_sms_agent/elks46_sms_agent.rb

@@ -0,0 +1,89 @@
+require 'net/http'
+
+module Agents
+  class Elks46SmsAgent < Agent
+    no_bulk_receive!
+    cannot_create_events!
+    cannot_be_scheduled!
+    description <<-MD
+      Integration that enables you to **send** SMS from Huginn.
+
+      Define your API credentials (`api_username` and `api_password`) which you can find at your [46elks account](https://46elks.com).
+
+      Options:
+
+      * `from` - Either a [text sender ID](https://46elks.com/kb/text-sender-id) or a [virtual phone number](https://46elks.com/products/virtual-numbers) in [E.164 format](https://46elks.com/kb/e164) if you want to be able to receive replies.
+
+      * `to` - The phone number of the recipient in [E.164 format](https://46elks.com/kb/e164).
+
+      * `message` - The message you want to send.
+    MD
+
+    # There is a form_configurable for extra options, this can be used instead of the default options.
+    # It's located in app/concerns/form_configurable.rb
+    def default_options
+      {
+        'api_username' => 'u6xxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+        'api_password' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+        'from' => 'Huginn',
+        'to' => ['+46700000000'],
+        'message' => 'Hello this message from your friend Huginn.',
+      }
+    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?
+        errors.add(:base, '`message` is required.')
+      end
+    end
+
+    def working?
+      !recent_error_logs?
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+          interpolate_with event do
+            send_sms(interpolated)
+          end
+      end
+    end
+
+    def send_sms(payload)
+      payload['to'].each do |to_recipient|
+        uri = URI('https://api.46elks.com/a1/sms')
+        req = Net::HTTP::Post.new(uri)
+        req.basic_auth payload['api_username'], payload['api_password']
+        req.set_form_data(
+          :from => payload['from'],
+          :to => to_recipient,
+          :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_sms_agent_spec.rb

@@ -0,0 +1,88 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::Elks46SmsAgent do
+    before do
+        default_options = {
+        api_username: 'u6xxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+        api_password: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+        from: 'Huginn',
+        to: ['+46700000000'],
+        message: 'This is a message from your friend Huginn.',
+        }
+
+        @checker = Agents::Elks46SmsAgent.new name: 'elks46 SMS 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::Elks46SmsAgent).send_sms 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" do
+            @checker.options[:message] = ''
+            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: "Huginn", to: ["+46700000000"],message: "This is a message from your friend Huginn."
+            @checker.receive [event]
+
+            expect(@sent_messages).to eq([
+                {
+                    "api_username": 'u6xxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                    "api_password": 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                    "from": 'Huginn',
+                    "to": ["+46700000000"],
+                    "message": 'This is a message from your friend Huginn.',
+                }.stringify_keys
+                ])
+            end
+
+    end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: huginn_elks46_sms_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.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: |
+  ## What is this?
+
+  This is an agent that allows you to send SMS with the help of https://46elks.com.
+
+  ## Want more?
+
+  Check out these agents as well:
+
+  -   [Sending MMS from Huginn]()
+  -   [Making Phone calls from Huginn]()
+email:
+- anton@46elks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_elks46_sms_agent.rb
+- lib/huginn_elks46_sms_agent/elks46_sms_agent.rb
+- spec/elks46_sms_agent_spec.rb
+homepage: https://github.com/antonmyr/huginn_elks46_sms_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.3
+signing_key: 
+specification_version: 4
+summary: Send SMS from Huginn using https://46elks.com.
+test_files:
+- spec/elks46_sms_agent_spec.rb