sendgrid-ruby 6.2.0 → 6.3.4

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'simplecov'
+SimpleCov.start
 require 'rubygems'
 require 'bundler/setup'
 require 'pry'

data/test/sendgrid/helpers/mail/test_mail.rb

@@ -1,5 +1,5 @@
 require_relative "../../../../lib/sendgrid/helpers/mail/mail"
-require_relative "../../../../lib/sendgrid/client"
+require_relative "../../../../lib/sendgrid/sendgrid"
 include SendGrid
 require "json"
 require 'minitest/autorun'

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -1,3 +1,5 @@
+require 'simplecov'
+SimpleCov.start
 require_relative '../../lib/sendgrid-ruby.rb'
 require 'ruby_http_client'
 require 'minitest/autorun'
@@ -5,34 +7,8 @@ require 'minitest/unit'
 
 class TestAPI < MiniTest::Test
 
-    unless File.exist?('/usr/local/bin/prism') || File.exist?(File.join(Dir.pwd, 'prism/bin/prism'))
-      if RUBY_PLATFORM =~ /mswin|mingw/
-        puts 'Please download the Windows binary (https://github.com/stoplightio/prism/releases) and place it in your /usr/local/bin directory'
-      else
-        puts 'Installing Prism'
-        IO.popen(['curl', '-s', 'https://raw.githubusercontent.com/stoplightio/prism/master/install.sh']) do |io|
-          out = io.read
-          unless system(out)
-            puts "Error downloading the prism binary, you can try downloading directly here (https://github.com/stoplightio/prism/releases) and place in your /usr/local/bin directory, #{out}"
-            exit
-          end
-        end
-      end
-    end
-
-    puts 'Activating Prism (~20 seconds)'
-    @@prism_pid = spawn('prism run --mock --list --spec https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/oai_stoplight.json', [:out, :err] => '/dev/null')
-    sleep(15)
-    puts 'Prism started'
-
     def setup
-        host = "http://localhost:4010"
-        @sg = SendGrid::API.new(api_key: "SENDGRID_API_KEY", host: host)
-    end
-
-    Minitest.after_run do
-      Process.kill('TERM', @@prism_pid)
-      puts 'Prism shut down'
+        @sg = SendGrid::API.new(api_key: "SENDGRID_API_KEY")
     end
 
     def test_init
@@ -58,7 +34,7 @@ class TestAPI < MiniTest::Test
         assert_equal(test_headers, sg.request_headers)
         assert_equal("v3", sg.version)
         assert_equal(subuser, sg.impersonate_subuser)
-        assert_equal("6.2.0", SendGrid::VERSION)
+        assert_equal("6.3.4", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 
@@ -2676,76 +2652,65 @@ class TestAPI < MiniTest::Test
         self.assert_equal('200', response.status_code)
     end
 
-
-    def test_license_file_correct_year_range
-        if File.exist?('./LICENSE.md')
-            # get only the first line from the license txt file
-            year_range = File.open('./LICENSE.md', &:readline).gsub(/[^\d-]/, '')
-            self.assert_equal("#{Time.now.year}", year_range)
-        end
+    def test_license_file_year
+        # Read the third line from the license file
+        year = IO.readlines('./LICENSE.md')[2].gsub(/[^\d]/, '')
+        self.assert_equal("#{Time.now.year}", year)
     end
 
-    def test_docker_exists
-      assert(File.file?('./Docker') || File.file?('./docker/Dockerfile'))
-    end
-
-    # def test_docker_compose_exists
-    #   assert(File.file?('./docker-compose.yml') || File.file?('./docker/docker-compose.yml'))
-    # end
-
     def test_env_sample_exists
-      assert(File.file?('./.env_sample'))
+        assert(File.file?('./.env_sample'))
     end
 
     def test_gitignore_exists
-      assert(File.file?('./.gitignore'))
+        assert(File.file?('./.gitignore'))
     end
 
     def test_travis_exists
-      assert(File.file?('./.travis.yml'))
+        assert(File.file?('./.travis.yml'))
     end
 
     def test_codeclimate_exists
-      assert(File.file?('./.codeclimate.yml'))
+        assert(File.file?('./.codeclimate.yml'))
     end
 
     def test_changelog_exists
-      assert(File.file?('./CHANGELOG.md'))
+        assert(File.file?('./CHANGELOG.md'))
     end
 
     def test_code_of_conduct_exists
-      assert(File.file?('./CODE_OF_CONDUCT.md'))
+        assert(File.file?('./CODE_OF_CONDUCT.md'))
     end
 
     def test_contributing_exists
-      assert(File.file?('./CONTRIBUTING.md'))
+        assert(File.file?('./CONTRIBUTING.md'))
     end
 
     def test_issue_template_exists
-      assert(File.file?('./ISSUE_TEMPLATE.md'))
+        assert(File.file?('./ISSUE_TEMPLATE.md'))
     end
 
     def test_license_exists
-      assert(File.file?('./LICENSE.md'))
+        assert(File.file?('./LICENSE.md'))
     end
 
-    def test_pull_request_template_exists
-      assert(File.file?('./PULL_REQUEST_TEMPLATE.md'))
+    def test_pr_template_exists
+        assert(File.file?('./PULL_REQUEST_TEMPLATE.md'))
     end
 
     def test_readme_exists
-      assert(File.file?('./README.md'))
+        assert(File.file?('./README.md'))
     end
 
     def test_troubleshooting_exists
-      assert(File.file?('./TROUBLESHOOTING.md'))
+        assert(File.file?('./TROUBLESHOOTING.md'))
     end
 
     def test_usage_exists
-      assert(File.file?('./USAGE.md'))
+        assert(File.file?('./USAGE.md'))
     end
 
-    def test_use_cases_exists
-      assert(File.file?('./USE_CASES.md'))
+    def test_use_cases_readme_exists
+        assert(File.file?('./use-cases/README.md'))
     end
 end

data/use-cases/README.md

@@ -0,0 +1,16 @@
+This directory provides examples for specific use cases.
+
+Please [open an issue](https://github.com/sendgrid/sendgrid-ruby/issues) or [make a pull request](https://github.com/sendgrid/sendgrid-ruby/pulls) for any use cases you would like us to document here. Thank you!
+
+# Email Use Cases
+* [Transactional Templates](transactional-templates.md)
+* [Legacy Templates](legacy-templates.md)
+
+# Twilio Use Cases
+* [Twilio Setup](twilio-setup.md)
+* [Send an Email With Twilio Email (Pilot)](twilio-email.md)
+* [Send an SMS Message](sms.md)
+
+# Non-Email Use Cases
+* [How to Set up a Domain Authentication](domain-authentication.md)
+* [How to View Email Statistics](email-statistics.md)

data/use-cases/domain-authentication.md

@@ -0,0 +1,5 @@
+# How to Setup a Domain Authentication
+
+You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](../USAGE.md#sender-authentication).
+
+Find more information about all of Twilio SendGrid's authentication related documentation [here](https://sendgrid.com/docs/ui/account-and-settings/).

data/use-cases/email-statistics.md

@@ -0,0 +1,52 @@
+# How to View Email Statistics
+
+You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](../USAGE.md#stats).
+
+Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as Twilio SendGrid processes your email.
+
+You can also use the email statistics helper to make it easier to interact with the API.
+
+```ruby
+require 'sendgrid-ruby'
+require 'date'
+
+include SendGrid
+
+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)
+to = Date.new(2017, 10, 12)
+
+email_stats = stats.by_day(from, to)
+
+email_stats.metrics
+
+if !email_stats.error?
+  email_stats.metrics.each do |metric|
+    puts "Date - #{metric.date}"
+    puts "Number of Requests - #{metric.requests}"
+    puts "Bounces - #{metric.bounces}"
+    puts "Opens - #{metric.opens}"
+    puts "Clicks - #{metric.clicks}"
+  end
+end
+
+# Fetch stats by week, between 2 dates for a category
+from = Date.new(2017, 10, 01)
+to = Date.new(2017, 10, 12)
+category = 'abcd'
+
+email_stats = stats.by_week(from, to, category)
+
+if !email_stats.error?
+  email_stats.metrics.each do |metric|
+    puts "Date - #{metric.date}"
+    puts "Number of Requests - #{metric.requests}"
+    puts "Bounces - #{metric.bounces}"
+    puts "Opens - #{metric.opens}"
+    puts "Clicks - #{metric.clicks}"
+  end
+end
+```

data/use-cases/legacy-templates.md

@@ -0,0 +1,98 @@
+# Legacy Templates
+
+For this example, we assume you have created a [legacy template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
+
+Template ID (replace with your own):
+```text
+13b8f94f-bcae-4ec6-b752-70d6cb59f932
+```
+
+Email Subject:
+```text
+<%subject%>
+```
+
+Template Body:
+```html
+<html>
+<head>
+	<title></title>
+</head>
+<body>
+Hello -name-,
+<br /><br/>
+I'm glad you are trying out the template feature!
+<br /><br/>
+<%body%>
+<br /><br/>
+I hope you are having a great day in -city- :)
+<br /><br/>
+</body>
+</html>
+```
+
+## With Mail Helper Class
+
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+
+mail = SendGrid::Mail.new
+mail.from = Email.new(email: 'test@example.com')
+mail.subject = 'I\'m replacing the subject tag'
+personalization = Personalization.new
+personalization.add_to(Email.new(email: 'test@example.com'))
+personalization.add_substitution(Substitution.new(key: '-name-', value: 'Example User'))
+personalization.add_substitution(Substitution.new(key: '-city-', value: 'Denver'))
+mail.add_personalization(personalization)
+mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: mail.to_json)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```
+
+## Without Mail Helper Class
+
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+
+data = JSON.parse('{
+  "personalizations": [
+    {
+      "to": [
+        {
+          "email": "test@example.com"
+        }
+      ],
+      "substitutions": {
+        "-name-": "Example User",
+        "-city-": "Denver"
+      },
+      "subject": "I\'m replacing the subject tag"
+    }
+  ],
+  "from": {
+    "email": "test@example.com"
+  },
+  "template_id": "13b8f94f-bcae-4ec6-b752-70d6cb59f932"
+}')
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: data)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```

data/use-cases/sms.md

@@ -0,0 +1,39 @@
+First, follow the [Twilio Setup](twilio-setup.md) guide for creating a Twilio account and setting up environment variables with the proper credentials.
+
+Then, install the Twilio Helper Library. Add this line to your application's Gemfile:
+
+```bash
+gem 'twilio-ruby'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself using:
+
+```bash
+gem install twilio-ruby
+```
+
+Finally, send a message.
+
+```ruby
+require 'twilio-ruby'
+
+# put your own credentials here
+account_sid = ENV['TWILIO_ACCOUNT_SID']
+auth_token = ENV['TWILIO_AUTH_TOKEN']
+
+# set up a client to talk to the Twilio REST API
+@client = Twilio::REST::Client.new account_sid, auth_token
+@client.api.account.messages.create(
+  from: '+14159341234',
+  to: '+16105557069',
+  body: 'Hey there!'
+)
+```
+
+For more information, please visit the [Twilio SMS Ruby documentation](https://www.twilio.com/docs/sms/quickstart/ruby).

data/use-cases/transactional-templates.md

@@ -0,0 +1,111 @@
+# Transactional Templates
+
+For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html) in the UI or via the API. Following is the template content we used for testing.
+
+Template ID (replace with your own):
+```text
+d-2c214ac919e84170b21855cc129b4a5f
+```
+
+Email Subject:
+```text
+{{subject}}
+```
+
+Template Body:
+```html
+<html>
+  <head>
+    <title></title>
+  </head>
+  <body>
+    Hello {{name}},
+    <br/><br/>
+    I'm glad you are trying out the template feature!
+    <br/><br/>
+    I hope you are having a great day in {{city}} :)
+    <br/><br/>
+  </body>
+</html>
+```
+
+## With Mail Helper Class
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+
+mail = Mail.new
+mail.from = Email.new(email: 'test@example.com')
+personalization = Personalization.new
+personalization.add_to(Email.new(email: 'test@example.com'))
+personalization.add_dynamic_template_data({
+    "subject" => "Testing Templates",
+    "name" => "Example User",
+    "city" => "Denver"
+  })
+mail.add_personalization(personalization)
+mail.template_id = 'd-2c214ac919e84170b21855cc129b4a5f'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: mail.to_json)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```
+
+## Without Mail Helper Class
+
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+
+data = JSON.parse('{
+  "personalizations": [
+    {
+      "to": [
+        {
+          "email": "test@example.com"
+        }
+      ],
+      "dynamic_template_data": {
+        "subject": "Testing Templates",
+        "name": "Example User",
+        "city": "Denver"
+      }
+    }
+  ],
+  "from": {
+    "email": "test@example.com"
+  },
+  "template_id": "d-2c214ac919e84170b21855cc129b4a5f"
+}')
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: data)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```
+
+## Adding Attachments
+
+```ruby
+attachment = Attachment.new
+attachment.content = Base64.strict_encode64(File.open(fpath, 'rb').read)
+attachment.type = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+attachment.filename = fname
+attachment.disposition = 'attachment'
+attachment.content_id = 'Reports Sheet'
+mail.add_attachment(attachment)
+```
+
+Attachments must be base64 encoded, using Base64's strict_encode64 where no line feeds are added.