sendgrid-ruby 6.3.2 → 6.3.7

data/examples/helpers/eventwebhook/example.rb

@@ -8,9 +8,9 @@ def is_valid_signature(request)
   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]
+    ec_public_key,
+    request.body.read,
+    request.env[SendGrid::EventWebhookHeader::SIGNATURE],
+    request.env[SendGrid::EventWebhookHeader::TIMESTAMP]
   )
 end

data/examples/helpers/mail/example.rb

@@ -11,7 +11,7 @@ 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
@@ -36,7 +36,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 +53,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 +89,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,7 +118,7 @@ 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
@@ -129,19 +129,25 @@ 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}"

data/examples/ips/ips.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve all IP addresses #
 # GET /ips #
@@ -18,7 +16,7 @@ puts response.headers
 # Retrieve all assigned IPs #
 # GET /ips/assigned #
 
-response = sg.client.ips.assigned.get()
+response = sg.client.ips.assigned.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -30,7 +28,7 @@ puts response.headers
 params = {}
 response = sg.client.ips.get(query_params: params)
 all_ips = JSON.parse(response.body)
-unassigned_ips = all_ips.select {|ip| ip.subusers.empty?}
+unassigned_ips = all_ips.select { |ip| ip.subusers.empty? }
 puts response.status_code
 puts response.body
 puts unassigned_ips
@@ -52,7 +50,7 @@ puts response.headers
 # Retrieve all IP pools. #
 # GET /ips/pools #
 
-response = sg.client.ips.pools.get()
+response = sg.client.ips.pools.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -64,7 +62,7 @@ puts response.headers
 data = JSON.parse('{
   "name": "new_pool_name"
 }')
-pool_name = "test_url_param"
+pool_name = 'test_url_param'
 response = sg.client.ips.pools._(pool_name).put(request_body: data)
 puts response.status_code
 puts response.body
@@ -74,8 +72,8 @@ puts response.headers
 # Retrieve all IPs in a specified pool. #
 # GET /ips/pools/{pool_name} #
 
-pool_name = "test_url_param"
-response = sg.client.ips.pools._(pool_name).get()
+pool_name = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -84,8 +82,8 @@ puts response.headers
 # Delete an IP pool. #
 # DELETE /ips/pools/{pool_name} #
 
-pool_name = "test_url_param"
-response = sg.client.ips.pools._(pool_name).delete()
+pool_name = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -97,7 +95,7 @@ puts response.headers
 data = JSON.parse('{
   "ip": "0.0.0.0"
 }')
-pool_name = "test_url_param"
+pool_name = 'test_url_param'
 response = sg.client.ips.pools._(pool_name).ips.post(request_body: data)
 puts response.status_code
 puts response.body
@@ -107,9 +105,9 @@ puts response.headers
 # Remove an IP address from a pool. #
 # DELETE /ips/pools/{pool_name}/ips/{ip} #
 
-pool_name = "test_url_param"
-ip = "test_url_param"
-response = sg.client.ips.pools._(pool_name).ips._(ip).delete()
+pool_name = 'test_url_param'
+ip = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).ips._(ip).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -130,7 +128,7 @@ puts response.headers
 # Retrieve all IPs currently in warmup #
 # GET /ips/warmup #
 
-response = sg.client.ips.warmup.get()
+response = sg.client.ips.warmup.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -139,8 +137,8 @@ puts response.headers
 # Retrieve warmup status for a specific IP address #
 # GET /ips/warmup/{ip_address} #
 
-ip_address = "test_url_param"
-response = sg.client.ips.warmup._(ip_address).get()
+ip_address = 'test_url_param'
+response = sg.client.ips.warmup._(ip_address).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -149,8 +147,8 @@ puts response.headers
 # Remove an IP from warmup #
 # DELETE /ips/warmup/{ip_address} #
 
-ip_address = "test_url_param"
-response = sg.client.ips.warmup._(ip_address).delete()
+ip_address = 'test_url_param'
+response = sg.client.ips.warmup._(ip_address).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -159,9 +157,8 @@ puts response.headers
 # Retrieve all IP pools an IP address belongs to #
 # GET /ips/{ip_address} #
 
-ip_address = "test_url_param"
-response = sg.client.ips._(ip_address).get()
+ip_address = 'test_url_param'
+response = sg.client.ips._(ip_address).get
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/mail/mail.rb

@@ -1,14 +1,12 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Create a batch ID #
 # POST /mail/batch #
 
-response = sg.client.mail.batch.post()
+response = sg.client.mail.batch.post
 puts response.status_code
 puts response.body
 puts response.headers
@@ -17,8 +15,8 @@ puts response.headers
 # Validate batch ID #
 # GET /mail/batch/{batch_id} #
 
-batch_id = "test_url_param"
-response = sg.client.mail.batch._(batch_id).get()
+batch_id = 'test_url_param'
+response = sg.client.mail.batch._(batch_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -26,148 +24,147 @@ puts response.headers
 ##################################################
 # v3 Mail Send #
 # POST /mail/send #
-# This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/lib/helpers/mail/README.md).
+# This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-ruby/blob/HEAD/lib/sendgrid/helpers/mail/README.md).
 
 data = JSON.parse('{
   "asm": {
-    "group_id": 1, 
+    "group_id": 1,
     "groups_to_display": [
-      1, 
-      2, 
+      1,
+      2,
       3
     ]
-  }, 
+  },
   "attachments": [
     {
-      "content": "[BASE64 encoded content block here]", 
-      "content_id": "ii_139db99fdb5c3704", 
-      "disposition": "inline", 
-      "filename": "file1.jpg", 
-      "name": "file1", 
+      "content": "[BASE64 encoded content block here]",
+      "content_id": "ii_139db99fdb5c3704",
+      "disposition": "inline",
+      "filename": "file1.jpg",
+      "name": "file1",
       "type": "jpg"
     }
-  ], 
-  "batch_id": "[YOUR BATCH ID GOES HERE]", 
+  ],
+  "batch_id": "[YOUR BATCH ID GOES HERE]",
   "categories": [
-    "category1", 
+    "category1",
     "category2"
-  ], 
+  ],
   "content": [
     {
-      "type": "text/html", 
+      "type": "text/html",
       "value": "<html><p>Hello, world!</p><img src=[CID GOES HERE]></img></html>"
     }
-  ], 
+  ],
   "custom_args": {
-    "New Argument 1": "New Value 1", 
-    "activationAttempt": "1", 
+    "New Argument 1": "New Value 1",
+    "activationAttempt": "1",
     "customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
-  }, 
+  },
   "from": {
-    "email": "sam.smith@example.com", 
+    "email": "sam.smith@example.com",
     "name": "Sam Smith"
-  }, 
-  "headers": {}, 
-  "ip_pool_name": "[YOUR POOL NAME GOES HERE]", 
+  },
+  "headers": {},
+  "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
   "mail_settings": {
     "bcc": {
-      "email": "ben.doe@example.com", 
+      "email": "ben.doe@example.com",
       "enable": true
-    }, 
+    },
     "bypass_list_management": {
       "enable": true
-    }, 
+    },
     "footer": {
-      "enable": true, 
-      "html": "<p>Thanks</br>The Twilio SendGrid Team</p>", 
+      "enable": true,
+      "html": "<p>Thanks</br>The Twilio SendGrid Team</p>",
       "text": "Thanks,/n The Twilio SendGrid Team"
-    }, 
+    },
     "sandbox_mode": {
       "enable": false
-    }, 
+    },
     "spam_check": {
-      "enable": true, 
-      "post_to_url": "http://example.com/compliance", 
+      "enable": true,
+      "post_to_url": "http://example.com/compliance",
       "threshold": 3
     }
-  }, 
+  },
   "personalizations": [
     {
       "bcc": [
         {
-          "email": "sam.doe@example.com", 
+          "email": "sam.doe@example.com",
           "name": "Sam Doe"
         }
-      ], 
+      ],
       "cc": [
         {
-          "email": "jane.doe@example.com", 
+          "email": "jane.doe@example.com",
           "name": "Jane Doe"
         }
-      ], 
+      ],
       "custom_args": {
-        "New Argument 1": "New Value 1", 
-        "activationAttempt": "1", 
+        "New Argument 1": "New Value 1",
+        "activationAttempt": "1",
         "customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
-      }, 
+      },
       "headers": {
-        "X-Accept-Language": "en", 
+        "X-Accept-Language": "en",
         "X-Mailer": "MyApp"
-      }, 
-      "send_at": 1409348513, 
-      "subject": "Hello, World!", 
+      },
+      "send_at": 1409348513,
+      "subject": "Hello, World!",
       "substitutions": {
-        "id": "substitutions", 
+        "id": "substitutions",
         "type": "object"
-      }, 
+      },
       "to": [
         {
-          "email": "john.doe@example.com", 
+          "email": "john.doe@example.com",
           "name": "John Doe"
         }
       ]
     }
-  ], 
+  ],
   "reply_to": {
-    "email": "sam.smith@example.com", 
+    "email": "sam.smith@example.com",
     "name": "Sam Smith"
-  }, 
+  },
   "sections": {
     "section": {
-      ":sectionName1": "section 1 text", 
+      ":sectionName1": "section 1 text",
       ":sectionName2": "section 2 text"
     }
-  }, 
-  "send_at": 1409348513, 
-  "subject": "Hello, World!", 
-  "template_id": "[YOUR TEMPLATE ID GOES HERE]", 
+  },
+  "send_at": 1409348513,
+  "subject": "Hello, World!",
+  "template_id": "[YOUR TEMPLATE ID GOES HERE]",
   "tracking_settings": {
     "click_tracking": {
-      "enable": true, 
+      "enable": true,
       "enable_text": true
-    }, 
+    },
     "ganalytics": {
-      "enable": true, 
-      "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]", 
-      "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]", 
-      "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]", 
-      "utm_name": "[NAME OF YOUR CAMPAIGN]", 
+      "enable": true,
+      "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]",
+      "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]",
+      "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]",
+      "utm_name": "[NAME OF YOUR CAMPAIGN]",
       "utm_term": "[IDENTIFY PAID KEYWORDS HERE]"
-    }, 
+    },
     "open_tracking": {
-      "enable": true, 
+      "enable": true,
       "substitution_tag": "%opentrack"
-    }, 
+    },
     "subscription_tracking": {
-      "enable": true, 
-      "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.", 
-      "substitution_tag": "<%click here%>", 
+      "enable": true,
+      "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
+      "substitution_tag": "<%click here%>",
       "text": "If you would like to unsubscribe and stop receiveing these emails <% click here %>."
     }
   }
 }')
-response = sg.client.mail._("send").post(request_body: data)
+response = sg.client.mail._('send').post(request_body: data)
 puts response.status_code
 puts response.body
 puts response.headers
-