webhookr-vero 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4645ed793f7e644f925f53ec059e141f7e1980a6
+  data.tar.gz: 172a2a56ae0a002dd1e9e73c645afba78e3a9826
+SHA512:
+  metadata.gz: 5bc3c4c1331b3a9166cc493e233ab6b931d56b18bea3502dd82b684f108401a8e3c13c778238827281751a160dff945f8e3a5ce75f48fa705e4f6fefe0a7b3d6
+  data.tar.gz: 1369103bfc9e265e8d798aa19cdbe33749951fb8829cd650872b5698d372c8ead0dbfd0ae2e4dfb0b41751c352397ef4d6c579683f1dd7710b67d5224cf01ea3

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem "rake", ">= 10.0"
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "em-websocket"
+  gem "guard"
+  gem "guard-minitest"
+  gem "guard-markdown"
+  gem "guard-livereload"
+  gem "simplecov", :require => false
+  gem "coveralls", :require => false
+end
+
+if File.exists?('Gemfile.local')
+  instance_eval File.read('Gemfile.local')
+end

data/Guardfile

@@ -0,0 +1,20 @@
+
+guard 'minitest', :test_folders => 'test', :test_file_patterns => '*_tests.rb' do
+  watch(%r|^test/(.+)_tests\.rb|)
+
+  watch(%r|^lib/(.*)([^/]+)\.rb|) do |m|
+    "test/#{m[1]}#{m[2]}_tests.rb"
+  end
+
+  watch(%r|^test/test_helper\.rb|) do
+    "test"
+  end
+end
+
+guard 'livereload' do
+  watch('README.html')
+end
+
+if File.exists?('Guardfile.local')
+  instance_eval File.read('Guardfile.local')
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tailor
+
+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,156 @@
+# Webhookr::Vero
+
+[![Circle CI](https://circleci.com/gh/TailorBrands/webhookr-vero.svg?style=svg)](https://circleci.com/gh/TailorBrands/webhookr-vero)
+[![Code Climate](https://codeclimate.com/github/TailorBrands/webhookr-vero/badges/gpa.svg)](https://codeclimate.com/github/TailorBrands/webhookr-vero)
+
+This gem is a plugin for [Webhookr](https://github.com/zoocasa/webhookr) that enables
+your application to accept [webhooks from vero](http://www.getvero.com/help/reporting/setting-up-veros-webhooks/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webhookr-vero'
+
+Or install it yourself:
+
+    $ gem install webhookr-vero
+
+[webhookr](https://github.com/zoocasa/webhookr) is installed as a dependency of webhookr-vero. If you have not [setup Webhookr](https://github.com/zoocasa/webhookr#usage--setup), do so now:
+
+```console
+rails g webhookr:add_route
+```
+
+## Usage
+
+Once you have the gem installed run the generator to add the code to your initializer.
+An initializer will be created if you do not have one.
+
+```console
+rails g webhookr:vero:init *initializer_name* -s
+```
+
+Run the generator to create an example file to handle vero webhooks.
+
+```console
+rails g webhookr:vero:example_hooks
+```
+
+Or create a vero handler class for any event that you want to handle. For example
+to handle unsubscribes you would create a class as follows:
+
+```ruby
+class VeroHooks
+  def on_unsubscribed(incoming)
+    # Your custom logic goes here.
+    user = incoming.payload.user
+    puts("User unsubscribed: (#{user.email})")
+  end
+end
+```
+
+For a complete list of events, and the payload format, see below.
+
+Edit config/initializers/*initializer_name* and change the commented line to point to
+your custom vero event handling class. If your class was called *VeroHooks*
+the configuration line would look like this:
+
+```ruby
+  Webhookr::Vero::Adapter.config.callback = VeroHooks
+```
+
+To see the list of vero URLs your application can use when you configure
+vero webhooks,
+run the provided webhookr rake task:
+
+```console
+rake webhookr:services
+```
+
+Example output:
+
+```console
+vero:
+  GET	/webhooks/events/vero/19xl64emxvn
+  POST	/webhooks/events/vero/19xl64emxvn
+```
+
+## vero Events & Payload
+
+### Events
+
+All webhook events are supported. For further information on these events, see the
+[vero documentation](http://www.getvero.com/help/reporting/setting-up-veros-webhooks/).
+
+<table>
+  <tr>
+    <th>Vero Event</th>
+    <th>Event Handler</th>
+  </tr>
+  <tr>
+    <td>Email Sent</td>
+    <td>on_sent(incoming)</td>
+  </tr>
+  <tr>
+    <td>Email Delivered</td>
+    <td>on_delivered(incoming)</td>
+  </tr>
+  <tr>
+    <td>Email Opened</td>
+    <td>on_opened(incoming)</td>
+  </tr>
+  <tr>
+    <td>Email Clicked</td>
+    <td>on_clicked(incoming)</td>
+  </tr>
+  <tr>
+    <td>Email Bounced</td>
+    <td>on_bounced(incoming)</td>
+  </tr>
+  <tr>
+    <td>User Unsubscribed</td>
+    <td>on_unsubscribed(incoming)</td>
+  </tr>
+  <tr>
+    <td>User Updated</td>
+    <td>on_user_updated(incoming)</td>
+  </tr>
+</table>
+
+### Payload
+
+The payload is the full payload data from as per the
+[vero documentation](http://www.getvero.com/help/reporting/setting-up-veros-webhooks/), converted to an OpenStruct
+for ease of access. Examples can be found in the example hook file.
+
+### <a name="supported_services"></a>Supported Service - vero
+
+* [http://www.getvero.com/help/reporting/setting-up-veros-webhooks/](vero - version: 2015-09-29)
+
+## <a name="works_with"></a>Works with:
+
+webhookr-vero works with Rails 3.1, 3.2 and 4.0
+
+### Versioning
+This library aims to adhere to [Semantic Versioning 2.0.0](http://semver.org/). Violations of this scheme should be reported as
+bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that
+version should be immediately yanked and/or a new version should be immediately released that restores
+compatibility. Breaking changes to the public API will only be introduced with new major versions. As a
+result of this policy, once this gem reaches a 1.0 release, you can (and should) specify a dependency on
+this gem using the [Pessimistic Version Constraint](http://docs.rubygems.org/read/chapter/16#page74) with
+two digits of precision. For example:
+
+    spec.add_dependency 'webhookr-vero', '~> 1.0'
+
+While this gem is currently a 0.x release, suggestion is to require the exact version that works for your code:
+
+    spec.add_dependency 'webhookr-vero', '0.0.1'
+
+## License
+
+webhookr-vero is released under the [MIT license](http://www.opensource.org/licenses/MIT).
+
+## About Tailor Brands
+
+[Check us out!](https://www.tailorbrands.com)

data/Rakefile

@@ -0,0 +1,37 @@
+
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'bundler/gem_tasks'
+
+if RUBY_VERSION >= '1.9'
+  begin
+    gem 'psych'
+  rescue Exception => e
+    # it's okay, fall back on the bundled psych
+  end
+end
+
+$:.push 'lib'
+
+version = Webhookr::Vero::VERSION
+
+desc 'Test Webhookr vero'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/**/*_tests.rb']
+  t.verbose = !!ENV['VERBOSE_TESTS']
+  t.warning = !!ENV['WARNINGS']
+end
+
+desc 'Build docs'
+Rake::RDocTask.new do |t|
+  t.main = 'README.md'
+  t.title = "Webhookr vero #{version}"
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include('README.md', 'MIT-LICENSE', 'lib/**/*.rb')
+end
+
+task :default => :test

data/lib/generators/webhookr/vero/example_hooks_generator.rb

@@ -0,0 +1,17 @@
+module Webhookr
+  module Vero
+    module Generators
+
+      class ExampleHooksGenerator < Rails::Generators::Base
+        EXAMPLE_HOOK_FILE = 'app/models/vero_hooks.rb'
+        source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+        desc "Creates an example vero hook file: '#{EXAMPLE_HOOK_FILE}'"
+        def example_hooks
+          copy_file( "vero_hooks.rb", EXAMPLE_HOOK_FILE)
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/webhookr/vero/init_generator.rb

@@ -0,0 +1,24 @@
+require 'generators/webhookr/init_generator'
+
+module Webhookr
+  module Vero
+    module Generators
+      class InitGenerator < Webhookr::Generators::InitGenerator
+
+        desc "This generator updates the named initializer with vero options"
+        def init
+          super
+          append_to_file "config/initializers/#{file_name}.rb" do
+            plugin_initializer_text
+          end
+        end
+
+        def plugin_initializer_text
+          "\nWebhookr::Vero::Adapter.config.security_token = '#{generate_security_token}'" +
+          "\n# Uncomment the next line to include your custom vero handler\n" +
+          "# <-- Webhookr::Vero::Adapter.config.callback = your_custom_class --> \n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/webhookr/vero/templates/vero_hooks.rb

@@ -0,0 +1,41 @@
+class VeroHooks
+
+  # All 'on_' handlers are optional. Omit any you do not require.
+  # Details on the payload structure: http://www.getvero.com/help/reporting/setting-up-veros-webhooks/
+  #
+
+  def on_sent(incoming)
+    user = incoming.payload.user
+    puts("Email sent: (#{user})")
+  end
+
+  def on_delivered(incoming)
+    user = incoming.payload.user
+    puts("Email deliverd: (#{user})")
+  end
+
+  def on_opened(incoming)
+    user = incoming.payload.user
+    puts("Email opened: (#{user})")
+  end
+
+  def on_clicked(incoming)
+    user = incoming.payload.user
+    puts("Email clicked: (#{user})")
+  end
+
+  def on_bounced(incoming)
+    user = incoming.payload.user
+    puts("Email bounced: (#{user})")
+  end
+
+  def on_unsubscribed(incoming)
+    user = incoming.payload.user
+    puts("User unsubscribed: (#{user})")
+  end
+
+  def on_user_updated(incoming)
+    user = incoming.payload.user
+    puts("User updated: (#{user})")
+  end
+end

data/lib/webhookr-vero.rb

@@ -0,0 +1,48 @@
+require "webhookr"
+require "webhookr-vero/version"
+require "webhookr/ostruct_utils"
+
+module Webhookr
+  module Vero
+    class Adapter
+      SERVICE_NAME = "vero"
+      EVENT_KEY = "type"
+      USER_KEY = "user"
+
+      include Webhookr::Services::Adapter::Base
+
+      def self.process(raw_response)
+        new.process(raw_response)
+      end
+
+      def process(raw_response)
+        Array.wrap(parse(raw_response)).collect do |p|
+          Webhookr::AdapterResponse.new(
+            SERVICE_NAME,
+            p.fetch(EVENT_KEY),
+            OstructUtils.to_ostruct(p.except(EVENT_KEY))
+          ) if assert_valid_packet(p)
+        end
+      end
+
+      private
+
+      def parse(raw_response)
+        begin
+          ActiveSupport::JSON.decode(
+            CGI.unescape(raw_response)
+          )
+        rescue Exception => e
+          raise InvalidPayloadError.new(e)
+        end
+      end
+
+      def assert_valid_packet(packet)
+        raise(Webhookr::InvalidPayloadError, "Unknown event #{packet[EVENT_KEY]}") unless packet[EVENT_KEY]
+        raise(Webhookr::InvalidPayloadError, "No user data in the response") unless packet[USER_KEY] 
+        true
+      end
+
+    end
+  end
+end

data/lib/webhookr-vero/version.rb

@@ -0,0 +1,5 @@
+module Webhookr
+  module Vero
+    VERSION = "0.0.1"
+  end
+end

data/test/generators/webhookr/vero_plugin/init_generator_tests.rb

@@ -0,0 +1,26 @@
+
+$: << File.join(File.dirname(__FILE__), %w{ .. .. .. })
+require 'test_helper'
+require 'generators/webhookr/vero/init_generator'
+
+class InitGeneratorTests < Rails::Generators::TestCase
+  tests Webhookr::Vero::Generators::InitGenerator
+  destination File.expand_path("../../../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  def setup
+    @name = "test_initializer"
+    @initializer = "config/initializers/#{@name}.rb"
+    run_generator Array.wrap(@name)
+  end
+
+  test "it should create the initializer" do
+    assert_file @initializer
+  end
+
+  test "it should have authorization information" do
+    assert_file @initializer do |content|
+      assert_match(%r{Webhookr::Vero::Adapter\.config\.security_token}, content)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.start
+Coveralls.wear!
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'rails'
+require "rails/generators/test_case"
+require File.expand_path('../../lib/webhookr-vero.rb', __FILE__)
+
+if RUBY_VERSION >= "1.9"
+  MiniTest::Reporters.use!(MiniTest::Reporters::SpecReporter.new)
+end

data/test/unit/webhookr-vero/version_tests.rb

@@ -0,0 +1,8 @@
+$: << File.join(File.dirname(__FILE__), %w{ .. .. })
+require 'test_helper'
+
+describe Webhookr::Vero do
+  it "must be defined" do
+    Webhookr::Vero::VERSION.wont_be_nil
+  end
+end

data/test/unit/webhookr-vero_tests.rb

@@ -0,0 +1,148 @@
+
+$: << File.join(File.dirname(__FILE__), "..")
+require 'test_helper'
+
+describe Webhookr::Vero::Adapter do
+
+  before do
+    @event_type = "sent"
+  end
+
+  def valid_response
+    '{
+      "type": "sent",
+      "user": {
+          "id": 12345,
+          "email": "kevin@tailorbrands.com"
+      },
+      "campaign": {
+          "id": 1235666234572456,
+          "type": "transactional",
+          "name": "Cart Abandonment Followup",
+          "subject": "You have items in your shopping bag",
+          "trigger-event": "Abandoned cart",
+          "permalink": "http://app.getvero.com/view/1/9c8c3ac6ac65736926a6da5aefbf852d"
+       },
+       "sent_at": 1435016238,
+       "user_agent":"Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)"
+  }'
+  end
+
+  def no_user_response
+    '{
+      "type": "sent",
+      "campaign": {
+          "id": 1235666234572456,
+          "type": "transactional",
+          "name": "Cart Abandonment Followup",
+          "subject": "You have items in your shopping bag",
+          "trigger-event": "Abandoned cart",
+          "permalink": "http://app.getvero.com/view/1/9c8c3ac6ac65736926a6da5aefbf852d"
+       },
+       "sent_at": 1435016238,
+       "user_agent":"Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)"
+  }'
+  end
+
+  describe "the class" do
+
+    subject { Webhookr::Vero::Adapter }
+
+    it "must support process" do
+      subject.must_respond_to(:process)
+    end
+
+    it "should not return an error for a valid packet" do
+      lambda {
+        subject.process(valid_response)
+      }.must_be_silent
+    end
+
+  end
+
+  describe "the instance" do
+
+    subject { Webhookr::Vero::Adapter.new }
+
+    it "should not return an error for a valid packet" do
+      lambda {
+        subject.process(valid_response)
+      }.must_be_silent
+    end
+
+    it "should raise Webhookr::InvalidPayloadError for no packet" do
+      lambda {
+        subject.process("")
+      }.must_raise(Webhookr::InvalidPayloadError)
+    end
+
+    it "should raise Webhookr::InvalidPayloadError for a missing user" do
+      lambda {
+        subject.process(no_user_response)
+      }.must_raise(Webhookr::InvalidPayloadError)
+    end
+
+  end
+
+  describe "it's response" do
+    before do
+      @adapter = Webhookr::Vero::Adapter.new
+    end
+
+    subject { @adapter.process(valid_response).first }
+
+    it "must respond to service_name" do
+      subject.must_respond_to(:service_name)
+    end
+
+    it "should return the correct service name" do
+      assert_equal(Webhookr::Vero::Adapter::SERVICE_NAME, subject.service_name)
+    end
+
+    it "must respond to event_type" do
+      subject.must_respond_to(:event_type)
+    end
+
+    it "should return the correct event type" do
+      assert_equal(@event_type, subject.event_type)
+    end
+
+    it "must respond to payload" do
+      subject.must_respond_to(:payload)
+    end
+
+    it "must respond to payload.sent_at" do
+      subject.payload.must_respond_to(:sent_at)
+    end
+
+    it "should return the correct data packet for sent_at" do
+      assert_equal(1435016238, subject.payload.sent_at)
+    end
+
+    it "must respond to payload.user_agent" do
+      subject.payload.must_respond_to(:user_agent)
+    end
+
+    it "should return the correct data packet for user_agent" do
+      assert_equal("Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)", subject.payload.user_agent)
+    end
+
+    it "must respond to payload.campaign" do
+      subject.payload.must_respond_to(:campaign)
+    end
+
+    it "should return the correct type for campaign" do
+      assert_equal("transactional", subject.payload.campaign.type)
+    end
+
+    it "must respond to payload.user" do
+      subject.payload.must_respond_to(:user)
+    end
+
+    it "should return the correct email for user" do
+      assert_equal("kevin@tailorbrands.com", subject.payload.user.email)
+    end
+
+  end
+
+end

data/webhookr-vero.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webhookr-vero/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "webhookr-vero"
+  gem.version       = Webhookr::Vero::VERSION
+  gem.authors       = ["Kevin Smyth"]
+  gem.email         = ["kevin@tailorbrands.com"]
+  gem.description   = "A webhookr extension to support vero webhooks."
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/TailorBrands/webhookr-vero"
+  gem.license       = "MIT"
+
+  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_dependency("webhookr")
+  gem.add_dependency("activesupport", [">= 3.1"])
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: webhookr-vero
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Smyth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webhookr
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A webhookr extension to support vero webhooks.
+email:
+- kevin@tailorbrands.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/webhookr/vero/example_hooks_generator.rb
+- lib/generators/webhookr/vero/init_generator.rb
+- lib/generators/webhookr/vero/templates/vero_hooks.rb
+- lib/webhookr-vero.rb
+- lib/webhookr-vero/version.rb
+- test/generators/webhookr/vero_plugin/init_generator_tests.rb
+- test/test_helper.rb
+- test/unit/webhookr-vero/version_tests.rb
+- test/unit/webhookr-vero_tests.rb
+- webhookr-vero.gemspec
+homepage: http://github.com/TailorBrands/webhookr-vero
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A webhookr extension to support vero webhooks.
+test_files:
+- test/generators/webhookr/vero_plugin/init_generator_tests.rb
+- test/test_helper.rb
+- test/unit/webhookr-vero/version_tests.rb
+- test/unit/webhookr-vero_tests.rb