sendgrid-ruby 6.3.3 → 6.3.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +7 -5
- data/.rubocop_todo.yml +109 -0
- data/.travis.yml +2 -3
- data/CHANGELOG.md +54 -9
- data/CONTRIBUTING.md +8 -11
- data/FIRST_TIMERS.md +79 -0
- data/ISSUE_TEMPLATE.md +5 -1
- data/{LICENSE.md → LICENSE} +0 -0
- data/Makefile +2 -1
- data/PULL_REQUEST_TEMPLATE.md +5 -5
- data/README.md +24 -28
- data/Rakefile +2 -3
- data/TROUBLESHOOTING.md +5 -5
- data/USAGE.md +146 -39
- data/examples/accesssettings/accesssettings.rb +9 -12
- data/examples/alerts/alerts.rb +8 -11
- data/examples/apikeys/apikeys.rb +12 -15
- data/examples/asm/asm.rb +27 -30
- data/examples/browsers/browsers.rb +0 -3
- data/examples/campaigns/campaigns.rb +29 -32
- data/examples/categories/categories.rb +0 -3
- data/examples/clients/clients.rb +1 -4
- data/examples/contactdb/contactdb.rb +63 -66
- data/examples/devices/devices.rb +0 -3
- data/examples/emailactivity/emailactivity.rb +52 -0
- data/examples/geo/geo.rb +0 -3
- data/examples/helpers/eventwebhook/example.rb +4 -4
- data/examples/helpers/mail/example.rb +19 -13
- data/examples/helpers/settings/example.rb +1 -1
- data/examples/helpers/stats/example.rb +4 -4
- data/examples/ips/ips.rb +19 -22
- data/examples/mail/mail.rb +72 -75
- data/examples/mailboxproviders/mailboxproviders.rb +0 -3
- data/examples/mailsettings/mailsettings.rb +21 -24
- data/examples/partnersettings/partnersettings.rb +3 -6
- data/examples/scopes/scopes.rb +8 -10
- data/examples/senderauthentication/senderauthentication.rb +41 -44
- data/examples/senders/senders.rb +28 -31
- data/examples/stats/stats.rb +0 -3
- data/examples/subusers/subusers.rb +17 -20
- data/examples/suppression/suppression.rb +15 -18
- data/examples/templates/templates.rb +29 -31
- data/examples/trackingsettings/trackingsettings.rb +14 -17
- data/examples/user/user.rb +41 -44
- data/lib/rack/sendgrid_webhook_verification.rb +5 -2
- data/lib/sendgrid/base_interface.rb +2 -1
- data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb +4 -6
- data/lib/sendgrid/helpers/inbound/README.md +5 -5
- data/lib/sendgrid/helpers/inbound/app.rb +2 -2
- data/lib/sendgrid/helpers/inbound/public/index.html +1 -1
- data/lib/sendgrid/helpers/inbound/send.rb +3 -3
- data/lib/sendgrid/helpers/ip_management/ip_management.rb +1 -1
- data/lib/sendgrid/helpers/mail/README.md +3 -3
- data/lib/sendgrid/helpers/mail/asm.rb +6 -18
- data/lib/sendgrid/helpers/mail/attachment.rb +12 -42
- data/lib/sendgrid/helpers/mail/bcc_settings.rb +6 -18
- data/lib/sendgrid/helpers/mail/bypass_list_management.rb +8 -18
- data/lib/sendgrid/helpers/mail/category.rb +2 -2
- data/lib/sendgrid/helpers/mail/click_tracking.rb +6 -18
- data/lib/sendgrid/helpers/mail/content.rb +4 -3
- data/lib/sendgrid/helpers/mail/custom_arg.rb +6 -10
- data/lib/sendgrid/helpers/mail/email.rb +5 -4
- data/lib/sendgrid/helpers/mail/footer.rb +7 -27
- data/lib/sendgrid/helpers/mail/ganalytics.rb +10 -54
- data/lib/sendgrid/helpers/mail/header.rb +6 -10
- data/lib/sendgrid/helpers/mail/mail.rb +32 -48
- data/lib/sendgrid/helpers/mail/mail_settings.rb +9 -25
- data/lib/sendgrid/helpers/mail/open_tracking.rb +6 -18
- data/lib/sendgrid/helpers/mail/personalization.rb +34 -27
- data/lib/sendgrid/helpers/mail/section.rb +6 -10
- data/lib/sendgrid/helpers/mail/spam_check.rb +7 -27
- data/lib/sendgrid/helpers/mail/subscription_tracking.rb +8 -36
- data/lib/sendgrid/helpers/mail/substitution.rb +6 -10
- data/lib/sendgrid/helpers/mail/tracking_settings.rb +8 -20
- data/lib/sendgrid/helpers/permissions/scope.rb +2 -2
- data/lib/sendgrid/helpers/settings/README.md +2 -2
- data/lib/sendgrid/helpers/settings/settings.rb +1 -1
- data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb +3 -5
- data/lib/sendgrid/helpers/stats/metrics.rb +5 -5
- data/lib/sendgrid/sendgrid.rb +1 -1
- data/lib/sendgrid/twilio_email.rb +1 -1
- data/lib/sendgrid/version.rb +1 -1
- data/mail_helper_v3.md +12 -12
- data/sendgrid-ruby.gemspec +8 -9
- data/spec/fixtures/event_webhook.rb +17 -11
- data/spec/rack/sendgrid_webhook_verification_spec.rb +30 -4
- data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb +38 -36
- data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb +1 -1
- data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb +1 -1
- data/spec/sendgrid/helpers/settings/settings_spec.rb +2 -2
- data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb +1 -1
- data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb +1 -1
- data/spec/sendgrid/helpers/stats/email_stats_spec.rb +22 -23
- data/spec/sendgrid/helpers/stats/metrics_spec.rb +19 -20
- data/spec/sendgrid/helpers/stats/stats_response_spec.rb +22 -23
- data/spec/spec_helper.rb +1 -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 +4 -6
- data/test/sendgrid/helpers/mail/test_category.rb +0 -2
- data/test/sendgrid/helpers/mail/test_email.rb +9 -11
- data/test/sendgrid/helpers/mail/test_mail.rb +101 -102
- data/test/sendgrid/helpers/mail/test_personalizations.rb +106 -93
- data/test/sendgrid/permissions/test_scopes.rb +1 -3
- data/test/sendgrid/test_sendgrid-ruby.rb +1947 -1948
- data/twilio_sendgrid_logo.png +0 -0
- data/use-cases/domain-authentication.md +1 -1
- data/use-cases/email-statistics.md +1 -1
- data/use-cases/legacy-templates.md +1 -1
- data/use-cases/transactional-templates.md +1 -1
- metadata +42 -36
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 231e75f3472085398e06a26224f22343ef40adc73f9f122dbfd821673f4c0dac
|
4
|
+
data.tar.gz: 57528772f441e47a8daa7b0f334302ed4f7f65576c6e4de35a4eec6530786a4c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6260ae36de0b84530c0b981d4c741e9329ecbdbfe488507a9e8c20d9a5ed1096a1b1f2b364d8b2be0280b0c7cbcdd8b531897d5306744dc60b9a39b505b5c713
|
7
|
+
data.tar.gz: 1844bf3d5888b0dd6239cd9c426ac749bfdc8b9736459ba45caced4d79f77a69a8ab756e1bb7191cc9b1cd96849bf4ce53d5d8ac31a1d890d757497f1ace7b2b
|
data/.rubocop.yml
CHANGED
data/.rubocop_todo.yml
ADDED
@@ -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
|
data/.travis.yml
CHANGED
@@ -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 =
|
25
|
+
if: branch = main
|
27
26
|
on_pull_requests: false
|
28
27
|
on_success: never
|
29
28
|
on_failure: change
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,51 @@
|
|
1
1
|
# Change Log
|
2
2
|
All notable changes to this project will be documented in this file.
|
3
3
|
|
4
|
+
[2020-12-16] Version 6.3.8
|
5
|
+
--------------------------
|
6
|
+
**Library - Fix**
|
7
|
+
- [PR #448](https://github.com/sendgrid/sendgrid-ruby/pull/448): tests failing on rubocop rule. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
|
8
|
+
|
9
|
+
|
10
|
+
[2020-11-05] Version 6.3.7
|
11
|
+
--------------------------
|
12
|
+
**Library - Chore**
|
13
|
+
- [PR #447](https://github.com/sendgrid/sendgrid-ruby/pull/447): fix rubocop styling errors. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
|
14
|
+
|
15
|
+
|
16
|
+
[2020-10-14] Version 6.3.6
|
17
|
+
--------------------------
|
18
|
+
**Library - Fix**
|
19
|
+
- [PR #440](https://github.com/sendgrid/sendgrid-ruby/pull/440): reading position of a request body. Thanks to [@snaka](https://github.com/snaka)!
|
20
|
+
|
21
|
+
|
22
|
+
[2020-09-28] Version 6.3.5
|
23
|
+
--------------------------
|
24
|
+
**Library - Fix**
|
25
|
+
- [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)!
|
26
|
+
|
27
|
+
**Library - Docs**
|
28
|
+
- [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)!
|
29
|
+
- [PR #332](https://github.com/sendgrid/sendgrid-ruby/pull/332): Add Email activity API Documentation. Thanks to [@dhoeric](https://github.com/dhoeric)!
|
30
|
+
|
31
|
+
**Library - Test**
|
32
|
+
- [PR #315](https://github.com/sendgrid/sendgrid-ruby/pull/315): Add rubocop check to CI. Thanks to [@dipil-saud](https://github.com/dipil-saud)!
|
33
|
+
|
34
|
+
**Library - Chore**
|
35
|
+
- [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)!
|
36
|
+
- [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)!
|
37
|
+
|
38
|
+
|
39
|
+
[2020-08-19] Version 6.3.4
|
40
|
+
--------------------------
|
41
|
+
**Library - Docs**
|
42
|
+
- [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)!
|
43
|
+
- [PR #344](https://github.com/sendgrid/sendgrid-ruby/pull/344): Update example.rb. Thanks to [@kylearoberts](https://github.com/kylearoberts)!
|
44
|
+
|
45
|
+
**Library - Chore**
|
46
|
+
- [PR #432](https://github.com/sendgrid/sendgrid-ruby/pull/432): update GitHub branch references to use HEAD. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
|
47
|
+
|
48
|
+
|
4
49
|
[2020-07-22] Version 6.3.3
|
5
50
|
--------------------------
|
6
51
|
**Library - Chore**
|
@@ -120,7 +165,7 @@ All notable changes to this project will be documented in this file.
|
|
120
165
|
[2019-06-04] Version 6.0.0
|
121
166
|
--------------------------
|
122
167
|
### BREAKING CHANGE
|
123
|
-
- [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](
|
168
|
+
- [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!
|
124
169
|
|
125
170
|
### Added
|
126
171
|
- [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!
|
@@ -161,7 +206,7 @@ All notable changes to this project will be documented in this file.
|
|
161
206
|
|
162
207
|
## [5.2.0] - 2017-10-30 ##
|
163
208
|
### Added
|
164
|
-
- PR #234: Helpers for email statistics - global, category, subuser
|
209
|
+
- PR #234: Helpers for email statistics - global, category, subuser
|
165
210
|
- Thanks to [Awin Abi](https://github.com/awinabi) for the pull request!
|
166
211
|
|
167
212
|
## [5.1.0] - 2017-9-1 ##
|
@@ -187,7 +232,7 @@ All notable changes to this project will be documented in this file.
|
|
187
232
|
- `mail.headers` becomes `mail.add_header()`
|
188
233
|
- `mail.categories` becomes `mail.add_category()`
|
189
234
|
- `mail.custom_args` becomes `mail.custom_args()`
|
190
|
-
- For a full example of usage, please [see here](
|
235
|
+
- For a full example of usage, please [see here](examples/helpers/mail/example.rb#L21).
|
191
236
|
|
192
237
|
## [4.3.3] - 2017-5-2
|
193
238
|
### Update
|
@@ -198,7 +243,7 @@ All notable changes to this project will be documented in this file.
|
|
198
243
|
## [4.3.2] - 2017-5-1 ##
|
199
244
|
### Fixes
|
200
245
|
- #161: Fixed problematic Sinatra dependency
|
201
|
-
- 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.
|
246
|
+
- 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.
|
202
247
|
- Thanks to [Sebastian Skałacki](https://github.com/skalee) for the pull request!
|
203
248
|
|
204
249
|
## [4.3.1] - 2017-4-12 ##
|
@@ -210,7 +255,7 @@ All notable changes to this project will be documented in this file.
|
|
210
255
|
## [4.3.0] - 2017-4-12 ##
|
211
256
|
### Added
|
212
257
|
- #70: Adds an account settings management helper object
|
213
|
-
- See the [helper README](
|
258
|
+
- See the [helper README](lib/sendgrid/helpers/settings) for details
|
214
259
|
- Thanks to [Kyle Kern](https://github.com/kernkw) for the pull request!
|
215
260
|
|
216
261
|
## [4.2.1] - 2017-4-10 ##
|
@@ -220,8 +265,8 @@ All notable changes to this project will be documented in this file.
|
|
220
265
|
|
221
266
|
## [4.2.0] - 2017-4-10 ##
|
222
267
|
### Added
|
223
|
-
- #148: Set api_key to empty string
|
224
|
-
- This makes creating an API key for a SendGrid
|
268
|
+
- #148: Set api_key to an empty string
|
269
|
+
- This makes creating an API key for a SendGrid sub-user who does not have an API key easier. See #146 for details
|
225
270
|
- Thanks to [Adam Beck](https://github.com/Gwash3189) for the pull request!
|
226
271
|
|
227
272
|
## [4.1.1] - 2017-4-6 ##
|
@@ -262,7 +307,7 @@ All notable changes to this project will be documented in this file.
|
|
262
307
|
## [4.0.3] - 2016-08-24 ##
|
263
308
|
### Added
|
264
309
|
- Table of Contents in the README
|
265
|
-
- Added a [USE_CASES.md](
|
310
|
+
- Added a [USE_CASES.md](USE_CASES.md) section, with the first use case example for transactional templates
|
266
311
|
|
267
312
|
## [4.0.2] - 2016-07-26 ##
|
268
313
|
### Fixed
|
@@ -270,7 +315,7 @@ All notable changes to this project will be documented in this file.
|
|
270
315
|
|
271
316
|
## [4.0.1] - 2016-07-25 ##
|
272
317
|
### Added
|
273
|
-
- [Troubleshooting](
|
318
|
+
- [Troubleshooting](TROUBLESHOOTING.md) section
|
274
319
|
|
275
320
|
## [4.0.0] - 2016-07-23 ##
|
276
321
|
### BREAKING CHANGE
|
data/CONTRIBUTING.md
CHANGED
@@ -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](
|
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
|
|
@@ -126,7 +123,7 @@ The Web API v3 client is `sendgrid-ruby.rb`
|
|
126
123
|
|
127
124
|
## Testing
|
128
125
|
|
129
|
-
All PRs require passing tests before the PR will be reviewed. All test files are in the [`tests`](
|
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.
|
130
127
|
|
131
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`.
|
132
129
|
|
@@ -152,10 +149,10 @@ Please run your code through:
|
|
152
149
|
```bash
|
153
150
|
# Clone your fork of the repo into the current directory
|
154
151
|
git clone https://github.com/sendgrid/sendgrid-ruby
|
155
|
-
|
152
|
+
|
156
153
|
# Navigate to the newly cloned directory
|
157
154
|
cd sendgrid-ruby
|
158
|
-
|
155
|
+
|
159
156
|
# Assign the original repo to a remote called "upstream"
|
160
157
|
git remote add upstream https://github.com/sendgrid/sendgrid-ruby
|
161
158
|
```
|
@@ -176,7 +173,7 @@ Please run your code through:
|
|
176
173
|
|
177
174
|
4. Commit your changes in logical chunks. Please adhere to these [git commit
|
178
175
|
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
|
179
|
-
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
|
180
177
|
[interactive rebase](https://help.github.com/articles/interactive-rebase)
|
181
178
|
feature to tidy up your commits before making them public.
|
182
179
|
|
@@ -187,7 +184,7 @@ Please run your code through:
|
|
187
184
|
5. Locally merge (or rebase) the upstream development branch into your topic branch:
|
188
185
|
|
189
186
|
```bash
|
190
|
-
git pull [--rebase] upstream
|
187
|
+
git pull [--rebase] upstream main
|
191
188
|
```
|
192
189
|
|
193
190
|
6. Push your topic branch up to your fork:
|
@@ -197,7 +194,7 @@ Please run your code through:
|
|
197
194
|
```
|
198
195
|
|
199
196
|
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
|
200
|
-
with a clear title and description against the `
|
197
|
+
with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
|
201
198
|
|
202
199
|
<a name="code-reviews"></a>
|
203
200
|
## Code Reviews
|
data/FIRST_TIMERS.md
ADDED
@@ -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 SMTPAPI 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 SMTPAPI 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# SMTPAPI 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 SMTPAPI 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 SMTPAPI 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 SMTPAPI 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 SMTPAPI 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)
|
data/ISSUE_TEMPLATE.md
CHANGED
@@ -1,5 +1,9 @@
|
|
1
1
|
<!--
|
2
2
|
If this is a feature request, make sure you search Issues for an existing request before creating a new one!
|
3
|
+
|
4
|
+
Please utilize the template below to help us resolve your issue.
|
5
|
+
|
6
|
+
Note that many issues can be resolved by updating to the latest version.
|
3
7
|
-->
|
4
8
|
|
5
9
|
### Issue Summary
|
@@ -21,6 +25,6 @@ A summary of the issue and the environment in which it occurs. If suitable, incl
|
|
21
25
|
```
|
22
26
|
|
23
27
|
### Technical details:
|
24
|
-
* sendgrid-ruby version:
|
28
|
+
* sendgrid-ruby version:
|
25
29
|
* ruby version:
|
26
30
|
|