mautic 2.3.3 → 2.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4499d4f66adb74f89f363f1407b0cf917728eaba2e10f9a48183a12ad14d8514
-  data.tar.gz: 2165001c7af680d7f3c9929a1fff7f8d463d8396d9514370f50669d59ac5dcd1
+  metadata.gz: ffa1c03fd57447ef4b33050b2fea5150a9c4b2665675fdb0894f1a914c7e24af
+  data.tar.gz: 05be7f0b16e1a3e0a9f3c3adc0e89c3e3b1c0554afd122777fce06ec2ab1dad9
 SHA512:
-  metadata.gz: 3a6de50ca1f0e1b51b0e7b4a547327351c0ac984e64dd23e48e7e55d20523fa6155b1d2aa0737110878e9af8dda916e17cb40ca9b0752d4b3d79033dbd1a76cf
-  data.tar.gz: 8bf7ba6cbe4fe3903b09b2083dda2a9204d49ac2b0187e0bd053259c57b21db29c2aeadcacdce4261f570cd37d9b10e8dc28f6500463a75335fda29ca116b875
+  metadata.gz: 20100e7ada6a8715ffefe5d2210c4c4cdd20007e0f410ef9d66a192851deca4a86e4b4fb1e91e25a00ac639641d7210c2bf64cf1f8dec36b9476bc73edfd46cb
+  data.tar.gz: 9f6e8a2abcb4ac1e067420e88e1691a6fb0f63cc1ddb3ffaa1a0be8043985dd072735b2e1316c8e0a413dcde474e743c446ed65d2b815dc29da140866a820245

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
@@ -11,16 +12,116 @@ module Mautic
       "#{firstname} #{lastname}"
     end
 
+    # @param [Hash] hash
+    # option hash [Integer] :id
+    # option hash [String] :firstName
+    # option hash [String] :lastName
+    def owner=(hash)
+      raise ArgumentError, "must be a hash !" unless hash.is_a?(Hash)
+
+      @table[:owner] = hash["id"]
+      @owner = hash
+    end
+
+    # @return [Hash]
+    # @example {id: 12, firstName: "Joe", lastName: "Doe"}
+    def owner
+      @owner || {}
+    end
+
+    # Assign mautic User ID as owner - for example for update author of contact
+    # @see https://developer.mautic.org/#edit-contact set owner
+    # @param [Integer] int
+    def owner_id=(int)
+      @table[:owner] = int
+    end
+
     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.owner = source['owner'] || {}
+        self.attributes = {
+          tags: (source['tags'] || []).collect { |t| Mautic::Tag.new(@connection, t) }.sort_by(&:name),
+          doNotContact: source['doNotContact'] || [],
+          owner: owner['id'],
+        }
+      end
+    end
+
+    def to_mautic(data = @table)
+      data.delete(:doNotContact)
+      data.delete(:tags)
+      super(data)
     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/app/models/mautic/tag.rb

@@ -6,6 +6,10 @@ module Mautic
       tag
     end
 
+    def to_s
+      name
+    end
+
     def name=(name)
       self.tag = name
     end

data/lib/mautic.rb

@@ -11,12 +11,23 @@ module Mautic
 
   class RequestError < StandardError
 
-    attr_reader :response, :errors
+    attr_reader :response, :errors, :request_url
 
     def initialize(response, message = nil)
       @errors ||= []
       @response = response
-      json_body = JSON.parse(response.body) rescue {}
+      @request_url = response.response&.env&.url
+      body = if response.body.start_with? "<!DOCTYPE html>"
+               response.body.split("\n").last
+             else
+               response.body
+             end
+
+      json_body = begin
+                    JSON.parse(body)
+                  rescue JSON::ParserError
+                    { "errors" => [{ "code" => response.status, "message" => body }] }
+                  end
       message ||= Array(json_body['errors']).collect do |error|
         msg = error['code'].to_s
         msg << " (#{error['type']}):" if error['type']
@@ -25,7 +36,7 @@ module Mautic
         msg
       end.join(', ')
 
-      super(message)
+      super("#{@request_url} => #{message}")
     end
 
   end
@@ -37,7 +48,11 @@ module Mautic
 
     def initialize(response, message = nil)
       @response = response
-      json_body = JSON.parse(response.body) rescue {}
+      json_body = begin
+                    JSON.parse(response.body)
+                  rescue ParseError
+                    {}
+                  end
       @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)

data/lib/mautic/engine.rb

@@ -5,7 +5,8 @@ module Mautic
     config.generators do |g|
       g.test_framework :rspec, fixture: false
     end
-
+    
+    # :nocov:
     initializer :append_migrations do |app|
       unless app.root.to_s.match root.to_s
         config.paths['db/migrate'].expanded.each do |expanded_path|
@@ -13,6 +14,7 @@ module Mautic
         end
       end
     end
+    # :nocov:
 
   end
 end

data/lib/mautic/model.rb

@@ -38,6 +38,7 @@ module Mautic
     end
 
     attr_reader :connection
+    attr_accessor :errors
 
     # @param [Mautic::Connection] connection
     def initialize(connection, hash = nil)
@@ -58,9 +59,10 @@ module Mautic
 
     def update(force = false)
       return false if changes.blank?
+
       begin
-        json = @connection.request((force && :put || :patch), "api/#{endpoint}/#{id}/edit", { body: to_mautic })
-        self.attributes = json[endpoint.singularize]
+        json = @connection.request((force && :put || :patch), "api/#{endpoint}/#{id}/edit", body: to_mautic)
+        assign_attributes json[endpoint.singularize]
         clear_changes
       rescue ValidationError => e
         self.errors = e.errors
@@ -69,10 +71,18 @@ module Mautic
       self.errors.blank?
     end
 
+    def update_columns(attributes = {})
+      json = @connection.request(:patch, "api/#{endpoint}/#{id}/edit", body: to_mautic(attributes))
+      assign_attributes json[endpoint.singularize]
+      clear_changes
+    rescue ValidationError => e
+      self.errors = e.errors
+    end
+
     def create
       begin
-        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", { body: to_mautic })
-        self.attributes = json[endpoint.singularize]
+        json = @connection.request(:post, "api/#{endpoint}/#{id && "#{id}/"}new", body: to_mautic)
+        assign_attributes json[endpoint.singularize]
         clear_changes
       rescue ValidationError => e
         self.errors = e.errors
@@ -106,8 +116,8 @@ module Mautic
       end
     end
 
-    def to_mautic
-      @table.each_with_object({}) do |(key,val), mem|
+    def to_mautic(data = @table)
+      data.each_with_object({}) do |(key, val), mem|
         mem[key] = val.is_a?(Array) ? val.join("|") : val
       end
     end

data/lib/mautic/proxy.rb

@@ -23,28 +23,20 @@ module Mautic
 
     def all(options = {}, &block)
       if options[:limit] == 'all'
-
         options.delete(:limit)
-
-        records = results = where(options)
-        total = @last_response['total'].to_i
-        while records.any?
-          records.each(&block) if block_given?
-          break if results.size >= total
-
-          records = where(options.merge(start: records.size))
-          results.concat records
-        end
+        limit_all(options, &block)
       else
         results = where(options)
         results.each { |i| yield i } if block_given?
+        results
       end
-      results
     end
 
+    # @param [Hash] params
+    # @see https://developer.mautic.org
     def where(params = {})
       q = params.reverse_merge(@options[:default_params] || {})
-      json = @connection.request(:get, "api/#{@endpoint}", { params: q })
+      json = @connection.request(:get, "api/#{@endpoint}", params: q)
       @count = json["total"].to_i
       @last_response = json
       json[data_name].collect do |id, attributes|
@@ -69,5 +61,22 @@ module Mautic
       @count = json["total"].to_i
     end
 
+    protected
+
+    # @param [Hash] options
+    # @option options (see #where)
+    def limit_all(options, &block)
+      records = results = where(options)
+      total = @last_response['total'].to_i
+      while records.any?
+        records.each(&block) if block_given?
+        break if results.size >= total
+
+        records = where(options.merge(start: records.size))
+        results.concat records
+      end
+      results
+    end
+
   end
 end

data/lib/mautic/version.rb

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

data/spec/rails_helper.rb

@@ -1,6 +1,8 @@
 ENV['RAILS_ENV'] ||= 'test'
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/spec/"
+end
 
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
 # Prevent database truncation if the environment is production

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mautic
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.3.8
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-06-25 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.8
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails Mautic integration