sendgrid-ruby 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc03ba685c99e58e6b186a588a8568c04b9800bb
-  data.tar.gz: 8287e74b24b8a63daade480fe4e8f9499486d04c
+  metadata.gz: 796596b834ff9725ad09dd290829bd710b88789f
+  data.tar.gz: 1d572c07d391a91a4e3f3c279b3fc9ef74128b83
 SHA512:
-  metadata.gz: c357990d74833e50714fa327abf456c701384c70604893bac9add0692441cc200c2b28e2d451b62fdc08c9f5d2bdebe09565760874582a8a7b549f82e7b2e49b
-  data.tar.gz: 6d6bf54a2cdd4847a0eca57ed5e1b34b0231040afa34dbf423f66858fa3053d4cd3de8ed9b061aea86644c154bf5668e2077d37b0451e1e480704da6071f2bf3
+  metadata.gz: 5285bba04ae710a028e424ce7b34676e09a4dbf5b2c20eed61205078d97011a3aadbea65f6562dd84883b6583203f28751834ecde2ad225bdcd7ba5bb8ef71dd
+  data.tar.gz: e5eb5ec7768129a04c65fcc4e5e3f2ab88013f4d6d79eec9252ed20f72fb3120d10527efda11127e80440f10b1e5a3e72c568afa7b094ceac4b1196424b53804

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  bundler-audit:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- examples/
+- spec/
+- test/
+- gemfiles/

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [5.3.0] - 2018-10-12 ##
+### Added
+- [PR #300](https://github.com/sendgrid/sendgrid-ruby/pull/300): Support for Dynamic Templates. Big thanks to [@nedcampion](https://github.com/nedcampion) for the PR!
+- [PR #178](https://github.com/sendgrid/sendgrid-ruby/pull/178): Convert key/value arguments to CustomArgs to strings. Big thanks to [@sitaramshelke](https://github.com/sitaramshelke) for the PR!
+- [PR #258](https://github.com/sendgrid/sendgrid-ruby/pull/258): Added unittest to check for specific repo files. Big thanks to [@mptap](https://github.com/mptap) for the PR!
+- [PR #255](https://github.com/sendgrid/sendgrid-ruby/pull/255): Add a unittest to check the license.md file date range. Big thanks to [@prashuchaudhary](https://github.com/prashuchaudhary) for the PR!
+- [PR #181](https://github.com/sendgrid/sendgrid-ruby/pull/181): Add Docker. Big thanks to [@shrivara](https://github.com/shrivara) for the PR!
+- [PR #248](https://github.com/sendgrid/sendgrid-ruby/pull/248): Added .codeclimate.yml. Big thanks to [@proton](https://github.com/proton) for the PR!
+- [PR #260](https://github.com/sendgrid/sendgrid-ruby/pull/260): Update ruby-http-client dependency to support v3.3.0. Big thanks to [@mptap](https://github.com/mptap) for the PR!
+- [PR #304](https://github.com/sendgrid/sendgrid-ruby/pull/304): Readability update for documentation. Big thanks to [@af4ro](https://github.com/af4ro) for the PR!
+- [PR #306](https://github.com/sendgrid/sendgrid-ruby/pull/306): Update example to work in Rails console. Big thanks to [@RogerPodacter](https://github.com/RogerPodacter) for the PR!
+
+### Fixes
+- [PR #252](https://github.com/sendgrid/sendgrid-ruby/pull/252): Update LICENSE, set correct year. Big thanks to [@pushkyn](https://github.com/pushkyn) for the PR!
+- [PR #257](https://github.com/sendgrid/sendgrid-ruby/pull/257): README.md typo fix. Big thanks to [@shucon](https://github.com/shucon) for the PR!
+
 ## [5.2.0] - 2017-10-30 ##
 ### Added
 - PR #234: Helpers for email statistics - global, category, subuser 

data/CONTRIBUTING.md

@@ -1,13 +1,19 @@
 Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome.  We simply ask that you follow the following contribution policies.
 
-- [CLAs and CCLAs](#cla)
-- [Roadmap & Milestones](#roadmap)
+- [CLAs and CCLAs](#clas-and-cclas)
 - [Feature Request](#feature-request)
 - [Submit a Bug Report](#submit-a-bug-report)
+    - [Please use our Bug Report Template](#please-use-our-bug-report-template)
 - [Improvements to the Codebase](#improvements-to-the-codebase)
-- [Understanding the Code Base](#understanding-the-codebase)
+    - [Development Environment](#development-environment)
+        - [Install and Run Locally](#install-and-run-locally)
+            - [Prerequisites](#prerequisites)
+            - [Initial setup:](#initial-setup)
+- [Environment Variables](#environment-variables)
+            - [Execute:](#execute)
+- [Understanding the Code Base](#understanding-the-code-base)
 - [Testing](#testing)
-- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
+- [Style Guidelines & Naming Conventions](#style-guidelines--naming-conventions)
 - [Creating a Pull Request](#creating-a-pull-request)
 
 <a name="roadmap"></a>
@@ -163,8 +169,10 @@ Please run your code through:
    ```bash
    # Clone your fork of the repo into the current directory
    git clone https://github.com/sendgrid/sendgrid-ruby
+   
    # Navigate to the newly cloned directory
    cd sendgrid-ruby
+   
    # Assign the original repo to a remote called "upstream"
    git remote add upstream https://github.com/sendgrid/sendgrid-ruby
    ```

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2017 SendGrid, Inc.
+Copyright (c) 2014-2018 SendGrid, Inc.
 
 MIT License
 

data/README.md

@@ -10,7 +10,7 @@ Version 3.X.X+ of this library provides full support for all SendGrid [Web API v
 
 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.
 
-Please browse the rest of this README for further detail.
+Please browse the rest of this README for further details.
 
 We appreciate your continued support, thank you!
 
@@ -83,16 +83,17 @@ The following is the minimum needed code to send an email with the [/mail/send H
 require 'sendgrid-ruby'
 include SendGrid
 
-from = Email.new(email: 'test@example.com')
-to = Email.new(email: 'test@example.com')
+from = SendGrid::Email.new(email: 'test@example.com')
+to = SendGrid::Email.new(email: 'test@example.com')
 subject = 'Sending with SendGrid is Fun'
-content = Content.new(type: 'text/plain', value: 'and easy to do anywhere, even with Ruby')
-mail = Mail.new(from, subject, to, content)
+content = SendGrid::Content.new(type: 'text/plain', value: 'and easy to do anywhere, even with Ruby')
+mail = SendGrid::Mail.new(from, subject, to, content)
 
 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.parsed_body
 puts response.headers
 ```
 
@@ -131,6 +132,7 @@ sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 response = sg.client.mail._("send").post(request_body: data)
 puts response.status_code
 puts response.body
+puts response.parsed_body
 puts response.headers
 ```
 
@@ -142,6 +144,7 @@ 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.parsed_body
 puts response.headers
 ```
 
@@ -153,6 +156,7 @@ 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.parsed_body
 puts response.headers
 ```
 

data/USE_CASES.md

@@ -7,7 +7,9 @@ This documentation provides examples for specific use cases. Please [open an iss
 * [How to View Email Statistics](#email-statistics)
 
 <a name="transactional-templates"></a>
-# Transactional Templates
+# (LEGACY) Transactional Templates
+
+IF YOU ARE USING OUR NEW TEMPLATES, PLEASE SEE [THIS ISSUE](https://github.com/sendgrid/sendgrid-ruby/issues/301).
 
 For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
 
@@ -68,6 +70,7 @@ rescue Exception => e
 end
 puts response.status_code
 puts response.body
+puts response.parsed_body
 puts response.headers
 ```
 
@@ -111,6 +114,7 @@ rescue Exception => e
 end
 puts response.status_code
 puts response.body
+puts response.parsed_body
 puts response.headers
 ```
 

data/docker/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.4.2-jessie
+
+# Clone sendgrid-ruby
+WORKDIR /sources
+RUN git clone https://github.com/sendgrid/sendgrid-ruby.git
+
+# Bundle
+WORKDIR /sources/sendgrid-ruby
+RUN bundle install
+
+# Install prism
+RUN curl https://raw.githubusercontent.com/stoplightio/prism/master/install.sh | sh

data/docker/README.md

@@ -0,0 +1,30 @@
+# Docker image for sendgrid-ruby
+
+## Quickstart
+1. [Install Docker](https://docs.docker.com/engine/installation/) on your machine.
+2. Run `docker run --rm -it sendgrid/sendgrid-ruby irb`.
+3. Run `require './lib/sendgrid-ruby.rb'`.
+
+## Poke around
+
+If you would like to just poke around in the image and check some examples:
+```sh
+docker run --rm -it sendgrid/sendgrid-ruby bash
+```
+
+If you want to mount your fork or specific version of the gem:
+```sh
+docker run --rm -v /path/to/local/sendgrid-ruby:/sources/sendgrid-ruby -it sendgrid/sendgrid-ruby bash
+```
+
+## Running tests
+
+If you would like to run the tests present in the image:
+```sh
+docker run --rm sendgrid/sendgrid-ruby rake
+```
+
+If you want to run tests on your fork or a specific version, mount the codebase onto the image:
+```sh
+docker run --rm -v /path/to/local/sendgrid-ruby:/sources/sendgrid-ruby sendgrid/sendgrid-ruby rake
+```

data/examples/helpers/mail/example.rb

@@ -125,5 +125,23 @@ def kitchen_sink
   puts response.headers
 end
 
+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 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"}
+    ]
+  })
+  mail.add_personalization(personalization)
+end
+
 hello_world
 kitchen_sink
+dynamic_template_data_hello_world
+

data/lib/sendgrid/helpers/inbound/README.md

@@ -30,7 +30,7 @@ bundle install
 ruby ./lib/sendgrid/helpers/inbound/send.rb ./lib/sendgrid/helpers/inbound/sample_data/default_data.txt
 ```
 
-More sample data can be found [here](https://github.com/sendgrid/sendgrid-ruby/tree/master/sendgrid/helpers/inbound/sample_data).
+More sample data can be found [here](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/inbound/sample_data).
 
 View the results in the first terminal.
 

data/lib/sendgrid/helpers/mail/custom_arg.rb

@@ -4,7 +4,7 @@ module SendGrid
   class CustomArg
     def initialize(key: nil, value: nil)
       @custom_arg = {}
-      (key.nil? || value.nil?) ? @custom_arg = nil : @custom_arg[key] = value
+      (key.nil? || value.nil?) ? @custom_arg = nil : @custom_arg[key.to_s] = value.to_s
     end
 
     def custom_arg=(custom_arg)

data/lib/sendgrid/helpers/mail/personalization.rb

@@ -3,7 +3,8 @@ require 'json'
 module SendGrid
   class Personalization
 
-    attr_reader :tos, :ccs, :bccs, :headers, :substitutions, :custom_args
+    attr_reader :tos, :ccs, :bccs, :headers, :substitutions, :custom_args,
+      :dynamic_template_data
 
     def initialize
       @tos = []
@@ -13,6 +14,7 @@ module SendGrid
       @headers = {}
       @substitutions = {}
       @custom_args = {}
+      @dynamic_template_data = {}
       @send_at = nil
     end
 
@@ -51,6 +53,10 @@ module SendGrid
       @custom_args = @custom_args.merge(custom_arg['custom_arg'])
     end
 
+    def add_dynamic_template_data(dynamic_template_data)
+      @dynamic_template_data.merge!(dynamic_template_data)
+    end
+
     def send_at=(send_at)
       @send_at = send_at
     end
@@ -68,6 +74,7 @@ module SendGrid
         'headers' => self.headers,
         'substitutions' => self.substitutions,
         'custom_args' => self.custom_args,
+        'dynamic_template_data' => self.dynamic_template_data,
         'send_at' => self.send_at
       }.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
     end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '5.2.0'
+  VERSION = '5.3.0'
 end

data/sendgrid-ruby.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
-  spec.add_dependency 'ruby_http_client', '~> 3.2'
+  spec.add_dependency 'ruby_http_client', '~> 3.3.0'
   spec.add_dependency 'sinatra', '>= 1.4.7', '< 3'
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'minitest', '~> 5.9'
 end

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

@@ -207,6 +207,21 @@ class TestMail < Minitest::Test
     assert_equal mail.to_json, expected_json
   end
 
+  def test_add_non_string_custom_arg
+    mail = Mail.new
+    mail.add_custom_arg(CustomArg.new(key: "Integer", value: 1))
+    mail.add_custom_arg(CustomArg.new(key: "Array", value: [1, "a", true]))
+    mail.add_custom_arg(CustomArg.new(key: "Hash", value: {"a" => 1, "b" => 2}))
+    expected_json = {
+        "custom_args"=>{
+                "Integer"=>"1",
+                "Array"=>"[1, \"a\", true]",
+                "Hash"=>"{\"a\"=>1, \"b\"=>2}",
+            }
+    }
+    assert_equal mail.to_json, expected_json
+  end
+
   def test_add_attachment
     mail = Mail.new
     mail.add_attachment('foo')

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

@@ -143,4 +143,19 @@ class TestPersonalization < Minitest::Test
     assert_equal @personalization.to_json, expected_json
   end
 
+  def test_add_dynamic_template_data
+    @personalization = Personalization.new()
+    @personalization.add_dynamic_template_data({
+        "name"=>"Example User",
+        "city"=> "Denver"
+    })
+    expected_json = {
+        "dynamic_template_data"=>{
+                "name"=>"Example User",
+                "city"=>"Denver"
+            }
+    }
+    assert_equal @personalization.to_json, expected_json
+  end
+
 end

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -55,7 +55,7 @@ class TestAPI < MiniTest::Test
             ')
         assert_equal(test_headers, sg.request_headers)
         assert_equal("v3", sg.version)
-        assert_equal("5.2.0", SendGrid::VERSION)
+        assert_equal("5.3.0", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 
@@ -2667,4 +2667,77 @@ class TestAPI < MiniTest::Test
 
         self.assert_equal('200', response.status_code)
     end
+
+
+    def test_license_file_correct_year_range
+        if File.exist?('./LICENSE.txt')
+            # get only the first line from the license txt file
+            year_range = File.open('./LICENSE.txt', &:readline).gsub(/[^\d-]/, '')
+            self.assert_equal("2014-#{Time.now.year}", year_range)
+        end
+    end
+
+    def test_docker_exists
+      assert(File.file?('./Dockerfile') || 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'))
+    end
+
+    def test_gitignore_exists
+      assert(File.file?('./.gitignore'))
+    end
+
+    def test_travis_exists
+      assert(File.file?('./.travis.yml'))
+    end
+
+    def test_codeclimate_exists
+      assert(File.file?('./.codeclimate.yml'))
+    end
+
+    def test_changelog_exists
+      assert(File.file?('./CHANGELOG.md'))
+    end
+
+    def test_code_of_conduct_exists
+      assert(File.file?('./CODE_OF_CONDUCT.md'))
+    end
+
+    def test_contributing_exists
+      assert(File.file?('./CONTRIBUTING.md'))
+    end
+
+    def test_issue_template_exists
+      assert(File.file?('./.github/ISSUE_TEMPLATE'))
+    end
+
+    def test_license_exists
+      assert(File.file?('./LICENSE.txt'))
+    end
+
+    def test_pull_request_template_exists
+      assert(File.file?('./.github/PULL_REQUEST_TEMPLATE'))
+    end
+
+    def test_readme_exists
+      assert(File.file?('./README.md'))
+    end
+
+    def test_troubleshooting_exists
+      assert(File.file?('./TROUBLESHOOTING.md'))
+    end
+
+    def test_usage_exists
+      assert(File.file?('./USAGE.md'))
+    end
+
+    def test_use_cases_exists
+      assert(File.file?('./USE_CASES.md'))
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".env_sample"
 - ".github/ISSUE_TEMPLATE"
 - ".github/PULL_REQUEST_TEMPLATE"
@@ -138,6 +153,8 @@ files:
 - USAGE.md
 - USE_CASES.md
 - config.ru
+- docker/Dockerfile
+- docker/README.md
 - examples/accesssettings/accesssettings.rb
 - examples/alerts/alerts.rb
 - examples/apikeys/apikeys.rb