devise_campaignable 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daf89819dba50b5d7e703bfa070061817c2e48db
-  data.tar.gz: 4b00b9c8067dc9bda6e7130df83a9727c2a1fc93
+  metadata.gz: 14a7a24f8cd973480789f970ba22350b78757432
+  data.tar.gz: ed115510d3be3239206b6aa0bb541fd31e6374c1
 SHA512:
-  metadata.gz: cae27bc83a46707fe46d99266cdd0b2c3d26ad07f60adae178b19b6f623ddb36c1761a9ee5b85ddbdf930bc5e4bd2f6c6b2614e19c3265d3e5052160d443ffe7
-  data.tar.gz: e4dcfa502a404ec130fa83ae9dc0e07dc3a055e5fc9631cf298428bfef6020059f32ada6d37f22b00a6e957859bcf8a275cc9dcffcbc2b18e2b350a1e5997f15
+  metadata.gz: 3da5b3a6e930f9723e2a62ab4dbc45e67b8f4f16fd5460b6365a87d90d890f6785a8fbc3b9ff14973cf06bf113fdea38463a10b4776caa54d9e403710480f9f8
+  data.tar.gz: 70d51c5ba5f574011aebce55bfda71235e4e5cc42e7698f608c0d44d22a0f953eb04493c87376e96743b1e80bb264d699b22691bcaf4b077f32e006ab4503281

data/devise_campaignable.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
 
   spec.add_runtime_dependency "devise", ">= 3.2.0"
-  spec.add_runtime_dependency "gibbon", "~> 1.1"
+  spec.add_runtime_dependency "gibbon", "~> 2.0"
 end

data/lib/devise_campaignable/adapters/mailchimp.rb

@@ -7,30 +7,20 @@ module Devise
             # Subscribe an email to the instantiated list.
             def subscribe(email, merge_vars={})
 	            # Logic for mailchimp subcription.
-	            api.subscribe({
-	            	:id => @campaignable_list_id,
-	                :email => {
-	                    :email => email
-	                }, 
-	                :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.
-                    :merge_vars => merge_vars # Include additional variables to be stored.
+	            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.
 	            })
             end
 
             # Update an existing subscription.
             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 => merge_vars # Include additional variables to be stored, including new email
+                # Update the existing member details.
+                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.
                 })
             end
 
@@ -38,46 +28,66 @@ module Devise
 	        # This method is available for API Keys belonging to users with the following roles: manager, admin, owner
             def unsubscribe(email)
 	            # Logic for mailchimp unsubscription.
-	            api.unsubscribe({
-	            	:id => @campaignable_list_id,
-	                :email => {
-	                    :email => email
-	                }, 
-	                :send_goodbye => false, # Don't send a goodbye email.
-	                :send_notify => false # Don't notify the user of the unsubscription.
-	            })
-            end            
+	            api.lists(@campaignable_list_id).members(subscriber_hash(email)).update(body: { status: "unsubscribed" })
+            end
 
             # Subscribe all users as a batch.
             def batch_subscribe(emails=[])
-                # Do this using a batch call to the MailChimp API for performance rather than lots of single API calls.
-                api.batch_subscribe({
-                	:id => @campaignable_list_id,
-                    :batch => emails.map {|email| {:email => { :email => email }} }, # Map all users in the system into a mailchimp collcation.
-                    :double_optin => false, # Don't require email authorization.
-                    :update_existing => true, # Don't error if adding existing subscriber.
-                    :replace_interests => false # Don't send a welcome email when they're added to the list.                
-                })
+                # Prepate the batch of subscribe operations to be called.
+                operations = []
+
+                # Create a upsert operations for each of the email addresses.
+                emails.each do |email|
+                    # The operation is manually compiled as the Gibbon
+                    # gem doesn't give us an easy way of doing this.
+                    operations.append({
+                        :method => "POST",
+                        :path => "/lists/#{@campaignable_list_id}/members",
+                        :body => {
+                            :email_address => email,
+                            :status => "subscribed"
+                        }.to_json
+                    })
+                end
+
+                # Make the request to process the batch of operations
+                api.batches.create(body: {:operations => operations})
             end
 
             # Unsubscribe all users as a batch.
             def batch_unsubscribe(emails=[])
-                # Do this using a batch call to the MailChimp API for performance rather than lots of single API calls.
-                api.batch_unsubscribe({
-                	:id => @campaignable_list_id,
-                    :batch => emails.map {|email| {:email => { :email => email }} }, # Map all users in the system into a mailchimp collcation.
-                    :send_goodbye => false, # Don't send a goodbye email.
-                    :send_notify => false # Don't notify the user of the unsubscription.             
-                })
+                # Prepate the batch of subscribe operations to be called.
+                operations = []
+
+                # Create a upsert operations for each of the email addresses.
+                emails.each do |email|
+                    # The operation is manually compiled as the Gibbon
+                    # gem doesn't give us an easy way of doing this.
+                    operations.append({
+                        :method => "PATCH",
+                        :path => "/lists/#{@campaignable_list_id}/members/#{subscriber_hash(email)}",
+                        :body => { :status => "unsubscribed" }.to_json
+                    })
+                end
+
+                # Make the request to process the batch of operations
+                api.batches.create(body: {:operations => operations})
             end
 
             private
 
+                # Convert the members email into a hash
+                # to be sent to mailchimp as part of the update calls.
+                def subscriber_hash(email)
+                    # Simple hash of the email address.
+                    Digest::MD5.hexdigest(email)
+                end
+
                 # Get an instance of the MailChimp API.
                 def api
                     # Instantiate an instance of Gibbon with the API key provided to this adapter.
                     # We only work with the lists api here, so namespace into that.
-                    Gibbon::API.new(@campaignable_api_key).lists                   
+                    Gibbon::Request.new(api_key: @campaignable_api_key)
                 end
 
         end

data/lib/devise_campaignable/version.rb

@@ -1,3 +1,3 @@
 module DeviseCampaignable
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_campaignable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Rawlins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 description: Inspired by the now slightly out of date devise_mailchimp this gem works
   in a similar fashion but with a focus on multi-vendor support, rather than exclusively
   MailChimp.