postmark_bounce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 001900621faaacb3fd482b4c117a8270f759b8a2
+  data.tar.gz: 357a0e48a8c49b9d074b0abcf57f4ec6db52b0f0
+SHA512:
+  metadata.gz: 78583ac0712838dd6e30f9566c8ead593bf7b7bcfb1b0c60b580230b5591c8c8316113691e9522d76e6aa877528a8765c9a7fb1da3e858aa1fcd8632fd037924
+  data.tar.gz: fec26a62dae3ff2d7efca3ce3914e4f4a7cc4e2a1fcee94e5e2f448326274e31656e5e27d52a6b789a86a5bbe89dd270ce050cd0065c73586ed323cd6553d8e9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Dean Perry
+
+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/README.md

@@ -0,0 +1,39 @@
+# PostmarkBounce
+
+`postmark_bounce` is a gem to accept and log Postmark bounces in your Rails application
+
+## Installation
+
+Add the gem to your Gemfile and bundle install.
+
+Mount the engine in your app:
+
+```ruby
+mount PostmarkBounce::Engine, at: "/postmark_bounce"
+```
+
+## Showing in your views
+
+I'm currently using this in my views:
+
+```haml
+- if PostmarkBounce::Email.shown.first
+  - bounce = PostmarkBounce::Email.shown.first
+  .alert.alert-warning.alert-bounce
+    .container
+      %p.pull-right= link_to "Dismiss", "/postmark_bounce/#{bounce.message_id}/hide", method: :put
+      %b An email to <mark>#{bounce.email}</mark> with the subject of <mark>#{bounce.subject}</mark> bounced at <mark>#{bounce.bounced_at.to_s(:short)}</mark> due to an error
+      %p= bounce.description
+```
+
+## To test
+
+```bash
+curl http://localhost:3000/postmark_bounce \
+  -X POST \
+  -H "Content-Type: application/json" \
+  -d '{ "ID": 42, "Type": "HardBounce", "TypeCode": 1, "Name": "Hard bounce", "Tag": "Test", "MessageID": "883953f4-6105-42a2-a16a-77a8eac79483", "Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).", "Details": "Test bounce details", "Email": "john@example.com", "BouncedAt": "2014-08-01T13:28:10.2735393-04:00", "DumpAvailable": true, "Inactive": true, "CanActivate": true, "Subject": "Test subject" }'
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PostmarkBounce'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/postmark_bounce_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/postmark_bounce .js
+//= link_directory ../stylesheets/postmark_bounce .css

data/app/assets/javascripts/postmark_bounce/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/postmark_bounce/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/postmark_bounce/application_controller.rb

@@ -0,0 +1,5 @@
+module PostmarkBounce
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/postmark_bounce/emails_controller.rb

@@ -0,0 +1,11 @@
+module PostmarkBounce
+  class EmailsController < ActionController::Base
+
+    def hide
+      @email = PostmarkBounce::Email.find_by(message_id: params[:message_id])    
+      @email.update_attributes(hidden: true)
+      redirect_to :back
+    end
+
+  end
+end

data/app/controllers/postmark_bounce/webhook_controller.rb

@@ -0,0 +1,26 @@
+module PostmarkBounce
+  class WebhookController < ActionController::Base
+
+    protect_from_forgery except: :event
+    
+    def event
+      eb = PostmarkBounce::Email.create(
+        bounce_id: params["ID"],
+        kind: params["Type"],
+        name: params["Name"],
+        message_id: params["MessageID"],
+        description: params["Description"],
+        details: params["Details"],
+        email: params["Email"],
+        bounced_at: params["BouncedAt"],
+        subject: params["Subject"]
+      )
+      if eb
+        render body: "success", status: 200
+      else
+        render body: "error no email", status: 404
+      end
+    end
+
+  end
+end

data/app/helpers/postmark_bounce/application_helper.rb

@@ -0,0 +1,4 @@
+module PostmarkBounce
+  module ApplicationHelper
+  end
+end

data/app/jobs/postmark_bounce/application_job.rb

@@ -0,0 +1,4 @@
+module PostmarkBounce
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/postmark_bounce/application_mailer.rb

@@ -0,0 +1,6 @@
+module PostmarkBounce
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/postmark_bounce/application_record.rb

@@ -0,0 +1,5 @@
+module PostmarkBounce
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/postmark_bounce/email.rb

@@ -0,0 +1,7 @@
+module PostmarkBounce
+  class Email < ApplicationRecord
+
+    scope :shown, -> { where(hidden: false) }
+
+  end
+end

data/app/views/layouts/postmark_bounce/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Postmark bounce</title>
+  <%= stylesheet_link_tag    "postmark_bounce/application", media: "all" %>
+  <%= javascript_include_tag "postmark_bounce/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,7 @@
+PostmarkBounce::Engine.routes.draw do
+
+  root to: "webhook#event", via: :post
+
+  put "/:message_id/hide", to: "emails#hide"
+
+end

data/db/migrate/20160902173042_create_postmark_bounce_emails.rb

@@ -0,0 +1,18 @@
+class CreatePostmarkBounceEmails < ActiveRecord::Migration[5.0]
+  def change
+    create_table :postmark_bounce_emails do |t|
+      t.boolean :hidden, default: false
+      t.integer :bounce_id
+      t.string :kind
+      t.string :name
+      t.string :message_id
+      t.text :description
+      t.string :details
+      t.string :email
+      t.datetime :bounced_at
+      t.string :subject
+
+      t.timestamps
+    end
+  end
+end

data/lib/postmark_bounce.rb

@@ -0,0 +1,5 @@
+require "postmark_bounce/engine"
+
+module PostmarkBounce
+  # Your code goes here...
+end

data/lib/postmark_bounce/engine.rb

@@ -0,0 +1,14 @@
+module PostmarkBounce
+  class Engine < ::Rails::Engine
+    isolate_namespace PostmarkBounce
+
+    initializer "postmark_bounce.append_migrations" do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+  end
+end

data/lib/postmark_bounce/version.rb

@@ -0,0 +1,3 @@
+module PostmarkBounce
+  VERSION = '0.1.0'
+end

data/lib/tasks/postmark_bounce_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :postmark_bounce do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: postmark_bounce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Rubygem to easily add Postmark Bounce notifications to your Rails app
+email:
+- dean@voupe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/postmark_bounce_manifest.js
+- app/assets/javascripts/postmark_bounce/application.js
+- app/assets/stylesheets/postmark_bounce/application.css
+- app/controllers/postmark_bounce/application_controller.rb
+- app/controllers/postmark_bounce/emails_controller.rb
+- app/controllers/postmark_bounce/webhook_controller.rb
+- app/helpers/postmark_bounce/application_helper.rb
+- app/jobs/postmark_bounce/application_job.rb
+- app/mailers/postmark_bounce/application_mailer.rb
+- app/models/postmark_bounce/application_record.rb
+- app/models/postmark_bounce/email.rb
+- app/views/layouts/postmark_bounce/application.html.erb
+- config/routes.rb
+- db/migrate/20160902173042_create_postmark_bounce_emails.rb
+- lib/postmark_bounce.rb
+- lib/postmark_bounce/engine.rb
+- lib/postmark_bounce/version.rb
+- lib/tasks/postmark_bounce_tasks.rake
+homepage: https://voupe.com
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Add Postmark Bounce notifications in your Rails app
+test_files: []