Skip to content

Commit

Permalink
Updated to comply with SendGrid's open source policies
Browse files Browse the repository at this point in the history
  • Loading branch information
@thinkingserious
thinkingserious committed May 21, 2016
1 parent 7677c15 commit 71f24b6
Show file tree
Hide file tree
Showing 5 changed files with 296 additions and 133 deletions.
180 changes: 180 additions & 0 deletions CONTRIBUTING.md
View file
@@ -0,0 +1,180 @@
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-java/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) or a SendGrid Company Contributor Licensing Agreement (CCLA) be filled out by every contributor to a SendGrid open source project.

Our goal with the CLA and CCLA 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 and CCLA encourage broad participation by our open source community and help 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 (or CCLA). Copies of the CLA and CCLA are available [here](https://drive.google.com/a/sendgrid.com/file/d/0B0PlcM9qA91LN2VEUTJWU2RIVXc/view).

You may submit your completed [CLA or CCLA](https://drive.google.com/a/sendgrid.com/file/d/0B0PlcM9qA91LN2VEUTJWU2RIVXc/view) to SendGrid at [dx@sendgrid.com](mailto:dx@sendgrid.com). SendGrid will then confirm you are ready to begin making contributions.

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/smtpapi-java/.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-java code base. Thank you!

### Development Environment ###

#### Install and Run Locally ####

##### Prerequisites #####

- Java 1.7 or above
- See [build.gradle](https://github.com/sendgrid/smtpapi-java/blob/master/build.gradle) for dependencies.

##### Initial setup: #####

```bash
git clone https://github.com/sendgrid/smtpapi-java.git
cd smtpapi-java
./gradlew build
```

##### Execute: #####

See the [examples folder](https://github.com/sendgrid/smtpapi-java/tree/master/examples) to get started quickly.

```bash
cd examples
javac -classpath ../repo/com/sendgrid/smtpapi-jar.jar:. Example.java && java -classpath ../repo/com/sendgrid/smtpapi-jar.jar:. Example
```

<a name="understanding_the_codebase"></a>
## Understanding the Code Base

**/examples**

Working examples that demonstrate usage.

**/src/test/java/com/sendgrid/smtpapi/**

Unit tests.

**/src/main/java/com/sendgrid/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 [`/src/test/java/com/sendgrid/smtpapi/`](https://github.com/sendgrid/smtpapi-java/tree/master/src/test/java/com/sendgrid/smtpapi/) directory.

For the purposes of contributing to this repo, please update the [`SMTPAPITest.java`](https://github.com/sendgrid/smtpapi-java/blob/master/test/src/test/java/com/sendgrid/smtpapi/SMTPAPITest.java) file with unit tests as you modify the code.

To run the tests:

```bash
./gradlew check
```

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

Please run your code through:

- [FindBugs](http://findbugs.sourceforge.net/)
- [CheckStyle](http://checkstyle.sourceforge.net/) with [Google's Java Style Guide](http://checkstyle.sourceforge.net/reports/google-java-style.html).

## 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-java
# Navigate to the newly cloned directory
cd sendgrid-python
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/sendgrid/smtpapi-java
```

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.
2 changes: 1 addition & 1 deletion LICENSE.txt
View file
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 SendGrid
Copyright (c) 2014-2016 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
Expand Down
167 changes: 35 additions & 132 deletions README.md
View file
@@ -1,10 +1,12 @@
# SMTPAPI for Java
[![BuildStatus](https://travis-ci.org/sendgrid/smtpapi-java.svg?branch=master)](https://travis-ci.org/sendgrid/smtpapi-java)

This module will let you build SendGrid's SMTP API headers with simplicity.
**This module allows you to build SendGrid's SMTP API headers with simplicity.**

[![BuildStatus](https://travis-ci.org/sendgrid/smtpapi-java.svg?branch=master)](https://travis-ci.org/sendgrid/smtpapi-java)
# Announcements

## Installing
All updates to this module is documented in our [CHANGELOG](https://github.com/sendgrid/smtpapi-java/blob/master/CHANGELOG.md).

# Installation

Choose your installation method - Maven w/ Gradle (recommended) or Jar file.

Expand Down Expand Up @@ -35,149 +37,50 @@ You can just drop the jar file in. It's a fat jar - it has all the dependencies

[smtpapi-java.jar](https://sendgrid-open-source.s3.amazonaws.com/smtpapi-java/smtpapi-java.jar)

## Examples

### Create headers

```java
import com.sendgrid.smtpapi.SMTPAPI;
SMTPAPI header = new SMTPAPI();
```

### [To](http://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
```java
header.addTo("email@email.com");
// or
header.addTo(["email@email.com"]);
// or
header.setTos(["email@email.com"]);

String[] tos = header.getTos();
```

### [Substitutions](http://sendgrid.com/docs/API_Reference/SMTP_API/substitution_tags.html)

```java
header.addSubstitution("key", "value");

JSONObject subs = header.getSubstitutions();
```

### [Unique Arguments](http://sendgrid.com/docs/API_Reference/SMTP_API/unique_arguments.html)

```java
header.addUniqueAarg("key", "value");
// or
Map map = new HashMap<String, String>();
map.put("unique", "value");
header.setUniqueArgs(map);
// or
JSONObject map = new JSONObject();
map.put("unique", "value");
header.setUniqueArgs(map);

JSONObject args = header.getUniqueArgs();
```
### [Categories](http://sendgrid.com/docs/API_Reference/SMTP_API/categories.html)

```java
header.addCategory("category");
// or
header.addCategory(["categories"]);
// or
header.setCategories(["category1", "category2"]);

String[] cats = header.getCategories();
```

### [Sections](http://sendgrid.com/docs/API_Reference/SMTP_API/section_tags.html)

```java
header.addSection("key", "section");
// or
Map newSec = new HashMap();
newSec.put("-section-", "value");
header.setSections(newSec);
// or
JSONObject newSec = new JSONObject();
newSec.put("-section-", "value");
header.setSections(newSec);

JSONObject sections = header.getSections();
```

### [Filters](http://sendgrid.com/docs/API_Reference/SMTP_API/apps.html)

```java
header.addFilter("filter", "setting", "value");
header.addFilter("filter", "setting", 1);
## Dependencies

JSONObject filters = header.getFilters();
```
- See [build.gradle](https://github.com/sendgrid/smtpapi-java/blob/master/build.gradle#L47).

### [ASM Group Id](https://sendgrid.com/docs/User_Guide/advanced_suppression_manager.html)
# Quick Start

```java
header.setASMGroupId(1);

Integer groupId = header.getASMGroupId();
```

### [Scheduling](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html)

```java
header.setSendAt(1416427645)

int sendAt = header.getSendAt();
```

### Get Headers

```java
String headers = header.jsonString();
```

If you need the unescaped JSON string.
```java
String rawJson = header.rawJsonString();
```

## Running Tests

```
./gradlew check
```

## Publishing to Maven

This only works if you have the correct permissions - for admins only basically.
import com.sendgrid.smtpapi.SMTPAPI;

```
cp gradle.properties.example gradle.properties
public class Example {
public static void main(String[] args) {
SMTPAPI header = new SMTPAPI();
header.addTo("test@example.com");
String headers = header.jsonString();
System.out.println(headers);
}
}
```

Edit the contents of gradle.properties with your credentials.
# Usage

```
./gradlew
./gradlew uploadArchives
```
- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
- [Example Code](https://github.com/sendgrid/smtpapi-java/tree/master/examples)

Login to [Sonatype](https://oss.sonatype.org/index.html#stagingRepositories).
## Roadmap

Go to [staging repositories page](https://oss.sonatype.org/index.html#stagingRepositories).
If you are intersted in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/smtpapi-java/milestones). We would love to hear your feedback.

Click 'Close' with the archive selected.
## How to Contribute

![](https://raw.githubusercontent.com/sendgrid/sendgrid-java/master/maven-help.png)
We encourage contribution to our projects, please see our [CONTRIBUTING](https://github.com/sendgrid/smtpapi-java/blob/master/CONTRIBUTING.md) guide for details.

Wait a few minutes, and refresh the staging repositories page.
Quick links:

Check the box for the SendGrid repo again and this time click 'Release'.
- [Feature Request](https://github.com/sendgrid/smtpapi-java/blob/master/CONTRIBUTING.md#feature_request)
- [Bug Reports](https://github.com/sendgrid/smtpapi-java/blob/master/CONTRIBUTING.md#submit_a_bug_report)
- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/smtpapi-java/blob/master/CONTRIBUTING.md#cla)
- [Improvements to the Codebase](https://github.com/sendgrid/smtpapi-java/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)

You're all done.
# About

[Further help](https://github.com/sendgrid/sendgrid-java/pull/15).
smtpapi-java is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).

smtpapi-java is maintained and funded by SendGrid, Inc. The names and logos for smtpapi-java are trademarks of SendGrid, Inc.

## MIT
![SendGrid Logo]
(https://assets3.sendgrid.com/mkt/assets/logos_brands/small/sglogo_2015_blue-9c87423c2ff2ff393ebce1ab3bd018a4.png)
Binary file added examples/Example.class
View file
Binary file not shown.

0 comments on commit 71f24b6

Please sign in to comment.