brightbytes-sendgrid 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2U2NTdjZDQ5OWM5NjRhZWE5MjFjNGViYTc2MDI3ZGFlMWM4N2IwNw==
+    ZDA1YWNiMmIxY2JhOTU0NmQxYzcyM2QyZGQ1Y2EyOTU1YmM0MWU3ZA==
   data.tar.gz: !binary |-
-    M2YwNjgwM2JhYzBhNWJiMWZjZGYzZWNlNjU0M2UxODBjOWI4NDQ2Yg==
+    ZGQzNzAzZjA4ZWFlN2ZjMDUwZWU0YmZiOTAyOTUzOTkyOWY2OWRjNA==
 SHA512:
   metadata.gz: !binary |-
-    MjVhNWVmMzg1OTU1ZDdmYjZjNGVhZTU0NjBlYWU1NTQ1YWJkODMyNDc2MTQ1
-    ZTNlYTUzZTAyYmY2YmUxMmNiYzQ1MmMzOTFlNDg2NGU2MTlmNjViMDk1YmI2
-    MzE4NzlmZGZkNmRiZDY0ZjBmNGY0MzlkMjIyOGY5MjJhZjFlMzk=
+    NWNmMjlkNzJjMDc4YTI2ZDVkYzI4MDAwYTg5ZTI0ZjZhYjVlYTM3NDQyNGMx
+    YzdhMjA1MDU2MzlhOGM3ZDk4NWExNThjOWM0ZTk3ZTEwZDYxZWU3NDAzYWM0
+    ZjIyNTM2NzFlZTM0ODIyZGIxZWMyZDQxZjUyNmFkYzc5Mjk2ZDY=
   data.tar.gz: !binary |-
-    MDE4ZGMwNmUxNzUyODNjNzk5ZWE3Mzc0YTgyOTRlMTgzNzUzN2U0Y2UyODc2
-    YmVlM2IxODUzNjczYzdlN2Q1NmU2ZGRlZjc4NzE4NWFmMWY1MmNlNTNkZDhl
-    Mjc0NTMwNzI4MDU5YTVjMmVmZTgyNmE5N2ZlZDBmNjVlMDc3ZDM=
+    ZDFiM2RlMWU3YmY0ZGNlYzAyZTUxMGZhYzQ0NzkyZTc5Mzg2ZTVmOWNiM2Ji
+    OTFkNzQ4MzZiNzBhMWY0NDgyMWJiZWRjYzI5NzMwZWZiZDRiY2Y5MmY3YTkw
+    ZTYxMDY1N2QxOTE2NjQyODVhMWYyZDFmNjVkNTE4MTUzMDI4YWE=

data/README.md

@@ -70,6 +70,10 @@ You can use following methods to set both global and per-email SendGrid SMTP API
   
     sendgrid_disable :clicktrack
     
+**sendgrid_bcc**
+
+    sendgrid_bcc 'some@email.com'
+    
 ## Auto generated unsubscribe link
 
 It is not a SendGrid **subscriptiontrack** filter!
@@ -80,8 +84,21 @@ Those links will be sent as a substitutions to SendGrid.
 So, to make this feature work, you have to:
 
 1. Configure unsubscribe categories. It will trigger link generator
+
+        config.unsubscribe_categories [:newsletter, :notifications]
+      
 2. Configure an unsubscribe_url. The resulting URL will be composed of unsubscribe_url and email and category parameters.
-3. Put {{unsubscribe}} placeholder somewhere in your email body
+
+        config.unsubscribe_url 'http://domain.com/unsubscribe'
+        config.unsubscribe_url Proc.new { |params| your_way_to_build_the_url(params) }
+        
+3. Put {{unsubscribe_html}} or {{unsubscribe_text}} or {{unsubcribe_url}} placeholder somewhere in your email body. You can adjust how html and text version are built:
+
+        config.unsubcribe_html_message "Click here to"
+        config.unsubcribe_link_text "unsubcribe"
+        # will produce "Click here to <a href="url">unsubscribe</a>"
+        config.unsubcribe_text_message "Go there to unsubscribe:"
+        # will produce "Go there to unsubscribe: url"
 
 ##Contributors
 

data/lib/brightbytes/sendgrid/config.rb

@@ -17,20 +17,28 @@ module Brightbytes
 
       # Unsubscribe default settings storage
 
-      class UnsubscribeConfig < Struct.new(:categories, :url); end
+      class UnsubscribeConfig < Struct.new(:categories, :url, :html_message, :link_text, :text_message); end
       
       def unsubscribe
-        @unsubscribe ||= UnsubscribeConfig.new([],nil)
+        @unsubscribe ||= UnsubscribeConfig.new(
+          [], nil, 
+          "If you would like to unsubscribe and stop receiving these emails", "click here",
+          "If you would like to unsubscribe and stop receiving these emails click here:"
+        )
       end
 
       def unsubscribe_categories(*categories)
         unsubscribe.categories = categories.flatten.map(&:to_sym)
       end
 
-      def unsubscribe_url(url)
-        unsubscribe.url = url
+      [:url, :html_message, :link_text, :text_message].each do |meth|
+        class_eval <<-DEF
+          def unsubscribe_#{meth}(value)
+            unsubscribe.#{meth} = value
+          end
+        DEF
       end
-
+      
     end
   end
 end

data/lib/brightbytes/sendgrid/unsubscribe.rb

@@ -23,30 +23,32 @@ module Brightbytes
       def add_links
         return unless feature_active?
         if categories.present?
-          sendgrid.section :unsubscribe, "<a href=\"{{unsubscribe_link}}\">Unsubscribe</a>"
+          sendgrid.section :unsubscribe_html_section, "#{unsubscribe.html_message} <a href=\"{{unsubscribe_url}}\" rel=\"nofollow\">#{unsubscribe.link_text}</a>"
+          sendgrid.section :unsubscribe_text_section, "#{unsubscribe.text_message} {{unsubscribe_url}}"
           emails.each do |email|
-            sendgrid.add_substitute :unsubscribe_link, unsubscribe_link(email)
+            sendgrid.add_substitute :unsubscribe_html, "{{unsubscribe_html_section}}"
+            sendgrid.add_substitute :unsubscribe_text, "{{unsubscribe_text_section}}"
+            sendgrid.add_substitute :unsubscribe_url,  unsubscribe_url(email)
           end
         else
-          sendgrid.section :unsubscribe, ''
-          sendgrid.add_substitute :unsubscribe_link, Array.new(emails.size, '')
+          sendgrid.add_substitute :unsubscribe_html, Array.new(emails.size, '')
+          sendgrid.add_substitute :unsubscribe_text, Array.new(emails.size, '')
+          sendgrid.add_substitute :unsubscribe_url,  Array.new(emails.size, '')
         end
       end
             
       private
       
-      def config
+      def unsubscribe
         Brightbytes::Sendgrid.config.unsubscribe
       end
       
-      delegate :categories, :url, to: :config, prefix: :unsubscribe
-      
       def feature_active?
-        unsubscribe_categories.present? || unsubscribe_url.present?
+        unsubscribe.categories.present? || unsubscribe.url.present?
       end
             
       def categories
-        @categories ||= unsubscribe_categories & sendgrid.categories
+        @categories ||= unsubscribe.categories & sendgrid.categories
       end
 
       def emails
@@ -60,12 +62,12 @@ module Brightbytes
       def message_recipients
         Array.wrap(message.to) + Array.wrap(message.cc) + Array.wrap(message.bcc)
       end
-      
-      def unsubscribe_link(email)
-        if unsubscribe_url.instance_of? Proc
-          unsubscribe_url.call(email: email, category: categories)
+            
+      def unsubscribe_url(email)
+        if unsubscribe.url.instance_of? Proc
+          unsubscribe.url.call(email: email, category: categories)
         else
-          "#{unsubscribe_url}#{unsubscribe_url[-1] == '?' ? '' : '?'}#{url_parameters(email)}"
+          "#{unsubscribe.url}#{unsubscribe.url[-1] == '?' ? '' : '?'}#{url_parameters(email)}"
         end
       end
       

data/lib/brightbytes/sendgrid/version.rb

@@ -1,5 +1,5 @@
 module Brightbytes
   module Sendgrid
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/spec/brightbytes/sendgrid_mailer_spec.rb

@@ -42,9 +42,17 @@ describe SendgridMailer do
     subject(:message) { described_class.unsubscribe_not_required }
     
     before(:each) { sendgrid_config_setup }
-  
-    it 'unsubscribe section should be empty' do
-      header.should include('"{{unsubscribe}}": ""')
+
+    it 'unsubscribe html version should be empty' do
+      header.should include('"{{unsubscribe_html}}": ["",""]')
+    end
+
+    it 'unsubscribe text version should be empty' do
+      header.should include('"{{unsubscribe_text}}": ["",""]')
+    end
+
+    it 'unsubscribe url should be empty' do
+      header.should include('"{{unsubscribe_url}}": ["",""]')
     end
   end
   
@@ -53,12 +61,24 @@ describe SendgridMailer do
     
     before(:each) { sendgrid_config_setup }
   
-    it 'unsubscribe section should be set' do
-      header.should include('"{{unsubscribe}}": "<a href=\"{{unsubscribe_link}}\">Unsubscribe</a>"')
+    it 'unsubscribe html section should be set' do
+      header.should include('"{{unsubscribe_html_section}}": "If you would like to unsubscribe and stop receiving these emails <a href=\"{{unsubscribe_url}}\" rel=\"nofollow\">click here</a>"')
     end
-  
-    it 'unsubscribe link should be set' do
-      header.should include('"{{unsubscribe_link}}": ["http://example.com/u?email=email1%40email.com&category=unsubscribe","http://example.com/u?email=email2%40email.com&category=unsubscribe"]')
+
+    it 'unsubscribe text section should be set' do
+      header.should include('"{{unsubscribe_text_section}}": "If you would like to unsubscribe and stop receiving these emails click here: {{unsubscribe_url}}"')
+    end
+
+    it 'unsubscribe html version should be set' do
+      header.should include('"{{unsubscribe_html}}": ["{{unsubscribe_html_section}}","{{unsubscribe_html_section}}"]')
+    end
+
+    it 'unsubscribe text version should be set' do
+      header.should include('"{{unsubscribe_text}}": ["{{unsubscribe_text_section}}","{{unsubscribe_text_section}}"]')
+    end
+
+    it 'unsubscribe url should be set' do
+      header.should include('"{{unsubscribe_url}}": ["http://example.com/u?email=email1%40email.com&category=unsubscribe","http://example.com/u?email=email2%40email.com&category=unsubscribe"]')
     end
   end
     

data/spec/brightbytes/standard_mailer_spec.rb

@@ -17,8 +17,16 @@ describe StandardMailer do
     
     before(:each) { sendgrid_config_setup }
 
-    it 'unsubscribe section should be empty' do
-      header.should include('"{{unsubscribe}}": ""')
+    it 'unsubscribe html version should be empty' do
+      header.should include('"{{unsubscribe_html}}": [""]')
+    end
+
+    it 'unsubscribe text version should be empty' do
+      header.should include('"{{unsubscribe_text}}": [""]')
+    end
+
+    it 'unsubscribe url should be empty' do
+      header.should include('"{{unsubscribe_url}}": [""]')
     end
   end
 
@@ -27,12 +35,24 @@ describe StandardMailer do
     
     before(:each) { sendgrid_config_setup }
 
-    it 'unsubscribe section should be set' do
-      header.should include('"{{unsubscribe}}": "<a href=\"{{unsubscribe_link}}\">Unsubscribe</a>"')
+    it 'unsubscribe html section should be set' do
+      header.should include('"{{unsubscribe_html_section}}": "If you would like to unsubscribe and stop receiving these emails <a href=\"{{unsubscribe_url}}\" rel=\"nofollow\">click here</a>"')
+    end
+
+    it 'unsubscribe text section should be set' do
+      header.should include('"{{unsubscribe_text_section}}": "If you would like to unsubscribe and stop receiving these emails click here: {{unsubscribe_url}}"')
+    end
+
+    it 'unsubscribe html version should be set' do
+      header.should include('"{{unsubscribe_html}}": ["{{unsubscribe_html_section}}"]')
+    end
+
+    it 'unsubscribe text version should be set' do
+      header.should include('"{{unsubscribe_text}}": ["{{unsubscribe_text_section}}"]')
     end
 
-    it 'unsubscribe link should be set' do
-      header.should include('"{{unsubscribe_link}}": ["http://example.com/u?email=email%40email.com&category=unsubscribe"]')
+    it 'unsubscribe url should be set' do
+      header.should include('"{{unsubscribe_url}}": ["http://example.com/u?email=email%40email.com&category=unsubscribe"]')
     end
   end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brightbytes-sendgrid
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Brightbytes Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler