mautic 2.3.8 → 2.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffa1c03fd57447ef4b33050b2fea5150a9c4b2665675fdb0894f1a914c7e24af
-  data.tar.gz: 05be7f0b16e1a3e0a9f3c3adc0e89c3e3b1c0554afd122777fce06ec2ab1dad9
+  metadata.gz: 59800fcfc64665ad1873fc20ef004bffe54edd38c2bb4da6263e702c0caba571
+  data.tar.gz: e32ddec1e3707e5cf8fab1232de729a6c8df75d30f2520dc1620eec57bf857c7
 SHA512:
-  metadata.gz: 20100e7ada6a8715ffefe5d2210c4c4cdd20007e0f410ef9d66a192851deca4a86e4b4fb1e91e25a00ac639641d7210c2bf64cf1f8dec36b9476bc73edfd46cb
-  data.tar.gz: 9f6e8a2abcb4ac1e067420e88e1691a6fb0f63cc1ddb3ffaa1a0be8043985dd072735b2e1316c8e0a413dcde474e743c446ed65d2b815dc29da140866a820245
+  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

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

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '2.3.8'
+  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.8
+  version: 2.3.9
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 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.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails Mautic integration