jackal-mail 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de5e9fbcfb826c25866a65a8dc38f8c0c2244279
-  data.tar.gz: 1ec43af44d16a3945b3cf50de7147b47d658c48e
+  metadata.gz: 8cf747d39ed920ee0b8acaa0a10d3851348a42c5
+  data.tar.gz: 35237c8e587f3b8ad9408803235873cf0162a5fe
 SHA512:
-  metadata.gz: e0c87d2739ff43205f60736a7e43f0613b8845d69d5749a34407b50eac7f7573379870daf99e2aed1a3bb547271673c0fc165f9adc2eee68b222be2e35bd8253
-  data.tar.gz: ba0d5461e9409cfc1f01c4bbe97ac663f223d40dc25e58cc15d05eed17a9a3bf3e3d621b4a704a418a938a443ce0b635c8e8f115f2ae802795437af230a1886d
+  metadata.gz: 769a2f4afee3d9c282e3907944da5b7f6ea6fd0f4ccfca8b22d1936475afbad794bfea02aed8ce99dddbcfccfd1769d1084293de23895ccfeb571c73378697a3
+  data.tar.gz: 24db5f06a2750bc065863e6a351809ea397ddfc4179d9ecc603ac43168c78c21aa06c6f4815406bc562fadccb4246204e1e4ec24b772fcd58d8f2f2bd3d50de9

data/CHANGELOG.md

@@ -1,2 +1,7 @@
-## v0.1.0
+# v0.1.2
+* Remove mail data on complete
+* Add basic testing coverage
+* Add service registration
+
+# v0.1.0
 * Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'minitest'
+gem 'pry'
+
+gemspec

data/README.md

@@ -1,3 +1,40 @@
 # Jackal Mail
 
-Mailer handler
+Simple handler for sending email
+
+## Configuration
+Optional configuration
+
+```json
+{
+  "jackal": {
+    "config": {
+      "mail": {
+        "bcc": "",
+        "via_options": {
+          ...
+        }
+      }
+    }
+  }
+}
+```
+See https://github.com/benprew/pony#transport for "via_options"
+
+## Payload structure
+
+```ruby
+{
+  :destination => {
+    :email => '',
+    :name => ''
+  },
+  :origin => {
+    :email => '',
+    :name => ''
+  },
+  :subject => '',
+  :message => '',
+  :html => true/false
+}
+```

data/jackal-mail.gemspec

@@ -12,5 +12,7 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.add_dependency 'jackal'
   s.add_dependency 'pony'
+  s.add_development_dependency 'carnivore-actor'
+
   s.files = Dir['**/*']
 end

data/lib/jackal-mail.rb

@@ -6,3 +6,19 @@ module Jackal
     autoload :Smtp, 'jackal-mail/smtp'
   end
 end
+
+Jackal.service(
+  :mail,
+  :description => 'Send mail notification',
+  :category => :notifier,
+  :configuration => {
+    :via_options => {
+      :type => :hash,
+      :description => 'SMTP configuration options'
+    },
+    :bcc => {
+      :type => :string,
+      :description => 'BCC address for all mail'
+    }
+  }
+)

data/lib/jackal-mail/smtp.rb

@@ -1,22 +1,5 @@
 require 'jackal-mail'
 
-=begin
-      # In payload: notification_email
-      {
-        :destination => {
-          :email => '',
-          :name => ''
-        },
-        :origin => {
-          :email => '',
-          :name => ''
-        },
-        :subject => '',
-        :message => '',
-        :html => true/false
-      }
-=end
-
 module Jackal
   # Mailer component
   module Mail
@@ -44,6 +27,7 @@ module Jackal
       def execute(message)
         failure_wrap(message) do |payload|
           deliver(payload)
+          payload[:data][:mail].delete(:result)
           job_completed(:mail, payload, message)
         end
       end
@@ -78,7 +62,7 @@ module Jackal
           if(bcc = config.get(:bcc))
             args[:bcc] = bcc
           end
-          result = Pony.mail(args)
+          result = send_mail(payload, args)
           payload.set(:data, :mail, :result, result)
           debug "Pony delivery result: #{result.inspect}"
         rescue => e
@@ -87,6 +71,11 @@ module Jackal
         end
       end
 
+      # So we can stub out mail sending for tests...
+      def send_mail(payload, args)
+        Pony.mail(args)
+      end
+
     end
   end
 end

data/lib/jackal-mail/version.rb

@@ -1,6 +1,6 @@
 module Jackal
   module Mail
     # Current library version
-    VERSION = Gem::Version.new('0.1.0')
+    VERSION = Gem::Version.new('0.1.2')
   end
 end

data/test/specs/config/test.rb

@@ -0,0 +1,19 @@
+Configuration.new do
+
+  jackal do
+    require ["carnivore-actor", "jackal-mail"]
+
+    mail do
+      config do
+      end
+
+      sources do
+        input  { type 'actor' }
+        output { type 'spec' }
+      end
+
+      callbacks ['Jackal::Mail::Smtp']
+    end
+  end
+
+end

data/test/specs/smtp_spec.rb

@@ -0,0 +1,54 @@
+require 'jackal-mail'
+require 'pry'
+
+SRC_ADDR = 'foo@example.com'
+DST_ADDR = 'bar@example.com'
+SUBJECT  = 'test'
+BODY     = 'foo'
+
+class Jackal::Mail::Smtp
+  def send_mail(payload, args)
+    payload.set(:smtp_args, args)
+    h = { :from => args[:from], :to => args[:to], :subject => args[:subject] }
+    Mail::Message.new(h)
+  end
+end
+
+describe Jackal::Mail::Smtp do
+
+  before do
+    @runner = run_setup(:test)
+    track_execution(Jackal::Mail::Smtp)
+  end
+
+  after do
+    @runner.terminate if @runner && @runner.alive?
+  end
+
+  let(:notification) { Carnivore::Supervisor.supervisor[:jackal_mail_input] }
+
+  describe 'execute' do
+    it 'passes correct data/format to slack-notifier' do
+      result = transmit_and_wait(notification, mail_payload)
+      callback_executed?(result).must_equal true
+      # ensure payload result was cleared to allow for multiple runs
+      result.get(:data, :mail, :result).must_be_nil
+
+      arr = [[:to, [DST_ADDR]], [:from, SRC_ADDR], [:subject, SUBJECT], [:body, BODY]]
+      arr.each { |key, value| result[:smtp_args][key].must_equal value }
+    end
+  end
+
+  private
+
+  def mail_payload
+    h = { :notification_email => {
+            :destination => { :email => DST_ADDR },
+            :origin => { :email => SRC_ADDR },
+            :subject => SUBJECT,
+            :message => BODY,
+            :html => false }}
+    Jackal::Utils.new_payload(:test, h)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackal-mail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jackal
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: carnivore-actor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Jackal Mail
 email: code@chrisroberts.org
 executables: []
@@ -45,11 +59,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- Gemfile
 - README.md
 - jackal-mail.gemspec
 - lib/jackal-mail.rb
 - lib/jackal-mail/smtp.rb
 - lib/jackal-mail/version.rb
+- test/specs/config/test.rb
+- test/specs/smtp_spec.rb
 homepage: http://github.com/carnivore-rb/jackal-mail
 licenses:
 - Apache 2.0
@@ -75,4 +92,3 @@ signing_key:
 specification_version: 4
 summary: Jackal Mail
 test_files: []
-has_rdoc: