devise_campaignable 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37e2f0f36b37d7f41f3a02e7ab940b1ac752c493
-  data.tar.gz: 1cbef6baab371c3a9fce5f68f4fdaf15dad45eb5
+  metadata.gz: d49a6804ef7659a0234f0ae7b2c9eaa1f5411cb9
+  data.tar.gz: 71eba1a480d64f4cce9ee93ca3ddbce609c3e696
 SHA512:
-  metadata.gz: b654b4e9b1df6b574d28d40471eadc161e660b1d3e779b98f6976868c8e0208d5b020c80900354471ee49e51af67d72c07f49f4759fc7ccc3887e03e06027f7b
-  data.tar.gz: d3345a32fe22e62bb2b49c81fabde912a0b16b6226a2d08ecef8d7e716110a999c4658275d9751b40d82e18ed586410fdc9806f84ba28c843c54ffcb25b27465
+  metadata.gz: 7d1aa9bed23eba753db194a591a908e3c9a38aec87e85cf202b5b1a047ab038e92ad8f8aa8e3b9eee8b911dbda5992ba64106afb01a8a08f63ffbc590825771f
+  data.tar.gz: 5556fbae3e90a96cf9ee57e190f3294d7aecc9f5925936010810f9ef086df5574bc615338d46eeedc7bc86bde04ed575d3c3df278d01a8433b4c5909c6793228

data/README.md

@@ -14,7 +14,6 @@ Simply add DeviseCampaignable and Gibbon to your application's Gemfile:
 
 	gem 'devise'
     gem 'devise_campaignable'
-      gem 'gibbon'
 
 ## Devise Configuration
 
@@ -26,6 +25,7 @@ Devise.setup do |config|
 	config.campaignable_vendor = :vendor_name
 	config.campaignable_api_key = 'your_service_api_key'
 	config.campaignable_list_id = 'the_id_of_the_list_to_which_we_subscribe'
+	config.campaignable_additional_fields = [:array, :of, :additional, :fields]
 end
 ```
 
@@ -41,6 +41,10 @@ A API key for your chosen vendor. How you aqcuire this will depend from vendor t
 
 The unique ID of the list to which you want your users to be subscribed. Again, how you get this will vary from vendor to vendor.
 
+#### 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.
+
 ## Model Configuration
 
 Add :campaignable to the **devise** call in your model (we’re assuming here you already have a User model with some Devise modules):

data/lib/devise_campaignable.rb

@@ -34,11 +34,20 @@ module Devise
 	# account tab in your MailChimp account and select API Keys & Authorized Apps, then add
 	# a key.  This defaults to 'your_api_key'
 	#
-	# Set subsribable_api_key in the Devise configuration file (config/initializers/devise.rb)
+	# Set campaignable_api_key in the Devise configuration file (config/initializers/devise.rb)
 	#
-	#   Devise.subsribable_api_key = "your_api_key"
+	#   Devise.campaignable_api_key = "your_api_key"
 	mattr_accessor :campaignable_api_key
 	@@campaignable_api_key = 'your_api_key'
+
+	# Public: The names of additional columns on your user model you want passed along to
+	# the campaign service provider, this may be things like names, address, plan etc.
+	#
+	# Set campaignable_additional_fields in the Devise configuration file (config/initializers/devise.rb)
+	#
+	#   Devise.campaignable_additional_fields = [:first_name, :last_name, :favourite_colour]
+	mattr_accessor :campaignable_additional_fields
+	@@campaignable_additional_fields = []
 end
 
 Devise.add_module :campaignable, :model => 'devise_campaignable/model'

data/lib/devise_campaignable/adapters/adapter.rb

@@ -15,7 +15,7 @@ module Devise
             # in the parent class but not on the base adapter.
             #
             # Accepts single email address to subscribe.
-            def subscribe(email)
+            def subscribe(email, merge_vars={})
                 # Raise an error to warn it isn't implemented.
                 raise NotImplementedError.new
             end
@@ -24,7 +24,7 @@ module Devise
             # in the parent class but not on the base adapter.
             #
             # Update an existing subscription.
-            def update_subscription(old_email, new_email)
+            def update_subscription(old_email, new_email, merge_vars={})
                 # Raise an error to warn it isn't implemented.
                 raise NotImplementedError.new
             end

data/lib/devise_campaignable/adapters/mailchimp.rb

@@ -5,7 +5,7 @@ module Devise
         class Mailchimp < Adapter
 
             # Subscribe an email to the instantiated list.
-            def subscribe(email)
+            def subscribe(email, merge_vars={})
 	            # Logic for mailchimp subcription.
 	            api.subscribe({
 	            	:id => @campaignable_list_id,
@@ -14,21 +14,23 @@ module Devise
 	                }, 
 	                :double_optin => false, # Don't require email authorization.
 	                :update_existing => true, # Don't error if adding existing subscriber.
-	                :send_welcome => false # Don't send a welcome email when they're added to the list.
+	                :send_welcome => false, # Don't send a welcome email when they're added to the list.
+                    :merge_vars => merge_vars # Include additional variables to be stored.
 	            })
             end
 
             # Update an existing subscription.
-            def update_subscription(old_email, new_email)
+            def update_subscription(old_email, new_email, merge_vars={})
+                # Append the new email address into the merge vars.
+                merge_vars[:new_email] = new_email
+
                 # Mailchimp have a handy helper for updating an existing subscription.
                 api.update_member({
                     :id => @campaignable_list_id,
                     :email => {
                         :email => old_email
                     },         
-                    :merge_vars => {
-                        :'new-email' => new_email
-                    }
+                    :merge_vars => merge_vars # Include additional variables to be stored, including new email
                 })
             end
 

data/lib/devise_campaignable/model.rb

@@ -30,14 +30,14 @@ module Devise
         # Method to subscibe the user to the configrued mailing list.
         def subscribe
             # Ask the list manager to subscribe this devise models email.
-            self.class.list_manager.subscribe(self.email)
+            self.class.list_manager.subscribe(self.email, campaignable_additional_fields)
         end
 
         # Method to update the subscription
         def update_subscription
             # Only change the subscription if the models email
             # address has been changed.
-            self.class.list_manager.update_subscription(self.email_was, self.email) if self.email_changed?
+            self.class.list_manager.update_subscription(self.email_was, self.email, campaignable_additional_fields) if self.email_changed?
         end
 
         # Method to unsubscribe the user from the configured mailing list.
@@ -46,6 +46,23 @@ module Devise
             self.class.list_manager.unsubscribe(self.email)
         end
 
+        private
+
+            # Get a hash of the additional fields.
+            def campaignable_additional_fields
+                # Create an empty hash to store the fields.
+                additional_fields = {}
+
+                # Loop over the additional fields configured.
+                self.class.campaignable_additional_fields.each do |field_name|
+                    # Create a new additional field using the key/value.
+                    additional_fields[field_name] = self.send(field_name)
+                end
+
+                # Compact to the hash to remove any empty data.
+                additional_fields.compact
+            end
+
         module ClassMethods
 
             # Get the list subscriber library.
@@ -82,7 +99,7 @@ module Devise
             end
 
             # Set the configuration variables for the modeule.
-            Devise::Models.config(self, :campaignable_api_key, :campaignable_list_id, :campaignable_vendor)
+            Devise::Models.config(self, :campaignable_api_key, :campaignable_list_id, :campaignable_vendor, :campaignable_additional_fields)
         end
     end
   end

data/lib/devise_campaignable/version.rb

@@ -1,3 +1,3 @@
 module DeviseCampaignable
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_campaignable
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Rawlins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler