integromat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0ca9bab3704f514b3c816a6cc35028464cda5bb8507d57a7712c7c1ea7ba13e
+  data.tar.gz: 64d6dd910bc9af12ccc9008206e8616a820a8e29a0de1d4af6591a6ea8df074a
+SHA512:
+  metadata.gz: 8f02bc00aa7f294f029ad97637d01c9572e40443c10db403c52351a668bac7bb566c2eae8279b8703c8218a07a0dbf1201257e94472190b0b6743d6346c850bf
+  data.tar.gz: 348d398cb82ef41e15db7fcba68b46f4f3ca94029fe89c025c8e74e7a98493ef14f73994f95ce4cbadd887daecce44e720356c31247e51b235b99bf77641e33e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,42 @@
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/ArgumentAlignment:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+Style/MethodDefParentheses:
+  Enabled: true
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+Naming/VariableNumber:
+  CheckSymbols: false
+Style/VariableNumber:
+  Enabled: false
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: false
+Lint/Debugger:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+Layout/ArrayAlignment:
+  EnforcedStyle: with_fixed_indentation
+Style/ClassVars:
+  Enabled: false
+Metrics/BlockLength:
+  Max: 2000

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Nathan Lopez
+
+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,98 @@
+# Integromat (Make) Ruby
+
+<span>[![Gem Version](https://img.shields.io/gem/v/integromat-ruby.svg?label=integromat-ruby&colorA=D30001&colorB=DF3B3C)](https://rubygems.org/gems/integromat-ruby)</span> <span>
+[![ruby](https://img.shields.io/badge/ruby-2.6+%20*-ruby.svg?colorA=D30001&colorB=DF3B3C)](https://github.com/andrewdsilva/integromat-ruby)</span> <span>
+![Rubocop Status](https://img.shields.io/badge/rubocop-passing-rubocop.svg?colorA=1f7a1f&colorB=2aa22a)</span> <span>
+[![MIT license](https://img.shields.io/badge/license-MIT-mit.svg?colorA=1f7a1f&colorB=2aa22a)](http://opensource.org/licenses/MIT)</span> <span>
+![Downloads](https://img.shields.io/gem/dt/integromat-ruby.svg?colorA=004d99&colorB=0073e6)</span>
+
+Integromat is a powerful automation platform that enables you to connect and automate various applications and services. One of the key features of Integromat is the ability to utilize webhooks, which allow you to send data to Integromat over HTTP. Webhooks act as instant triggers, allowing you to execute scenarios immediately upon receiving a request at the webhook URL.
+
+Integromat-Ruby is a lightweight Ruby gem that simplifies the process of triggering Integromat webhooks from any Ruby application. With just a few lines of code, you can seamlessly integrate your Ruby app with Integromat and automate various tasks.
+
+To start using Integromat-Ruby, you'll need an Integromat account and a created webhook. If you're new to Integromat, don't worry – setting up an account and creating a webhook is straightforward and well-documented on the Integromat website (https://make.com). Once you have your Integromat account and webhook ready, you're all set to integrate it with your Ruby application.
+
+- [Sign up for Integromat (Make)](https://www.make.com/en/register)
+- [Webhooks Documentation](https://www.integromat.com/en/help/app/webhooks)
+
+## Installation
+
+To install the gem add it into a Gemfile (Bundler):
+
+```ruby
+gem "integromat"
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+## Usage
+
+To use integromat, start by configuring it with a hash of the webhooks you want to integrate. You can also customize the base URI.
+
+```ruby
+require "integromat"
+
+Integromat.configure do |c|
+  c.web_hooks = { user_register: "webhook_id" }
+
+  # Override the base URI
+  c.base_uri = "https://hook.eu2.make.com"
+end
+```
+
+To obtain the base URL and hook ID, please look at the webhook URL you created in the Integromat application (Make).
+
+![Webhook module on make](./images/make-screenshot.png)
+
+Create an instance of `Webhook` for the desired hook, and use the `trigger` method to send a hash of parameters to the Integromat (Make) webhook. The `trigger` method returns `true` if the hook is successfully posted.
+
+```ruby
+hook = Integromat::Webhook.new(:user_register)
+
+if hook.trigger({ username: "andrewdsilva" })
+  pp "Hook triggered !"
+else
+  pp "Hook not triggered !"
+end
+```
+
+## Use Integromat on your Rails application
+
+If you are using Integromat with Rails, I recommend creating an initializer file (e.g., `config/initializers/integromat.rb`) and adding the following code:
+
+```ruby
+Integromat.configure do |c|
+  c.web_hooks = { user_register: "webhook_id" }
+
+  # Override the base URI
+  c.base_uri = "https://hook.eu2.make.com"
+end
+```
+
+### Example
+
+Suppose you want to call the webhook every time a user signs up for your application. You can use the `trigger` method from the Integromat gem within a callback on your `User` model.
+
+```ruby
+class User < ApplicationRecord
+  after_create :notify_registration
+
+  def notify_registration
+    Integromat::Webhook.new(:user_registration).trigger(email: email)
+  end
+end
+```
+
+This code sets up an `after_create` callback on the `User` model, which calls the `notify_registration` method. Inside this method, the `Integromat::Webhook.new(:user_registration)` creates a new webhook instance for the "user_registration" hook. The `trigger` method is then used to ping the webhook.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrewdsilva/integromat-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/integromat.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/integromat/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "integromat"
+  spec.version = Integromat::VERSION
+  spec.authors = ["Nathan Lopez"]
+  spec.email = ["nathan.lopez042@gmail.com"]
+
+  spec.summary = "A simple solution for integrating Integromat (Make) webhooks into your Ruby applications."
+  spec.description = "Integromat is a powerful automation platform that enables you to connect and automate various " \
+    "applications and services. One of the key features of Integromat is the ability to utilize webhooks, which " \
+    "allow you to send data to Integromat over HTTP. Webhooks act as instant triggers, allowing you to execute " \
+    "scenarios immediately upon receiving a request at the webhook URL.\n\n" \
+    "Integromat-Ruby is a lightweight Ruby gem that simplifies the process of triggering Integromat webhooks from " \
+    "any Ruby application. With just a few lines of code, you can seamlessly integrate your Ruby app with Integromat " \
+    "and automate various tasks."
+  spec.homepage = "https://github.com/andrewdsilva/integromat-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/andrewdsilva/integromat-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+
+  spec.add_development_dependency "webmock"
+end

data/lib/integromat/base.rb

@@ -0,0 +1,33 @@
+require "faraday"
+
+module Integromat
+  class Base
+    def post_hook(data)
+      api.post(hook_path, data)
+    end
+
+    def web_hook_id
+      @web_hook_id ||= config.web_hooks[hook_ref]
+    end
+
+    def api
+      @api ||= ::Faraday.new(url: api_url) do |faraday|
+        faraday.request :json
+        faraday.response :logger, ::Logger.new($stdout), bodies: true
+        faraday.adapter ::Faraday.default_adapter
+      end
+    end
+
+    def api_url
+      config.base_uri.to_s
+    end
+
+    def hook_path
+      "/#{web_hook_id}"
+    end
+
+    def config
+      Integromat.config
+    end
+  end
+end

data/lib/integromat/config.rb

@@ -0,0 +1,10 @@
+module Integromat
+  class Config
+    attr_accessor :base_uri, :web_hooks
+
+    def initialize
+      self.base_uri = "https://hook.make.com"
+      self.web_hooks = {}
+    end
+  end
+end

data/lib/integromat/exceptions.rb

@@ -0,0 +1,4 @@
+module Integromat
+  class IntegromatMisConfiguration < StandardError; end
+  class IntegromatServerError < StandardError; end
+end

data/lib/integromat/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Integromat
+  VERSION = "0.1.0"
+end

data/lib/integromat/webhook.rb

@@ -0,0 +1,21 @@
+module Integromat
+  class Webhook < Base
+    attr_accessor :hook_ref
+
+    def initialize(hook_ref, hook_id = nil)
+      super()
+
+      self.hook_ref = hook_ref
+
+      @web_hook_id = hook_id if hook_id
+    end
+
+    def trigger(data = {})
+      unless web_hook_id
+        raise IntegromatMisConfiguration, "No hook configured for #{hook_ref}. Configured hooks: #{config.web_hooks}"
+      end
+
+      post_hook(data)
+    end
+  end
+end

data/lib/integromat.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "integromat/version"
+require "integromat/exceptions"
+require "integromat/config"
+require "integromat/base"
+require "integromat/webhook"
+
+module Integromat
+  class << self
+    attr_accessor :config
+  end
+
+  class Error < StandardError; end
+
+  def self.configure
+    self.config ||= Integromat::Config.new
+    yield(config) if block_given?
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: integromat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Lopez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+description: |-
+  Integromat is a powerful automation platform that enables you to connect and automate various applications and services. One of the key features of Integromat is the ability to utilize webhooks, which allow you to send data to Integromat over HTTP. Webhooks act as instant triggers, allowing you to execute scenarios immediately upon receiving a request at the webhook URL.
+
+  Integromat-Ruby is a lightweight Ruby gem that simplifies the process of triggering Integromat webhooks from any Ruby application. With just a few lines of code, you can seamlessly integrate your Ruby app with Integromat and automate various tasks.
+email:
+- nathan.lopez042@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- images/make-screenshot.png
+- integromat.gemspec
+- lib/integromat.rb
+- lib/integromat/base.rb
+- lib/integromat/config.rb
+- lib/integromat/exceptions.rb
+- lib/integromat/version.rb
+- lib/integromat/webhook.rb
+homepage: https://github.com/andrewdsilva/integromat-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andrewdsilva/integromat-ruby
+  source_code_uri: https://github.com/andrewdsilva/integromat-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key: 
+specification_version: 4
+summary: A simple solution for integrating Integromat (Make) webhooks into your Ruby
+  applications.
+test_files: []