sendgrid-ruby 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58e24c0cfd83197efded57156c9b03e9426669cd
-  data.tar.gz: 50fcc1d3309165332a3abd6834e5076e862bbbe9
+  metadata.gz: 1577f622dc1139887c7bf0e70e48af93a902e4f4
+  data.tar.gz: 4be15a9ae9f75ef61ea292572fa1735686bc6777
 SHA512:
-  metadata.gz: 64b4d83d8c7d4d2a0720902442f991d277c8570d5f30f70873fe9fb1a65d57063432ca76f378ac434d7425c0009c2280399b27e5249da6e32af564158ea713d8
-  data.tar.gz: bc15d4aa204006ba4b2c3ad52566c4bb8a2c08b06b8f4a46d7fd23749b7ffc49f836d70f59faed22ada7ca8754372594b113e5ec4cc7242ddacd7fae8a9076fc
+  metadata.gz: cc058748afd2ea184df9ad8ea88bdee864332914d80651c9aa3c3c8cbc00476dd28bcacc2e7afcad823e46307608e522f9bb6d6dbeb92f0e1767d90b80bed5af
+  data.tar.gz: e622f4208a1795bf5d63233688392d68c11395a2a5b08c413805224674c0ee21f2b108c7913b80bdc3d565edcbbeb4c823aedad46fbec45769f5d729e65f1571

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 All notable changes to this project will be documented in this file.
 
 ## [4.0.0] - 2016-07-23 ##
-- BREAKING CHANGE
+### BREAKING CHANGE
 - Update dependency to [ruby-http-client](https://github.com/sendgrid/ruby-http-client/releases/tag/v3.0.0)
 - Response headers now return a hash instead of a string
 - Thanks to [Chris France](https://github.com/hipsterelitist) for the pull request!

data/README.md

@@ -157,6 +157,10 @@ We encourage contribution to our libraries (you might even score some nifty swag
 - [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#cla)
 - [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#improvements_to_the_codebase)
 
+# Troubleshooting
+
+Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md) for common library issues.
+
 # About
 
 sendgrid-ruby is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).

data/TROUBLESHOOTING.md

@@ -0,0 +1,111 @@
+If you have a non-library SendGrid issue, please contact our [support team](https://support.sendgrid.com).
+
+If you can't find a solution below, please open an [issue](https://github.com/sendgrid/sendgrid-ruby/issues).
+
+
+## Table of Contents
+
+* [Migrating from v2 to v3](#migrating)
+* [Continue Using v2](#v2)
+* [Testing v3 /mail/send Calls Directly](#testing)
+* [Error Messages](#error)
+* [Versions](#versions)
+* [Environment Variables and Your SendGrid API Key](#environment)
+* [Using the Package Manager](#package-manager)
+
+<a name="migrating"></a>
+## Migrating from v2 to v3
+
+Please review [our guide](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html) on how to migrate from v2 to v3.
+
+<a name="v2"></a>
+## Continue Using v2
+
+[Here](https://github.com/sendgrid/sendgrid-ruby/tree/0fbf579c0f7ed1dff87adc4957c4dc5a6b257068) is the last working version with v2 support.
+
+Using rubygems:
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'sendgrid-ruby',  '1.1.6'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself using:
+
+```bash
+gem install sendgrid-ruby -v 1.1.6
+```
+
+Download:
+
+Click the "Clone or download" green button in [GitHub](https://github.com/sendgrid/sendgrid-ruby/tree/0fbf579c0f7ed1dff87adc4957c4dc5a6b257068) and choose download.
+
+<a name="testing"></a>
+## Testing v3 /mail/send Calls Directly
+
+[Here](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/curl_examples.html) are some cURL examples for common use cases.
+
+<a name="error"></a>
+## Error Messages
+
+To read the error message returned by SendGrid's API:
+
+```ruby
+begin
+    response = sg.client.mail._("send").post(request_body: mail.to_json)
+rescue Exception => e
+    puts e.message
+end
+```
+
+<a name="versions"></a>
+## Versions
+
+We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guarenteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-ruby/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases) section.
+
+<a name="environment"></a>
+## Environment Variables and Your SendGrid API Key
+
+All of our examples assume you are using [environment variables](https://github.com/sendgrid/sendgrid-ruby#setup-environment-variables) to hold your SendGrid API key.
+
+If you choose to add your SendGrid API key directly (not recommended):
+
+`sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])`
+
+becomes
+
+`sg = SendGrid::API.new(api_key: 'SENDGRID_API_KEY')`
+
+In the first case SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual SendGrid API Key.
+
+<a name="package-manager"></a>
+## Using the Package Manager
+
+We upload this library to [RubyGems](https://rubygems.org/gems/sendgrid-ruby) whenever we make a release. This allows you to use [RubyGems](https://rubygems.org) for easy installation.
+
+In most cases we recommend you download the latest version of the library, but if you need a different version, please use:
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'sendgrid-ruby',  'X.X.X'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself using:
+
+```bash
+gem install sendgrid-ruby -v X.X.X
+```

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '4.0.0'
+  VERSION = '4.0.1'
 end

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -30,7 +30,7 @@ class TestAPI < Minitest::Test
             ')
         assert_equal(test_headers, sg.request_headers)
         assert_equal("v3", sg.version)
-        assert_equal("4.0.0", SendGrid::VERSION)
+        assert_equal("4.0.1", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -55,6 +55,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TROUBLESHOOTING.md
 - USAGE.md
 - examples/accesssettings/accesssettings.rb
 - examples/alerts/alerts.rb