mautic 0.1.8 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 5fe0c00bf9adc2bb52aebcec2b270740492e49d6e8a3627635b1c5612e82b04a
-  data.tar.gz: 40ada8b3e84aa4ee9bb3ced6392fe47c912cd3ccf32bd7c97ff0f08454f2d2ef
+SHA1:
+  metadata.gz: 395ca0792f8a56986bc97cc6a267deb9c24cdb44
+  data.tar.gz: 15c8e1583f8ea06db7683400978c8bf064b54e77
 SHA512:
-  metadata.gz: 46d1ac327fee620c46227d3b8e41e16d2b66edcd5d228bdf7a414caca606e107cae91cd2c503fead21e37028b497136f3df19135f9d588d5175a73900e560c8f
-  data.tar.gz: a7eb6c40d61fa28df4907c022af430df7ec3d24c5ccbce5e284dda73f822991251737c3fbadf6ffc51e4505f2324defc2d726582b8f7c5bcc2c918fddf872bbd
+  metadata.gz: bfff68b112c2edb739a49d4d549d1165f91d728b412c4a4e24219387e23ba65b7ec4f3ddc6892ddb3206b494e85f99b1b31d3b3238bc262cdf12859d7ca337d5
+  data.tar.gz: 5ec16c2043356e0118c0b509a8358b8902b750645e30092b3fa50f92c21aa24de986b1ca17c91b6232a5a5ae1848ff57cb691712c7c1ab5a1d11f9c2e7181c42

data/README.md

@@ -1,18 +1,10 @@
 # Mautic rails 
 RoR helper / wrapper for Mautic API and forms
 
-*Rails 4 compatible*
 ## Usage
 ### Gem provides API connection to your Mautic(s)
   1. Create mautic connection
   2. Authorize it
-      
-      In mautic you need add API oauth2 login.
-      For URI callback allow:
-      ```
-      http://localhost:3000/mautic/connections/:ID/oauth2
-      ```
-      ID = is your Mautic::Connection ID
   
    Find connection which you want to use:
   ```ruby
@@ -66,7 +58,7 @@ There are two options of usage:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mautic', '~>0.1'
+gem 'mautic'
 ```
 
 And then execute:
@@ -86,7 +78,6 @@ add to `config/initializers/mautic.rb`:
 Mautic.configure do |config|
   # This is for oauth handshake token url. I need to know where your app listen
   config.base_url = "https://my-rails-app.com"
-  # OR it can be Proc 
   # *optional* This is your default mautic URL - used in form helper 
   config.mautic_url = "https://mautic.my.app"
 end

data/app/assets/javascripts/mautic/application.js

@@ -10,7 +10,5 @@
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
-// require rails-ujs
-//= require jquery
-//= require jquery_ujs
+//= require rails-ujs
 //= require_tree .

data/app/controllers/mautic/connections_controller.rb

@@ -1,5 +1,109 @@
 module Mautic
   class ConnectionsController < ApplicationController
-    include ::Mautic::ConnectionsControllerConcern
+    before_action :set_mautic_connection, only: [:show, :edit, :update, :destroy, :oauth2, :authorize]
+
+    # GET /mautic_connections
+    def index
+      @mautic_connections = Connection.order(:url)
+      respond_to do |format|
+        format.html { render layout: !request.xhr? }
+        format.json { render json: @mautic_connections }
+      end
+    end
+
+    # GET /mautic_connections/1
+    def show
+      respond_to do |format|
+        format.html { render layout: !request.xhr? }
+      end
+    end
+
+    # GET /mautic_connections/new
+    def new
+      @mautic_connection = Connection.new
+      respond_to do |format|
+        format.html { render layout: !request.xhr? }
+      end
+    end
+
+    # GET /mautic_connections/1/edit
+    def edit
+      respond_to do |format|
+        format.html { render layout: !request.xhr? }
+      end
+    end
+
+    # POST /mautic_connections
+    def create
+      @mautic_connection = Connection.new(mautic_connection_params)
+
+      respond_to do |format|
+        if @mautic_connection.save
+          format.html { redirect_to mautic.connection_path(@mautic_connection), notice: t('mautic.text_mautic_connection_created') }
+          format.js { head :no_content }
+          format.json { render json: @mautic_connection }
+        else
+          format.html { render :new }
+          format.js { head :unprocessable_entity }
+          format.json { render json: @mautic_connection.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PATCH/PUT /mautic_connections/1
+    def update
+      respond_to do |format|
+        if @mautic_connection.update(mautic_connection_params)
+          format.html { redirect_to mautic.connection_path(@mautic_connection), notice: t('mautic.text_mautic_connection_updated') }
+          format.js { head :no_content }
+          format.json { render json: @mautic_connection }
+        else
+          format.html { render :edit }
+          format.js { head :unprocessable_entity }
+          format.json { render json: @mautic_connection.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /mautic_connections/1
+    def destroy
+      @mautic_connection.destroy
+      respond_to do |format|
+        format.html { redirect_to :connections, notice: t('mautic.text_mautic_connection_destroyed') }
+        format.js { render js: "document.getElementById('#{view_context.dom_id(@mautic_connection)}').remove()" }
+        format.json { render json: @mautic_connection }
+      end
+    end
+
+    # ==--==--==--==--
+
+    def authorize
+      redirect_to @mautic_connection.authorize
+    end
+
+    def oauth2
+      begin
+        response = @mautic_connection.get_code(params.require(:code))
+        @mautic_connection.update(token: response.token, refresh_token: response.refresh_token)
+        return render plain: t('mautic.text_mautic_authorize_successfully')
+      rescue OAuth2::Error => e
+        flash[:error] = e.message
+      end
+
+      render :show
+    end
+
+    private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_mautic_connection
+      @mautic_connection = Connection.find(params[:id])
+    rescue ActiveRecord::RecordNotFound => e
+      return render head: 404, plain: e.message
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def mautic_connection_params
+      params.require(:connection).permit(:url, :client_id, :secret, :type)
+    end
   end
 end

data/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/mautic/connection.rb

@@ -3,8 +3,8 @@ module Mautic
 
     self.table_name = 'mautic_connections'
 
-    validates :url, presence: true, format: URI::regexp(%w(http https))
-    validates :client_id, :secret, presence: true, unless: :new_record?
+    validates :url, :client_id, :secret, presence: true
+    validates :url, format: URI::regexp(%w(http https))
 
     alias_attribute :access_token, :token
 
@@ -39,48 +39,9 @@ module Mautic
     end
 
     def request(type, path, params = {})
-      @last_request = [type, path, params]
-      response = raise NotImplementedError
-      parse_response(response)
-    end
-
-    private
-
-    def callback_url
-      if (conf = Mautic.config.base_url).is_a?(Proc)
-        conf = conf.call(self)
-      end
-
-      URI.parse(conf)
+      raise NotImplementedError
     end
 
-    def parse_response(response)
-      case response.status
-      when 400
-        raise Mautic::ValidationError.new(response)
-      when 404
-        raise Mautic::RecordNotFound.new(response)
-      when 200, 201
-        json = JSON.parse(response.body) rescue {}
-        Array(json['errors']).each do |error|
-          case error['code'].to_i
-          when 401
-            raise Mautic::TokenExpiredError.new(response) if @try_to_refresh
-            @try_to_refresh = true
-            refresh!
-            json = request(*@last_request)
-          when 404
-            raise Mautic::RecordNotFound.new(response)
-          else
-            raise Mautic::RequestError.new(response)
-          end
-        end
-      else
-        raise Mautic::RequestError.new(response)
-      end
-
-      json
-    end
 
   end
 end

data/app/models/mautic/connections/oauth2.rb

@@ -30,15 +30,28 @@ module Mautic
       end
 
       def request(type, path, params = {})
-        @last_request = [type, path, params]
-        response = connection.request(type, path, params)
-        parse_response(response)
+        json = JSON.parse connection.request(type, path, params).body
+        Array(json['errors']).each do |error|
+          case error['code']
+          when 400
+            # Validation error
+          when 401
+            raise Mautic::TokenExpiredError.new(error['message']) if @try_to_refresh
+            @try_to_refresh = true
+            refresh!
+            json = request(type, path, params)
+          else
+            raise Mautic::AuthorizeError.new("#{error['code']} - #{error['message']}")
+          end
+        end
+        json
       end
 
       private
 
       def callback_url
-        uri = super
+        # return Mautic.config.oauth2_callback_url if Mautic.config.oauth2_callback_url
+        uri = URI.parse(Mautic.config.base_url)
         uri.path = Mautic::Engine.routes.url_helpers.oauth2_connection_path(self)
         uri.to_s
       end

data/app/models/mautic/contact.rb

@@ -1,8 +1,6 @@
 module Mautic
   class Contact < Model
 
-    alias_attribute :first_name, :firstname
-    alias_attribute :last_name, :lastname
     def self.in(connection)
       Proxy.new(connection, endpoint, default_params: { search: '!is:anonymous' })
     end

data/app/views/mautic/connections/_form.html.erb

@@ -1,5 +1,4 @@
-<%#= form_with(model: mautic_connection.becomes(Mautic::Connection), local: true) do |form| %>
-<%= form_for(mautic_connection.becomes(Mautic::Connection)) do |form| %>
+<%= form_with(model: mautic_connection.becomes(Mautic::Connection), local: true) do |form| %>
   <% if mautic_connection.errors.any? %>
     <div id="error_explanation">
       <h2><%= pluralize(mautic_connection.errors.count, "error") %> prohibited this mautic_connection from being saved:</h2>

data/db/migrate/20171028082047_create_mautic_mautic_connections.rb

@@ -1,4 +1,4 @@
-class CreateMauticMauticConnections < ActiveRecord::Migration
+class CreateMauticMauticConnections < ActiveRecord::Migration[5.1]
   def change
     create_table :mautic_connections do |t|
       t.string :type
@@ -10,7 +10,7 @@ class CreateMauticMauticConnections < ActiveRecord::Migration
       t.string :token
       t.string :refresh_token
 
-      t.timestamps null: false
+      t.timestamps
     end
   end
 end

data/lib/mautic.rb

@@ -1,5 +1,4 @@
 require "oauth2"
-require "jquery-rails"
 require "mautic/engine"
 
 module Mautic
@@ -9,46 +8,14 @@ module Mautic
   autoload :Proxy, 'mautic/proxy'
   autoload :Model, 'mautic/model'
 
-  class RequestError < StandardError
-
-    attr_reader :response, :errors
-
-    def initialize(response, message = nil)
-      @errors ||= []
-      @response = response
-      json_body = JSON.parse(response.body) rescue {}
-      message ||= Array(json_body['errors']).collect do |error|
-        msg = error['code'].to_s
-        msg << " (#{error['type']}):" if error['type']
-        msg << " #{error['message']}"
-        @errors << error['message']
-        msg
-      end.join(', ')
-
-      super(message)
-    end
-
+  class TokenExpiredError < StandardError
   end
 
-  class TokenExpiredError < RequestError
-  end
-
-  class ValidationError < RequestError
-
-    def initialize(response, message = nil)
-      @response = response
-      json_body = JSON.parse(response.body) rescue {}
-      @errors = Array(json_body['errors']).inject({}) { |mem, var| mem.merge!(var['details']); mem }
-      message ||= @errors.collect { |field, msg| "#{field}: #{msg.join(', ')}" }.join('; ')
-      super(response, message)
-    end
-
-  end
+  class ValidationError < StandardError
 
-  class AuthorizeError < RequestError
   end
 
-  class RecordNotFound < RequestError
+  class AuthorizeError < StandardError
   end
 
   configure do |config|

data/lib/mautic/model.rb

@@ -15,14 +15,6 @@ module Mautic
 
     end
 
-    class Attribute < OpenStruct
-
-      def name
-        @alias
-      end
-
-    end
-
     class << self
 
       def endpoint
@@ -38,9 +30,8 @@ module Mautic
     def initialize(connection, hash=nil)
       @connection = connection
       @table = MauticHash.new
-      self.attributes = { id: hash['id'], created_at: hash['dateAdded']&.to_time, updated_at: hash['dateModified']&.to_time } if hash
+      self.attributes = { created_at: hash['dateAdded']&.to_time, updated_at: hash['dateModified']&.to_time } if hash
       assign_attributes(hash)
-      clear_changes
     end
 
     def save(force = false)
@@ -49,37 +40,29 @@ module Mautic
 
     def update(force = false)
       return false if changes.blank?
-      begin
-        json = @connection.request((force && :put || :patch), "api/#{endpoint}/#{id}/edit", { body: to_h })
+      json = @connection.request((force && :put || :patch), "api/#{endpoint}/#{id}/edit", { body: to_h })
+      if json['errors']
+        self.errors = json['errors']
+      else
         self.attributes = json[endpoint.singularize]
-        clear_changes
-      rescue ValidationError => e
-        self.errors = e.errors
       end
-
-      self.errors.blank?
+      json['errors'].blank?
     end
 
     def create
-      begin
-        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", { body: to_h })
+      json = @connection.request(:post, "api/#{endpoint}/#{id}/new", { body: to_h })
+      if json['errors']
+        self.errors = json['errors']
+      else
         self.attributes = json[endpoint.singularize]
-        clear_changes
-      rescue ValidationError => e
-        self.errors = e.errors
       end
-
-      self.errors.blank?
+      json['errors'].blank?
     end
 
     def destroy
-      begin
-        @connection.request(:delete, "api/#{endpoint}/#{id}/delete")
-        true
-      rescue RequestError => e
-        self.errors = e.errors
-        false
-      end
+      json = @connection.request(:delete, "api/#{endpoint}/#{id}/delete")
+      self.errors = json['errors'] if json['errors']
+      json['errors'].blank?
     end
 
     def changes
@@ -90,42 +73,25 @@ module Mautic
       @table.to_h
     end
 
+    private
+
+    def endpoint
+      self.class.endpoint
+    end
+
     def attributes=(hash)
       hash.each_pair do |k, v|
         k = k.to_sym
         @table[k] = v
       end
-    end
-
-    private
-
-    def clear_changes
       @table.instance_variable_set(:@changes, nil)
     end
 
-    def endpoint
-      self.class.endpoint
-    end
-
     def assign_attributes(source = nil)
-      @mautic_attributes = []
       source ||= {}
       data = {}
-
       if (fields = source['fields'])
-        if fields['all']
-          @mautic_attributes = fields['all'].collect do |key, value|
-            data[key] = value
-            Attribute.new(alias: key, value: value)
-          end
-        else
-          fields.each do |_group, pairs|
-            pairs.each do |key, attrs|
-              @mautic_attributes << (a = Attribute.new(attrs))
-              data[key] = a.value
-            end
-          end
-        end
+        data.merge!(fields['all']) if fields['all']
       elsif source
         data = source
       end
@@ -133,4 +99,4 @@ module Mautic
     end
 
   end
-end
+end

data/lib/mautic/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '0.1.8'
+  VERSION = '1.0.1'
 end

data/spec/rails_helper.rb

@@ -1,7 +1,4 @@
 ENV['RAILS_ENV'] ||= 'test'
-require 'simplecov'
-SimpleCov.start
-
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
 # Prevent database truncation if the environment is production
 abort('The Rails environment is running in production mode!') if Rails.env.production?

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ require 'factory_bot_rails'
 require 'database_cleaner'
 require 'faker'
 require 'webmock/rspec'
-require 'pry-rails'
 # require 'capybara/rspec'
 
 ActiveRecord::Migration.maintain_test_schema!
@@ -35,6 +34,10 @@ RSpec.configure do |config|
   end
 
   config.include FactoryBot::Syntax::Methods
+  # DatabaseCleaner.clean_with(
+  #   :truncation,
+  #   except: %w(ar_internal_metadata)
+  # )
 
   config.before(:suite) do
     DatabaseCleaner.clean_with(:truncation, except: %w(ar_internal_metadata))
@@ -44,6 +47,10 @@ RSpec.configure do |config|
     DatabaseCleaner.strategy = :transaction
   end
 
+  config.before(:each, js: true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
   config.before(:each) do
     DatabaseCleaner.start
   end
@@ -58,4 +65,21 @@ RSpec.configure do |config|
 
   config.filter_rails_from_backtrace!
 
+  # config.before(:each) do |ex|
+  #   meta = ex.metadata
+  #   unless meta[:null]
+  #     case meta[:logged]
+  #     when :admin
+  #       logged(Symphonia::User, FactoryBot.create(:admin_user))
+  #     when true
+  #       logged(Symphonia::User, FactoryBot.create(:user))
+  #     end
+  #   end
+  # end
+
+end
+
+
+def logged(model, user)
+  allow(model).to receive(:current).and_return(user)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mautic
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.1
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2017-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,34 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.8
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -186,12 +166,12 @@ files:
 - app/assets/stylesheets/mautic/application.css
 - app/assets/stylesheets/mautic/mautic_connections.css
 - app/assets/stylesheets/scaffold.css
-- app/controllers/concerns/mautic/connections_controller_concern.rb
 - app/controllers/mautic/application_controller.rb
 - app/controllers/mautic/connections_controller.rb
 - app/helpers/mautic/application_helper.rb
 - app/jobs/mautic/application_job.rb
 - app/mailers/mautic/application_mailer.rb
+- app/models/application_record.rb
 - app/models/mautic/application_record.rb
 - app/models/mautic/connection.rb
 - app/models/mautic/connections/oauth2.rb
@@ -235,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails Mautic integration

data/app/controllers/concerns/mautic/connections_controller_concern.rb

@@ -1,118 +0,0 @@
-module Mautic
-  module ConnectionsControllerConcern
-    extend ActiveSupport::Concern
-
-    included do
-
-      before_action :set_mautic_connection, only: [:show, :edit, :update, :destroy, :oauth2, :authorize]
-
-    end
-
-
-    # GET /mautic_connections
-    def index
-      @mautic_connections = Mautic::Connection.order(:url)
-      respond_to do |format|
-        format.html { render layout: !request.xhr? }
-        format.json { render json: @mautic_connections }
-      end
-    end
-
-    # GET /mautic_connections/1
-    def show
-      respond_to do |format|
-        format.html { render layout: !request.xhr? }
-      end
-    end
-
-    # GET /mautic_connections/new
-    def new
-      @mautic_connection = Mautic::Connection.new
-      respond_to do |format|
-        format.html { render layout: !request.xhr? }
-      end
-    end
-
-    # GET /mautic_connections/1/edit
-    def edit
-      respond_to do |format|
-        format.html { render layout: !request.xhr? }
-      end
-    end
-
-    # POST /mautic_connections
-    def create
-      @mautic_connection = Mautic::Connection.new(mautic_connection_params)
-
-      respond_to do |format|
-        if @mautic_connection.save
-          format.html { render(:edit, notice: t('mautic.text_mautic_connection_created')) }
-          format.js { head :no_content }
-          format.json { render json: @mautic_connection }
-        else
-          format.html { render :new }
-          format.js { head :unprocessable_entity }
-          format.json { render json: @mautic_connection.errors, status: :unprocessable_entity }
-        end
-      end
-    end
-
-    # PATCH/PUT /mautic_connections/1
-    def update
-      respond_to do |format|
-        if @mautic_connection.update(mautic_connection_params)
-          format.html { redirect_to({ action: :index }, notice: t('mautic.text_mautic_connection_updated')) }
-          format.js { head :no_content }
-          format.json { render json: @mautic_connection }
-        else
-          format.html { render :edit }
-          format.js { head :unprocessable_entity }
-          format.json { render json: @mautic_connection.errors, status: :unprocessable_entity }
-        end
-      end
-    end
-
-    # DELETE /mautic_connections/1
-    def destroy
-      @mautic_connection.destroy
-      respond_to do |format|
-        format.html { redirect_to action: "index", notice: t('mautic.text_mautic_connection_destroyed') }
-        format.js { render js: "document.getElementById('#{view_context.dom_id(@mautic_connection)}').remove()" }
-        format.json { render json: @mautic_connection }
-      end
-    end
-
-    # ==--==--==--==--
-
-    def authorize
-      redirect_to @mautic_connection.authorize
-    end
-
-    def oauth2
-      begin
-        response = @mautic_connection.get_code(params.require(:code))
-        @mautic_connection.update(token: response.token, refresh_token: response.refresh_token)
-        return render plain: t('mautic.text_mautic_authorize_successfully')
-      rescue OAuth2::Error => e
-        flash[:error] = e.message
-      end
-
-      render :show
-    end
-
-    private
-
-    # Use callbacks to share common setup or constraints between actions.
-    def set_mautic_connection
-      @mautic_connection = Mautic::Connection.find(params[:id])
-    rescue ActiveRecord::RecordNotFound => e
-      return render head: 404, plain: e.message
-    end
-
-    # Only allow a trusted parameter "white list" through.
-    def mautic_connection_params
-      params.require(:connection).permit(:url, :client_id, :secret, :type)
-    end
-
-  end
-end