webhookr 0.2.0 → 0.3.0

data/lib/webhookr/ostruct_utils.rb

@@ -1,28 +1,28 @@
+# frozen_string_literal: true
+
 module Webhookr
   # Adapted from http://www.rebeccamiller-webster.com/2012/06/recursively-convert-a-ruby-hash-to-openstruct/
   module OstructUtils
-
-     def self.to_ostruct(obj)
-        case
-        when obj.kind_of?(Hash)
-          return hash_to_ostruct(obj)
-        when obj.kind_of?(Array)
-          return array_to_ostruct(obj)
+    def self.to_ostruct(obj)
+      case obj
+        when Hash
+          hash_to_ostruct(obj)
+        when Array
+          array_to_ostruct(obj)
         else
-          return obj
-        end
-      end
-
-      def self.hash_to_ostruct(hash)
-        hash.each  do |key, val|
-          hash[key] = to_ostruct(val)
-        end
-        OpenStruct.new(hash)
+          obj
       end
+    end
 
-      def self.array_to_ostruct(array)
-        array.map { |r| to_ostruct(r) }
+    def self.hash_to_ostruct(hash)
+      hash.each do |key, val|
+        hash[key] = to_ostruct(val)
       end
+      OpenStruct.new(hash)
+    end
 
+    def self.array_to_ostruct(array)
+      array.map { |r| to_ostruct(r) }
+    end
   end
-end
+end

data/lib/webhookr/service.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Webhookr
   class Service
     attr_reader :service_name
 
     def initialize(service_name, options = {})
-      @service_name = (service_name || "").downcase
+      @service_name = (service_name || '').downcase
       @raw_payload = options[:payload]
       available?
       validate_security_token(options[:security_token]) if configured_security_token
@@ -17,35 +19,37 @@ module Webhookr
 
     private
 
-    def callback(object, payload)
-      method = method_for(payload)
-      object.send(method, payload) if object.respond_to?(method)
-    end
+      def callback(object, payload)
+        method = method_for(payload)
+        object.send(method, payload) if object.respond_to?(method)
+      end
 
-    def method_for(payload)
-      "on_" + payload.event_type
-    end
+      def method_for(payload)
+        "on_#{payload.event_type}"
+      end
 
-    def callback_class
-      callback = Webhookr.config[service_name].try(:callback)
-      raise "No callback is configured for the service '#{service_name}'." if callback.nil?
-      @call_back_class || callback.new
-    end
+      def callback_class
+        callback = Webhookr.config[service_name].try(:callback)
+        raise Webhookr::MissingCallbackClassError, service_name if callback.nil?
 
-    def configured_security_token
-      Webhookr.config[service_name].try(:security_token)
-    end
+        @call_back_class || callback.new
+      end
 
-    def validate_security_token(token)
-      raise Webhookr::InvalidSecurityTokenError if token.nil? || !SecureCompare.compare(token, configured_security_token)
-    end
+      def configured_security_token
+        Webhookr.config[service_name].try(:security_token)
+      end
 
-    def service_adapter
-      raise NameError.new(%{Bad service name "#{service_name}"}) unless Webhookr.adapters[service_name]
-      @service_adapter ||= Webhookr.adapters[service_name]
-    end
+      def validate_security_token(token)
+        raise Webhookr::InvalidSecurityTokenError if token.nil? || !SecureCompare.compare(token, configured_security_token)
+      end
 
-    alias_method :available?, :service_adapter
+      def service_adapter
+        raise Webhookr::InvalidServiceNameError, service_name unless Webhookr.adapters[service_name]
+        @service_adapter ||= Webhookr.adapters[service_name]
+      end
 
+      def available?
+        !!service_adapter
+      end
   end
 end

data/lib/webhookr/services.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 
 module Webhookr::Services
   extend ActiveSupport::Autoload
 
   autoload :Adapter
 end
-

data/lib/webhookr/services/adapter.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 
 module Webhookr::Services::Adapter
   extend ActiveSupport::Autoload
 
   autoload :Base
 end
-

data/lib/webhookr/services/adapter/base.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 
 module Webhookr::Services::Adapter::Base
   extend ActiveSupport::Concern
 
   included do
-    self.initialize! if self.respond_to?(:initialize!)
+    initialize! if respond_to?(:initialize!)
     Webhookr.adapters[self::SERVICE_NAME] = self
   end
 
@@ -17,4 +18,3 @@ module Webhookr::Services::Adapter::Base
     end
   end
 end
-

data/lib/webhookr/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webhookr
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

data/test/dummy/Rakefile

@@ -1,4 +1,3 @@
-#!/usr/bin/env rake
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
   protect_from_forgery
 end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module ApplicationHelper
 end

data/test/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Dummy::Application

data/test/dummy/config/application.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require File.expand_path('../boot', __FILE__)
 
 # Pick the frameworks you want:
 # require "active_record/railtie"
-require "action_controller/railtie"
-require "sprockets/railtie"
-require "rails/test_unit/railtie"
+require 'action_controller/railtie'
+require 'sprockets/railtie'
+require 'rails/test_unit/railtie'
 
 Bundler.require
-require "webhookr"
+require 'webhookr'
 
 module Dummy
   class Application < Rails::Application
@@ -16,7 +18,7 @@ module Dummy
     # -- all .rb files in that directory are automatically loaded.
 
     # Custom directories with classes and modules you want to be autoloadable.
-    config.autoload_paths += %W(#{config.root}/../../lib)
+    config.autoload_paths += %W{#{config.root}/../../lib}
 
     # Only load the plugins named here, in the order given (default is alphabetical).
     # :all can be used as a placeholder for all plugins not explicitly named.
@@ -34,7 +36,7 @@ module Dummy
     # config.i18n.default_locale = :de
 
     # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
+    config.encoding = 'utf-8'
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
@@ -58,7 +60,5 @@ module Dummy
 
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
-
   end
 end
-

data/test/dummy/config/boot.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'rubygems'
+
 gemfile = File.expand_path('../../../../Gemfile', __FILE__)
 
 if File.exist?(gemfile)
@@ -7,4 +10,4 @@ if File.exist?(gemfile)
   Bundler.setup
 end
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Load the rails application
 require File.expand_path('../application', __FILE__)
 

data/test/dummy/config/environments/development.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
@@ -19,7 +21,6 @@ Dummy::Application.configure do
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 
-
   # Do not compress assets
   config.assets.compress = false
 

data/test/dummy/config/environments/production.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
@@ -60,5 +62,4 @@ Dummy::Application.configure do
 
   # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
-
 end

data/test/dummy/config/environments/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
@@ -9,27 +11,26 @@ Dummy::Application.configure do
 
   # Configure static asset server for tests with Cache-Control for performance
   config.serve_static_assets = true
-  config.static_cache_control = "public, max-age=3600"
+  config.static_cache_control = 'public, max-age=3600'
 
   # Rails 4.0
   config.eager_load = false
 
   # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
+  config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
 
   # Raise exceptions instead of rendering exception templates
   config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  config.action_controller.allow_forgery_protection = false
 
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
   # config.action_mailer.delivery_method = :test
 
-
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
 end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.

data/test/dummy/config/initializers/inflections.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 # Add new inflection rules using the following format

data/test/dummy/config/initializers/mime_types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 # Add new mime types for use in respond_to blocks:

data/test/dummy/config/initializers/secret_token.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 # Your secret key for verifying the integrity of signed cookies.
 # If you change this key, all old signed cookies will become invalid!
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-Dummy::Application.config.secret_key_base = '37ef70b5f837f7a433cdd2a24cfac821c9e6624bccad494de69557a4d95e70d6400afb6c291fed109e417492c84c39d4325f35716fdc6c57cc376aacc72ad512'
+Dummy::Application.config.secret_key_base = '37ef70b5f837f7a433cdd2a24cfac821c9e6624bccad494de69557a4d95e70d6400afb6c291fed109e417492c84c39d4325f35716fdc6c57cc376aacc72ad512'

data/test/dummy/config/initializers/session_store.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information

data/test/dummy/config/initializers/webhookr.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Webhookr.config.basic_auth.username = "admin"
-# Webhookr.config.basic_auth.password = "pass"
+# Webhookr.config.basic_auth.password = "pass"

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 #
 # This file contains settings for ActionController::ParamsWrapper which
@@ -5,6 +7,5 @@
 
 # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
 ActiveSupport.on_load(:action_controller) do
-  wrap_parameters :format => [:json]
+  wrap_parameters format: [:json]
 end
-

data/test/dummy/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
-  mount Webhookr::Engine => "/webhookr", :as => "webhookr"
+  mount Webhookr::Engine => '/webhookr', as: 'webhookr'
 end

data/test/dummy/script/rails

@@ -1,6 +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__)
+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

@@ -1,76 +1,72 @@
+# frozen_string_literal: true
 
-$: << File.join(File.dirname(__FILE__), %w{ .. .. })
+$LOAD_PATH << 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"
+      @security_token = 'secure_blort'
     end
 
-    test ":get with no service id should return a ActionController::RoutingError" do
-      assert_raise(ActionController::RoutingError) {
-        get(:show, {:service_id => ""})
-      }
+    test ':get with no service id should return a ActionController::RoutingError' do
+      assert_raise(ActionController::RoutingError) do
+        get(:show, params: { service_id: '' })
+      end
     end
 
-    test ":get with an unknown service id should return a ActionController::RoutingError" do
-      assert_raise(ActionController::RoutingError) {
-        get(:show, {:service_id => "blort"})
-      }
+    test ':get with an unknown service id should return a ActionController::RoutingError' do
+      assert_raise(ActionController::RoutingError) do
+        get(:show, params: { service_id: 'blort' })
+      end
     end
 
-    test ":get with known service id should return success and an empty body" do
-      get(:show, {:service_id => stub.service_name})
+    test ':get with known service id should return success and an empty body' do
+      get(:show, params: { service_id: stub.service_name })
       assert_response :success
-      assert(@response.body.blank?, "Expected an empty reponse, but got'#{@response.body}'")
+      assert(@response.body.blank?, "Expected an empty reponse, but got '#{@response.body}'")
     end
 
-    test ":post with valid payload should return success" do
+    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 }
-                    }
-           )
+      post(
+        :create,
+        params: {
+          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
+    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})
-      }
+
+      assert_raise(ActionController::InvalidAuthenticityToken) do
+        get(:show, params: { service_id: stub.service_name })
+      end
     end
 
-    test ":get with :security_token configured and passed should return :success" do
+    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})
+      get(
+        :show,
+        params: {
+          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