webhookr 0.2.0 → 0.3.0

data/test/functional/webhookr/events_routes_test.rb

@@ -1,33 +1,40 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module Webhookr
   class EventsRoutesTest < ActionController::TestCase
-
     def setup
       @routes = Webhookr::Engine.routes
-      @show_controller = { :format => "json", :controller => "webhookr/events", :action => "show", :service_id => "service_id" }
-      @show_controller_with_token = @show_controller.merge({ :security_token => "secure" })
-      @create_controller = { :format => "json", :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"
+      @show_controller = { format: 'json', controller: 'webhookr/events', action: 'show', service_id: 'service_id' }
+      @show_controller_with_token = @show_controller.merge(security_token: 'secure')
+      @create_controller = { format: 'json', 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 })
+    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 })
+    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 })
+    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 })
+    test ':post route to events with optional :security_token' do
+      assert_recognizes(@create_controller_with_token, path: @path_with_token, method: :post)
     end
 
+    test 'non-JSON routes' do
+      @show_controller[:format] = 'xml'
+      @create_controller[:format] = 'xml'
+      assert_recognizes(@show_controller, path: "#{@path}.xml", method: :get)
+      assert_recognizes(@create_controller, path: "#{@path}.xml", method: :post)
+    end
   end
 end

data/test/functional/webhookr/service_test.rb

@@ -1,42 +1,45 @@
+# frozen_string_literal: true
+
 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) {
+    test 'should raise Webhookr::InvalidServiceNameError for a nil service' do
+      assert_raise(Webhookr::InvalidServiceNameError) do
         Webhookr::Service.new(nil)
-      }
+      end
     end
 
-    test "should raise NameError for an unknown service" do
-      assert_raise(NameError) {
-        Webhookr::Service.new("unknown_service")
-      }
+    test 'should raise Webhookr::InvalidServiceNameError for an unknown service' do
+      assert_raise(Webhookr::InvalidServiceNameError) do
+        Webhookr::Service.new('unknown_service')
+      end
     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!
-      }
+    test 'should raise a Webhookr::InvalidPayloadError for an invalid payload' do
+      assert_raise(Webhookr::InvalidPayloadError) do
+        Webhookr::Service.new(
+          stub.service_name,
+          payload: 'blort'
+        ).process!
+      end
     end
 
-    test "should raise a Runtime error if there is no callback class configured" do
+    test 'should raise a Webhookr::MissingCallbackClassError 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!
-      }
+      assert_raise(Webhookr::MissingCallbackClassError) do
+        Webhookr::Service.new(
+          stub.service_name,
+          payload: stub.payload
+        ).process!
+      end
     end
-
   end
 
   class ServiceTest < ActiveSupport::TestCase
-
     include Webhookr::ServiceUnderTest
 
     def setup
@@ -44,47 +47,49 @@ module Webhookr
       PlainOldCallBackClass.reset!
     end
 
-    test "should accept a callback class configuration" do
-      assert_nothing_raised {
+    test 'should accept a callback class configuration' do
+      assert_nothing_raised do
         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
     end
 
-    test "a service should be initialized" do
-      # pending "more time" do
-      #   assert_false
-      # end
+    test 'process! should not raise a Webhookr::InvalidPayloadError for a valid payload' do
+      assert_nothing_raised do
+        Webhookr::Service.new(
+          stub.service_name,
+          payload: stub.payload
+        ).process!
+      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!
-      }
+    test 'process! should silently ignore on_event not present in callback class' do
+      assert_nothing_raised do
+        Webhookr::Service.new(
+          stub.service_name,
+          payload: stub(event_type: 'no_event').payload
+        ).process!
+      end
     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!
+    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!
+    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!
+    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

data/test/integration/webhookr/add_route_generator_test.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
 
-$: << File.join(File.dirname(__FILE__), %w{ .. .. })
+$LOAD_PATH << 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__))
+  destination File.expand_path('../../../tmp', File.dirname(__FILE__))
   setup :prepare_destination
 
-  test "it should add the engine to routes" do
+  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
+end

data/test/integration/webhookr/init_generator_test.rb

@@ -1,27 +1,28 @@
+# frozen_string_literal: true
 
-$: << File.join(File.dirname(__FILE__), %w{ .. .. })
+$LOAD_PATH << 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__))
+  destination File.expand_path('../../../tmp', File.dirname(__FILE__))
   setup :prepare_destination
 
   def setup
-    @name = "test_initializer"
+    @name = 'test_initializer'
     @initializer = "config/initializers/#{@name}.rb"
     run_generator Array.wrap(@name)
   end
 
-  test "it should create the initializer" do
+  test 'it should create the initializer' do
     assert_file @initializer
   end
 
-  test "it should have authorization information" do
+  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
+end

data/test/stubs/service_under_test_stubs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webhookr
   module ServiceUnderTest
     class Adapter
@@ -7,22 +9,19 @@ module Webhookr
 
       class << self
         def process(payload)
-          [*payload].collect do |p|
+          [ *payload ].collect do |p|
             p = Rack::Utils.parse_nested_query(p)
             validate(payload)
-            OpenStruct.new({
-              :event_type => p["event"],
-              :data => OpenStruct.new(p["data"])
-            })
+            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
+          raise Webhookr::InvalidPayloadError, payload if payload.nil? || payload == 'blort'
         end
-
       end
     end
   end
@@ -30,44 +29,38 @@ end
 
 module Webhookr
   module ServiceUnderTest
-
     def stub(options = {})
       ops = {
-        :service_name => "service_under_test",
-        :event_type => "test_event",
-        :email => "gerry@zoocasa.com"
+        service_name: 'service_under_test',
+        event_type: 'test_event',
+        email: 'foo@example.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]
-       })
+      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
+  @call_count = 0
+  @email = nil
 
   def self.reset!
-    @@call_count = 0
-    @@email = nil
-  end
-
-  def self.call_count
-    @@call_count
+    @call_count = 0
+    @email = nil
   end
 
-  def self.email
-    @@email
+  class << self
+    attr_accessor :call_count, :email
   end
 
   def on_test_event(payload)
-    @@call_count += 1
-    @@email = payload.data.email
+    self.class.call_count += 1
+    self.class.email = payload.data.email
   end
-end
+end

data/test/test_helper.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 require 'coveralls'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
-]
-SimpleCov.command_name("Webhookr Tests")
+])
+SimpleCov.command_name('Webhookr Tests')
 SimpleCov.start
 
 # Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
+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"
+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!
 
@@ -26,4 +28,3 @@ MiniTest::Reporters.use!(MiniTest::Reporters::SpecReporter.new)
 puts "Webhookr #{Webhookr::VERSION}"
 puts "Rails #{Rails::VERSION::STRING}"
 puts "Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} - #{RbConfig::CONFIG['RUBY_INSTALL_NAME']}"
-

data/test/unit/webhookr/adapter_response_test.rb

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

data/test/unit/webhookr/ostruct_utils_test.rb

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