webhookr 0.2.0 → 0.3.0

data/.travis.yml

@@ -1,13 +1,13 @@
 language: ruby
 rvm:
-  - "1.9.3"
-  - "2.0.0"
-  - jruby-19mode # JRuby in 1.9 mode
-  - ruby-head
+  - 2.5.0
+  - 2.4.3
+  - 2.3.6
+  - 2.2.9
+  - jruby
 env:
-  - RAILS_VERSION=4.0.0
-  - RAILS_VERSION=3.2.13
-  - RAILS_VERSION=3.1.12
+  - RAILS_VERSION=5.1
+  - RAILS_VERSION=4.2
 matrix:
   allow_failures:
-    - rvm: ruby-head
+    - rvm: jruby

data/Gemfile

@@ -1,21 +1,18 @@
-source "http://rubygems.org"
+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')
+  gem 'coveralls', require: false
+  gem 'em-websocket'
+  gem 'guard'
+  gem 'guard-livereload'
+  gem 'guard-markdown'
+  gem 'guard-minitest'
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'rake', '~> 10.0'
+  gem 'simplecov', require: false
 end
 
+instance_eval File.read('Gemfile.local') if File.exist?('Gemfile.local')

data/Guardfile

@@ -1,31 +1,28 @@
 
-guard 'minitest', :test_folders => 'test', :test_file_patterns => '*_test.rb' do
+guard 'minitest', test_folders: 'test', test_file_patterns: '*_test.rb' do
   watch(%r|^test/(.+)_test\.rb|)
-  watch(%r|^test/stubs/(.+)\.rb$|) { "test" }
+  watch(%r|^test/stubs/(.+)\.rb$|) { 'test' }
 
   # Rails
-  watch(%r{^app/models/(.+)\.rb$}) { |m|
+  watch(%r{^app/models/(.+)\.rb$}) do |m|
     "test/unit/#{m[1]}_test.rb"
-  }
+  end
 
-  watch(%r{^app/controllers/(.+)\.rb$}) { |m|
+  watch(%r{^app/controllers/(.+)\.rb$}) do |m|
     "test/functional/#{m[1]}_test.rb"
-  }
+  end
 
-  watch('config/routes.rb') {
-    ["test/functional", "test/integration"]
-  }
+  watch('config/routes.rb') do
+    ['test/functional', 'test/integration']
+  end
 end
 
 guard 'livereload' do
   watch('README.html')
 end
 
-guard 'markdown', :convert_on_start => true do
- watch ('README.md') { "./README.md|./README.html" }
-end
-
-if File.exists?('Guardfile.local')
-  instance_eval File.read('Guardfile.local')
+guard 'markdown', convert_on_start: true do
+  watch('README.md') { './README.md|./README.html' }
 end
 
+instance_eval File.read('Guardfile.local') if File.exist?('Guardfile.local')

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 2167961 Ontario Inc., Zoocasa <code@zoocasa.com>
+Copyright (c) 2012-2017 J Smith <dark.panda@gmail.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,8 +1,8 @@
 # webhookr: Rails Webhooks Made Easy
-[![Build Status](https://travis-ci.org/zoocasa/webhookr.png?branch=master)](https://travis-ci.org/zoocasa/webhookr)
-[![Dependency Status](https://gemnasium.com/zoocasa/webhookr.png)](https://gemnasium.com/zoocasa/webhookr)
-[![Code Climate](https://codeclimate.com/github/zoocasa/webhookr.png)](https://codeclimate.com/github/zoocasa/webhookr)
-[![Coverage Status](https://coveralls.io/repos/zoocasa/webhookr/badge.png?branch=master)](https://coveralls.io/r/zoocasa/webhookr?branch=master)
+[![Build Status](https://travis-ci.org/dark-panda/webhookr.png?branch=master)](https://travis-ci.org/dark-panda/webhookr)
+[![Dependency Status](https://gemnasium.com/dark-panda/webhookr.png)](https://gemnasium.com/dark-panda/webhookr)
+[![Code Climate](https://codeclimate.com/github/dark-panda/webhookr.png)](https://codeclimate.com/github/dark-panda/webhookr)
+[![Coverage Status](https://coveralls.io/repos/dark-panda/webhookr/badge.png?branch=master)](https://coveralls.io/r/dark-panda/webhookr?branch=master)
 
 ## <a name="introduction"></a>Introduction
 
@@ -59,7 +59,7 @@ end
 ## <a name="usage"></a>Usage & Setup
 
 webhookr works with Rails 3.1 onwards. It generally requires a plugin to be
-useful, such as the [MailChimp plugin](https://github.com/zoocasa/webhookr-mailchimp).
+useful, such as the [MailChimp plugin](https://github.com/dark-panda/webhookr-mailchimp).
 
 ## Setup
 
@@ -130,9 +130,10 @@ If you are sending sensitive data via webhooks, it is recommended you use HTTPS.
 
 ### <a name="supported_services"></a>Supported Services
 
-* MailChimp - [webhookr-mail_chimp](https://github.com/zoocasa/webhookr-mailchimp)
+* MailChimp - [webhookr-mail_chimp](https://github.com/dark-panda/webhookr-mailchimp)
 * Mandrill - [webhookr-mandrill](https://github.com/gerrypower/webhookr-mandrill)
 * Stripe - [webhookr-stripe](https://github.com/gerrypower/webhookr-stripe)
+* Recurly - [webhookr-recurly](https://github.com/tfe/webhookr-recurly)
 * Github - coming soon
 
 ## <a name="works_with"></a>Works with:
@@ -169,7 +170,7 @@ While this gem is currently a 0.x release, suggestion is to require the exact ve
 
 webhookr is released under the [MIT license](http://www.opensource.org/licenses/MIT).
 
-## Author
+## Authors
 
 * [Gerry Power](https://github.com/gerrypower)
 * [J Smith](https://github.com/dark-panda)

data/Rakefile

@@ -7,7 +7,7 @@ require 'rake/testtask'
 require 'rdoc/task'
 require 'bundler/gem_tasks'
 
-$:.push File.expand_path(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.push File.expand_path(File.dirname(__FILE__), 'lib')
 
 version = Webhookr::VERSION
 
@@ -39,8 +39,8 @@ namespace :webhookr do
     end
 
     desc 'Install and test all'
-    task :all => [:install, :test_versions]
+    task all: [:install, :test_versions]
   end
 end
 
-task :default => :test
+task default: :test

data/app/controllers/webhookr/events_controller.rb

@@ -1,37 +1,44 @@
+# frozen_string_literal: true
+
 module Webhookr
   class EventsController < ActionController::Base
-    http_basic_authenticate_with(
-      :name => Webhookr.config.basic_auth.username,
-      :password => Webhookr.config.basic_auth.password
-    ) if Webhookr.config.basic_auth.username && Webhookr.config.basic_auth.password
+    if Webhookr.config.basic_auth.username && Webhookr.config.basic_auth.password
+      http_basic_authenticate_with(
+        name: Webhookr.config.basic_auth.username,
+        password: Webhookr.config.basic_auth.password
+      )
+    end
 
-    before_filter :create_service
+    if respond_to?(:before_action)
+      before_action :create_service
+    else
+      before_filter :create_service
+    end
 
     def show
-      render :nothing => true
+      render body: nil
     end
 
     def create
       @service.process!
-      render :nothing => true
+      render body: nil
     end
 
     private
 
-    def create_service
-      begin
+      def create_service
         # Rails 4.0.0 fix: https://github.com/rails/rails/pull/11353
         request.body.rewind
 
         @service = Webhookr::Service.new(
-          params[:service_id], :payload => request.body.read, :security_token => params[:security_token]
+          params[:service_id],
+          payload: request.body.read,
+          security_token: params[:security_token]
         )
-      rescue NameError => e
-        raise ActionController::RoutingError.new("No service '#{params[:service_id]}' is available.")
-      rescue Webhookr::InvalidSecurityTokenError => e
-        raise ActionController::InvalidAuthenticityToken.new("Invalid or missing security token for service '#{params[:service_id]}'.")
+      rescue Webhookr::InvalidServiceNameError
+        raise ActionController::RoutingError, "No service '#{params[:service_id]}' is available."
+      rescue Webhookr::InvalidSecurityTokenError
+        raise ActionController::InvalidAuthenticityToken, "Invalid or missing security token for service '#{params[:service_id]}'."
       end
-    end
-
   end
 end

data/config/routes.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 Webhookr::Engine.routes.draw do
-  get "/events/:service_id(/:security_token)" => "events#show",
-      :as => "events",
-      :defaults => { :format => 'json' },
-      :constraints => { :format => 'json' }
-  post "/events/:service_id(/:security_token)" => "events#create",
-       :as => "new_event",
-       :defaults => { :format => 'json' },
-       :constraints => { :format => 'json' }
+  get '/events/:service_id(/:security_token)' => 'events#show',
+    as: 'events',
+    defaults: { format: 'json' }
+
+  post '/events/:service_id(/:security_token)' => 'events#create',
+    as: 'new_event',
+    defaults: { format: 'json' }
 end

data/lib/generators/webhookr/add_route_generator.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module Webhookr
   module Generators
     class AddRouteGenerator < Rails::Generators::Base
-
-      desc 'This generator adds \'mount Webhookr::Engine => "/webhookr", :as => "webhookr"\' to your routes'
+      desc 'This generator adds \'mount Webhookr::Engine => "/webhookr", as: "webhookr"\' to your routes'
       def add_route
-        route 'mount Webhookr::Engine => "/webhookr", :as => "webhookr"'
+        route 'mount Webhookr::Engine => "/webhookr", as: "webhookr"'
       end
-
     end
   end
 end

data/lib/generators/webhookr/init_generator.rb

@@ -1,30 +1,32 @@
+# frozen_string_literal: true
+
 module Webhookr
   module Generators
     class InitGenerator < Rails::Generators::NamedBase
-
       desc "This generator creates an initializer file 'config/initializers/NAME.rb'"
       def init
         initializer("#{file_name}.rb") do
-          file_contents
+          file_contents.strip_heredoc
         end
       end
 
       def file_contents
-<<-eos
-# Webhookr Initializer
+        <<-eos
+          # Webhookr Initializer
 
-## Turn on http basic authentication for all plugins
-  # Webhookr.config.basic_auth.username = "admin"
-  # Webhookr.config.basic_auth.password = "password"
+          ## Turn on http basic authentication for all plugins
+          # Webhookr.config.basic_auth.username = "admin"
+          # Webhookr.config.basic_auth.password = "password"
 
-## Plugin Initializers go here ##
-eos
+          ## Plugin Initializers go here ##
+        eos
       end
 
-      def generate_security_token
-        rand(10000000000000000).floor.to_s(36)
-      end
+      private
 
+        def generate_security_token
+          SecureRandom.hex(32)
+        end
     end
   end
 end

data/lib/tasks/webhookr_tasks.rake

@@ -1,15 +1,15 @@
-namespace :webhookr do
-  desc "List the configured services and paths"
-  task :services => :environment do
 
-    puts "No webhookr services configured - add and configure webhookr plugins." and next if Webhookr.adapters.empty?
+namespace :webhookr do
+  desc 'List the configured services and paths'
+  task services: :environment do
+    puts 'No webhookr services configured - add and configure webhookr plugins.' and next if Webhookr.adapters.empty?
 
     include Webhookr::Engine.routes.url_helpers
 
-    Webhookr.adapters.each do |key, adapter|
+    Webhookr.adapters.each_key do |key|
       puts "\n\n#{key}:"
-      %w{ GET POST}.each do |x|
-        puts "  #{x}\t#{events_path(key, :security_token => Webhookr.config[key].try(:security_token))}\n"
+      %w{ GET POST }.each do |x|
+        puts "  #{x}\t#{events_path(key, security_token: Webhookr.config[key].try(:security_token))}\n"
       end
     end
   end

data/lib/webhookr.rb

@@ -1,10 +1,15 @@
-require "securecompare"
-require "webhookr/engine"
+# frozen_string_literal: true
+
+require 'securecompare'
+require 'webhookr/engine'
 
 module Webhookr
   extend ActiveSupport::Autoload
 
   autoload :InvalidPayloadError
+  autoload :InvalidSecurityTokenError
+  autoload :InvalidServiceNameError
+  autoload :MissingCallbackClassError
   autoload :AdapterResponse
   autoload :Service
   autoload :VERSION
@@ -15,11 +20,13 @@ module Webhookr
     end
 
     def config
-      @config ||= defined?(Rails) ? Rails.application.config.webhookr :
-                                    ActiveSupport::OrderedOptions.new
+      @config ||= if defined?(Rails)
+        Rails.application.config.webhookr
+      else
+        ActiveSupport::OrderedOptions.new
+      end
     end
   end
 end
 
-require "webhookr/services"
-
+require 'webhookr/services'

data/lib/webhookr/adapter_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webhookr
   class AdapterResponse < Struct.new(:service_name, :event_type, :payload); end
-end
+end

data/lib/webhookr/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/kernel/singleton_class'
 
 module Webhookr
@@ -6,11 +8,10 @@ module Webhookr
 
     # Enable basic auth for all services when config.basic_auth.username
     # and config.basic_auth.password are set.
-    self.config.webhookr = ActiveSupport::OrderedOptions.new
-    self.config.webhookr.basic_auth = ActiveSupport::OrderedOptions.new
+    config.webhookr = ActiveSupport::OrderedOptions.new
+    config.webhookr.basic_auth = ActiveSupport::OrderedOptions.new
 
-    initializer "webhookr.config" do |app|
+    initializer 'webhookr.config' do |app|
     end
   end
 end
-

data/lib/webhookr/invalid_payload_error.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
 module Webhookr
-  class InvalidPayloadError < RuntimeError; end
-end
+  class InvalidPayloadError < RuntimeError
+    def initialize(payload)
+      super("'#{payload.inspect}' is not valid")
+    end
+  end
+end

data/lib/webhookr/invalid_security_token_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webhookr
   class InvalidSecurityTokenError < RuntimeError; end
-end
+end

data/lib/webhookr/invalid_service_name_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Webhookr
+  class InvalidServiceNameError < NameError
+    def initialize(service_name)
+      super(%{Bad service name "#{service_name}"})
+    end
+  end
+end

data/lib/webhookr/missing_callback_class_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Webhookr
+  class MissingCallbackClassError < RuntimeError
+    def initialize(service_name)
+      super(%{No callback is configured for the service "#{service_name}".})
+    end
+  end
+end