RubyGems - sendgrid-ruby - Versions diffs - 1.1.6 → 6.6.2 - Mend

sendgrid-ruby 1.1.6 → 6.6.2

Files changed (160) hide show

checksums.yaml +5 -5
data/.env_sample +1 -3
data/.github/ISSUE_TEMPLATE/config.yml +10 -0
data/.github/workflows/test-and-deploy.yml +120 -0
data/.gitignore +3 -0
data/.rubocop.yml +5 -27
data/.rubocop_todo.yml +127 -0
data/CHANGELOG.md +417 -1
data/CODE_OF_CONDUCT.md +73 -0
data/CONTRIBUTING.md +202 -0
data/Dockerfile +14 -0
data/FIRST_TIMERS.md +79 -0
data/Gemfile +4 -4
data/ISSUE_TEMPLATE.md +30 -0
data/LICENSE +21 -0
data/Makefile +14 -0
data/PULL_REQUEST_TEMPLATE.md +31 -0
data/README.md +153 -229
data/Rakefile +9 -3
data/TROUBLESHOOTING.md +151 -0
data/UPGRADE.md +5 -0
data/USAGE.md +5144 -0
data/config.ru +4 -0
data/examples/accesssettings/accesssettings.rb +80 -0
data/examples/alerts/alerts.rb +59 -0
data/examples/apikeys/apikeys.rb +81 -0
data/examples/asm/asm.rb +170 -0
data/examples/browsers/browsers.rb +13 -0
data/examples/campaigns/campaigns.rb +150 -0
data/examples/categories/categories.rb +33 -0
data/examples/clients/clients.rb +24 -0
data/examples/contactdb/contactdb.rb +392 -0
data/examples/devices/devices.rb +13 -0
data/examples/emailactivity/emailactivity.rb +52 -0
data/examples/geo/geo.rb +13 -0
data/examples/helpers/eventwebhook/example.rb +16 -0
data/examples/helpers/mail/example.rb +158 -0
data/examples/helpers/settings/example.rb +23 -0
data/examples/helpers/stats/example.rb +42 -0
data/examples/ips/ips.rb +164 -0
data/examples/mail/mail.rb +170 -0
data/examples/mailboxproviders/mailboxproviders.rb +13 -0
data/examples/mailsettings/mailsettings.rb +216 -0
data/examples/partnersettings/partnersettings.rb +36 -0
data/examples/scopes/scopes.rb +59 -0
data/examples/senderauthentication/senderauthentication.rb +307 -0
data/examples/senders/senders.rb +95 -0
data/examples/stats/stats.rb +13 -0
data/examples/subusers/subusers.rb +166 -0
data/examples/suppression/suppression.rb +198 -0
data/examples/templates/templates.rb +127 -0
data/examples/trackingsettings/trackingsettings.rb +107 -0
data/examples/user/user.rb +290 -0
data/gemfiles/Sinatra_1.gemfile +6 -0
data/gemfiles/Sinatra_2.gemfile +6 -0
data/lib/rack/sendgrid_webhook_verification.rb +55 -0
data/lib/sendgrid/base_interface.rb +40 -0
data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb +50 -0
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 +14 -0
data/lib/sendgrid/helpers/mail/asm.rb +19 -0
data/lib/sendgrid/helpers/mail/attachment.rb +55 -0
data/lib/sendgrid/helpers/mail/bcc_settings.rb +19 -0
data/lib/sendgrid/helpers/mail/bypass_list_management.rb +31 -0
data/lib/sendgrid/helpers/mail/category.rb +18 -0
data/lib/sendgrid/helpers/mail/click_tracking.rb +19 -0
data/lib/sendgrid/helpers/mail/content.rb +19 -0
data/lib/sendgrid/helpers/mail/custom_arg.rb +18 -0
data/lib/sendgrid/helpers/mail/email.rb +32 -0
data/lib/sendgrid/helpers/mail/footer.rb +21 -0
data/lib/sendgrid/helpers/mail/ganalytics.rb +28 -0
data/lib/sendgrid/helpers/mail/header.rb +18 -0
data/lib/sendgrid/helpers/mail/mail.rb +122 -0
data/lib/sendgrid/helpers/mail/mail_settings.rb +45 -0
data/lib/sendgrid/helpers/mail/open_tracking.rb +19 -0
data/lib/sendgrid/helpers/mail/personalization.rb +93 -0
data/lib/sendgrid/helpers/mail/section.rb +18 -0
data/lib/sendgrid/helpers/mail/spam_check.rb +21 -0
data/lib/sendgrid/helpers/mail/subscription_tracking.rb +23 -0
data/lib/sendgrid/helpers/mail/substitution.rb +18 -0
data/lib/sendgrid/helpers/mail/tracking_settings.rb +39 -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 +22 -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 +33 -0
data/lib/sendgrid/helpers/stats/stats_response.rb +29 -0
data/lib/sendgrid/sendgrid.rb +21 -0
data/lib/sendgrid/twilio_email.rb +21 -0
data/lib/sendgrid/version.rb +1 -1
data/lib/sendgrid-ruby.rb +32 -7
data/mail_helper_v3.md +390 -0
data/sendgrid-ruby.gemspec +16 -20
data/spec/fixtures/event_webhook.rb +22 -0
data/spec/rack/sendgrid_webhook_verification_spec.rb +142 -0
data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb +105 -0
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 +111 -0
data/spec/sendgrid/helpers/stats/metrics_spec.rb +45 -0
data/spec/sendgrid/helpers/stats/stats_response_spec.rb +75 -0
data/spec/sendgrid/sendgrid_spec.rb +11 -0
data/spec/sendgrid/twilio_email_spec.rb +11 -0
data/spec/spec_helper.rb +12 -1
data/static/img/github-fork.png +0 -0
data/static/img/github-sign-up.png +0 -0
data/test/sendgrid/helpers/mail/test_attachment.rb +33 -0
data/test/sendgrid/helpers/mail/test_category.rb +25 -0
data/test/sendgrid/helpers/mail/test_email.rb +41 -0
data/test/sendgrid/helpers/mail/test_mail.rb +260 -0
data/test/sendgrid/helpers/mail/test_personalizations.rb +214 -0
data/test/sendgrid/permissions/test_scopes.rb +36 -0
data/test/sendgrid/test_sendgrid-ruby.rb +2729 -0
data/twilio_sendgrid_logo.png +0 -0
data/use-cases/README.md +17 -0
data/use-cases/domain-authentication.md +5 -0
data/use-cases/email-statistics.md +52 -0
data/use-cases/legacy-templates.md +98 -0
data/use-cases/personalizations.md +34 -0
data/use-cases/sms.md +39 -0
data/use-cases/transactional-templates.md +111 -0
data/use-cases/twilio-email.md +13 -0
data/use-cases/twilio-setup.md +54 -0
metadata +187 -112
data/.rspec +0 -2
data/.travis.yml +0 -20
data/FETCH_HEAD +0 -0
data/Guardfile +0 -10
data/LICENSE.txt +0 -22
data/example.rb +0 -41
data/lib/sendgrid/client.rb +0 -62
data/lib/sendgrid/exceptions.rb +0 -7
data/lib/sendgrid/mail.rb +0 -182
data/lib/sendgrid/recipient.rb +0 -29
data/lib/sendgrid/response.rb +0 -14
data/lib/sendgrid/template.rb +0 -26
data/lib/sendgrid/template_mailer.rb +0 -59
data/spec/lib/sendgrid/client_spec.rb +0 -87
data/spec/lib/sendgrid/mail_spec.rb +0 -151
data/spec/lib/sendgrid/recipient_spec.rb +0 -91
data/spec/lib/sendgrid/template_mailer_spec.rb +0 -86
data/spec/lib/sendgrid/template_spec.rb +0 -61
data/spec/lib/sendgrid_spec.rb +0 -7

data/test/sendgrid/helpers/mail/test_mail.rb ADDED Viewed

@@ -0,0 +1,260 @@
+require_relative '../../../../lib/sendgrid/helpers/mail/mail'
+require_relative '../../../../lib/sendgrid/sendgrid'
+include SendGrid
+require 'json'
+require 'minitest/autorun'
+class TestMail < Minitest::Test
+  def setup; end
+  def test_hello_world
+    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 = SendGrid::Mail.new
+    mail.from = Email.new(email: 'test@example.com')
+    mail.subject = 'Hello World from the Twilio SendGrid Ruby Library'
+    personalization = Personalization.new
+    personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User 1'))
+    personalization.add_to(Email.new(email: 'test2@example.com', name: 'Example User 2'))
+    personalization.add_cc(Email.new(email: 'test3@example.com', name: 'Example User 3'))
+    personalization.add_cc(Email.new(email: 'test4@example.com', name: 'Example User 4'))
+    personalization.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User 5'))
+    personalization.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User 6'))
+    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 = 1_443_636_843
+    mail.add_personalization(personalization)
+    personalization2 = Personalization.new
+    personalization2.add_to(Email.new(email: 'test1@example.com', name: 'Example User 1'))
+    personalization2.add_to(Email.new(email: 'test2@example.com', name: 'Example User 2'))
+    personalization2.add_cc(Email.new(email: 'test3@example.com', name: 'Example User 3'))
+    personalization2.add_cc(Email.new(email: 'test4@example.com', name: 'Example User 4'))
+    personalization2.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User 5'))
+    personalization2.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User 6'))
+    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 = 1_443_636_843
+    mail.add_personalization(personalization2)
+    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'
+    attachment.type = 'application/pdf'
+    attachment.filename = 'balance_001.pdf'
+    attachment.disposition = 'attachment'
+    attachment.content_id = 'Balance Sheet'
+    mail.add_attachment(attachment)
+    attachment2 = Attachment.new
+    attachment2.content = 'BwdW'
+    attachment2.type = 'image/png'
+    attachment2.filename = 'banner.png'
+    attachment2.disposition = 'inline'
+    attachment2.content_id = 'Banner'
+    mail.add_attachment(attachment2)
+    mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
+    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.add_header(Header.new(key: 'X-Test3', value: 'test3'))
+    mail.add_header(Header.new(key: 'X-Test4', value: 'test4'))
+    mail.add_category(Category.new(name: 'May'))
+    mail.add_category(Category.new(name: '2016'))
+    mail.add_custom_arg(CustomArg.new(key: 'campaign', value: 'welcome'))
+    mail.add_custom_arg(CustomArg.new(key: 'weekday', value: 'morning'))
+    mail.send_at = 1_443_636_842
+    mail.batch_id = 'sendgrid_batch_id'
+    mail.asm = ASM.new(group_id: 99, groups_to_display: [4, 5, 6, 7, 8])
+    mail.ip_pool_name = '23'
+    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>')
+    mail_settings.sandbox_mode = SandBoxMode.new(enable: true)
+    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.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')
+    tracking_settings.ganalytics = Ganalytics.new(enable: true, utm_source: 'some source', utm_medium: 'some medium', utm_term: 'some term', utm_content: 'some content', utm_campaign: 'some campaign')
+    mail.tracking_settings = tracking_settings
+    mail.reply_to = Email.new(email: 'test@example.com')
+    # rubocop:disable Layout/LineLength
+    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":"test5@example.com","name":"Example User 5"},{"email":"test6@example.com","name":"Example User 6"}],"cc":[{"email":"test3@example.com","name":"Example User 3"},{"email":"test4@example.com","name":"Example User 4"}],"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":"test1@example.com","name":"Example User 1"},{"email":"test2@example.com","name":"Example User 2"}]},{"bcc":[{"email":"test5@example.com","name":"Example User 5"},{"email":"test6@example.com","name":"Example User 6"}],"cc":[{"email":"test3@example.com","name":"Example User 3"},{"email":"test4@example.com","name":"Example User 4"}],"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":"test1@example.com","name":"Example User 1"},{"email":"test2@example.com","name":"Example User 2"}]}],"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"}}}'))
+    # rubocop:enable all
+  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
+    mail.add_category(Category.new(name: 'foo'))
+    mail.add_category(Category.new(name: 'bar'))
+    assert_equal(%w[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 Viewed

@@ -0,0 +1,214 @@
+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'))
+    @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_duplicate_add_to
+    @personalization = Personalization.new
+    @personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
+    @personalization.add_to(Email.new(email: 'TEST2@EXAMPLE.COM', name: 'Example User 2'))
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_to(Email.new(email: 'test1@example.com', name: 'Duplicate User'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_to(Email.new(email: 'TEST1@EXAMPLE.COM', name: 'Duplicate User'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_to(Email.new(email: 'test2@example.com', name: 'Duplicate User 2'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_to(Email.new(email: 'TEST2@EXAMPLE.COM', name: 'Duplicate User 2'))
+    end
+  end
+  def test_add_from
+    @personalization = Personalization.new
+    @personalization.add_from(Email.new(email: 'from1@example.com', name: 'Example Sender'))
+    expected_json = {
+      'from' => {
+        'email' => 'from1@example.com',
+        'name' => 'Example Sender'
+      }
+    }
+    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'))
+    @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_duplicate_add_cc
+    @personalization = Personalization.new
+    @personalization.add_cc(Email.new(email: 'test1@example.com', name: 'Example User'))
+    @personalization.add_cc(Email.new(email: 'TEST2@EXAMPLE.COM', name: 'Example User 2'))
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_cc(Email.new(email: 'test1@example.com', name: 'Duplicate User'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_cc(Email.new(email: 'TEST1@EXAMPLE.COM', name: 'Duplicate User'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_cc(Email.new(email: 'test2@example.com', name: 'Duplicate User 2'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_cc(Email.new(email: 'TEST2@EXAMPLE.COM', name: 'Duplicate User 2'))
+    end
+  end
+  def test_add_bcc
+    @personalization = Personalization.new
+    @personalization.add_bcc(Email.new(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_duplicate_add_bcc
+    @personalization = Personalization.new
+    @personalization.add_bcc(Email.new(email: 'test1@example.com', name: 'Example User'))
+    @personalization.add_bcc(Email.new(email: 'TEST2@EXAMPLE.COM', name: 'Example User 2'))
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_bcc(Email.new(email: 'test1@example.com', name: 'Duplicate User'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_bcc(Email.new(email: 'TEST1@EXAMPLE.COM', name: 'Duplicate User'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_bcc(Email.new(email: 'test2@example.com', name: 'Duplicate User 2'))
+    end
+    assert_raises(DuplicatePersonalizationError) do
+      @personalization.add_bcc(Email.new(email: 'TEST2@EXAMPLE.COM', name: 'Duplicate User 2'))
+    end
+  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

data/test/sendgrid/permissions/test_scopes.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require_relative '../../../lib/sendgrid/helpers/permissions/scope'
+require 'minitest/autorun'
+class TestCategory < Minitest::Test
+  include SendGrid
+  # usecases
+  # 1. test admin scopes
+  # 2. test read only scopes
+  # 3. test read only and full access scopes for a method by hardcoding
+  # 4. test read only and full access scopes by loading scopes.yaml
+  def setup
+    @scopes_from_yaml = YAML.load_file("#{File.dirname(__FILE__)}/../../../lib/sendgrid/helpers/permissions/scopes.yml").freeze
+  end
+  def test_admin_scopes
+    assert_equal Scope.admin_permissions, @scopes_from_yaml.values.map(&:values).flatten
+  end
+  def test_read_only_scopes
+    assert_equal Scope.read_only_permissions, @scopes_from_yaml.map { |_, v| v[:read] }.flatten
+  end
+  def test_read_only_and_full_access_for_mail_hardcoded
+    assert_equal Scope.mail_read_only_permissions, ["mail.batch.read"]
+    assert_equal Scope.mail_full_access_permissions, ["mail.send", "mail.batch.create", "mail.batch.delete", "mail.batch.read", "mail.batch.update"]
+  end
+  def test_read_only_and_full_access_from_file
+    @scopes_from_yaml.each_key do |endpoint|
+      assert_equal Scope.send("#{endpoint}_read_only_permissions"), @scopes_from_yaml[endpoint][:read]
+      assert_equal Scope.send("#{endpoint}_full_access_permissions"), @scopes_from_yaml[endpoint].values.flatten
+    end
+  end
+end