mautic 2.3.8 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffa1c03fd57447ef4b33050b2fea5150a9c4b2665675fdb0894f1a914c7e24af
-  data.tar.gz: 05be7f0b16e1a3e0a9f3c3adc0e89c3e3b1c0554afd122777fce06ec2ab1dad9
+  metadata.gz: eb4e903dff064ccd272c769b31a9692b0479cc93f86d6caa7586f73adb0190d6
+  data.tar.gz: a96abb5a2f455fb0026bfe56be46640f49d6fdcf89673f27fb59ebae8f66aa42
 SHA512:
-  metadata.gz: 20100e7ada6a8715ffefe5d2210c4c4cdd20007e0f410ef9d66a192851deca4a86e4b4fb1e91e25a00ac639641d7210c2bf64cf1f8dec36b9476bc73edfd46cb
-  data.tar.gz: 9f6e8a2abcb4ac1e067420e88e1691a6fb0f63cc1ddb3ffaa1a0be8043985dd072735b2e1316c8e0a413dcde474e743c446ed65d2b815dc29da140866a820245
+  metadata.gz: 49997f77ce24fa44c9a3ec96a785b31d0ae382ccd754e9c3c89b1adabf33869b31dc3fbc0aaf25f38b3d988192cafa6ccc7d617b7c90a53ae516a6f218b8fa38
+  data.tar.gz: ab3974fd38ba6ce83c8b489634bce1a637b18effdddbcb779b98e5531d865cf4bd6363c899b57927a9374a409b35cc0f27865cffca7086963954bbfad9aa9828

data/README.md

@@ -32,13 +32,40 @@ Mautic.configure do |config|
   # OR it can be Proc 
   # *optional* This is your default mautic URL - used in form helper 
   config.mautic_url = "https://mautic.my.app"
+  # Set authorize condition for manage Mautic::Connections
+  config.authorize_mautic_connections = ->(controller) { false }
 end
 ```
+### Manage mautic connections
+You can use builtin Mautic:ConnectionsController:
 
 add to `config/routes.rb`
 ```ruby
 mount Mautic::Engine => "/mautic"
 ```
+note: Make sure that you have some user authorization. There is builtin mechanism, in `Mautic.config.authorize_mautic_connections` = which return `false` to prevent all access by default (see: app/controllers/mautic/connections_controller.rb:3). For change this, you need add to `config/initializers/mautic.rb`:
+```ruby
+Mautic.config.authorize_mautic_connections = ->(controller) { current_user.admin? }
+```
+
+OR use your own controller, by including concern 
+```ruby
+class MyOwnController < ApplicationController
+  before_action :authorize_user
+
+  include Mautic::ConnectionsControllerConcern
+end
+```
+Concern require additional routes (authorize and oauth2) in `routes.rb`
+```ruby
+resources :my_resources do
+  member do
+    get :authorize
+    get :oauth2
+  end
+end
+```
+
 ### Create mautic connection
   
 1. In your mautic, create new
@@ -67,11 +94,11 @@ mount Mautic::Engine => "/mautic"
   ```
   Get specify contact:
   ```ruby
-  contact = m.contact.find(1) # => #<Mautic::Contact id=1 ...>
+  contact = m.contact.find(1) # => #<Mautic::Contact id=1 ...>
   ```
   Collections of contacts:
   ```ruby
-  m.contacts.where("gmail").each do |contact|
+  m.contacts.where(search: "gmail").each do |contact|
     #<Mautic::Contact id=12 ...>
     #<Mautic::Contact id=21 ...>
     #<Mautic::Contact id=99 ...>
@@ -88,7 +115,7 @@ mount Mautic::Engine => "/mautic"
   contact.save # => false
   contact.errors # => [{"code"=>400, "message"=>"email: This field is required.", "details"=>{"email"=>["This field is required."]}}]
   ```
-  Do not contact
+  #### Do not contact
   ```ruby
   contact.do_not_contact? # => false
   contact.do_not_contact! message: "Some reason"
@@ -100,6 +127,18 @@ mount Mautic::Engine => "/mautic"
   contact.remove_do_not_contact!
   contact.do_not_contact? # => false
   ```
+  #### Campaigns
+  list of contacts campaigns (where contact is a member) and remove it from one
+  ```ruby
+  contact.campaigns #=> [Mautic::Campaign, ...]
+  campaign = contact.campaigns.find { |campaign| campaign.name == "Newsletter" }
+  campaign.remove_contact! contact.id
+  ```
+  or add contact back
+  ```ruby
+  campaign = connection.campaigns.where(search: "Newsletter").first
+  campaign.add_contact! contact.id
+  ```
   Of course you can use more than contact: `assets`, `emails`, `companies`, `forms`, `points` ...
 ### Gem provides simple Mautic form submit
 There are two options of usage:

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

@@ -85,12 +85,12 @@ module Mautic
     # ==--==--==--==--
 
     def authorize
-      redirect_to @mautic_connection.authorize
+      redirect_to @mautic_connection.authorize(self)
     end
 
     def oauth2
       begin
-        response = @mautic_connection.get_code(params.require(:code))
+        response = @mautic_connection.get_code(params.require(:code), self)
         @mautic_connection.update(token: response.token, refresh_token: response.refresh_token)
         return render plain: t('mautic.text_mautic_authorize_successfully')
       rescue OAuth2::Error => e

data/app/controllers/mautic/connections_controller.rb

@@ -1,5 +1,15 @@
 module Mautic
   class ConnectionsController < ApplicationController
+    before_action :authorize_me
     include ::Mautic::ConnectionsControllerConcern
+
+    private
+
+    def authorize_me
+      unless Mautic.config.authorize_mautic_connections.call(self)
+        logger.warn "Mautic::ConnectionsController unauthorized, you can change this by Mautic.config.authorize_mautic_connections. See: lib/mautic.rb:77"
+        render plain: "Unauthorized", status: 403
+      end
+    end
   end
 end

data/app/models/mautic/campaign.rb

@@ -0,0 +1,22 @@
+module Mautic
+  class Campaign < Model
+
+    # @see https://developer.mautic.org/#add-contact-to-a-campaign
+    # @param [Integer] id of Mautic::Contact
+    def add_contact!(id)
+      json = @connection.request(:post, "api/campaigns/#{self.id}/contact/#{id}/add")
+      json["success"]
+    rescue RequestError => _e
+      false
+    end
+
+    # @see https://developer.mautic.org/#remove-contact-from-a-campaign
+    # @param [Integer] id of Mautic::Contact
+    def remove_contact!(id)
+      json = @connection.request(:post, "api/campaigns/#{self.id}/contact/#{id}/remove")
+      json["success"]
+    rescue RequestError => _e
+      false
+    end
+  end
+end

data/app/models/mautic/company_field.rb

@@ -0,0 +1,11 @@
+module Mautic
+  class CompanyField < Model
+    def self.endpoint
+      "fields/company"
+    end
+
+    def self.in(connection)
+      Proxy.new(connection, endpoint, klass: name, data_name: "field")
+    end
+  end
+end

data/app/models/mautic/connection.rb

@@ -17,11 +17,11 @@ module Mautic
       raise NotImplementedError
     end
 
-    def authorize
+    def authorize(context)
       raise NotImplementedError
     end
 
-    def get_code(code)
+    def get_code(code, context)
       raise NotImplementedError
     end
 
@@ -55,7 +55,7 @@ module Mautic
 
     private
 
-    def callback_url
+    def callback_url(context)
       if (conf = Mautic.config.base_url).is_a?(Proc)
         conf = conf.call(self)
       end

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

@@ -11,12 +11,12 @@ module Mautic
         })
       end
 
-      def authorize
-        client.auth_code.authorize_url(redirect_uri: callback_url)
+      def authorize(context)
+        client.auth_code.authorize_url(redirect_uri: callback_url(context))
       end
 
-      def get_code(code)
-        client.auth_code.get_token(code, redirect_uri: callback_url)
+      def get_code(code, context)
+        client.auth_code.get_token(code, redirect_uri: callback_url(context))
       end
 
       def connection
@@ -37,9 +37,10 @@ module Mautic
 
       private
 
-      def callback_url
+      def callback_url(context)
         uri = super
-        uri.path = Mautic::Engine.routes.url_helpers.oauth2_connection_path(self)
+        # uri.path = Mautic::Engine.routes.url_helpers.oauth2_connection_path(self)
+        uri.path = context.url_for(action: "oauth2", id: self , only_path: true)
         uri.to_s
       end
 

data/app/models/mautic/contact.rb

@@ -41,8 +41,9 @@ module Mautic
 
       if source
         self.owner = source['owner'] || {}
+        tags = (source['tags'] || []).map { |t| Mautic::Tag.new(self, t) }.sort_by(&:name)
         self.attributes = {
-          tags: (source['tags'] || []).collect { |t| Mautic::Tag.new(@connection, t) }.sort_by(&:name),
+          tags: Tag::Collection.new(self, *tags),
           doNotContact: source['doNotContact'] || [],
           owner: owner['id'],
         }
@@ -51,7 +52,6 @@ module Mautic
 
     def to_mautic(data = @table)
       data.delete(:doNotContact)
-      data.delete(:tags)
       super(data)
     end
 
@@ -96,7 +96,7 @@ module Mautic
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
 
     alias add_dnc do_not_contact!
@@ -117,6 +117,23 @@ module Mautic
 
     # !endgroup
 
+    # @!group Campaigns
+
+    # @return [Array<Mautic::Campaign>]
+    def campaigns
+      return @campaigns if @campaigns
+
+      json = @connection.request(:get, "api/contacts/#{id}/campaigns")
+
+      @campaigns = json["campaigns"].collect do |_campaign_id, campaign_attributes|
+        Mautic::Campaign.new @connection, campaign_attributes
+      end
+    rescue RequestError => _e
+      []
+    end
+
+    # !endgroup
+
     private
 
     def clear_change

data/app/models/mautic/contact_field.rb

@@ -0,0 +1,11 @@
+module Mautic
+  class ContactField < Model
+    def self.endpoint
+      "fields/contact"
+    end
+
+    def self.in(connection)
+      Proxy.new(connection, endpoint, klass: name, data_name: "field")
+    end
+  end
+end

data/app/models/mautic/form.rb

@@ -5,5 +5,34 @@ module Mautic
       self.attributes = { name: source['name'], fields: source['fields'] } if source.is_a? Hash
     end
 
+    # @param [Integer] submission_id
+    # @return Mautic::Submissions::Form
+    # @see https://developer.mautic.org/#get-form-submission
+    def submission(submission_id)
+      json = @connection.request(:get, "api/forms/#{id}/submissions/#{submission_id}")
+      Mautic::Submissions::Form.new @connection, json["submission"]
+    rescue Mautic::RecordNotFound => _e
+      nil
+    end
+
+    # @see https://developer.mautic.org/#list-form-submissions
+    # @param [Hash] options
+    # @option options [String] :search String or search command to filter entities by.
+    # @option options [String] :start Starting row for the entities returned. Defaults to 0.
+    # @option options [String] :limit Limit number of entities to return. Defaults to the system configuration for pagination (30).
+    # @option options [String] :orderBy Column to sort by. Can use any column listed in the response, also can use column of joined table with prefix. Sort by submitted date is s.date_submitted
+    # @option options [String] :orderByDir Sort direction: asc or desc.
+    # @option options [String] :publishedOnly Only return currently published entities.
+    # @option options [String] :minimal Return only array of entities without additional lists in it.
+    # @return Array[Mautic::Submissions::Form]
+    def submissions(**options)
+      json = @connection.request(:get, "api/forms/#{id}/submissions", params: options)
+      @submissions = json["submissions"].collect do |attributes|
+        Mautic::Submissions::Form.new @connection, attributes
+      end
+    rescue RequestError => _e
+      []
+    end
+
   end
-end
+end

data/app/models/mautic/tag.rb

@@ -1,6 +1,34 @@
 module Mautic
   class Tag < Model
 
+    class Collection < Array
+      attr_reader :model
+
+      # @param [Mautic::Model] model
+      def initialize(model, *several_variants)
+        @model = model
+        @tags_to_remove = []
+        super(several_variants)
+      end
+
+      def <<(item)
+        @model.changed = true
+        item = Tag.new(@model, { tag: item }) if item.is_a?(String)
+        super(item)
+      end
+
+      def remove(item)
+        @model.changed = true
+        item = detect { |t| t.name == item } if item.is_a?(String)
+        @tags_to_remove << "-#{item}"
+        delete item
+      end
+
+      def to_mautic
+        map(&:name) + @tags_to_remove
+      end
+    end
+
     # alias for attribute :tag
     def name
       tag

data/app/models/mautic/web_hook.rb

@@ -12,10 +12,10 @@ module Mautic
 
     def form_submissions
       @forms ||= Array.wrap(@params.require("mautic.form_on_submit")).collect do |data|
-        p = data.permit(submission: [:id, form: {}, lead: {}, results: {}]).to_h
+        p = data.permit(submission: [:id, :referer, form: {}, lead: {}, results: {}]).to_h
         ::Mautic::Submissions::Form.new(@connection, p["submission"]) if p["submission"]
       end.compact
     end
 
   end
-end
+end

data/app/views/layouts/mautic/application.html.erb

@@ -2,8 +2,6 @@
 <html>
   <head>
     <title>Mautic</title>
-    <%= stylesheet_link_tag "mautic/application", media: "all" %>
-    <%= javascript_include_tag "mautic/application" %>
     <%= csrf_meta_tags %>
   </head>
   <body>

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

@@ -24,7 +24,7 @@
   <% if form.object.persisted? %>
     <div class="field">
       <label>Now generate pair of tokens with this callback url:</label>
-      <pre><%= @mautic_connection.send :callback_url %></pre>
+      <pre><%= @mautic_connection.send :callback_url, controller %></pre>
     </div>
 
     <div class="field">

data/config/routes.rb

@@ -3,8 +3,6 @@ Mautic::Engine.routes.draw do
     member do
       get :authorize
       get :oauth2
-
     end
-    # post "webhook/:mautic_connection_id", action: "webhook", on: :collection
   end
 end

data/lib/mautic.rb

@@ -67,10 +67,14 @@ module Mautic
   end
 
   configure do |config|
-    # This is URL your application - its for oauth callbacks
+    # This is URL of your application - its for oauth callbacks
     config.base_url = "http://localhost:3000"
+
     # *optional* This is your default mautic URL - used in form helper
     config.mautic_url = "https://mautic.my.app"
+
+    # Set authorize condition for manage Mautic::Connections
+    config.authorize_mautic_connections = ->(controller) { false }
   end
   # Your code goes here...
 

data/lib/mautic/model.rb

@@ -39,6 +39,7 @@ module Mautic
 
     attr_reader :connection
     attr_accessor :errors
+    attr_writer :changed
 
     # @param [Mautic::Connection] connection
     def initialize(connection, hash = nil)
@@ -58,7 +59,7 @@ module Mautic
     end
 
     def update(force = false)
-      return false if changes.blank?
+      return false unless changed?
 
       begin
         json = @connection.request((force && :put || :patch), "api/#{endpoint}/#{id}/edit", body: to_mautic)
@@ -68,7 +69,7 @@ module Mautic
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
 
     def update_columns(attributes = {})
@@ -88,7 +89,7 @@ module Mautic
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
 
     def destroy
@@ -105,6 +106,12 @@ module Mautic
       @table.changes
     end
 
+    def changed?
+      return @changed unless @changed.nil?
+
+      @changed = !changes.empty?
+    end
+
     def attributes
       @table.to_h
     end
@@ -118,13 +125,20 @@ module Mautic
 
     def to_mautic(data = @table)
       data.each_with_object({}) do |(key, val), mem|
-        mem[key] = val.is_a?(Array) ? val.join("|") : val
+        mem[key] = if val.respond_to?(:to_mautic)
+                     val.to_mautic
+                   elsif val.is_a?(Array)
+                     val.join("|")
+                   else
+                     val
+                   end
       end
     end
 
     private
 
     def clear_changes
+      @changed = nil
       @table.instance_variable_set(:@changes, nil)
     end
 

data/lib/mautic/proxy.rb

@@ -14,7 +14,7 @@ module Mautic
     end
 
     def data_name
-      @endpoint.split("/").last
+      @options[:data_name] || @endpoint.split("/").last
     end
 
     def build_instance(data)
@@ -79,4 +79,4 @@ module Mautic
     end
 
   end
-end
+end

data/lib/mautic/submissions/form.rb

@@ -1,5 +1,6 @@
 module Mautic
   module Submissions
+    # @see https://developer.mautic.org/#get-form-submissions
     class Form
       attr_reader :id
 
@@ -30,6 +31,17 @@ module Mautic
       def contact
         @contact ||= @connection.contacts.new(@raw["lead"])
       end
+
+      # @return [String]
+      def referer
+        @raw["referer"].to_s
+      end
+
+      # @return [Hash]
+      def results
+        @raw["results"]
+      end
+
     end
   end
-end
+end

data/lib/mautic/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '2.3.8'
+  VERSION = '2.5.0'
 end

data/spec/spec_helper.rb

@@ -46,6 +46,9 @@ RSpec.configure do |config|
 
   config.before(:each) do
     DatabaseCleaner.strategy = :transaction
+    Mautic.configure do |config|
+      config.authorize_mautic_connections = ->(controller) { true }
+    end
   end
 
   config.before(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mautic
 version: !ruby/object:Gem::Version
-  version: 2.3.8
+  version: 2.5.0
 platform: ruby
 authors:
 - Lukáš Pokorný
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -160,12 +160,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/mautic_manifest.js
-- app/assets/javascripts/mautic/application.js
-- app/assets/javascripts/mautic/mautic_connections.js
-- 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
@@ -174,9 +168,12 @@ files:
 - app/jobs/mautic/application_job.rb
 - app/mailers/mautic/application_mailer.rb
 - app/models/mautic/application_record.rb
+- app/models/mautic/campaign.rb
+- app/models/mautic/company_field.rb
 - app/models/mautic/connection.rb
 - app/models/mautic/connections/oauth2.rb
 - app/models/mautic/contact.rb
+- app/models/mautic/contact_field.rb
 - app/models/mautic/event.rb
 - app/models/mautic/form.rb
 - app/models/mautic/tag.rb
@@ -207,7 +204,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +219,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby on Rails Mautic integration
 test_files:

data/app/assets/config/mautic_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/mautic .js
-//= link_directory ../stylesheets/mautic .css

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

@@ -1,14 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-// require rails-ujs
-//= require_tree .

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

@@ -1,2 +0,0 @@
-// Place all the behaviors and hooks related to the matching controller here.
-// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/mautic/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/assets/stylesheets/mautic/mautic_connections.css

@@ -1,4 +0,0 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/

data/app/assets/stylesheets/scaffold.css

@@ -1,80 +0,0 @@
-body {
-  background-color: #fff;
-  color: #333;
-  margin: 33px;
-}
-
-body, p, ol, ul, td {
-  font-family: verdana, arial, helvetica, sans-serif;
-  font-size: 13px;
-  line-height: 18px;
-}
-
-pre {
-  background-color: #eee;
-  padding: 10px;
-  font-size: 11px;
-}
-
-a {
-  color: #000;
-}
-
-a:visited {
-  color: #666;
-}
-
-a:hover {
-  color: #fff;
-  background-color: #000;
-}
-
-th {
-  padding-bottom: 5px;
-}
-
-td {
-  padding: 0 5px 7px;
-}
-
-div.field,
-div.actions {
-  margin-bottom: 10px;
-}
-
-#notice {
-  color: green;
-}
-
-.field_with_errors {
-  padding: 2px;
-  background-color: red;
-  display: table;
-}
-
-#error_explanation {
-  width: 450px;
-  border: 2px solid red;
-  padding: 7px 7px 0;
-  margin-bottom: 20px;
-  background-color: #f0f0f0;
-}
-
-#error_explanation h2 {
-  text-align: left;
-  font-weight: bold;
-  padding: 5px 5px 5px 15px;
-  font-size: 12px;
-  margin: -7px -7px 0;
-  background-color: #c00;
-  color: #fff;
-}
-
-#error_explanation ul li {
-  font-size: 12px;
-  list-style: square;
-}
-
-label {
-  display: block;
-}