sendgrid-ruby 1.1.6 → 6.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a0997af40965b55afccbb2fd70def32ed7c8213a
-  data.tar.gz: 2453f6b8577c67c463a30260b5e33e05e5d4d4a9
+SHA256:
+  metadata.gz: 55bf390189f4cd0b16be070f03374d2c3acfbd0ad99ac92acbc531fb9a0e193f
+  data.tar.gz: 245ea8f376252fa963314eaf3680c6552e250d99184d6002fb1e0f9ea02c0473
 SHA512:
-  metadata.gz: 645b595f82306ba093af8d4b6e8465d2e243ca149070a411d5d90295845b8eda5433b6b89c8ffb62db520b949df26a7011d357b978ffa8bce7e1b038b2f0b337
-  data.tar.gz: 6c982e7e5c6c6c5366cc5332019383114d189b6b4d39092b3c33139e56bed3d85da1596a6a4a9b1fcf3818c7d7f774ea43d7412c0b0cf10f3311d7056b26b652
+  metadata.gz: c6a0f18a3efb5331dc4339407b963398815168de2b29b807536e24c74590476761558739d74146f781c2bf3c4552a6afaa15ccdfb809cf97bf05abf437937694
+  data.tar.gz: dfdcfd458cb2d01ef55e480a26cbdbbf1d0135f3379fc0aa534ac58e45c382d374d17fff201093f3db592046180ed327b8beb2deb39b1f51d68ca0581e538863

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/.env_sample

@@ -1,3 +1 @@
-SENDGRID_USERNAME=your_sendgrid_username
-SENDGRID_PASSWORD=your_sendgrid_password
-SENDGRID_APIKEY=your_sendgrid_apikey
+export SENDGRID_API_KEY=''

data/.gitignore

@@ -1,6 +1,7 @@
 # Created by https://www.gitignore.io
 
 ### Ruby ###
+bin
 *.gem
 *.rbc
 /.config

data/.travis.yml

@@ -1,20 +1,31 @@
 language: ruby
 rvm:
-- 2.2
-- 2.0
-- 1.9.3
-notifications:
-  hipchat:
-    rooms:
-      secure: gYBEwOGBTxHE2nrxsHQqp2UdjRtCX04wVLYEimeT9RG/0LClS4nzJF7DaXLWlAwgLPmk+KV2+nXuLO5oausBr9ODmWhho8G0F90RPR47NupcvT1RM+I2ZbxSjHCUICL22mdnZd8ye/mrk/YtFWYmgmH7ILRK3BuYovXFoKoRnLg=
-    template:
-    - '<a href="https://travis-ci.org/%{repository}/builds/%{build_id}">%{repository}
-      Build %{build_number}</a> on branch <i>%{branch}</i> by %{author}: <strong>%{message}</strong>
-      <a href="https://github.com/sendgrid/docs/commits/%{commit}">View on GitHub</a>'
-    format: html
-    notify: false
+- ruby-head
+- 2.6
+- 2.5
+- 2.4
+- jruby
+gemfile:
+- gemfiles/Sinatra_1.gemfile
+- gemfiles/Sinatra_2.gemfile
 before_script:
-    - bundle install
-script:
-    - rubocop --fail-level=E
-    - rake
+- mkdir prism
+- mkdir prism/bin
+- export PATH=$PATH:$PWD/prism/bin/
+- "./test/prism.sh"
+install: make install
+script: make test
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+  fast_finish: true
+deploy:
+  provider: rubygems
+  api_key:
+    secure: CWlfN170i/fHPrIufHHLWQ0utjuhxf4ELSxKeypIuO2CNTqNMzocDAa2vxMt4XfO6d2wFPV/LC+IHR7i+sp7PKvjRoa4BLUUxjfBNDboc0gGESeUYlAxwsJo0tOVCNmpxgjQKqtPLz/19A/v/xpxLv2Im/9Idqa5ATd06sMDdM8=
+  gem: sendgrid-ruby
+  on:
+    tags: true
+    rvm: '2.4'
+    gem: gemfiles/Sinatra_1.gemfile
+    skip_cleanup: true

data/CHANGELOG.md

@@ -1,6 +1,236 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+[2020-01-22] Version 6.0.4
+--------------------------
+**Library - Fix**
+- [PR #404](https://github.com/sendgrid/sendgrid-ruby/pull/404): add skip_cleanup flag to fix travis deploy. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+
+[2020-01-22] Version 6.0.3
+--------------------------
+**Library - Docs**
+- [PR #402](https://github.com/sendgrid/sendgrid-ruby/pull/402): baseline all the templated markdown docs. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-01-08] Version 6.0.2
+--------------------------
+**Library - Fix**
+- [PR #401](https://github.com/sendgrid/sendgrid-ruby/pull/401): Only try to deploy once to rubygems. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+
+[2020-01-03] Version 6.0.1
+--------------------------
+**Library - Chore**
+- [PR #400](https://github.com/sendgrid/sendgrid-ruby/pull/400): Add auto-deploy to travis.yml. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #399](https://github.com/sendgrid/sendgrid-ruby/pull/399): Add testing to Makefile. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #396](https://github.com/sendgrid/sendgrid-ruby/pull/396): Adding Makefile to assist with automation. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+**Library - Fix**
+- [PR #321](https://github.com/sendgrid/sendgrid-ruby/pull/321): TROUBLESHOOTING.md broken link fix. Thanks to [@arshadkazmi42](https://github.com/arshadkazmi42)!
+
+
+[2019-06-04] Version 6.0.0
+--------------------------
+### BREAKING CHANGE
+- [PR #284](https://github.com/sendgrid/sendgrid-ruby/pull/284): The sinatra gem is no longer specified as a dependency of this gem. If you would like to use the inbound processing, please follow the [upgrade guide](https://github.com/sendgrid/sendgrid-ruby/blob/master/UPGRADE.md). Big thanks to [@jjb](https://github.com/jjb) for the PR!
+
+### Added
+- [PR #271](https://github.com/sendgrid/sendgrid-ruby/pull/271): Add ability to impersonate a subuser. Big thanks to [@danilospa](https://github.com/danilospa) for the PR!
+- [PR #278](https://github.com/sendgrid/sendgrid-ruby/pull/278): Make SendGrid permissions management easy. Big thanks to [@sony-mathew](https://github.com/sony-mathew) for the PR!
+- [PR #343](https://github.com/sendgrid/sendgrid-ruby/pull/343) and [PR #345](https://github.com/sendgrid/sendgrid-ruby/pull/345): Update README.md with examples for dynamic templates and corrections to the old legacy template example. Big thanks to [@kylearoberts](https://github.com/kylearoberts) for the PR!
+- [PR #216](https://github.com/sendgrid/sendgrid-ruby/pull/216): Get unassigned IPs example. Big thanks to [@cristianossd](https://github.com/cristianossd) for the PR!
+- [PR #231](https://github.com/sendgrid/sendgrid-ruby/pull/231): Add support for IO objects set as Attachment content. Big thanks to [@awj](https://github.com/awj) for the PR!
+- [PR #232](https://github.com/sendgrid/sendgrid-ruby/pull/232): Add method to check email content for secret keys. Big thanks to [@jaredsilver](https://github.com/jaredsilver) for the PR!
+- [PR #236](https://github.com/sendgrid/sendgrid-ruby/pull/236): Add an IpManagement helper. Big thanks to [@brokenthumbs](https://github.com/brokenthumbs) for the PR!
+- [PR #264](https://github.com/sendgrid/sendgrid-ruby/pull/264): Add Email Statistics helper example. Big thanks to [@jeremyjung](https://github.com/jeremyjung) for the PR!
+- [PR #246](https://github.com/sendgrid/sendgrid-ruby/pull/246): Modified Mail Class calling examples with SendGrid::Mail. Big thanks to [@rohan-techfreak](https://github.com/rohan-techfreak) for the PR!
+- [PR #268](https://github.com/sendgrid/sendgrid-ruby/pull/268): Added Code Review to CONTRIBUTING.md. Big thanks to [@mptap](https://github.com/mptap) for the PR!
+- [PR #276](https://github.com/sendgrid/sendgrid-ruby/pull/276): Codebase Improvement: Use attr_accessor instead of getters and setters. Big thanks to [@rahul26goyal](https://github.com/rahul26goyal) for the PR!
+- [PR #365](https://github.com/sendgrid/sendgrid-ruby/pull/365): Add our Developer Experience Engineer career opportunity to the README. Big thanks to [@mptap](https://github.com/mptap) for the PR!
+
+### Fixes
+- [PR #262](https://github.com/sendgrid/sendgrid-ruby/pull/262): Fix CONTRIBUTING.md formatting. Big thanks to [@thepriefy](https://github.com/thepriefy) for the PR!
+- [PR #277](https://github.com/sendgrid/sendgrid-ruby/pull/277): Fix travis warning. Big thanks to [@rahul26goyal](https://github.com/rahul26goyal) for the PR!
+- [PR #303](https://github.com/sendgrid/sendgrid-ruby/pull/303): Update readme tags and fix minor test failures. Big thanks to [@af4ro](https://github.com/af4ro) for the PR!
+- [PR #370](https://github.com/sendgrid/sendgrid-ruby/pull/370): Remove references to "Whitelabel". Big thanks to [@crweiner](https://github.com/crweiner) for the PR!
+- [PR #383](https://github.com/sendgrid/sendgrid-ruby/pull/383): Correct endpoint for single spam report requests. Big thanks to [@bermannoah](https://github.com/bermannoah) for the PR!
+
+## [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 
+- Thanks to [Awin Abi](https://github.com/awinabi) for the pull request!
+
+## [5.1.0] - 2017-9-1 ##
+### Added
+- #173: Update ruby-http-client dependency
+- [#12](https://github.com/sendgrid/ruby-http-client/pull/12) Add a helper that returns the response body as a hash via the `parsed_body` method in the `Response` object.
+- Thanks to [Diego Camargo](https://github.com/belfazt) for the pull request!
+
+## [5.0.0] - 2017-05-27
+### BREAKING CHANGE
+- #108 Fix unexpected `Mail` `#categories`, `#categories=` behavior
+- Fixed Issue #95 Refactor Mail Helper Array Assignments
+- `personalization.to` becomes `personalization.add_to()`
+- `personalization.cc` becomes `personalization.add_cc()`
+- `personalization.bcc` becomes `personalization.add_bcc()`
+- `personalization.headers` becomes `personalization.add_header()`
+- `personalization.substitutions` becomes `personalization.add_substitution()`
+- `personalization.custom_args` becomes `personalization.add_custom_arg()`
+- `mail.personalizations` becomes `mail.add_personalization()`
+- `mail.contents` becomes `mail.add_content()`
+- `mail.attachments` becomes `mail.add_attachment()`
+- `mail.sections` becomes `mail.add_section()`
+- `mail.headers` becomes `mail.add_header()`
+- `mail.categories` becomes `mail.add_category()`
+- `mail.custom_args` becomes `mail.custom_args()`
+- For a full example of usage, please [see here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/helpers/mail/example.rb#L21).
+
+## [4.3.3] - 2017-5-2
+### Update
+- #157: Specify required ruby version as '>= 2.2'
+- This library does not support [Ruby 2.1 or below](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/).
+- Thanks to [Ryunosuke Sato](https://github.com/tricknotes) for the pull request!
+
+## [4.3.2] - 2017-5-1 ##
+### Fixes
+- #161: Fixed problematic Sinatra dependency
+- Brings back Rails 4 compatibility (and Rack 1.x applications, in general), also removes release candidate version constraint (both broken in #160). Moreover, ensures that tests are run against two major Sinatra versions, which should protect from compatibility issues in future, somewhat. Related issue: #159.
+- Thanks to [Sebastian Skałacki](https://github.com/skalee) for the pull request!
+
+## [4.3.1] - 2017-4-12 ##
+### Fixes
+- #160: Updated sinatra version to 2.0
+- Fixes bundler dependency issues with rails >5.0 and rack 2.0. Solves #159
+- Thanks to [gkats](https://github.com/gkats) for the pull request!
+
+## [4.3.0] - 2017-4-12 ##
+### Added
+- #70: Adds an account settings management helper object
+- See the [helper README](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/settings) for details
+- Thanks to [Kyle Kern](https://github.com/kernkw) for the pull request!
+
+## [4.2.1] - 2017-4-10 ##
+### Fixed
+- #112: Fixes version ambiguity in gemspec
+- Thanks to [Chris McKnight](https://github.com/cmckni3) for the pull request!
+
+## [4.2.0] - 2017-4-10 ##
+### Added
+- #148: Set api_key to empty string
+- This makes creating an API key for a SendGrid subuser who does not have an API key easier. See #146 for details
+- Thanks to [Adam Beck](https://github.com/Gwash3189) for the pull request!
+
+## [4.1.1] - 2017-4-6 ##
+### Fixed
+- #115 #134: Fix typos in initialize methods
+- Thanks to [Ben Jackson](https://github.com/benjackson84) for the pull request!
+
+## [4.1.0] - 2017-4-6 ##
+### Add
+- #144: Add [Inbound Email Parse Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/inbound_email.html) support
+- Thanks to [Wataru Sato](https://github.com/awwa) for the pull request!
+
+## [4.0.8] - 2017-2-17 ##
+### Add
+- Solves #147: Add User Agent string
+
+## [4.0.7] - 2017-1-25 ##
+### Fixes
+- [Pull Request #7](https://github.com/sendgrid/ruby-http-client/pull/7)
+- Fixes [issue #6](https://github.com/sendgrid/ruby-http-client/issues/6): TLS certificates not verified
+- Thanks to [Koen Rouwhorst](https://github.com/koenrh) for the pull request!
+
+## [4.0.6] - 2016-10-18 ##
+### Added
+- Pull #113: Fix Travis CI Prism functionality for non-SendGrid contributors, update deprecated File.exists
+
+## [4.0.5] - 2016-10-17 ##
+### Added
+- Pull #110, fixed Issue #109
+- Automates StopLight.io Prism mock server locally & on Travis CI
+- Thanks to [KY](https://github.com/tkbky) for the pull request!
+
+## [4.0.4] - 2016-09-15 ##
+### Fixed
+- Pull #72: [remove unnecessary ruby 2.2 requirement](https://github.com/sendgrid/sendgrid-ruby/pull/72)
+- Thanks to [Billy Watson](https://github.com/billywatson) for the pull request!
+
+## [4.0.3] - 2016-08-24 ##
+### Added
+- Table of Contents in the README
+- Added a [USE_CASES.md](https://github.com/sendgrid/sendgrid-ruby/blob/master/USE_CASES.md) section, with the first use case example for transactional templates
+
+## [4.0.2] - 2016-07-26 ##
+### Fixed
+- Example and USAGE DELETE calls were missing example payloads
+
+## [4.0.1] - 2016-07-25 ##
+### Added
+- [Troubleshooting](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md) section
+
+## [4.0.0] - 2016-07-23 ##
+### 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!
+
+## [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
+
+## [3.0.5] - 2016-07-05 ##
+### Added
+- Accept: application/json header per https://sendgrid.com/docs/API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/requests.html
+
+### Updated
+- Content based on our updated [Swagger/OAI doc](https://github.com/sendgrid/sendgrid-oai)
+
+## [3.0.4] - 2016-06-15 ##
+### Added
+- Updated dependency on ruby-http-client
+
+## [3.0.3] - 2016-06-15 ##
+### Fixing
+- Import structure
+
+## [3.0.2] - 2016-06-15 ##
+### Added
+- Relative import for mail/helper
+
+## [3.0.1] - 2016-06-15 ##
+### Added
+- Add mail/send helper to the $LOAD_PATH, updated http client dependency
+
+## [3.0.0] - 2016-06-13 ##
+### Added
+- Breaking change to support the v3 Web API
+- New HTTP client
+- v3 Mail Send helper
+
 ## [1.1.6] - 2015-11-26 ##
 ## Added
 Support for cc_name and bcc_name via [#31](https://github.com/sendgrid/sendgrid-ruby/pull/31)
@@ -24,4 +254,4 @@ Inline content support
 
 ## [1.0.3] - 2015-10-01 ##
 ### Fixed
-Payload 'to' attribute fix for smtpapi
+Payload 'to' attribute fix for smtpapi

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at open-source@twilio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/CONTRIBUTING.md

@@ -0,0 +1,214 @@
+Hello! Thank you for choosing to help contribute to one of the Twilio 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.
+
+**All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.**
+- [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)
+  - [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--naming-conventions)
+- [Creating a Pull Request](#creating-a-pull-request)
+- [Code Reviews](#code-reviews)
+
+<a name="roadmap"></a>
+We use [Milestones](https://github.com/sendgrid/sendgrid-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.
+
+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 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/sendgrid-ruby/ISSUE_TEMPLATE.md) (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 sendgrid-ruby code base. Thank you!
+
+### Development Environment ###
+
+#### Install and Run Locally ####
+
+##### Prerequisites #####
+
+- Ruby 2.1+
+- [ruby_http_client](https://github.com/sendgrid/ruby-http-client)
+
+
+##### Initial setup: #####
+
+1. Clone the project
+
+   ```bash
+   git clone https://github.com/sendgrid/sendgrid-ruby.git
+   cd sendgrid-ruby
+   ```
+
+1. Install bundler and bundle
+
+   ```bash
+   bundle install
+   ```
+
+### Environment Variables
+
+First, get your free Twilio 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).
+
+```bash
+echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
+echo "sendgrid.env" >> .gitignore
+source ./sendgrid.env
+```
+
+##### Execute: #####
+
+See the [examples folder](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples) to get started quickly.
+
+To run the examples using the local version of this library from the root directory of this repo, please replace:
+
+`require 'sendgrid-ruby'`
+
+with:
+
+`require_relative './lib/sendgrid-ruby.rb'`
+
+Then run using:
+
+```bash
+ruby example.rb
+```
+
+<a name="understanding-the-codebase"></a>
+## Understanding the Code Base
+
+**/examples**
+
+Working examples that demonstrate usage.
+
+**/test**
+
+Tests for the mail send and Web API v3 endpoints.
+
+**/lib**
+
+The Web API v3 client is `sendgrid-ruby.rb`
+
+<a name="testing"></a>
+## Testing
+
+All PRs require passing tests before the PR will be reviewed.
+
+All test files are in the [`tests`](https://github.com/sendgrid/sendgrid-ruby/tree/master/test) directory.
+
+For the purposes of contributing to this repo, please update the [`test_sendgrid-ruby.rb`](https://github.com/sendgrid/sendgrid-ruby/blob/master/test/test_sendgrid-ruby.rb) file with unit tests as you modify the code.
+
+To run the tests:
+
+```bash
+rake
+```
+
+<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).
+
+<a name="creating-a-pull-request"></a>
+## Creating a Pull Request
+
+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/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
+   ```
+
+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.
+
+<a name="code-reviews"></a>
+## Code Reviews
+
+If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, Github has some [great information on how to review a Pull Request](https://help.github.com/articles/about-pull-request-reviews/).

data/Gemfile

@@ -1,5 +1,6 @@
-gem 'dotenv-rails'
-gem 'smtpapi'
-gem 'rest-client'
-source 'https://rubygems.org'
+source 'http://rubygems.org'
+
 gemspec
+
+gem 'ruby_http_client'
+

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,26 @@
+<!--
+If this is a feature request, make sure you search Issues for an existing request before creating a new one!
+-->
+
+### 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, or code examples.
+
+### Steps to Reproduce
+1. This is the first step
+2. This is the second step
+3. Further steps, etc.
+
+### Code Snippet
+```ruby
+# paste code here
+```
+
+### Exception/Log
+```
+# paste exception/log here
+```
+
+### Technical details:
+* sendgrid-ruby version:
+* ruby version:
+