easyhooks 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 219561adbcf6276d6d1a582a09356af22440fd99b880951a927a408c009e4f89
+  data.tar.gz: b44708a1a93e6b22f82d7ec00e9ec2df7938af7d11257faed4103d2d9aeda58b
+SHA512:
+  metadata.gz: 4f2c8992ac190e68c0c71b4f4f5364a6c2b12c48a407ad6a5fd785abf5855822f8145b03f118f70fc43e73f2dd4a53f88ee54279b8f2a12f18faa63b2fddfa34
+  data.tar.gz: 3a8e7fedb30c5b6ffe568c2c125e4e3e80930224ef98eaf6c3cd48ebbd2499dc131238ef6b17fabaadd11a01054dacd33920c2de683e4151a19c0a9b6fc9b547

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,374 @@
+# Easyhooks - Webhooks made easy
+
+Easyhooks is a ruby gem created to handle webhooks for Rails ActiveRecord instances. Simple, easy and fast.
+You can use it to create webhooks for your models, and then use them to send data to your clients.
+
+## Requirements
+
+- Ruby 3.0 or newer
+- Rails 6.1 or newer (including Rails 7.0)
+
+## Installation
+
+Include the gem in your Gemfile and run `bundle` to install it:
+
+```ruby
+gem 'easyhooks'
+```
+
+This step is not required if you don't want to store your hooks configuration in the database, but it's recommended.
+
+```shell
+rails g easyhooks:migration
+rails db:migrate
+```
+
+## Usage
+
+### Defining the easiest hook
+
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved do
+      action :my_first_action, endpoint: 'https://example.com'
+    end
+  end
+end
+```
+
+The example above it's the simplest use. It will create a trigger called `approved` for the `User` model. Whenever a _user_ is **created**, **updated** or **deleted**,
+the trigger `approved` dispatches an **ActiveJob** called `PostProcessor` to asynchronously send a **POST** request to the endpoint `https://example.com` with the following payload:
+
+```json
+{
+  "object": "User",
+  "action": "my_first_action",
+  "trigger": {
+    "name": "approved",
+    "event": "CREATE"
+  },
+  "data": {
+    "id": 1
+  }
+}
+```
+
+Easy, no? Let's understand how everything works and see how to customize it even more.
+
+### Trigger
+
+A trigger is a way to define when a webhook should be dispatched. It can be defined by the following options:
+* `:on` - Defines the events that will trigger the webhook. It can be `:create`, `:update` or `:destroy`. Defaults to `[:create, :update, :destroy]`.
+* `:only` - Defines the attributes that will trigger the webhook. It can be a single attribute or an array of attributes. Defaults to `nil` (or any model changes). Example: `only: :name` or `only: [:name, :email]`.
+
+**Note:** `:only` works only for `:update` events.
+
+Example:
+
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved, on: :update, only: :name do
+      action :my_first_action, endpoint: 'https://example.com'
+    end
+  end
+end
+```
+
+Whenever in your codebase a `User` is updated and the `name` attribute is changed, the trigger `approved` will dispatch the action `my_first_action`.
+
+### Action
+
+An action is a way to define what should be done when a webhook is dispatched. It can be defined by the following options:
+* `:endpoint` - Defines the endpoint that will receive the webhook data. It must be a valid URL.
+* `:method` - Defines the HTTP method that will be used to send the webhook. It can be `:get`, `:post`, `:put`, `:patch` or `:delete`. Defaults to `:post`.
+* `:headers` - Defines the headers that will be sent with the webhook. It must be a hash. Defaults to `{ 'Content-Type': 'application/json' }`.
+* `:auth` - Defines the authentication that will be used to send with the webhook `Authorization` header. Is must be a string. Defaults to `nil`. Example: `Basic YWRtaW46cGFzc3dvcmQ=`.
+
+Example:
+
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved do
+      action :my_first_action, endpoint: 'https://example.com', method: :put, headers: { 'X-Easy': 'Easyhooks' }, auth: 'Basic YWRtaW46cGFzc3dvcmQ='
+    end
+  end
+end
+```
+
+You can also define multiple actions for a single trigger:
+
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved do
+      action :my_first_action, endpoint: 'https://example.com/first', method: put
+      action :my_second_action, endpoint: 'https://example.com/second', method: post
+    end
+  end
+end
+```
+
+### Customizing the Payload
+
+The payload is the data that will be sent to the endpoint. It can be defined by the following options in any easyhooks block like `trigger`, `action` or even `easyhooks`:
+* `:payload` - Defines the payload that will be sent to the endpoint. It must be a symbol or a proc. Defaults to `{ id: model.id }`.
+
+**Note:** If you define a payload in a `trigger` block, it will be used for all actions. If you define a payload in an `action` block, it will be used only for that action.
+
+Example:
+
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved do
+      action :my_first_action, endpoint: 'https://example.com', payload: :my_payload
+    end
+  end
+
+  def my_payload
+    { id: id, name: name }
+  end
+end
+```
+JSON Payload:
+```json
+{
+  "object": "User",
+  "action": "my_first_action",
+  "trigger": {
+    "name": "approved",
+    "event": "CREATE"
+  },
+  "data": {
+    "id": 1,
+    "name": "John Doe"
+  }
+}
+```
+
+### Adding conditions
+
+You can add conditions to your triggers and actions. It can be defined by the following options:
+* `:if` - Defines a condition that will be evaluated before dispatching the webhook. It must be a symbol or a proc. Defaults to `nil`.
+
+**Note:** If you define a condition in a `trigger` block, it will be used for all actions. If you define a condition in an `action` block, it will be used only for that action.
+
+Example:
+
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved, if: :my_condition do
+      action :my_first_action, endpoint: 'https://example.com'
+    end
+  end
+
+  def my_condition
+    name == 'John Doe'
+  end
+end
+```
+
+### Accessing the webhook response data
+
+You can access the webhook response data in your codebase. This will be useful if you want to do something with the response, like logging it.
+
+**Note:** This callback will be called only if the webhook is successfully sent. Meaning that, if any error occurs while evaluating the webhook, this callback will not be called.
+For failure callbacks, you can use the `:on_fail` option.
+
+**Note 2:** The response object is an instance of [Net::HTTPResponse](https://ruby-doc.org/stdlib-3.0.0/libdoc/net/http/rdoc/Net/HTTPResponse.html).
+
+Example:
+
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved do
+      action :my_first_action, endpoint: 'https://example.com' do |response|
+        puts response.code
+        puts response.body
+      end
+    end
+  end
+end
+```
+
+### Handling webhook failures
+
+You can handle webhook failures in your codebase. This will be useful let's say if the endpoint is down and you want to retry the webhook later.
+You can define a `:on_fail` callback (symbol or proc) in any easyhooks block like `trigger` or `action`:
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved do
+      action :my_first_action, endpoint: 'https://example.com', on_fail: :my_callback
+    end
+  end
+
+  def my_callback
+    # Do something
+  end
+end
+```
+
+### Global configuration
+
+Defining endpoints, headers and auth for each action can be a little bit annoying. You can define a global configuration for all actions in your codebase.
+There is three ways to do that:
+* Using the `easyhooks` block
+* Using an YAML file
+* Using the database
+
+#### Using the `easyhooks` block
+
+You can define a global configuration for all actions in your codebase using the `easyhooks` block:
+
+```ruby
+class User < ActiveRecord::Base
+  easyhooks endpoint: 'https://example.com', auth: 'Bearer token' do
+    trigger :approved do
+      action :my_first_action, if: :my_condition
+      action :my_second_action, if: :my_second_condition
+    end
+  end
+end
+```
+
+**Note:** Easyhooks prioritizes the configuration defined in the `action` block over the configuration defined in the `easyhooks` block:
+* Order of priority: `action` > `trigger` > `easyhooks` > `yaml` > `database`.
+
+Example:
+```ruby
+class User < ActiveRecord::Base
+  easyhooks endpoint: 'https://example.com' do
+    trigger :approved do
+      action :my_first_action, method: :put
+      action :my_second_action
+    end
+  end
+end
+```
+
+In the example above, the `my_first_action` will be sent using the `PUT` method, while the `my_second_action` will be sent using the `POST` method.
+You can combine any number of configurations in your codebase and Easyhooks handle.
+
+#### Using an YAML file
+
+You can define a global configuration for all actions in your codebase using an YAML file:
+
+```yaml
+# config/easyhooks.yml
+development:
+  classes:
+    User:
+      endpoint: 'https://example.com'
+      method: :post
+      auth: 'Bearer token'
+      headers:
+        X-Easy: Easyhooks
+  triggers:
+    approved:
+      endpoint: 'https://example.com'
+      method: :patch
+  actions:
+    my_first_action:
+      endpoint: 'https://example.com'
+      method: :put
+```
+
+In the example above, we start configuring the hooks by environment.
+An `action` should have a unique name and can be shared between classes. Same for `triggers`.
+A `class` can have multiple trigger/actions and you can define a single configuration by class.
+
+**Note:** The priority of the configurations defined in the YAML file is the same as mentioned before:
+* Order of priority: `action` > `trigger` > `easyhooks` > `yaml` > `database`.
+
+#### Using the database (Stored configuration)
+
+You can define a global configuration for everything in your codebase using the database. For that you will need
+to execute the migration generator and run the migration:
+
+```shell
+rails g easyhooks:migration
+rails db:migrate
+```
+
+Define your models and hooks, but make sure to use the `:stored` option in the `easyhooks` block:
+```ruby
+class User < ActiveRecord::Base
+  easyhooks :stored do
+    trigger :approved do
+      action :my_first_action
+    end
+  end
+end
+```
+Then, store the configuration in the database using the `Easyhooks::Store` model. Open the rails console and run:
+```ruby
+  stored_action = Easyhooks::Store.create!(context: 'actions', name: 'my_first_action', endpoint: 'https://example.com', method: :put)
+  stored_action.add_headers({ 'X-Easy': 'Easyhooks' })
+  stored_action.add_auth('Bearer', 'token')
+```
+
+Using the database store will allow you to change the configuration without the need to restart your application, which
+is pretty useful, let`s say, if you want to change the endpoint of a webhook that is broken, or the auth token expired.
+
+The `context` attribute can be `actions`, `triggers` or `classes`. 
+The `name` attribute is the name of the action, trigger or class.
+
+Here you can also override the configurations using the priority order mentioned before:
+```ruby
+class User < ActiveRecord::Base
+  easyhooks :stored do
+    trigger :approved do
+      action :my_first_action
+      action :my_second_action, method: :patch
+    end
+  end
+end
+```
+
+You can also use the type `:stored` for blocks like `trigger` and `action`, and combine multiple rules:
+```ruby
+  Easyhooks::Store.create!(context: 'triggers', name: 'approved', method: :patch, endpoint: 'https://example.com/users')
+```
+```ruby
+class User < ActiveRecord::Base
+  easyhooks do
+    trigger :approved, type: :stored do
+      action :my_first_action, payload: :my_payload
+      action :another_action, method: :post
+    end
+    trigger :deleted, on: :destroy, payload: :my_other_payload, if: :condition do
+      action :my_second_action, endpoint: 'https://example.com/users/deleted'
+    end
+  end
+end
+```
+
+## Conclusion
+You can combine all the options mentioned above to create your own webhooks. Easyhooks is flexible and easy to use.
+Be creative and have fun!
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration.
+
+## Future improvements
+
+- Add option to temporarily disable a trigger, action or class hook
+- Add option to retry a webhook if it fails
+- Add option to define a timeout for the webhook
+- Rails generator to create database stored hooks
+- Rails generator to create YAML stored hooks
+
+
+## License
+
+Apache License, Version 2.0.
+See [LICENSE](https://apache.org/licenses/LICENSE-2.0.txt) for details.
+
+Copyright (c) 2023-2023 [Thiago Bonfante](https://github.com/thiagobonfante)

data/lib/easyhooks/action.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'easyhooks/store'
+require 'easyhooks/base'
+
+module Easyhooks
+  class Action < Easyhooks::Base
+
+    attr_accessor :trigger_name, :args, :on_fail_callable, :event_callable, :event
+
+    def initialize(name, trigger_name, hook, args = {}, &event)
+      super(name, args[:type], hook, args[:if], args[:payload], args[:on_fail])
+      @args = args
+      @trigger_name = trigger_name
+      @event_callable = "#{name}_event".to_sym
+      @on_fail_callable = "#{name}_on_fail".to_sym
+      @event = event
+      @hook = validate_hook(hook)
+    end
+
+    def load!(klass_name = nil)
+      return if self.type == :default
+
+      stored_action = Store.find_by(name: self.name, context: 'actions')
+      stored_action ||= Store.find_by(name: self.trigger_name, context: 'triggers')
+      stored_action ||= Store.find_by(name: klass_name, context: 'classes') if klass_name.present?
+      stored_action ||= Store.find_by(name: self.name, context: 'global')
+
+      raise "Action '#{self.name}' not found in database" unless stored_action.present?
+
+      # noinspection RubyArgCount
+      self.hook.method = validate_method(stored_action.method)
+      self.hook.endpoint = validate_endpoint(stored_action.endpoint)
+      self.hook.auth = validate_auth(stored_action.auth)
+      self.hook.headers = validate_headers(stored_action.headers)
+    end
+  end
+end

data/lib/easyhooks/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'easyhooks/concerns/helpers'
+require 'easyhooks/concerns/validators'
+
+module Easyhooks
+  class Base
+    include Easyhooks::Helpers
+    include Easyhooks::Validators
+
+    attr_accessor :name, :type, :hook, :condition, :payload, :on_fail
+
+    def initialize(name, type, hook, condition, payload, on_fail)
+      @name = validate_name(name)
+      @type = validate_type(type)
+      @hook = hook
+      @condition = validate_callback(condition, 'if')
+      @payload = validate_callback(payload, 'payload')
+      @on_fail = validate_callback(on_fail, 'on_fail')
+    end
+  end
+end

data/lib/easyhooks/concerns/helpers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Easyhooks
+  module Helpers
+    extend ActiveSupport::Concern
+
+    included do
+      def condition_applicable?(object)
+        if condition
+          if condition.is_a?(Symbol)
+            object.send(condition)
+          else
+            condition.call(object)
+          end
+        else
+          true
+        end
+      end
+
+      def request_payload(object)
+        if payload
+          if payload.is_a?(Symbol)
+            object.send(payload)
+          else
+            payload.call(object)
+          end
+        else
+          { id: object.id }
+        end
+      end
+    end
+  end
+end