metova-webhooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e0762f8f8c8cfea0ee2b3421538e14e8cad9ee3
+  data.tar.gz: 6105ee50db418aec117bdc5757ee29115d228c33
+SHA512:
+  metadata.gz: 2add541a95c4f5417a1b059d440fb0fcf501380fbc87260dec28990168d13bae65cd36d7ce1ba682ebde6237579ea95f18a2145ac6bb2a7064fff0739943f9d5
+  data.tar.gz: c4ce06cece8ac1c5a2077eda8e482ea8a99a1a728aa5331277a3d1f3274d2e0ac9bd908d5572a3a9f56dc7b28c1b9468a0a84d555b95dd4f4dec4bc5fbbb08b8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jami Couch
+
+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/README.md

@@ -0,0 +1,102 @@
+# Metova::Webhooks
+
+Easily add webhooks to your Rails app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metova-webhooks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metova-webhooks
+
+Then install the migrations:
+
+    $ rake metova-webhooks:install:migrations
+
+And migrate:
+
+    $ rake db:migrate
+
+### Notes
+
+Webhooks requires a 'User' model and ActiveJob, so make sure you have those things.
+
+## Usage
+
+In your webhookable model, include `Metova::Webhookable`:
+
+```ruby
+class MyModel
+  include Metova::Webhookable
+
+  # the following overrides are optional and can be used to customize your events
+
+  # override namespace to provide a namespace for your events (ex: a parent class and id)
+  def namespace
+    ''
+  end
+
+  # override hook_name to change the base event name
+  def hook_name
+    self.class.to_s.underscore
+  end
+
+  # override webhook_event to change how event names are constructed
+  def webhook_event(event)
+    [namespace, hook_name, event].reject(&:empty?).join(':')
+  end
+
+  # override webhook_serialize to change how the model is serialized for sending
+  def webhook_serialize
+    self.to_json
+  end
+
+  # ...
+end
+```
+
+Include `Metova::WebhooksBase` in a controller:
+
+```ruby
+class MyWebhooksController < ActionController::Base
+  include Metova::WebhooksBase
+
+  # override create to change the create behavior
+  def create
+    # create takes a block, and the webhook will not save if there are any errors, so you can do custom validations
+    super do |webhook|
+      webhook.errors.add :user, "is not allowed to make webhooks" if some_condition
+    end
+  end
+
+  protected
+    # your controller needs to respond to current_user (for example, if you are using devise)
+    def current_user
+      nil
+    end
+end
+```
+
+Add routes to your `config/routes.rb`:
+
+```ruby
+resources :webhooks, only: [:index, :create, :destroy]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/metova/metova-webhooks.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/job/metova/webhook_job.rb

@@ -0,0 +1,16 @@
+module Metova
+  class WebhookJob < ActiveJob::Base
+    queue_as :default
+
+    def perform(event, payload)
+      Webhook.where(event: event).each do |webhook|
+        begin
+          url = URI.parse(webhook.url)
+          Net::HTTP.post_form url, JSON.parse(payload)
+        rescue Exception => e
+          Rails.logger.error e.message
+        end
+      end
+    end
+  end
+end

data/app/models/metova/webhook.rb

@@ -0,0 +1,8 @@
+module Metova
+  class Webhook < ActiveRecord::Base
+    belongs_to :user, required: true
+
+    validates_presence_of :event
+    validates_presence_of :url
+  end
+end

data/db/migrate/20150812204248_create_metova_webhooks.rb

@@ -0,0 +1,12 @@
+class CreateMetovaWebhooks < ActiveRecord::Migration
+  def change
+    create_table :metova_webhooks do |t|
+      t.references :user, index: true
+      t.string :event
+      t.string :url
+
+      t.timestamps null: false
+    end
+    add_index :metova_webhooks, :event
+  end
+end

data/lib/metova/webhooks.rb

@@ -0,0 +1,9 @@
+require 'metova/webhooks/engine'
+
+require 'metova/webhooks/version'
+
+require 'metova/webhooks/controllers/webhooks_base'
+require 'metova/webhooks/models/webhookable'
+
+module Metova
+end

data/lib/metova/webhooks/controllers/webhooks_base.rb

@@ -0,0 +1,27 @@
+module Metova::WebhooksBase
+  extend ActiveSupport::Concern
+
+  def index
+    respond_with Metova::Webhook.where(user: current_user)
+  end
+
+  def create
+    @webhook = Metova::Webhook.new permitted_params.merge(user: current_user)
+    if block_given?
+      yield @webhook
+    end
+    @webhook.save if @webhook.errors.empty?
+    respond_with @webhook, location: nil
+  end
+
+  def destroy
+    @webhook = Metova::Webhook.where(user: current_user).find(params[:id])
+    @webhook.destroy
+    respond_with @webhook
+  end
+
+  protected
+    def permitted_params
+      params.require(:webhook).permit(:event, :url)
+    end
+end

data/lib/metova/webhooks/engine.rb

@@ -0,0 +1,17 @@
+require 'responders'
+
+module Metova::Webhooks
+  class Engine < ::Rails::Engine
+    isolate_namespace Metova
+
+    # run engine migrations when running bin/rake db:migrate from the main app
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
+        end
+      end
+    end
+
+  end
+end

data/lib/metova/webhooks/models/webhookable.rb

@@ -0,0 +1,37 @@
+module Metova::Webhookable
+  extend ActiveSupport::Concern
+
+  included do
+    after_create :create_hook
+    after_update :update_hook
+    after_destroy :destroy_hook
+  end
+
+  def namespace
+    ''
+  end
+
+  def hook_name
+    self.class.to_s.underscore
+  end
+
+  def webhook_event(event)
+    [namespace, hook_name, event].reject(&:empty?).join(':')
+  end
+
+  def create_hook
+    Metova::WebhookJob.perform_later webhook_event('create'), self.webhook_serialize
+  end
+
+  def update_hook
+    Metova::WebhookJob.perform_later webhook_event('update'), self.webhook_serialize
+  end
+
+  def destroy_hook
+    Metova::WebhookJob.perform_later webhook_event('destroy'), self.webhook_serialize
+  end
+
+  def webhook_serialize
+    self.to_json
+  end
+end

data/lib/metova/webhooks/version.rb

@@ -0,0 +1,5 @@
+module Metova
+  module Webhooks
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: metova-webhooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jami Couch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: Webhook library for Rails
+email:
+- jami.couch@metova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/job/metova/webhook_job.rb
+- app/models/metova/webhook.rb
+- db/migrate/20150812204248_create_metova_webhooks.rb
+- lib/metova/webhooks.rb
+- lib/metova/webhooks/controllers/webhooks_base.rb
+- lib/metova/webhooks/engine.rb
+- lib/metova/webhooks/models/webhookable.rb
+- lib/metova/webhooks/version.rb
+homepage: http://github.com/metova/metova-webhooks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Webhook library for Rails
+test_files: []