zapier_rest_hooks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38e5cbb5067871db89890b70f6e3973caa00a119
+  data.tar.gz: 4fe11ce016bbb4a59957dd220cf4529efa0ab67b
+SHA512:
+  metadata.gz: 3e501fe2d7e89eb4249127f791b9ee1bc0b90ee6f1d4e742cf069c7763353e49faa1d89e7de2af203ffe7ec942cabe09e4d7745caae1a106ad65734022990645
+  data.tar.gz: 9481d479aa699e97d8def79110668890a17c6d8c4da422ce6b01f43ca661edc21574aa1a423c4adcfe41744236987c95f579a069e8bdc2297a56e018b2a685b7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Esteban Arango Medina
+
+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/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ZapierRestHooks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/app/controllers/zapier_rest_hooks/application_controller.rb

@@ -0,0 +1,5 @@
+module ZapierRestHooks
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/zapier_rest_hooks/hooks_controller.rb

@@ -0,0 +1,31 @@
+require_dependency 'zapier_rest_hooks/application_controller'
+
+module ZapierRestHooks
+  class HooksController < ApplicationController
+    def create
+      hook = Hook.new(hook_params)
+      render nothing: true, status: 500 && return unless hook.save
+      Rails.logger.info "Created REST hook: #{hook.inspect}"
+      # The Zapier documentation says to return 201 - Created.
+      render json: hook.to_json(only: :id), status: 201
+    end
+
+    def destroy
+      hook = Hook.find(params[:id]) if params[:id]
+      if hook.nil? && params[:subscription_url]
+        hook = Hook.find_by_subscription_url(params[:subscription_url]).destroy
+      end
+      Rails.logger.info "Destroying REST hook: #{hook.inspect}"
+      hook.destroy
+      render nothing: true, status: 200
+    end
+
+    private
+
+    def hook_params
+      params[:event_name] ||= params[:name]
+      params[:hook] = params
+      params.require(:hook).permit(:event_name, :target_url, :owner_id, :owner_class_name, :subscription_url)
+    end
+  end
+end

data/app/models/zapier_rest_hooks/hook.rb

@@ -0,0 +1,37 @@
+require 'rest-client'
+module ZapierRestHooks
+  Struct.new('ZapierApp', :id)
+  class Hook < ActiveRecord::Base
+    validates :event_name, :target_url, presence: true
+
+    # Looks for an appropriate REST hook that matches the owner, and triggers the hook if one exists.
+    def self.trigger(event_name, encoded_record, owner = Struct::ZapierApp.new(0))
+      hooks = self.hooks(event_name, owner)
+      return if hooks.empty?
+
+      unless Rails.env.development?
+        # Trigger each hook if there is more than one for an owner, which can happen.
+        hooks.each do |hook|
+          Rails.logger.info "Triggering REST hook event: #{event_name} / #{hook.inspect}"
+          Rails.logger.info "REST hook record: #{encoded_record}"
+          RestClient.post(hook.target_url, encoded_record) do |response|
+            if response.code.eql? 410
+              Rails.logger.info "Destroying REST hook because of 410 response: #{hook.inspect}"
+              hook.destroy
+            end
+          end
+        end
+      end
+    end
+
+    # Returns all hooks for a given event_name and owner.
+    def self.hooks(event_name, owner = Struct::ZapierApp.new(0))
+      where(event_name: event_name, owner_class_name: owner.class.name, owner_id: owner.id)
+    end
+
+    # Tests whether any hooks exist for a given event_name and owner
+    def self.hooks_exist?(event_name, owner = Struct::ZapierApp.new(0))
+      hooks(event_name, owner).any?
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+ZapierRestHooks::Engine.routes.draw do
+  resources :hooks, only: [:create, :destroy]
+end

data/db/migrate/20160614153212_create_zapier_rest_hooks_hooks.rb

@@ -0,0 +1,11 @@
+class CreateZapierRestHooksHooks < ActiveRecord::Migration
+  def change
+    create_table :zapier_rest_hooks_hooks do |t|
+      t.string :event_name
+      t.string :subscription_url
+      t.string :target_url
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160614204418_add_owner_to_hooks.rb

@@ -0,0 +1,6 @@
+class AddOwnerToHooks < ActiveRecord::Migration
+  def change
+    add_column :zapier_rest_hooks_hooks, :owner_id, :string, default: 0
+    add_column :zapier_rest_hooks_hooks, :owner_class_name, :string, default: 'Struct::ZapierApp'
+  end
+end

data/lib/generators/zapier_rest_hooks/install_generator.rb

@@ -0,0 +1,22 @@
+
+require 'rails/generators/base'
+module ZapierRestHooks
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    require 'rails/generators/migration'
+
+    desc 'Mounts ZapierRestHooks in routes and copies migrations.'
+
+    def mount_in_routes
+      route 'mount ZapierRestHooks::Engine, at: "/hooks"'
+    end
+
+    def copy_migrations
+      require 'rake'
+      Rails.application.load_tasks
+      Rake::Task['railties:install:migrations'].reenable
+      Rake::Task['zapier_rest_hooks:install:migrations'].invoke
+    end
+  end
+end

data/lib/tasks/zapier_rest_hooks_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :zapier_rest_hooks do
+#   # Task goes here
+# end

data/lib/zapier_rest_hooks.rb

@@ -0,0 +1,4 @@
+require 'zapier_rest_hooks/engine'
+
+module ZapierRestHooks
+end

data/lib/zapier_rest_hooks/engine.rb

@@ -0,0 +1,12 @@
+module ZapierRestHooks
+  class Engine < ::Rails::Engine
+    isolate_namespace ZapierRestHooks
+
+    config.generators do |g|
+      g.test_framework      :rspec,        fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/zapier_rest_hooks/version.rb

@@ -0,0 +1,3 @@
+module ZapierRestHooks
+  VERSION = '0.0.1'.freeze
+end

data/spec/controllers/zapier_rest_hooks/hooks_controller_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module ZapierRestHooks
+  RSpec.describe HooksController, type: :controller do
+    routes { ZapierRestHooks::Engine.routes }
+
+    before :each do
+      request.env['HTTP_ACCEPT'] = 'application/json'
+    end
+
+    describe 'POST #create' do
+      it 'creates a new hook' do
+        expect {
+          post :create, attributes_for(:hook)
+        }.to change(Hook, :count).by(1)
+      end
+    end
+
+    describe 'DELETE #destroy' do
+      let!(:hook) { create(:hook) }
+      it 'destroys the requested font' do
+        expect {
+          delete :destroy, id: hook
+        }.to change(Hook, :count).by(-1)
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

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

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/models/candidate.rb

@@ -0,0 +1,20 @@
+class Candidate < ActiveRecord::Base
+  # Relations
+  belongs_to :organization
+
+  # Callbacks
+  after_create :trigger_hooks_with_owner, if: :organization
+  after_create :trigger_hooks_without_owner, unless: :organization
+
+  private
+
+  def trigger_hooks_with_owner
+    return unless ZapierRestHooks::Hook.hooks_exist?('new_candidate', organization)
+    ZapierRestHooks::Hook.trigger('new_candidate', to_json, organization)
+  end
+
+  def trigger_hooks_without_owner
+    return unless ZapierRestHooks::Hook.hooks_exist?('new_candidate')
+    ZapierRestHooks::Hook.trigger('new_candidate', to_json)
+  end
+end

data/spec/dummy/app/models/organization.rb

@@ -0,0 +1,2 @@
+class Organization < ActiveRecord::Base
+end

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

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

data/spec/dummy/config/application.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+# require 'rails/test_unit/railtie'
+
+Bundler.require(*Rails.groups)
+require 'zapier_rest_hooks'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3