sendgrid-ruby 3.0.6 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d87e0ebd7948408c1716659ae622d2be7f95f59a
-  data.tar.gz: bc8f0d2d86daa5fea84161a044aac3f0960825cf
+  metadata.gz: f2e4c4f609ac09eee2af7a117a7e149d322229f2
+  data.tar.gz: 0322d3868fbc93f37f4f1b2ae410ed5cf7d9a9e6
 SHA512:
-  metadata.gz: dd419b14d5b9b113b7860a4dc0683c70cb051dfa6494d225b28c6998b12b1dc025ab3fc53dce71a962044dc8dce15d23b815b4d3ec503d9f6d35d0978a9ccb64
-  data.tar.gz: e651ea89308ba59e482cd6fdc26058a3638a9ff0cc692daa294f2078c53e0c01040fd9d75a1c874c86fda2dcc4151dd29aeac8c99227c363de19ac56c8372b8d
+  metadata.gz: 22d6d4a1ed6f4d5f402e0b179d18a7632851c94fb62b19a04150a8c006a51509abb6bfca3929f98f5497470464c503e7c5e44f18ed8d7de2165c2c562f5d3d34
+  data.tar.gz: 74fc4c64185b74b97b89173ae1f24424544bb7fcf75760707ddbb2ee2da3a81e2aba00177ec002088a88631eb3e81c4f48d544f33dc801cc06aa7cd707074ed0

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [3.0.7] - 2016-07-20 ##
+### Added
+- README updates
+- Update introduction blurb to include information regarding our forward path
+- Update the v3 /mail/send example to include non-helper usage
+- Update the generic v3 example to include non-fluent interface usage
+
 ## [3.0.6] - 2016-07-05 ##
 ### Added
 - Update docs, unit tests and examples to include Sender ID

data/CONTRIBUTING.md

@@ -64,7 +64,7 @@ We welcome direct contributions to the sendgrid-ruby code base. Thank you!
 
 ##### Prerequisites #####
 
-- Ruby 2.2
+- Ruby version 2.2
 - [ruby_http_client](https://github.com/sendgrid/ruby-http-client)
 
 ##### Initial setup: #####

data/README.md

@@ -1,36 +1,26 @@
 [![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-ruby.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-ruby)
 
 
-**This library allows you to quickly and easily use the SendGrid Web API via Ruby.**
+**This library allows you to quickly and easily use the SendGrid Web API v3 via Ruby.**
 
-# Announcements
-
-**BREAKING CHANGE as of 2016.06.14**
+Version 3.X.X of this library provides full support for all SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
 
-Version `3.X.X` is a breaking change for the entire library.
+This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-ruby/issues) and [pull requests](https://github.com/sendgrid/sendgrid-ruby/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
 
-Version 3.X.X brings you full support for all Web API v3 endpoints. We
-have the following resources to get you started quickly:
+Please browse the rest of this README for further detail.
 
--   [SendGrid
-    Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html)
--   [Usage
-    Documentation](https://github.com/sendgrid/sendgrid-ruby/tree/master/USAGE.md)
--   [Example
-    Code](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples)
--   [Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
+We appreciate your continued support, thank you!
 
-Thank you for your continued support!
+# Installation
 
-All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-ruby/blob/master/CHANGELOG.md).
+## Prerequisites
 
-# Installation
+- Ruby version 2.2
+- The SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-ruby)
 
 ## Setup Environment Variables
 
-First, get your free SendGrid account [here](https://sendgrid.com/free?source=sendgrid-ruby).
-
-Next, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys).
+Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example:
 
 ```bash
 echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
@@ -59,21 +49,24 @@ gem install sendgrid-ruby
 
 ## Dependencies
 
-- The SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-ruby)
 - [Ruby-HTTP-Client](https://github.com/sendgrid/ruby-http-client)
 
 # Quick Start
 
 ## Hello Email
 
+The following is the minimum needed code to send an email with the [/mail/send Helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/mail) ([here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/helpers/mail/example.rb#L21) is a full example):
+
+### With Mail Helper Class
+
 ```ruby
 require 'sendgrid-ruby'
 include SendGrid
 
 from = Email.new(email: 'test@example.com')
-subject = 'Hello World from the SendGrid Ruby Library'
+subject = 'Hello World from the SendGrid Ruby Library!'
 to = Email.new(email: 'test@example.com')
-content = Content.new(type: 'text/plain', value: 'some text here')
+content = Content.new(type: 'text/plain', value: 'Hello, Email!')
 mail = Mail.new(from, subject, to, content)
 
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
@@ -83,12 +76,57 @@ puts response.body
 puts response.headers
 ```
 
-## General v3 Web API Usage
+For more complex scenarios, please do not use the above constructor and instead build your own personalization object as [demonstrated here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/helpers/mail/example.rb#L21).
+
+### Without Mail Helper Class
+
+The following is the minimum needed code to send an email without the /mail/send Helper ([here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/mail/mail.rb#L26) is a full example):
+
+```ruby
+data = JSON.parse('{
+  "personalizations": [
+    {
+      "to": [
+        {
+          "email": "test@example.com"
+        }
+      ],
+      "subject": "Hello World from the SendGrid Ruby Library!"
+    }
+  ],
+  "from": {
+    "email": "test@example.com"
+  },
+  "content": [
+    {
+      "type": "text/plain",
+      "value": "Hello, Email!"
+    }
+  ]
+}')
+response = sg.client.mail._("send").post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+## General v3 Web API Usage (With Fluent Interface)
+
+```ruby
+require 'sendgrid-ruby'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+response = sg.client.suppression.bounces.get()
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+## General v3 Web API Usage (Without Fluent Interface)
 
 ```ruby
 require 'sendgrid-ruby'
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
-response = sg.client.api_keys.get()
+response = sg.client._("suppression/bounces").get()
 puts response.status_code
 puts response.body
 puts response.headers
@@ -97,17 +135,22 @@ puts response.headers
 # Usage
 
 - [SendGrid Docs](https://sendgrid.com/docs/API_Reference/index.html)
-- [Usage Docs](https://github.com/sendgrid/sendgrid-ruby/tree/master/USAGE.md)
+- [Library Usage Docs](https://github.com/sendgrid/sendgrid-ruby/tree/master/USAGE.md)
 - [Example Code](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples)
+- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
+- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) - build a request object payload for a v3 /mail/send API call.
+
+# Announcements
+
+All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-ruby/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases).
 
-## Roadmap
+# Roadmap
 
-If you are interested in the future direction of this project, please take a look at our [milestones](
-). We would love to hear your feedback.
+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.
 
-## How to Contribute
+# How to Contribute
 
-We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md) guide for details.
+We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md) guide for details.
 
 - [Feature Request](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#feature_request)
 - [Bug Reports](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#submit_a_bug_report)

data/USAGE.md

@@ -2086,7 +2086,7 @@ For more detailed information about how to use the v3 Mail Send endpoint, please
 
 ### 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/master/lib/sendgrid/helpers/mail/README.md).
 
 ```ruby
 data = JSON.parse('{

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '3.0.6'
+  VERSION = '3.0.7'
 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("3.0.6", SendGrid::VERSION)
+        assert_equal("3.0.7", 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: 3.0.6
+  version: 3.0.7
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client