RubyGems - anadea-mailsocio-qa - Versions diffs - 0.1.0 - Mend

anadea-mailsocio-qa 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml +7 -0
data/.gitignore +8 -0
data/Gemfile +2 -0
data/Gemfile.lock +43 -0
data/Rakefile +2 -0
data/bin/mailsocio-qa +10 -0
data/lib/mailsocio_qa/mailsocio_test.rb +269 -0
data/lib/mailsocio_qa/settings.rb +5 -0
data/lib/mailsocio_qa/test_client.rb +91 -0
data/lib/mailsocio_qa/test_html_page.rb +21 -0
data/lib/mailsocio_qa.rb +13 -0
data/lib/minitest/mailsocio_qa_plugin.rb +28 -0
data/mailsocio-qa.gemspec +20 -0
data/settings.yml +27 -0
metadata +161 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 358f0bf77ff8f08d406dd4b7d46e7141c09b94c2
+  data.tar.gz: f482a30a4827d7f173eb02dc6b131184feb77738
+SHA512:
+  metadata.gz: c63adb9ba1a8bca9fe7bd5740c0ac145311c882fdeb03ebcbb190aa21bbfd14a1c70395158fa696cbdded59588c30288ac38198b50a9c8e954bee6a07e97d855
+  data.tar.gz: 044fd1dfeecddc8959b12192ca3cbd4900608e6d6b19bc4b54b05e4e2dcd6a17411155809064e0b6973c07e9def4d900e88a7e8aa55a09c66470fae934d6e77b

data/.gitignore ADDED Viewed

@@ -0,0 +1,8 @@
+/.bundle
+/log
+/tmp
+*.swp
+.rbenv-version
+.vagrant/*
+provision/cache/*
+pkg/*

data/Gemfile ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ source 'https://rubygems.org'
2	+ gemspec

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    anadea-mailsocio-qa (0.0.3)
+      activesupport (>= 3.0, < 5.0)
+      httpi (>= 2.0)
+      json (>= 1.0)
+      mail (>= 2.0)
+      minitest (>= 4.0)
+      nokogiri (>= 1.0)
+      settingslogic (>= 2.0)
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    httpi (2.4.0)
+      rack
+    i18n (0.7.0)
+    json (1.8.2)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.5)
+    mini_portile (0.6.2)
+    minitest (5.6.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.1)
+    settingslogic (2.0.9)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  anadea-mailsocio-qa!

data/Rakefile ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require 'bundler'
2	+ Bundler::GemHelper.install_tasks

data/bin/mailsocio-qa ADDED Viewed

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default)
+require 'mailsocio_qa'
+HTTPI.log = false
+require 'minitest/autorun'

data/lib/mailsocio_qa/mailsocio_test.rb ADDED Viewed

@@ -0,0 +1,269 @@
+# encoding: UTF-8
+require 'mailsocio_qa/settings'
+require 'mailsocio_qa/test_client'
+require 'mailsocio_qa/test_html_page'
+module MailsocioQA
+  class MailsocioTest < ::Minitest::Test
+    def setup
+      @base_domain = Regexp.escape(Settings.mailsocio.base_domain)
+      @track_domain = "track.#{Settings.mailsocio.base_domain}"
+      @client = TestClient.new
+      addresses = Settings.trap.addresses
+      @john = addresses.john
+      @jane = addresses.jane
+      @invalid = addresses.invalid
+    end
+    def test_create_account
+      @client.create_account
+      refute_nil @client.account_id
+    end
+    def test_send_mail
+      @client.create_account
+      @client.clean_messages
+      @client.deliver(
+        'X-To' => "{\"#{@john}\":{\"name\":\"John Doe\"}}",
+        'Subject' => 'Hello',
+        'Body' => 'Hello, __NAME__'
+      )
+      message = @client.read_message
+      assert_equal 'Hello', message.subject
+      assert_equal 'Hello, John Doe', message.body.raw_source.strip
+    end
+    def test_nonascii_mail_css_and_tracking
+      @client.create_account
+      @client.clean_messages
+      @client.deliver(
+        'X-To' => "[\"#{@john}\"]",
+        'X-Inline-Css' => 1,
+        'X-Track' => 1,
+        'Content-Type' => 'text/html; charset=ISO-8859-1',
+        'Content-Transfer-Encoding' => 'quoted-printable',
+        'Subject' => 'Hello',
+        'Body' => <<NONASCIIHTML
+<html>
+  <head>
+    <style type=3D"text/css">
+      body, .wrapper {
+        height: 20px;
+      }
+    </style>
+  </head>
+  <body>
+    <p>English Caf=E9</p>
+  </body>
+</html>
+NONASCIIHTML
+      )
+      message = @client.read_message
+      assert_equal 'Hello', message.subject
+      assert_match /\s*<body style=3D"height:20px">\r\n/, message.body.raw_source.strip, 'No inlined css styles'
+      assert_match /\s*<p>English Caf=E9<\/p>\r\n/, message.body.raw_source.strip, 'Not original quoted-printable'
+      assert_match /<img src=3D".*\/assets\/dot\.png\?token=3D/, message.body.raw_source.strip, 'No tracking image injected'
+    end
+    def test_send_newsletter
+      @client.create_account
+      @client.clean_messages('john')
+      @client.clean_messages('jane')
+      @client.deliver(
+        'X-Newsletter-Id' => '15',
+        'X-To' => "[\"#{@john}\", \"#{@jane}\"]"
+      )
+      @client.read_message
+      stat = @client.newsletter_statistics('15')
+      assert_equal 2, stat['queued']
+    end
+    def test_newsletter_tracking
+      @client.create_account
+      @client.clean_messages('john')
+      @client.clean_messages('jane')
+      @client.deliver(
+        'X-Newsletter-Id' => '15',
+        'X-To' => "[\"#{@john}\",\"#{@jane}\"]",
+        'X-Track' => 'yes',
+        'Content-Type' => 'text/html',
+        'Body' => '<a href="http://google.com/search">Search</a>'
+      )
+      message = @client.read_message('john')
+      page = TestHtmlPage.new(message.body.raw_source)
+      stat = @client.newsletter_statistics('15')
+      assert_equal 2, stat['queued']
+      assert_equal 2, stat['sent']
+      assert_equal 0, stat['viewed']
+      assert_equal 0, stat['clicked']
+      page.load
+      stat = @client.newsletter_statistics('15')
+      assert_equal 2, stat['queued']
+      assert_equal 2, stat['sent']
+      assert_equal 1, stat['viewed']
+      assert_equal 0, stat['clicked']
+      assert_equal 'http://google.com/search', page.click
+      stat = @client.newsletter_statistics('15')
+      assert_equal 2, stat['queued']
+      assert_equal 2, stat['sent']
+      assert_equal 1, stat['viewed']
+      assert_equal 1, stat['clicked']
+      message = @client.read_message('jane')
+      page = TestHtmlPage.new(message.body.raw_source)
+      page.load
+      stat = @client.newsletter_statistics('15')
+      assert_equal 2, stat['queued']
+      assert_equal 2, stat['sent']
+      assert_equal 2, stat['viewed']
+      assert_equal 1, stat['clicked']
+      assert_equal 'http://google.com/search', page.click
+      stat = @client.newsletter_statistics('15')
+      assert_equal 2, stat['queued']
+      assert_equal 2, stat['sent']
+      assert_equal 2, stat['viewed']
+      assert_equal 2, stat['clicked']
+    end
+    def test_hard_bounce
+      @client.create_account
+      @client.deliver(
+        'X-Newsletter-Id' => '15',
+        'X-To' => "[\"#{@invalid}\"]"
+      )
+      sleep 90
+      stat = @client.newsletter_statistics('15')
+      assert_equal 1, stat['queued']
+      assert_equal 1, stat['hard_bounced']
+    end
+    def test_newsletter_tracking_subsequent_failures
+      skip("still not in production")
+      @client.create_account
+      @client.deliver(
+        'X-Newsletter-Id' => '15',
+        'X-To' => "[\"#{@invalid}\"]",
+      )
+      sleep 90
+      stat = @client.newsletter_statistics('15')
+      assert_equal 0, stat['new']
+      assert_equal 1, stat['queued']
+      assert_equal 1, stat['hard_bounced']
+      assert_equal 0, stat['skipped']
+      assert_equal 1, stat['sent']
+      assert_equal 0, stat['delivered']
+      @client.deliver(
+        'X-Newsletter-Id' => '16',
+        'X-To' => "[\"#{@invalid}\"]",
+      )
+      sleep 30
+      stat = @client.newsletter_statistics('16')
+      assert_equal 0, stat['new']
+      assert_equal 1, stat['queued']
+      assert_equal 1, stat['hard_bounced']
+      assert_equal 1, stat['skipped']
+      assert_equal 1, stat['sent']
+      assert_equal 0, stat['delivered']
+    end
+    def test_authentication_results
+      @client.create_account
+      @client.clean_messages
+      @client.deliver('X-To' => "[\"#{@john}\"]")
+      message = @client.read_message
+      auth_results = message['Authentication-Results'].value
+      assert_match /spf=pass/, auth_results
+      assert_match /dkim=pass/, auth_results
+      assert_match "@#{@track_domain}", message.return_path
+      assert_match "d=#{@track_domain}", message['DKIM-Signature'].try(:value)
+    end
+    def test_custom_tracking_domain
+      domain = Settings.trap.custom_tracking_domain
+      attrs = @client.create_account(custom_tracking_domain: domain)
+      @client.custom_tracking_domain = domain
+      assert_wont_raise('Could not read account via custom tracking domain URL') do
+        @client.read_account
+      end
+      assert attrs['custom_tracking_enabled'], 'Custom tracking is disabled'
+      assert attrs['custom_signing_enabled'], 'Custom signing is disabled'
+      @client.clean_messages
+      @client.deliver('X-To' => "[\"#{@john}\"]")
+      message = @client.read_message
+      auth_results = message['Authentication-Results'].value
+      assert_match /spf=pass/, auth_results
+      assert_match /dkim=pass/, auth_results
+      assert_match "@#{domain}", message.return_path
+      assert_match "d=#{domain}", message['DKIM-Signature'].try(:value)
+    end
+    def test_custom_tracking_hard_bounce
+      domain = Settings.trap.custom_tracking_domain
+      @client.create_account(custom_tracking_domain: domain)
+      @client.clean_messages
+      @client.deliver(
+        'X-Newsletter-Id' => '15',
+        'X-To' => "[\"#{@invalid}\"]"
+      )
+      sleep 90
+      stat = @client.newsletter_statistics('15')
+      assert_equal 1, stat['queued']
+      assert_equal 1, stat['hard_bounced']
+    end
+    def test_transactional_routing
+      @client.create_account
+      @client.clean_messages
+      @client.deliver('X-To' => "[\"#{@john}\"]")
+      received = @client.read_message.received
+      assert_match /from (smtp0\.#{@base_domain}) \(\1\. /, received[-3].value
+      assert_match 'from localhost.localdomain (localhost ', received[-2].value
+      assert_match 'from localhost.localdomain (localhost ', received[-1].value
+    end
+    def test_bulk_routing
+      @client.create_account
+      @client.clean_messages
+      @client.deliver(
+        'Precedence' => 'bulk',
+        'X-To' => "[\"#{@john}\"]"
+      )
+      received = @client.read_message.received
+      assert_match /^from (smtp[1-9]\d*\.#{@base_domain}) \(\1\. /, received[-3].value
+      assert_match 'from localhost.localdomain (localhost ', received[-2].value
+      assert_match 'from localhost.localdomain (localhost ', received[-1].value
+    end
+  end
+end

data/lib/mailsocio_qa/settings.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'settingslogic'
+module MailsocioQA
+  class Settings < Settingslogic
+  end
+end

data/lib/mailsocio_qa/test_client.rb ADDED Viewed

@@ -0,0 +1,91 @@
+require 'mailsocio_qa/settings'
+module MailsocioQA
+  class TestClient
+    attr_accessor :account_id, :custom_tracking_domain
+    def create_account(attrs = {})
+      attrs.reverse_merge!(api_key: Settings.mailsocio.api_key)
+      response = HTTPI.post(accounts_url, { account: attrs}.to_query)
+      raise "Could not create account:\n#{response.body}" if response.error?
+      JSON.parse(response.body).tap do |json|
+        self.account_id = json['id']
+      end
+    end
+    def read_account
+      response = HTTPI.get(accounts_url(self.account_id))
+      raise "Could not read account:\n#{response.body}" if response.error?
+      JSON.parse(response.body)
+    end
+    def newsletter_statistics(newsletter_id)
+      response = HTTPI.get(newsletter_statistics_url(newsletter_id))
+      raise "Could not get newsletter statistics:\n#{response.body}" if response.error?
+      JSON.parse(response.body)
+    end
+    def deliver(fields = {}, &block)
+      config = Settings.mailsocio.mail
+      fields.reverse_merge!(
+        'X-Account-Id' => account_id,
+        'X-Api-Key' => Settings.mailsocio.api_key
+      )
+      fields.reverse_merge!(config.message)
+      Mail::Message.new(fields, &block).tap do |mail|
+        mail.subject ||= 'Good news, everyone!'
+        delivery = config.delivery
+        mail.delivery_method(delivery.method.to_sym, delivery.settings.symbolize_keys)
+        mail.deliver
+      end
+    end
+    def read_message(user = 'john')
+      10.times do
+        message = retriever(user).first(:delete_after_find => true)
+        return message if message.present?
+        sleep 10
+      end
+      raise 'Could not read message'
+    end
+    def clean_messages(user = 'john')
+      retriever(user).delete_all
+    end
+    def retriever(user)
+      address = Settings.trap.addresses[user]
+      server = Settings.trap.server
+      settings = server.settings.symbolize_keys
+      settings.merge!(user_name: address)
+      Mail::Configuration.instance.retriever_method(server.method.to_sym, settings)
+    end
+    def accounts_url(account_id = nil)
+      if account_id.blank?
+        app_url('/api/accounts')
+      else
+        app_url("/api/accounts/#{account_id}")
+      end
+    end
+    def newsletter_statistics_url(newsletter_id)
+      app_url("/api/accounts/#{account_id}/newsletters/#{newsletter_id}/statistics")
+    end
+    def app_url(path)
+      if custom_tracking_domain.blank?
+        "http://app.#{Settings.mailsocio.base_domain}#{path}"
+      else
+        "http://#{self.custom_tracking_domain}#{path}"
+      end
+    end
+  end
+end

data/lib/mailsocio_qa/test_html_page.rb ADDED Viewed

@@ -0,0 +1,21 @@
+module MailsocioQA
+  class TestHtmlPage
+    def initialize(html)
+      @doc = Nokogiri::HTML(html)
+    end
+    def load
+      @doc.css('img').each do |img|
+        open(img['src'])
+      end
+    end
+    def click
+      @doc.css('a').each do |a|
+        response = HTTPI.get(a['href'])
+        raise "Expected redirect but got #{response.code}" unless response.code == 302
+        return response.headers['location']
+      end
+    end
+  end
+end

data/lib/mailsocio_qa.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'active_support/all'
+require 'json'
+require 'nokogiri'
+require 'mail'
+require 'httpi'
+require 'mailsocio_qa/settings'
+require 'mailsocio_qa/test_client'
+require 'mailsocio_qa/test_html_page'
+require 'minitest'
+require 'mailsocio_qa/mailsocio_test'

data/lib/minitest/mailsocio_qa_plugin.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require 'mailsocio_qa/settings'
+module Minitest
+  def self.plugin_mailsocio_qa_options(opts, options)
+    opts.on "-c", "--config PATH", String, "Mailsocio QA config file." do |source|
+      MailsocioQA::Settings.source source
+    end
+  end
+  def self.plugin_mailsocio_qa_init(options)
+    MailsocioQA::Settings.source File.expand_path('../../../settings.yml', __FILE__)
+    MailsocioQA::Settings.load!
+  end
+  class Test
+    def self.runnable_methods
+      methods_matching(/^test_/)
+    end
+  end
+  module Assertions
+    def assert_wont_raise error_message
+      yield
+    rescue
+      assert false, error_message
+    end
+  end
+end

data/mailsocio-qa.gemspec ADDED Viewed

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name          = 'anadea-mailsocio-qa'
+  s.version       = '0.1.0'
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = "Mailsocio Quality Assurance"
+  s.description   = s.summary
+  s.authors       = 'Anadea'
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = 'mailsocio-qa'
+  s.require_paths = ['lib']
+  s.add_dependency 'minitest', ['>= 4.0']
+  s.add_dependency 'httpi', ['>= 2.0']
+  s.add_dependency 'mail', ['>= 2.0']
+  s.add_dependency 'json', ['>= 1.0']
+  s.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
+  s.add_dependency 'settingslogic', ['>= 2.0']
+  s.add_dependency 'nokogiri', ['>= 1.0']
+end

data/settings.yml ADDED Viewed

@@ -0,0 +1,27 @@
+mailsocio:
+  base_domain: sendbrain.dev
+  api_key: "91d10da569d04883f0345e21c7b16e6caa7cea3eb84f3538a799cf96f3acb9c4"
+  mail:
+    delivery:
+      method: smtp
+      settings:
+        address: app.sendbrain.dev
+        port: 25
+    message:
+      from: tester@mailsocio.com
+      to: submit@app.sendbrain.dev
+trap:
+  server:
+    method: pop3
+    settings:
+      password: epyfnm123
+      address: pop.gmail.com
+      port: 995
+      enable_ssl: true
+  addresses:
+    john: john.doe@raven.org.ua
+    jane: jane.doe@raven.org.ua
+    invalid: invalid@raven.org.ua
+  custom_tracking_domain: emailz.raven.org.ua

metadata ADDED Viewed

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: anadea-mailsocio-qa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anadea
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: settingslogic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Mailsocio Quality Assurance
+email:
+executables:
+- mailsocio-qa
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/mailsocio-qa
+- lib/mailsocio_qa.rb
+- lib/mailsocio_qa/mailsocio_test.rb
+- lib/mailsocio_qa/settings.rb
+- lib/mailsocio_qa/test_client.rb
+- lib/mailsocio_qa/test_html_page.rb
+- lib/minitest/mailsocio_qa_plugin.rb
+- mailsocio-qa.gemspec
+- settings.yml
+homepage:
+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: []
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: Mailsocio Quality Assurance
+test_files: []
+has_rdoc: