huginn_sms77_voice_agent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc21165cb6ae38eba981e7ac497e6465b58753a22f06f56b76e8be82ce2b0169
+  data.tar.gz: c9bdff3bf5c357c3dfda74d739718ee6962852739d976f43c87f9e05f5b3c7ef
+SHA512:
+  metadata.gz: dce30e6c354861b7dd96cbbf192d8e662e1a55d152101d96713da75773c414acd19963e29369876e9ce7b15b4a385a66d493fc825bb6d8f86045bc7c1d13210c
+  data.tar.gz: 642b0fbc8f9326e2f51e7c9137c3a0317537f077d01360bc5e9d7a7a1728be4c9e5213ab881b057919ae301176f46990b2158ddf023df7d94ad20acaacf5f510

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-present sms77 e.K.
+
+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_sms77_voice_agent/sms77_voice_agent.rb

@@ -0,0 +1,120 @@
+require 'net/http'
+
+module Agents
+  class Sms77VoiceAgent < Agent
+    include ActiveModel::Type
+    include FormConfigurable
+
+    cannot_be_scheduled!
+    cannot_create_events!
+    no_bulk_receive!
+
+    description <<-MD
+      The Sms77.io Agent receives and collects events for dispatching Text2Voice phone calls to a given number.
+
+      Expects an event with key `text`, `message`, `voice` or `sms` with the text to send. Use the `EventFormattingAgent` if lacks such a key.
+
+      Requires an API key from [Sms77](https://sms77.io) for sending.
+
+      Options:
+
+      * `text` - The message you want to send *(required)*
+
+      * `to` - recipient phone number *(required)*
+
+      * `from` - Sender number. *Expects a string with 11 alphanumeric or 16 numeric characters*
+
+      * `xml` - Decides whether the given text is XML or not *Allowed values: 0, 1*
+    MD
+
+    def required_options
+      {
+        'api_key' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+        'text' => 'Hope to see you again soon!',
+        'to' => '+4900000000000'
+      }
+    end
+
+    def optional_options
+      {
+        'from' => 'Huginn',
+        'xml' => false
+      }
+    end
+
+    def default_options
+      optional_options.merge(required_options)
+    end
+
+    form_configurable :api_key, type: :text
+    form_configurable :from, type: :text
+    form_configurable :text, type: :text
+    form_configurable :to, type: :text
+    form_configurable :xml, type: :boolean
+
+    def source_keys
+      %w[text message voice sms]
+    end
+
+    def validate_options
+      required_options.keys.each do |k|
+        val = options[k]
+        errors.add(:base, "#{k} is required") if val.nil? || val.empty?
+      end
+    end
+
+    def working?
+      interpolated['api_key'].present? && !recent_error_logs?
+    end
+
+    def receive(incoming_events)
+      interpolate_with_each(incoming_events) do |event|
+
+        source_keys.each do |k|
+          text = event.payload[k].presence.to_s
+
+          next unless text.present?
+
+          send_voice text
+        end
+      end
+    end
+
+    def send_voice(text)
+      fd = default_options
+
+      fd.delete('api_key')
+
+      fd.keys.each do |k|
+        val = interpolated[k]
+
+        if 'xml' === k
+          val = ActiveModel::Type::Boolean.new.cast(val) ? '1' : '0'
+        end
+
+        fd[k] = val
+      end
+
+      fd['text'] = text
+
+      log "Sending Text2Speech with payload #{fd.to_json}"
+
+      body = HTTParty.post('https://gateway.sms77.io/api/voice', :body => fd, :headers => {
+        'Authorization' => "Basic #{interpolated['api_key']}",
+        'sentWith' => "Huginn"
+      })
+
+      code = body.split(/\n+/)[0].to_i
+
+      if code === 100
+        log body
+      elsif code === 900
+        raise StandardError, "SMS77_AUTH_ERROR: #{body}"
+      else
+        raise StandardError, "SMS77_DISPATCH_ERROR: #{body}"
+      end
+
+      body
+    end
+  end
+end

data/lib/huginn_sms77_voice_agent.rb

@@ -0,0 +1,3 @@
+require 'huginn_agent'
+
+HuginnAgent.register 'huginn_sms77_voice_agent/sms77_voice_agent'

data/spec/sms77_voice_agent_spec.rb

@@ -0,0 +1,95 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::Sms77VoiceAgent do
+  is_live_test = nil != ENV["SMS77_LIVE_TEST"]
+  api_key = is_live_test ? ENV["SMS77_API_KEY"] : 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+  to = is_live_test ? ENV["SMS77_RECIPIENT"] : '+4900000000000'
+
+  before do
+    @default_options = {
+      api_key: api_key,
+      text: 'Hope to see you again soon!',
+      to: to,
+    }
+
+    if is_live_test
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.allow_http_connections_when_no_cassette = true
+
+        c.hook_into :webmock
+      end
+
+      WebMock.allow_net_connect!
+    end
+
+    @checker = Agents::Sms77Agent.new name: 'Sms77VoiceAgentTest', options: @default_options
+    @checker.user = users(:bob)
+    @checker.save!
+
+    @event = Event.new
+    @event.agent = agents(:bob_manual_event_agent)
+    @event.payload = @default_options
+    @event.save!
+  end
+
+  describe 'validation' do
+    before do
+      expect(@checker).to be_valid
+    end
+
+    it "should validate the presence of api_key" do
+      @checker.options[:api_key] = ''
+      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 text" do
+      @checker.options[:text] = ''
+      expect(@checker).not_to be_valid
+    end
+  end
+
+  describe '#receive' do
+    it "should receive event" do
+      stub(HTTParty).post {
+        '100'\
+        '174206'\
+        '0.1'
+      }
+      @checker.receive([@event])
+    end
+
+    it "should raise error on wrong credentials" do
+      unless is_live_test
+        stub(HTTParty).post { { "success" => "900" } }
+      end
+      opts = @default_options
+      opts[:api_key] = 'thisAintGonnaWork!'
+      expect { @checker.send_voice(opts.stringify_keys) }.to raise_error(StandardError, /SMS77_AUTH_ERROR:/)
+    end
+
+    it "should raise error on general dispatch error" do
+      unless is_live_test
+        stub(HTTParty).post { { "success" => "202" } }
+      end
+      opts = @default_options
+      opts[:to] = '0'
+      expect { @checker.send_voice(opts.stringify_keys) }.to raise_error(StandardError, /SMS77_DISPATCH_ERROR:/)
+    end
+
+    it "should WORK!" do
+      unless is_live_test
+        stub(HTTParty).post { "100" }
+      end
+
+      expect(@checker.send_voice(@default_options.stringify_keys)).to eq(100)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_sms77_voice_agent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sms77 e.K.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-11 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: Send Text2Voice messages from Huginn via https://sms77.io.
+email:
+- support@sms77.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/huginn_sms77_voice_agent.rb
+- lib/huginn_sms77_voice_agent/sms77_voice_agent.rb
+- spec/sms77_voice_agent_spec.rb
+homepage: https://github.com/sms77io/huginn-voice
+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.3.7
+signing_key:
+specification_version: 4
+summary: Send Text2Voice messages from Huginn via https://sms77.io.
+test_files:
+- spec/sms77_voice_agent_spec.rb