mautic 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c03bde50c40a75d830eb7e281af2ecc36143b62a9db7b30647a26bb1044013d4
-  data.tar.gz: 0eda55684550a7512e911792846a0d7646ba4da0a1a15a216ecc6836876deda5
+  metadata.gz: eb4e903dff064ccd272c769b31a9692b0479cc93f86d6caa7586f73adb0190d6
+  data.tar.gz: a96abb5a2f455fb0026bfe56be46640f49d6fdcf89673f27fb59ebae8f66aa42
 SHA512:
-  metadata.gz: 7382580246a31dcc47c03fb1c9ef98168fd4a0429439b8b45794db9f8dc263d839866a3f3e4c0c4aeab741d074c8fa6029d0cef25be67e0a279b2f68b1d8d8c0
-  data.tar.gz: 8e801c01c6aec779c05e7f858dfdfe45dc3ca06b21c86086e42f4f0a180a0251e1ab02bf4edb84ed0c2c91658b7e8e8f9370b81511b04324ed10efa2bbdf6e15
+  metadata.gz: 49997f77ce24fa44c9a3ec96a785b31d0ae382ccd754e9c3c89b1adabf33869b31dc3fbc0aaf25f38b3d988192cafa6ccc7d617b7c90a53ae516a6f218b8fa38
+  data.tar.gz: ab3974fd38ba6ce83c8b489634bce1a637b18effdddbcb779b98e5531d865cf4bd6363c899b57927a9374a409b35cc0f27865cffca7086963954bbfad9aa9828

data/README.md

@@ -94,11 +94,11 @@ end
   ```
   Get specify contact:
   ```ruby
-  contact = m.contact.find(1) # => #<Mautic::Contact id=1 ...>
+  contact = m.contact.find(1) # => #<Mautic::Contact id=1 ...>
   ```
   Collections of contacts:
   ```ruby
-  m.contacts.where("gmail").each do |contact|
+  m.contacts.where(search: "gmail").each do |contact|
     #<Mautic::Contact id=12 ...>
     #<Mautic::Contact id=21 ...>
     #<Mautic::Contact id=99 ...>
@@ -115,7 +115,7 @@ end
   contact.save # => false
   contact.errors # => [{"code"=>400, "message"=>"email: This field is required.", "details"=>{"email"=>["This field is required."]}}]
   ```
-  Do not contact
+  #### Do not contact
   ```ruby
   contact.do_not_contact? # => false
   contact.do_not_contact! message: "Some reason"
@@ -127,6 +127,18 @@ end
   contact.remove_do_not_contact!
   contact.do_not_contact? # => false
   ```
+  #### Campaigns
+  list of contacts campaigns (where contact is a member) and remove it from one
+  ```ruby
+  contact.campaigns #=> [Mautic::Campaign, ...]
+  campaign = contact.campaigns.find { |campaign| campaign.name == "Newsletter" }
+  campaign.remove_contact! contact.id
+  ```
+  or add contact back
+  ```ruby
+  campaign = connection.campaigns.where(search: "Newsletter").first
+  campaign.add_contact! contact.id
+  ```
   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/models/mautic/company_field.rb

@@ -0,0 +1,11 @@
+module Mautic
+  class CompanyField < Model
+    def self.endpoint
+      "fields/company"
+    end
+
+    def self.in(connection)
+      Proxy.new(connection, endpoint, klass: name, data_name: "field")
+    end
+  end
+end

data/app/models/mautic/contact_field.rb

@@ -0,0 +1,11 @@
+module Mautic
+  class ContactField < Model
+    def self.endpoint
+      "fields/contact"
+    end
+
+    def self.in(connection)
+      Proxy.new(connection, endpoint, klass: name, data_name: "field")
+    end
+  end
+end

data/app/models/mautic/form.rb

@@ -5,5 +5,34 @@ module Mautic
       self.attributes = { name: source['name'], fields: source['fields'] } if source.is_a? Hash
     end
 
+    # @param [Integer] submission_id
+    # @return Mautic::Submissions::Form
+    # @see https://developer.mautic.org/#get-form-submission
+    def submission(submission_id)
+      json = @connection.request(:get, "api/forms/#{id}/submissions/#{submission_id}")
+      Mautic::Submissions::Form.new @connection, json["submission"]
+    rescue Mautic::RecordNotFound => _e
+      nil
+    end
+
+    # @see https://developer.mautic.org/#list-form-submissions
+    # @param [Hash] options
+    # @option options [String] :search String or search command to filter entities by.
+    # @option options [String] :start Starting row for the entities returned. Defaults to 0.
+    # @option options [String] :limit Limit number of entities to return. Defaults to the system configuration for pagination (30).
+    # @option options [String] :orderBy Column to sort by. Can use any column listed in the response, also can use column of joined table with prefix. Sort by submitted date is s.date_submitted
+    # @option options [String] :orderByDir Sort direction: asc or desc.
+    # @option options [String] :publishedOnly Only return currently published entities.
+    # @option options [String] :minimal Return only array of entities without additional lists in it.
+    # @return Array[Mautic::Submissions::Form]
+    def submissions(**options)
+      json = @connection.request(:get, "api/forms/#{id}/submissions", params: options)
+      @submissions = json["submissions"].collect do |attributes|
+        Mautic::Submissions::Form.new @connection, attributes
+      end
+    rescue RequestError => _e
+      []
+    end
+
   end
-end
+end

data/app/views/layouts/mautic/application.html.erb

@@ -2,8 +2,6 @@
 <html>
   <head>
     <title>Mautic</title>
-    <%= stylesheet_link_tag "mautic/application", media: "all" %>
-    <%= javascript_include_tag "mautic/application" %>
     <%= csrf_meta_tags %>
   </head>
   <body>

data/lib/mautic/proxy.rb

@@ -14,7 +14,7 @@ module Mautic
     end
 
     def data_name
-      @endpoint.split("/").last
+      @options[:data_name] || @endpoint.split("/").last
     end
 
     def build_instance(data)
@@ -79,4 +79,4 @@ module Mautic
     end
 
   end
-end
+end

data/lib/mautic/submissions/form.rb

@@ -1,5 +1,6 @@
 module Mautic
   module Submissions
+    # @see https://developer.mautic.org/#get-form-submissions
     class Form
       attr_reader :id
 
@@ -36,6 +37,11 @@ module Mautic
         @raw["referer"].to_s
       end
 
+      # @return [Hash]
+      def results
+        @raw["results"]
+      end
+
     end
   end
 end

data/lib/mautic/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mautic
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-26 00:00:00.000000000 Z
+date: 2020-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -160,12 +160,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/mautic_manifest.js
-- app/assets/javascripts/mautic/application.js
-- app/assets/javascripts/mautic/mautic_connections.js
-- 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/concerns/mautic/receive_web_hooks.rb
 - app/controllers/mautic/application_controller.rb
@@ -175,9 +169,11 @@ files:
 - app/mailers/mautic/application_mailer.rb
 - app/models/mautic/application_record.rb
 - app/models/mautic/campaign.rb
+- app/models/mautic/company_field.rb
 - app/models/mautic/connection.rb
 - app/models/mautic/connections/oauth2.rb
 - app/models/mautic/contact.rb
+- app/models/mautic/contact_field.rb
 - app/models/mautic/event.rb
 - app/models/mautic/form.rb
 - app/models/mautic/tag.rb
@@ -223,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Ruby on Rails Mautic integration

data/app/assets/config/mautic_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/mautic .js
-//= link_directory ../stylesheets/mautic .css

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

@@ -1,14 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-// require rails-ujs
-//= require_tree .

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

@@ -1,2 +0,0 @@
-// Place all the behaviors and hooks related to the matching controller here.
-// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/mautic/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/assets/stylesheets/mautic/mautic_connections.css

@@ -1,4 +0,0 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/

data/app/assets/stylesheets/scaffold.css

@@ -1,80 +0,0 @@
-body {
-  background-color: #fff;
-  color: #333;
-  margin: 33px;
-}
-
-body, p, ol, ul, td {
-  font-family: verdana, arial, helvetica, sans-serif;
-  font-size: 13px;
-  line-height: 18px;
-}
-
-pre {
-  background-color: #eee;
-  padding: 10px;
-  font-size: 11px;
-}
-
-a {
-  color: #000;
-}
-
-a:visited {
-  color: #666;
-}
-
-a:hover {
-  color: #fff;
-  background-color: #000;
-}
-
-th {
-  padding-bottom: 5px;
-}
-
-td {
-  padding: 0 5px 7px;
-}
-
-div.field,
-div.actions {
-  margin-bottom: 10px;
-}
-
-#notice {
-  color: green;
-}
-
-.field_with_errors {
-  padding: 2px;
-  background-color: red;
-  display: table;
-}
-
-#error_explanation {
-  width: 450px;
-  border: 2px solid red;
-  padding: 7px 7px 0;
-  margin-bottom: 20px;
-  background-color: #f0f0f0;
-}
-
-#error_explanation h2 {
-  text-align: left;
-  font-weight: bold;
-  padding: 5px 5px 5px 15px;
-  font-size: 12px;
-  margin: -7px -7px 0;
-  background-color: #c00;
-  color: #fff;
-}
-
-#error_explanation ul li {
-  font-size: 12px;
-  list-style: square;
-}
-
-label {
-  display: block;
-}