mautic 2.3.7 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a1c181282f3dfa4350d619d42c0abdea2b310d2ba85b2f8ca06e875e5eece65
-  data.tar.gz: 5f9921e8982d447ff37493791b88d0a00a37cdc6d52058c10734e23ed55eaef4
+  metadata.gz: c03bde50c40a75d830eb7e281af2ecc36143b62a9db7b30647a26bb1044013d4
+  data.tar.gz: 0eda55684550a7512e911792846a0d7646ba4da0a1a15a216ecc6836876deda5
 SHA512:
-  metadata.gz: 4640a5a580ec8deb680a05eac9d558bb99d5685e84282e3d41d3edf38b4d3143a484cf3fd58f0d0fd7ac20c42a97f62144d03820540e4ad45dd9ffaf9e3b99a1
-  data.tar.gz: 4a12224e16bb2cd5adbf64538b81f17914699dacc84ddf57d9ba10e95b5e69c17e5672b00bfc8fe4e4d41501946d808a364c92eb3ea50269fb8ce78f2f26b9f8
+  metadata.gz: 7382580246a31dcc47c03fb1c9ef98168fd4a0429439b8b45794db9f8dc263d839866a3f3e4c0c4aeab741d074c8fa6029d0cef25be67e0a279b2f68b1d8d8c0
+  data.tar.gz: 8e801c01c6aec779c05e7f858dfdfe45dc3ca06b21c86086e42f4f0a180a0251e1ab02bf4edb84ed0c2c91658b7e8e8f9370b81511b04324ed10efa2bbdf6e15

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

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/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,14 +41,20 @@ 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'],
         }
       end
     end
 
+    def to_mautic(data = @table)
+      data.delete(:doNotContact)
+      super(data)
+    end
+
     def events
       @proxy_events ||= Proxy.new(connection, "contacts/#{id}/events", klass: "Mautic::Event")
     end
@@ -90,7 +96,7 @@ module Mautic
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
 
     alias add_dnc do_not_contact!
@@ -111,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/tag.rb

@@ -1,11 +1,43 @@
 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
     end
 
+    def to_s
+      name
+    end
+
     def name=(name)
       self.tag = name
     end

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/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/submissions/form.rb

@@ -30,6 +30,12 @@ module Mautic
       def contact
         @contact ||= @connection.contacts.new(@raw["lead"])
       end
+
+      # @return [String]
+      def referer
+        @raw["referer"].to_s
+      end
+
     end
   end
-end
+end

data/lib/mautic/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '2.3.7'
+  VERSION = '2.4.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.7
+  version: 2.4.0
 platform: ruby
 authors:
 - Lukáš Pokorný
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -174,6 +174,7 @@ 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/connection.rb
 - app/models/mautic/connections/oauth2.rb
 - app/models/mautic/contact.rb
@@ -207,7 +208,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +223,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.0.6
+signing_key:
 specification_version: 4
 summary: Ruby on Rails Mautic integration
 test_files: