fake_sns 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eea380f4afe8a28a3fe8ef442ee68bc36ed44fc7
+  data.tar.gz: 27394ec000f0bb22a985f37e38058c9c32057b33
+SHA512:
+  metadata.gz: 4a4c3f9cb1e0e99c47fc939ba45bf15ce944ab3bdc9ac70f3086daccfd1e0ba5c8b1e7a3ceed9a360653d3ae614ac5bf3f83bf8e519f373f3ec5e5c688ce0271
+  data.tar.gz: 65744967afec469a3224a608dd141d5c2549f482e28c1d42f2980388cccfe3e1d37d3ee6714d4ae497c2f337c534780a0bc4621d42cbf182c4cb7eaa7c9a827c

data/.gitignore

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

data/.rspec

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

data/.simplecov

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+SimpleCov.start do
+  add_filter "/spec/"
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+cache: bundler

data/Gemfile

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

data/README.md

@@ -0,0 +1,167 @@
+# Fake SNS
+
+A small web app for local SNS development.
+
+It contains a small store to inspect, and some methods to inspect and change the
+contents, so you can create scenarios.
+
+### Noteworthy differences:
+
+* No checking of access keys.
+* Returns all topics, not just 100, no support for `NextToken` parameter.
+
+### Implemented:
+
+* CreateTopic
+* ListTopics
+* DeleteTopic
+* GetTopicAttributes
+* SetTopicAttributes
+* ListSubscriptions
+* ListSubscriptionsByTopic
+
+### Under Construction
+
+* Subscribe
+* Publish
+
+### Actions to be implemented:
+
+* AddPermission
+* ConfirmSubscription
+* CreatePlatformApplication
+* CreatePlatformEndpoint
+* DeleteEndpoint
+* DeletePlatformApplication
+* GetEndpointAttributes
+* GetPlatformApplicationAttributes
+* GetSubscriptionAttributes
+* ListEndpointsByPlatformApplication
+* ListPlatformApplications
+* RemovePermission
+* SetEndpointAttributes
+* SetPlatformApplicationAttributes
+* SetSubscriptionAttributes
+* Unsubscribe
+
+## Usage
+
+There are 2 ways of running FakeSNS, as a gem, or as plain Rack app. The first
+is easy, the latter is more flexible.
+
+As a gem:
+
+```
+$ gem install fake_sns
+$ fake_sns -p 9292
+```
+
+To configure AWS-SDK to send messages here:
+
+``` ruby
+AWS.config(
+  use_ssl:       false,
+  sns_endpoint:  "0.0.0.0",
+  sns_port:      9292,
+)
+```
+
+### Command line options
+
+Get help by running `fake_sns --help`. These options are basically the same as
+Sinatra's options. Here are the SNS specific options:
+
+* Store the database somewhere else: `--database FILENAME` or
+specify an in memory database that will be lost: `--database :memory:`
+
+### Extra endpoints
+
+To get a YAML representation of all the data known to FakeSNS, do a GET request
+to the root path:
+
+```
+curl -X GET http://localhost:9292/
+```
+
+To change the database, submit the contents you got from the previous step,
+augment it and submit it as the body of a PUT request:
+
+```
+curl -X GET http://localhost:9292/ -o my-data.yml
+vim my-data.yml
+curl -X PUT --data @my-data.yml http://localhost:9292/
+```
+
+To reset the entire database, send a DELETE request:
+
+```
+curl -X DELETE http://localhost:9292/
+```
+
+To send ALL the messages stored in the queue, you can send a post request:
+
+```
+curl -X POST http://localhost:9292/drain
+```
+
+You can also just send a single message:
+
+```
+curl -X POST http://localhost:9292/drain/:message_id
+```
+
+Currently, only HTTP/HTTPS and SQS endpoints are working. You'll need
+to pass AWS config (in JSON format) for the SQS integration to work. See
+[FakeSNS] [fake_sns] for more information.
+
+```
+curl \
+       -X POST \
+       --data '{"aws_config": {"use_ssl": false, "sqs_endpoint": "localhost", "sqs_port": 4789, "secret_access_key": "xxx", "access_key_id": "yyy"}}' \
+       http://localhost:9292/drain
+```
+
+### Test Integration
+
+When making integration tests for your app, you can easily include Fake SNS.
+
+Here are the methods you need to run FakeSNS programmatically.
+
+``` ruby
+require "fake_sns/test_integration"
+
+# globally, before the test suite starts:
+AWS.config(
+  use_ssl:            false,
+  sns_endpoint:       "localhost",
+  sns_port:           4568,
+  access_key_id:      "fake access key",
+  secret_access_key:  "fake secret key",
+)
+fake_sns = FakeSNS::TestIntegration.new
+
+# before each test that requires SNS:
+fake_sns.start
+
+# at the end of the suite:
+at_exit {
+  fake_sns.stop
+}
+
+# for debugging, get everything FakeSNS knows:
+puts fake_sns.data.inspect
+
+# if you have SQS configured in the AWS config, you can also do:
+fake_sns.drain
+```
+
+See `spec/spec_helper.rb` in this project for an example on how to load it in
+your test suite.
+
+## More information
+
+* [API Reference](http://docs.aws.amazon.com/sns/latest/api/API_Operations.html)
+* [AWS-SDK docs](http://rubydoc.info/gems/aws-sdk/frames)
+* [Fake SQS] [fake_sqs]
+
+[fake_sqs]: https://github.com/iain/fake_sqs

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+
+require "tempfile"
+require "rspec/core/rake_task"
+
+namespace :spec do
+
+  desc "Run specs with in-memory database"
+  RSpec::Core::RakeTask.new(:memory) do |t|
+    ENV["SNS_DATABASE"] = ":memory:"
+  end
+
+  desc "Run specs with file database"
+  RSpec::Core::RakeTask.new(:file) do |t|
+    file = Tempfile.new(["rspec-sns", ".yml"], encoding: "utf-8")
+    ENV["SNS_DATABASE"] = file.path
+  end
+
+end
+
+desc "Run spec suite with both in-memory and file"
+task :spec => ["spec:memory", "spec:file"]
+
+task :default => :spec

data/bin/fake_sns

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'fake_sns'
+require 'optparse'
+
+options = {
+  :port      => 9292,
+  :host      => "0.0.0.0",
+  :verbose   => false,
+  :daemonize => false,
+  :database  => nil,
+}
+
+parser = OptionParser.new do |o|
+
+  o.on "--database FILENAME", "Place to store the database (defaults to ~/.fake_sns.yml)" do |filename|
+    options[:database] = filename
+  end
+
+  o.on "-p", "--port PORT", Integer, "Port to use (default: #{options[:port]})" do |port|
+    options[:port] = port
+  end
+
+  o.on "-o", "--bind HOST", "Host to bind to (default: 0.0.0.0)" do |host|
+    options[:host] = host
+  end
+
+  o.on "-s", "--server SERVER", ['thin', 'mongrel', 'webrick'], "Server to use: thin, mongrel or webrick (by default Sinatra chooses the best available)" do |server|
+    options[:server] = server
+  end
+
+  o.on "-P", "--pid PIDFILE", "Where to write the pid" do |pid|
+    options[:pid] = pid
+  end
+
+  o.on "-d", "--[no-]daemonize", "Detaches the process" do |daemonize|
+    options[:daemonize] = daemonize
+  end
+
+  o.on "-v", "--[no]-verbose", "Shows input parameters and output XML" do |verbose|
+    options[:verbose] = verbose
+  end
+
+  o.on_tail "--version", "Shows the version" do
+    puts "fake_sns version #{FakeSNS::VERSION}"
+    exit
+  end
+
+  o.on_tail "-h", "--help", "Shows this help page" do
+    puts o
+    exit
+  end
+
+end
+
+parser.parse!
+
+if options[:daemonize]
+  Process.daemon(true, true)
+end
+
+if (pid = options[:pid])
+  if File.exist?(pid)
+    existing_pid = File.open(pid, 'r').read.chomp.to_i
+    running = Process.getpgid(existing_pid) rescue false
+    if running
+      warn "Error, Process #{existing_pid} already running"
+      exit 1
+    else
+      warn "Cleaning up stale pid at #{pid}"
+    end
+  end
+  File.open(pid, 'w') { |f| f.write(Process.pid) }
+end
+
+FakeSNS.server(options).run!

data/config.ru

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "fake_sns/server"
+run FakeSNS::Server

data/fake_sns.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fake_sns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fake_sns"
+  spec.version       = FakeSNS::VERSION
+  spec.authors       = ["iain"]
+  spec.email         = ["iain@iain.nl"]
+  spec.description   = %q{Small Fake version of SNS}
+  spec.summary       = %q{Small Fake version of SNS}
+  spec.homepage      = "https://github.com/yourkarma/fake_sns"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sinatra", "~> 1.4"
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "verbose_hash_fetch"
+  spec.add_dependency "faraday", "~> 0.8"
+  spec.add_dependency "aws-sdk", "~> 1.30"
+
+  spec.add_development_dependency "aws-sdk"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "fake_sqs", "~> 0.0.9"
+  spec.add_development_dependency "json_expressions"
+
+end

data/lib/fake_sns/action.rb

@@ -0,0 +1,24 @@
+module FakeSNS
+  class Action
+
+    attr_reader :db, :params
+
+    def self.param(fields, &block)
+      fields.each do |field, key|
+        define_method field do
+          params.fetch(key, &block)
+        end
+      end
+    end
+
+    def initialize(db, params)
+      @db = db
+      @params = params
+    end
+
+    def call
+      # override me, if needed
+    end
+
+  end
+end

data/lib/fake_sns/actions/create_topic.rb

@@ -0,0 +1,41 @@
+module FakeSNS
+  module Actions
+    class CreateTopic < Action
+
+      param name: "Name"
+
+      def valid_name?
+        name =~ /\A[\w\-]+\z/
+      end
+
+      def call
+        raise InvalidParameterValue, "Topic Name: #{name.inspect}" unless valid_name?
+        @topic = (existing_topic || new_topic)
+      end
+
+      def arn
+        topic["arn"]
+      end
+
+      attr_reader :topic
+
+      private
+
+      def new_topic
+        arn = generate_arn
+        topic_attributes = { "arn" => arn, "name" => name }
+        db.topics.create(topic_attributes)
+        topic_attributes
+      end
+
+      def generate_arn
+        "arn:aws:sns:us-east-1:#{SecureRandom.hex}:#{name}"
+      end
+
+      def existing_topic
+        db.topics.find { |t| t["name"] == name }
+      end
+
+    end
+  end
+end

data/lib/fake_sns/actions/delete_topic.rb

@@ -0,0 +1,13 @@
+module FakeSNS
+  module Actions
+    class DeleteTopic < Action
+
+      param arn: "TopicArn"
+
+      def call
+        db.topics.delete(arn)
+      end
+
+    end
+  end
+end

data/lib/fake_sns/actions/get_topic_attributes.rb

@@ -0,0 +1,32 @@
+module FakeSNS
+  module Actions
+    class GetTopicAttributes < Action
+
+      param arn:    "TopicArn"
+
+# TopicArn
+# Owner
+# Policy
+# DisplayName
+# SubscriptionsPending
+# SubscriptionsConfirmed
+# SubscriptionsDeleted
+# DeliveryPolicy
+# EffectiveDeliveryPolicy
+
+      attr_reader :topic
+
+      def call
+        @topic = db.topics.fetch(arn) { raise NotFound, arn }
+      end
+
+      def each_attribute
+        yield "TopicArn", arn
+        %w(DisplayName Policy DeliveryPolicy).each do |key|
+          yield key, topic[key] if topic.has_key?(key)
+        end
+      end
+
+    end
+  end
+end

data/lib/fake_sns/actions/list_subscriptions.rb

@@ -0,0 +1,24 @@
+module FakeSNS
+  module Actions
+    class ListSubscriptions < Action
+
+      param next_token: "NextToken"
+
+      def call
+      end
+
+      def each_subscription
+        subscriptions.each do |subscription|
+          yield subscription
+        end
+      end
+
+      private
+
+      def subscriptions
+        db.subscriptions
+      end
+
+    end
+  end
+end

data/lib/fake_sns/actions/list_subscriptions_by_topic.rb

@@ -0,0 +1,23 @@
+module FakeSNS
+  module Actions
+    class ListSubscriptionsByTopic < ListSubscriptions
+
+      param topic_arn: "TopicArn"
+      param next_token: "NextToken"
+
+      def call
+        super
+        @topic = db.topics.fetch(topic_arn) do
+          raise InvalidParameterValue, "Unknown topic: #{topic_arn}"
+        end
+      end
+
+      private
+
+      def subscriptions
+        super.select { |s| s["topic_arn"] == topic_arn }
+      end
+
+    end
+  end
+end

data/lib/fake_sns/actions/list_topics.rb

@@ -0,0 +1,13 @@
+module FakeSNS
+  module Actions
+    class ListTopics < Action
+
+      def each_topic
+        db.topics.each do |topic|
+          yield topic
+        end
+      end
+
+    end
+  end
+end

data/lib/fake_sns/actions/publish.rb

@@ -0,0 +1,37 @@
+module FakeSNS
+  module Actions
+    class Publish < Action
+
+      param message: "Message"
+      param message_structure: "MessageStructure"
+      param subject: "Subject" do nil end
+      param target_arn: "TargetArn" do nil end
+      param topic_arn: "TopicArn" do nil end
+
+      def call
+        if (bytes = message.bytesize) > 262144
+          raise InvalidParameterValue, "Too much bytes: #{bytes} > 262144."
+        end
+        @topic = db.topics.fetch(topic_arn) do
+          raise InvalidParameterValue, "Unknown topic: #{topic_arn}"
+        end
+        @message_id = SecureRandom.uuid
+
+        db.messages.create(
+          id:          message_id,
+          subject:     subject,
+          message:     message,
+          topic_arn:   topic_arn,
+          structure:   message_structure,
+          target_arn:  target_arn,
+          received_at: Time.now,
+        )
+      end
+
+      def message_id
+        @message_id || raise(InternalFailure, "no message id yet, this should not happen")
+      end
+
+    end
+  end
+end

data/lib/fake_sns/actions/set_topic_attributes.rb

@@ -0,0 +1,19 @@
+module FakeSNS
+  module Actions
+    class SetTopicAttributes < Action
+
+      VALID_PARAMETER_NAMES = %w(Policy DisplayName DeliveryPolicy)
+
+      param key:    "AttributeName"
+      param value:  "AttributeValue"
+      param arn:    "TopicArn"
+
+      def call
+        raise InvalidParameterValue, "AttributeName: #{key.inspect}" unless VALID_PARAMETER_NAMES.include?(key)
+        topic = db.topics.fetch(arn) { raise NotFound, arn }
+        topic[key] = value
+      end
+
+    end
+  end
+end

data/lib/fake_sns/actions/subscribe.rb

@@ -0,0 +1,43 @@
+module FakeSNS
+  module Actions
+    class Subscribe < Action
+
+      param endpoint: "Endpoint"
+      param protocol: "Protocol"
+      param topic_arn: "TopicArn"
+
+      attr_reader :topic
+
+      def call
+        @topic = db.topics.fetch(topic_arn) do
+          raise InvalidParameterValue, "Unknown topic: #{topic_arn}"
+        end
+        @subscription = (existing_subscription || new_subscription)
+      end
+
+      def subscription_arn
+        @subscription["arn"]
+      end
+
+      private
+
+      def existing_subscription
+        db.subscriptions.to_a.find { |s|
+          s.topic_arn == topic_arn && s.endpoint == endpoint
+        }
+      end
+
+      def new_subscription
+        attributes = {
+          "arn"       => "#{topic_arn}:#{SecureRandom.uuid}",
+          "protocol"  => protocol,
+          "endpoint"  => endpoint,
+          "topic_arn" => topic_arn,
+        }
+        db.subscriptions.create(attributes)
+        attributes
+      end
+
+    end
+  end
+end