sendgrid-ruby 4.3.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83955f77f1e93c80a05e5d032940419529128ba7
-  data.tar.gz: d901ce541307f08ac44a499dc846aa14dbd30b50
+  metadata.gz: a23133f8c4095f9f190145c808636a48bfd7307c
+  data.tar.gz: 0066b643ab7820a2444a8463e2817a9c76826522
 SHA512:
-  metadata.gz: c4b15198a85c4a7699322963b53e431ed4f1b2603884542a1155a078791565ba319c359ec67f8babd52d70f3680231c3b711d1df398eddcf993b32c3709ba0ba
-  data.tar.gz: c2a8deff3ed44c3e994690dffc5c473330abbf60712c7db16fdab8c5e8995c20d3efd2077152ca59cb84be19aed3f54ac95e07b3a4fc895c2db3486f7802d9ec
+  metadata.gz: 9a493f33a268e47cbbeacb127f8a85fca38dd63da8a4b65522595e8eb44767c93f62711d7d90a52d5289555394e37cf0d261de6bbfeab2dae6df49a4889c0a3d
+  data.tar.gz: c23996c075c861b7aaac71e324c381f05fe5921dc1b07f41f03ac3538a48e0ce34d671ff38e8036a152afe90c0c8e9cbb2332c5856b24267b722b712123e8c6c

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-- 2.2
+- 2.2.6
+- 2.3.4
+- 2.4.1
 gemfile:
 - gemfiles/Sinatra_1.gemfile
 - gemfiles/Sinatra_2.gemfile

data/CHANGELOG.md

@@ -1,6 +1,25 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [5.0.0] - 2017-05-27
+### BREAKING CHANGE
+- #108 Fix unexpected `Mail` `#categories`, `#categories=` behavior
+- Fixed Issue #95 Refactor Mail Helper Array Assignments
+- `personalization.to` becomes `personalization.add_to()`
+- `personalization.cc` becomes `personalization.add_cc()`
+- `personalization.bcc` becomes `personalization.add_bcc()`
+- `personalization.headers` becomes `personalization.add_header()`
+- `personalization.substitutions` becomes `personalization.add_substitution()`
+- `personalization.custom_args` becomes `personalization.add_custom_arg()`
+- `mail.personalizations` becomes `mail.add_personalization()`
+- `mail.contents` becomes `mail.add_content()`
+- `mail.attachments` becomes `mail.attachment()`
+- `mail.sections` becomes `mail.add_section()`
+- `mail.headers` becomes `mail.add_header()`
+- `mail.categories` becomes `mail.add_category()`
+- `mail.custom_args` becomes `mail.custom_args()`
+- For a full example of usage, please [see here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/helpers/mail/example.rb#L21).
+
 ## [4.3.3] - 2017-5-2
 ### Update
 - #157: Specify required ruby version as '>= 2.2'
@@ -32,7 +51,7 @@ All notable changes to this project will be documented in this file.
 
 ## [4.2.0] - 2017-4-10 ##
 ### Added
-- #148: Set api_key to empty string 
+- #148: Set api_key to empty string
 - This makes creating an API key for a SendGrid subuser who does not have an API key easier. See #146 for details
 - Thanks to [Adam Beck](https://github.com/Gwash3189) for the pull request!
 

data/README.md

@@ -81,9 +81,9 @@ require 'sendgrid-ruby'
 include SendGrid
 
 from = Email.new(email: 'test@example.com')
-subject = 'Hello World from the SendGrid Ruby Library!'
 to = Email.new(email: 'test@example.com')
-content = Content.new(type: 'text/plain', value: 'Hello, Email!')
+subject = 'Sending with SendGrid is Fun'
+content = Content.new(type: 'text/plain', value: 'and easy to do anywhere, even with Ruby')
 mail = Mail.new(from, subject, to, content)
 
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
@@ -111,7 +111,7 @@ data = JSON.parse('{
           "email": "test@example.com"
         }
       ],
-      "subject": "Hello World from the SendGrid Ruby Library!"
+      "subject": "Sending with SendGrid is Fun"
     }
   ],
   "from": {
@@ -120,7 +120,7 @@ data = JSON.parse('{
   "content": [
     {
       "type": "text/plain",
-      "value": "Hello, Email!"
+      "value": "and easy to do anywhere, even with Ruby"
     }
   ]
 }')

data/USE_CASES.md

@@ -51,11 +51,11 @@ mail = Mail.new
 mail.from = Email.new(email: 'test@example.com')
 mail.subject = 'I\'m replacing the subject tag'
 personalization = Personalization.new
-personalization.to = Email.new(email: 'test@example.com')
-personalization.substitutions = Substitution.new(key: '-name-', value: 'Example User')
-personalization.substitutions = Substitution.new(key: '-city-', value: 'Denver')
-mail.personalizations = personalization
-mail.contents = Content.new(type: 'text/html', value: 'I\'m replacing the <strong>body tag</strong>')
+personalization.add_to(Email.new(email: 'test@example.com'))
+personalization.add_substitution(Substitution.new(key: '-name-', value: 'Example User'))
+personalization.add_substitution(Substitution.new(key: '-city-', value: 'Denver'))
+mail.add_personalization(personalization)
+mail.add_content(Content.new(type: 'text/html', value: 'I\'m replacing the <strong>body tag</strong>'))
 mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
 
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])

data/examples/helpers/mail/example.rb

@@ -23,41 +23,41 @@ def kitchen_sink
   mail.from = Email.new(email: 'test@example.com')
   mail.subject = 'Hello World from the SendGrid Ruby Library'
   personalization = Personalization.new
-  personalization.to = Email.new(email: 'test1@example.com', name: 'Example User')
-  personalization.to = Email.new(email: 'test2@example.com', name: 'Example User')
-  personalization.cc = Email.new(email: 'test3@example.com', name: 'Example User')
-  personalization.cc = Email.new(email: 'test4@example.com', name: 'Example User')
-  personalization.bcc = Email.new(email: 'test5@example.com', name: 'Example User')
-  personalization.bcc = Email.new(email: 'test6@example.com', name: 'Example User')
+  personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
+  personalization.add_to(Email.new(email: 'test2@example.com', name: 'Example User'))
+  personalization.add_cc(Email.new(email: 'test3@example.com', name: 'Example User'))
+  personalization.add_cc(Email.new(email: 'test4@example.com', name: 'Example User'))
+  personalization.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User'))
+  personalization.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User'))
   personalization.subject = 'Hello World from the Personalized SendGrid Ruby Library'
-  personalization.headers = Header.new(key: 'X-Test', value: 'True')
-  personalization.headers = Header.new(key: 'X-Mock', value: 'False')
-  personalization.substitutions = Substitution.new(key: '%name%', value: 'Example User')
-  personalization.substitutions = Substitution.new(key: '%city%', value: 'Denver')
-  personalization.custom_args = CustomArg.new(key: 'user_id', value: '343')
-  personalization.custom_args = CustomArg.new(key: 'type', value: 'marketing')
+  personalization.add_header(Header.new(key: 'X-Test', value: 'True'))
+  personalization.add_header(Header.new(key: 'X-Mock', value: 'False'))
+  personalization.add_substitution(Substitution.new(key: '%name%', value: 'Example User'))
+  personalization.add_substitution(Substitution.new(key: '%city%', value: 'Denver'))
+  personalization.add_custom_arg(CustomArg.new(key: 'user_id', value: '343'))
+  personalization.add_custom_arg(CustomArg.new(key: 'type', value: 'marketing'))
   personalization.send_at = 1443636843
-  mail.personalizations = personalization
+  mail.add_personalization(personalization)
 
   personalization2 = Personalization.new
-  personalization2.to = Email.new(email: 'test1@example.com', name: 'Example User')
-  personalization2.to = Email.new(email: 'test2@example.com', name: 'Example User')
-  personalization2.cc = Email.new(email: 'test3@example.com', name: 'Example User')
-  personalization2.cc = Email.new(email: 'test4@example.com', name: 'Example User')
-  personalization2.bcc = Email.new(email: 'test5@example.com', name: 'Example User')
-  personalization2.bcc = Email.new(email: 'test6@example.com', name: 'Example User')
+  personalization2.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
+  personalization2.add_to(Email.new(email: 'test2@example.com', name: 'Example User'))
+  personalization2.add_cc(Email.new(email: 'test3@example.com', name: 'Example User'))
+  personalization2.add_cc(Email.new(email: 'test4@example.com', name: 'Example User'))
+  personalization2.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User'))
+  personalization2.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User'))
   personalization2.subject = 'Hello World from the Personalized SendGrid Ruby Library'
-  personalization2.headers = Header.new(key: 'X-Test', value: 'True')
-  personalization2.headers = Header.new(key: 'X-Mock', value: 'False')
-  personalization2.substitutions = Substitution.new(key: '%name%', value: 'Example User')
-  personalization2.substitutions = Substitution.new(key: '%city%', value: 'Denver')
-  personalization2.custom_args = CustomArg.new(key: 'user_id', value: '343')
-  personalization2.custom_args = CustomArg.new(key: 'type', value: 'marketing')
+  personalization2.add_header(Header.new(key: 'X-Test', value: 'True'))
+  personalization2.add_header(Header.new(key: 'X-Mock', value: 'False'))
+  personalization2.add_substitution(Substitution.new(key: '%name%', value: 'Example User'))
+  personalization2.add_substitution(Substitution.new(key: '%city%', value: 'Denver'))
+  personalization2.add_custom_arg(CustomArg.new(key: 'user_id', value: '343'))
+  personalization2.add_custom_arg(CustomArg.new(key: 'type', value: 'marketing'))
   personalization2.send_at = 1443636843
   mail.personalizations = personalization2
 
-  mail.contents = Content.new(type: 'text/plain', value: 'some text here')
-  mail.contents = Content.new(type: 'text/html', value: '<html><body>some text here</body></html>')
+  mail.add_content(Content.new(type: 'text/plain', value: 'some text here'))
+  mail.add_content(Content.new(type: 'text/html', value: '<html><body>some text here</body></html>'))
 
   attachment = Attachment.new
   attachment.content = 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3JhcyBwdW12'
@@ -66,7 +66,7 @@ def kitchen_sink
   attachment.disposition = 'attachment'
   attachment.content_id = 'Balance Sheet'
 
-  mail.attachments = attachment
+  mail.add_attachment(attachment)
 
   attachment2 = Attachment.new
   attachment2.content = 'BwdW'
@@ -74,21 +74,21 @@ def kitchen_sink
   attachment2.filename = 'banner.png'
   attachment2.disposition = 'inline'
   attachment2.content_id = 'Banner'
-  mail.attachments = attachment2
+  mail.add_attachment(attachment2)
 
   mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
 
-  mail.sections = Section.new(key: '%section1%', value: 'Substitution Text for Section 1')
-  mail.sections = Section.new(key: '%section2%', value: 'Substitution Text for Section 2')
+  mail.add_section(Section.new(key: '%section1%', value: 'Substitution Text for Section 1'))
+  mail.add_section(Section.new(key: '%section2%', value: 'Substitution Text for Section 2'))
 
-  mail.headers = Header.new(key: 'X-Test3', value: 'test3')
-  mail.headers = Header.new(key: 'X-Test4', value: 'test4')
+  mail.add_header(Header.new(key: 'X-Test3', value: 'test3'))
+  mail.add_header(Header.new(key: 'X-Test4', value: 'test4'))
 
-  mail.categories = Category.new(name: 'May')
-  mail.categories = Category.new(name: '2016')
+  mail.add_category(Category.new(name: 'May'))
+  mail.add_category(Category.new(name: '2016'))
 
-  mail.custom_args = CustomArg.new(key: 'campaign', value: 'welcome')
-  mail.custom_args = CustomArg.new(key: 'weekday', value: 'morning')
+  mail.add_custom_arg(CustomArg.new(key: 'campaign', value: 'welcome'))
+  mail.add_custom_arg(CustomArg.new(key: 'weekday', value: 'morning'))
 
   mail.send_at = 1443636842
 

data/lib/sendgrid-ruby.rb

@@ -1,4 +1,24 @@
 require_relative 'sendgrid/client'
 require_relative 'sendgrid/version'
+require_relative 'sendgrid/helpers/mail/asm'
+require_relative 'sendgrid/helpers/mail/attachment'
+require_relative 'sendgrid/helpers/mail/bcc_settings'
+require_relative 'sendgrid/helpers/mail/bypass_list_management'
+require_relative 'sendgrid/helpers/mail/category'
+require_relative 'sendgrid/helpers/mail/click_tracking'
+require_relative 'sendgrid/helpers/mail/content'
+require_relative 'sendgrid/helpers/mail/custom_arg'
+require_relative 'sendgrid/helpers/mail/email'
+require_relative 'sendgrid/helpers/mail/footer'
+require_relative 'sendgrid/helpers/mail/ganalytics'
+require_relative 'sendgrid/helpers/mail/header'
 require_relative 'sendgrid/helpers/mail/mail'
+require_relative 'sendgrid/helpers/mail/mail_settings'
+require_relative 'sendgrid/helpers/mail/open_tracking'
+require_relative 'sendgrid/helpers/mail/personalization'
+require_relative 'sendgrid/helpers/mail/section'
+require_relative 'sendgrid/helpers/mail/spam_check'
+require_relative 'sendgrid/helpers/mail/subscription_tracking'
+require_relative 'sendgrid/helpers/mail/substitution'
+require_relative 'sendgrid/helpers/mail/tracking_settings'
 require_relative 'sendgrid/helpers/settings/settings'

data/lib/sendgrid/helpers/mail/asm.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module SendGrid
+  class ASM
+    def initialize(group_id: nil, groups_to_display: nil)
+      @group_id = group_id
+      @groups_to_display = groups_to_display
+    end
+
+    def group_id=(group_id)
+      @group_id = group_id
+    end
+
+    def group_id
+      @group_id
+    end
+
+    def groups_to_display=(groups_to_display)
+      @groups_to_display = groups_to_display
+    end
+
+    def groups_to_display
+      @groups_to_display
+    end
+
+    def to_json(*)
+      {
+        'group_id' => self.group_id,
+        'groups_to_display' => self.groups_to_display
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/attachment.rb

@@ -0,0 +1,63 @@
+require 'json'
+
+module SendGrid
+  class Attachment
+    def initialize
+      @content = nil
+      @type = nil
+      @filename = nil
+      @disposition = nil
+      @content_id = nil
+    end
+
+    def content=(content)
+      @content = content
+    end
+
+    def content
+      @content
+    end
+
+    def type=(type)
+      @type = type
+    end
+
+    def type
+      @type
+    end
+
+    def filename=(filename)
+      @filename = filename
+    end
+
+    def filename
+      @filename
+    end
+
+    def disposition=(disposition)
+      @disposition = disposition
+    end
+
+    def disposition
+      @disposition
+    end
+
+    def content_id=(content_id)
+      @content_id = content_id
+    end
+
+    def content_id
+      @content_id
+    end
+
+    def to_json(*)
+      {
+        'content' => self.content,
+        'type' => self.type,
+        'filename' => self.filename,
+        'disposition' => self.disposition,
+        'content_id' => self.content_id
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/bcc_settings.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module SendGrid
+  class BccSettings
+    def initialize(enable: nil, email: nil)
+      @enable = enable
+      @email = email
+    end
+
+    def enable=(enable)
+      @enable = enable
+    end
+
+    def enable
+      @enable
+    end
+
+    def email=(email)
+      @email = email
+    end
+
+    def email
+      @email
+    end
+
+    def to_json(*)
+      {
+        'enable' => self.enable,
+        'email' => self.email
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/bypass_list_management.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module SendGrid
+  class BypassListManagement
+    def initialize(enable: nil)
+      @enable = enable
+    end
+
+    def enable=(enable)
+      @enable = enable
+    end
+
+    def enable
+      @enable
+    end
+
+    def to_json(*)
+      {
+        'enable' => self.enable
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+
+  class SandBoxMode
+    def initialize(enable: nil)
+      @enable = enable
+    end
+
+    def enable=(enable)
+      @enable = enable
+    end
+
+    def enable
+      @enable
+    end
+
+    def to_json(*)
+      {
+        'enable' => self.enable
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/category.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module SendGrid
+  class Category
+    attr_accessor :name
+
+    def initialize(name: nil)
+      @name = name
+    end
+
+    def name=(name)
+      @name = name
+    end
+
+    def name
+      @name
+    end
+
+    def to_json(*)
+      {
+        'category' => name
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+
+    alias :category :name
+    alias :category= :name=
+  end
+end

data/lib/sendgrid/helpers/mail/click_tracking.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module SendGrid
+  class ClickTracking
+    def initialize(enable: nil, enable_text: nil)
+      @enable = enable
+      @enable_text = enable_text
+    end
+
+    def enable=(enable)
+      @enable = enable
+    end
+
+    def enable
+      @enable
+    end
+
+    def enable_text=(enable_text)
+      @enable_text = enable_text
+    end
+
+    def enable_text
+      @enable_text
+    end
+
+    def to_json(*)
+      {
+        'enable' => self.enable,
+        'enable_text' => self.enable_text
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end