sendgrid-ruby 6.0.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2a951fe9149a9c9e1ca5e9c9ce053995bb80810c
-  data.tar.gz: e974acc6b662c335d35ad99702a173a70b656c0c
+SHA256:
+  metadata.gz: 8a77256d8db572200bdedd90a2b719d0f36d1a1aecbf17070968b555ed404028
+  data.tar.gz: 10081de69452a519515b2fe5f086460935cac375e1d3ade7528412477aab38a9
 SHA512:
-  metadata.gz: 9f51d4253bd7708337a981c2f196b4e37f3d8b092a469d11b7300815d3faef5bec7c6df32c98c1be8158dd71146d87d4983b560710d4d8715dcf0f1d55f6b62d
-  data.tar.gz: 7beeb7406e6e7b5370d42aa5d35b471bcab706b43bead079a58104cc4f641b19f7fa11ec6f17b95d7e0f371c5dde99832369b8fc2940457a907a64d214c0d0d2
+  metadata.gz: fa4e2a6a2cd904d43f1c32a57ecbc1ea7db0729fed4cab05303566515975661fd12bb0e1d3f92480b3101276019db4a1858dc060ff35a1055ff587dc5582d071
+  data.tar.gz: 10493d88b4836f3f90a8813dbe3bb6d40e141a3d0f1ed99adc35c34a308c7a149104b7bde9829c8bf5b5b1efb7e855ad1236fc43c5f6c444c656a1e6f740599c

data/.codeclimate.yml

@@ -16,6 +16,6 @@ ratings:
   - "**.rb"
 exclude_paths:
 - examples/
+- gemfiles/
 - spec/
 - test/
-- gemfiles/

data/.gitignore

@@ -39,3 +39,5 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+prism*

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+Style/StringLiterals:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,111 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-09-18 20:20:54 UTC using RuboCop version 0.91.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'sendgrid-ruby.gemspec'
+
+# Offense count: 22
+Lint/UselessAssignment:
+  Exclude:
+    - 'examples/scopes/scopes.rb'
+    - 'spec/rack/sendgrid_webhook_verification_spec.rb'
+
+# Offense count: 8
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 144
+
+# Offense count: 9
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 96
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 2006
+  Exclude:
+    - 'test/sendgrid/test_sendgrid-ruby.rb'
+
+# Offense count: 41
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 141
+
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 7
+
+# Offense count: 4
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# 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
+Naming/FileName:
+  Exclude:
+    - 'gemfiles/Sinatra_1.gemfile'
+    - 'gemfiles/Sinatra_2.gemfile'
+    - 'lib/sendgrid-ruby.rb'
+    - 'test/sendgrid/test_sendgrid-ruby.rb'
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/sendgrid/helpers/mail/personalization.rb'
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'examples/helpers/eventwebhook/example.rb'
+
+# Offense count: 35
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 4
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  Exclude:
+    - 'examples/emailactivity/emailactivity.rb'
+
+# Offense count: 97
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 6
+Style/MixinUsage:
+  Exclude:
+    - 'examples/helpers/eventwebhook/example.rb'
+    - 'examples/helpers/mail/example.rb'
+    - 'examples/helpers/settings/example.rb'
+    - 'examples/helpers/stats/example.rb'
+    - 'test/sendgrid/helpers/mail/test_attachment.rb'
+    - 'test/sendgrid/helpers/mail/test_mail.rb'
+
+# Offense count: 55
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 3211

data/.travis.yml

@@ -1,29 +1,30 @@
 language: ruby
-rvm:
-- 2.2.6
-- 2.3.4
-- 2.4.1
+env:
+  - version=ruby:2.7
+  - version=ruby:2.6
+  - version=ruby:2.5
+  - version=ruby:2.4
+  - version=jruby:9.2
+
 gemfile:
-- gemfiles/Sinatra_1.gemfile
-- gemfiles/Sinatra_2.gemfile
-before_script:
-- mkdir prism
-- mkdir prism/bin
-- export PATH=$PATH:$PWD/prism/bin/
-- ./test/prism.sh
+  - gemfiles/Sinatra_1.gemfile
+  - gemfiles/Sinatra_2.gemfile
+
+script: make test-docker
+
+deploy:
+  provider: rubygems
+  api_key: $RUBYGEMS_API_KEY
+  gem: sendgrid-ruby
+  on:
+    tags: true
+    condition: $version = ruby:2.4 && $BUNDLE_GEMFILE = *"gemfiles/Sinatra_1.gemfile"
+
 notifications:
-  hipchat:
+  slack:
+    if: branch = main
+    on_pull_requests: false
+    on_success: never
+    on_failure: change
     rooms:
-      secure: gYBEwOGBTxHE2nrxsHQqp2UdjRtCX04wVLYEimeT9RG/0LClS4nzJF7DaXLWlAwgLPmk+KV2+nXuLO5oausBr9ODmWhho8G0F90RPR47NupcvT1RM+I2ZbxSjHCUICL22mdnZd8ye/mrk/YtFWYmgmH7ILRK3BuYovXFoKoRnLg=
-    template:
-    - '<a href="https://travis-ci.org/%{repository}/builds/%{build_id}">%{repository}
-      Build %{build_number}</a> on branch <i>%{branch}</i> by %{author}: <strong>%{message}</strong>
-      <a href="https://github.com/sendgrid/%{repository}/commits/%{commit}">View on GitHub</a>'
-    format: html
-    notify: false
-script:
-    - rake test
-    - rake spec
-before_install:
-    - gem update bundler
-
+      - secure: QwoVrGveeA1bo/26fO2A+OQHmUX69NLaC214qd18C1Z8ztYMHkd05/9+k9HFb+PSdPkGLSeYOPWAKJUqJWB7HfGINNGpRGIPFcmfB7vhvvLFnhud/SAdQPRZ+SCeZPdpZcjpVRLYENKv259ucGPBCPFXh1HfJF92R0IrKeW5CII=

data/CHANGELOG.md

@@ -1,9 +1,184 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [6.0.0] - 2019-06-04 ##
+[2021-02-10] Version 6.4.0
+--------------------------
+**Library - Feature**
+- [PR #455](https://github.com/sendgrid/sendgrid-ruby/pull/455): Add http_options as a param in the SendGrid::API's constructor. Thanks to [@hoangtuanictvn](https://github.com/hoangtuanictvn)!
+
+
+[2021-01-27] Version 6.3.9
+--------------------------
+**Library - Fix**
+- [PR #446](https://github.com/sendgrid/sendgrid-ruby/pull/446): Accurate duplicate checking when adding email to Personalizations. Thanks to [@mito5525](https://github.com/mito5525)!
+- [PR #457](https://github.com/sendgrid/sendgrid-ruby/pull/457): email is required. Thanks to [@luk4s](https://github.com/luk4s)!
+
+
+[2020-12-16] Version 6.3.8
+--------------------------
+**Library - Fix**
+- [PR #448](https://github.com/sendgrid/sendgrid-ruby/pull/448): tests failing on rubocop rule. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+
+[2020-11-05] Version 6.3.7
+--------------------------
+**Library - Chore**
+- [PR #447](https://github.com/sendgrid/sendgrid-ruby/pull/447): fix rubocop styling errors. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+
+[2020-10-14] Version 6.3.6
+--------------------------
+**Library - Fix**
+- [PR #440](https://github.com/sendgrid/sendgrid-ruby/pull/440): reading position of a request body. Thanks to [@snaka](https://github.com/snaka)!
+
+
+[2020-09-28] Version 6.3.5
+--------------------------
+**Library - Fix**
+- [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)!
+
+**Library - Docs**
+- [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)!
+- [PR #332](https://github.com/sendgrid/sendgrid-ruby/pull/332): Add Email activity API Documentation. Thanks to [@dhoeric](https://github.com/dhoeric)!
+
+**Library - Test**
+- [PR #315](https://github.com/sendgrid/sendgrid-ruby/pull/315): Add rubocop check to CI. Thanks to [@dipil-saud](https://github.com/dipil-saud)!
+
+**Library - Chore**
+- [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)!
+- [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)!
+
+
+[2020-08-19] Version 6.3.4
+--------------------------
+**Library - Docs**
+- [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)!
+- [PR #344](https://github.com/sendgrid/sendgrid-ruby/pull/344): Update example.rb. Thanks to [@kylearoberts](https://github.com/kylearoberts)!
+
+**Library - Chore**
+- [PR #432](https://github.com/sendgrid/sendgrid-ruby/pull/432): update GitHub branch references to use HEAD. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+
+[2020-07-22] Version 6.3.3
+--------------------------
+**Library - Chore**
+- [PR #431](https://github.com/sendgrid/sendgrid-ruby/pull/431): migrate to new default sendgrid-oai branch. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+- [PR #366](https://github.com/sendgrid/sendgrid-ruby/pull/366): add Rubocop configuration file. Thanks to [@RolandBurrows](https://github.com/RolandBurrows)!
+
+**Library - Test**
+- [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)!
+
+**Library - Docs**
+- [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)!
+
+
+[2020-07-08] Version 6.3.2
+--------------------------
+**Library - Test**
+- [PR #368](https://github.com/sendgrid/sendgrid-ruby/pull/368): add Simplecov Local Enhancements. Thanks to [@RolandBurrows](https://github.com/RolandBurrows)!
+
+
+[2020-06-25] Version 6.3.1
+--------------------------
+
+
+[2020-06-24] Version 6.3.0
+--------------------------
+**Library - Feature**
+- [PR #428](https://github.com/sendgrid/sendgrid-ruby/pull/428): adds rack middleware to make request verification easier in rack apps. Thanks to [@philnash](https://github.com/philnash)!
+- [PR #425](https://github.com/sendgrid/sendgrid-ruby/pull/425): verify signature from event webhook. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+**Library - Fix**
+- [PR #427](https://github.com/sendgrid/sendgrid-ruby/pull/427): drop the starkbank dependency. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-05-13] Version 6.2.1
+--------------------------
+**Library - Fix**
+- [PR #421](https://github.com/sendgrid/sendgrid-ruby/pull/421): migrate to common prism setup. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-04-29] Version 6.2.0
+--------------------------
+**Library - Feature**
+- [PR #417](https://github.com/sendgrid/sendgrid-ruby/pull/417): add support for Twilio Email. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-04-15] Version 6.1.4
+--------------------------
+**Library - Fix**
+- [PR #416](https://github.com/sendgrid/sendgrid-ruby/pull/416): correct the User-Agent casing. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-04-01] Version 6.1.3
+--------------------------
+**Library - Docs**
+- [PR #414](https://github.com/sendgrid/sendgrid-ruby/pull/414): support verbiage for login issues. Thanks to [@adamchasetaylor](https://github.com/adamchasetaylor)!
+
+**Library - Chore**
+- [PR #413](https://github.com/sendgrid/sendgrid-ruby/pull/413): upgrade rake dev dependency. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-03-18] Version 6.1.2
+--------------------------
+**Library - Chore**
+- [PR #337](https://github.com/sendgrid/sendgrid-ruby/pull/337): Remove unnecessary require statements. Thanks to [@moutten](https://github.com/moutten)!
+- [PR #354](https://github.com/sendgrid/sendgrid-ruby/pull/354): Update Dockerfile ruby version. Thanks to [@Rovel](https://github.com/Rovel)!
+
+**Library - Fix**
+- [PR #412](https://github.com/sendgrid/sendgrid-ruby/pull/412): loosen the ruby_http_client version constraint. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-03-04] Version 6.1.1
+--------------------------
+**Library - Docs**
+- [PR #375](https://github.com/sendgrid/sendgrid-ruby/pull/375): update bug template URL. Thanks to [@divyanshu-rawat](https://github.com/divyanshu-rawat)!
+- [PR #385](https://github.com/sendgrid/sendgrid-ruby/pull/385): Remove announcements (the job posting is filled?). Thanks to [@deyton](https://github.com/deyton)!
+
+**Library - Chore**
+- [PR #409](https://github.com/sendgrid/sendgrid-ruby/pull/409): bump `bundler` version to 2.1.2. Thanks to [@chhhris](https://github.com/chhhris)!
+- [PR #408](https://github.com/sendgrid/sendgrid-ruby/pull/408): add Ruby 2.7 to Travis. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-02-19] Version 6.1.0
+--------------------------
+**Library - Feature**
+- [PR #405](https://github.com/sendgrid/sendgrid-ruby/pull/405): Use latest SendGrid HTTP Client. Thanks to [@saveav](https://github.com/saveav)!
+
+
+[2020-01-22] Version 6.0.4
+--------------------------
+**Library - Fix**
+- [PR #404](https://github.com/sendgrid/sendgrid-ruby/pull/404): add skip_cleanup flag to fix travis deploy. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+
+[2020-01-22] Version 6.0.3
+--------------------------
+**Library - Docs**
+- [PR #402](https://github.com/sendgrid/sendgrid-ruby/pull/402): baseline all the templated markdown docs. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-01-08] Version 6.0.2
+--------------------------
+**Library - Fix**
+- [PR #401](https://github.com/sendgrid/sendgrid-ruby/pull/401): Only try to deploy once to rubygems. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+
+[2020-01-03] Version 6.0.1
+--------------------------
+**Library - Chore**
+- [PR #400](https://github.com/sendgrid/sendgrid-ruby/pull/400): Add auto-deploy to travis.yml. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #399](https://github.com/sendgrid/sendgrid-ruby/pull/399): Add testing to Makefile. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #396](https://github.com/sendgrid/sendgrid-ruby/pull/396): Adding Makefile to assist with automation. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+**Library - Fix**
+- [PR #321](https://github.com/sendgrid/sendgrid-ruby/pull/321): TROUBLESHOOTING.md broken link fix. Thanks to [@arshadkazmi42](https://github.com/arshadkazmi42)!
+
+
+[2019-06-04] Version 6.0.0
+--------------------------
 ### BREAKING CHANGE
-- [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!
+- [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!
 
 ### Added
 - [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!
@@ -44,7 +219,7 @@ All notable changes to this project will be documented in this file.
 
 ## [5.2.0] - 2017-10-30 ##
 ### Added
-- PR #234: Helpers for email statistics - global, category, subuser 
+- PR #234: Helpers for email statistics - global, category, subuser
 - Thanks to [Awin Abi](https://github.com/awinabi) for the pull request!
 
 ## [5.1.0] - 2017-9-1 ##
@@ -70,7 +245,7 @@ All notable changes to this project will be documented in this file.
 - `mail.headers` becomes `mail.add_header()`
 - `mail.categories` becomes `mail.add_category()`
 - `mail.custom_args` becomes `mail.custom_args()`
-- For a full example of usage, please [see here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/helpers/mail/example.rb#L21).
+- For a full example of usage, please [see here](examples/helpers/mail/example.rb#L21).
 
 ## [4.3.3] - 2017-5-2
 ### Update
@@ -81,7 +256,7 @@ All notable changes to this project will be documented in this file.
 ## [4.3.2] - 2017-5-1 ##
 ### Fixes
 - #161: Fixed problematic Sinatra dependency
-- 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.
+- 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.
 - Thanks to [Sebastian Skałacki](https://github.com/skalee) for the pull request!
 
 ## [4.3.1] - 2017-4-12 ##
@@ -93,7 +268,7 @@ All notable changes to this project will be documented in this file.
 ## [4.3.0] - 2017-4-12 ##
 ### Added
 - #70: Adds an account settings management helper object
-- See the [helper README](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/settings) for details
+- See the [helper README](lib/sendgrid/helpers/settings) for details
 - Thanks to [Kyle Kern](https://github.com/kernkw) for the pull request!
 
 ## [4.2.1] - 2017-4-10 ##
@@ -103,8 +278,8 @@ All notable changes to this project will be documented in this file.
 
 ## [4.2.0] - 2017-4-10 ##
 ### Added
-- #148: Set api_key to empty string
-- This makes creating an API key for a SendGrid subuser who does not have an API key easier. See #146 for details
+- #148: Set api_key to an empty string
+- This makes creating an API key for a SendGrid sub-user who does not have an API key easier. See #146 for details
 - Thanks to [Adam Beck](https://github.com/Gwash3189) for the pull request!
 
 ## [4.1.1] - 2017-4-6 ##
@@ -145,7 +320,7 @@ All notable changes to this project will be documented in this file.
 ## [4.0.3] - 2016-08-24 ##
 ### Added
 - Table of Contents in the README
-- 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
+- Added a [USE_CASES.md](USE_CASES.md) section, with the first use case example for transactional templates
 
 ## [4.0.2] - 2016-07-26 ##
 ### Fixed
@@ -153,7 +328,7 @@ All notable changes to this project will be documented in this file.
 
 ## [4.0.1] - 2016-07-25 ##
 ### Added
-- [Troubleshooting](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md) section
+- [Troubleshooting](TROUBLESHOOTING.md) section
 
 ## [4.0.0] - 2016-07-23 ##
 ### BREAKING CHANGE