redmine_mautic 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2dd12867669658f7fbef2bf96263cc2b0c7807f0aeab9c3ca35a568460ed5c26
+  data.tar.gz: 35d02d9c9d0321312d04dd097506db2cbe04b45fa7aab1112d9073125c170bd1
+SHA512:
+  metadata.gz: 5e1a48adcdb3d24d63adef2e70c483951c37cfa03b14f665d3ca6b7d0cf87f958010b7cfd1b55fee1303582b4d306b60cebbaa758df4909039de3ffb1816d08a
+  data.tar.gz: 91c421904416debe2e82ab047d58563a5f2a542968cb38fb149c15390888f5f1acaea26189246bca444e8486dabf70bbd648e687368ec4ffc28161f233d60256

data/README.md

@@ -0,0 +1,39 @@
+# Redmine interface for mautic rails gem
+
+This [redmine](https://github.com/redmine/redmine) feature allow to simply create new connection to your mautic for API integration
+
+## Installation
+
+Add to your gemfile
+
+    gem "rys", github: "easysoftware/rys"
+    gem "mautic_redmine", github: "luk4s/redmine_mautic"
+    
+Then run
+    
+    bundle install
+    
+And of course migrations
+
+    rake db:migrate
+    
+## Usage
+
+Connections list are manage on address `/redmine_mautic`.
+
+Add new connection in 3+1 steps:
+
+1. New button on `/redmine_mautic` > type your mautic URL and hit "create"
+2. In your mautic create new API credentials and as callback url use url from form in redmine.
+3. Copy keys from mautic to redmine form and press "update".
+4. Hit "Authorize" button...
+
+## Development
+
+For development [ryspec](https://github.com/easysoftware/ryspec) plugin is recommended
+
+    gem 'ryspec', github: "easysoftware/ryspec"
+
+## Contributing
+
+Pull requests are welcome

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+
+possible_app_dirs = [
+  ENV['DUMMY_PATH'],
+  File.join(Dir.pwd, 'test/dummy')
+]
+dir = possible_app_dirs.compact.first
+
+if !File.directory?(dir)
+  abort("Directory '#{dir}' does not exists")
+end
+
+APP_RAKEFILE = File.expand_path(File.join(dir, 'Rakefile'), __dir__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/app/controllers/redmine_mautic_controller.rb

@@ -0,0 +1,3 @@
+  class RedmineMauticController < ApplicationController
+    include ::Mautic::ConnectionsControllerConcern
+  end

data/app/views/issues/redmine_mautic/_view_issues_show_details_bottom.html.erb

@@ -0,0 +1,8 @@
+<% Rys::Feature.on('redmine_mautic.issue.show') do %>
+  <hr>
+  <div>
+    <strong>Test 1</strong> <%= @redmine_mautic_test_1 %><br>
+    <strong>Test 2</strong> <%= @redmine_mautic_test_2 %>
+  </div>
+  <hr>
+<% end %>

data/app/views/redmine_mautic/_form.html.erb

@@ -0,0 +1,32 @@
+<%= error_messages_for form.object %>
+
+<div class="box tabular">
+  <p class="field">
+    <%= form.select :type, %w(Mautic::Connections::Oauth2) %>
+  </p>
+
+  <p class="field">
+    <%= form.text_field :url, label: form.object.class.human_attribute_name(:url), placeholder: 'https://mautic.org', required: true %>
+  </p>
+</div>
+<div class="box tabular">
+  <% unless form.object.new_record? %>
+    <p class="field">
+      <label>Callback url</label>
+      <%= Setting.protocol %>://<%= Setting.host_name %>/mautic/connections/<%= (form.object.id || Mautic::Connection.last.id.next) %>/oauth2
+      <em class="info">Now generate pair of tokens with this callback url</em>
+    </p>
+    <p class="field settings">
+      <%= form.text_field :client_id, label: form.object.class.human_attribute_name(:client_id), size: 50 %>
+    </p>
+
+    <p class="field">
+      <%= form.text_field :secret, label: form.object.class.human_attribute_name(:secret), size: 50 %>
+    </p>
+
+  <% end %>
+
+  <p class="actions">
+    <%= form.submit %>
+  </p>
+</div>

data/app/views/redmine_mautic/edit.html.erb

@@ -0,0 +1,8 @@
+<div class="contextual">
+  <%= link_to l(:button_back), redmine_mautic_index_path %>
+</div>
+
+<h1>Edit connection to <%= @mautic_connection.url %></h1>
+<%= labelled_form_for(@mautic_connection, as: :connection, url: redmine_mautic_path(@mautic_connection)) do |form| %>
+<%= render 'form', form: form %>
+<% end %>

data/app/views/redmine_mautic/index.html.erb

@@ -0,0 +1,37 @@
+<div class="contextual">
+  <%= link_to l("redmine_mautic.label_new_connection"), new_redmine_mautic_path, class: 'icon icon-add' %>
+</div>
+<h1>Mautic Connections</h1>
+<% if @mautic_connections.any? %>
+  <table class="list">
+    <thead>
+      <tr>
+        <th>Url</th>
+        <th>Client</th>
+        <th>Secret</th>
+        <th></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% @mautic_connections.each do |mautic_connection| %>
+        <tr id="<%= dom_id mautic_connection %>">
+          <td><%= mautic_connection.url %></td>
+          <td><%= mautic_connection.client_id %></td>
+          <td><%= mautic_connection.secret %></td>
+          <td class="buttons">
+            <%= link_to l(:button_edit), edit_redmine_mautic_path(mautic_connection), class: 'icon icon-edit' %>
+            <%= link_to l(:button_delete), redmine_mautic_path(mautic_connection), method: :delete, data: { confirm: l(:text_are_you_sure), rmeote: true }, class: 'icon icon-del' %>
+            <% if mautic_connection.refresh_token.blank? %>
+              <%= link_to('Authorize', mautic.authorize_connection_path(mautic_connection), class: 'icon icon-server-authentication', target: '_blank') %>
+            <% else %>
+              <%= link_to('re-Authorize', mautic.authorize_connection_path(mautic_connection), class: 'icon icon-reload', target: '_blank') %>
+            <% end %>
+            </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+  <% else %>
+  <p class="nodata"><%= l :label_no_data %></p>
+  <% end %>

data/app/views/redmine_mautic/new.html.erb

@@ -0,0 +1,8 @@
+<div class="contextual">
+  <%= link_to l(:button_back), redmine_mautic_index_path %>
+</div>
+
+<h1>New connection</h1>
+<%= labelled_form_for(@mautic_connection, as: :connection, url: :redmine_mautic_index) do |form| %>
+<%= render 'form', form: form %>
+<% end %>

data/config/initializers/01_access_control.rb

@@ -0,0 +1,37 @@
+# Redmine::AccessControl.map do |map|
+#
+#   # ---------------------------------------------------------------------------
+#   # Global level
+#
+#   # View on global
+#
+#   map.permission(:view_redmine_mautics, {
+#     redmine_mautic: [:index, :show]
+#   }, read: true, global: true)
+#
+#   # Manage on global
+#
+#   map.permission(:manage_redmine_mautics, {
+#     redmine_mautic: [:new, :create, :edit, :update, :destroy]
+#   }, require: :loggedin, global: true)
+#
+#   # ---------------------------------------------------------------------------
+#   # Project level
+#
+#   map.project_module :redmine_mautic do |pmap|
+#
+#     # View on project
+#
+#     pmap.permission(:view_redmine_mautic, {
+#       redmine_mautic: [:index, :show]
+#     }, read: true)
+#
+#     # Edit on project
+#
+#     pmap.permission(:manage_redmine_mautic, {
+#       redmine_mautic: [:new, :create, :edit, :update, :destroy]
+#     }, require: :loggedin)
+#
+#   end
+#
+# end

data/config/initializers/02_menu_manager.rb

@@ -0,0 +1,24 @@
+# Redmine::MenuManager.map :admin_menu do |menu|
+#   menu.push :redmine_mautic,
+#             :redmine_mautics_path,
+#             caption: :label_redmine_mautics,
+#             html: { class: 'icon icon-invoice' },
+#             if: proc { |p| User.current.admin? }
+# end
+
+# Redmine::MenuManager.map :project_menu do |menu|
+#   menu.push :redmine_mautic,
+#             :redmine_mautics_path,
+#             caption: :label_redmine_mautics,
+#             param: :project_id,
+#             html: { class: 'icon icon-invoice' },
+#             if: proc { |p| User.current.admin? }
+# end
+
+# Redmine::MenuManager.map :top_menu do |menu|
+#   menu.push :redmine_mautic,
+#             :redmine_mautics_path,
+#             caption: :label_redmine_mautics,
+#             html: { class: 'icon icon-invoice' },
+#             if: proc { |p| User.current.admin? }
+# end

data/config/initializers/03_hooks.rb

@@ -0,0 +1,8 @@
+# Hooks definitions
+# http://www.redmine.org/projects/redmine/wiki/Hooks
+#
+# module RedmineMautic
+#   class Hooks < ::Redmine::Hook::ViewListener
+#     render_on :view_issues_show_details_bottom, partial: 'issues/redmine_mautic/view_issues_show_details_bottom'
+#   end
+# end

data/config/initializers/04_features.rb

@@ -0,0 +1,7 @@
+# This file define all features
+#
+# Rys::Feature.add('redmine_mautic.project.show')
+# Rys::Feature.add('redmine_mautic.issue.show')
+# Rys::Feature.add('redmine_mautic.time_entries.show')
+
+Rys::Feature.add('redmine_mautic')

data/config/initializers/mautic.rb

@@ -0,0 +1 @@
+Mautic.config.base_url = ->(_) { "#{Setting.protocol}://#{Setting.host_name}" }

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  redmine_mautic:
+    plugin_name: "RedmineMautic"
+    label_new_connection: New connection

data/config/routes.rb

@@ -0,0 +1,23 @@
+Rails.application.routes.draw do
+
+  # Usually definition
+  #
+  # get 'redmine_mautic_issue_1', to: 'issues#index'
+
+  # Conditional definition
+  #
+  # get 'redmine_mautic_issues_2', to: 'issues#index', rys_feature: 'redmine_mautic.issue'
+
+  # Conditional block definiton
+  #
+  # rys_feature 'redmine_mautic.issue' do
+  #   get 'redmine_mautic_issues_3', to: 'issues#index'
+  # end
+
+  rys_feature 'redmine_mautic' do
+    mount Mautic::Engine => '/mautic'
+    resources :redmine_mautic
+  end
+
+  # get '/redmine_mautic', to: 'redmine_mautic#index'
+end

data/gems.rb

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# There are defined commands, after install hook and custom hooks
+plugin 'rys-bundler', github: 'easysoftware/rys-bundler', branch: 'master'
+
+# Common dependencies
+eval_gemfile('dependencies.rb')
+
+# Loading gems dependecies in right moment
+Plugin.hook('rys-gemfile', self)
+
+# Loading gems from dummy application
+# Possible paths (by priority)
+#   1. As second argument
+#   2. Environment variable DUMMY_PATH
+#   3. Current_dir / test / dummy
+Plugin.hook('rys-load-dummy', self)
+gem "mautic", path: "/Users/lukas/_projects/mautic"

data/lib/redmine_mautic.rb

@@ -0,0 +1,7 @@
+require 'rys'
+require 'mautic'
+
+require 'redmine_mautic/engine'
+
+module RedmineMautic
+end

data/lib/redmine_mautic/engine.rb

@@ -0,0 +1,12 @@
+require 'rys'
+
+module RedmineMautic
+  class Engine < ::Rails::Engine
+    include Rys::EngineExtensions
+
+    initializer 'redmine_mautic.setup' do
+      # Custom initializer
+    end
+
+  end
+end

data/lib/redmine_mautic/version.rb

@@ -0,0 +1,3 @@
+module RedmineMautic
+  VERSION = "0.1.1"
+end

data/lib/tasks/redmine_mautic.rake

@@ -0,0 +1,16 @@
+begin
+  require 'rspec/core/rake_task'
+
+  namespace :redmine_mautic do
+    desc 'Runs rspec tests'
+    RSpec::Core::RakeTask.new(:spec) do |task, task_args|
+      args = []
+      args << '--require' << Ryspec::Engine.root.join('spec/spec_helper')
+
+      task.rspec_opts = args
+      task.pattern = RedmineMautic::Engine.root.join('spec/**/*_spec.rb')
+    end
+  end
+rescue StandardError, LoadError
+
+end

data/patches/controllers/issues_controller.rb.example

@@ -0,0 +1,37 @@
+Rys::Patcher.add('IssuesController') do
+
+  included do
+    before_action :redmine_mautic_add_flash_notice, only: [:show]
+  end
+
+  instance_methods do
+    def show
+      Rys::Feature.on('redmine_mautic.issue.show') do
+        @redmine_mautic_test_1 = 'Test 2'
+      end
+
+      super
+    end
+
+    private
+
+      def redmine_mautic_add_flash_notice
+        if Rys::Feature.active?('redmine_mautic.issue.show', 'redmine_mautic.project.show')
+          flash.now[:notice] = 'Features are activated'
+        end
+      end
+  end
+
+
+  instance_methods(feature: 'redmine_mautic.issue.show') do
+    def show
+      @redmine_mautic_test_2 = 'Test 2'
+
+      super
+    end
+  end
+
+  class_methods do
+  end
+
+end

data/patches/core_ext/string.rb.example

@@ -0,0 +1,20 @@
+Rys::Patcher.add('String') do
+
+  apply_only_once!
+
+  apply_if do
+    !String.new.respond_to?(:to_boolean)
+  end
+
+  instance_methods do
+    def to_boolean
+      case self
+      when 'yes', 'y', 'true', 't', '1'
+        true
+      else
+        false
+      end
+    end
+  end
+
+end

data/patches/models/project.rb.example

@@ -0,0 +1,28 @@
+Rys::Patcher.add('Project') do
+
+  included do
+    # has_many :things
+
+    after_commit :redmine_mautic_ensure_something, if: -> { Rys::Feature.active?('redmine_mautic.project') }
+  end
+
+  instance_methods do
+
+    private
+
+      def redmine_mautic_ensure_something
+        puts 'Features are activated'
+      end
+
+  end
+
+  instance_methods(feature: 'redmine_mautic.project') do
+    def to_s
+      "I'am cool " + super
+    end
+  end
+
+  class_methods do
+  end
+
+end

data/spec/controllers/submit_form_spec.rb

@@ -0,0 +1,42 @@
+RSpec.describe "Submit mautic form", type: :controller do
+  let(:user) { { firstname: "John", lastname: "Doe", mail: "john@doe.com", language: Setting.default_language } }
+  controller do
+    def create
+      @user = User.new(language: Setting.default_language, mail_notification: Setting.default_notification_option)
+      @user.attributes = invite_params
+      @user.login = @user.mail
+      @user.generate_password = true
+      @user.must_change_passwd = true
+      @user.status = User::STATUS_ACTIVE
+
+      Mautic::FormHelper.submit(url: "https://mautic.org", form: '6', request: request) do |data|
+        data.mail = @user.mail
+        data.firstname = @user.firstname
+        data.lastname = @user.lastname
+        data.ep_language = @user.language
+      end
+
+      render plain: "ok"
+    end
+
+    def invite_params
+      permitted_params = [:firstname, :lastname, :mail, :easy_user_type_id, memberships: [:role_id, { project_ids: [] }]]
+      permitted_params << :admin if User.current.admin?
+      @invite_params ||= params.require(:user).permit(permitted_params)
+    end
+  end
+
+  it "like onboarding" do
+    stub = stub_request(:post, "https://mautic.org/form/submit").
+      with(body: ({ 'mauticform' => hash_including({ 'mail' => user[:mail],
+                                                    'firstname' => user[:firstname],
+                                                    'lastname' => user[:lastname],
+                                                    'ep_language' => user[:language],
+                                                    'submit' => '1',
+                                                    'formId' => '6' }) }))
+    
+    post :create, { user: user }
+    expect(stub).to have_been_requested
+  end
+
+end

data/spec/factories/factory.rb

@@ -0,0 +1,7 @@
+# FactoryBot.define do
+#
+#   factory :test do
+#     sequence(:name) { |n| "Test ##{n}" }
+#   end
+#
+# end

data/spec/features/feature_spec.rb

@@ -0,0 +1,6 @@
+# RSpec.feature 'Feature test', js: true do
+#
+#   scenario 'Scenario' do
+#   end
+#
+# end

data/spec/models/model_spec.rb

@@ -0,0 +1,7 @@
+# RSpec.describe 'Model test', logged: :admin do
+#
+#   it 'Test something' do
+#     expect(1).to eq(1)
+#   end
+#
+# end

data/spec/requests/redmine_mautic_spec.rb

@@ -0,0 +1,20 @@
+require_relative "../spec_helper"
+RSpec.describe "/redmine_mautic", type: :request do
+
+  it '#index' do
+    get "/redmine_mautic"
+    expect(response).to be_success
+  end
+
+  it '#new' do
+    get "/redmine_mautic/new"
+    expect(response).to be_success
+  end
+
+  it '#create' do
+    post "/redmine_mautic", connection: { url: 'https://mautic.org' }
+    expect(response).to be_success
+    expect(response.body).to include("connection[secret]")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'webmock/rspec'
+spec = Bundler.load.specs.find{|s| s.name.to_s == 'ryspec' }
+
+if !spec
+  abort('Gem ryspec was not found. Please add it and run bundle install again.')
+end
+
+require File.join(spec.full_gem_path, 'spec/spec_helper')

data/spec/support/support.rb

@@ -0,0 +1,4 @@
+# module RedmineMautic::Test
+#   module Helper
+#   end
+# end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: redmine_mautic
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Lukáš Pokorný
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mautic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: https://github.com/luk4s/mautic-rails
+email:
+- luk4s.pokorny@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/images/redmine_mautic/.keep
+- app/assets/javascripts/redmine_mautic/.keep
+- app/assets/stylesheets/redmine_mautic/.keep
+- app/controllers/redmine_mautic_controller.rb
+- app/helpers/.keep
+- app/mailers/.keep
+- app/models/.keep
+- app/views/.keep
+- app/views/issues/redmine_mautic/_view_issues_show_details_bottom.html.erb
+- app/views/redmine_mautic/_form.html.erb
+- app/views/redmine_mautic/edit.html.erb
+- app/views/redmine_mautic/index.html.erb
+- app/views/redmine_mautic/new.html.erb
+- config/initializers/01_access_control.rb
+- config/initializers/02_menu_manager.rb
+- config/initializers/03_hooks.rb
+- config/initializers/04_features.rb
+- config/initializers/mautic.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/.keeo
+- gems.rb
+- lib/redmine_mautic.rb
+- lib/redmine_mautic/engine.rb
+- lib/redmine_mautic/version.rb
+- lib/tasks/redmine_mautic.rake
+- patches/controllers/issues_controller.rb.example
+- patches/core_ext/string.rb.example
+- patches/models/project.rb.example
+- spec/controllers/submit_form_spec.rb
+- spec/factories/factory.rb
+- spec/features/feature_spec.rb
+- spec/models/model_spec.rb
+- spec/requests/redmine_mautic_spec.rb
+- spec/spec_helper.rb
+- spec/support/support.rb
+homepage: https://github.com/luk4s
+licenses:
+- GPL-2.0-or-later
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Integration mautic rails gem with Redmine
+test_files:
+- spec/spec_helper.rb
+- spec/features/feature_spec.rb
+- spec/models/model_spec.rb
+- spec/requests/redmine_mautic_spec.rb
+- spec/support/support.rb
+- spec/factories/factory.rb
+- spec/controllers/submit_form_spec.rb