mautic 1.0.5 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d61af0eb918446c6edf125b168fd769dca21e6bf
-  data.tar.gz: 6e3707b229934a703d7065feaf6596c71e0a500c
+SHA256:
+  metadata.gz: 1f4e005c1b32fba6f6609b90752ef110cb2f1a2cbf8379ec01ebb8afc02120f6
+  data.tar.gz: 864ad4d3796f591f1b0280bcd9d7ca3c9ff989fa7e094b8dcddf32d3b1b1be7f
 SHA512:
-  metadata.gz: 0da6bcb99a484a7a4a2d2ecbb17a563a06f04687e44faf9f596f55bbad4e9dbe92029284f90ec6d60e1005cb117e6da8251e76afac1f5394ce92bc2d4f35a28e
-  data.tar.gz: 92d3a2903427d32d74a15fb523b60ffab5ef4563119ddf0405ec7d5c567102bb7947eeda4b7c1d77258c183280eb308eca512b88f2e482eec84a6ad515050d93
+  metadata.gz: 2dc666eb9370ed8a8de3e0896180c73bb57979192f2534a6950fc5edcc35283eff3ff187ee2138d189f60f85b9872abecccb990ddb3701d6e46a9e47dfd4b0d2
+  data.tar.gz: 6ddd8b536df58ab14e21c6cff3407ef0a768737db7bce81fb3751036c455802ebd6b1831293e23a038e6597225c91c514dd158b0eb449f0d771837c22765b049

data/README.md

@@ -1,6 +1,7 @@
 # Mautic rails 
 RoR helper / wrapper for Mautic API and forms
 
+*Rails 4.2.8+, 5.1+ compatible*
 ## Usage
 ### Gem provides API connection to your Mautic(s)
   1. Create mautic connection
@@ -60,12 +61,23 @@ There are two options of usage:
   m.data = {} # hash of attributes
   m.push # push data to mautic 
   ```
+  
+### Webhook receiver
+Receive webhook from mautic, parse it and prepare for use.
+
+  1. add concern to your controller
+      
+          include Mautic::ReceiveWebHooks
+  2. in routes must be specify `:mautic_id`, for example:
+  
+          post "webhook/:mautic_id", action: "webhook", on: :collection
+          
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mautic'
+gem 'mautic', '~>0.1'
 ```
 
 And then execute:
@@ -85,6 +97,7 @@ add to `config/initializers/mautic.rb`:
 Mautic.configure do |config|
   # This is for oauth handshake token url. I need to know where your app listen
   config.base_url = "https://my-rails-app.com"
+  # OR it can be Proc 
   # *optional* This is your default mautic URL - used in form helper 
   config.mautic_url = "https://mautic.my.app"
 end

data/app/assets/javascripts/mautic/application.js

@@ -10,5 +10,5 @@
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
-//= require rails-ujs
+// require rails-ujs
 //= require_tree .

data/app/controllers/concerns/mautic/connections_controller_concern.rb

@@ -0,0 +1,118 @@
+module Mautic
+  module ConnectionsControllerConcern
+    extend ActiveSupport::Concern
+
+    included do
+
+      before_action :set_mautic_connection, only: [:show, :edit, :update, :destroy, :oauth2, :authorize]
+
+    end
+
+
+    # GET /mautic_connections
+    def index
+      @mautic_connections = Mautic::Connection.order(:url)
+      respond_to do |format|
+        format.html { render layout: !request.xhr? }
+        format.json { render json: @mautic_connections }
+      end
+    end
+
+    # GET /mautic_connections/1
+    def show
+      respond_to do |format|
+        format.html { render layout: !request.xhr? }
+      end
+    end
+
+    # GET /mautic_connections/new
+    def new
+      @mautic_connection = Mautic::Connection.new
+      respond_to do |format|
+        format.html { render layout: !request.xhr? }
+      end
+    end
+
+    # GET /mautic_connections/1/edit
+    def edit
+      respond_to do |format|
+        format.html { render layout: !request.xhr? }
+      end
+    end
+
+    # POST /mautic_connections
+    def create
+      @mautic_connection = Mautic::Connection.new(mautic_connection_params)
+
+      respond_to do |format|
+        if @mautic_connection.save
+          format.html { render(:edit, notice: t('mautic.text_mautic_connection_created')) }
+          format.js { head :no_content }
+          format.json { render json: @mautic_connection }
+        else
+          format.html { render :new }
+          format.js { head :unprocessable_entity }
+          format.json { render json: @mautic_connection.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PATCH/PUT /mautic_connections/1
+    def update
+      respond_to do |format|
+        if @mautic_connection.update(mautic_connection_params)
+          format.html { redirect_to({ action: :index }, notice: t('mautic.text_mautic_connection_updated')) }
+          format.js { head :no_content }
+          format.json { render json: @mautic_connection }
+        else
+          format.html { render :edit }
+          format.js { head :unprocessable_entity }
+          format.json { render json: @mautic_connection.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /mautic_connections/1
+    def destroy
+      @mautic_connection.destroy
+      respond_to do |format|
+        format.html { redirect_to action: "index", notice: t('mautic.text_mautic_connection_destroyed') }
+        format.js { render js: "document.getElementById('#{view_context.dom_id(@mautic_connection)}').remove()" }
+        format.json { render json: @mautic_connection }
+      end
+    end
+
+    # ==--==--==--==--
+
+    def authorize
+      redirect_to @mautic_connection.authorize
+    end
+
+    def oauth2
+      begin
+        response = @mautic_connection.get_code(params.require(:code))
+        @mautic_connection.update(token: response.token, refresh_token: response.refresh_token)
+        return render plain: t('mautic.text_mautic_authorize_successfully')
+      rescue OAuth2::Error => e
+        flash[:error] = e.message
+      end
+
+      render :show
+    end
+
+    private
+
+    # Use callbacks to share common setup or constraints between actions.
+    def set_mautic_connection
+      @mautic_connection = Mautic::Connection.find(params[:id])
+    rescue ActiveRecord::RecordNotFound => e
+      return render head: 404, plain: e.message
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def mautic_connection_params
+      params.require(:connection).permit(:url, :client_id, :secret, :type)
+    end
+
+  end
+end

data/app/controllers/concerns/mautic/receive_web_hooks.rb

@@ -0,0 +1,16 @@
+module Mautic
+  module ReceiveWebHooks
+    extend ActiveSupport::Concern
+
+    included do
+
+    end
+
+    protected
+
+    # params path need +:mautic_id+
+    def webhook
+      @webhook ||= Mautic::Connection.receive_webhook params
+    end
+  end
+end

data/app/controllers/mautic/connections_controller.rb

@@ -1,109 +1,5 @@
 module Mautic
   class ConnectionsController < ApplicationController
-    before_action :set_mautic_connection, only: [:show, :edit, :update, :destroy, :oauth2, :authorize]
-
-    # GET /mautic_connections
-    def index
-      @mautic_connections = Connection.order(:url)
-      respond_to do |format|
-        format.html { render layout: !request.xhr? }
-        format.json { render json: @mautic_connections }
-      end
-    end
-
-    # GET /mautic_connections/1
-    def show
-      respond_to do |format|
-        format.html { render layout: !request.xhr? }
-      end
-    end
-
-    # GET /mautic_connections/new
-    def new
-      @mautic_connection = Connection.new
-      respond_to do |format|
-        format.html { render layout: !request.xhr? }
-      end
-    end
-
-    # GET /mautic_connections/1/edit
-    def edit
-      respond_to do |format|
-        format.html { render layout: !request.xhr? }
-      end
-    end
-
-    # POST /mautic_connections
-    def create
-      @mautic_connection = Connection.new(mautic_connection_params)
-
-      respond_to do |format|
-        if @mautic_connection.save
-          format.html { redirect_to mautic.connection_path(@mautic_connection), notice: t('mautic.text_mautic_connection_created') }
-          format.js { head :no_content }
-          format.json { render json: @mautic_connection }
-        else
-          format.html { render :new }
-          format.js { head :unprocessable_entity }
-          format.json { render json: @mautic_connection.errors, status: :unprocessable_entity }
-        end
-      end
-    end
-
-    # PATCH/PUT /mautic_connections/1
-    def update
-      respond_to do |format|
-        if @mautic_connection.update(mautic_connection_params)
-          format.html { redirect_to mautic.connection_path(@mautic_connection), notice: t('mautic.text_mautic_connection_updated') }
-          format.js { head :no_content }
-          format.json { render json: @mautic_connection }
-        else
-          format.html { render :edit }
-          format.js { head :unprocessable_entity }
-          format.json { render json: @mautic_connection.errors, status: :unprocessable_entity }
-        end
-      end
-    end
-
-    # DELETE /mautic_connections/1
-    def destroy
-      @mautic_connection.destroy
-      respond_to do |format|
-        format.html { redirect_to :connections, notice: t('mautic.text_mautic_connection_destroyed') }
-        format.js { render js: "document.getElementById('#{view_context.dom_id(@mautic_connection)}').remove()" }
-        format.json { render json: @mautic_connection }
-      end
-    end
-
-    # ==--==--==--==--
-
-    def authorize
-      redirect_to @mautic_connection.authorize
-    end
-
-    def oauth2
-      begin
-        response = @mautic_connection.get_code(params.require(:code))
-        @mautic_connection.update(token: response.token, refresh_token: response.refresh_token)
-        return render plain: t('mautic.text_mautic_authorize_successfully')
-      rescue OAuth2::Error => e
-        flash[:error] = e.message
-      end
-
-      render :show
-    end
-
-    private
-    # Use callbacks to share common setup or constraints between actions.
-    def set_mautic_connection
-      @mautic_connection = Connection.find(params[:id])
-    rescue ActiveRecord::RecordNotFound => e
-      return render head: 404, plain: e.message
-    end
-
-    # Only allow a trusted parameter "white list" through.
-    def mautic_connection_params
-      params.require(:connection).permit(:url, :client_id, :secret, :type)
-    end
+    include ::Mautic::ConnectionsControllerConcern
   end
 end

data/app/models/mautic/connection.rb

@@ -3,11 +3,16 @@ module Mautic
 
     self.table_name = 'mautic_connections'
 
-    validates :url, :client_id, :secret, presence: true
-    validates :url, format: URI::regexp(%w(http https))
+    validates :url, presence: true, format: URI::regexp(%w(http https))
+    validates :client_id, :secret, presence: true, unless: :new_record?
 
     alias_attribute :access_token, :token
 
+    # @param [ActionController::Parameters] params
+    def self.receive_webhook(params)
+      WebHook.new(find(params.require(:mautic_id)), params)
+    end
+
     def client
       raise NotImplementedError
     end
@@ -46,6 +51,14 @@ module Mautic
 
     private
 
+    def callback_url
+      if (conf = Mautic.config.base_url).is_a?(Proc)
+        conf = conf.call(self)
+      end
+
+      URI.parse(conf)
+    end
+
     def parse_response(response)
       case response.status
       when 400

data/app/models/mautic/connections/oauth2.rb

@@ -38,8 +38,7 @@ module Mautic
       private
 
       def callback_url
-        # return Mautic.config.oauth2_callback_url if Mautic.config.oauth2_callback_url
-        uri = URI.parse(Mautic.config.base_url)
+        uri = super
         uri.path = Mautic::Engine.routes.url_helpers.oauth2_connection_path(self)
         uri.to_s
       end

data/app/models/mautic/web_hook.rb

@@ -0,0 +1,18 @@
+module Mautic
+  # Represent received web hook
+  class WebHook
+
+    attr_reader :connection
+    # @param [Mautic::Connection] connection
+    # @param [ActionController::Parameters] params
+    def initialize(connection, params)
+      @connection = connection
+      @params = params
+    end
+
+    def form_submissions
+      @forms ||= Array.wrap(@params.require("mautic.form_on_submit")).collect { |data| ::Mautic::Submissions::Form.new(@connection, data["submission"]) if data["submission"] }.compact
+    end
+
+  end
+end

data/app/views/mautic/connections/_form.html.erb

@@ -1,4 +1,5 @@
-<%= form_with(model: mautic_connection.becomes(Mautic::Connection), local: true) do |form| %>
+<%#= form_with(model: mautic_connection.becomes(Mautic::Connection), local: true) do |form| %>
+<%= form_for(mautic_connection.becomes(Mautic::Connection)) do |form| %>
   <% if mautic_connection.errors.any? %>
     <div id="error_explanation">
       <h2><%= pluralize(mautic_connection.errors.count, "error") %> prohibited this mautic_connection from being saved:</h2>

data/config/routes.rb

@@ -5,5 +5,6 @@ Mautic::Engine.routes.draw do
       get :oauth2
 
     end
+    # post "webhook/:mautic_id", action: "webhook", on: :collection
   end
 end

data/db/migrate/20171028082047_create_mautic_mautic_connections.rb

@@ -1,4 +1,4 @@
-class CreateMauticMauticConnections < ActiveRecord::Migration[5.1]
+class CreateMauticMauticConnections < Mautic::DummyMigrationClass
   def change
     create_table :mautic_connections do |t|
       t.string :type
@@ -10,7 +10,7 @@ class CreateMauticMauticConnections < ActiveRecord::Migration[5.1]
       t.string :token
       t.string :refresh_token
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
-end
+end

data/lib/mautic.rb

@@ -7,6 +7,7 @@ module Mautic
   autoload :FormHelper, 'mautic/form_helper'
   autoload :Proxy, 'mautic/proxy'
   autoload :Model, 'mautic/model'
+  autoload :Submissions, 'mautic/submissions'
 
   class RequestError < StandardError
 
@@ -58,4 +59,12 @@ module Mautic
   end
   # Your code goes here...
 
+  if Rails.version.start_with? "4"
+    class DummyMigrationClass < ActiveRecord::Migration
+    end
+  else
+    class DummyMigrationClass < ActiveRecord::Migration[4.2]
+    end
+  end
+
 end

data/lib/mautic/model.rb

@@ -1,4 +1,6 @@
 module Mautic
+  # Virtual model for Mautic endpoint
+  #   @see https://developer.mautic.org/#endpoints
   class Model < OpenStruct
 
     class MauticHash < Hash
@@ -35,6 +37,9 @@ module Mautic
 
     end
 
+    attr_reader :connection
+
+    # @param [Mautic::Connection] connection
     def initialize(connection, hash=nil)
       @connection = connection
       @table = MauticHash.new
@@ -43,6 +48,10 @@ module Mautic
       clear_changes
     end
 
+    def mautic_id
+      "#{id}/#{@connection.id}"
+    end
+
     def save(force = false)
       id.present? ? update(force) : create
     end
@@ -62,7 +71,7 @@ module Mautic
 
     def create
       begin
-        json = @connection.request(:post, "api/#{endpoint}/#{id}/new", { body: to_h })
+        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", { body: to_h })
         self.attributes = json[endpoint.singularize]
         clear_changes
       rescue ValidationError => e

data/lib/mautic/spec_helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path('../../../spec/spec_helper', __FILE__)
+Dir.glob(File.expand_path('../../../spec/{factories,support}/*.rb', __FILE__)).each do |file|
+  require file
+end

data/lib/mautic/submissions.rb

@@ -0,0 +1,5 @@
+module Mautic
+  module Submissions
+    autoload :Form, "mautic/submissions/form"
+  end
+end

data/lib/mautic/submissions/form.rb

@@ -0,0 +1,29 @@
+module Mautic
+  module Submissions
+    class Form
+      attr_reader :id
+
+      def initialize(connection, data)
+        @connection = connection
+        @raw = data
+        @id = data["id"]
+      end
+
+      def form_id
+        @raw["form"]["id"]
+      end
+
+      def contact_id
+        @raw["lead"]["id"]
+      end
+
+      def form
+        @form ||= @connection.forms.new(@raw["form"].merge("fields" => @raw["results"]))
+      end
+
+      def contact
+        @connection.contacts.new(@raw["lead"])
+      end
+    end
+  end
+end

data/lib/mautic/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '1.0.5'
+  VERSION = '2.1.1'
 end

data/spec/spec_helper.rb

@@ -8,6 +8,10 @@ require 'pry-rails'
 
 ActiveRecord::Migration.maintain_test_schema!
 
+Dir.glob(File.expand_path('../support/*.rb', __FILE__)).each do |file|
+  require file
+end
+
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   # config.infer_spec_type_from_file_location!

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mautic
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.1.1
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 4.2.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 4.2.8
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,8 @@ files:
 - app/assets/stylesheets/mautic/application.css
 - app/assets/stylesheets/mautic/mautic_connections.css
 - app/assets/stylesheets/scaffold.css
+- app/controllers/concerns/mautic/connections_controller_concern.rb
+- app/controllers/concerns/mautic/receive_web_hooks.rb
 - app/controllers/mautic/application_controller.rb
 - app/controllers/mautic/connections_controller.rb
 - app/helpers/mautic/application_helper.rb
@@ -176,6 +178,7 @@ files:
 - app/models/mautic/connections/oauth2.rb
 - app/models/mautic/contact.rb
 - app/models/mautic/form.rb
+- app/models/mautic/web_hook.rb
 - app/views/layouts/mautic/application.html.erb
 - app/views/mautic/connections/_form.html.erb
 - app/views/mautic/connections/edit.html.erb
@@ -190,6 +193,9 @@ files:
 - lib/mautic/form_helper.rb
 - lib/mautic/model.rb
 - lib/mautic/proxy.rb
+- lib/mautic/spec_helper.rb
+- lib/mautic/submissions.rb
+- lib/mautic/submissions/form.rb
 - lib/mautic/version.rb
 - lib/tasks/mautic_tasks.rake
 - spec/rails_helper.rb
@@ -214,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails Mautic integration