sendgrid-ruby 6.3.4 → 6.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b7ceda12fd42d78b3d9be742691aa04943810f7aaaeee00ebddded73004bb0b
-  data.tar.gz: c0dfae6e4e0a91ebf5816f8d2b4ce8dfcc4857be2e5d31dd1289f71b0b4f1845
+  metadata.gz: e029e78d950c6d118cf0444a43ea84aaaa93a7524fb35d22e0442e9a575ae18e
+  data.tar.gz: 136c50aab4d0f6561acccad706b2238eee7bc3d76d723055ce43f38fd4ef747a
 SHA512:
-  metadata.gz: 77d07eaf2f1b79970ec14246a185b97fb00b860831bad8db6570c8230d708f2621889eb10baeddf8f58deda706dc2ef88ba350a9fa0df25c135f03b28a8ba2db
-  data.tar.gz: 86c963fea6f7def49fbec7399c46862244cc9bf551f9b77894458311f676fe46b66be1b87621efcf4cee702dd9d136808df66d8727108aaea5e7e15b2b751d3d
+  metadata.gz: ff63561ef8b7ea73bf7125c3cd62803e0ffe50a73914fbd3736d7d3aed8a98c23f6f8b6a1ab7c07d9eefc5b1fabed78586d8d27bafd548c87d4f79f422eb430f
+  data.tar.gz: 3d7eb06f425f60994db736113f45c9db3406b63f4bc1ff1a6e7eadd6761f8a67ba98eda05cf6830eef40fd9143046219ec3e7fa9d5b58da8bc270eddf0809a68

data/.rubocop.yml

@@ -1,6 +1,4 @@
-AllCops:
-  Exclude:
-    - examples/**/*
-    - gemfiles/**/*
-    - spec/**/*
-    - test/**/*
+inherit_from: .rubocop_todo.yml
+
+Style/StringLiterals:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,109 @@
+# 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
+
+# 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

@@ -14,8 +14,7 @@ script: make test-docker
 
 deploy:
   provider: rubygems
-  api_key:
-    secure: CWlfN170i/fHPrIufHHLWQ0utjuhxf4ELSxKeypIuO2CNTqNMzocDAa2vxMt4XfO6d2wFPV/LC+IHR7i+sp7PKvjRoa4BLUUxjfBNDboc0gGESeUYlAxwsJo0tOVCNmpxgjQKqtPLz/19A/v/xpxLv2Im/9Idqa5ATd06sMDdM8=
+  api_key: $RUBYGEMS_API_KEY
   gem: sendgrid-ruby
   on:
     tags: true

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+[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**
@@ -171,7 +188,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 ##

data/CONTRIBUTING.md

@@ -17,9 +17,6 @@ Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid o
 - [Creating a Pull Request](#creating-a-pull-request)
 - [Code Reviews](#code-reviews)
 
-<a name="roadmap"></a>
-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.
-
 There are a few ways to contribute, which we'll enumerate below:
 
 <a name="feature-request"></a>
@@ -152,10 +149,10 @@ Please run your code through:
    ```bash
    # Clone your fork of the repo into the current directory
    git clone https://github.com/sendgrid/sendgrid-ruby
-   
+
    # Navigate to the newly cloned directory
    cd sendgrid-ruby
-   
+
    # Assign the original repo to a remote called "upstream"
    git remote add upstream https://github.com/sendgrid/sendgrid-ruby
    ```

data/Makefile

@@ -5,6 +5,7 @@ install:
 
 test:
 	bundle exec rake
+	rubocop
 
 test-integ: test
 

data/README.md

@@ -1,6 +1,6 @@
 ![Twilio SendGrid Logo](twilio_sendgrid_logo.png)
 
-[![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-ruby.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-ruby) 
+[![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-ruby.svg?branch=main)](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)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
@@ -31,7 +31,6 @@ We appreciate your continued support, thank you!
 * [Usage](#usage)
 * [Use Cases](#use_cases)
 * [Announcements](#announcements)
-* [Roadmap](#roadmap)
 * [How to Contribute](#contribute)
 * [Troubleshooting](#troubleshooting)
 * [About](#about)
@@ -195,11 +194,6 @@ Please see our announcement regarding [breaking changes](https://github.com/send
 
 All updates to this library are documented in our [CHANGELOG](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
-
-If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/sendgrid/sendgrid-ruby/issues) and [pull requests](https://github.com/sendgrid/sendgrid-ruby/pulls). We would love to hear your feedback.
-
 <a name="contribute"></a>
 # How to Contribute
 

data/Rakefile

@@ -10,6 +10,5 @@ end
 
 RSpec::Core::RakeTask.new(:spec)
 
-desc "Run tests"
-task default: [:spec, :test]
-
+desc 'Run tests'
+task default: %i[spec test]

data/USAGE.md

@@ -21,6 +21,7 @@ sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 * [CLIENTS](#clients)
 * [CONTACTDB](#contactdb)
 * [DEVICES](#devices)
+* [EMAIL ACTIVITY](#email-activity)
 * [GEO](#geo)
 * [IPS](#ips)
 * [MAIL](#mail)
@@ -1754,6 +1755,112 @@ puts response.status_code
 puts response.body
 puts response.headers
 ```
+
+<a name="email-activity"></a>
+# EMAIL ACTIVITY
+
+## Filter all messages
+> In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity).
+
+Filter all messages to search your Email Activity.
+
+Queries may need to be [URL encoded](https://meyerweb.com/eric/tools/dencoder/). URL encoding depends on how you're using the API - if you are trying it out here, or using one of the Libraries, we handle the encoding for you. If you are using cURL, or your own implementation, you probably need to encode it.
+
+Queries have this format:
+
+`query={query_type}="{query_content}"`
+
+encoded, this would look like this:
+
+`query=type%3D%22query_content%22`
+
+for example:
+
+Filter by a specific email - `query=to_email%3D%22example%40example.com%22`
+
+Filter by subject line - `query=subject%3d%22A%20Great%20Subject%22`
+
+You can filter by other operators besides `=`. We also accept `!=`, `<`, and `>`.
+
+For a tutorial on how to get started, check out [Getting Started with the Email Activity API](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html).
+
+For information about building combined queries, see [Building compound Email Activity queries](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html#-Creating-compound-queries).
+
+### GET /messages
+```ruby
+require 'erb'
+
+filter_key = 'to_email'
+filter_operator = ERB::Util.url_encode('=')
+filter_value = 'testing@sendgrid.net'
+filter_value = ERB::Util.url_encode(format('"%s"', filter_value))
+query_params = {}
+query_params['query'] = format("%s%s%s", filter_key, filter_operator, filter_value)
+query_params['limit'] = '1'
+
+params = query_params
+response = sg.client.messages.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+## Filter messages by message ID
+
+> In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity).
+
+Get all of the details about the specified message.
+
+### GET /messages/{msg_id}
+
+```ruby
+msg_id = "test_url_param"
+response = sg.client.messages._(msg_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+
+## Request a CSV
+
+### POST /messages/download
+
+> In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity).
+
+This request kicks of a process to generate a CSV file. When the file is generated, the email that is listed as the account owner gets an email that links out to the file that is ready for download. The link expires in 3 days.
+
+The CSV fill contain the last 1 million messages. This endpoint will be rate limited to 1 request every 12 hours.
+
+```ruby
+response = sg.client.messages.download.post()
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+## Download CSV
+
+### GET /messages/download/{download_uuid}
+
+> In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity).
+
+Download the CSV that you requested with the POST Request a CSV.
+
+When the file is generated, the email that is listed as the account owner gets an email that links out to the file that is ready for download. The link expires in 3 days.
+
+The CSV fill contain the last 1 million messages. This endpoint will be rate limited to 1 request every 12 hours.
+
+```ruby
+download_uuid = "test_url_param"
+response = sg.client.messages.download._(download_uuid).get
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+
+
 <a name="geo"></a>
 # GEO
 
@@ -3531,6 +3638,7 @@ puts response.status_code
 puts response.body
 puts response.headers
 ```
+
 ## Retrieve email statistics for your subusers.
 
 **This endpoint allows you to retrieve the email statistics for the given subusers.**
@@ -4144,9 +4252,9 @@ Transactional templates are templates created specifically for transactional ema
 
 ### GET /templates
 
-
 ```ruby
-response = sg.client.templates.get()
+params = JSON.parse('{"generations": "legacy,dynamic"}')
+response = sg.client.templates.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers

data/examples/accesssettings/accesssettings.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve all recent access attempts #
 # GET /access_settings/activity #
@@ -22,10 +20,10 @@ data = JSON.parse('{
   "ips": [
     {
       "ip": "192.168.1.1"
-    }, 
+    },
     {
       "ip": "192.*.*.*"
-    }, 
+    },
     {
       "ip": "192.168.1.3/32"
     }
@@ -40,7 +38,7 @@ puts response.headers
 # Retrieve a list of currently whitelisted IPs #
 # GET /access_settings/whitelist #
 
-response = sg.client.access_settings.whitelist.get()
+response = sg.client.access_settings.whitelist.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -51,8 +49,8 @@ puts response.headers
 
 data = JSON.parse('{
   "ids": [
-    1, 
-    2, 
+    1,
+    2,
     3
   ]
 }')
@@ -65,8 +63,8 @@ puts response.headers
 # Retrieve a specific whitelisted IP #
 # GET /access_settings/whitelist/{rule_id} #
 
-rule_id = "test_url_param"
-response = sg.client.access_settings.whitelist._(rule_id).get()
+rule_id = 'test_url_param'
+response = sg.client.access_settings.whitelist._(rule_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -75,9 +73,8 @@ puts response.headers
 # Remove a specific IP from the whitelist #
 # DELETE /access_settings/whitelist/{rule_id} #
 
-rule_id = "test_url_param"
-response = sg.client.access_settings.whitelist._(rule_id).delete()
+rule_id = 'test_url_param'
+response = sg.client.access_settings.whitelist._(rule_id).delete
 puts response.status_code
 puts response.body
 puts response.headers
-