huginn_sms77_agent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65d9f9785bdc9d6967ffd31c6bdca8467930fae501827a70f7f33d2c802f610f
+  data.tar.gz: d22bc9255e81982237b775f10344be1d00500263974d0aad4ba5cb3085df8e39
+SHA512:
+  metadata.gz: 1c94c1f2ca632c7dd28693c117a953a240c41da1574728c1d95729762fd9dd1ab6b31cffd51cd57c2a60cf8a50d9ebb049b90d504dfd4ae2eba80950666cb1b0
+  data.tar.gz: f93e3984a7ebbaaaf4dd473b9d19397be06c69ba4ff11f2d174ecf6ba61b3abd88fba0910faccba10d60498a057a78cab13363b50dcb85eb74c522111300e3c1

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_agent/sms77_agent.rb

@@ -0,0 +1,113 @@
+require 'net/http'
+
+module Agents
+  class Sms77Agent < Agent
+    no_bulk_receive!
+    cannot_create_events!
+    cannot_be_scheduled!
+    description <<-MD
+      Agent for sending SMS from Huginn via Sms77.io.
+
+      Get an API key at [Sms77](https://sms77.io) and you are ready to start sending!
+
+      Options:
+      * `text` - The message you want to send (required)
+      * `to` - recipient(s) separated by comma - phone number(s) or contact(s) (required)
+
+      * `from` - Sender number. *Allowed value: A string of 11 alphanumeric or 16 numeric characters*
+      * `debug` - If activated no SMS will be sent or calculated *Allowed values: 0, 1*
+      * `delay` - Date/time for time-delayed SMS: *Allowed values: A UNIX timestamp or date with format yyyy-mm-dd hh:ii*
+      * `no_reload` - Switch off reload lock. This lock prevents the sending of the same SMS (text, type and recipient alike) within 180 seconds *Allowed values: 0, 1*
+      * `unicode` - For Cyrillic, Arabic etc characters. SMS length is then reduced to 70 characters. The API recognizes the coding automatically; this parameter enforces it *Allowed values: 0, 1*
+      * `flash` - Send SMS as Flash SMS. These are displayed directly in the receiver’s display *Allowed values: 0, 1*
+      * `udh` - Individual User Data Header of the SMS. If specified and parameter text contains hexcode, message gets sent as 8-bit binary
+      * `utf8` - Forces the detection as a UTF8 character set and overrides automatic recognition of the API *Allowed values: 0, 1*
+      * `ttl` - Specifies the validity period of the SMS in milliseconds *Allowed values: integer between 300000 and 86400000*
+      * `details` - Shows numerous details to the sent SMS. Handy for debugging *Allowed values: 0, 1*
+      * `return_msg_id` - If this parameter is set, the ID of the SMS is output in the second line after the status code *Allowed values: 0, 1*
+      * `label` - Custom label for whatever use. *Allowed characters*: a-z, A-Z, 0-9, .-_@
+      * `json` - The output is more detailed in JSON format *Allowed values: 0, 1*
+      * `performance_tracking` - Enable Performance Tracking for URLs found in the message text *Allowed values: 0, 1*
+      * `foreign_id` - Custom tag to return in DLR callbacks etc. Max. 64 chars. *Allowed characters: a-z, A-Z, 0-9, .-_@*
+    MD
+
+    def default_options
+      {
+          'api_key' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+          'from' => 'Huginn',
+          'text' => 'Hope to see you again soon!',
+          'to' => '+4900000000000',
+          'debug' => 0,
+          'delay' => nil,
+          'no_reload' => nil,
+          'unicode' => 0,
+          'flash' => 0,
+          'udh' => nil,
+          'utf8' => 0,
+          'ttl' => nil,
+          'details' => 0,
+          'return_msg_id' => 0,
+          'label' => nil,
+          'json' => 0,
+          'performance_tracking' => 0,
+          'foreign_id' => nil,
+      }
+    end
+
+    def validate_options
+      unless options['api_key'].present?
+        errors.add(:base, '`api_key` is required.')
+      end
+
+      unless interpolated['text'].present?
+        errors.add(:base, '`text` is required.')
+      end
+
+      unless interpolated['to'].present?
+        errors.add(:base, '`to` is required.')
+      end
+    end
+
+    def working?
+      interpolated['api_key'].present? && !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)
+      fd = default_options
+      fd.delete('api_key')
+      fd.each { |k, v| fd[k] = payload[k] }
+
+      body = HTTParty.post('https://gateway.sms77.io/api/sms',
+                           :body => fd, :headers => {'Authorization' => "Basic #{payload['api_key']}"})
+
+      if !body.is_a?(Hash)
+        begin
+          body = JSON.parse(body)
+        rescue JSON::ParserError => e
+          # Ignored
+        end
+      end
+
+      code = Hash === body ? body['success'] : "#{body}".split(/\n+/)[0]
+      code = code.to_i
+
+      if [100, 101].include? code
+        log body
+      elsif 900 === code
+        raise StandardError, "SMS77_AUTH_ERROR: #{body}"
+      else
+        raise StandardError, "SMS77_DISPATCH_ERROR: #{body}"
+      end
+
+      body
+    end
+  end
+end

data/lib/huginn_sms77_agent.rb

@@ -0,0 +1,3 @@
+require 'huginn_agent'
+
+HuginnAgent.register 'huginn_sms77_agent/sms77_agent'

data/spec/sms77_agent_spec.rb

@@ -0,0 +1,109 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::Sms77Agent 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: 'Sms77AgentTest', 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 { {
+          "success" => "100",
+          "total_price" => 0,
+          "balance" => 7.228,
+          "debug" => "true",
+          "sms_type" => "direct",
+          "messages" => [{
+                             "id" => nil,
+                             "sender" => "SMS",
+                             "recipient" => "4900000000000",
+                             "text" => "test",
+                             "encoding" => "gsm",
+                             "parts" => 1,
+                             "price" => 0,
+                             "success" => true,
+                             "error" => nil,
+                             "error_text" => nil
+                         }]
+      } }
+      @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_sms(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_sms(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_sms(@default_options.stringify_keys)).to eq(100)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_sms77_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 SMS & Text2Voice messages from Huginn via https://sms77.io.
+email:
+- support@sms77.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/huginn_sms77_agent.rb
+- lib/huginn_sms77_agent/sms77_agent.rb
+- spec/sms77_agent_spec.rb
+homepage: https://github.com/sms77io/huginn
+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 SMS & Text2Voice messages from Huginn via https://sms77.io.
+test_files:
+- spec/sms77_agent_spec.rb