huginn_mailgun_agent 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c15b29390a244efd8ec88a386a01d3e67a4870eefd95ee7a0734c1a009f17d5b
+  data.tar.gz: 407f6a6154369597b1f05461d7efe8bce098754c925705560f2213e4aefc6587
+SHA512:
+  metadata.gz: 381cf58105d792338d0cb6be5fd7d72b13b69d72488299e467977a1c3f7021ccfa90d5520e631b6afadf68950f2f44755c91c2ae463715adb4001acae9387461
+  data.tar.gz: 5cc3a88af54597b41276580b57fa9b8bde758a8f3f6a78142f155413a6d366dba7b680f88927954cb401516a37554fb66787cf2b621e9b6faae0201ca0da2107

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2018 Justin Hammond
+
+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_mailgun_agent.rb

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

data/lib/huginn_mailgun_agent/mailgun_agent.rb

@@ -0,0 +1,152 @@
+require 'mailgun-ruby'
+
+module Agents
+
+  class Mysql2AgentConnection < ActiveRecord::Base
+      def self.abstract_class?
+        true # So it gets its own connection
+      end
+  end
+
+  class MailgunAgent < Agent
+
+    include FormConfigurable
+    
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule "never"
+    
+    description <<-MD
+    Sends bulk transactional emails via MailGun. Uses a Database connection to retrieve the recipients
+    
+    To send emails to users, first create a Database and table to hold your recipients. 
+    
+    `connection_url` is the database connection you want to use
+    
+    `sql` should be the Select Query to select your users. It must return a `name` and `email` field. eg: `select name, email from users`
+    
+    `mailgun_apikey` is your MailGun Private Key
+    
+    `mailgun_domain` is the domain you wish to use with Mailgun
+    
+    `mailgun_tracking` will enable both Open and Click Tracking in your emails (if enabled on your Mailgun Domain Account)
+    
+    `testing_mode` will submit the messages to Mailgun, but not actually send the emails to the recipients
+    
+    `from_address` is the address you want to the emails to come from (can be overridden in a event payload)
+    
+    If `merge_event` is true, then the Mailgun Message ID is merged with the original payload
+    
+    Payload Fields:
+    
+     * `from_address` allows you to override the default from message. Should be in this format: `name <email@address.com>`
+    
+     * `subject` is the email Subject
+    
+     * `message` is the Email Body (can be HTML if you want to enable tracking)
+    
+     * `tags` is either a single Tag or a array or Tags that you can use for Analytics on the MailGun Site
+    MD
+
+    def default_options
+      {
+        'connection_url' => 'mysql2://user:pass@localhost/database',
+        'sql' => 'select email, name from emails order by id desc',
+        'merge_event' => 'false',
+        'mailgun_apikey' => '',
+        'from_address' => 'test@example.com',
+        'testing_mode' => 'false',
+        'mailgun_domain' => '',
+        'mailgun_tracking' => 'false',
+      }
+    end
+
+
+    form_configurable :mailgun_apikey, type: :text
+    form_configurable :mailgun_domain, type: :text
+    form_configurable :from_address, type: :text
+    form_configurable :connection_url
+    form_configurable :sql, type: :text, ace: {:mode =>'sql', :theme => ''}
+    form_configurable :merge_event, type: :boolean
+    form_configurable :mailgun_tracking, type: :boolean
+    form_configurable :testing_mode, type: :boolean
+    
+    def validate_options
+
+      if options['merge_event'].present? && !%[true false].include?(options['merge_event'].to_s)
+        errors.add(:base, "Oh no!!! if provided, merge_event must be 'true' or 'false'")
+      end
+      errors.add(:base, "Mailgun API Key Missing") unless options['mailgun_apikey'].present?
+      errors.add(:base, "Missing From Address") unless options['from_address'].present?
+      errors.add(:base, "Missing Mailgun Domain") unless options['mailgun_domain'].present?
+        
+    end
+
+    def working?
+      !recent_error_logs?
+    end
+
+    def check
+      handle(interpolated)
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+          handle(interpolated(event), event.payload)
+      end
+    end
+    
+    private
+   
+    def handle(opts, event = Event.new)
+       t1 = Time.now
+       connection_url = opts["connection_url"]
+       sql = opts["sql"]
+ 
+       begin
+         conn = Mysql2AgentConnection.establish_connection(connection_url).connection
+         mg_client = Mailgun::Client.new(opts['mailgun_apikey'])
+         bm_obj = Mailgun::BatchMessage.new(mg_client, opts['mailgun_domain'])
+         bm_obj.test_mode(opts['testing_mode'])
+         bm_obj.track_opens(opts['mailgun_tracking'])
+         bm_obj.track_clicks(opts['mailgun_tracking'])
+         bm_obj.subject(event['subject'])
+         if event['msg-tag'].respond_to?('each')
+           event['msg-tag'].each do | tag |
+             bm_obj.add_tag(tag)
+           end
+         else
+           bm_obj.add_tag(event['msg-tag'])
+         end
+         if event['from_address'].present?
+           bm_obj.from(event['from_address'])
+         else
+           bm_obj.from(opts['from_address'])
+         end
+         bm_obj.body_html(event['message'])
+         results = conn.exec_query(sql)
+         results.each do |row|
+           toaddr = row['name'] + " <" + row['email']  + ">"
+           log("Sending to #{toaddr}")
+           bm_obj.add_recipient(:to, toaddr)
+         end 
+         if results.present?
+          conn.close
+         end
+         message_ids = bm_obj.finalize
+         if (opts['merge_event'] == 'true')
+          event['message_ids'] = message_ids
+          create_event payload: event  
+         else 
+          create_event payload: message_ids
+         end
+         log("Time: #{(Time.now - t1).round(2)}s, Sent: #{results.length if results.present?}, #{pp message_ids}")
+ 
+       rescue => error
+         error "Error connection: #{error.inspect} - #{error.backtrace}"
+         return
+       end
+ 
+     end
+  end
+end

data/spec/mailgun_agent_spec.rb

@@ -0,0 +1,18 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::MailgunAgent do
+  before(:each) do
+    @valid_options = Agents::MailgunAgent.new.default_options
+    @checker = Agents::MailgunAgent.new(:name => "MailgunAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  describe '#working?' do
+      it 'checks if events have error' do
+        @checker.error "oh no!"
+        expect(@checker.reload).not_to be_working # There is a recent error
+      end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: huginn_mailgun_agent
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Justin Hammond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-02 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'
+- !ruby/object:Gem::Dependency
+  name: mailgun-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+description: 
+email:
+- justin@devthendo.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_mailgun_agent.rb
+- lib/huginn_mailgun_agent/mailgun_agent.rb
+- spec/mailgun_agent_spec.rb
+homepage: https://github.com/DevThenDo/huginn_mailgun_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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Sends bulk transactional emails via MailGun. Uses a Database connection to
+  retrieve the recipients
+test_files:
+- spec/mailgun_agent_spec.rb