sqs_facade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a61eb1e0ce4acc3c9fd9a2932721265d7c405069
+  data.tar.gz: 39c71d485d2be6f44449cc910bfd92a8e8d0d3f2
+SHA512:
+  metadata.gz: 32d0a13b790fedd2ac74dbaf728d476b120405771bd70dc4ac30d9880b2244a09af98cfb7581723beb17ec10f8b940b545d3a8415880b718f2e22ad7797ba892
+  data.tar.gz: 4023a1fae1171a9002890622076fa7bc42361e58cc1d50861c85db9ca47c9de755933a46ccd422075059be2a47fc6591e375cc052dacf260320ce21201b28010

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nephtali Rodriguez
+
+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,91 @@
+# SQS Facade
+
+[![Build Status](https://semaphoreci.com/api/v1/nrodriguez/sqs_facade/branches/master/badge.svg)](https://semaphoreci.com/nrodriguez/sqs_facade)
+
+This gem is geared towards making your life easier when it comes to testing using AWS SQS messages. Think Factory Girl/Faker for AWS SQS purposes. It works by generating a message skeleton and allows you to override the defaults with anything you want. Internal message are stored as JSON strings.
+
+It works by generating objects with an internal message structure such as:
+
+```ruby
+{
+    "Type"=> "Notification",
+    "MessageId"=> "b2632fcd-b735-57ae-84aa-6075ace8a47c",
+    "TopicArn"=> "arn:aws:sns:us-east-1:123456789:sample_sns",
+    "Subject"=> "entityupsert",
+    "Message"=> "{\"something\":\"hey\",\"really\":\"there\",\"cool\":\"lonely girl\"}",
+    "Timestamp"=> "2016-05-19T19:53:01.936Z",
+    "SignatureVersion"=> "1",
+    "Signature"=> "cf23df2207d99a74fbe169e3eba035e633b65d94==",
+    "SigningCertURL"=> "https://sns.us-east-1.amazonaws.com/SampleSNS.pem",
+    "UnsubscribeURL"=> "https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:123456789:sample_sns"
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sqs_facade'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sqs_facade
+
+## Usage
+
+Usage is easy. Simply instantiate the class and by default new will return an object with generated dummy values.
+
+```ruby
+SqsFacade.new
+
+-> <SqsFacade:0x007fcea2944260 @full_message={"Type"=>"Notification", "MessageId"=>"be3b6b8b-ce76-4e6e-a800-bba8377a37a7", "TopicArn"=>"arn:aws:sns:us-east-1:31cf754f-bbd7-4c14-9c78-e81f7d115958:some-sns-topic", "Subject"=>"entityupsert", "Message"=>"{\"something\":\"hey\",\"really\":\"there\",\"cool\":\"lonely girl\"}", "Timestamp"=>"2016-05-19T19:53:01.936Z", "SignatureVersion"=>"1", "Signature"=>"c+9MIvg7+87QVQzm3xAxog==", "SigningCertURL"=>"https://sns.us-east-1.amazonaws.com/eb74a61a20c15ac1c53db21a4af05993.pem", "UnsubscribeURL"=>"https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:31cf754f-bbd7-4c14-9c78-e81f7d115958:some-sns-topic:1234"}>
+```
+To access the full message as a hash use the ```full_message``` method
+
+```ruby
+SqsFacade.new.full_message
+
+-> {"Type"=>"Notification", "MessageId"=>"e1cbeb58-9b36-4ee4-94ff-d195f2b7fcbf", "TopicArn"=>"arn:aws:sns:us-east-1:e9f8a671-2d08-4fc4-b54b-6109c02da13a:some-sns-topic", "Subject"=>"entityupsert", "Message"=>"{\"something\":\"hey\",\"really\":\"there\",\"cool\":\"lonely girl\"}", "Timestamp"=>"2016-05-19T19:53:01.936Z", "SignatureVersion"=>"1", "Signature"=>"DBHK4iOEfwT99DLhLz2EqQ==", "SigningCertURL"=>"https://sns.us-east-1.amazonaws.com/0fae4284696382f2784a1670d2a56b81.pem", "UnsubscribeURL"=>"https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:e9f8a671-2d08-4fc4-b54b-6109c02da13a:some-sns-topic:1234"}
+```
+
+You can override certain values by passing them in during instantiation:
+
+```ruby
+SqsFacade.new(message: {awesome_person: "justneph", career: "software engineer/pro wrestler"})
+
+-> <SqsFacade:0x007fcea306c5b0 @full_message={"Type"=>"Notification", "MessageId"=>"20c8433e-16c1-4aec-a0a5-d8f6e3e445e1", "TopicArn"=>"arn:aws:sns:us-east-1:e82988d7-1a3f-45e8-b718-8e7565631c35:some-sns-topic", "Subject"=>"entityupsert", "Message"=>"{\"awesome_person\":\"justneph\",\"career\":\"software engineer/pro wrestler\"}", "Timestamp"=>"2016-05-19T19:53:01.936Z", "SignatureVersion"=>"1", "Signature"=>"/MX5p5Se7ujuIYY2o/vVJQ==", "SigningCertURL"=>"https://sns.us-east-1.amazonaws.com/4c7e432f8f8c3d425fecb50d5c81409c.pem", "UnsubscribeURL"=>"https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:e82988d7-1a3f-45e8-b718-8e7565631c35:some-sns-topic:1234"}>
+```
+
+Each parameter is accessible via a method call as well
+
+```ruby
+irb(main):012:0> SqsFacade.new(message: {awesome_person: "justneph", career: "software engineer/pro wrestler"}).message
+=> "{\"awesome_person\":\"justneph\",\"career\":\"software engineer/pro wrestler\"}"
+
+irb(main):013:0> SqsFacade.new(message: {awesome_person: "justneph", career: "software engineer/pro wrestler"}).timestamp
+=> "2016-05-19T19:53:01.936Z"
+
+irb(main):014:0> SqsFacade.new(message: {awesome_person: "justneph", career: "software engineer/pro wrestler"}).topic_arn
+=> "arn:aws:sns:us-east-1:61458f06-5922-4fcf-a165-e52531e7f1ee:some-sns-topic"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sqs_facade. This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sqs_facade"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/facade/message.rb

@@ -0,0 +1,44 @@
+module Facade
+  class Message
+    attr_accessor :full_message
+
+    def initialize(args = "")
+      @full_message = create_message(args)
+      set_accessors
+    end
+
+    def set_accessors
+      full_message.keys.each do |key|
+        define_singleton_method(key.underscore.to_sym) do
+          full_message[key]
+        end
+      end
+    end
+
+    private
+
+    def message_template
+      topic_id = SecureRandom.uuid
+      {
+        "Type"=> "Notification",
+        "MessageId"=> SecureRandom.uuid,
+        "TopicArn"=> "arn:aws:sns:us-east-1:#{topic_id}:some-sns-topic",
+        "Subject"=> "entityupsert",
+        "Message"=> "{\"something\":\"hey\",\"really\":\"there\",\"cool\":\"lonely girl\"}",
+        "Timestamp"=> "2016-05-19T19:53:01.936Z",
+        "SignatureVersion"=> "1",
+        "Signature"=> SecureRandom.base64(16),
+        "SigningCertURL"=> "https://sns.us-east-1.amazonaws.com/#{SecureRandom.hex}.pem",
+        "UnsubscribeURL"=> "https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:#{topic_id}:some-sns-topic:1234"
+      }
+    end
+
+    def create_message(args)
+      return message_template if args.empty?
+      skeleton = message_template
+      args.each{|k,v| skeleton[k.to_s.capitalize] = args[k] }
+      skeleton["Message"] = skeleton["Message"].to_json
+      skeleton
+    end
+  end
+end

data/lib/facade/version.rb

@@ -0,0 +1,3 @@
+module Facade
+  VERSION = "0.1.0"
+end

data/lib/sqs_facade.rb

@@ -0,0 +1,9 @@
+require "json"
+require "active_support/inflector"
+require "securerandom"
+require "facade/version"
+require "facade/message"
+
+class SqsFacade < Facade::Message
+  # Your code goes here...
+end

data/sqs_facade.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'facade/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sqs_facade"
+  spec.version       = Facade::VERSION
+  spec.authors       = ["Nephtali Rodriguez"]
+  spec.email         = ["nrodriguez@xogrp.com"]
+
+  spec.summary       = %q{Allows fake AWS SQS messages to be generated for testing.}
+  spec.description   = %q{Allows fake AWS SQS messages to be generated for testing. This is intended to be used as a Faker/Factory Girl equivalent for stubbing out AWS SQS messages.}
+  spec.homepage      = "https://github.com/xogroup/sqs_facade"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '~> 2.3'
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: sqs_facade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nephtali Rodriguez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: Allows fake AWS SQS messages to be generated for testing. This is intended
+  to be used as a Faker/Factory Girl equivalent for stubbing out AWS SQS messages.
+email:
+- nrodriguez@xogrp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/facade/message.rb
+- lib/facade/version.rb
+- lib/sqs_facade.rb
+- sqs_facade.gemspec
+homepage: https://github.com/xogroup/sqs_facade
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+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: Allows fake AWS SQS messages to be generated for testing.
+test_files: []