sendgrid-ruby 6.2.0 → 6.6.2

data/examples/contactdb/contactdb.rb

@@ -1,15 +1,13 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Create a Custom Field #
 # POST /contactdb/custom_fields #
 
 data = JSON.parse('{
-  "name": "pet", 
+  "name": "pet",
   "type": "text"
 }')
 response = sg.client.contactdb.custom_fields.post(request_body: data)
@@ -21,7 +19,7 @@ puts response.headers
 # Retrieve all custom fields #
 # GET /contactdb/custom_fields #
 
-response = sg.client.contactdb.custom_fields.get()
+response = sg.client.contactdb.custom_fields.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -30,8 +28,8 @@ puts response.headers
 # Retrieve a Custom Field #
 # GET /contactdb/custom_fields/{custom_field_id} #
 
-custom_field_id = "test_url_param"
-response = sg.client.contactdb.custom_fields._(custom_field_id).get()
+custom_field_id = 'test_url_param'
+response = sg.client.contactdb.custom_fields._(custom_field_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -40,8 +38,8 @@ puts response.headers
 # Delete a Custom Field #
 # DELETE /contactdb/custom_fields/{custom_field_id} #
 
-custom_field_id = "test_url_param"
-response = sg.client.contactdb.custom_fields._(custom_field_id).delete()
+custom_field_id = 'test_url_param'
+response = sg.client.contactdb.custom_fields._(custom_field_id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -62,7 +60,7 @@ puts response.headers
 # Retrieve all lists #
 # GET /contactdb/lists #
 
-response = sg.client.contactdb.lists.get()
+response = sg.client.contactdb.lists.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -72,9 +70,9 @@ puts response.headers
 # DELETE /contactdb/lists #
 
 data = JSON.parse('[
-  1, 
-  2, 
-  3, 
+  1,
+  2,
+  3,
   4
 ]')
 response = sg.client.contactdb.lists.delete(request_body: data)
@@ -90,7 +88,7 @@ data = JSON.parse('{
   "name": "newlistname"
 }')
 params = JSON.parse('{"list_id": 1}')
-list_id = "test_url_param"
+list_id = 'test_url_param'
 response = sg.client.contactdb.lists._(list_id).patch(request_body: data, query_params: params)
 puts response.status_code
 puts response.body
@@ -101,7 +99,7 @@ puts response.headers
 # GET /contactdb/lists/{list_id} #
 
 params = JSON.parse('{"list_id": 1}')
-list_id = "test_url_param"
+list_id = 'test_url_param'
 response = sg.client.contactdb.lists._(list_id).get(query_params: params)
 puts response.status_code
 puts response.body
@@ -112,7 +110,7 @@ puts response.headers
 # DELETE /contactdb/lists/{list_id} #
 
 params = JSON.parse('{"delete_contacts": "true"}')
-list_id = "test_url_param"
+list_id = 'test_url_param'
 response = sg.client.contactdb.lists._(list_id).delete(query_params: params)
 puts response.status_code
 puts response.body
@@ -123,10 +121,10 @@ puts response.headers
 # POST /contactdb/lists/{list_id}/recipients #
 
 data = JSON.parse('[
-  "recipient_id1", 
+  "recipient_id1",
   "recipient_id2"
 ]')
-list_id = "test_url_param"
+list_id = 'test_url_param'
 response = sg.client.contactdb.lists._(list_id).recipients.post(request_body: data)
 puts response.status_code
 puts response.body
@@ -137,7 +135,7 @@ puts response.headers
 # GET /contactdb/lists/{list_id}/recipients #
 
 params = JSON.parse('{"page": 1, "page_size": 1, "list_id": 1}')
-list_id = "test_url_param"
+list_id = 'test_url_param'
 response = sg.client.contactdb.lists._(list_id).recipients.get(query_params: params)
 puts response.status_code
 puts response.body
@@ -147,9 +145,9 @@ puts response.headers
 # Add a Single Recipient to a List #
 # POST /contactdb/lists/{list_id}/recipients/{recipient_id} #
 
-list_id = "test_url_param"
-recipient_id = "test_url_param"
-response = sg.client.contactdb.lists._(list_id).recipients._(recipient_id).post()
+list_id = 'test_url_param'
+recipient_id = 'test_url_param'
+response = sg.client.contactdb.lists._(list_id).recipients._(recipient_id).post
 puts response.status_code
 puts response.body
 puts response.headers
@@ -159,8 +157,8 @@ puts response.headers
 # DELETE /contactdb/lists/{list_id}/recipients/{recipient_id} #
 
 params = JSON.parse('{"recipient_id": 1, "list_id": 1}')
-list_id = "test_url_param"
-recipient_id = "test_url_param"
+list_id = 'test_url_param'
+recipient_id = 'test_url_param'
 response = sg.client.contactdb.lists._(list_id).recipients._(recipient_id).delete(query_params: params)
 puts response.status_code
 puts response.body
@@ -172,8 +170,8 @@ puts response.headers
 
 data = JSON.parse('[
   {
-    "email": "jones@example.com", 
-    "first_name": "Guy", 
+    "email": "jones@example.com",
+    "first_name": "Guy",
     "last_name": "Jones"
   }
 ]')
@@ -188,15 +186,15 @@ puts response.headers
 
 data = JSON.parse('[
   {
-    "age": 25, 
-    "email": "example@example.com", 
-    "first_name": "", 
+    "age": 25,
+    "email": "example@example.com",
+    "first_name": "",
     "last_name": "User"
-  }, 
+  },
   {
-    "age": 25, 
-    "email": "example2@example.com", 
-    "first_name": "Example", 
+    "age": 25,
+    "email": "example2@example.com",
+    "first_name": "Example",
     "last_name": "User"
   }
 ]')
@@ -220,7 +218,7 @@ puts response.headers
 # DELETE /contactdb/recipients #
 
 data = JSON.parse('[
-  "recipient_id1", 
+  "recipient_id1",
   "recipient_id2"
 ]')
 response = sg.client.contactdb.recipients.delete(request_body: data)
@@ -232,7 +230,7 @@ puts response.headers
 # Retrieve the count of billable recipients #
 # GET /contactdb/recipients/billable_count #
 
-response = sg.client.contactdb.recipients.billable_count.get()
+response = sg.client.contactdb.recipients.billable_count.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -241,7 +239,7 @@ puts response.headers
 # Retrieve a Count of Recipients #
 # GET /contactdb/recipients/count #
 
-response = sg.client.contactdb.recipients.count.get()
+response = sg.client.contactdb.recipients.count.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -260,8 +258,8 @@ puts response.headers
 # Retrieve a single recipient #
 # GET /contactdb/recipients/{recipient_id} #
 
-recipient_id = "test_url_param"
-response = sg.client.contactdb.recipients._(recipient_id).get()
+recipient_id = 'test_url_param'
+response = sg.client.contactdb.recipients._(recipient_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -270,8 +268,8 @@ puts response.headers
 # Delete a Recipient #
 # DELETE /contactdb/recipients/{recipient_id} #
 
-recipient_id = "test_url_param"
-response = sg.client.contactdb.recipients._(recipient_id).delete()
+recipient_id = 'test_url_param'
+response = sg.client.contactdb.recipients._(recipient_id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -280,8 +278,8 @@ puts response.headers
 # Retrieve the lists that a recipient is on #
 # GET /contactdb/recipients/{recipient_id}/lists #
 
-recipient_id = "test_url_param"
-response = sg.client.contactdb.recipients._(recipient_id).lists.get()
+recipient_id = 'test_url_param'
+response = sg.client.contactdb.recipients._(recipient_id).lists.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -290,7 +288,7 @@ puts response.headers
 # Retrieve reserved fields #
 # GET /contactdb/reserved_fields #
 
-response = sg.client.contactdb.reserved_fields.get()
+response = sg.client.contactdb.reserved_fields.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -302,25 +300,25 @@ puts response.headers
 data = JSON.parse('{
   "conditions": [
     {
-      "and_or": "", 
-      "field": "last_name", 
-      "operator": "eq", 
+      "and_or": "",
+      "field": "last_name",
+      "operator": "eq",
       "value": "Miller"
-    }, 
+    },
     {
-      "and_or": "and", 
-      "field": "last_clicked", 
-      "operator": "gt", 
+      "and_or": "and",
+      "field": "last_clicked",
+      "operator": "gt",
       "value": "01/02/2015"
-    }, 
+    },
     {
-      "and_or": "or", 
-      "field": "clicks.campaign_identifier", 
-      "operator": "eq", 
+      "and_or": "or",
+      "field": "clicks.campaign_identifier",
+      "operator": "eq",
       "value": "513"
     }
-  ], 
-  "list_id": 4, 
+  ],
+  "list_id": 4,
   "name": "Last Name Miller"
 }')
 response = sg.client.contactdb.segments.post(request_body: data)
@@ -332,7 +330,7 @@ puts response.headers
 # Retrieve all segments #
 # GET /contactdb/segments #
 
-response = sg.client.contactdb.segments.get()
+response = sg.client.contactdb.segments.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -344,17 +342,17 @@ puts response.headers
 data = JSON.parse('{
   "conditions": [
     {
-      "and_or": "", 
-      "field": "last_name", 
-      "operator": "eq", 
+      "and_or": "",
+      "field": "last_name",
+      "operator": "eq",
       "value": "Miller"
     }
-  ], 
-  "list_id": 5, 
+  ],
+  "list_id": 5,
   "name": "The Millers"
 }')
 params = JSON.parse('{"segment_id": "test_string"}')
-segment_id = "test_url_param"
+segment_id = 'test_url_param'
 response = sg.client.contactdb.segments._(segment_id).patch(request_body: data, query_params: params)
 puts response.status_code
 puts response.body
@@ -365,7 +363,7 @@ puts response.headers
 # GET /contactdb/segments/{segment_id} #
 
 params = JSON.parse('{"segment_id": 1}')
-segment_id = "test_url_param"
+segment_id = 'test_url_param'
 response = sg.client.contactdb.segments._(segment_id).get(query_params: params)
 puts response.status_code
 puts response.body
@@ -376,7 +374,7 @@ puts response.headers
 # DELETE /contactdb/segments/{segment_id} #
 
 params = JSON.parse('{"delete_contacts": "true"}')
-segment_id = "test_url_param"
+segment_id = 'test_url_param'
 response = sg.client.contactdb.segments._(segment_id).delete(query_params: params)
 puts response.status_code
 puts response.body
@@ -387,9 +385,8 @@ puts response.headers
 # GET /contactdb/segments/{segment_id}/recipients #
 
 params = JSON.parse('{"page": 1, "page_size": 1}')
-segment_id = "test_url_param"
+segment_id = 'test_url_param'
 response = sg.client.contactdb.segments._(segment_id).recipients.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/devices/devices.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve email statistics by device type. #
 # GET /devices/stats #
@@ -13,4 +11,3 @@ response = sg.client.devices.stats.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/emailactivity/emailactivity.rb

@@ -0,0 +1,52 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Filter all messages #
+# GET /messages #
+
+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 #
+# GET /messages/{msg_id} #
+
+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 #
+
+response = sg.client.messages.download.post
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Download CSV #
+# GET /messages/download/{download_uuid} #
+
+download_uuid = "test_url_param"
+response = sg.client.messages.download._(download_uuid).get
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/geo/geo.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve email statistics by country and state/province. #
 # GET /geo/stats #
@@ -13,4 +11,3 @@ response = sg.client.geo.stats.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/helpers/eventwebhook/example.rb

@@ -0,0 +1,16 @@
+require 'sengrid-ruby'
+include SendGrid
+
+def is_valid_signature(request)
+  public_key = 'base64-encoded public key'
+
+  event_webhook = SendGrid::EventWebhook.new
+  ec_public_key = event_webhook.convert_public_key_to_ecdsa(public_key)
+
+  event_webhook.verify_signature(
+    ec_public_key,
+    request.body.read,
+    request.env[SendGrid::EventWebhookHeader::SIGNATURE],
+    request.env[SendGrid::EventWebhookHeader::TIMESTAMP]
+  )
+end

data/examples/helpers/mail/example.rb

@@ -11,13 +11,14 @@ def hello_world
   # puts JSON.pretty_generate(mail.to_json)
   puts mail.to_json
 
-  sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'], host: 'https://api.sendgrid.com')
+  sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
   response = sg.client.mail._('send').post(request_body: mail.to_json)
   puts response.status_code
   puts response.body
   puts response.headers
 end
 
+# rubocop:disable Metrics/AbcSize
 def kitchen_sink
   mail = SendGrid::Mail.new
   mail.from = Email.new(email: 'test@example.com')
@@ -29,6 +30,9 @@ def kitchen_sink
   personalization.add_cc(Email.new(email: 'test4@example.com', name: 'Example User'))
   personalization.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User'))
   personalization.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User'))
+  # Note, the domain of the from email property specified in any personalization must
+  # match the domain of the from email property specified at root level
+  personalization.add_from(Email.new(email: 'alias@example.com', name: "My alias"))
   personalization.subject = 'Hello World from the Personalized Twilio SendGrid Ruby Library'
   personalization.add_header(Header.new(key: 'X-Test', value: 'True'))
   personalization.add_header(Header.new(key: 'X-Mock', value: 'False'))
@@ -36,7 +40,7 @@ def kitchen_sink
   personalization.add_substitution(Substitution.new(key: '%city%', value: 'Denver'))
   personalization.add_custom_arg(CustomArg.new(key: 'user_id', value: '343'))
   personalization.add_custom_arg(CustomArg.new(key: 'type', value: 'marketing'))
-  personalization.send_at = 1443636843
+  personalization.send_at = 1_443_636_843
   mail.add_personalization(personalization)
 
   personalization2 = Personalization.new
@@ -53,7 +57,7 @@ def kitchen_sink
   personalization2.add_substitution(Substitution.new(key: '%city%', value: 'Denver'))
   personalization2.add_custom_arg(CustomArg.new(key: 'user_id', value: '343'))
   personalization2.add_custom_arg(CustomArg.new(key: 'type', value: 'marketing'))
-  personalization2.send_at = 1443636843
+  personalization2.send_at = 1_443_636_843
   mail.add_personalization(personalization2)
 
   mail.add_content(Content.new(type: 'text/plain', value: 'some text here'))
@@ -89,12 +93,12 @@ def kitchen_sink
   mail.add_custom_arg(CustomArg.new(key: 'campaign', value: 'welcome'))
   mail.add_custom_arg(CustomArg.new(key: 'weekday', value: 'morning'))
 
-  mail.send_at = 1443636842
+  mail.send_at = 1_443_636_842
 
   # This must be a valid [batch ID](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html) to work
   # mail.batch_id = 'sendgrid_batch_id'
 
-  mail.asm = ASM.new(group_id: 99, groups_to_display: [4,5,6,7,8])
+  mail.asm = ASM.new(group_id: 99, groups_to_display: [4, 5, 6, 7, 8])
 
   mail.ip_pool_name = '23'
 
@@ -118,30 +122,37 @@ def kitchen_sink
   # puts JSON.pretty_generate(mail.to_json)
   puts mail.to_json
 
-  sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'], host: 'https://api.sendgrid.com')
+  sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
   response = sg.client.mail._('send').post(request_body: mail.to_json)
   puts response.status_code
   puts response.body
   puts response.headers
 end
+# rubocop:enable Metrics/AbcSize
 
 def dynamic_template_data_hello_world
   mail = Mail.new
   mail.template_id = '' # a non-legacy template id
   mail.from = Email.new(email: 'test@example.com')
-  subject = 'Dynamic Template Data Hello World from the Twilio SendGrid Ruby Library'
-  mail.subject = subject
   personalization = Personalization.new
   personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
-  personalization.add_dynamic_template_data({
-    "variable" => [
-      {"foo" => "bar"}, {"foo" => "baz"}
+  personalization.add_dynamic_template_data(
+    'variable' => [
+      { 'foo' => 'bar' }, { 'foo' => 'baz' }
     ]
-  })
+  )
   mail.add_personalization(personalization)
+
+  # puts JSON.pretty_generate(mail.to_json)
+  puts mail.to_json
+
+  sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+  response = sg.client.mail._('send').post(request_body: mail.to_json)
+  puts response.status_code
+  puts response.body
+  puts response.headers
 end
 
 hello_world
 kitchen_sink
 dynamic_template_data_hello_world
-

data/examples/helpers/settings/example.rb

@@ -11,7 +11,7 @@ puts response.body
 puts response.headers
 
 # Turn on bcc settings
-response = settings.update_bcc(enabled: true, email: "email@example.com")
+response = settings.update_bcc(enabled: true, email: 'email@example.com')
 puts response.status_code
 puts response.body
 puts response.headers

data/examples/helpers/stats/example.rb

@@ -7,14 +7,14 @@ sg_client = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']).client
 stats = SendGrid::EmailStats.new(sendgrid_client: sg_client)
 
 # Fetch stats by day, between 2 dates
-from = Date.new(2017, 10, 01)
+from = Date.new(2017, 10, 1)
 to = Date.new(2017, 10, 12)
 
 email_stats = stats.by_day(from, to)
 
 email_stats.metrics
 
-if !email_stats.error?
+unless email_stats.error?
   email_stats.metrics.each do |metric|
     puts "Date - #{metric.date}"
     puts "Number of Requests - #{metric.requests}"
@@ -25,13 +25,13 @@ if !email_stats.error?
 end
 
 # Fetch stats by week, between 2 dates for a category
-from = Date.new(2017, 10, 01)
+from = Date.new(2017, 10, 1)
 to = Date.new(2017, 10, 12)
 category = 'abcd'
 
 email_stats = stats.by_week(from, to, category)
 
-if !email_stats.error?
+unless email_stats.error?
   email_stats.metrics.each do |metric|
     puts "Date - #{metric.date}"
     puts "Number of Requests - #{metric.requests}"