smtpapi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac48327f1e39cd10c190d8de7333db73cd406004
-  data.tar.gz: 8482c0dbd28b403477a7633d479306b6d1fd828d
+SHA256:
+  metadata.gz: fd52e5509ec31d99e879b341ecb97c903c755cd549a2062b5c82c9b2f840316d
+  data.tar.gz: 6304f16a9d0336b988bd98b0cab323408ef8089d3608aad6c99d6996c70f3d8b
 SHA512:
-  metadata.gz: b74ba4f6d51a9a5ba5ea75563ce9c59e5df4d635f2d68527c1549786951993d0b2c9d9642d107c68b42275c9b88753931e270a47dfa3283f11033706d43a44aa
-  data.tar.gz: 30b50e8473fb33ff252282868d92174a1ff906b3ac75f5e8aede372459b6324083f947b85d0c39988f2aa4d20da425a0a001e00fca33f97d0b94046a2f613f20
+  metadata.gz: 106eb5d455c551673148034db89c6585e0fe7242938c9227d4aae53a3934a1d69c432920b5766cde6bfd62afd0fb84c961847f752f4a6ee70500d832640a0ee4
+  data.tar.gz: cee21370e420f428d29029b1c62f6ec045577eb5a7572a22c1f238912647454ec744a54d0b190f7e6f39428d69ad45da37619005e3f5270c601dc324aac0a8b2

data/.codeclimate.yml

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

data/.env_sample

@@ -0,0 +1 @@
+SENDGRID_API_KEY=

data/.github/ISSUE_TEMPLATE

@@ -0,0 +1,17 @@
+#### Issue Summary
+
+A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, code examples.
+
+
+#### Steps to Reproduce
+
+1. This is the first step
+2. This is the second step
+3. Further steps, etc.
+
+Any other information you want to share that is relevant to the issue being reported. Especially, why do you consider this to be a bug? What do you expect to happen instead?
+
+#### Technical details:
+
+* smtpapi-ruby Version: master (latest commit: [commit number])
+* Ruby Version: 2.2

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,24 @@
+<!--
+We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines given above, then fill out the blanks below.
+
+
+Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged!
+e.g. 
+Fixes #1
+Closes #2
+-->
+# Fixes # 
+
+### Checklist
+- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
+- [ ] I have read the [Contribution Guide] and my PR follows them.
+- [ ] I updated my branch with the master branch.
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation about the functionality in the appropriate .md file
+- [ ] I have added in line documentation to the code I modified
+
+### Short description of what this PR does:
+- 
+- 
+
+If you have questions, please send an email to [Sendgrid](mailto:dx@sendgrid.com), or file a Github Issue in this repository.

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.env

data/.rubocop.yml

@@ -22,7 +22,7 @@ RegexpLiteral:
 
 # Increase the max line number of class
 ClassLength:
-  Max: 200
+  Max: 250
   CountComments: true
 
 CyclomaticComplexity:

data/.travis.yml

@@ -1,11 +1,24 @@
 language: ruby
 rvm:
-  - "1.9.3"
-  - "2.0.0"
-  - "2.1.5"
-  - "2.2.1"
+- ruby-head
+- 2.6
+- 2.5
+- 2.4
+- jruby
 before_script:
-  - bundle install
+- bundle install
 script:
-  - rubocop --fail-level=W
-  - rake test
+- rubocop --fail-level=W
+- rake test
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+  fast_finish: true
+deploy:
+  provider: rubygems
+  api_key:
+    secure: PRNz0pPyO99KdYcQ1WKkunc3TOz1N5ZmdT997KlzRYa5uos+IFqr5UsztJzOrus5iWoQdKKtLGSRYe1SFnXDkSOwK61Q5YvYdSqF3OE/QD63qHub+is4CxmfMmXg+eBGreSH+kIWlSD8N3ic2CDZR8JoQmhPcit6zCZSN3WVRfY=
+  gem: smtpapi-ruby
+  on:
+    tags: true
+    rvm: '2.4'

data/CHANGELOG.md

@@ -1,8 +1,48 @@
 # Change Log
 All notable changes to this project will be documented in this file.
+
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.1.0] - 2015-04-06
+[2020-01-09] Version 0.1.1
+--------------------------
+**Library - Chore**
+- [PR #92](https://github.com/sendgrid/smtpapi-ruby/pull/92): Auto-deploy upon successful tagged commit. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #50](https://github.com/sendgrid/smtpapi-ruby/pull/50): Update License date range. Thanks to [@shucon](https://github.com/shucon)!
+- [PR #85](https://github.com/sendgrid/smtpapi-ruby/pull/85): updated Readme.md. Thanks to [@rahulpuroht](https://github.com/rahulpuroht)!
+- [PR #67](https://github.com/sendgrid/smtpapi-ruby/pull/67): Add Use Cases directory. Thanks to [@eyewritecode](https://github.com/eyewritecode)!
+- [PR #65](https://github.com/sendgrid/smtpapi-ruby/pull/65): Update LICENSE.txt. Thanks to [@nocategory](https://github.com/nocategory)!
+- [PR #64](https://github.com/sendgrid/smtpapi-ruby/pull/64): Resolve linting issues. Thanks to [@mrala](https://github.com/mrala)!
+- [PR #46](https://github.com/sendgrid/smtpapi-ruby/pull/46): Replaced .length > 0 with .!empty?. Thanks to [@nvzard](https://github.com/nvzard)!
+- [PR #35](https://github.com/sendgrid/smtpapi-ruby/pull/35): Replaced .length > 0 with !empty #32. Thanks to [@181514912](https://github.com/181514912)!
+- [PR #42](https://github.com/sendgrid/smtpapi-ruby/pull/42): Added unittest to check for specific repo files. Thanks to [@mptap](https://github.com/mptap)!
+- [PR #40](https://github.com/sendgrid/smtpapi-ruby/pull/40): Update LICENSE.txt. Thanks to [@GaryLeutheuser](https://github.com/GaryLeutheuser)!
+- [PR #41](https://github.com/sendgrid/smtpapi-ruby/pull/41): Add License end year test. Thanks to [@diegous](https://github.com/diegous)!
+- [PR #43](https://github.com/sendgrid/smtpapi-ruby/pull/43): Update LICENSE.txt. Thanks to [@astromoose](https://github.com/astromoose)!
+- [PR #26](https://github.com/sendgrid/smtpapi-ruby/pull/26): add a .env_sample file. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #24](https://github.com/sendgrid/smtpapi-ruby/pull/24): add Gem badge to README file. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #28](https://github.com/sendgrid/smtpapi-ruby/pull/28): Added the gem badge. Thanks to [@roooodcastro](https://github.com/roooodcastro)!
+- [PR #44](https://github.com/sendgrid/smtpapi-ruby/pull/44): Rename PULL_REQUEST_TEMPLATE.md. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #25](https://github.com/sendgrid/smtpapi-ruby/pull/25): add pull request template. Thanks to [@rohitdaryanani](https://github.com/rohitdaryanani)!
+- [PR #31](https://github.com/sendgrid/smtpapi-ruby/pull/31): Added .codeclimate.yml. Thanks to [@veruz](https://github.com/veruz)!
+- [PR #18](https://github.com/sendgrid/smtpapi-ruby/pull/18): add .github/ISSUE_TEMPLATE. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #13](https://github.com/sendgrid/smtpapi-ruby/pull/13): Add/update badges on README. Thanks to [@jessecalton](https://github.com/jessecalton)!
+- [PR #12](https://github.com/sendgrid/smtpapi-ruby/pull/12): more SEO friendly url. Thanks to [@ladhadha](https://github.com/ladhadha)!
+
+**Library - Fix**
+- [PR #69](https://github.com/sendgrid/smtpapi-ruby/pull/69): Remove duplicate text in CONTRIBUTING.md. Thanks to [@eyewritecode](https://github.com/eyewritecode)!
+- [PR #17](https://github.com/sendgrid/smtpapi-ruby/pull/17): Fixed some Grammatical errors in CONTRIBUTING.md. Thanks to [@mohsincl](https://github.com/mohsincl)!
+- [PR #16](https://github.com/sendgrid/smtpapi-ruby/pull/16): update contributing and readme - fix typo and ToC. Thanks to [@pushkyn](https://github.com/pushkyn)!
+
+**Library - Docs**
+- [PR #15](https://github.com/sendgrid/smtpapi-ruby/pull/15): update README.md. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #14](https://github.com/sendgrid/smtpapi-ruby/pull/14): add table of contents in README.md. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #9](https://github.com/sendgrid/smtpapi-ruby/pull/9): Add TROUBLESHOOTING.md. Thanks to [@colto](https://github.com/colto)!
+- [PR #7](https://github.com/sendgrid/smtpapi-ruby/pull/7): Added Code of Conduct. Thanks to [@gr8shivam](https://github.com/gr8shivam)!
+- [PR #5](https://github.com/sendgrid/smtpapi-ruby/pull/5): Update README.md. Thanks to [@ciceropablo](https://github.com/ciceropablo)!
+
+
+[2015-04-06] Version 0.1.0
+--------------------------
 ### Changed
 - Change home to SendGrid
 - Add unit test dev dep

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,41 @@
+# SendGrid Community Code of Conduct
+
+The SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, successful and growing community. 
+
+### Be Open
+Members of the community are open to collaboration, whether it's on pull requests, code reviews, approvals, issues or otherwise. We're receptive to constructive comments and criticism, as the experiences and skill sets of all members contribute to the whole of our efforts. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate, and everyone can make a difference.
+
+### Be Considerate
+Members of the community are considerate of their peers, which include other contributors and users of SendGrid. We're thoughtful when addressing the efforts of others, keeping in mind that often the labor was completed with the intent of the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
+
+### Be Respectful
+Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues.  Overall, we're good to each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
+
+## Additional Guidance 
+
+### Disclose Potential Conflicts of Interest
+Community discussions often involve interested parties. We expect participants to be aware when they are conflicted due to employment or other projects they are involved in and disclose those interests to other project members. When in doubt, over-disclose. Perceived conflicts of interest are important to address so that the community’s decisions are credible even when unpopular, difficult or favorable to the interests of one group over another.
+
+### Interpretation
+This Code is not exhaustive or complete. It is not a rulebook; it serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter.  When in doubt, try to abide by [SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.  
+
+### Enforcement
+Most members of the SendGrid community always comply with this Code, not because of the existence of this Code, but because they have long experience participating in open source communities where the conduct described above is normal and expected. However, failure to observe this Code may be grounds for suspension, reporting the user for abuse or changing permissions for outside contributors.
+
+## If you have concerns about someone’s conduct
+**Initiate Direct Contact** - It is always appropriate to email a community member (if contact information is available), mention that you think their behavior was out of line, and (if necessary) point them to this Code.
+
+**Discuss Publicly** - Discussing publicly is always acceptable. Note, though, that approaching the person directly may be better, as it tends to make them less defensive, and it respects the time of other community members, so you probably want to try direct contact first.
+
+**Contact the Moderators** - You can reach the SendGrid moderators by emailing dx@sendgrid.com.
+
+## Submission to SendGrid Repositories
+Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com). 
+
+## Attribution
+
+SendGrid thanks the following, on which it draws for content and inspiration:
+
+* [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)  
+* [Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct) 
+* [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html) 

data/CONTRIBUTING.md

@@ -0,0 +1,181 @@
+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)
+- [Feature Request](#feature-request)
+- [Submit a Bug Report](#submit-a-bug-report)
+- [Improvements to the Codebase](#improvements-to-the-codebase)
+- [Understanding the Code Base](#understanding-the-codebase)
+- [Testing](#testing)
+- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
+- [Creating a Pull Request](#creating-a-pull-request)
+
+<a name="roadmap"></a>
+We use [Milestones](https://github.com/sendgrid/smtpapi-ruby/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged.
+
+<a name="cla"></a>
+## CLAs and CCLAs
+
+Before you get started, SendGrid requires that a SendGrid Contributor License Agreement (CLA) be filled out by every contributor to a SendGrid open source project.
+
+Our goal with the CLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions.  The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when making a contribution.  In this way the CLA encourages broad participation by our open source community and helps us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution.
+
+SendGrid does not merge a pull request made against a SendGrid open source project until that pull request is associated with a signed CLA. Copies of the CLA are available [here](https://gist.github.com/SendGridDX/98b42c0a5d500058357b80278fde3be8#file-sendgrid_cla).
+
+When you create a Pull Request, after a few seconds, a comment will appear with a link to the CLA. Click the link and fill out the brief form and then click the "I agree" button and you are all set. You will not be asked to re-sign the CLA unless we make a change.
+
+There are a few ways to contribute, which we'll enumerate below:
+
+<a name="feature-request"></a>
+## Feature Request
+
+If you'd like to make a feature request, please read this section.
+
+The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:
+
+- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
+- Please be respectful and considerate of others when commenting on issues.
+
+<a name="submit-a-bug-report"></a>
+## Submit a Bug Report
+
+Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
+
+A software bug is a demonstrable issue in the code base. In order for us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.
+
+Before you decide to create a new issue, please try the following:
+
+1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
+2. Update to the latest version of this code and check if the issue has already been fixed.
+3. Copy and fill in the Bug Report Template we have provided below.
+
+### Please use our Bug Report Template
+
+In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/smtpapi-ruby/.github/ISSUE_TEMPLATE) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
+
+<a name="improvements-to-the-codebase"></a>
+## Improvements to the Codebase
+
+We welcome direct contributions to the smtpapi-ruby code base. Thank you!
+
+### Development Environment ###
+
+#### Install and Run Locally ####
+
+##### Prerequisites #####
+
+- Ruby version 2.2
+- The SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=smtpapi-ruby))
+
+##### Initial setup: #####
+
+```bash
+git clone https://github.com/sendgrid/smtpapi-ruby.git
+cd smtpapi-ruby
+```
+
+##### Execute: #####
+
+See the [examples folder](https://github.com/sendgrid/smtpapi-ruby/tree/master/examples) to get started quickly.
+
+To run the example:
+
+```bash
+ruby examples/example.rb
+```
+
+<a name="understanding-the-codebase"></a>
+## Understanding the Code Base
+
+**/examples**
+
+Working examples that demonstrate usage.
+
+**/tess**
+
+Unit tests
+
+**/lib/smtpapi**
+
+Source code.
+
+<a name="testing"></a>
+## Testing
+
+All PRs require passing tests before the PR will be reviewed.
+
+All test files are in the [`test`](https://github.com/sendgrid/smtpapi-ruby/tree/master/test) directory.
+
+For the purposes of contributing to this repo, please update the [`test.rb`](https://github.com/sendgrid/smtpapi-ruby/blob/master/test/test.rb) file with unit tests as you modify the code.
+
+To run the tests:
+
+```bash
+rake test
+```
+
+<a name="style-guidelines-and-naming-conventions"></a>
+## Style Guidelines & Naming Conventions
+
+Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning.
+
+- [Community Driven Style Guide](https://github.com/bbatsov/ruby-style-guide)
+
+Please run your code through:
+
+- [rubocop](https://github.com/bbatsov/rubocop).
+
+## Creating a Pull Request<a name="creating-a-pull-request"></a>
+
+1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/sendgrid/smtpapi-ruby
+   # Navigate to the newly cloned directory
+   cd smtpapi-ruby
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/sendgrid/smtpapi-ruby
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout <dev-branch>
+   git pull upstream <dev-branch>
+   ```
+
+3. Create a new topic branch (off the main project development branch) to
+   contain your feature, change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Please adhere to these [git commit
+   message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+   or your code is unlikely be merged into the main project. Use Git's
+   [interactive rebase](https://help.github.com/articles/interactive-rebase)
+   feature to tidy up your commits before making them public.
+
+4a. Create tests.
+
+4b. Create or update the example code that demonstrates the functionality of this change to the code.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream master
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
+
+If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 SendGrid JP
+Copyright (c) 2012-2020 Twilio SendGrid, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Makefile

@@ -0,0 +1,7 @@
+.PHONY: install test
+
+install:
+	gem install bundler:1.14.6; bundle install
+
+test:
+	rake test

data/README.md

@@ -1,190 +1,115 @@
-# smtpapi-ruby
-
-This ruby gem allows you to quickly and more easily generate SendGrid X-SMTPAPI headers.
+![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
 
 [![Build Status](https://travis-ci.org/sendgrid/smtpapi-ruby.svg?branch=master)](https://travis-ci.org/SendGrid/smtpapi-ruby)
+[![Gem Version](https://badge.fury.io/rb/smtpapi.svg)](https://badge.fury.io/rb/smtpapi)
+[![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
+[![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
+[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
+[![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/smtpapi-ruby.svg)](https://github.com/sendgrid/smtpapi-ruby/graphs/contributors)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'smtpapi'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install smtpapi
-
-## Usage
-
-### Initializing
-
-```ruby
-header = Smtpapi::Header.new
-```
-
-### to_json
+**This ruby gem allows you to quickly and more easily generate SendGrid X-SMTPAPI headers.**
 
-This gives you back the stringified json formatted X-SMTPAPI header.
 
-```ruby
-header = Smtpapi::Header.new
-header.to_json
-```
+# Announcements
 
-### add_to
+**NEW:** If you're a software engineer who is passionate about #DeveloperExperience and/or #OpenSource, [this is an incredible opportunity to join our #DX team](https://sendgrid.com/careers/role/1421152/?gh_jid=1421152) as a Developer Experience Engineer and work with [@thinkingserious](https://github.com/thinkingserious) and [@aroach](https://github.com/aroach)! Tell your friends :)
 
-```ruby
-header    = Smtpapi::Header.new
-header.add_to('you@youremail.com')                            # to => ['you@youremail.com']
-header.add_to('other@otheremail.com', 'other')                # to => ['you@youremail.com', 'other <other@otheremail.com>']
-header.add_to(['you@youremail.com', 'other@otheremail.com'])  # to => ['you@youremail.com', 'other <other@otheremail.com>', 'you@youremail.com', 'other@otheremail.com']
-```
+All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/smtpapi-ruby/blob/master/CHANGELOG.md).
 
-### set_tos
+# Table of Contents
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Usage](#usage)
+- [Roadmap](#roadmap)
+- [How to Contribute](#contribute)
+- [About](#about)
+- [License](#license)
 
-```ruby
-header    = Smtpapi::Header.new
-header.set_tos(['you@youremail.com', 'other@otheremail.com']) # to => ['you@youremail.com', 'other@otheremail.com']
-```
+<a name="installation"></a>
+# Installation
 
-### add_substitution
-
-```ruby
-header    = Smtpapi::Header.new
-header.add_substitution('keep', ['secret'])        # sub = {keep: ['secret']}
-header.add_substitution('other', ['one', 'two'])   # sub = {keep: ['secret'], other: ['one', 'two']}
-```
-
-### set_substitutions
-
-```ruby
-header    = Smtpapi::Header.new
-header.set_substitutions({'keep' => 'secret'})  # sub = {keep: ['secret']}
-```
-
-### add_unique_arg
-
-```ruby
-header    = Smtpapi::Header.new
-header.add_unique_arg('cat', 'dogs')
-```
+## Prerequisites
 
-### set_unique_args
+- Ruby version 2.2
+- The SendGrid service, starting at the [free level](https://sendgrid.com/free?source=smtpapi-ruby)
 
-```ruby
-header    = Smtpapi::Header.new
-header.set_unique_args({'cow' => 'chicken'})
-header.set_unique_args({'dad' => 'proud'})
-```
+## Install Package
 
-### add_category
+Add this line to your application's Gemfile:
 
-```ruby
-header    = Smtpapi::Header.new
-header.add_category('tactics') # category = ['tactics']
-header.add_category('advanced') # category = ['tactics', 'advanced']
+```bash
+gem 'smtpapi'
 ```
 
-### set_categories
+And then execute:
 
-```ruby
-header    = Smtpapi::Header.new
-header.set_categories(['tactics', 'advanced']) # category = ['tactics', 'advanced']
+```bash
+bundle
 ```
 
-### add_section
+Or install it yourself as:
 
-```ruby
-header    = Smtpapi::Header.new
-header.add_section('-charge-', 'This ship is useless.')
-header.add_section('-bomber-', 'Only for sad vikings.')
+```bash
+gem install smtpapi
 ```
 
-### set_sections
+## Setup Environment Variables
 
-```ruby
-header    = Smtpapi::Header.new
-header.set_sections({'-charge-' => 'This ship is useless.'})
-```
+### Environment Variable
 
-### add_filter
+Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example:
 
-```ruby
-header    = Smtpapi::Header.new
-header.add_filter('footer', 'enable', 1)
-header.add_filter('footer', 'text/html', '<strong>boo</strong>')
+```bash
+echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
+echo "sendgrid.env" >> .gitignore
+source ./sendgrid.env
 ```
 
-### set_filters
+<a name="quick-start"></a>
+# Quick Start
 
 ```ruby
-header    = Smtpapi::Header.new
-filter = {
-  'footer' => {
-    'setting' => {
-      'enable' => 1,
-      "text/plain" => 'You can haz footers!'
-    }
-  }
-}
-header.set_filters(filter)
+header = Smtpapi::Header.new
+header.add_to('test@example.com')
+print header.to_json
 ```
 
-### set_send_at
+<a name="usage"></a>
+# Usage
 
-```ruby
-header    = Smtpapi::Header.new
-lt = Time.local(2014, 8, 29, 17, 56, 35)
-header.set_send_at(lt)
-```
+- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
+- [Example Code](https://github.com/sendgrid/smtpapi-ruby/blob/master/examples)
 
-### set_send_each_at
+<a name="roadmap"></a>
+# Roadmap
 
-```ruby
-header    = Smtpapi::Header.new
-lt1       = Time.local(2014,  8, 29, 17, 56, 35)
-lt2       = Time.local(2013, 12, 31,  0,  0,  0)
-lt3       = Time.local(2015,  9,  1,  4,  5,  6)
-header.set_send_each_at([lt1, lt2, lt3])
-```
+If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/smtpapi-ruby/milestones). We would love to hear your feedback.
 
-### asm_group_id
+<a name="contribute"></a>
+# How to Contribute
 
-This is to specify an [ASM Group](https://sendgrid.com/docs/User_Guide/advanced_suppression_manager.html) for the message.
+We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md) guide for details.
 
-```ruby
-header = Smtpapi::Header.new
-header.set_asm_group(2)
-```
+Quick links:
 
-### set_ip_pool
+- [Feature Request](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#feature_request)
+- [Bug Reports](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#submit_a_bug_report)
+- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#cla)
+- [Improvements to the Codebase](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
 
-[Using IP Pools with the SMTP API Header](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_pools.html)
-```ruby
-header = Smtpapi::Header.new
-header.set_ip_pool("test_pool")
-```
-
-## Contributing
+## Credits
 
-1. Fork it ( http://github.com/sendgridjp/smtpapi-ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+This library was created by [Wataru Sato](https://github.com/awwa) and is now maintained by SendGrid.
 
-## Running Tests
+<a name="about"></a>
+# About
 
-The existing tests in the `test` directory can be run using test gem with the following command:
+smtpapi-ruby is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
 
-```bash
-rake test
-```
+smtpapi-ruby is maintained and funded by SendGrid, Inc. The names and logos for smtpapi-ruby are trademarks of SendGrid, Inc.
 
-## Credits
+<a name="license"></a>
+# License
 
-This library was created by [Wataru Sato](https://github.com/awwa) and is now maintained by SendGrid.
+[The MIT License (MIT)](LICENSE.txt)

data/TROUBLESHOOTING.md

@@ -0,0 +1,17 @@
+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/smtpapi-ruby/issues).
+
+## Table of Contents
+* [Viewing the Request Header](#request-header)
+
+<a name="request-header"></a>
+## Viewing the Request Header
+
+When debugging or testing, it may be useful to exampine the raw request header to compare against the [documented format](https://sendgrid.com/docs/API_Reference/api_v3.html).
+
+You can do this like so:
+
+```ruby
+puts header
+```

data/examples/example.rb

@@ -0,0 +1,81 @@
+require_relative '../lib/smtpapi'
+header = Smtpapi::Header.new
+
+## add_to
+header.add_to('test1@example.com')
+header.add_to('test2@example.com', 'other')
+# header.add_to(['test1@example.com', 'test2@example.com'])
+
+## set_tos
+# header.set_tos(['you@youremail.com', 'other@otheremail.com'])
+# to => ['you@youremail.com', 'other@otheremail.com']
+
+## add_substitution
+# sub = {keep: ['secret']}
+header.add_substitution('keep', ['secret'])
+# sub = {keep: ['secret'], other: ['one', 'two']}
+header.add_substitution('other', %w(one two))
+
+## set_substitutions
+# header.set_substitutions({'keep' => 'secret'})  # sub = {keep: ['secret']}
+
+## add_unique_arg
+header.add_unique_arg('cat', 'dogs')
+
+## set_unique_args
+# header.set_unique_args({'cow' => 'chicken'})
+# header.set_unique_args({'dad' => 'proud'})
+
+## add_category
+# category = ['tactics']
+header.add_category('tactics')
+# category = ['tactics', 'advanced']
+header.add_category('advanced')
+
+## set_categories
+# category = ['tactics', 'advanced']
+# header.set_categories(['tactics', 'advanced'])
+
+## add_section
+header.add_section('-charge-', 'This ship is useless.')
+header.add_section('-bomber-', 'Only for sad vikings.')
+
+## set_sections
+# header.set_sections({'-charge-' => 'This ship is useless.'})
+
+## add_filter
+header.add_filter('footer', 'enable', 1)
+header.add_filter('footer', 'text/html', '<strong>boo</strong>')
+
+## set_filters
+# filter = {
+#   'footer' => {
+#     'setting' => {
+#       'enable' => 1,
+#       "text/plain" => 'You can haz footers!'
+#     }
+#   }
+# }
+# header.set_filters(filter)
+
+## set_send_at
+lt = Time.local(2014, 8, 29, 17, 56, 35)
+header.set_send_at(lt)
+
+## set_send_each_at
+# lt1       = Time.local(2014,  8, 29, 17, 56, 35)
+# lt2       = Time.local(2013, 12, 31,  0,  0,  0)
+# lt3       = Time.local(2015,  9,  1,  4,  5,  6)
+# header.set_send_each_at([lt1, lt2, lt3])
+
+## asm_group_id
+# This is to specify an ASM Group for the message.
+# See: https://sendgrid.com/docs/User_Guide/advanced_suppression_manager.html
+header.set_asm_group(2)
+
+## set_ip_pool
+# Using IP Pools with the SMTP API Header
+# See: https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_pools.html)
+header.set_ip_pool('test_pool')
+
+print header.to_json

data/lib/smtpapi.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 $LOAD_PATH.unshift File.dirname(__FILE__)
 require 'smtpapi/version'
 require 'json'
@@ -116,20 +115,23 @@ module Smtpapi
 
     def to_array
       data = {}
-      data['to'] = @to if @to.length > 0
-      data['sub'] = @sub if @sub.length > 0
-      data['section'] = @section if @section.length > 0
-      data['unique_args'] = @unique_args if @unique_args.length > 0
-      data['category'] = @category if @category.length > 0
-      data['filters'] = @filters if @filters.length > 0
+      data['to'] = @to unless @to.empty?
+      data['sub'] = @sub unless @sub.empty?
+      data['section'] = @section unless @section.empty?
+      data['unique_args'] = @unique_args unless @unique_args.empty?
+      data['category'] = @category unless @category.empty?
+      data['filters'] = @filters unless @filters.empty?
       data['send_at'] = @send_at.to_i unless @send_at.nil?
       data['asm_group_id'] = @asm_group_id.to_i unless @asm_group_id.nil?
       data['ip_pool'] = @ip_pool unless @ip_pool.nil?
       str_each_at = []
+
       @send_each_at.each do |val|
         str_each_at.push(val.to_i)
       end
-      data['send_each_at'] = str_each_at if str_each_at.length > 0
+
+      data['send_each_at'] = str_each_at unless str_each_at.empty?
+
       data
     end
 
@@ -143,8 +145,8 @@ module Smtpapi
     def escape_unicode(str)
       str.unpack('U*').map do |i|
         if i > 65_535
-          "\\u#{format('%04x', ((i - 0x10000) / 0x400 + 0xD800))}"\
-          "\\u#{format('%04x', ((i - 0x10000) % 0x400 + 0xDC00))}" if i > 65_535
+          "\\u#{format('%04x', ((i - 0x10000) / 0x400 + 0xD800))}" \
+          "\\u#{format('%04x', ((i - 0x10000) % 0x400 + 0xDC00))}"
         elsif i > 127
           "\\u#{format('%04x', i)}"
         else

data/lib/smtpapi/version.rb

@@ -2,5 +2,5 @@
 # SendGrid smtpapi
 #
 module Smtpapi
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'.freeze
 end

data/smtpapi.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'smtpapi/version'
 
@@ -18,7 +17,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency('rubocop', '>=0.29.0', '<0.30.0')
   spec.add_development_dependency('test-unit', '~> 3.0')

data/test/test.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'test/unit'
 require './lib/smtpapi'
 
@@ -7,7 +6,7 @@ require './lib/smtpapi'
 #
 class SmtpapiTest < Test::Unit::TestCase
   def test_version
-    assert_equal('0.1.0', Smtpapi::VERSION)
+    assert_equal('0.1.1', Smtpapi::VERSION)
   end
 
   def test_empty
@@ -21,7 +20,8 @@ class SmtpapiTest < Test::Unit::TestCase
     header.add_to('other@otheremail.com', 'Other Name')
     assert_equal(
       '{"to":["you@youremail.com","Other Name <other@otheremail.com>"]}',
-      header.json_string)
+      header.json_string
+    )
   end
 
   def test_add_to_array
@@ -29,7 +29,8 @@ class SmtpapiTest < Test::Unit::TestCase
     header.add_to(['you@youremail.com', 'my@myemail.com'])
     assert_equal(
       '{"to":["you@youremail.com","my@myemail.com"]}',
-      header.json_string)
+      header.json_string
+    )
   end
 
   def test_set_tos
@@ -37,7 +38,8 @@ class SmtpapiTest < Test::Unit::TestCase
     header.set_tos(['you@youremail.com', 'other@otheremail.com'])
     assert_equal(
       '{"to":["you@youremail.com","other@otheremail.com"]}',
-      header.json_string)
+      header.json_string
+    )
   end
 
   def test_add_substitution
@@ -46,7 +48,8 @@ class SmtpapiTest < Test::Unit::TestCase
     header.add_substitution('other', %w(one two))
     assert_equal(
       '{"sub":{"keep":["secret"],"other":["one","two"]}}',
-      header.json_string)
+      header.json_string
+    )
   end
 
   def test_set_substitutions
@@ -63,7 +66,8 @@ class SmtpapiTest < Test::Unit::TestCase
       '{"section":'\
         '{"-charge-":"This ship is useless.",'\
           '"-bomber-":"Only for sad vikings."}}',
-      header.json_string)
+      header.json_string
+    )
   end
 
   def test_set_sections
@@ -175,9 +179,9 @@ class SmtpapiTest < Test::Unit::TestCase
 
   def test_send_each_at
     header = Smtpapi::Header.new
-    localtime1 = Time.local(2014,  8, 29, 17, 56, 35)
-    localtime2 = Time.local(2013, 12, 31,  0,  0,  0)
-    localtime3 = Time.local(2015,  9,  1,  4,  5,  6)
+    localtime1 = Time.local(2014, 8, 29, 17, 56, 35)
+    localtime2 = Time.local(2013, 12, 31, 0, 0, 0)
+    localtime3 = Time.local(2015, 9, 1, 4, 5, 6)
     header.set_send_each_at([localtime1, localtime2, localtime3])
 
     assert_equal(
@@ -201,4 +205,80 @@ class SmtpapiTest < Test::Unit::TestCase
 
     assert_equal('{"ip_pool":"test_pool"}', header.json_string)
   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.md') || 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
+
+  def test_license_date_is_updated
+    license_end_year = IO.read('LICENSE.txt').match(
+      /Copyright \(c\) \d{4}-(\d{4}) Twilio SendGrid/
+    )[1]
+    current_year = Time.new.year
+
+    assert_equal(current_year, license_end_year.to_i)
+  end
 end

data/use_cases/README.md

@@ -0,0 +1,3 @@
+This directory provides examples for specific use cases. Please [open an issue](https://github.com/sendgrid/smtpapi-ruby/issues) or make a pull request for any use cases you would like us to document here. Thank you!
+
+ # Table of Contents

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smtpapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Wataru Sato
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,18 +67,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".env_sample"
+- ".github/ISSUE_TEMPLATE"
+- ".github/PULL_REQUEST_TEMPLATE"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
+- TROUBLESHOOTING.md
+- examples/example.rb
 - lib/smtpapi.rb
 - lib/smtpapi/version.rb
 - smtpapi.gemspec
 - test/test.rb
+- use_cases/README.md
 homepage: https://github.com/sendgrid/smtpapi-ruby
 licenses:
 - MIT
@@ -112,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Smtpapi library for SendGrid.