Merge branch 'master' into master

Author: Matt Bernier

.github/PULL_REQUEST_TEMPLATE

@@ -1,29 +1,24 @@
-<!-- 
-Please explain WHAT you changed and WHY.
+<!--
+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.
 
-The title should be descriptive, for example:
 
-* *Fixed a typo in the apikeypermissions.md page*
-* *Added the maximum number of domain whitelabels you can create to domains.md*
-* *Fixing the number of days a batch id is valid in scheduling_parameters.md*
-
-Fill out this form in the body:
--->
-
-**Description of the change**:
-**Reason for the change**:
-**Link to original source**:
-<!-- 
-If this pull request closes an issue, add in the issue number here 
+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
 -->
-Closes #
+# 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
 
-Make sure all of these items are complete, or else the PR will be ineligible for a code review.
+### Short description of what this PR does:
+- 
+- 
 
-- [ ] Code passes all existing [tests](https://github.com/sendgrid/csharp-http-client/tree/master/UnitTest)
-- [ ] Any new functionality added includes new unit tests
-- [ ] Create or update example code to show the new functionality in action.
-- [ ] All code, branch, and git naming and style conventions are followed (see [`CONTRIBUTING.md`](https://github.com/sendgrid/csharp-http-client/blob/master/CONTRIBUTING.md#style-guidelines--naming-conventions))
-- [ ] Feature branch has been rebased off of the latest `master` branch. ( see [`CONTRIBUTING.md`](https://github.com/sendgrid/csharp-http-client/blob/master/CONTRIBUTING.md#creating-a-pull-request)).
+If you have questions, please send an email to [Sendgrid](mailto:dx@sendgrid.com), or file a Github Issue in this repository.

.gitignore

@@ -14,3 +14,6 @@ CSharpHTTPClient/packages/
 CSharpHTTPClient/CSharpHTTPClient.sln.VisualState.xml
 *.PublicKey
 *.pfx
+
+# Environment files
+.env/*.*

Example/.env_sample

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

LICENSE.txt LICENSE.mdLICENSE.txt renamed to LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 SendGrid, Inc.
+Copyright (c) 2012-2017 SendGrid, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -85,10 +85,20 @@ Console.WriteLine(response.StatusCode);
 Console.WriteLine(response.Body.ReadAsStringAsync().Result);
 Console.WriteLine(response.Headers.ToString());
 ```
-
 <a name="usage"></a>
 # Usage
 
+- [Example Code](https://github.com/sendgrid/csharp-http-client/blob/master/Example/Example.cs)
+
+## Environment Variables 
+
+You can do the following to create a .env file:
+
+```cp .env_example .env```
+
+Then, just add your API Key into your .env file.
+
+
 <a name="roadmap"></a>
 # Roadmap
 
@@ -119,4 +129,4 @@ csharp-http-client is guided and supported by the SendGrid [Developer Experience
 csharp-http-client is maintained and funded by SendGrid, Inc. The names and logos for csharp-http-client are trademarks of SendGrid, Inc.
 
 # License
-[The MIT License (MIT)](LICENSE.txt)
+[The MIT License (MIT)](LICENSE.txt)

UnitTest/RequiredFilesExistTest.cs

@@ -0,0 +1,90 @@
+namespace SendGrid.Tests
+{
+
+  public class TestRequiredFilesExist {
+
+      // ./Docker or docker/Docker
+      public void checkDockerExists() {
+          boolean dockerExists = File.Exists("./Docker") ||
+          File.Exists("./docker/Docker");
+          Assert.True(dockerExists);
+      }
+
+      // ./docker-compose.yml or ./docker/docker-compose.yml
+      public void checkDockerComposeExists() {
+          boolean dockerComposeExists = File.Exists("./docker-compose.yml") ||
+          File.Exists("./docker/docker-compose.yml");
+          Assert.True(dockerComposeExists);
+      }
+
+      // ./.env_sample
+      public void checkEnvSampleExists() {
+          Assert.True(File.Exists("./.env_sample"));
+      }
+
+      // ./.gitignore
+      public void checkGitIgnoreExists() {
+          Assert.True(File.Exists("./.gitignore"));
+      }
+
+      // ./.travis.yml
+      public void checkTravisExists() {
+          Assert.True(File.Exists("./.travis.yml"));
+      }
+
+      // ./.codeclimate.yml
+      public void checkCodeClimateExists() {
+          Assert.True(File.Exists("./.codeclimate.yml"));
+      }
+
+      // ./CHANGELOG.md
+      public void checkChangelogExists() {
+          Assert.True(File.Exists("./CHANGELOG.md"));
+      }
+
+      // ./CODE_OF_CONDUCT.md
+      public void checkCodeOfConductExists() {
+          Assert.True(File.Exists("./CODE_OF_CONDUCT.md"));
+      }
+
+      // ./CONTRIBUTING.md
+      public void checkContributingGuideExists() {
+          Assert.True(File.Exists("./CONTRIBUTING.md"));
+      }
+
+      // ./.github/ISSUE_TEMPLATE
+      public void checkIssuesTemplateExists() {
+          Assert.True(File.Exists("./.github/ISSUE_TEMPLATE"));
+      }
+
+      // ./LICENSE.md
+      public void checkLicenseExists() {
+          Assert.True(File.Exists("./LICENSE.md"));
+      }
+
+      // ./.github/PULL_REQUEST_TEMPLATE
+      public void checkPullRequestExists() {
+          Assert.True(File.Exists("./.github/PULL_REQUEST_TEMPLATE"));
+      }
+
+      // ./README.md
+      public void checkReadMeExists() {
+          Assert.True(File.Exists("./README.md"));
+      }
+
+      // ./TROUBLESHOOTING.md
+      public void checkTroubleShootingGuideExists() {
+          Assert.True(File.Exists("./TROUBLESHOOTING.md"));
+      }
+
+      // ./USAGE.md
+      public void checkUsageGuideExists() {
+          Assert.True(File.Exists("./USAGE.md"));
+      }
+
+      // ./USE_CASES.md
+      public void checkUseCases() {
+          Assert.True(File.Exists("./USE_CASES.md"));
+      }
+  }
+}

UnitTest/UnitTest.cs

@@ -7,6 +7,8 @@
 using System.Text;
 using System.Net;
 using System.Threading;
+using System.IO;
+using System.Linq;
 
 namespace UnitTest
 {
@@ -95,4 +97,17 @@ public async void TestMethodCallWithCancellationToken()
             Response response = await test_client.get(cancellationToken: cancellationTokenSource.Token);
         }
     }
+
+    [TestFixture]
+    public class TestRepositoryFiles
+    {
+        [Test]
+        public void TestLicenseEndYear()
+        {
+            var licensePath = Path.Combine("..", "..", "..", "LICENSE.txt");
+            string line = File.ReadLines(licensePath).Skip(2).Take(1).First();
+
+            Assert.AreEqual(DateTime.Now.Year.ToString(), line.Substring(19, 4));
+        }
+    }
 }