mautic 2.3.9 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59800fcfc64665ad1873fc20ef004bffe54edd38c2bb4da6263e702c0caba571
-  data.tar.gz: e32ddec1e3707e5cf8fab1232de729a6c8df75d30f2520dc1620eec57bf857c7
+  metadata.gz: 8369fa0948409afca63ba594d3c630729dd160bc27fd9808dbaa941fab2e6a6e
+  data.tar.gz: 0cbc398f5515825575367d69866f176659713af2835df403901ee7321bdd0d85
 SHA512:
-  metadata.gz: 0b8433f04ee7a96e9474a0f8b39a883637d68b5b2135203f150fc697d5a495e3a7447311c1d27171fe7545c74b979ee4b7727397ba279fde1ce9472b2ed29809
-  data.tar.gz: 495c134933d712de9598cc618bf308f5b297e59bf86040d3e1c25b7ad636ee910932b08adc46c3a1a7144459b3f17e49dbb8cb57b167d28084715f8e19ed8197
+  metadata.gz: 623bedbe8dce28df4d92147ba646ff88506e1e2ddb883903ac687cfba6927164579279011307fbe53587d6940cd94a71feb55a31ef0a4642a7140a1e86f80253
+  data.tar.gz: e33d151ab4d0b44b4c978c347f6b56b1b4407520d814d9c62a2f0db1b363dab893cea944727158eab115ef17d9c9a0dec754c80ef25aaaf85bcfa3be5a556320

data/README.md

@@ -94,11 +94,11 @@ end
   ```
   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 ...>
@@ -115,7 +115,7 @@ end
   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"
@@ -127,6 +127,18 @@ end
   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/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/contact.rb

@@ -1,6 +1,9 @@
 module Mautic
   class Contact < Model
 
+    around_create :ensure_stage, if: ->(contact) { contact.changes.has_key?(:stage_id) }
+    around_update :ensure_stage, if: ->(contact) { contact.changes.has_key?(:stage_id) }
+
     alias_attribute :first_name, :firstname
     alias_attribute :last_name, :lastname
 
@@ -41,17 +44,19 @@ module Mautic
 
       if source
         self.owner = source['owner'] || {}
+        self.stage = source['stage'] || {}
+        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'],
+          stage_id: stage&.id,
         }
       end
     end
 
     def to_mautic(data = @table)
       data.delete(:doNotContact)
-      data.delete(:tags)
       super(data)
     end
 
@@ -96,7 +101,7 @@ module Mautic
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
 
     alias add_dnc do_not_contact!
@@ -117,11 +122,64 @@ 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
+
+    # @!group Stage
+
+    # @return [Mautic::Stage, nil]
+    def stage
+      @stage
+    end
+
+    # @param [Mautic:::Stage,Hash, nil] hash
+    def stage=(object_or_hash)
+      @stage = case object_or_hash
+               when Mautic::Stage
+                 object_or_hash
+               when Hash
+                 Mautic::Stage.new(connection, object_or_hash)
+               end
+      @table[:stage_id] = @stage&.id
+      @stage
+    end
+
+    # !endgroup
+
     private
 
     def clear_change
       super
       remove_instance_variable :@do_not_contact
     end
+
+    # Add or Remove contact in stage after contact save
+    def ensure_stage
+      stage_id_change = changes[:stage_id]
+      yield
+      if stage_id_change
+        self.stage = Mautic::Stage.in(connection).find(stage_id_change)
+        stage.add_contact!(id)
+        @table[:stage_id] = stage.id
+      else
+        stage.remove_contact!(id)
+        @table.delete(:stage_id)
+      end
+      clear_changes
+    end
   end
-end
+end

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/stage.rb

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

@@ -2,6 +2,7 @@ module Mautic
   # Virtual model for Mautic endpoint
   #   @see https://developer.mautic.org/#endpoints
   class Model < OpenStruct
+    extend ActiveModel::Callbacks
 
     class MauticHash < Hash
 
@@ -37,8 +38,11 @@ module Mautic
 
     end
 
+    define_model_callbacks :create, :update, :save
+
     attr_reader :connection
     attr_accessor :errors
+    attr_writer :changed
 
     # @param [Mautic::Connection] connection
     def initialize(connection, hash = nil)
@@ -54,21 +58,25 @@ module Mautic
     end
 
     def save(force = false)
-      id.present? ? update(force) : create
+      run_callbacks :save do
+        id.present? ? update(force) : create
+      end
     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)
-        assign_attributes json[endpoint.singularize]
+        run_callbacks :create do
+          json = @connection.request((force && :put || :patch), "api/#{endpoint}/#{id}/edit", body: to_mautic)
+          assign_attributes json[endpoint.singularize]
+        end
         clear_changes
       rescue ValidationError => e
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
 
     def update_columns(attributes = {})
@@ -81,14 +89,16 @@ module Mautic
 
     def create
       begin
-        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", body: to_mautic)
-        assign_attributes json[endpoint.singularize]
+        run_callbacks :create do
+          json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", body: to_mautic)
+          assign_attributes json[endpoint.singularize]
+        end
         clear_changes
       rescue ValidationError => e
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
 
     def destroy
@@ -105,6 +115,12 @@ module Mautic
       @table.changes
     end
 
+    def changed?
+      return @changed unless @changed.nil?
+
+      @changed = !changes.empty?
+    end
+
     def attributes
       @table.to_h
     end
@@ -117,14 +133,21 @@ module Mautic
     end
 
     def to_mautic(data = @table)
-      data.each_with_object({}) do |(key, val), mem|
-        mem[key] = val.is_a?(Array) ? val.join("|") : val
+      data.transform_values do |val|
+        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.9'
+  VERSION = '2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mautic
 version: !ruby/object:Gem::Version
-  version: 2.3.9
+  version: 2.6.0
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-02-08 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,11 +168,15 @@ 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/stage.rb
 - app/models/mautic/tag.rb
 - app/models/mautic/web_hook.rb
 - app/views/layouts/mautic/application.html.erb
@@ -222,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails Mautic integration

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;
-}