devise_campaignable 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 751ee1ed0076c925f82fc139434f15fa1009fa62
-  data.tar.gz: db5d81fd9147d2433af34592eb97f6e1c7aa3f43
+  metadata.gz: b541e0a1dae4c14bde1a8a02ad5e461e1b2f6de2
+  data.tar.gz: 91813e958ac27a088fc7b24be4978e22785db627
 SHA512:
-  metadata.gz: 6ece3bc3f9d0838d1773031451ca057490e1555db1493f0d80ac045e4ed89c3f56da4014b857e240ede1fe9408f289995e10c11c7212ab19dc75ac8e2eda467a
-  data.tar.gz: 997614ebdc35e6f71e78116244210c1029fc9db83544d8e62b932f47c570f72c6b86c9001cfd00a01a52e06c70b525b2c4b528d528afb47fc4c472ee12514f24
+  metadata.gz: d232dec8510b38130393668ae4df4391b401cba9a3b3c124fc812558103f16ee520e4e79d41f5c11fe389204b00806cd3a7cc6ecca0df3714883fb6b2915dab5
+  data.tar.gz: 712b10cc75b1cde529ffa78cadbac9a6af6d7c7fcacbbf4bd12c16e57b4d212849d6e7bc0f9e4295004581630de00f6fef0c0e3d4e847389b615acf7c3e61f25

data/README.md

@@ -43,7 +43,9 @@ The unique ID of the list to which you want your users to be subscribed. Again,
 
 #### config.campaignable_additional_fields (optional)
 
-An array of symbols which denote attributes on the model you want sent to the campaign vendor. Can be things like Name, Age, Address. Defaults to no additional fields.
+An array of symbols which denote attributes on the model you want sent to the campaign vendor. Can be things like Name, Age, Address. Defaults to no additional fields. 
+
+**MailChimp Users: You need to have added merge fields with matching names to your MailChimp list before this will work, the merge fields should match the attribute on your user model, capitalized. i.e. an attribute such as 'name' should have a merge field on the list of 'NAME'.**
 
 ## Model Configuration
 

data/lib/devise_campaignable/adapters/mailchimp.rb

@@ -10,7 +10,7 @@ module Devise
 	            api.lists(@campaignable_list_id).members(subscriber_hash(email)).upsert(body: {
 	                :email_address => email,
                     :status => "subscribed",
-                    :merge_fields => merge_vars # Include additional variables to be stored.
+                    :merge_fields => prep_merge_fields(merge_vars) # Include additional variables to be stored.
 	            })
             end
 
@@ -20,7 +20,7 @@ module Devise
                 api.lists(@campaignable_list_id).members(subscriber_hash(old_email)).update(body: {
                     :email_address => new_email,
                     :status => "subscribed",
-                    :merge_fields => merge_vars # Include additional variables to be stored.
+                    :merge_fields => prep_merge_fields(merge_vars) # Include additional variables to be stored.
                 })
             end
 
@@ -30,8 +30,10 @@ module Devise
 	            # Logic for mailchimp unsubscription.
 	            api.lists(@campaignable_list_id).members(subscriber_hash(email)).update(body: { status: "unsubscribed" })
             rescue Gibbon::MailChimpError => e
-              raise unless e.status_code == 404
-              Rails.logger.warn "unsubscribe: User #{email} not found!"
+                # Reraise any non 404 errors.
+                raise unless e.status_code == 404
+                # Log rails errors into the rails logger.
+                Rails.logger.warn "unsubscribe: User #{email} not found!"
             end
 
             # Subscribe all users as a batch.
@@ -79,6 +81,12 @@ module Devise
 
             private
 
+                # Prepare the merge fields to be sent to MailChimp.
+                def prep_merge_fields(merge_fields)
+                    # Upper-case all the keys as this is how MC expect them.
+                    merge_fields.map { |k, v| [k.upcase, v] }.to_h
+                end
+
                 # Convert the members email into a hash
                 # to be sent to mailchimp as part of the update calls.
                 def subscriber_hash(email)

data/lib/devise_campaignable/model.rb

@@ -48,6 +48,7 @@ module Devise
         
         # Returns true if it's a valid email for subscribing
         def self.valid_campaign_email?(email)
+            # Check that the email is present, and that it's not an example domain.
             email.present? && /\@example\.(com|net|org|edu)$/ !~ email
         end
 
@@ -69,6 +70,7 @@ module Devise
             end
             
             def campaignable_user?
+                # Check the email is valid, so callbacks not fired for example domains.
                 Campaignable.valid_campaign_email? self.email
             end
 

data/lib/devise_campaignable/version.rb

@@ -1,3 +1,3 @@
 module DeviseCampaignable
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_campaignable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Robert Rawlins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A multi-vendor mailing list extension for Devise. Have your users automatically