aws_sns_subscription 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aws_sns_subscription_confirmer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sean Devine
+
+MIT License
+
+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,17 @@
+# AWS SNS Subscription Confirmation for Ruby on Rails
+
+If you use AWS SNS for notifications (such as email bounces or complaints), you'll need to confirm the subscription request.
+
+This makes that easier for Ruby on Rails apps.
+
+## Instructions
+
+### Step 1: Add the gem to your gemfile
+
+`gem "aws_sns_subscription"`
+
+### Step 2: Add a before filter to the controllers that you're using as endpoints
+
+    class ExampleEmailBouncesController < ApplicationController
+      before_filter :respond_to_aws_sns_subscription_confirmations, only: [:create]
+    end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/aws_sns_subscription.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aws_sns_subscription/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "aws_sns_subscription"
+  gem.version       = AWSSNSSubscription::VERSION
+  gem.authors       = ["Sean Devine"]
+  gem.email         = ["sean@buytruckload.com"]
+  gem.description   = %q{Easy confirmation of Amazon SNS subscription requests in Rails apps}
+  gem.summary       = %q{Auto responds to AWS SNS subscription confirmations}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency "rspec"
+  gem.add_dependency "require_all"
+  gem.add_dependency "activesupport"
+  gem.add_dependency "httparty"
+end

data/lib/aws_sns_subscription/confirmer.rb

@@ -0,0 +1,12 @@
+module AWSSNSSubscription
+  module Confirmer
+    extend ActiveSupport::Concern
+
+    def respond_to_aws_sns_subscription_confirmations
+      if request.headers["x-amz-sns-message-type"] == "SubscriptionConfirmation"
+        HTTParty.get JSON.parse(request.raw_post)["SubscribeURL"]
+        head :ok and return
+      end
+    end
+  end
+end

data/lib/aws_sns_subscription/railtie.rb

@@ -0,0 +1,10 @@
+module AWSSNSSubscription
+  class Railtie < Rails::Railtie
+    initializer "aws_sns_subscription.action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        puts "Extending #{self} with AWSSNSSubscription::Confirmer"
+        include AWSSNSSubscription::Confirmer
+      end
+    end
+  end
+end

data/lib/aws_sns_subscription/version.rb

@@ -0,0 +1,3 @@
+module AWSSNSSubscription
+  VERSION = "1.0.0"
+end

data/lib/aws_sns_subscription.rb

@@ -0,0 +1,8 @@
+require 'httparty'
+require 'active_support/all'
+require 'require_all'
+require_rel 'aws_sns_subscription'
+
+module AwsSnsSubscription
+
+end

data/spec/confirmer_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'active_support/all'
+require 'httparty'
+require  File.expand_path('../../lib/aws_sns_subscription/confirmer.rb', __FILE__)
+
+module AWSSNSSubscription
+  class Controller
+    include AWSSNSSubscription::Confirmer
+    def head(status)
+    end
+  end
+  describe Confirmer do
+    subject { Controller.new }
+    describe "receiving the subcription confirmation request" do
+      let(:raw_post) do
+        File.read(File.expand_path("../fixtures/raw_post.txt", __FILE__))
+      end
+      before(:each) do
+        subject.stub(:request).and_return(mock("request", headers: { "x-amz-sns-message-type" => "SubscriptionConfirmation" }, raw_post: raw_post))
+      end
+      it "should send a get request to the appropriate url" do
+        HTTParty.should_receive(:get).with("https://sns.us-east-1.amazonaws.com/?Action=ConfirmSubscription&TopicArn=arn:aws:sns:us-east-1:123456789012:MyTopic&Token=2336412f37fb687f5d51e6e241d09c805a5a57b30d712f794cc5f6a988666d92768dd60a747ba6f3beb71854e285d6ad02428b09ceece29417f1f02d609c582afbacc99c583a916b9981dd2728f4ae6fdb82efd087cc3b7849e05798d2d2785c03b0879594eeac82c01f235d0e717736")
+        subject.respond_to_aws_sns_subscription_confirmations
+      end
+    end
+    describe "not receiving a subscription confirmation request" do
+      before(:each) do
+        subject.stub(:request).and_return(mock("request", headers: { "x-amz-sns-message-type" => nil }))
+      end
+      it "should not send a get request" do
+        HTTParty.should_receive(:get).exactly(0).times
+      end
+    end
+  end
+end

data/spec/fixtures/raw_post.txt

@@ -0,0 +1,12 @@
+{
+  "Type" : "SubscriptionConfirmation",
+  "MessageId" : "165545c9-2a5c-472c-8df2-7ff2be2b3b1b",
+  "Token" : "2336412f37fb687f5d51e6e241d09c805a5a57b30d712f794cc5f6a988666d92768dd60a747ba6f3beb71854e285d6ad02428b09ceece29417f1f02d609c582afbacc99c583a916b9981dd2728f4ae6fdb82efd087cc3b7849e05798d2d2785c03b0879594eeac82c01f235d0e717736",
+  "TopicArn" : "arn:aws:sns:us-east-1:123456789012:MyTopic",
+  "Message" : "You have chosen to subscribe to the topic arn:aws:sns:us-east-1:123456789012:MyTopic.\nTo confirm the subscription, visit the SubscribeURL included in this message.",
+  "SubscribeURL" : "https://sns.us-east-1.amazonaws.com/?Action=ConfirmSubscription&TopicArn=arn:aws:sns:us-east-1:123456789012:MyTopic&Token=2336412f37fb687f5d51e6e241d09c805a5a57b30d712f794cc5f6a988666d92768dd60a747ba6f3beb71854e285d6ad02428b09ceece29417f1f02d609c582afbacc99c583a916b9981dd2728f4ae6fdb82efd087cc3b7849e05798d2d2785c03b0879594eeac82c01f235d0e717736",
+  "Timestamp" : "2012-04-26T20:45:04.751Z",
+  "SignatureVersion" : "1",
+  "Signature" : "EXAMPLEpH+DcEwjAPg8O9mY8dReBSwksfg2S7WKQcikcNKWLQjwu6A4VbeS0QHVCkhRS7fUQvi2egU3N858fiTDN6bkkOxYDVrY0Ad8L10Hs3zH81mtnPk5uvvolIC1CXGu43obcgFxeL3khZl8IKvO61GWB6jI9b5+gLPoBc1Q=",
+  "SigningCertURL" : "https://sns.us-east-1.amazonaws.com/SimpleNotificationService-f3ecfb7224c7233fe7bb5f59f96de52f.pem"
+  }

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: aws_sns_subscription
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean Devine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy confirmation of Amazon SNS subscription requests in Rails apps
+email:
+- sean@buytruckload.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aws_sns_subscription.gemspec
+- lib/aws_sns_subscription.rb
+- lib/aws_sns_subscription/confirmer.rb
+- lib/aws_sns_subscription/railtie.rb
+- lib/aws_sns_subscription/version.rb
+- spec/confirmer_spec.rb
+- spec/fixtures/raw_post.txt
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Auto responds to AWS SNS subscription confirmations
+test_files:
+- spec/confirmer_spec.rb
+- spec/fixtures/raw_post.txt
+- spec/spec_helper.rb