smtpapi 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67133d1164778251a9c37490925e80fc1d87111a90ab856fc3c5d3389e8f0905
-  data.tar.gz: be492d0b300754ac81fe33483a7f2d41ce9c349681f302f80135e7b7b9e6e3de
+  metadata.gz: f703034c8bca559b9820a2141798ab17659d5d6bebacbbd710a5e11c8c94be82
+  data.tar.gz: '08d97aaf3b6a07da8a6f0f167e75b6dfaf23a9d7250a0cbed9753d36c1d0b5f8'
 SHA512:
-  metadata.gz: 84814ed5deacb38587faac01a58fd9b01d6935dc784566037b156293a55cf665cfe96edc744722a85871b0932942fe805dc1dedcdb2a6d341062adff749de83d
-  data.tar.gz: f0a3d5da5f36f16e120124640194f61e244a81d55f269bbeaf161896efb14f5a49eb1eddda9b4a4625be245a8e5dd2d0fb63a65c6d64211cc6e0072edca9cb10
+  metadata.gz: 320e0446b122b8b0b639e812d6373922c94f2c7475752797878d8252edef29eafb87ef938c33cd9efc03eca34a6561f84f83525014a8f90de8084916297bbb3f
+  data.tar.gz: 5d068b0ff4304e658ed7090d255a6133a0a113ee09e564384ae3d564547984ec9f534c79997fa4d04778cc8b4f2491f7a18b1905433000386378de63023e6806

data/.travis.yml

@@ -1,18 +1,19 @@
 language: ruby
 rvm:
-- ruby-head
-- 2.6
-- 2.5
-- 2.4
-- jruby
+  - ruby-head
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
+  - jruby-9.2
 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
+    - rvm: ruby-head
   fast_finish: true
 deploy:
   provider: rubygems
@@ -22,3 +23,13 @@ deploy:
   on:
     tags: true
     rvm: '2.4'
+    skip_cleanup: true
+
+notifications:
+  slack:
+    if: branch = main
+    on_pull_requests: false
+    on_success: never
+    on_failure: change
+    rooms:
+      - secure: kyDurUDtXcp+6SfpFeszmzRZEpl2IOFqevGelhKVfx7j+M+p1wvPCkv9vnSdpKaZbQ80EKORxS4ZsnKUL9/yOP2uF9mrzB/DCfzFynw/IVfBejM8nkbf/CmosFh0SkkLuwotaPeqMhAtg1J8Avk1HVKJmihaJfkD6kzQ3PSyKlw=

data/CHANGELOG.md

@@ -3,6 +3,37 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+[2020-08-05] Version 0.1.7
+--------------------------
+**Library - Chore**
+- [PR #36](https://github.com/sendgrid/smtpapi-ruby/pull/36): fix CodeClimate suggestions. Thanks to [@valterbarros](https://github.com/valterbarros)!
+
+
+[2020-07-22] Version 0.1.6
+--------------------------
+**Library - Docs**
+- [PR #82](https://github.com/sendgrid/smtpapi-ruby/pull/82): Create usage.md file. Thanks to [@prathamsharma92](https://github.com/prathamsharma92)!
+- [PR #83](https://github.com/sendgrid/smtpapi-ruby/pull/83): add code review section in contributions. Thanks to [@prathamsharma92](https://github.com/prathamsharma92)!
+
+
+[2020-03-04] Version 0.1.5
+--------------------------
+**Library - Chore**
+- [PR #95](https://github.com/sendgrid/smtpapi-ruby/pull/95): add Ruby 2.7 to Travis. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-02-19] Version 0.1.4
+--------------------------
+**Library - Chore**
+- [PR #87](https://github.com/sendgrid/smtpapi-ruby/pull/87): Add test coverage analysis. Thanks to [@RolandBurrows](https://github.com/RolandBurrows)!
+
+
+[2020-01-22] Version 0.1.3
+--------------------------
+**Library - Fix**
+- [PR #94](https://github.com/sendgrid/smtpapi-ruby/pull/94): add skip_cleanup flag to fix travis deploy. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+
 [2020-01-22] Version 0.1.2
 --------------------------
 **Library - Docs**

data/CONTRIBUTING.md

@@ -1,7 +1,5 @@
 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)
@@ -9,23 +7,10 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
 - [Testing](#testing)
 - [Style Guidelines & Naming Conventions](#style-guidelines-and-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/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
 
@@ -51,7 +36,7 @@ Before you decide to create a new issue, please try the following:
 
 ### 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/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.
+In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).
 
 <a name="improvements-to-the-codebase"></a>
 ## Improvements to the Codebase
@@ -178,4 +163,7 @@ Please run your code through:
 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 <a href="https://help.github.com/articles/about-pull-request-reviews/">information on how to review a Pull Request.</a>

data/ISSUE_TEMPLATE.md

@@ -1,5 +1,9 @@
 <!--
 If this is a feature request, make sure you search Issues for an existing request before creating a new one!
+
+Please utilize the template below to help us resolve your issue.
+
+Note that many issues can be resolved by updating to the latest version.
 -->
 
 ### Issue Summary
@@ -21,6 +25,6 @@ A summary of the issue and the environment in which it occurs. If suitable, incl
 ```
 
 ### Technical details:
-* smtpapi-ruby version:
+* smtpapi-ruby version: 
 * ruby version:
 

data/PULL_REQUEST_TEMPLATE.md

@@ -23,7 +23,7 @@ A short description of what this PR does.
 - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
 - [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md) and my PR follows them
 - [ ] I have titled the PR appropriately
-- [ ] I have updated my branch with the master branch
+- [ ] I have updated my branch with the main 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 inline documentation to the code I modified

data/README.md

@@ -10,10 +10,8 @@
 
 **This ruby gem allows you to quickly and more easily generate SendGrid X-SMTPAPI headers.**
 
-
 # Announcements
-
-**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 :)
+**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
 
 All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/smtpapi-ruby/blob/master/CHANGELOG.md).
 
@@ -31,7 +29,7 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/
 
 ## Prerequisites
 
-- Ruby version 2.2
+- Ruby version >= 2.4
 - The SendGrid service, starting at the [free level](https://sendgrid.com/free?source=smtpapi-ruby)
 
 ## Install Package
@@ -95,8 +93,8 @@ Quick links:
 
 - [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)
+- [Review Pull Requests](https://github.com/sendgrid/smtpapi-ruby/blob/master/CONTRIBUTING.md#code-reviews)
 
 ## Credits
 
@@ -105,9 +103,11 @@ This library was created by [Wataru Sato](https://github.com/awwa) and is now ma
 <a name="about"></a>
 # About
 
-smtpapi-ruby is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
+smtpapi-ruby is maintained and funded by Twilio SendGrid, Inc. The names and logos for smtpapi-ruby are trademarks of Twilio SendGrid, Inc.
+
+If you need help installing or using the library, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).
 
-smtpapi-ruby is maintained and funded by SendGrid, Inc. The names and logos for smtpapi-ruby are trademarks of SendGrid, Inc.
+If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
 
 <a name="license"></a>
 # License

data/USAGE.md

@@ -0,0 +1,4 @@
+# Usage
+
+- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
+- [Example Code](https://github.com/sendgrid/smtpapi-ruby/blob/master/examples)

data/lib/smtpapi.rb

@@ -81,9 +81,7 @@ module Smtpapi
 
     def add_filter(filter_name, parameter_name, parameter_value)
       @filters[filter_name] = {} if @filters[filter_name].nil?
-      if @filters[filter_name]['settings'].nil?
-        @filters[filter_name]['settings'] = {}
-      end
+      @filters[filter_name]['settings'] = {} if @filters[filter_name]['settings'].nil?
       @filters[filter_name]['settings'][parameter_name] = parameter_value
       self
     end
@@ -140,7 +138,8 @@ module Smtpapi
     def json_string
       escape_unicode(to_array.to_json)
     end
-    alias_method :to_json, :json_string
+
+    alias :to_json :json_string
 
     def escape_unicode(str)
       str.unpack('U*').map do |i|

data/lib/smtpapi/version.rb

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

data/smtpapi.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency('rubocop', '>=0.29.0', '<0.30.0')
   spec.add_development_dependency('test-unit', '~> 3.0')
+  spec.add_development_dependency 'simplecov'
 end

data/test/test.rb

@@ -1,3 +1,4 @@
+require 'test_helper'
 require 'test/unit'
 require './lib/smtpapi'
 
@@ -6,7 +7,7 @@ require './lib/smtpapi'
 #
 class SmtpapiTest < Test::Unit::TestCase
   def test_version
-    assert_equal('0.1.2', Smtpapi::VERSION)
+    assert_equal('0.1.7', Smtpapi::VERSION)
   end
 
   def test_empty

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smtpapi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Wataru Sato
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,6 +59,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
 description: Smtpapi library for SendGrid.
 email:
 - awwa500@gmail.com
@@ -83,11 +97,13 @@ files:
 - README.md
 - Rakefile
 - TROUBLESHOOTING.md
+- USAGE.md
 - examples/example.rb
 - lib/smtpapi.rb
 - lib/smtpapi/version.rb
 - smtpapi.gemspec
 - test/test.rb
+- test/test_helper.rb
 - use_cases/README.md
 homepage: https://github.com/sendgrid/smtpapi-ruby
 licenses:
@@ -108,9 +124,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Smtpapi library for SendGrid.
 test_files:
 - test/test.rb
+- test/test_helper.rb