mautic 2.3.4 → 2.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afb8b76cddd73b61cfefac55cd183fd3b84603dfc1681fe00d4c524838cf5bcb
-  data.tar.gz: 8a632817a47a0e2819a4cd74fef4798ebddf80cd9c68fdebad462bb0ca3a570d
+  metadata.gz: 59800fcfc64665ad1873fc20ef004bffe54edd38c2bb4da6263e702c0caba571
+  data.tar.gz: e32ddec1e3707e5cf8fab1232de729a6c8df75d30f2520dc1620eec57bf857c7
 SHA512:
-  metadata.gz: cb0312a5a188a6619421a33b4768dd5e2aa90ea6ef7764e67a7ad169e9b1ec24bf342c9eb1ce4c22958a24562c22a2c80285daa8f48c14c9df1fc2bca2603dcf
-  data.tar.gz: 4b4b003e569e396529ece6d0971d749131996d0e0692cf33f64af21efa164820dab732b155526d3074d4e136c9ac91648180d540407523f8f4a9e9815de5ca5f
+  metadata.gz: 0b8433f04ee7a96e9474a0f8b39a883637d68b5b2135203f150fc697d5a495e3a7447311c1d27171fe7545c74b979ee4b7727397ba279fde1ce9472b2ed29809
+  data.tar.gz: 495c134933d712de9598cc618bf308f5b297e59bf86040d3e1c25b7ad636ee910932b08adc46c3a1a7144459b3f17e49dbb8cb57b167d28084715f8e19ed8197

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
@@ -88,6 +115,18 @@ 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
+  ```ruby
+  contact.do_not_contact? # => false
+  contact.do_not_contact! message: "Some reason"
+  contact.do_not_contact? # => true
+  ```
+  Remove do not contact
+  ```ruby
+  contact.do_not_contact? # => true
+  contact.remove_do_not_contact!
+  contact.do_not_contact? # => false
+  ```
   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/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

@@ -3,6 +3,7 @@ module Mautic
 
     alias_attribute :first_name, :firstname
     alias_attribute :last_name, :lastname
+
     def self.in(connection)
       Proxy.new(connection, endpoint, default_params: { search: '!is:anonymous' })
     end
@@ -11,16 +12,116 @@ 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
-      self.attributes = {
-        tags: (source['tags'] || []).collect { |t| Mautic::Tag.new(@connection, t) }.sort_by(&:name)
-      } if source
+
+      if source
+        self.owner = source['owner'] || {}
+        self.attributes = {
+          tags: (source['tags'] || []).collect { |t| Mautic::Tag.new(@connection, t) }.sort_by(&:name),
+          doNotContact: source['doNotContact'] || [],
+          owner: owner['id'],
+        }
+      end
+    end
+
+    def to_mautic(data = @table)
+      data.delete(:doNotContact)
+      data.delete(:tags)
+      super(data)
     end
 
     def events
       @proxy_events ||= Proxy.new(connection, "contacts/#{id}/events", klass: "Mautic::Event")
     end
 
+    # @!group Do Not Contact
+    # @see https://developer.mautic.org/#add-do-not-contact
+
+    def do_not_contact?
+      doNotContact.present?
+    end
+
+    alias dnc? do_not_contact?
+
+    # @return [Array[Hash]]
+    def do_not_contact
+      return unless do_not_contact?
+
+      # Based on mautic docs => Contacts constants: Contacts::UNSUBSCRIBED (1), Contacts::BOUNCED (2), Contacts::MANUAL (3)
+      reason_list = { 1 => :unsubscribed, 2 => :bounced, 3 => :manual }
+      @do_not_contact ||= doNotContact.collect do |hsh|
+        { reason_list[hsh["reason"]] => hsh["comments"] }
+      end
+    end
+
+    def bounced?
+      do_not_contact? && !!do_not_contact.detect { |dnc| dnc.key?(:bounced) }
+    end
+
+    def unsubscribed?
+      do_not_contact? && !!do_not_contact.detect { |dnc| dnc.key?(:unsubscribed) }
+    end
+
+    def do_not_contact!(comments: '')
+      begin
+        json = @connection.request(:post, "api/contacts/#{id}/dnc/email/add", body: { comments: comments })
+        self.attributes = { doNotContact: json[endpoint.singularize]["doNotContact"] }
+        clear_changes
+      rescue ValidationError => e
+        self.errors = e.errors
+      end
+
+      self.errors.blank?
+    end
+
+    alias add_dnc do_not_contact!
+
+    def remove_do_not_contact!
+      begin
+        json = @connection.request(:post, "api/contacts/#{id}/dnc/email/remove", body: {})
+        self.attributes = { doNotContact: json[endpoint.singularize]["doNotContact"] }
+        clear_changes
+      rescue ValidationError => e
+        self.errors = e.errors
+      end
+
+      self.errors.blank?
+    end
+
+    alias remove_dnc remove_do_not_contact!
+
+    # !endgroup
+
+    private
+
+    def clear_change
+      super
+      remove_instance_variable :@do_not_contact
+    end
   end
 end

data/app/models/mautic/tag.rb

@@ -6,6 +6,10 @@ module Mautic
       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,7 @@ module Mautic
     end
 
     attr_reader :connection
+    attr_accessor :errors
 
     # @param [Mautic::Connection] connection
     def initialize(connection, hash = nil)
@@ -58,9 +59,10 @@ module Mautic
 
     def update(force = false)
       return false if changes.blank?
+
       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
@@ -69,10 +71,18 @@ module Mautic
       self.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
@@ -106,8 +116,8 @@ module Mautic
       end
     end
 
-    def to_mautic
-      @table.each_with_object({}) do |(key,val), mem|
+    def to_mautic(data = @table)
+      data.each_with_object({}) do |(key, val), mem|
         mem[key] = val.is_a?(Array) ? val.join("|") : val
       end
     end

data/lib/mautic/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '2.3.4'
+  VERSION = '2.3.9'
 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.4
+  version: 2.3.9
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails Mautic integration