sendgrid-ruby 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a23133f8c4095f9f190145c808636a48bfd7307c
-  data.tar.gz: 0066b643ab7820a2444a8463e2817a9c76826522
+  metadata.gz: 17a0c45fe3cb5d548c9b968d913f1d043e9cd77c
+  data.tar.gz: e66e0b611e7d57a6ca17145ba4a03694386234b5
 SHA512:
-  metadata.gz: 9a493f33a268e47cbbeacb127f8a85fca38dd63da8a4b65522595e8eb44767c93f62711d7d90a52d5289555394e37cf0d261de6bbfeab2dae6df49a4889c0a3d
-  data.tar.gz: c23996c075c861b7aaac71e324c381f05fe5921dc1b07f41f03ac3538a48e0ce34d671ff38e8036a152afe90c0c8e9cbb2332c5856b24267b722b712123e8c6c
+  metadata.gz: d4373e034801eccbe7bbfe12f39221ca1b9439a6c298757b42424db1d3695581cd403ab7bde1f524260989357d4b0d049dc80dc8577e87200a903b94c32221c7
+  data.tar.gz: 4588228cef48b5e709f1008a2600d8ec50f41aa4dd66bb5e011b4d69da3267f51a2ea0d60b57a443b0d982b3887a2beb20b9f58c36008238a644e3eaa6409138

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [5.1.0] - 2017-9-1 ##
+### Added
+- #173: Update ruby-http-client dependency
+- [#12](https://github.com/sendgrid/ruby-http-client/pull/12) Add a helper that returns the response body as a hash via the `parsed_body` method in the `Response` object.
+- Thanks to [Diego Camargo](https://github.com/belfazt) for the pull request!
+
 ## [5.0.0] - 2017-05-27
 ### BREAKING CHANGE
 - #108 Fix unexpected `Mail` `#categories`, `#categories=` behavior
@@ -13,7 +19,7 @@ All notable changes to this project will be documented in this file.
 - `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.attachments` becomes `mail.add_attachment()`
 - `mail.sections` becomes `mail.add_section()`
 - `mail.headers` becomes `mail.add_header()`
 - `mail.categories` becomes `mail.add_category()`
@@ -172,4 +178,4 @@ Inline content support
 
 ## [1.0.3] - 2015-10-01 ##
 ### Fixed
-Payload 'to' attribute fix for smtpapi
+Payload 'to' attribute fix for smtpapi

data/README.md

@@ -1,6 +1,7 @@
 [![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-ruby.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-ruby) [![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
+[![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
 
-Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-ruby/issues/94). Your support is appreciated!
+**NEW:** Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/ruby) for releases and breaking changes.
 
 **This library allows you to quickly and easily use the SendGrid Web API v3 via Ruby.**
 
@@ -178,7 +179,7 @@ Please see [our helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/li
 
 Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-ruby/issues/94). Your support is appreciated!
 
-All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-ruby/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases).
+All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-ruby/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/ruby) for releases and breaking changes.
 
 <a name="roadmap"></a>
 # Roadmap

data/examples/helpers/mail/example.rb

@@ -54,7 +54,7 @@ def kitchen_sink
   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.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>'))
@@ -65,7 +65,6 @@ def kitchen_sink
   attachment.filename = 'balance_001.pdf'
   attachment.disposition = 'attachment'
   attachment.content_id = 'Balance Sheet'
-
   mail.add_attachment(attachment)
 
   attachment2 = Attachment.new

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

data/mail_helper_v3.md

@@ -0,0 +1,382 @@
+Hello!
+
+It is now time to implement the final piece of our v2 to v3 migration. Before we dig into writing the code, we would love to get feedback on the following proposed interfaces.
+
+We are starting with the use cases below for the first iteration. (we have completed this work on [our C# library](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md), you can check that out for a sneak peek of where we are heading).
+
+# Send a Single Email to a Single Recipient
+
+The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+
+```ruby
+require 'sendgrid-ruby'
+
+from = SendGrid::Email.new('test@example.com', 'Example User')
+to = SendGrid::Email.new('test@example.com', 'Example User')
+subject = 'Sending with SendGrid is Fun'
+plain_text_content = 'and easy to do anywhere, even with Ruby'
+html_content = '<strong>and easy to do anywhere, even with Ruby</strong>'
+msg = SendGrid::Mail.create_single_email(from, to, subject, plain_text_content, html_content)
+
+client = SendGrid::ClientFactory.new(api_key: ENV['SENDGRID_API_KEY'])
+
+begin
+    response = client.send_email(msg)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+# Send a Single Email to Multiple Recipients
+
+The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+
+```ruby
+require 'sendgrid-ruby'
+
+from = SendGrid::Email.new('test@example.com', 'Example User')
+tos = [ 
+    SendGrid::Email.new('test1@example.com', 'Example User1'),
+    SendGrid::Email.new('test2@example.com', 'Example User2'),
+    SendGrid::Email.new('test3@example.com', 'Example User3')
+];
+subject = 'Sending with SendGrid is Fun'
+plain_text_content = 'and easy to do anywhere, even with Ruby'
+html_content = '<strong>and easy to do anywhere, even with Ruby</strong>'
+msg = SendGrid::Mail.create_single_email_to_multiple_recipients(from,
+                                                           tos,
+                                                           subject,
+                                                           plain_text_content,
+                                                           html_content)
+
+client = SendGrid::ClientFactory.new(api_key: ENV['SENDGRID_API_KEY'])
+
+begin
+    response = client.send_email(msg)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+# Send Multiple Emails to Multiple Recipients
+
+The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+
+```ruby
+require 'sendgrid-ruby'
+
+from = SendGrid::Email.new('test@example.com', 'Example User')
+tos = [ 
+    SendGrid::Email.new('test1@example.com', 'Example User1'),
+    SendGrid::Email.new('test2@example.com', 'Example User2'),
+    SendGrid::Email.new('test3@example.com', 'Example User3')
+];
+subjects = [
+    'Sending with SendGrid is Fun',
+    'Sending with SendGrid is Super Fun',
+    'Sending with SendGrid is Super Duper Fun'
+];
+plain_text_content = 'and easy to do anywhere, even with Ruby'
+html_content = '<strong>and easy to do anywhere, even with Ruby</strong>'
+values = [
+    'Name 1',
+    'Name 2',
+    'Name 3'
+]
+substitutions = {
+    '-name1-' => values
+}
+msg = SendGrid::Mail.create_multiple_emails_to_multiple_recipients(from,
+                                                              tos,
+                                                              subjects,
+                                                              plain_text_content,
+                                                              html_content,
+                                                              substitutions)
+
+client = SendGrid::ClientFactory.new(api_key: ENV['SENDGRID_API_KEY'])
+
+begin
+    response = client.send_email(msg)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+# Kitchen Sink - an example with all settings used
+
+The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+
+```ruby
+client = SendGrid::ClientFactory.new(api_key: ENV['SENDGRID_API_KEY'])
+
+from = SendGrid::Email.new('test@example.com', 'Example User')
+to = SendGrid::Email.new('test@example.com', 'Example User')
+subject = 'Sending with SendGrid is Fun'
+plain_text_content = 'and easy to do anywhere, even with Ruby'
+html_content = '<strong>and easy to do anywhere, even with Ruby</strong>'
+msg = SendGrid::SendGridMessage.new(from, to, subject, plain_text_content, html_content)
+
+# For a detailed description of each of these settings, please see the [documentation](https://sendgrid.com/docs/API_Reference/api_v3.html).
+
+msg.add_to(SendGrid::Email.new('test1@example.com', 'Example User1'))
+to_emails = [ 
+    SendGrid::Email.new('test2@example.com', 'Example User2'),
+    SendGrid::Email.new('test3@example.com', 'Example User3')
+];
+msg.add_tos(to_emails)
+
+msg.add_cc(SendGrid::Email.new('test4@example.com', 'Example User4'))
+cc_emails = [ 
+    SendGrid::Email.new('test5@example.com', 'Example User5'),
+    SendGrid::Email.new('test6@example.com', 'Example User6')
+];
+msg.add_ccs(cc_emails)
+
+msg.add_bcc(SendGrid::Email.new('test7@example.com', 'Example User7'))
+bcc_emails = [ 
+    SendGrid::Email.new('test8@example.com', 'Example User8'),
+    SendGrid::Email.new('test9@example.com', 'Example User9')
+];
+msg.add_bccs(bcc_emails)
+
+msg.add_header('X-Test1', 'Test1')
+msg.add_header('X-Test2', 'Test2')
+headers = [
+    'X-Test3' => 'Test3',
+    'X-Test4' => 'Test4'
+]
+msg.add_headers(headers)
+
+msg.add_substitution('%name1%', 'Example Name 1');
+msg.add_substitution('%city1%', 'Denver');
+substitutions = [
+    '%name2%' => 'Example Name 2',
+    '%city2%' => 'Orange'
+]
+msg.add_substitutions(substitutions)
+
+msg.add_custom_arg('marketing1', 'false')
+msg.add_custom_arg('transactional1', 'true')
+custom_args = [
+    'marketing2' => 'true',
+    'transactional2' => 'false'
+]
+msg.add_custom_args(custom_args)
+
+msg.set_send_at(1461775051)
+
+msg.set_subject('this subject overrides the Global Subject on the default Personalization')
+
+# If you need to add more [Personalizations](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html), here is an example of adding another Personalization by passing in a personalization index.
+
+msg.add_to(SendGrid::Email.new('test10@example.com', 'Example User10'), 1)
+to_emails = [ 
+    SendGrid::Email.new('test11@example.com', 'Example User11'),
+    SendGrid::Email.new('test12@example.com', 'Example User12')
+];
+msg.add_tos(to_emails, 1)
+
+msg.add_cc(SendGrid::Email.new('test13@example.com', 'Example User13'), 1)
+cc_emails = [ 
+    SendGrid::Email.new('test14@example.com', 'Example User14'),
+    SendGrid::Email.new('test15@example.com', 'Example User15')
+];
+msg.add_ccs(cc_emails, 1)
+
+msg.add_bcc(SendGrid::Email.new('test16@example.com', 'Example User16'), 1)
+bcc_emails = [ 
+    SendGrid::Email.new('test17@example.com', 'Example User17'),
+    SendGrid::Email.new('test18@example.com', 'Example User18')
+];
+msg.add_bccs(bcc_emails, 1)
+
+msg.add_header('X-Test5', 'Test5', 1)
+msg.add_header('X-Test6', 'Test6', 1)
+headers = [
+    'X-Test7' => 'Test7',
+    'X-Test8' => 'Test8'
+]
+msg.add_headers(headers, 1)
+
+msg.add_substitution('%name3%', 'Example Name 3', 1);
+msg.add_substitution('%city3%', 'Redwood City', 1);
+substitutions = [
+    '%name4%' => 'Example Name 4',
+    '%city4%' => 'London'
+]
+msg.add_substitutions(substitutions, 1)
+
+msg.add_custom_arg('marketing3', 'true', 1)
+msg.add_custom_arg('transactional3', 'false', 1)
+custom_args = [
+    'marketing4' => 'false',
+    'transactional4' => 'true'
+]
+msg.add_custom_args(custom_args, 1)
+
+msg.set_send_at(1461775052, 1)
+
+msg.set_subject('this subject overrides the Global Subject on the second Personalization', 1)
+
+# The values below this comment are global to entire message
+
+msg.set_from(SendGrid::Email.new('test0@example.com', 'Example User0'))
+
+msg.set_global_subject('Sending with SendGrid is Fun');
+
+msg.add_content(MimeType::Text, 'and easy to do anywhere, even with Ruby')
+msg.add_content(MimeType::Html, '<strong>and easy to do anywhere, even with Ruby</strong>')
+contents = [
+    SendGrid::Content.new('text/calendar', 'Party Time!!'),
+    SendGrid::Content.new('text/calendar2', 'Party Time 2!!')
+]
+msg.add_contents(contents)
+
+msg.add_attachment('balance_001.pdf',
+                   'base64 encoded content',
+                   'application/pdf',
+                   'attachment',
+                   'Balance Sheet')
+
+attachments = [
+    SendGrid::Attachment.new('banner.png',
+                             'base64 encoded content',
+                             'image/png',
+                             'inline',
+                             'Banner'),
+    SendGrid::Attachment.new('banner2.png',
+                             'base64 encoded content',
+                             'image/png',
+                             'inline',
+                             'Banner 2'),                             
+]
+msg.add_attachments(attachments)
+
+msg.set_template_id('13b8f94f-bcae-4ec6-b752-70d6cb59f932')
+
+msg.add_global_header('X-Day', 'Monday')
+global_headers = [
+    'X-Month' => 'January',
+    'X-Year' => '2017'
+]
+msg.set_global_headers(global_headers)
+
+msg.add_section('%section1%', 'Substitution for Section 1 Tag')
+sections = [
+    '%section2%' => 'Substitution for Section 2 Tag',
+    '%section3%' => 'Substitution for Section 3 Tag'    
+]
+msg.add_sections(sections)
+
+begin
+    response = client.send_email(msg)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+# Attachments
+
+The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+
+```ruby
+client = SendGrid::ClientFactory.new(api_key: ENV['SENDGRID_API_KEY'])
+
+from = SendGrid::Email.new('test@example.com', 'Example User')
+to = SendGrid::Email.new('test@example.com', 'Example User')
+subject = 'Sending with SendGrid is Fun'
+plain_text_content = 'and easy to do anywhere, even with Ruby'
+html_content = '<strong>and easy to do anywhere, even with Ruby</strong>'
+msg = SendGrid::SendGridMessage.new(from, to, subject, plain_text_content, html_content)
+msg.add_attachment('balance_001.pdf',
+                   'base64 encoded content',
+                   'application/pdf',
+                   'attachment',
+                   'Balance Sheet')
+
+begin
+    response = client.send_email(msg)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+# Transactional Templates
+
+The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+
+For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
+
+Template ID (replace with your own):
+
+```text
+13b8f94f-bcae-4ec6-b752-70d6cb59f932
+```
+
+Email Subject:
+
+```text
+<%subject%>
+```
+
+Template Body:
+
+```html
+<html>
+<head>
+	<title></title>
+</head>
+<body>
+Hello -name-,
+<br /><br/>
+I'm glad you are trying out the template feature!
+<br /><br/>
+<%body%>
+<br /><br/>
+I hope you are having a great day in -city- :)
+<br /><br/>
+</body>
+</html>
+```
+
+```ruby
+client = SendGrid::ClientFactory.new(api_key: ENV['SENDGRID_API_KEY'])
+
+from = SendGrid::Email.new('test@example.com', 'Example User')
+to = SendGrid::Email.new('test@example.com', 'Example User')
+subject = 'Sending with SendGrid is Fun'
+plain_text_content = 'and easy to do anywhere, even with Ruby'
+html_content = '<strong>and easy to do anywhere, even with Ruby</strong>'
+msg = SendGrid::SendGridMessage.new(from, to, subject, plain_text_content, html_content)
+
+substitutions = [
+    '-name-' => 'Example User',
+    '-city-' => 'Denver'
+]
+msg.add_substitutions(substitutions)
+msg.set_template_id('13b8f94f-bcae-4ec6-b752-70d6cb59f932')
+
+begin
+    response = client.send_email(msg)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.headers
+```

data/sendgrid-ruby.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
-  spec.add_dependency 'ruby_http_client', '~> 3.0'
+  spec.add_dependency 'ruby_http_client', '~> 3.2'
   spec.add_dependency 'sinatra', '>= 1.4.7', '< 3'
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'rspec'

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

@@ -9,15 +9,13 @@ 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.add_to(Email.new(email: "test@example.com"))
-    mail.add_personalization(personalization)
-    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>"))
-    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 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)
+
+    assert_equal(mail.to_json, JSON.parse('{"from":{"email":"test@example.com"}, "subject":"Sending with 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

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -55,7 +55,7 @@ class TestAPI < MiniTest::Test
             ')
         assert_equal(test_headers, sg.request_headers)
         assert_equal("v3", sg.version)
-        assert_equal("5.0.0", SendGrid::VERSION)
+        assert_equal("5.1.0", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-27 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +203,7 @@ files:
 - lib/sendgrid/helpers/settings/tracking_settings_dto.rb
 - lib/sendgrid/helpers/settings/user_settings_dto.rb
 - lib/sendgrid/version.rb
+- mail_helper_v3.md
 - sendgrid-ruby.gemspec
 - spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb
 - spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb
@@ -235,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Official SendGrid Gem