mautic 2.3.5 → 2.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af1f088355eb05f40c5b2d22ce36e6c6319ff7e0bc7b6e62b798762a2a400724
-  data.tar.gz: 92867e40e6b9722094f2c174b4a40286cdac41e07c09553e11b38df4caaff4c6
+  metadata.gz: 5b00390acf94aa6294ef58fbfeab2d3a0198544c52b162c837134adf79e8c3ad
+  data.tar.gz: 3efd6bea9cdc79cd58b535489edc1a6cd11ae5539797b2246feaa1760662009f
 SHA512:
-  metadata.gz: 361320378ad1c77a3bd8b0a3600ad30fe5c5a95fc7aab7a934992a1fd591c23fd872b3c5aa0ebaf30e54e87997763bc3775119747ef2fa0f449a8252fd3626d2
-  data.tar.gz: 5a630110651bd5fd915fd05570953bdf326c513cdea05d20f0040a6628a6b9b159bf55af5e0ffca6153dab32061a2fdd9dc0f30bd4c7d82401ccf098e9f4072f
+  metadata.gz: cc3eb999f11d813f81047485875e194acd8c41f9de2910f87df449af5be27a90d577eab222651acbe3565c804e7c9510a458cfc0e0a7f643c9217f049f035e59
+  data.tar.gz: dc2eeb43ce4ad5f5805e92e4bc452f91abbd3fbd2e16df28a6b1abdc78a9fd1975ac9faa1bdd7756d118feb792d20c0eec4e405e257cffff1d46828ac5eb50a4

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/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

@@ -12,16 +12,49 @@ module Mautic
       "#{firstname} #{lastname}"
     end
 
+    # @param [Hash] hash
+    # option hash [Integer] :id
+    # option hash [String] :firstName
+    # option hash [String] :lastName
+    def owner=(hash)
+      raise ArgumentError, "must be a hash !" unless hash.is_a?(Hash)
+
+      @table[:owner] = hash["id"]
+      @owner = hash
+    end
+
+    # @return [Hash]
+    # @example {id: 12, firstName: "Joe", lastName: "Doe"}
+    def owner
+      @owner || {}
+    end
+
+    # Assign mautic User ID as owner - for example for update author of contact
+    # @see https://developer.mautic.org/#edit-contact set owner
+    # @param [Integer] int
+    def owner_id=(int)
+      @table[:owner] = int
+    end
+
     def assign_attributes(source = nil)
       super
+
       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
@@ -32,6 +65,7 @@ module Mautic
     def do_not_contact?
       doNotContact.present?
     end
+
     alias dnc? do_not_contact?
 
     # @return [Array[Hash]]
@@ -62,8 +96,9 @@ module Mautic
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
+
     alias add_dnc do_not_contact!
 
     def remove_do_not_contact!
@@ -77,6 +112,7 @@ module Mautic
 
       self.errors.blank?
     end
+
     alias remove_dnc remove_do_not_contact!
 
     # !endgroup

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/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

@@ -38,6 +38,8 @@ module Mautic
     end
 
     attr_reader :connection
+    attr_accessor :errors
+    attr_writer :changed
 
     # @param [Mautic::Connection] connection
     def initialize(connection, hash = nil)
@@ -57,28 +59,37 @@ 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 })
-        self.attributes = json[endpoint.singularize]
+        json = @connection.request((force && :put || :patch), "api/#{endpoint}/#{id}/edit", body: to_mautic)
+        assign_attributes json[endpoint.singularize]
         clear_changes
       rescue ValidationError => e
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
+    end
+
+    def update_columns(attributes = {})
+      json = @connection.request(:patch, "api/#{endpoint}/#{id}/edit", body: to_mautic(attributes))
+      assign_attributes json[endpoint.singularize]
+      clear_changes
+    rescue ValidationError => e
+      self.errors = e.errors
     end
 
     def create
       begin
-        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", { body: to_mautic })
-        self.attributes = json[endpoint.singularize]
+        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", body: to_mautic)
+        assign_attributes json[endpoint.singularize]
         clear_changes
       rescue ValidationError => e
         self.errors = e.errors
       end
 
-      self.errors.blank?
+      errors.blank?
     end
 
     def destroy
@@ -95,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
@@ -106,15 +123,22 @@ module Mautic
       end
     end
 
-    def to_mautic
-      @table.each_with_object({}) do |(key,val), mem|
-        mem[key] = val.is_a?(Array) ? val.join("|") : val
+    def to_mautic(data = @table)
+      data.each_with_object({}) do |(key, val), mem|
+        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/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '2.3.5'
+  VERSION = '2.3.10'
 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.5
+  version: 2.3.10
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2020-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails