huginn_elks46_phone_call_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ff16588e5a704a5c691cf45047ebb08fff4f4fef8542838dcb69d1683564bb7
+  data.tar.gz: 16fe1ad492149eea01b3cd93635f1e8eb7acdd2b5cb1bbabce1e74eab3753f68
+SHA512:
+  metadata.gz: 04a1782eb34efe434c6c2ccc43b3b1e1d47993c9fb936db73bb02d530d63a1d8c1d81dce12d897603923735c2ecf30338478d0b2e352752486bea7bcddca4c68
+  data.tar.gz: cbe87280f0320c3234f90b82a34909248f0b9bec260a86cc19386094ddaa7bf1622ca7b128479154862df5a6b5242a916581c763727b8d3e38ab0c324cb802f1

data/lib/huginn_elks46_phone_call_agent.rb

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

data/lib/huginn_elks46_phone_call_agent/elks46_phone_call_agent.rb

@@ -0,0 +1,90 @@
+require 'net/http'
+
+module Agents
+  class Elks46PhoneCallAgent < Agent
+    no_bulk_receive!
+    cannot_create_events!
+    cannot_be_scheduled!
+    description <<-MD
+      Integration that enables you to make phone calls from Huginn.
+      Define your API credentials (`api_username` and `api_password`) which you can find at your [46elks account](https://46elks.com).
+      Options:
+      * `from` - A valid phone number in [E.164 format](https://46elks.com/kb/e164). Can be one of your voice enabled 46elks numbers, the phone number you signed up with, or an unlocked number.
+      
+      * `to` - The phone number of the recipient in [E.164 format](https://46elks.com/kb/e164).
+      * `voice_start` - A webhook URL that returns the first action to execute. See [Call actions](https://46elks.com/docs/call-actions) for details. It is also possible to add a JSON struct for direct call actions without any logic, like: {"connect":"+46766861004"}.   
+      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' => '+xxxxxxxxxxx',
+          'to' => ['+46700000000'],
+          'voice_start' => '{"play":"https://file-examples.com/wp-content/uploads/2017/11/file_example_MP3_700KB.mp3"}',
+      }
+    end
+
+    def validate_options
+      # Should validate even more, especially the api keys
+      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['voice_start'].present?
+        errors.add(:base, '`voice_start` is required.')
+      end
+      unless /{"(play|record|recordcall|ivr|hangup)":".*"}/.match(interpolated['voice_start'])
+        errors.add(:base, '`voice_start` needs to include a valid call action and value. See https://46elks.com/docs/call-actions for more information.')
+      end
+    end
+
+    def working?
+      !recent_error_logs?
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        interpolate_with event do
+          make_phone_call(interpolated)
+        end
+      end
+    end
+
+    def make_phone_call(payload)
+      payload['to'].each do |to_recipient|
+        uri = URI('https://api.46elks.com/a1/calls')
+        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,
+          :voice_start => payload['voice_start']
+        )
+
+        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_phone_call_agent_spec.rb

@@ -0,0 +1,92 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::Elks46PhoneCallAgent do
+    before do
+        default_options = {
+            'api_username' => 'u6xxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+            'api_password' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+            'from' => '+46700000000',
+            'to' => ['+46700000000'],
+            'voice_start' => '{"hangup":"busy"}',
+        }
+
+        @checker = Agents::Elks46PhoneCallAgent.new name: 'elks46 Phone Call 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::Elks46PhoneCallAgent).make_phone_call 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 voice_start" do
+            @checker.options[:voice_start] = ''
+            expect(@checker).not_to be_valid
+        end
+        it "should validate that only valid keys are allowed" do
+            @checker.options[:voice_start] = '{"invalid":"busy"}'
+            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: "+46700000000", to: ["+46700000000"], voice_start: '{"hangup":"busy"}'
+            @checker.receive [event]
+
+            expect(@sent_messages).to eq([
+                {
+                    "api_username": 'u6xxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                    "api_password": 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                    "from": '+46700000000',
+                    "to": ["+46700000000"],
+                    "voice_start": '{"hangup":"busy"}'
+                }.stringify_keys
+                ])
+            end
+
+    end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: huginn_elks46_phone_call_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_phone_call_agent.rb
+- lib/huginn_elks46_phone_call_agent/elks46_phone_call_agent.rb
+- spec/elks46_phone_call_agent_spec.rb
+homepage: https://github.com/antonmyr/huginn_elks46_phone_call_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: Make phone calls with various features from Huginn using https://46elks.com.
+test_files:
+- spec/elks46_phone_call_agent_spec.rb