RubyGems - sendgrid-ruby - Versions diffs - 4.0.8 → 6.0.0 - Mend

sendgrid-ruby 4.0.8 → 6.0.0

Files changed (95) hide show

checksums.yaml +4 -4
data/.codeclimate.yml +21 -0
data/.env_sample +1 -0
data/.github/PULL_REQUEST_TEMPLATE +26 -0
data/.gitignore +1 -0
data/.travis.yml +11 -2
data/CHANGELOG.md +119 -3
data/CODE_OF_CONDUCT.md +41 -0
data/CONTRIBUTING.md +34 -30
data/Gemfile +4 -1
data/LICENSE.txt +1 -1
data/README.md +53 -24
data/Rakefile +7 -2
data/TROUBLESHOOTING.md +41 -15
data/UPGRADE.md +5 -0
data/USAGE.md +1130 -1129
data/USE_CASES.md +280 -16
data/config.ru +4 -0
data/docker/Dockerfile +12 -0
data/docker/README.md +30 -0
data/examples/helpers/mail/example.rb +62 -45
data/examples/helpers/settings/example.rb +23 -0
data/examples/helpers/stats/example.rb +42 -0
data/examples/ips/ips.rb +13 -0
data/examples/mail/mail.rb +2 -2
data/examples/scopes/scopes.rb +49 -3
data/examples/{whitelabel/whitelabel.rb → senderauthentication/senderauthentication.rb} +27 -27
data/examples/suppression/suppression.rb +10 -10
data/gemfiles/Sinatra_1.gemfile +6 -0
data/gemfiles/Sinatra_2.gemfile +6 -0
data/lib/sendgrid-ruby.rb +27 -1
data/lib/sendgrid/client.rb +12 -9
data/lib/sendgrid/helpers/inbound/README.md +98 -0
data/lib/sendgrid/helpers/inbound/app.rb +32 -0
data/lib/sendgrid/helpers/inbound/config.yml +26 -0
data/lib/sendgrid/helpers/inbound/public/index.html +10 -0
data/lib/sendgrid/helpers/inbound/sample_data/default_data.txt +58 -0
data/lib/sendgrid/helpers/inbound/sample_data/raw_data.txt +57 -0
data/lib/sendgrid/helpers/inbound/sample_data/raw_data_with_attachments.txt +298 -0
data/lib/sendgrid/helpers/inbound/send.rb +26 -0
data/lib/sendgrid/helpers/ip_management/ip_management.rb +17 -0
data/lib/sendgrid/helpers/mail/README.md +1 -1
data/lib/sendgrid/helpers/mail/asm.rb +33 -0
data/lib/sendgrid/helpers/mail/attachment.rb +86 -0
data/lib/sendgrid/helpers/mail/bcc_settings.rb +33 -0
data/lib/sendgrid/helpers/mail/bypass_list_management.rb +43 -0
data/lib/sendgrid/helpers/mail/category.rb +20 -0
data/lib/sendgrid/helpers/mail/click_tracking.rb +33 -0
data/lib/sendgrid/helpers/mail/content.rb +20 -0
data/lib/sendgrid/helpers/mail/custom_arg.rb +24 -0
data/lib/sendgrid/helpers/mail/email.rb +29 -0
data/lib/sendgrid/helpers/mail/footer.rb +43 -0
data/lib/sendgrid/helpers/mail/ganalytics.rb +74 -0
data/lib/sendgrid/helpers/mail/header.rb +24 -0
data/lib/sendgrid/helpers/mail/mail.rb +36 -895
data/lib/sendgrid/helpers/mail/mail_settings.rb +63 -0
data/lib/sendgrid/helpers/mail/open_tracking.rb +33 -0
data/lib/sendgrid/helpers/mail/personalization.rb +82 -0
data/lib/sendgrid/helpers/mail/section.rb +24 -0
data/lib/sendgrid/helpers/mail/spam_check.rb +43 -0
data/lib/sendgrid/helpers/mail/subscription_tracking.rb +53 -0
data/lib/sendgrid/helpers/mail/substitution.rb +24 -0
data/lib/sendgrid/helpers/mail/tracking_settings.rb +53 -0
data/lib/sendgrid/helpers/permissions/scope.rb +28 -0
data/lib/sendgrid/helpers/permissions/scopes.yml +309 -0
data/lib/sendgrid/helpers/settings/README.md +14 -0
data/lib/sendgrid/helpers/settings/mail_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/settings/partner_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/settings/settings.rb +28 -0
data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb +24 -0
data/lib/sendgrid/helpers/settings/user_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/stats/email_stats.rb +46 -0
data/lib/sendgrid/helpers/stats/metrics.rb +35 -0
data/lib/sendgrid/helpers/stats/stats_response.rb +31 -0
data/lib/sendgrid/version.rb +2 -2
data/mail_helper_v3.md +390 -0
data/sendgrid-ruby.gemspec +12 -5
data/spec/sendgrid/helpers/ip_management/ip_management_spec.rb +12 -0
data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb +32 -0
data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb +24 -0
data/spec/sendgrid/helpers/settings/settings_spec.rb +25 -0
data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb +27 -0
data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb +24 -0
data/spec/sendgrid/helpers/stats/email_stats_spec.rb +112 -0
data/spec/sendgrid/helpers/stats/metrics_spec.rb +46 -0
data/spec/sendgrid/helpers/stats/stats_response_spec.rb +76 -0
data/spec/spec_helper.rb +10 -0
data/test/sendgrid/helpers/mail/test_attachment.rb +35 -0
data/test/sendgrid/helpers/mail/test_category.rb +27 -0
data/test/sendgrid/helpers/mail/test_email.rb +34 -0
data/test/sendgrid/helpers/mail/test_mail.rb +198 -59
data/test/sendgrid/helpers/mail/test_personalizations.rb +161 -0
data/test/sendgrid/permissions/test_scopes.rb +38 -0
data/test/sendgrid/test_sendgrid-ruby.rb +90 -9
metadata +170 -10

data/test/sendgrid/helpers/mail/test_category.rb ADDED

@@ -0,0 +1,27 @@
+require_relative '../../../../lib/sendgrid/helpers/mail/mail'
+require 'minitest/autorun'
+class TestCategory < Minitest::Test
+  include SendGrid
+  def setup
+    @category = Category.new(name: 'foo')
+  end
+  def test_aliases
+    assert_equal @category.method(:name), @category.method(:category)
+  end
+  def test_name
+    assert_equal @category.name, 'foo'
+  end
+  def test_to_json
+    expected_json = {
+      'category' => 'foo'
+    }
+    assert_equal @category.to_json, expected_json
+  end
+end

data/test/sendgrid/helpers/mail/test_email.rb ADDED

@@ -0,0 +1,34 @@
+require_relative '../../../../lib/sendgrid/helpers/mail/email'
+require 'minitest/autorun'
+class TestEmail < Minitest::Test
+  include SendGrid
+  def test_split_email_full_email
+    @email = Email.new(email: "Example User <test1@example.com>")
+    expected_json = {
+        "email"=>"test1@example.com",
+        "name"=>"Example User"
+    }
+    assert_equal @email.to_json, expected_json
+  end
+  def test_split_email_only_email
+    @email = Email.new(email: "test1@example.com")
+    expected_json = {
+        "email"=>"test1@example.com",
+    }
+    assert_equal @email.to_json, expected_json
+  end
+  def test_split_email_name_and_email
+    @email = Email.new(name: "Example User", email: "test1@example.com")
+    expected_json = {
+        "email"=>"test1@example.com",
+        "name"=>"Example User"
+    }
+    assert_equal @email.to_json, expected_json
+  end
+end

data/test/sendgrid/helpers/mail/test_mail.rb CHANGED

@@ -9,88 +9,86 @@ class TestMail < Minitest::Test
   end
   def test_hello_world
-    mail = Mail.new()
-    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: "test@example.com")
-    mail.personalizations = personalization
-    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>")
-    assert_equal(mail.to_json, JSON.parse('{"content":[{"type":"text/plain","value":"some text here"},{"type":"text/html","value":"<html><body>some text here</body></html>"}],"from":{"email":"test@example.com"},"personalizations":[{"to":[{"email":"test@example.com"}]}],"subject":"Hello World from the SendGrid Ruby Library"}'))
+    from = Email.new(email: 'test@example.com')
+    to = Email.new(email: 'test@example.com')
+    subject = 'Sending with Twilio SendGrid is Fun'
+    content = Content.new(type: 'text/plain', value: 'and easy to do anywhere, even with Ruby')
+    mail = SendGrid::Mail.new(from, subject, to, content)
+    assert_equal(mail.to_json, JSON.parse('{"from":{"email":"test@example.com"}, "subject":"Sending with Twilio SendGrid is Fun", "personalizations":[{"to":[{"email":"test@example.com"}]}], "content":[{"type":"text/plain", "value":"and easy to do anywhere, even with Ruby"}]}'))
   end
   def test_kitchen_sink
-    mail = Mail.new()
+    mail = SendGrid::Mail.new
     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: "test@example.com", name: "Example User")
-    personalization.to = Email.new(email: "test@example.com", name: "Example User")
-    personalization.cc = Email.new(email: "test@example.com", name: "Example User")
-    personalization.cc = Email.new(email: "test@example.com", name: "Example User")
-    personalization.bcc = Email.new(email: "test@example.com", name: "Example User")
-    personalization.bcc = Email.new(email: "test@example.com", name: "Example User")
-    personalization.subject = "Hello World from the Personalized SendGrid Python 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")
+    mail.subject = "Hello World from the Twilio SendGrid Ruby Library"
+    personalization = Personalization.new
+    personalization.add_to(Email.new(email: "test@example.com", name: "Example User"))
+    personalization.add_to(Email.new(email: "test@example.com", name: "Example User"))
+    personalization.add_cc(Email.new(email: "test@example.com", name: "Example User"))
+    personalization.add_cc(Email.new(email: "test@example.com", name: "Example User"))
+    personalization.add_bcc(Email.new(email: "test@example.com", name: "Example User"))
+    personalization.add_bcc(Email.new(email: "test@example.com", name: "Example User"))
+    personalization.subject = "Hello World from the Personalized Twilio SendGrid Ruby Library"
+    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
-    personalization2 = Personalization.new()
-    personalization2.to = Email.new(email: "test@example.com", name: "Example User")
-    personalization2.to = Email.new(email: "test@example.com", name: "Example User")
-    personalization2.cc = Email.new(email: "test@example.com", name: "Example User")
-    personalization2.cc = Email.new(email: "test@example.com", name: "Example User")
-    personalization2.bcc = Email.new(email: "test@example.com", name: "Example User")
-    personalization2.bcc = Email.new(email: "test@example.com", name: "Example User")
-    personalization2.subject = "Hello World from the Personalized SendGrid Python 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")
+    mail.add_personalization(personalization)
+    personalization2 = Personalization.new
+    personalization2.add_to(Email.new(email: "test@example.com", name: "Example User"))
+    personalization2.add_to(Email.new(email: "test@example.com", name: "Example User"))
+    personalization2.add_cc(Email.new(email: "test@example.com", name: "Example User"))
+    personalization2.add_cc(Email.new(email: "test@example.com", name: "Example User"))
+    personalization2.add_bcc(Email.new(email: "test@example.com", name: "Example User"))
+    personalization2.add_bcc(Email.new(email: "test@example.com", name: "Example User"))
+    personalization2.subject = "Hello World from the Personalized Twilio SendGrid Ruby Library"
+    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.add_personalization(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 = Attachment.new
     attachment.content = "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3JhcyBwdW12"
     attachment.type = "application/pdf"
     attachment.filename = "balance_001.pdf"
     attachment.disposition = "attachment"
     attachment.content_id = "Balance Sheet"
-    mail.attachments = attachment
+    mail.add_attachment(attachment)
-    attachment2 = Attachment.new()
+    attachment2 = Attachment.new
     attachment2.content = "BwdW"
     attachment2.type = "image/png"
     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
@@ -100,7 +98,7 @@ class TestMail < Minitest::Test
     mail.ip_pool_name = "23"
-    mail_settings = MailSettings.new()
+    mail_settings = MailSettings.new
     mail_settings.bcc = BccSettings.new(enable: true, email: "test@example.com")
     mail_settings.bypass_list_management = BypassListManagement.new(enable: true)
     mail_settings.footer = Footer.new(enable: true, text: "Footer Text", html: "<html><body>Footer Text</body></html>")
@@ -108,7 +106,7 @@ class TestMail < Minitest::Test
     mail_settings.spam_check = SpamCheck.new(enable: true, threshold: 1, post_to_url: "https://spamcatcher.sendgrid.com")
     mail.mail_settings = mail_settings
-    tracking_settings = TrackingSettings.new()
+    tracking_settings = TrackingSettings.new
     tracking_settings.click_tracking = ClickTracking.new(enable: false, enable_text: false)
     tracking_settings.open_tracking = OpenTracking.new(enable: true, substitution_tag: "Optional tag to replace with the open image in the body of the message")
     tracking_settings.subscription_tracking = SubscriptionTracking.new(enable: true, text: "text to insert into the text/plain portion of the message", html: "html to insert into the text/html portion of the message", substitution_tag: "Optional tag to replace with the open image in the body of the message")
@@ -117,6 +115,147 @@ class TestMail < Minitest::Test
     mail.reply_to = Email.new(email: "test@example.com")
-    assert_equal(mail.to_json, JSON.parse('{"asm":{"group_id":99,"groups_to_display":[4,5,6,7,8]},"attachments":[{"content":"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3JhcyBwdW12","content_id":"Balance Sheet","disposition":"attachment","filename":"balance_001.pdf","type":"application/pdf"},{"content":"BwdW","content_id":"Banner","disposition":"inline","filename":"banner.png","type":"image/png"}],"batch_id":"sendgrid_batch_id","categories":["May","2016"],"content":[{"type":"text/plain","value":"some text here"},{"type":"text/html","value":"<html><body>some text here</body></html>"}],"custom_args":{"campaign":"welcome","weekday":"morning"},"from":{"email":"test@example.com"},"headers":{"X-Test3":"test3","X-Test4":"test4"},"ip_pool_name":"23","mail_settings":{"bcc":{"email":"test@example.com","enable":true},"bypass_list_management":{"enable":true},"footer":{"enable":true,"html":"<html><body>Footer Text</body></html>","text":"Footer Text"},"sandbox_mode":{"enable":true},"spam_check":{"enable":true,"post_to_url":"https://spamcatcher.sendgrid.com","threshold":1}},"personalizations":[{"bcc":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}],"cc":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}],"custom_args":{"type":"marketing","user_id":"343"},"headers":{"X-Mock":"False","X-Test":"True"},"send_at":1443636843,"subject":"Hello World from the Personalized SendGrid Python Library","substitutions":{"%city%":"Denver","%name%":"Example User"},"to":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}]},{"bcc":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}],"cc":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}],"custom_args":{"type":"marketing","user_id":"343"},"headers":{"X-Mock":"False","X-Test":"True"},"send_at":1443636843,"subject":"Hello World from the Personalized SendGrid Python Library","substitutions":{"%city%":"Denver","%name%":"Example User"},"to":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}]}],"reply_to":{"email":"test@example.com"},"sections":{"%section1%":"Substitution Text for Section 1","%section2%":"Substitution Text for Section 2"},"send_at":1443636842,"subject":"Hello World from the SendGrid Ruby Library","template_id":"13b8f94f-bcae-4ec6-b752-70d6cb59f932","tracking_settings":{"click_tracking":{"enable":false,"enable_text":false},"ganalytics":{"enable":true,"utm_campaign":"some campaign","utm_content":"some content","utm_medium":"some medium","utm_source":"some source","utm_term":"some term"},"open_tracking":{"enable":true,"substitution_tag":"Optional tag to replace with the open image in the body of the message"},"subscription_tracking":{"enable":true,"html":"html to insert into the text/html portion of the message","substitution_tag":"Optional tag to replace with the open image in the body of the message","text":"text to insert into the text/plain portion of the message"}}}'))
+    assert_equal(mail.to_json, JSON.parse('{"asm":{"group_id":99,"groups_to_display":[4,5,6,7,8]},"attachments":[{"content":"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3JhcyBwdW12","content_id":"Balance Sheet","disposition":"attachment","filename":"balance_001.pdf","type":"application/pdf"},{"content":"BwdW","content_id":"Banner","disposition":"inline","filename":"banner.png","type":"image/png"}],"batch_id":"sendgrid_batch_id","categories":["May","2016"],"content":[{"type":"text/plain","value":"some text here"},{"type":"text/html","value":"<html><body>some text here</body></html>"}],"custom_args":{"campaign":"welcome","weekday":"morning"},"from":{"email":"test@example.com"},"headers":{"X-Test3":"test3","X-Test4":"test4"},"ip_pool_name":"23","mail_settings":{"bcc":{"email":"test@example.com","enable":true},"bypass_list_management":{"enable":true},"footer":{"enable":true,"html":"<html><body>Footer Text</body></html>","text":"Footer Text"},"sandbox_mode":{"enable":true},"spam_check":{"enable":true,"post_to_url":"https://spamcatcher.sendgrid.com","threshold":1}},"personalizations":[{"bcc":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}],"cc":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}],"custom_args":{"type":"marketing","user_id":"343"},"headers":{"X-Mock":"False","X-Test":"True"},"send_at":1443636843,"subject":"Hello World from the Personalized Twilio SendGrid Ruby Library","substitutions":{"%city%":"Denver","%name%":"Example User"},"to":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}]},{"bcc":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}],"cc":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}],"custom_args":{"type":"marketing","user_id":"343"},"headers":{"X-Mock":"False","X-Test":"True"},"send_at":1443636843,"subject":"Hello World from the Personalized Twilio SendGrid Ruby Library","substitutions":{"%city%":"Denver","%name%":"Example User"},"to":[{"email":"test@example.com","name":"Example User"},{"email":"test@example.com","name":"Example User"}]}],"reply_to":{"email":"test@example.com"},"sections":{"%section1%":"Substitution Text for Section 1","%section2%":"Substitution Text for Section 2"},"send_at":1443636842,"subject":"Hello World from the Twilio SendGrid Ruby Library","template_id":"13b8f94f-bcae-4ec6-b752-70d6cb59f932","tracking_settings":{"click_tracking":{"enable":false,"enable_text":false},"ganalytics":{"enable":true,"utm_campaign":"some campaign","utm_content":"some content","utm_medium":"some medium","utm_source":"some source","utm_term":"some term"},"open_tracking":{"enable":true,"substitution_tag":"Optional tag to replace with the open image in the body of the message"},"subscription_tracking":{"enable":true,"html":"html to insert into the text/html portion of the message","substitution_tag":"Optional tag to replace with the open image in the body of the message","text":"text to insert into the text/plain portion of the message"}}}'))
+  end
+  def test_that_personalizations_is_empty_initially
+    mail = SendGrid::Mail.new
+    assert_equal([], mail.personalizations)
+  end
+  def test_that_contents_is_empty_initially
+    mail = SendGrid::Mail.new
+    assert_equal([], mail.contents)
+  end
+  def test_that_attachments_is_empty_initially
+    mail = SendGrid::Mail.new
+    assert_equal([], mail.attachments)
+  end
+  def test_that_categories_is_empty_initially
+    mail = SendGrid::Mail.new
+    assert_equal([], mail.categories)
+  end
+  def test_add_personalization
+    mail = SendGrid::Mail.new
+    mail.add_personalization('foo')
+    assert_equal(['foo'.to_json], mail.personalizations)
+  end
+  def test_add_content
+    mail = SendGrid::Mail.new
+    mail.add_content('foo')
+    assert_equal(['foo'.to_json], mail.contents)
+  end
+  def test_add_section
+    mail = SendGrid::Mail.new
+    mail.add_section(Section.new(key: '%section1%', value: 'Substitution Text for Section 1'))
+    expected_json = {
+        "sections"=>{
+                "%section1%"=>"Substitution Text for Section 1"
+            }
+    }
+    assert_equal mail.to_json, expected_json
+    mail.add_section(Section.new(key: '%section2%', value: 'Substitution Text for Section 2'))
+    expected_json = {
+        "sections"=>{
+                "%section1%"=>"Substitution Text for Section 1",
+                "%section2%"=>"Substitution Text for Section 2"
+            }
+    }
+    assert_equal mail.to_json, expected_json
+  end
+  def test_add_header
+    mail = SendGrid::Mail.new
+    mail.add_header(Header.new(key: 'X-Test3', value: 'test3'))
+    expected_json = {
+        "headers"=>{
+                "X-Test3"=>"test3"
+            }
+    }
+    assert_equal mail.to_json, expected_json
+    mail.add_header(Header.new(key: 'X-Test4', value: 'test4'))
+    expected_json = {
+        "headers"=>{
+                "X-Test3"=>"test3",
+                "X-Test4"=>"test4"
+            }
+    }
+    assert_equal mail.to_json, expected_json
+  end
+  def test_add_custom_arg
+    mail = SendGrid::Mail.new
+    mail.add_custom_arg(CustomArg.new(key: 'campaign 1', value: 'welcome 1'))
+    expected_json = {
+        "custom_args"=>{
+                "campaign 1"=>"welcome 1"
+            }
+    }
+    assert_equal mail.to_json, expected_json
+    mail.add_custom_arg(CustomArg.new(key: 'campaign 2', value: 'welcome 2'))
+    expected_json = {
+        "custom_args"=>{
+                "campaign 1"=>"welcome 1",
+                "campaign 2"=>"welcome 2"
+            }
+    }
+    assert_equal mail.to_json, expected_json
+  end
+  def test_add_non_string_custom_arg
+    mail = Mail.new
+    mail.add_custom_arg(CustomArg.new(key: "Integer", value: 1))
+    mail.add_custom_arg(CustomArg.new(key: "Array", value: [1, "a", true]))
+    mail.add_custom_arg(CustomArg.new(key: "Hash", value: {"a" => 1, "b" => 2}))
+    expected_json = {
+        "custom_args"=>{
+                "Integer"=>"1",
+                "Array"=>"[1, \"a\", true]",
+                "Hash"=>"{\"a\"=>1, \"b\"=>2}",
+            }
+    }
+    assert_equal mail.to_json, expected_json
+  end
+  def test_add_attachment
+    mail = SendGrid::Mail.new
+    mail.add_attachment('foo')
+    assert_equal(['foo'.to_json], mail.attachments)
+  end
+  def test_add_valid_category
+    mail = SendGrid::Mail.new
+    category = Category.new(name: 'foo')
+    mail.add_category(category)
+    assert_equal(['foo'], mail.categories)
+  end
+  def test_add_more_than_1_valid_category
+    mail = SendGrid::Mail.new
+    category_1 = Category.new(name: 'foo')
+    category_2 = Category.new(name: 'bar')
+    mail.add_category(category_1)
+    mail.add_category(category_2)
+    assert_equal(['foo', 'bar'], mail.categories)
+  end
+  def test_add_invalid_category
+    mail = SendGrid::Mail.new
+    assert_raises(NoMethodError) do
+      mail.add_category('foo')
+    end
+  end
+  def test_check_for_secrets
+    mail = Mail.new
+    mail.add_content(Content.new(type: 'text/plain', value: 'Sensitive information: SG.a123b456'))
+    assert_raises(SecurityError) do
+      mail.check_for_secrets([/SG.[a-zA-Z0-9_-]*/])
+    end
   end
 end

data/test/sendgrid/helpers/mail/test_personalizations.rb ADDED

@@ -0,0 +1,161 @@
+require_relative '../../../../lib/sendgrid/helpers/mail/personalization'
+require 'minitest/autorun'
+class TestPersonalization < Minitest::Test
+  include SendGrid
+  def test_add_to
+    @personalization = Personalization.new()
+    @personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
+    expected_json = {
+        "to"=>[
+            {
+                "email"=>"test1@example.com",
+                "name"=>"Example User"
+            }
+        ]
+    }
+    @personalization.add_to(Email.new(email: 'test2@example.com', name: 'Example User 2'))
+    expected_json = {
+        "to"=>[
+            {
+                "email"=>"test1@example.com",
+                "name"=>"Example User"
+            },
+            {
+                "email"=>"test2@example.com",
+                "name"=>"Example User 2"
+            }
+        ]
+    }
+    assert_equal @personalization.to_json, expected_json
+  end
+  def test_add_cc
+    @personalization = Personalization.new()
+    @personalization.add_cc(Email.new(email: 'test1@example.com', name: 'Example User'))
+    expected_json = {
+        "cc"=>[
+            {
+                "email"=>"test1@example.com",
+                "name"=>"Example User"
+            }
+        ]
+    }
+    @personalization.add_cc(Email.new(email: 'test2@example.com', name: 'Example User 2'))
+    expected_json = {
+        "cc"=>[
+            {
+                "email"=>"test1@example.com",
+                "name"=>"Example User"
+            },
+            {
+                "email"=>"test2@example.com",
+                "name"=>"Example User 2"
+            }
+        ]
+    }
+    assert_equal @personalization.to_json, expected_json
+  end
+  def test_add_bcc
+    @personalization = Personalization.new()
+    @personalization.add_bcc(Email.new(email: 'test1@example.com', name: 'Example User'))
+    expected_json = {
+        "bcc"=>[
+            {
+                "email"=>"test1@example.com",
+                "name"=>"Example User"
+            }
+        ]
+    }
+    @personalization.add_bcc(Email.new(email: 'test2@example.com', name: 'Example User 2'))
+    expected_json = {
+        "bcc"=>[
+            {
+                "email"=>"test1@example.com",
+                "name"=>"Example User"
+            },
+            {
+                "email"=>"test2@example.com",
+                "name"=>"Example User 2"
+            }
+        ]
+    }
+    assert_equal @personalization.to_json, expected_json
+  end
+  def test_add_header
+    @personalization = Personalization.new()
+    @personalization.add_header(Header.new(key: 'X-Test', value: 'True'))
+    expected_json = {
+        "headers"=>{
+                "X-Test"=>"True"
+            }
+    }
+    assert_equal @personalization.to_json, expected_json
+    @personalization.add_header(Header.new(key: 'X-Test 1', value: 'False'))
+    expected_json = {
+        "headers"=>{
+                "X-Test"=>"True",
+                "X-Test 1"=>"False"
+            }
+    }
+    assert_equal @personalization.to_json, expected_json
+  end
+  def test_add_substitution
+    @personalization = Personalization.new()
+    @personalization.add_substitution(Substitution.new(key: '%name%', value: 'Example User'))
+    expected_json = {
+        "substitutions"=>{
+                "%name%"=>"Example User"
+            }
+    }
+    assert_equal @personalization.to_json, expected_json
+    @personalization.add_substitution(Substitution.new(key: '%name 1%', value: 'Example User 1'))
+    expected_json = {
+        "substitutions"=>{
+                "%name%"=>"Example User",
+                "%name 1%"=>"Example User 1"
+            }
+    }
+    assert_equal @personalization.to_json, expected_json
+  end
+  def test_add_custom_arg
+    @personalization = Personalization.new()
+    @personalization.add_custom_arg(CustomArg.new(key: 'user_id', value: '343'))
+    expected_json = {
+        "custom_args"=>{
+                "user_id"=>"343"
+            }
+    }
+    assert_equal @personalization.to_json, expected_json
+    @personalization.add_custom_arg(CustomArg.new(key: 'city', value: 'denver'))
+    expected_json = {
+        "custom_args"=>{
+                "user_id"=>"343",
+                "city"=>"denver"
+            }
+    }
+    assert_equal @personalization.to_json, expected_json
+  end
+  def test_add_dynamic_template_data
+    @personalization = Personalization.new()
+    @personalization.add_dynamic_template_data({
+        "name"=>"Example User",
+        "city"=> "Denver"
+    })
+    expected_json = {
+        "dynamic_template_data"=>{
+                "name"=>"Example User",
+                "city"=>"Denver"
+            }
+    }
+    assert_equal @personalization.to_json, expected_json
+  end
+end