RubyGems - webhookr - Versions diffs - 0.0.2 - Mend

webhookr 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (68) hide show

data/.gitignore +14 -0
data/Gemfile +18 -0
data/Guardfile +31 -0
data/MIT-LICENSE +22 -0
data/README.md +159 -0
data/Rakefile +46 -0
data/app/controllers/webhookr/events_controller.rb +34 -0
data/config/routes.rb +4 -0
data/lib/generators/webhookr/add_route_generator.rb +12 -0
data/lib/generators/webhookr/init_generator.rb +30 -0
data/lib/tasks/webhookr_tasks.rake +16 -0
data/lib/webhookr/adapter_response.rb +3 -0
data/lib/webhookr/engine.rb +16 -0
data/lib/webhookr/invalid_payload_error.rb +3 -0
data/lib/webhookr/invalid_security_token_error.rb +3 -0
data/lib/webhookr/ostruct_utils.rb +28 -0
data/lib/webhookr/service.rb +51 -0
data/lib/webhookr/services/adapter/base.rb +20 -0
data/lib/webhookr/services/adapter.rb +7 -0
data/lib/webhookr/services.rb +7 -0
data/lib/webhookr/version.rb +3 -0
data/lib/webhookr.rb +24 -0
data/script/rails +8 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +15 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/mailers/.gitkeep +0 -0
data/test/dummy/app/models/.gitkeep +0 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/config/application.rb +65 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +31 -0
data/test/dummy/config/environments/production.rb +64 -0
data/test/dummy/config/environments/test.rb +35 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/webhookr.rb +2 -0
data/test/dummy/config/initializers/wrap_parameters.rb +10 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +3 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/lib/assets/.gitkeep +0 -0
data/test/dummy/log/.gitkeep +0 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/functional/webhookr/events_controller_test.rb +76 -0
data/test/functional/webhookr/events_routes_test.rb +33 -0
data/test/functional/webhookr/service_test.rb +91 -0
data/test/integration/webhookr/add_route_generator_test.rb +15 -0
data/test/integration/webhookr/init_generator_test.rb +27 -0
data/test/stubs/service_under_test_stubs.rb +73 -0
data/test/test_helper.rb +18 -0
data/test/unit/webhookr/Services/ServiceUnderTest/adapter_test.rb +39 -0
data/test/unit/webhookr/adapter_response_test.rb +20 -0
data/test/unit/webhookr/ostruct_utils_test.rb +32 -0
data/test/webhookr_test.rb +11 -0
data/webhookr.gemspec +22 -0
metadata +171 -0

data/test/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/test/dummy/public/favicon.ico ADDED Viewed

File without changes

data/test/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/functional/webhookr/events_controller_test.rb ADDED Viewed

@@ -0,0 +1,76 @@
+$: << File.join(File.dirname(__FILE__), %w{ .. .. })
+require 'test_helper'
+require 'stubs/service_under_test_stubs'
+module Webhookr
+  class EventsControllerTest < ActionController::TestCase
+    include Webhookr::ServiceUnderTest
+    def setup
+      @routes = Webhookr::Engine.routes
+      PlainOldCallBackClass.reset!
+      Webhookr::ServiceUnderTest::Adapter.config.security_token = nil
+      @security_token = "secure_blort"
+    end
+    test ":get with no service id should return a ActionController::RoutingError" do
+      assert_raise(ActionController::RoutingError) {
+        get(:show)
+      }
+    end
+    test ":get with an unknown service id should return a ActionController::RoutingError" do
+      assert_raise(ActionController::RoutingError) {
+        get(:show, {:service_id => "blort"})
+      }
+    end
+    test ":get with known service id should return success and an empty body" do
+      get(:show, {:service_id => stub.service_name})
+      assert_response :success
+      assert(@response.body.blank?, "Expected an empty reponse, but got'#{@response.body}'")
+    end
+    test ":post with valid payload should return success" do
+      PlainOldCallBackClass.reset!
+      Webhookr::ServiceUnderTest::Adapter.config.callback = PlainOldCallBackClass
+      post(:create, {
+                      :service_id => stub.service_name,
+                      :event => stub.event_type,
+                      :data => { :email => stub.email }
+                    }
+           )
+      assert_equal 1, PlainOldCallBackClass.call_count
+    end
+    test ":get with :security_token configured and not passed should return :InvalidAuthenticityToken" do
+      Webhookr::ServiceUnderTest::Adapter.config.security_token = @security_token
+      assert_raise(ActionController::InvalidAuthenticityToken) {
+        get(:show, {:service_id => stub.service_name})
+      }
+    end
+    test ":get with :security_token configured and passed should return :success" do
+      Webhookr::ServiceUnderTest::Adapter.config.security_token = @security_token
+      get(:show, {:service_id => stub.service_name, :security_token => @security_token})
+      assert_response(:success)
+    end
+    test "basic auth will prevent unauthorized access" do
+      # pending "more time" do
+      #   Webhookr.config.basic_auth.username = "admin"
+      #   Webhookr.config.basic_auth.password = "password"
+      #
+      #   post(:create, {
+      #                   :service_id => stub.service_name,
+      #                   :event => stub.event
+      #                 }
+      #        )
+      #   assert_response :unauthorized
+      # end
+    end
+  end
+end

data/test/functional/webhookr/events_routes_test.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require 'test_helper'
+module Webhookr
+  class EventsRoutesTest < ActionController::TestCase
+    def setup
+      @routes = Webhookr::Engine.routes
+      @show_controller = { :controller => "webhookr/events", :action => "show", :service_id => "service_id" }
+      @show_controller_with_token = @show_controller.merge({ :security_token => "secure" })
+      @create_controller = { :controller => "webhookr/events", :action => "create", :service_id => "service_id" }
+      @create_controller_with_token = @create_controller.merge({ :security_token => "secure" })
+      @path = "/events/service_id"
+      @path_with_token = "/events/service_id/secure"
+    end
+    test ":get route to events" do
+      assert_recognizes(@show_controller, { :path => @path, :method => :get })
+    end
+    test ":get route to events with optional :security_token" do
+      assert_recognizes(@show_controller_with_token, { :path => @path_with_token, :method => :get })
+    end
+    test ":post route to events" do
+      assert_recognizes(@create_controller, { :path => @path, :method => :post })
+    end
+    test ":post route to events with optional :security_token" do
+      assert_recognizes(@create_controller_with_token, { :path => @path_with_token, :method => :post })
+    end
+  end
+end

data/test/functional/webhookr/service_test.rb ADDED Viewed

@@ -0,0 +1,91 @@
+require 'test_helper'
+require 'stubs/service_under_test_stubs'
+module Webhookr
+  class ServiceTest < ActiveSupport::TestCase
+    include Webhookr::ServiceUnderTest
+    test "should raise NameError for a nil service" do
+      assert_raise(NameError) {
+        Webhookr::Service.new(nil)
+      }
+    end
+    test "should raise NameError for an unknown service" do
+      assert_raise(NameError) {
+        Webhookr::Service.new("unknown_service")
+      }
+    end
+    test "should raise a Webhookr::InvalidPayloadError for an invalid payload" do
+      assert_raise(Webhookr::InvalidPayloadError) {
+        Webhookr::Service.new(stub.service_name,
+                              :payload => "blort").process!
+      }
+    end
+    test "should raise a Runtime error if there is no callback class configured" do
+      Webhookr::ServiceUnderTest::Adapter.config.callback = nil
+      assert_raise(RuntimeError) {
+        Webhookr::Service.new(stub.service_name,
+                              :payload => stub.payload).process!
+      }
+    end
+  end
+  class ServiceTest < ActiveSupport::TestCase
+    include Webhookr::ServiceUnderTest
+    def setup
+      Webhookr::ServiceUnderTest::Adapter.config.callback = PlainOldCallBackClass
+      PlainOldCallBackClass.reset!
+    end
+    test "should accept a callback class configuration" do
+      assert_nothing_raised {
+        Webhookr::ServiceUnderTest::Adapter.config.callback = Object
+      }
+    end
+    test "process! should not raise a Webhookr::InvalidPayloadError for a valid payload" do
+      assert_nothing_raised {
+        Webhookr::Service.new(stub.service_name,
+                              :payload => stub.payload).process!
+      }
+    end
+    test "a service should be initialized" do
+      # pending "more time" do
+      #   assert_false
+      # end
+    end
+    test "process! should silently ignore on_event not present in callback class" do
+      assert_nothing_raised {
+        Webhookr::Service.new(stub.service_name,
+                              :payload => stub(:event_type => "no_event").payload).process!
+      }
+    end
+    test "process! should call the on_event method of the callback class for a valid payload" do
+      Webhookr::Service.new(stub.service_name, :payload => stub.payload).process!
+      assert_equal PlainOldCallBackClass.call_count, 1
+    end
+    test "process! should have the payload data email" do
+      email = "test@test.com"
+      Webhookr::Service.new(stub.service_name,
+                            :payload => stub(:email => email).payload).process!
+      assert_equal(email, PlainOldCallBackClass.email)
+    end
+    test "process! should process multiple records" do
+      Webhookr::Service.new(stub.service_name,
+                            :payload => [ stub.payload, stub.payload ]).process!
+      assert_equal 2, PlainOldCallBackClass.call_count
+    end
+  end
+end

data/test/integration/webhookr/add_route_generator_test.rb ADDED Viewed

@@ -0,0 +1,15 @@
+$: << File.join(File.dirname(__FILE__), %w{ .. .. })
+require 'test_helper'
+require 'generators/webhookr/add_route_generator'
+class InitGeneratorTest < Rails::Generators::TestCase
+  tests Webhookr::Generators::AddRouteGenerator
+  destination File.expand_path("../../../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+  test "it should add the engine to routes" do
+    run_generator
+    # TODO: Not sure how to confirm the route was added, so just run it for now
+  end
+end

data/test/integration/webhookr/init_generator_test.rb ADDED Viewed

@@ -0,0 +1,27 @@
+$: << File.join(File.dirname(__FILE__), %w{ .. .. })
+require 'test_helper'
+require 'generators/webhookr/init_generator'
+class InitGeneratorTest < Rails::Generators::TestCase
+  tests Webhookr::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{basic_auth\.username}, content)
+      assert_match(%r{basic_auth\.password}, content)
+    end
+  end
+end

data/test/stubs/service_under_test_stubs.rb ADDED Viewed

@@ -0,0 +1,73 @@
+module Webhookr
+  module ServiceUnderTest
+    class Adapter
+      SERVICE_NAME = 'service_under_test'
+      include Webhookr::Services::Adapter::Base
+      class << self
+        def process(payload)
+          [*payload].collect do |p|
+            p = Rack::Utils.parse_nested_query(p)
+            validate(payload)
+            OpenStruct.new({
+              :event_type => p["event"],
+              :data => OpenStruct.new(p["data"])
+            })
+          end
+        end
+        def validate(payload)
+          if payload.nil? || payload == "blort"
+            raise Webhookr::InvalidPayloadError.new("'#{payload}' is not valid")
+          end
+        end
+      end
+    end
+  end
+end
+module Webhookr
+  module ServiceUnderTest
+    def stub(options = {})
+      ops = {
+        :service_name => "service_under_test",
+        :event_type => "test_event",
+        :email => "gerry@zoocasa.com"
+      }.merge(options)
+      OpenStruct.new({
+        :payload => "event=#{ops[:event_type]}&data[email]=#{ops[:email]}",
+        :service_name => ops[:service_name],
+        :event_type => ops[:event_type],
+        :email => ops[:email]
+       })
+    end
+  end
+end
+class PlainOldCallBackClass
+  @@call_count = 0
+  @@email = nil
+  def self.reset!
+    @@call_count = 0
+    @@email = nil
+  end
+  def self.call_count
+    @@call_count
+  end
+  def self.email
+    @@email
+  end
+  def on_test_event(payload)
+    @@call_count += 1
+    @@email = payload.data.email
+  end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require 'simplecov'
+SimpleCov.start
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+require "rails/generators/test_case"
+require "minitest/reporters"
+Rails.backtrace_cleaner.remove_silencers!
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+MiniTest::Reporters.use!(MiniTest::Reporters::SpecReporter.new)

data/test/unit/webhookr/Services/ServiceUnderTest/adapter_test.rb ADDED Viewed

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'stubs/service_under_test_stubs'
+module Webhookr
+  module Services
+    class ServiceUnderTest::AdapterTest < ActiveSupport::TestCase
+      def setup
+        @event_type = "test_event"
+        @data_msg = "Hello world!"
+        @valid_response = "event=#{@event_type}&data[msg]=#{@data_msg}"
+        @invalid_response = "blort"
+     end
+      test "should not raise an exception for a valid payload" do
+        assert_nothing_raised {
+          Webhookr::ServiceUnderTest::Adapter.process(@valid_response)
+        }
+      end
+      test "should raise an exception for a invalid payload" do
+        assert_raise(Webhookr::InvalidPayloadError) {
+          Webhookr::ServiceUnderTest::Adapter.process(@invalid_response)
+        }
+      end
+      test "should repond with the correct event" do
+        responses = Webhookr::ServiceUnderTest::Adapter.process(@valid_response)
+        assert_equal(@event_type, responses.first.event_type)
+      end
+      test "should respond with valid data" do
+        responses = Webhookr::ServiceUnderTest::Adapter.process(@valid_response)
+        assert_equal(@data_msg, responses.first.data.msg)
+      end
+    end
+  end
+end

data/test/unit/webhookr/adapter_response_test.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require 'test_helper'
+class AdapterResponseTest < ActiveSupport::TestCase
+  def setup
+    @subject = Webhookr::AdapterResponse.new("service_name", "event_type", "payload")
+  end
+  test "should respond to event_type" do
+    assert_respond_to(@subject, :event_type)
+  end
+  test "should respond to payload" do
+    assert_respond_to(@subject, :payload)
+  end
+  test "should respond to service_name" do
+    assert_respond_to(@subject, :service_name)
+  end
+end

data/test/unit/webhookr/ostruct_utils_test.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require 'test_helper'
+require 'webhookr/ostruct_utils'
+require 'ostruct'
+class OstructUtilsTest < ActiveSupport::TestCase
+  def setup
+    @hash = { :a => { :b => { :c => 1 } }, :a1 => [ { :b1 => { :c1 => 1 } } ] }
+    @converted = Webhookr::OstructUtils.to_ostruct(@hash)
+  end
+  test "should be an OpenStruct" do
+    assert(@converted.is_a?(OpenStruct))
+  end
+  test "should have a nested OpenStruct" do
+    assert(@converted.a.is_a?(OpenStruct))
+  end
+  test "should have a nested nested OpenStruct" do
+    assert(@converted.a.b.is_a?(OpenStruct))
+  end
+  test "should have a nested nested nested value of 1" do
+    assert(@converted.a.b.c == 1)
+  end
+  test "should replace a nested hash in an array" do
+    assert(@converted.a1.first.b1.c1 == 1)
+  end
+end

data/test/webhookr_test.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'test_helper'
+class WebhookrTest < ActiveSupport::TestCase
+  test "should have Webhookr configuration" do
+    assert_kind_of Hash, Webhookr.config
+  end
+  test "should have a basic_auth hash" do
+    assert_kind_of Hash, Webhookr.config.basic_auth
+  end
+end

data/webhookr.gemspec ADDED Viewed

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/webhookr/version', __FILE__)
+Gem::Specification.new do |s|
+  s.name = "webhookr"
+  s.version = Webhookr::VERSION
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gerry Power"]
+  s.email = ["code@zoocasa.com"]
+  s.description = "Webhookr - easily and securely add webhooks to your Rails app."
+  s.summary = s.description
+  s.files = `git ls-files`.split($\)
+  s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.homepage = "http://github.com/zoocasa/webhookr"
+  s.require_paths = ["lib"]
+  s.add_dependency "rails", ["~> 3.1"]
+end