mautic 2.3.4 → 2.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afb8b76cddd73b61cfefac55cd183fd3b84603dfc1681fe00d4c524838cf5bcb
-  data.tar.gz: 8a632817a47a0e2819a4cd74fef4798ebddf80cd9c68fdebad462bb0ca3a570d
+  metadata.gz: af1f088355eb05f40c5b2d22ce36e6c6319ff7e0bc7b6e62b798762a2a400724
+  data.tar.gz: 92867e40e6b9722094f2c174b4a40286cdac41e07c09553e11b38df4caaff4c6
 SHA512:
-  metadata.gz: cb0312a5a188a6619421a33b4768dd5e2aa90ea6ef7764e67a7ad169e9b1ec24bf342c9eb1ce4c22958a24562c22a2c80285daa8f48c14c9df1fc2bca2603dcf
-  data.tar.gz: 4b4b003e569e396529ece6d0971d749131996d0e0692cf33f64af21efa164820dab732b155526d3074d4e136c9ac91648180d540407523f8f4a9e9815de5ca5f
+  metadata.gz: 361320378ad1c77a3bd8b0a3600ad30fe5c5a95fc7aab7a934992a1fd591c23fd872b3c5aa0ebaf30e54e87997763bc3775119747ef2fa0f449a8252fd3626d2
+  data.tar.gz: 5a630110651bd5fd915fd05570953bdf326c513cdea05d20f0040a6628a6b9b159bf55af5e0ffca6153dab32061a2fdd9dc0f30bd4c7d82401ccf098e9f4072f

data/README.md

@@ -88,6 +88,18 @@ mount Mautic::Engine => "/mautic"
   contact.save # => false
   contact.errors # => [{"code"=>400, "message"=>"email: This field is required.", "details"=>{"email"=>["This field is required."]}}]
   ```
+  Do not contact
+  ```ruby
+  contact.do_not_contact? # => false
+  contact.do_not_contact! message: "Some reason"
+  contact.do_not_contact? # => true
+  ```
+  Remove do not contact
+  ```ruby
+  contact.do_not_contact? # => true
+  contact.remove_do_not_contact!
+  contact.do_not_contact? # => false
+  ```
   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/contact.rb

@@ -3,6 +3,7 @@ module Mautic
 
     alias_attribute :first_name, :firstname
     alias_attribute :last_name, :lastname
+
     def self.in(connection)
       Proxy.new(connection, endpoint, default_params: { search: '!is:anonymous' })
     end
@@ -13,14 +14,78 @@ module Mautic
 
     def assign_attributes(source = nil)
       super
-      self.attributes = {
-        tags: (source['tags'] || []).collect { |t| Mautic::Tag.new(@connection, t) }.sort_by(&:name)
-      } if source
+      if source
+        self.attributes = {
+          tags: (source['tags'] || []).collect { |t| Mautic::Tag.new(@connection, t) }.sort_by(&:name),
+          doNotContact: source['doNotContact'] || [],
+        }
+      end
     end
 
     def events
       @proxy_events ||= Proxy.new(connection, "contacts/#{id}/events", klass: "Mautic::Event")
     end
 
+    # @!group Do Not Contact
+    # @see https://developer.mautic.org/#add-do-not-contact
+
+    def do_not_contact?
+      doNotContact.present?
+    end
+    alias dnc? do_not_contact?
+
+    # @return [Array[Hash]]
+    def do_not_contact
+      return unless do_not_contact?
+
+      # Based on mautic docs => Contacts constants: Contacts::UNSUBSCRIBED (1), Contacts::BOUNCED (2), Contacts::MANUAL (3)
+      reason_list = { 1 => :unsubscribed, 2 => :bounced, 3 => :manual }
+      @do_not_contact ||= doNotContact.collect do |hsh|
+        { reason_list[hsh["reason"]] => hsh["comments"] }
+      end
+    end
+
+    def bounced?
+      do_not_contact? && !!do_not_contact.detect { |dnc| dnc.key?(:bounced) }
+    end
+
+    def unsubscribed?
+      do_not_contact? && !!do_not_contact.detect { |dnc| dnc.key?(:unsubscribed) }
+    end
+
+    def do_not_contact!(comments: '')
+      begin
+        json = @connection.request(:post, "api/contacts/#{id}/dnc/email/add", body: { comments: comments })
+        self.attributes = { doNotContact: json[endpoint.singularize]["doNotContact"] }
+        clear_changes
+      rescue ValidationError => e
+        self.errors = e.errors
+      end
+
+      self.errors.blank?
+    end
+    alias add_dnc do_not_contact!
+
+    def remove_do_not_contact!
+      begin
+        json = @connection.request(:post, "api/contacts/#{id}/dnc/email/remove", body: {})
+        self.attributes = { doNotContact: json[endpoint.singularize]["doNotContact"] }
+        clear_changes
+      rescue ValidationError => e
+        self.errors = e.errors
+      end
+
+      self.errors.blank?
+    end
+    alias remove_dnc remove_do_not_contact!
+
+    # !endgroup
+
+    private
+
+    def clear_change
+      super
+      remove_instance_variable :@do_not_contact
+    end
   end
 end

data/lib/mautic/version.rb

@@ -1,3 +1,3 @@
 module Mautic
-  VERSION = '2.3.4'
+  VERSION = '2.3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mautic
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.3.5
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-03-03 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.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails Mautic integration