critsend_events 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/.rvmrc

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+ruby_string="ruby-1.9.3"
+gemset_name="critsend_events"
+
+if rvm list strings | grep -q "${ruby_string}" ; then
+
+  # Load or create the specified environment
+  if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+    && -s "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}" ]] ; then
+    \. "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}"
+  else
+    rvm --create  "${ruby_string}@${gemset_name}"
+  fi
+
+else
+
+  # Notify the user to install the desired interpreter before proceeding.
+  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into the project directory."
+
+fi

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v1.0.0
+
+* Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alexander Glushkov
+
+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,60 @@
+# CritsendEvents
+
+Accepts Critsend events with Ruby on Rails.  
+I hope that it will work with any Rack-based application, but I didn't verify that.
+
+Check the [Critsend Event API](http://www.critsend.com/event-api/) for reference.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'critsend_events'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install critsend_events
+
+## Usage
+
+- install it
+- add middleware
+- write an event receiver
+- add config to initializers with Critsend authentication key
+
+```ruby
+# application.rb
+
+config.middleware.use "CritsendEvents::WebhookReceiver", "CritsendEventsReceiver"
+
+
+
+# app/models/critsend_events_receiver.rb
+
+class CritsendEventsReceiver
+  def handle(events)
+    Rails.logger.info "Events from Critsend: #{events.inspect}"
+  end
+end
+
+
+
+# config/initializers/critsend_config.rb
+
+CritsendEvents::Config.setup do |config|
+  config.authentication_key = ENV["CRITSEND_WEBHOOKS_AUTH_KEY"]
+  # config.mount_point = "/critsend/receiver" // optional, default
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/critsend_events.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/critsend_events/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors         = ["Alexander Glushkov"]
+  gem.email           = ["cutalion@gmail.com"]
+  gem.description     = %q{}
+  gem.summary         = %q{Accepts Critsend events with Ruby on Rails}
+  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.name            = "critsend_events"
+  gem.require_paths   = ["lib"]
+  gem.version         = CritsendEvents::VERSION
+  gem.add_dependency  'json'
+
+  gem.add_development_dependency 'rspec', '~> 2.0'
+  gem.add_development_dependency 'rake'
+end

data/lib/critsend_events.rb

@@ -0,0 +1,8 @@
+require 'openssl'
+require 'json'
+
+require "critsend_events/version"
+require "critsend_events/config"
+require "critsend_events/signature_generator"
+require "critsend_events/webhook_processor"
+require "critsend_events/webhook_receiver"

data/lib/critsend_events/config.rb

@@ -0,0 +1,17 @@
+module CritsendEvents
+  class Config
+    class << self
+      def mount_point; @@mount_point; end
+      def mount_point=(val); @@mount_point = val; end
+      @@mount_point = "/critsend/receiver"
+
+      def authentication_key; @@authentication_key; end
+      def authentication_key=(val); @@authentication_key = val; end
+      @@authentication_key = ""
+
+      def setup
+        yield self
+      end
+    end
+  end
+end

data/lib/critsend_events/signature_generator.rb

@@ -0,0 +1,8 @@
+module CritsendEvents
+  class SignatureGenerator
+    def self.generate(secret_key, message)
+      digest = OpenSSL::Digest::Digest.new('sha256')
+      OpenSSL::HMAC.hexdigest(digest, secret_key, message)
+    end
+  end
+end

data/lib/critsend_events/version.rb

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

data/lib/critsend_events/webhook_processor.rb

@@ -0,0 +1,24 @@
+module CritsendEvents
+  class WebhookProcessor
+    attr_reader :handler
+    def initialize(handler)
+      handler = constantize(handler).new if handler.is_a?(String)
+      @handler = handler
+    end
+
+    def process(data)
+      events = JSON.parse(data)
+      @handler.handle(events) if @handler.respond_to?(:handle)
+    end
+
+    private
+
+    def constantize(handler)
+      if handler.respond_to?(:constantize)
+        handler.constantize
+      else
+        Module.const_get(handler)
+      end
+    end
+  end
+end

data/lib/critsend_events/webhook_receiver.rb

@@ -0,0 +1,57 @@
+require File.expand_path(__FILE__, 'signature_generator')
+require File.expand_path(__FILE__, 'config')
+
+module CritsendEvents
+  class WebhookReceiver
+    attr_reader :processor
+
+    def initialize(app, handler)
+      @app = app
+      @processor = WebhookProcessor.new(handler)
+    end
+
+    def call(env)
+      if events_posted?(env)
+        receive_events(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def events_posted?(env)
+      return false if env["REQUEST_METHOD"].to_s != "POST"
+      return env["PATH_INFO"].to_s == Config.mount_point
+    end
+
+    def receive_events(env)
+      if request_signed?(env)
+        process(env)
+        [200, {"Content-Type" => "application/json"}, StringIO.new("")]
+      else
+        [403, {"Content-Type" => "application/json"}, StringIO.new('{"error": "Invalid payload according to our webhooks key"}')]
+      end
+    end
+
+    def process(env)
+      env['rack.input'].rewind
+      data = env['rack.input'].read
+      processor.process data
+    end
+
+    def request_signed?(env)
+      critsend_signature = env["HTTP_X_CRITSEND_WEBHOOKS_SIGNATURE"]
+      data               = env['rack.input'].read
+      secret_key         = Config.authentication_key
+      our_signature      = SignatureGenerator.generate(secret_key, data)
+
+      valid_signature?(critsend_signature, our_signature)
+    end
+
+    def valid_signature?(their_signature, our_signature)
+      return false if their_signature.to_s.empty?
+      our_signature === their_signature
+    end
+  end
+end

data/spec/lib/critsend_events/webhook_processor_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe CritsendEvents::WebhookProcessor do
+  class TestHandler
+    def handle(*args); end
+  end
+
+  it "should initialize handler if handler is a string" do
+    processor = CritsendEvents::WebhookProcessor.new("TestHandler")
+    processor.handler.should be_a TestHandler
+  end
+
+  describe ".process" do
+    let(:raw_data)    { '[{"category": "soft_bounce"}]' }
+    let(:parsed_data) { JSON.parse(raw_data) }
+    let(:handler)     { TestHandler.new }
+
+    it "should convert raw data to json and pass it to registered handler" do
+      processor = CritsendEvents::WebhookProcessor.new(handler)
+      handler.should_receive(:handle).with(parsed_data)
+      processor.process(raw_data)
+    end
+  end
+end

data/spec/lib/critsend_events/webhook_receiver_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe CritsendEvents::WebhookReceiver do
+  let(:app)         { stub }
+  let(:handler)     { stub }
+  let(:middleware)  { CritsendEvents::WebhookReceiver.new(app, handler) }
+  let(:env)         { Hash.new }
+  let(:events_json) { "[]" }
+  before { CritsendEvents::Config.stub authentication_key: "key" }
+
+  context "if events posted" do
+    let(:env) { {"REQUEST_METHOD" => "POST", "PATH_INFO" => CritsendEvents::Config.mount_point} }
+    describe "receive events" do
+      before { env["rack.input"] = StringIO.new(events_json) }
+
+      context "if request not signed" do
+        it "should response with 403 Forbidden" do
+          response.status.should                  == 403
+          response.body.should                    == '{"error": "Invalid payload according to our webhooks key"}'
+          response.headers["Content-Type"].should == "application/json"
+        end
+      end
+
+      context "if request signed" do
+        before { env["HTTP_X_CRITSEND_WEBHOOKS_SIGNATURE"] = CritsendEvents::SignatureGenerator.generate(CritsendEvents::Config.authentication_key, events_json) }
+
+        it "should response with 200 OK" do
+          response.body.should                    == ''
+          response.status.should                  == 200
+          response.headers["Content-Type"].should == "application/json"
+        end
+
+        it "should call registered handler" do
+          middleware.processor.should_receive(:process).with(events_json)
+          middleware.call(env)
+        end
+      end
+
+      context "if request has incorrect signature" do
+        before { env["HTTP_X_CRITSEND_WEBHOOKS_SIGNATURE"] = "wrong-signature" }
+
+        it "should response with 403 Forbidden" do
+          response.status.should                  == 403
+          response.body.should                    == '{"error": "Invalid payload according to our webhooks key"}'
+          response.headers["Content-Type"].should == "application/json"
+        end
+      end
+    end
+  end
+
+  context "if events not posted" do
+    context "REQUEST_METHOD not POST" do
+      let(:env) { {"REQUEST_METHOD" => "GET", "PATH_INFO" => CritsendEvents::Config.mount_point} }
+      it "should pass the request to next middleware" do
+        app.should_receive(:call).with(env)
+        middleware.call(env)
+      end
+    end
+    context "PATH_INFO does not equal to mount point" do
+      let(:env) { {"REQUEST_METHOD" => "POST", "PATH_INFO" => "/"} }
+      it "should pass the request to next middleware" do
+        app.should_receive(:call).with(env)
+        middleware.call(env)
+      end
+    end
+  end
+
+  class Response < Struct.new(:status, :headers, :body)
+    def body
+      self[:body].read
+    end
+  end
+
+  def response
+    env["rack.input"].rewind
+    Response.new(*middleware.call(env))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'critsend_events'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: critsend_events
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Glushkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: ''
+email:
+- cutalion@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- critsend_events.gemspec
+- lib/critsend_events.rb
+- lib/critsend_events/config.rb
+- lib/critsend_events/signature_generator.rb
+- lib/critsend_events/version.rb
+- lib/critsend_events/webhook_processor.rb
+- lib/critsend_events/webhook_receiver.rb
+- spec/lib/critsend_events/webhook_processor_spec.rb
+- spec/lib/critsend_events/webhook_receiver_spec.rb
+- 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'
+      segments:
+      - 0
+      hash: -4088613327361974571
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4088613327361974571
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Accepts Critsend events with Ruby on Rails
+test_files:
+- spec/lib/critsend_events/webhook_processor_spec.rb
+- spec/lib/critsend_events/webhook_receiver_spec.rb
+- spec/spec_helper.rb