sendgrid-ruby 6.3.1 → 6.3.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (119) hide show
  1. checksums.yaml +4 -4
  2. data/.codeclimate.yml +1 -1
  3. data/.rubocop.yml +8 -0
  4. data/.rubocop_todo.yml +109 -0
  5. data/.travis.yml +2 -3
  6. data/CHANGELOG.md +61 -9
  7. data/CONTRIBUTING.md +10 -20
  8. data/FIRST_TIMERS.md +79 -0
  9. data/ISSUE_TEMPLATE.md +5 -1
  10. data/Makefile +3 -2
  11. data/PULL_REQUEST_TEMPLATE.md +1 -1
  12. data/README.md +22 -27
  13. data/Rakefile +2 -3
  14. data/TROUBLESHOOTING.md +5 -5
  15. data/USAGE.md +145 -38
  16. data/examples/accesssettings/accesssettings.rb +9 -12
  17. data/examples/alerts/alerts.rb +8 -11
  18. data/examples/apikeys/apikeys.rb +12 -15
  19. data/examples/asm/asm.rb +27 -30
  20. data/examples/browsers/browsers.rb +0 -3
  21. data/examples/campaigns/campaigns.rb +29 -32
  22. data/examples/categories/categories.rb +0 -3
  23. data/examples/clients/clients.rb +1 -4
  24. data/examples/contactdb/contactdb.rb +63 -66
  25. data/examples/devices/devices.rb +0 -3
  26. data/examples/emailactivity/emailactivity.rb +52 -0
  27. data/examples/geo/geo.rb +0 -3
  28. data/examples/helpers/eventwebhook/example.rb +4 -4
  29. data/examples/helpers/mail/example.rb +19 -13
  30. data/examples/helpers/settings/example.rb +1 -1
  31. data/examples/helpers/stats/example.rb +4 -4
  32. data/examples/ips/ips.rb +19 -22
  33. data/examples/mail/mail.rb +72 -75
  34. data/examples/mailboxproviders/mailboxproviders.rb +0 -3
  35. data/examples/mailsettings/mailsettings.rb +21 -24
  36. data/examples/partnersettings/partnersettings.rb +3 -6
  37. data/examples/scopes/scopes.rb +7 -9
  38. data/examples/senderauthentication/senderauthentication.rb +41 -44
  39. data/examples/senders/senders.rb +28 -31
  40. data/examples/stats/stats.rb +0 -3
  41. data/examples/subusers/subusers.rb +17 -20
  42. data/examples/suppression/suppression.rb +15 -18
  43. data/examples/templates/templates.rb +29 -31
  44. data/examples/trackingsettings/trackingsettings.rb +14 -17
  45. data/examples/user/user.rb +41 -44
  46. data/lib/rack/sendgrid_webhook_verification.rb +5 -2
  47. data/lib/sendgrid/base_interface.rb +1 -1
  48. data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb +4 -6
  49. data/lib/sendgrid/helpers/inbound/README.md +5 -5
  50. data/lib/sendgrid/helpers/inbound/app.rb +1 -1
  51. data/lib/sendgrid/helpers/inbound/public/index.html +1 -1
  52. data/lib/sendgrid/helpers/inbound/send.rb +2 -2
  53. data/lib/sendgrid/helpers/ip_management/ip_management.rb +1 -1
  54. data/lib/sendgrid/helpers/mail/README.md +3 -3
  55. data/lib/sendgrid/helpers/mail/asm.rb +6 -18
  56. data/lib/sendgrid/helpers/mail/attachment.rb +12 -42
  57. data/lib/sendgrid/helpers/mail/bcc_settings.rb +6 -18
  58. data/lib/sendgrid/helpers/mail/bypass_list_management.rb +8 -18
  59. data/lib/sendgrid/helpers/mail/category.rb +2 -2
  60. data/lib/sendgrid/helpers/mail/click_tracking.rb +6 -18
  61. data/lib/sendgrid/helpers/mail/content.rb +4 -3
  62. data/lib/sendgrid/helpers/mail/custom_arg.rb +6 -10
  63. data/lib/sendgrid/helpers/mail/email.rb +5 -4
  64. data/lib/sendgrid/helpers/mail/footer.rb +7 -27
  65. data/lib/sendgrid/helpers/mail/ganalytics.rb +10 -54
  66. data/lib/sendgrid/helpers/mail/header.rb +6 -10
  67. data/lib/sendgrid/helpers/mail/mail.rb +30 -48
  68. data/lib/sendgrid/helpers/mail/mail_settings.rb +9 -25
  69. data/lib/sendgrid/helpers/mail/open_tracking.rb +6 -18
  70. data/lib/sendgrid/helpers/mail/personalization.rb +34 -27
  71. data/lib/sendgrid/helpers/mail/section.rb +6 -10
  72. data/lib/sendgrid/helpers/mail/spam_check.rb +7 -27
  73. data/lib/sendgrid/helpers/mail/subscription_tracking.rb +8 -36
  74. data/lib/sendgrid/helpers/mail/substitution.rb +6 -10
  75. data/lib/sendgrid/helpers/mail/tracking_settings.rb +7 -20
  76. data/lib/sendgrid/helpers/permissions/scope.rb +1 -1
  77. data/lib/sendgrid/helpers/settings/README.md +2 -2
  78. data/lib/sendgrid/helpers/settings/settings.rb +1 -1
  79. data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb +3 -5
  80. data/lib/sendgrid/helpers/stats/metrics.rb +5 -5
  81. data/lib/sendgrid/sendgrid.rb +1 -1
  82. data/lib/sendgrid/twilio_email.rb +1 -1
  83. data/lib/sendgrid/version.rb +1 -1
  84. data/mail_helper_v3.md +12 -12
  85. data/sendgrid-ruby.gemspec +8 -8
  86. data/spec/fixtures/event_webhook.rb +17 -11
  87. data/spec/rack/sendgrid_webhook_verification_spec.rb +30 -4
  88. data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb +38 -36
  89. data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb +1 -1
  90. data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb +1 -1
  91. data/spec/sendgrid/helpers/settings/settings_spec.rb +2 -2
  92. data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb +1 -1
  93. data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb +1 -1
  94. data/spec/sendgrid/helpers/stats/email_stats_spec.rb +22 -23
  95. data/spec/sendgrid/helpers/stats/metrics_spec.rb +19 -20
  96. data/spec/sendgrid/helpers/stats/stats_response_spec.rb +22 -23
  97. data/spec/spec_helper.rb +3 -1
  98. data/static/img/github-fork.png +0 -0
  99. data/static/img/github-sign-up.png +0 -0
  100. data/test/sendgrid/helpers/mail/test_attachment.rb +4 -6
  101. data/test/sendgrid/helpers/mail/test_category.rb +0 -2
  102. data/test/sendgrid/helpers/mail/test_email.rb +9 -11
  103. data/test/sendgrid/helpers/mail/test_mail.rb +101 -102
  104. data/test/sendgrid/helpers/mail/test_personalizations.rb +106 -93
  105. data/test/sendgrid/permissions/test_scopes.rb +0 -2
  106. data/test/sendgrid/test_sendgrid-ruby.rb +1948 -1958
  107. data/twilio_sendgrid_logo.png +0 -0
  108. data/use-cases/README.md +16 -0
  109. data/use-cases/domain-authentication.md +5 -0
  110. data/use-cases/email-statistics.md +52 -0
  111. data/use-cases/legacy-templates.md +98 -0
  112. data/use-cases/sms.md +39 -0
  113. data/use-cases/transactional-templates.md +111 -0
  114. data/use-cases/twilio-email.md +13 -0
  115. data/use-cases/twilio-setup.md +54 -0
  116. metadata +53 -28
  117. data/USE_CASES.md +0 -405
  118. data/docker/Dockerfile +0 -12
  119. data/docker/README.md +0 -30
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 34e9f9d2222a7a622d3a92b44006854f282296230b5e08958bdc0c3983ce1bf0
4
- data.tar.gz: d2d1daecf34261120b150a4c3d64fb48b90816e18dd3b053478751365e0ae426
3
+ metadata.gz: aa01e80d5c4628995eb1deeafc8dc22364917d5840e1906e3c6319c2b7a66224
4
+ data.tar.gz: 87a42bf375187c6a21fcc2432753ce96cb17c8b47f851c1d3800defc0ef9378f
5
5
  SHA512:
6
- metadata.gz: ce14fa4b6341a6dac4c09aa83f999463f1c07849b05e47e5c9a596c009ba39a6ca733193c6f8543adc5aa1c989d6651a48f21223c608bda1a95d61b6e0af42a0
7
- data.tar.gz: 77b872b63c84354a2f01d4a1b2717e23212f5a59a1ef8b6ae427491aabd43bc165cbbf1657383786187751b6db372ac1358e818c2f4ebe7a29e3cb17fbebce48
6
+ metadata.gz: 2689e50ffdd1914c0e0212cbfe3ac6faeb6d4c199edae135c13c5324d8d4d0c5ab39f0b5dbc33d9673c4de20540aa173262a3abfc58b000143430080d5dd68c9
7
+ data.tar.gz: b0e843dad160781bf98a01b507a7a5d7bb5a6c607a554cffede4871e7b00ce2e529de438189d33743901db48599a4fcc1b420c972de97b2df4ed54bae61813f3
@@ -16,6 +16,6 @@ ratings:
16
16
  - "**.rb"
17
17
  exclude_paths:
18
18
  - examples/
19
+ - gemfiles/
19
20
  - spec/
20
21
  - test/
21
- - gemfiles/
@@ -0,0 +1,8 @@
1
+ inherit_from: .rubocop_todo.yml
2
+
3
+ Style/StringLiterals:
4
+ Enabled: false
5
+
6
+ Metrics/BlockLength:
7
+ Exclude:
8
+ - 'spec/**/*'
@@ -0,0 +1,109 @@
1
+ # This configuration was generated by
2
+ # `rubocop --auto-gen-config`
3
+ # on 2020-09-18 20:20:54 UTC using RuboCop version 0.91.0.
4
+ # The point is for the user to remove these configuration records
5
+ # one by one as the offenses are removed from the code base.
6
+ # Note that changes in the inspected code, or installation of new
7
+ # versions of RuboCop, may require this file to be generated again.
8
+
9
+ # Offense count: 1
10
+ # Configuration parameters: Include.
11
+ # Include: **/*.gemspec
12
+ Gemspec/RequiredRubyVersion:
13
+ Exclude:
14
+ - 'sendgrid-ruby.gemspec'
15
+
16
+ # Offense count: 22
17
+ Lint/UselessAssignment:
18
+ Exclude:
19
+ - 'examples/scopes/scopes.rb'
20
+ - 'spec/rack/sendgrid_webhook_verification_spec.rb'
21
+
22
+ # Offense count: 8
23
+ # Configuration parameters: IgnoredMethods.
24
+ Metrics/AbcSize:
25
+ Max: 144
26
+
27
+ # Offense count: 9
28
+ # Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
29
+ # ExcludedMethods: refine
30
+ Metrics/BlockLength:
31
+ Max: 96
32
+
33
+ # Offense count: 3
34
+ # Configuration parameters: CountComments, CountAsOne.
35
+ Metrics/ClassLength:
36
+ Max: 2006
37
+
38
+ # Offense count: 41
39
+ # Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
40
+ Metrics/MethodLength:
41
+ Max: 141
42
+
43
+ # Offense count: 2
44
+ # Configuration parameters: CountKeywordArgs.
45
+ Metrics/ParameterLists:
46
+ Max: 7
47
+
48
+ # Offense count: 4
49
+ # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
50
+ # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
51
+ Naming/FileName:
52
+ Exclude:
53
+ - 'gemfiles/Sinatra_1.gemfile'
54
+ - 'gemfiles/Sinatra_2.gemfile'
55
+ - 'lib/sendgrid-ruby.rb'
56
+ - 'test/sendgrid/test_sendgrid-ruby.rb'
57
+
58
+ # Offense count: 1
59
+ # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
60
+ # AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
61
+ Naming/MethodParameterName:
62
+ Exclude:
63
+ - 'lib/sendgrid/helpers/mail/personalization.rb'
64
+
65
+ # Offense count: 1
66
+ # Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
67
+ # NamePrefix: is_, has_, have_
68
+ # ForbiddenPrefixes: is_, has_, have_
69
+ # AllowedMethods: is_a?
70
+ # MethodDefinitionMacros: define_method, define_singleton_method
71
+ Naming/PredicateName:
72
+ Exclude:
73
+ - 'spec/**/*'
74
+ - 'examples/helpers/eventwebhook/example.rb'
75
+
76
+ # Offense count: 35
77
+ Style/Documentation:
78
+ Enabled: false
79
+
80
+ # Offense count: 4
81
+ # Configuration parameters: EnforcedStyle.
82
+ # SupportedStyles: annotated, template, unannotated
83
+ Style/FormatStringToken:
84
+ Exclude:
85
+ - 'examples/emailactivity/emailactivity.rb'
86
+
87
+ # Offense count: 97
88
+ # Cop supports --auto-correct.
89
+ # Configuration parameters: EnforcedStyle.
90
+ # SupportedStyles: always, always_true, never
91
+ Style/FrozenStringLiteralComment:
92
+ Enabled: false
93
+
94
+ # Offense count: 6
95
+ Style/MixinUsage:
96
+ Exclude:
97
+ - 'examples/helpers/eventwebhook/example.rb'
98
+ - 'examples/helpers/mail/example.rb'
99
+ - 'examples/helpers/settings/example.rb'
100
+ - 'examples/helpers/stats/example.rb'
101
+ - 'test/sendgrid/helpers/mail/test_attachment.rb'
102
+ - 'test/sendgrid/helpers/mail/test_mail.rb'
103
+
104
+ # Offense count: 55
105
+ # Cop supports --auto-correct.
106
+ # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
107
+ # URISchemes: http, https
108
+ Layout/LineLength:
109
+ Max: 3211
@@ -14,8 +14,7 @@ script: make test-docker
14
14
 
15
15
  deploy:
16
16
  provider: rubygems
17
- api_key:
18
- secure: CWlfN170i/fHPrIufHHLWQ0utjuhxf4ELSxKeypIuO2CNTqNMzocDAa2vxMt4XfO6d2wFPV/LC+IHR7i+sp7PKvjRoa4BLUUxjfBNDboc0gGESeUYlAxwsJo0tOVCNmpxgjQKqtPLz/19A/v/xpxLv2Im/9Idqa5ATd06sMDdM8=
17
+ api_key: $RUBYGEMS_API_KEY
19
18
  gem: sendgrid-ruby
20
19
  on:
21
20
  tags: true
@@ -23,7 +22,7 @@ deploy:
23
22
 
24
23
  notifications:
25
24
  slack:
26
- if: branch = master
25
+ if: branch = main
27
26
  on_pull_requests: false
28
27
  on_success: never
29
28
  on_failure: change
@@ -1,6 +1,58 @@
1
1
  # Change Log
2
2
  All notable changes to this project will be documented in this file.
3
3
 
4
+ [2020-10-14] Version 6.3.6
5
+ --------------------------
6
+ **Library - Fix**
7
+ - [PR #440](https://github.com/sendgrid/sendgrid-ruby/pull/440): reading position of a request body. Thanks to [@snaka](https://github.com/snaka)!
8
+
9
+
10
+ [2020-09-28] Version 6.3.5
11
+ --------------------------
12
+ **Library - Fix**
13
+ - [PR #437](https://github.com/sendgrid/sendgrid-ruby/pull/437): Raise error when adding duplicate email address in Personalizations. Thanks to [@Pranc1ngPegasus](https://github.com/Pranc1ngPegasus)!
14
+
15
+ **Library - Docs**
16
+ - [PR #322](https://github.com/sendgrid/sendgrid-ruby/pull/322): Update documentation for retrieving a list of all templates. Thanks to [@renshuki](https://github.com/renshuki)!
17
+ - [PR #332](https://github.com/sendgrid/sendgrid-ruby/pull/332): Add Email activity API Documentation. Thanks to [@dhoeric](https://github.com/dhoeric)!
18
+
19
+ **Library - Test**
20
+ - [PR #315](https://github.com/sendgrid/sendgrid-ruby/pull/315): Add rubocop check to CI. Thanks to [@dipil-saud](https://github.com/dipil-saud)!
21
+
22
+ **Library - Chore**
23
+ - [PR #339](https://github.com/sendgrid/sendgrid-ruby/pull/339): Added rubocop configs and changed source files with rubocop "offenses". Thanks to [@douglaslise](https://github.com/douglaslise)!
24
+ - [PR #338](https://github.com/sendgrid/sendgrid-ruby/pull/338): Refactor getters and setters to use ruby accessors. Thanks to [@douglaslise](https://github.com/douglaslise)!
25
+
26
+
27
+ [2020-08-19] Version 6.3.4
28
+ --------------------------
29
+ **Library - Docs**
30
+ - [PR #319](https://github.com/sendgrid/sendgrid-ruby/pull/319): Run all the *.md files through grammar.ly service and update accordingly. Thanks to [@Sarthakagarwal22](https://github.com/Sarthakagarwal22)!
31
+ - [PR #344](https://github.com/sendgrid/sendgrid-ruby/pull/344): Update example.rb. Thanks to [@kylearoberts](https://github.com/kylearoberts)!
32
+
33
+ **Library - Chore**
34
+ - [PR #432](https://github.com/sendgrid/sendgrid-ruby/pull/432): update GitHub branch references to use HEAD. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
35
+
36
+
37
+ [2020-07-22] Version 6.3.3
38
+ --------------------------
39
+ **Library - Chore**
40
+ - [PR #431](https://github.com/sendgrid/sendgrid-ruby/pull/431): migrate to new default sendgrid-oai branch. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
41
+ - [PR #366](https://github.com/sendgrid/sendgrid-ruby/pull/366): add Rubocop configuration file. Thanks to [@RolandBurrows](https://github.com/RolandBurrows)!
42
+
43
+ **Library - Test**
44
+ - [PR #429](https://github.com/sendgrid/sendgrid-ruby/pull/429): fix the license test and actually run the test scripts. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
45
+
46
+ **Library - Docs**
47
+ - [PR #273](https://github.com/sendgrid/sendgrid-ruby/pull/273): Create a Use Cases Directory and Associated Files. Thanks to [@alanunruh](https://github.com/alanunruh)!
48
+
49
+
50
+ [2020-07-08] Version 6.3.2
51
+ --------------------------
52
+ **Library - Test**
53
+ - [PR #368](https://github.com/sendgrid/sendgrid-ruby/pull/368): add Simplecov Local Enhancements. Thanks to [@RolandBurrows](https://github.com/RolandBurrows)!
54
+
55
+
4
56
  [2020-06-25] Version 6.3.1
5
57
  --------------------------
6
58
 
@@ -101,7 +153,7 @@ All notable changes to this project will be documented in this file.
101
153
  [2019-06-04] Version 6.0.0
102
154
  --------------------------
103
155
  ### BREAKING CHANGE
104
- - [PR #284](https://github.com/sendgrid/sendgrid-ruby/pull/284): The sinatra gem is no longer specified as a dependency of this gem. If you would like to use the inbound processing, please follow the [upgrade guide](https://github.com/sendgrid/sendgrid-ruby/blob/master/UPGRADE.md). Big thanks to [@jjb](https://github.com/jjb) for the PR!
156
+ - [PR #284](https://github.com/sendgrid/sendgrid-ruby/pull/284): The sinatra gem is no longer specified as a dependency of this gem. If you would like to use the inbound processing, please follow the [upgrade guide](UPGRADE.md). Big thanks to [@jjb](https://github.com/jjb) for the PR!
105
157
 
106
158
  ### Added
107
159
  - [PR #271](https://github.com/sendgrid/sendgrid-ruby/pull/271): Add ability to impersonate a subuser. Big thanks to [@danilospa](https://github.com/danilospa) for the PR!
@@ -142,7 +194,7 @@ All notable changes to this project will be documented in this file.
142
194
 
143
195
  ## [5.2.0] - 2017-10-30 ##
144
196
  ### Added
145
- - PR #234: Helpers for email statistics - global, category, subuser
197
+ - PR #234: Helpers for email statistics - global, category, subuser
146
198
  - Thanks to [Awin Abi](https://github.com/awinabi) for the pull request!
147
199
 
148
200
  ## [5.1.0] - 2017-9-1 ##
@@ -168,7 +220,7 @@ All notable changes to this project will be documented in this file.
168
220
  - `mail.headers` becomes `mail.add_header()`
169
221
  - `mail.categories` becomes `mail.add_category()`
170
222
  - `mail.custom_args` becomes `mail.custom_args()`
171
- - For a full example of usage, please [see here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/helpers/mail/example.rb#L21).
223
+ - For a full example of usage, please [see here](examples/helpers/mail/example.rb#L21).
172
224
 
173
225
  ## [4.3.3] - 2017-5-2
174
226
  ### Update
@@ -179,7 +231,7 @@ All notable changes to this project will be documented in this file.
179
231
  ## [4.3.2] - 2017-5-1 ##
180
232
  ### Fixes
181
233
  - #161: Fixed problematic Sinatra dependency
182
- - Brings back Rails 4 compatibility (and Rack 1.x applications, in general), also removes release candidate version constraint (both broken in #160). Moreover, ensures that tests are run against two major Sinatra versions, which should protect from compatibility issues in future, somewhat. Related issue: #159.
234
+ - Brings back Rails 4 compatibility (and Rack 1.x applications, in general), also removes release candidate version constraint (both broken in #160). Moreover, ensures that tests are run against two major Sinatra versions, which should protect from compatibility issues in the future, somewhat. Related issue: #159.
183
235
  - Thanks to [Sebastian Skałacki](https://github.com/skalee) for the pull request!
184
236
 
185
237
  ## [4.3.1] - 2017-4-12 ##
@@ -191,7 +243,7 @@ All notable changes to this project will be documented in this file.
191
243
  ## [4.3.0] - 2017-4-12 ##
192
244
  ### Added
193
245
  - #70: Adds an account settings management helper object
194
- - See the [helper README](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/settings) for details
246
+ - See the [helper README](lib/sendgrid/helpers/settings) for details
195
247
  - Thanks to [Kyle Kern](https://github.com/kernkw) for the pull request!
196
248
 
197
249
  ## [4.2.1] - 2017-4-10 ##
@@ -201,8 +253,8 @@ All notable changes to this project will be documented in this file.
201
253
 
202
254
  ## [4.2.0] - 2017-4-10 ##
203
255
  ### Added
204
- - #148: Set api_key to empty string
205
- - This makes creating an API key for a SendGrid subuser who does not have an API key easier. See #146 for details
256
+ - #148: Set api_key to an empty string
257
+ - This makes creating an API key for a SendGrid sub-user who does not have an API key easier. See #146 for details
206
258
  - Thanks to [Adam Beck](https://github.com/Gwash3189) for the pull request!
207
259
 
208
260
  ## [4.1.1] - 2017-4-6 ##
@@ -243,7 +295,7 @@ All notable changes to this project will be documented in this file.
243
295
  ## [4.0.3] - 2016-08-24 ##
244
296
  ### Added
245
297
  - Table of Contents in the README
246
- - Added a [USE_CASES.md](https://github.com/sendgrid/sendgrid-ruby/blob/master/USE_CASES.md) section, with the first use case example for transactional templates
298
+ - Added a [USE_CASES.md](USE_CASES.md) section, with the first use case example for transactional templates
247
299
 
248
300
  ## [4.0.2] - 2016-07-26 ##
249
301
  ### Fixed
@@ -251,7 +303,7 @@ All notable changes to this project will be documented in this file.
251
303
 
252
304
  ## [4.0.1] - 2016-07-25 ##
253
305
  ### Added
254
- - [Troubleshooting](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md) section
306
+ - [Troubleshooting](TROUBLESHOOTING.md) section
255
307
 
256
308
  ## [4.0.0] - 2016-07-23 ##
257
309
  ### BREAKING CHANGE
@@ -17,9 +17,6 @@ Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid o
17
17
  - [Creating a Pull Request](#creating-a-pull-request)
18
18
  - [Code Reviews](#code-reviews)
19
19
 
20
- <a name="roadmap"></a>
21
- We use [Milestones](https://github.com/sendgrid/sendgrid-ruby/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged.
22
-
23
20
  There are a few ways to contribute, which we'll enumerate below:
24
21
 
25
22
  <a name="feature-request"></a>
@@ -42,7 +39,7 @@ A software bug is a demonstrable issue in the code base. In order for us to diag
42
39
  Before you decide to create a new issue, please try the following:
43
40
 
44
41
  1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
45
- 2. Update to the latest version of this code and check if issue has already been fixed
42
+ 2. Update to the latest version of this code and check if an issue has already been fixed
46
43
  3. Copy and fill in the Bug Report Template we have provided below
47
44
 
48
45
  ### Please use our Bug Report Template
@@ -93,7 +90,7 @@ source ./sendgrid.env
93
90
 
94
91
  ##### Execute: #####
95
92
 
96
- See the [examples folder](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples) to get started quickly.
93
+ See the [examples folder](examples) to get started quickly.
97
94
 
98
95
  To run the examples using the local version of this library from the root directory of this repo, please replace:
99
96
 
@@ -124,20 +121,13 @@ Tests for the mail send and Web API v3 endpoints.
124
121
 
125
122
  The Web API v3 client is `sendgrid-ruby.rb`
126
123
 
127
- <a name="testing"></a>
128
124
  ## Testing
129
125
 
130
- All PRs require passing tests before the PR will be reviewed.
131
-
132
- All test files are in the [`tests`](https://github.com/sendgrid/sendgrid-ruby/tree/master/test) directory.
126
+ All PRs require passing tests before the PR will be reviewed. All test files are in the [`tests`](test) directory. For the purposes of contributing to this repo, please update the [`test_sendgrid-ruby.rb`](test/sendgrid/test_sendgrid-ruby.rb) file with unit tests as you modify the code.
133
127
 
134
- For the purposes of contributing to this repo, please update the [`test_sendgrid-ruby.rb`](https://github.com/sendgrid/sendgrid-ruby/blob/master/test/test_sendgrid-ruby.rb) file with unit tests as you modify the code.
128
+ The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`.
135
129
 
136
- To run the tests:
137
-
138
- ```bash
139
- rake
140
- ```
130
+ Once these are available, simply execute the Docker test target to run all tests: `make test-docker`. This command can also be used to open an interactive shell into the container where this library is installed. To start a *bash* shell for example, use this command: `command=bash make test-docker`.
141
131
 
142
132
  <a name="style-guidelines-and-naming-conventions"></a>
143
133
  ## Style Guidelines & Naming Conventions
@@ -159,10 +149,10 @@ Please run your code through:
159
149
  ```bash
160
150
  # Clone your fork of the repo into the current directory
161
151
  git clone https://github.com/sendgrid/sendgrid-ruby
162
-
152
+
163
153
  # Navigate to the newly cloned directory
164
154
  cd sendgrid-ruby
165
-
155
+
166
156
  # Assign the original repo to a remote called "upstream"
167
157
  git remote add upstream https://github.com/sendgrid/sendgrid-ruby
168
158
  ```
@@ -183,7 +173,7 @@ Please run your code through:
183
173
 
184
174
  4. Commit your changes in logical chunks. Please adhere to these [git commit
185
175
  message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
186
- or your code is unlikely be merged into the main project. Use Git's
176
+ or your code is unlikely to be merged into the main project. Use Git's
187
177
  [interactive rebase](https://help.github.com/articles/interactive-rebase)
188
178
  feature to tidy up your commits before making them public.
189
179
 
@@ -194,7 +184,7 @@ Please run your code through:
194
184
  5. Locally merge (or rebase) the upstream development branch into your topic branch:
195
185
 
196
186
  ```bash
197
- git pull [--rebase] upstream master
187
+ git pull [--rebase] upstream main
198
188
  ```
199
189
 
200
190
  6. Push your topic branch up to your fork:
@@ -204,7 +194,7 @@ Please run your code through:
204
194
  ```
205
195
 
206
196
  7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
207
- with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
197
+ with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
208
198
 
209
199
  <a name="code-reviews"></a>
210
200
  ## Code Reviews
@@ -0,0 +1,79 @@
1
+ # How To Contribute to Twilio SendGrid Repositories via GitHub
2
+ Contributing to the Twilio SendGrid repositories is easy! All you need to do is find an open issue (see the bottom of this page for a list of repositories containing open issues), fix it and submit a pull request. Once you have submitted your pull request, the team can easily review it before it is merged into the repository.
3
+
4
+ To make a pull request, follow these steps:
5
+
6
+ 1. Log into GitHub. If you do not already have a GitHub account, you will have to create one in order to submit a change. Click the Sign up link in the upper right-hand corner to create an account. Enter your username, password, and email address. If you are an employee of Twilio SendGrid, please use your full name with your GitHub account and enter Twilio SendGrid as your company so we can easily identify you.
7
+
8
+ <img src="/static/img/github-sign-up.png" width="800">
9
+
10
+ 2. __[Fork](https://help.github.com/fork-a-repo/)__ the [sendgrid-ruby](https://github.com/sendgrid/sendgrid-ruby) repository:
11
+
12
+ <img src="/static/img/github-fork.png" width="800">
13
+
14
+ 3. __Clone__ your fork via the following commands:
15
+
16
+ ```bash
17
+ # Clone your fork of the repo into the current directory
18
+ git clone https://github.com/your_username/sendgrid-ruby
19
+ # Navigate to the newly cloned directory
20
+ cd sendgrid-ruby
21
+ # Assign the original repo to a remote called "upstream"
22
+ git remote add upstream https://github.com/sendgrid/sendgrid-ruby
23
+ ```
24
+
25
+ > Don't forget to replace *your_username* in the URL by your real GitHub username.
26
+
27
+ 4. __Create a new topic branch__ (off the main project development branch) to contain your feature, change, or fix:
28
+
29
+ ```bash
30
+ git checkout -b <topic-branch-name>
31
+ ```
32
+
33
+ 5. __Commit your changes__ in logical chunks.
34
+
35
+ Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public. Probably you will also have to create tests (if needed) or create or update the example code that demonstrates the functionality of this change to the code.
36
+
37
+ 6. __Locally merge (or rebase)__ the upstream development branch into your topic branch:
38
+
39
+ ```bash
40
+ git pull [--rebase] upstream main
41
+ ```
42
+
43
+ 7. __Push__ your topic branch up to your fork:
44
+
45
+ ```bash
46
+ git push origin <topic-branch-name>
47
+ ```
48
+
49
+ 8. __[Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository/)__ with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
50
+
51
+ ## Important notice
52
+
53
+ Before creating a pull request, make sure that you respect the repository's constraints regarding contributions. You can find them in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
54
+
55
+ ## Repositories with Open, Easy, Help Wanted, Issue Filters
56
+
57
+ * [Python SDK](https://github.com/sendgrid/sendgrid-python/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
58
+ * [PHP SDK](https://github.com/sendgrid/sendgrid-php/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
59
+ * [C# SDK](https://github.com/sendgrid/sendgrid-csharp/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
60
+ * [Ruby SDK](https://github.com/sendgrid/sendgrid-ruby/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
61
+ * [Node.js SDK](https://github.com/sendgrid/sendgrid-nodejs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
62
+ * [Java SDK](https://github.com/sendgrid/sendgrid-java/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
63
+ * [Go SDK](https://github.com/sendgrid/sendgrid-go/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
64
+ * [Python STMPAPI Client](https://github.com/sendgrid/smtpapi-python/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
65
+ * [PHP STMPAPI Client](https://github.com/sendgrid/smtpapi-php/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
66
+ * [C# STMPAPI Client](https://github.com/sendgrid/smtpapi-csharp/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
67
+ * [Ruby STMPAPI Client](https://github.com/sendgrid/smtpapi-ruby/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
68
+ * [Node.js STMPAPI Client](https://github.com/sendgrid/smtpapi-nodejs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
69
+ * [Java STMPAPI Client](https://github.com/sendgrid/smtpapi-java/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
70
+ * [Go STMPAPI Client](https://github.com/sendgrid/smtpapi-go/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
71
+ * [Python HTTP Client](https://github.com/sendgrid/python-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
72
+ * [PHP HTTP Client](https://github.com/sendgrid/php-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
73
+ * [C# HTTP Client](https://github.com/sendgrid/csharp-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
74
+ * [Java HTTP Client](https://github.com/sendgrid/java-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
75
+ * [Ruby HTTP Client](https://github.com/sendgrid/ruby-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
76
+ * [Go HTTP Client](https://github.com/sendgrid/rest/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
77
+ * [Open API Definition](https://github.com/sendgrid/sendgrid-oai/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
78
+ * [DX Automator](https://github.com/sendgrid/dx-automator/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
79
+ * [Documentation](https://github.com/sendgrid/docs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)