smtpapi 0.1.7 → 0.1.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +2 -3
  3. data/CHANGELOG.md +9 -0
  4. data/CONTRIBUTING.md +8 -8
  5. data/FIRST_TIMERS.md +79 -0
  6. data/README.md +9 -9
  7. data/TROUBLESHOOTING.md +1 -1
  8. data/USAGE.md +1 -1
  9. data/lib/smtpapi/version.rb +1 -1
  10. data/smtpapi.gemspec +1 -1
  11. data/static/img/github-fork.png +0 -0
  12. data/static/img/github-sign-up.png +0 -0
  13. data/test/test.rb +1 -1
  14. data/twilio_sendgrid_logo.png +0 -0
  15. metadata +10 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f703034c8bca559b9820a2141798ab17659d5d6bebacbbd710a5e11c8c94be82
4
- data.tar.gz: '08d97aaf3b6a07da8a6f0f167e75b6dfaf23a9d7250a0cbed9753d36c1d0b5f8'
3
+ metadata.gz: 03db13b8fad2cfff41a85a74ae3d5b43c463b358c35bcad5a8d7dfa8ae1f06b3
4
+ data.tar.gz: 2e6fc93174ddd3aa70ddfe929b2df651d07c0f16926e6cc71c44b2c4a91fc96f
5
5
  SHA512:
6
- metadata.gz: 320e0446b122b8b0b639e812d6373922c94f2c7475752797878d8252edef29eafb87ef938c33cd9efc03eca34a6561f84f83525014a8f90de8084916297bbb3f
7
- data.tar.gz: 5d068b0ff4304e658ed7090d255a6133a0a113ee09e564384ae3d564547984ec9f534c79997fa4d04778cc8b4f2491f7a18b1905433000386378de63023e6806
6
+ metadata.gz: aa7d466509d90184e2c5c926af626e4a2105b063d5837f986736086dd541c2bc0b792bd1bad9a49cb8ee591c4ad42db8ea39b94795692bc0786e526e84961c8c
7
+ data.tar.gz: ce4488347de557411bb13a8b197d617e84b4148b72d17d130f00b6c6ce24a56a91cd7d5f44aba9a2ddc6d174af3a945e2431e767ed1abf949752657706b88f53
data/.travis.yml CHANGED
@@ -7,10 +7,9 @@ rvm:
7
7
  - 2.4
8
8
  - jruby-9.2
9
9
  before_script:
10
- - bundle install
10
+ - make install
11
11
  script:
12
- - rubocop --fail-level=W
13
- - rake test
12
+ - make test
14
13
  matrix:
15
14
  allow_failures:
16
15
  - rvm: ruby-head
data/CHANGELOG.md CHANGED
@@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file.
3
3
 
4
4
  This project adheres to [Semantic Versioning](http://semver.org/).
5
5
 
6
+ [2020-08-19] Version 0.1.8
7
+ --------------------------
8
+ **Library - Docs**
9
+ - [PR #72](https://github.com/sendgrid/smtpapi-ruby/pull/72): Update *.md files using Grammarly. Thanks to [@anatolyyyyyy](https://github.com/anatolyyyyyy)!
10
+
11
+ **Library - Chore**
12
+ - [PR #96](https://github.com/sendgrid/smtpapi-ruby/pull/96): update GitHub branch references to use HEAD. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
13
+
14
+
6
15
  [2020-08-05] Version 0.1.7
7
16
  --------------------------
8
17
  **Library - Chore**
data/CONTRIBUTING.md CHANGED
@@ -1,4 +1,4 @@
1
- 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.
1
+ 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.
2
2
 
3
3
  - [Feature Request](#feature-request)
4
4
  - [Submit a Bug Report](#submit-a-bug-report)
@@ -9,7 +9,7 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
9
9
  - [Creating a Pull Request](#creating-a-pull-request)
10
10
  - [Code Reviews](#code-reviews)
11
11
 
12
- 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.
12
+ 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.
13
13
 
14
14
  <a name="feature-request"></a>
15
15
  ## Feature Request
@@ -61,7 +61,7 @@ cd smtpapi-ruby
61
61
 
62
62
  ##### Execute: #####
63
63
 
64
- See the [examples folder](https://github.com/sendgrid/smtpapi-ruby/tree/master/examples) to get started quickly.
64
+ See the [examples folder](examples) to get started quickly.
65
65
 
66
66
  To run the example:
67
67
 
@@ -89,9 +89,9 @@ Source code.
89
89
 
90
90
  All PRs require passing tests before the PR will be reviewed.
91
91
 
92
- All test files are in the [`test`](https://github.com/sendgrid/smtpapi-ruby/tree/master/test) directory.
92
+ All test files are in the [`test`](test) directory.
93
93
 
94
- 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.
94
+ For the purposes of contributing to this repo, please update the [`test.rb`](test/test.rb) file with unit tests as you modify the code.
95
95
 
96
96
  To run the tests:
97
97
 
@@ -140,7 +140,7 @@ Please run your code through:
140
140
 
141
141
  4. Commit your changes in logical chunks. Please adhere to these [git commit
142
142
  message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
143
- or your code is unlikely be merged into the main project. Use Git's
143
+ or your code is unlikely to be merged into the main project. Use Git's
144
144
  [interactive rebase](https://help.github.com/articles/interactive-rebase)
145
145
  feature to tidy up your commits before making them public.
146
146
 
@@ -151,7 +151,7 @@ Please run your code through:
151
151
  5. Locally merge (or rebase) the upstream development branch into your topic branch:
152
152
 
153
153
  ```bash
154
- git pull [--rebase] upstream master
154
+ git pull [--rebase] upstream main
155
155
  ```
156
156
 
157
157
  6. Push your topic branch up to your fork:
@@ -161,7 +161,7 @@ Please run your code through:
161
161
  ```
162
162
 
163
163
  7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
164
- with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
164
+ with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
165
165
 
166
166
  <a name="code-reviews"></a>
167
167
  ## Code Reviews
data/FIRST_TIMERS.md ADDED
@@ -0,0 +1,79 @@
1
+ # How To Contribute to Twilio SendGrid Repositories via GitHub
2
+ Contributing to the Twilio SendGrid repositories is easy! All you need to do is find an open issue (see the bottom of this page for a list of repositories containing open issues), fix it and submit a pull request. Once you have submitted your pull request, the team can easily review it before it is merged into the repository.
3
+
4
+ To make a pull request, follow these steps:
5
+
6
+ 1. Log into GitHub. If you do not already have a GitHub account, you will have to create one in order to submit a change. Click the Sign up link in the upper right-hand corner to create an account. Enter your username, password, and email address. If you are an employee of Twilio SendGrid, please use your full name with your GitHub account and enter Twilio SendGrid as your company so we can easily identify you.
7
+
8
+ <img src="/static/img/github-sign-up.png" width="800">
9
+
10
+ 2. __[Fork](https://help.github.com/fork-a-repo/)__ the [smtpapi-php](https://github.com/sendgrid/smtpapi-php) repository:
11
+
12
+ <img src="/static/img/github-fork.png" width="800">
13
+
14
+ 3. __Clone__ your fork via the following commands:
15
+
16
+ ```bash
17
+ # Clone your fork of the repo into the current directory
18
+ git clone https://github.com/your_username/smtpapi-php
19
+ # Navigate to the newly cloned directory
20
+ cd smtpapi-php
21
+ # Assign the original repo to a remote called "upstream"
22
+ git remote add upstream https://github.com/sendgrid/smtpapi-php
23
+ ```
24
+
25
+ > Don't forget to replace *your_username* in the URL by your real GitHub username.
26
+
27
+ 4. __Create a new topic branch__ (off the main project development branch) to contain your feature, change, or fix:
28
+
29
+ ```bash
30
+ git checkout -b <topic-branch-name>
31
+ ```
32
+
33
+ 5. __Commit your changes__ in logical chunks.
34
+
35
+ 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. Probably you will also have to create tests (if needed) or create or update the example code that demonstrates the functionality of this change to the code.
36
+
37
+ 6. __Locally merge (or rebase)__ the upstream development branch into your topic branch:
38
+
39
+ ```bash
40
+ git pull [--rebase] upstream main
41
+ ```
42
+
43
+ 7. __Push__ your topic branch up to your fork:
44
+
45
+ ```bash
46
+ git push origin <topic-branch-name>
47
+ ```
48
+
49
+ 8. __[Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository/)__ with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
50
+
51
+ ## Important notice
52
+
53
+ Before creating a pull request, make sure that you respect the repository's constraints regarding contributions. You can find them in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
54
+
55
+ ## Repositories with Open, Easy, Help Wanted, Issue Filters
56
+
57
+ * [Python SDK](https://github.com/sendgrid/sendgrid-python/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
58
+ * [PHP SDK](https://github.com/sendgrid/sendgrid-php/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
59
+ * [C# SDK](https://github.com/sendgrid/sendgrid-csharp/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
60
+ * [Ruby SDK](https://github.com/sendgrid/sendgrid-ruby/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
61
+ * [Node.js SDK](https://github.com/sendgrid/sendgrid-nodejs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
62
+ * [Java SDK](https://github.com/sendgrid/sendgrid-java/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
63
+ * [Go SDK](https://github.com/sendgrid/sendgrid-go/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
64
+ * [Python STMPAPI Client](https://github.com/sendgrid/smtpapi-python/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
65
+ * [PHP STMPAPI Client](https://github.com/sendgrid/smtpapi-php/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
66
+ * [C# STMPAPI Client](https://github.com/sendgrid/smtpapi-csharp/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
67
+ * [Ruby STMPAPI Client](https://github.com/sendgrid/smtpapi-ruby/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
68
+ * [Node.js STMPAPI Client](https://github.com/sendgrid/smtpapi-nodejs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
69
+ * [Java STMPAPI Client](https://github.com/sendgrid/smtpapi-java/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
70
+ * [Go STMPAPI Client](https://github.com/sendgrid/smtpapi-go/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
71
+ * [Python HTTP Client](https://github.com/sendgrid/python-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
72
+ * [PHP HTTP Client](https://github.com/sendgrid/php-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
73
+ * [C# HTTP Client](https://github.com/sendgrid/csharp-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
74
+ * [Java HTTP Client](https://github.com/sendgrid/java-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
75
+ * [Ruby HTTP Client](https://github.com/sendgrid/ruby-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
76
+ * [Go HTTP Client](https://github.com/sendgrid/rest/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
77
+ * [Open API Definition](https://github.com/sendgrid/sendgrid-oai/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
78
+ * [DX Automator](https://github.com/sendgrid/dx-automator/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
79
+ * [Documentation](https://github.com/sendgrid/docs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
- ![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
1
+ ![SendGrid Logo](twilio_sendgrid_logo.png)
2
2
 
3
- [![Build Status](https://travis-ci.org/sendgrid/smtpapi-ruby.svg?branch=master)](https://travis-ci.org/SendGrid/smtpapi-ruby)
3
+ [![Build Status](https://travis-ci.org/sendgrid/smtpapi-ruby.svg?branch=main)](https://travis-ci.org/SendGrid/smtpapi-ruby)
4
4
  [![Gem Version](https://badge.fury.io/rb/smtpapi.svg)](https://badge.fury.io/rb/smtpapi)
5
5
  [![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
6
6
  [![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
@@ -13,7 +13,7 @@
13
13
  # Announcements
14
14
  **The default branch name for this repository has been changed to `main` as of 07/27/2020.**
15
15
 
16
- All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/smtpapi-ruby/blob/master/CHANGELOG.md).
16
+ All updates to this library is documented in our [CHANGELOG](CHANGELOG.md).
17
17
 
18
18
  # Table of Contents
19
19
  - [Installation](#installation)
@@ -77,7 +77,7 @@ print header.to_json
77
77
  # Usage
78
78
 
79
79
  - [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
80
- - [Example Code](https://github.com/sendgrid/smtpapi-ruby/blob/master/examples)
80
+ - [Example Code](examples)
81
81
 
82
82
  <a name="roadmap"></a>
83
83
  # Roadmap
@@ -87,14 +87,14 @@ If you are interested in the future direction of this project, please take a loo
87
87
  <a name="contribute"></a>
88
88
  # How to Contribute
89
89
 
90
- We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md) guide for details.
90
+ We encourage contribution to our libraries, please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
91
91
 
92
92
  Quick links:
93
93
 
94
- - [Feature Request](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#feature_request)
95
- - [Bug Reports](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#submit_a_bug_report)
96
- - [Improvements to the Codebase](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
97
- - [Review Pull Requests](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#code-reviews)
94
+ - [Feature Request](CONTRIBUTING.md#feature_request)
95
+ - [Bug Reports](CONTRIBUTING.md#submit_a_bug_report)
96
+ - [Improvements to the Codebase](CONTRIBUTING.md#improvements_to_the_codebase)
97
+ - [Review Pull Requests](CONTRIBUTING.md#code-reviews)
98
98
 
99
99
  ## Credits
100
100
 
data/TROUBLESHOOTING.md CHANGED
@@ -8,7 +8,7 @@ If you can't find a solution below, please open an [issue](https://github.com/se
8
8
  <a name="request-header"></a>
9
9
  ## Viewing the Request Header
10
10
 
11
- 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).
11
+ When debugging or testing, it may be useful to examine the raw request header to compare against the [documented format](https://sendgrid.com/docs/API_Reference/api_v3.html).
12
12
 
13
13
  You can do this like so:
14
14
 
data/USAGE.md CHANGED
@@ -1,4 +1,4 @@
1
1
  # Usage
2
2
 
3
3
  - [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
4
- - [Example Code](https://github.com/sendgrid/smtpapi-ruby/blob/master/examples)
4
+ - [Example Code](examples)
data/lib/smtpapi/version.rb CHANGED
@@ -2,5 +2,5 @@
2
2
  # SendGrid smtpapi
3
3
  #
4
4
  module Smtpapi
5
- VERSION = '0.1.7'.freeze
5
+ VERSION = '0.1.8'.freeze
6
6
  end
data/smtpapi.gemspec CHANGED
@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
20
20
  spec.add_development_dependency 'rake'
21
21
  spec.add_development_dependency('rubocop', '>=0.29.0', '<0.30.0')
22
22
  spec.add_development_dependency('test-unit', '~> 3.0')
23
- spec.add_development_dependency 'simplecov'
23
+ spec.add_development_dependency('simplecov', '~> 0.18.5')
24
24
  end
data/test/test.rb CHANGED
@@ -7,7 +7,7 @@ require './lib/smtpapi'
7
7
  #
8
8
  class SmtpapiTest < Test::Unit::TestCase
9
9
  def test_version
10
- assert_equal('0.1.7', Smtpapi::VERSION)
10
+ assert_equal('0.1.8', Smtpapi::VERSION)
11
11
  end
12
12
 
13
13
  def test_empty
data/twilio_sendgrid_logo.png ADDED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: smtpapi
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.7
4
+ version: 0.1.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Wataru Sato
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2020-08-05 00:00:00.000000000 Z
12
+ date: 2020-08-19 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: rake
@@ -63,16 +63,16 @@ dependencies:
63
63
  name: simplecov
64
64
  requirement: !ruby/object:Gem::Requirement
65
65
  requirements:
66
- - - ">="
66
+ - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: '0'
68
+ version: 0.18.5
69
69
  type: :development
70
70
  prerelease: false
71
71
  version_requirements: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - ">="
73
+ - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: '0'
75
+ version: 0.18.5
76
76
  description: Smtpapi library for SendGrid.
77
77
  email:
78
78
  - awwa500@gmail.com
@@ -89,6 +89,7 @@ files:
89
89
  - CHANGELOG.md
90
90
  - CODE_OF_CONDUCT.md
91
91
  - CONTRIBUTING.md
92
+ - FIRST_TIMERS.md
92
93
  - Gemfile
93
94
  - ISSUE_TEMPLATE.md
94
95
  - LICENSE.md
@@ -102,8 +103,11 @@ files:
102
103
  - lib/smtpapi.rb
103
104
  - lib/smtpapi/version.rb
104
105
  - smtpapi.gemspec
106
+ - static/img/github-fork.png
107
+ - static/img/github-sign-up.png
105
108
  - test/test.rb
106
109
  - test/test_helper.rb
110
+ - twilio_sendgrid_logo.png
107
111
  - use_cases/README.md
108
112
  homepage: https://github.com/sendgrid/smtpapi-ruby
109
113
  licenses: