mautic 2.3.1 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50cf7b5fa5dcc376ddb8a7e50a37c521d00ffcab8cef1b17b2e1bac598eb70aa
-  data.tar.gz: 6a6f4890c25207a24ac1eaa0b30834e8059fec5c0f14e0392e7e902016882688
+  metadata.gz: 4499d4f66adb74f89f363f1407b0cf917728eaba2e10f9a48183a12ad14d8514
+  data.tar.gz: 2165001c7af680d7f3c9929a1fff7f8d463d8396d9514370f50669d59ac5dcd1
 SHA512:
-  metadata.gz: 37cd5dae4578a9bffa5f16a9ac4341b7f9c22bf1e1f0bdbd86aab0e7ac76932d5e1106c2c33f50214f8ec9e0f51102cb68d1c718d952c42cdbaf38e24c8b6b2e
-  data.tar.gz: ee5be0217d9e2797778ab93ff29b9bc39a23e8c0bc92bbd7aa2df59ae46008a5eb60624d4743001ef4d2e1cbda15ddd7eb24c9c2a44b495d177ff8ea53235f7e
+  metadata.gz: 3a6de50ca1f0e1b51b0e7b4a547327351c0ac984e64dd23e48e7e55d20523fa6155b1d2aa0737110878e9af8dda916e17cb40ca9b0752d4b3d79033dbd1a76cf
+  data.tar.gz: 8bf7ba6cbe4fe3903b09b2083dda2a9204d49ac2b0187e0bd053259c57b21db29c2aeadcacdce4261f570cd37d9b10e8dc28f6500463a75335fda29ca116b875

data/README.md

@@ -1,19 +1,66 @@
-# Mautic rails 
+# Mautic rails
+[![Maintainability](https://api.codeclimate.com/v1/badges/c8cd605b5e021fb841d1/maintainability)](https://codeclimate.com/github/luk4s/mautic-rails/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c8cd605b5e021fb841d1/test_coverage)](https://codeclimate.com/github/luk4s/mautic-rails/test_coverage)
+ 
 RoR helper / wrapper for Mautic API and forms
 
 *Rails 4.2.8+, 5.1+ 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
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mautic', '~> 2.3'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+Also you need migrate database:
+```bash
+$ rails db:migrate
+```
+
+## Configuration
+
+add to `config/initializers/mautic.rb`:
+```ruby
+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
+```
+
+add to `config/routes.rb`
+```ruby
+mount Mautic::Engine => "/mautic"
+```
+### Create mautic connection
   
+1. In your mautic, create new
+2. Got to `/your-mount-point/connections`
+3. Create new connection - enter URL to your mautic
+4. Copy `callback url` then go to you mautic
+
+      > In mautic you need add API oauth2 login.
+
+      > ```
+      > http://localhost:3000/mautic/connections/:ID/oauth2
+      > ```
+      > ID = is your Mautic::Connection ID
+          
+5. Create new **Oauth2** API connections. Use `callback url` from previous step and copy `key` and `secret` to form in your app
+6. Update and use `Authorize`  button for handshake
+
+> For example of integration check https://github.com/luk4s/redmine_mautic
+      
+     
+## Usage
+
    Find connection which you want to use:
   ```ruby
   m = Mautic::Connection.last
@@ -72,43 +119,6 @@ Receive webhook from mautic, parse it and prepare for use.
   
           post "webhook/:mautic_id", action: "webhook", on: :collection
           
-
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'mautic', '~>0.1'
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install mautic
-```
-
-## Configuration
-
-add to `config/initializers/mautic.rb`:
-```ruby
-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
-```
-
-add to `config/routes.rb`
-```ruby
-mount Mautic::Engine => "/mautic"
-
-```
-
 ## Contributing
 Ideas and pull requests are welcome!
 

data/app/models/mautic/connection.rb

@@ -66,34 +66,37 @@ module Mautic
     def parse_response(response)
       case response.status
       when 400
-        raise Mautic::ValidationError.new(response)
+        raise Mautic::ValidationError, response
       when 401
-        json = try_to_refresh_and_parse(response)
+        try_to_refresh_and_parse(response)
       when 404
-        raise Mautic::RecordNotFound.new(response)
+        raise Mautic::RecordNotFound, response
       when 200, 201
-        json = JSON.parse(response.body) rescue {}
-        Array(json['errors']).each do |error|
-          case error['code'].to_i
-          when 401
-            json = try_to_refresh_and_parse(response)
-          when 404
-            raise Mautic::RecordNotFound.new(response)
-          else
-            raise Mautic::RequestError.new(response)
-          end
-        end
+        handle_success_response response
       else
-        raise Mautic::RequestError.new(response)
+        raise Mautic::RequestError, response
+      end
+    end
+
+    def handle_success_response(response)
+      json = JSON.parse(response.body) rescue {}
+      Array(json['errors']).each do |error|
+        case error['code'].to_i
+        when 401
+          json = try_to_refresh_and_parse(response)
+        when 404
+          raise Mautic::RecordNotFound, response
+        else
+          raise Mautic::RequestError, response
+        end
       end
 
       json
     end
 
-    private
-
     def try_to_refresh_and_parse(response)
-      raise Mautic::TokenExpiredError.new(response) if @try_to_refresh
+      raise Mautic::TokenExpiredError, response if @try_to_refresh
+
       @try_to_refresh = true
       refresh!
       request(*@last_request)

data/app/models/mautic/form.rb

@@ -2,7 +2,7 @@ module Mautic
   class Form < Model
 
     def assign_attributes(source = nil)
-      self.attributes = {name: source['name'], fields: source['fields']} if source.is_a? Hash
+      self.attributes = { name: source['name'], fields: source['fields'] } if source.is_a? Hash
     end
 
   end

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

@@ -1,13 +1,13 @@
-<%#= form_with(model: mautic_connection.becomes(Mautic::Connection), local: true) do |form| %>
 <%= form_for(mautic_connection.becomes(Mautic::Connection)) 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>
+      <h2><%= pluralize(mautic_connection.errors.count, "error") %> prohibited this mautic_connection from being
+        saved:</h2>
 
       <ul>
-      <% mautic_connection.errors.full_messages.each do |message| %>
-        <li><%= message %></li>
-      <% end %>
+        <% mautic_connection.errors.full_messages.each do |message| %>
+          <li><%= message %></li>
+        <% end %>
       </ul>
     </div>
   <% end %>
@@ -21,17 +21,23 @@
     <%= form.label :url %>
     <%= form.text_field :url, id: :mautic_connection_url %>
   </div>
+  <% 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>
+    </div>
 
-  <div class="field">
-    <%= form.label :client_id %>
-    <%= form.text_field :client_id, id: :mautic_connection_client_id %>
-  </div>
+    <div class="field">
+      <%= form.label :client_id %>
+      <%= form.text_field :client_id, id: :mautic_connection_client_id %>
+    </div>
 
-  <div class="field">
-    <%= form.label :secret %>
-    <%= form.text_field :secret, id: :mautic_connection_secret %>
-  </div>
+    <div class="field">
+      <%= form.label :secret %>
+      <%= form.text_field :secret, id: :mautic_connection_secret %>
+    </div>
 
+  <% end %>
   <div class="actions">
     <%= form.submit %>
   </div>

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

@@ -1,4 +1,3 @@
 <h1>Editing Mautic Connection</h1>
 
 <%= render 'form', mautic_connection: @mautic_connection %>
-callback_url: <%= @mautic_connection.send :callback_url %>

data/lib/mautic/model.rb

@@ -40,7 +40,7 @@ module Mautic
     attr_reader :connection
 
     # @param [Mautic::Connection] connection
-    def initialize(connection, hash=nil)
+    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
@@ -59,7 +59,7 @@ 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_mautic })
         self.attributes = json[endpoint.singularize]
         clear_changes
       rescue ValidationError => e
@@ -71,7 +71,7 @@ module Mautic
 
     def create
       begin
-        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", { body: to_h })
+        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", { body: to_mautic })
         self.attributes = json[endpoint.singularize]
         clear_changes
       rescue ValidationError => e
@@ -106,6 +106,12 @@ module Mautic
       end
     end
 
+    def to_mautic
+      @table.each_with_object({}) do |(key,val), mem|
+        mem[key] = val.is_a?(Array) ? val.join("|") : val
+      end
+    end
+
     private
 
     def clear_changes
@@ -119,27 +125,34 @@ module Mautic
     def assign_attributes(source = nil)
       @mautic_attributes = []
       source ||= {}
+
+      data = if (fields = source['fields'])
+               attributes_from_fields(fields)
+             elsif source
+               source
+             end
+      self.attributes = data
+    end
+
+    def attributes_from_fields(fields)
       data = {}
+      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|
+          next unless pairs.is_a?(Hash)
 
-      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|
-            next unless pairs.is_a?(Hash)
-            pairs.each do |key, attrs|
-              @mautic_attributes << (a = Attribute.new(attrs))
-              data[key] = a.value
-            end
+          pairs.each do |key, attrs|
+            @mautic_attributes << (a = Attribute.new(attrs))
+            data[key] = a.value
           end
         end
-      elsif source
-        data = source
       end
-      self.attributes = data
+
+      data
     end
 
   end

data/lib/mautic/proxy.rb

@@ -29,9 +29,7 @@ module Mautic
         records = results = where(options)
         total = @last_response['total'].to_i
         while records.any?
-          if block_given?
-            records.each &block
-          end
+          records.each(&block) if block_given?
           break if results.size >= total
 
           records = where(options.merge(start: records.size))

data/lib/mautic/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '2.3.1'
+  VERSION = '2.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mautic
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.3
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-16 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,84 +58,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +205,8 @@ files:
 homepage: https://github.com/luk4s/mautic-rails
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -221,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails Mautic integration