Skip to content

Commit e47f5fc

Browse files
Merge branch 'master' into master
2 parents 4f2f40e + 4c8607d commit e47f5fc

18 files changed

+411
-46
lines changed

.codeclimate.yml

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# This is a sample .codeclimate.yml configured for Engine analysis on Code
2+
# Climate Platform. For an overview of the Code Climate Platform, see here:
3+
# http://docs.codeclimate.com/article/300-the-codeclimate-platform
4+
5+
# Under the engines key, you can configure which engines will analyze your repo.
6+
# Each key is an engine name. For each value, you need to specify enabled: true
7+
# to enable the engine as well as any other engines-specific configuration.
8+
9+
# For more details, see here:
10+
# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
11+
12+
# For a list of all available engines, see here:
13+
# http://docs.codeclimate.com/article/296-engines-available-engines
14+
15+
#engines:
16+
# to turn on an engine, add it here and set enabled to `true`
17+
# to turn off an engine, set enabled to `false` or remove it
18+
# rubocop:
19+
# enabled: true
20+
# golint:
21+
# enabled: true
22+
# gofmt:
23+
# enabled: true
24+
# eslint:
25+
# enabled: true
26+
# csslint:
27+
# enabled: true
28+
29+
# Engines can analyze files and report issues on them, but you can separately
30+
# decide which files will receive ratings based on those issues. This is
31+
# specified by path patterns under the ratings key.
32+
33+
# For more details see here:
34+
# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
35+
36+
# ratings:
37+
# paths:
38+
# - app/**
39+
# - lib/**
40+
# - "**.rb"
41+
# - "**.go"
42+
43+
# You can globally exclude files from being analyzed by any engine using the
44+
# exclude_paths key.
45+
46+
#All maintainability checks are enabled by default with the following configurations.
47+
#checks,
48+
# argument-count:
49+
# config:
50+
# threshold: 4
51+
# complex-logic:
52+
# config:
53+
# threshold: 4
54+
# file-lines:
55+
# config:
56+
# threshold: 250
57+
# method-complexity:
58+
# config:
59+
# threshold: 5
60+
# method-count:
61+
# config:
62+
# threshold: 20
63+
# method-lines:
64+
# config:
65+
# threshold: 25
66+
# nested-control-flow:
67+
# config:
68+
# threshold: 4
69+
# return-statements:
70+
# config:
71+
# threshold: 4
72+
# similar-code:
73+
# config:
74+
# threshold: # language-specific defaults. an override will affect all languages.
75+
# identical-code:
76+
# config:
77+
# threshold: # language-specific defaults. an override will affect all languages.
78+
79+
engines:
80+
sonar-java:
81+
enabled: true
82+
channel: beta
83+
84+
exclude_paths:
85+
- "scripts/"
86+
- ".github/"
87+
- "gradle/"
88+
- "**/test/"

.github/PULL_REQUEST_TEMPLATE

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
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.
3+
4+
5+
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!
6+
e.g.
7+
Fixes #1
8+
Closes #2
9+
-->
10+
# Fixes #
11+
12+
### Checklist
13+
- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
14+
- [ ] I have read the [Contribution Guide] and my PR follows them.
15+
- [ ] I updated my branch with the master branch.
16+
- [ ] I have added tests that prove my fix is effective or that my feature works
17+
- [ ] I have added necessary documentation about the functionality in the appropriate .md file
18+
- [ ] I have added in line documentation to the code I modified
19+
20+
### Short description of what this PR does:
21+
-
22+
-
23+
24+
If you have questions, please send an email to [Sendgrid](mailto:[email protected]), or file a Github Issue in this repository.

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,6 @@ repo/
2222
/.settings/
2323
/.classpath
2424
/.project
25+
26+
# Environment files
27+
.env/*.*

.travis.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
language: java
2-
sudo: false
32
jdk:
43
- oraclejdk8
5-
- oraclejdk7
6-
- openjdk7
4+
- openjdk8
5+
before_script:
6+
- chmod a+x gradlew
7+
script:
8+
- ./gradlew build check
79
after_script:
8-
- "./gradlew build"
910
- "./scripts/s3upload.sh"
1011
env:
1112
global:
@@ -22,4 +23,4 @@ notifications:
2223
Build %{build_number}</a> on branch <i>%{branch}</i> by %{author}: <strong>%{message}</strong>
2324
<a href="https://github.com/sendgrid/%{repository}/commits/%{commit}">View on GitHub</a>'
2425
format: html
25-
notify: true
26+
notify: true

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file.
33

44
This project adheres to [Semantic Versioning](http://semver.org/).
55

6+
## [4.2.0] - 2017-10-30
7+
### Added
8+
- [Pull #22](https://github.com/sendgrid/java-http-client/pull/22): Allow setting both `apache http client` and `test` parameters
9+
- BIG thanks to [Maxim Novak](https://github.com/maximn) for the pull request!
10+
11+
## [4.1.1] - 2016-10-11
12+
### Added
13+
- [Pull #23](https://github.com/sendgrid/java-http-client/pull/23): Moved Mockito to test dependency.
14+
- BIG thanks to [Joseph Lust](https://github.com/twistedpair) for the pull request!
15+
616
## [4.1.0] - 2016-10-11
717
### Added
818
- [Pull #17](https://github.com/sendgrid/java-http-client/pull/17): Assign server response outside try block

CODE_OF_CONDUCT.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# SendGrid Community Code of Conduct
2+
3+
The SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, successful and growing community.
4+
5+
### Be Open
6+
Members of the community are open to collaboration, whether it's on pull requests, code reviews, approvals, issues or otherwise. We're receptive to constructive comments and criticism, as the experiences and skill sets of all members contribute to the whole of our efforts. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate, and everyone can make a difference.
7+
8+
### Be Considerate
9+
Members of the community are considerate of their peers, which include other contributors and users of SendGrid. We're thoughtful when addressing the efforts of others, keeping in mind that often the labor was completed with the intent of the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
10+
11+
### Be Respectful
12+
Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues. Overall, we're good to each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
13+
14+
## Additional Guidance
15+
16+
### Disclose Potential Conflicts of Interest
17+
Community discussions often involve interested parties. We expect participants to be aware when they are conflicted due to employment or other projects they are involved in and disclose those interests to other project members. When in doubt, over-disclose. Perceived conflicts of interest are important to address so that the community’s decisions are credible even when unpopular, difficult or favorable to the interests of one group over another.
18+
19+
### Interpretation
20+
This Code is not exhaustive or complete. It is not a rulebook; it serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter. When in doubt, try to abide by [SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.
21+
22+
### Enforcement
23+
Most members of the SendGrid community always comply with this Code, not because of the existence of this Code, but because they have long experience participating in open source communities where the conduct described above is normal and expected. However, failure to observe this Code may be grounds for suspension, reporting the user for abuse or changing permissions for outside contributors.
24+
25+
## If you have concerns about someone’s conduct
26+
**Initiate Direct Contact** - It is always appropriate to email a community member (if contact information is available), mention that you think their behavior was out of line, and (if necessary) point them to this Code.
27+
28+
**Discuss Publicly** - Discussing publicly is always acceptable. Note, though, that approaching the person directly may be better, as it tends to make them less defensive, and it respects the time of other community members, so you probably want to try direct contact first.
29+
30+
**Contact the Moderators** - You can reach the SendGrid moderators by emailing [email protected].
31+
32+
## Submission to SendGrid Repositories
33+
Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com).
34+
35+
## Attribution
36+
37+
SendGrid thanks the following, on which it draws for content and inspiration:
38+
39+
* [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)
40+
* [Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)
41+
* [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)

CONTRIBUTING.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
22

33
- [CLAs and CCLAs](#cla)
44
- [Roadmap & Milestones](#roadmap)
5-
- [Feature Request](#feature_request)
6-
- [Submit a Bug Report](#submit_a_bug_report)
7-
- [Improvements to the Codebase](#improvements_to_the_codebase)
8-
- [Understanding the Code Base](#understanding_the_codebase)
5+
- [Feature Request](#feature-request)
6+
- [Submit a Bug Report](#submit-a-bug-report)
7+
- [Improvements to the Codebase](#improvements-to-the-codebase)
8+
- [Understanding the Code Base](#understanding-the-codebase)
99
- [Testing](#testing)
10-
- [Style Guidelines & Naming Conventions](#style_guidelines_and_naming_conventions)
11-
- [Creating a Pull Request](#creating_a_pull_request)
10+
- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
11+
- [Creating a Pull Request](#creating-a-pull-request)
1212

1313
<a name="roadmap"></a>
1414
We use [Milestones](https://github.com/sendgrid/java-http-client/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.
@@ -26,7 +26,7 @@ When you create a Pull Request, after a few seconds, a comment will appear with
2626

2727
There are a few ways to contribute, which we'll enumerate below:
2828

29-
<a name="feature_request"></a>
29+
<a name="feature-request"></a>
3030
## Feature Request
3131

3232
If you'd like to make a feature request, please read this section.
@@ -36,7 +36,7 @@ The GitHub issue tracker is the preferred channel for library feature requests,
3636
- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
3737
- Please be respectful and considerate of others when commenting on issues
3838

39-
<a name="submit_a_bug_report"></a>
39+
<a name="submit-a-bug-report"></a>
4040
## Submit a Bug Report
4141

4242
Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
@@ -53,7 +53,7 @@ Before you decide to create a new issue, please try the following:
5353

5454
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/java-http-client/.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.
5555

56-
<a name="improvements_to_the_codebase"></a>
56+
<a name="improvements-to-the-codebase"></a>
5757
## Improvements to the Codebase
5858

5959
We welcome direct contributions to the java-http-client code base. Thank you!
@@ -64,7 +64,7 @@ We welcome direct contributions to the java-http-client code base. Thank you!
6464

6565
##### Prerequisites #####
6666

67-
- Java version Oracle JDK 7, 8 or OpenJDK 7
67+
- Java version Oracle JDK 8 or OpenJDK 7
6868
- Please see [build.gradle](https://github.com/sendgrid/java-http-client/blob/master/build.gradle)
6969

7070
##### Initial setup: #####
@@ -89,10 +89,10 @@ source ./sendgrid.env
8989
```bash
9090
./gradlew build
9191
cd examples
92-
javac -classpath {path_to}/sendgrid-java-http-client-4.1.0-jar.jar:. Example.java && java -classpath {path_to}/sendgrid-java-http-client-4.1.0-jar.jar:. Example
92+
javac -classpath {path_to}/sendgrid-java-http-client-4.2.0-jar.jar:. Example.java && java -classpath {path_to}/sendgrid-java-http-client-4.2.0-jar.jar:. Example
9393
```
9494

95-
<a name="understanding_the_codebase"></a>
95+
<a name="understanding-the-codebase"></a>
9696
## Understanding the Code Base
9797

9898
**/examples**
@@ -131,7 +131,7 @@ Run the tests:
131131
./gradlew test -i
132132
```
133133

134-
<a name="style_guidelines_and_naming_conventions"></a>
134+
<a name="style-guidelines-and-naming-conventions"></a>
135135
## Style Guidelines & Naming Conventions
136136

137137
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.
@@ -141,8 +141,8 @@ Please run your code through:
141141
- [FindBugs](http://findbugs.sourceforge.net/)
142142
- [CheckStyle](http://checkstyle.sourceforge.net/) with [Google's Java Style Guide](http://checkstyle.sourceforge.net/reports/google-java-style.html).
143143

144-
145-
## Creating a Pull Request<a name="creating_a_pull_request"></a>
144+
<a name="creating-a-pull-request"></a>
145+
## Creating a Pull Request
146146

147147
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
148148
and configure the remotes:
@@ -151,7 +151,7 @@ Please run your code through:
151151
# Clone your fork of the repo into the current directory
152152
git clone https://github.com/sendgrid/java-http-client
153153
# Navigate to the newly cloned directory
154-
cd sendgrid-python
154+
cd java-http-client
155155
# Assign the original repo to a remote called "upstream"
156156
git remote add upstream https://github.com/sendgrid/java-http-client
157157
```

LICENSE.txt renamed to LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 SendGrid, Inc.
3+
Copyright (c) 2016-2017 SendGrid, Inc.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)