pokey-sendgrid 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2267dda332347e006ace1fe92ccbb1db280ce12d
+  data.tar.gz: 47be71f73cdc13d6432c9a7307963487e84c74fd
+SHA512:
+  metadata.gz: e1c5e559bbe26d7b0f9105489379d217c8a67daab668e9bcabaea8dc00143e92df78754a4196cb674ef5ddb39b8135f31b70163b5dd26d0ed0580044e20329d8
+  data.tar.gz: de4186d5c62cd34f52ed659b9680ee37e19be870beeb94fa9566d51f46dfc0e4a7c7342b93e61334d0732f52de97375eb77589e5247d06807e9df0be17b29f30

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

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 pokey-sendgrid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chuck Callebs
+
+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,108 @@
+# Pokey::Sendgrid
+
+Sensible defaults to emulate Sendgrid data on development/QA using Pokey hooks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pokey-sendgrid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pokey-sendgrid
+
+## Usage
+
+If this is your first installation (and you're on Rails), run
+
+`$ rails g pokey:install`
+
+This will create an initializer file that defines your `hook_dir` (the
+location where all hooks will be defined). Just create a new file in that
+directory that inherits from `Pokey::Sendgrid::Hook`.
+
+Simple example:
+
+``` RUBY
+class SendgridHook < Pokey::Sendgrid::Hook
+  # Your Sendgrid webhook endpoint
+  def destination
+    # Defaults to /api/sendgrid/events
+    "http://localhost:3000/api/sendgrid/events"
+  end
+
+  # Time (in seconds) between Pokey requests
+  def interval
+    5 # Defaults to 5
+  end
+end
+```
+
+#### Categories and Unique Arguments
+This gem also supports dynamic categories / unique arguments when generating
+data. To use:
+
+``` RUBY
+class SendgridHook < Pokey::SendgridHook
+  def categories
+    [
+      ["User", "Welcome Email"],
+      ["Billing", "Payment Successful"]
+    ]
+  end
+
+  def unique_args
+    {
+      "custom-identifier" => 15
+    }
+  end
+end
+```
+
+#### Limiting Events
+By default, Pokey::Sendgrid will generate all types of SendGrid events:
+- processed
+- dropped
+- delivered
+- deferred
+- bounce
+- open
+- click
+- spam_report
+- unsubscribe
+- group_unsubscribe
+- group_resubscribe
+
+To limit the amount of events your application receives, override the
+`sendgrid_events` method like so:
+
+``` RUBY
+class SendgridHook < Pokey::SendgridHook
+  protected
+
+  # Limits events to only "Open" and "Click"
+  def sendgrid_events
+    ["open", "click"]
+  end
+end
+```
+
+#### Start generating data
+If you're on rails, just start your server. Otherwise, start your application.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pokey-sendgrid. This project is intended to be a safe, welcoming space for collaboration, and 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/lib/pokey/sendgrid.rb

@@ -0,0 +1,9 @@
+require "pokey/sendgrid/version"
+require "pokey/sendgrid/mock_data"
+require "pokey/sendgrid/hook"
+
+module Pokey
+  module Sendgrid
+    # Your code goes here...
+  end
+end

data/lib/pokey/sendgrid/hook.rb

@@ -0,0 +1,79 @@
+require 'pokey/hook'
+require 'faker'
+
+module Pokey
+  module Sendgrid
+    # Reference: https://sendgrid.com/docs/API_Reference/Webhooks/event.html
+    class Hook < Pokey::Hook
+      include Pokey::Sendgrid::MockData
+
+      def destination
+        "http://localhost:3000/api/sendgrid/events"
+      end
+
+      def interval
+        5
+      end
+
+      def http_method
+        :post
+      end
+
+      def data
+        data = base_data
+
+        case data["event"]
+        # Delivery events
+        when "bounce", "deferred", "delivered", "dropped", "processed"
+          data.merge!({
+            "smtp-id" => smtp_id
+          })
+        # Engagement events
+        when "click", "open", "spamreport", "unsubscribe"
+          data.merge!({
+            "useragent" => user_agents.sample,
+            "ip" => Faker::Internet.ip_v4_address
+          })
+        end
+
+        data.merge!(unique_args)
+        data
+      end
+
+      def categories
+        []
+      end
+
+      def unique_args
+        {}
+      end
+
+      protected
+
+      def base_data
+        {
+          "timestamp" => Time.now.to_i,
+          "category" => categories.sample,
+          "event" => sendgrid_events.sample,
+          "email" => Faker::Internet.email
+        }
+      end
+
+      def sendgrid_events
+        [
+          "processed",
+          "dropped",
+          "delivered",
+          "deferred",
+          "bounce",
+          "open",
+          "click",
+          "spamreport",
+          "unsubscribe",
+          "group_unsubscribe",
+          "group_resubscribe"
+        ]
+      end
+    end
+  end
+end

data/lib/pokey/sendgrid/mock_data.rb

@@ -0,0 +1,22 @@
+module Pokey
+  module Sendgrid
+    module MockData
+      def user_agents
+        [
+          "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_4) AppleWebKit/600.7.12 (KHTML, like Gecko) Version/8.0.7 Safari/600.7.12",
+          "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:39.0) Gecko/20100101 Firefox/39.0",
+          "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.134 Safari/537.36",
+          "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:39.0) Gecko/20100101 Firefox/39.0",
+          "Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko"
+        ]
+      end
+
+      def smtp_id
+        prefix = Faker::Internet.password(10, 20)
+        suffix = Faker::Internet.password(10, 20)
+        domain = Faker::Internet.domain_word
+        "#{prefix}_#{suffix}@#{domain}.mail"
+      end
+    end
+  end
+end

data/lib/pokey/sendgrid/version.rb

@@ -0,0 +1,5 @@
+module Pokey
+  module Sendgrid
+    VERSION = "0.1.1"
+  end
+end

data/pokey-sendgrid.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pokey/sendgrid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pokey-sendgrid"
+  spec.version       = Pokey::Sendgrid::VERSION
+  spec.authors       = ["Chuck Callebs"]
+  spec.email         = ["chuck@callebs.io"]
+
+  spec.summary       = %q{Easily simulate Sendgrid webhooks using Pokey.}
+  spec.homepage      = "https://github.com/ccallebs/pokey-sendgrid"
+  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.add_runtime_dependency "pokey", "~> 0.2"
+  spec.add_runtime_dependency "faker", "~> 1.5"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: pokey-sendgrid
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chuck Callebs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pokey
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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
+  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: 
+email:
+- chuck@callebs.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pokey/sendgrid.rb
+- lib/pokey/sendgrid/hook.rb
+- lib/pokey/sendgrid/mock_data.rb
+- lib/pokey/sendgrid/version.rb
+- pokey-sendgrid.gemspec
+homepage: https://github.com/ccallebs/pokey-sendgrid
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Easily simulate Sendgrid webhooks using Pokey.
+test_files: []