Updating to comply to SendGrid's Open Source policies

Author: thinkingserious

.env_sample

@@ -1,5 +1,6 @@
 # Change Log
 All notable changes to this project will be documented in this file.
+
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [1.1.0] - 2016-03-17

CHANGELOG.md

@@ -1,14 +1,28 @@
-Hello! Thank you for choosing to help contribute to the ruby-http-client. There are many ways you can contribute and help is always welcome.
-
+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/ruby-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.
 
-* [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="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:
 
@@ -37,58 +51,50 @@ 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 (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
-
-```
-Short and descriptive example bug report title
-
-#### Issue Summary
-
-A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, code examples.
-
-
-#### Steps to Reproduce
-
-1. This is the first step
-2. This is the second step
-3. Further steps, etc.
-
-Any other information you want to share that is relevant to the issue being reported. Especially, why do you consider this to be a bug? What do you expect to happen instead?
-
-#### Technical details:
-
-* ruby-http-client Version: master (latest commit: 2cb34372ef0f31352f7c90015a45e1200cb849da)
-* Ruby Version: 2.2
-```
+In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/ruby-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.
 
 <a name="improvements_to_the_codebase"></a>
 ## Improvements to the Codebase
 
-We welcome direct contributions to the python-http-client code base. Thank you!
+We welcome direct contributions to the ruby-http-client code base. Thank you!
 
 ### Development Environment ###
 
-#### Install and run locally ####
+#### Install and Run Locally ####
 
 ##### Prerequisites #####
 
-* Ruby 2.2
-* There are no external dependencies
+- Ruby 2.2 or higher
 
 ##### Initial setup: #####
 
-```
+```bash
 git clone https://github.com/sendgrid/ruby-http-client.git
 cd ruby-http-client
-cp .env_sample .env
 ```
 
-Update your settings in `.env`
-
 ##### Execute: #####
 
 See the [examples folder](https://github.com/sendgrid/ruby-http-client/tree/master/examples) to get started quickly.
 
+To try the SendGrid example:
+
+First, get your free SendGrid account [here](https://sendgrid.com/free?source=ruby-http-client).
+
+Next, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys).
+
+```bash
+echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
+echo "sendgrid.env" >> .gitignore
+source ./sendgrid.env
+```
+
+To run the example (after updating the emails):
+
+```bash
+ruby examples/example.rb
+```
+
 <a name="understanding_the_codebase"></a>
 ## Understanding the Code Base
 
@@ -109,30 +115,28 @@ This allows for the following mapping from a URL to a method chain:
 
 All PRs require passing tests before the PR will be reviewed.
 
-All test files are in the `[test](https://github.com/sendgrid/ruby-http-client/tree/master/test)` directory.
+All test files are in the [`test`](https://github.com/sendgrid/ruby-http-client/tree/master/test) directory.
 
 For the purposes of contributing to this repo, please update the [`test_ruby_http_client.rb`](https://github.com/sendgrid/ruby-http-client/blob/master/test/test_ruby_http_client.rb) file with unit tests as you modify the code.
 
 To run the tests:
 
-`rake`
-
-All PRs require passing tests before the PR will be reviewed.
+```bash
+rake
+```
 
 <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.
 
-* [Community Driven Style Guide](https://github.com/bbatsov/ruby-style-guide)
+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 [rubocop](https://github.com/bbatsov/rubocop).
+- [Community Driven Style Guide](https://github.com/bbatsov/ruby-style-guide)
 
-### Directory Structure
+Please run your code through:
 
-* `examples` for example calls
-* `test`, for all tests
-* `libs`, for the client library
+- [rubocop](https://github.com/bbatsov/rubocop).
 
 ## Creating a Pull Request<a name="creating_a_pull_request"></a>
 
@@ -143,7 +147,7 @@ Please run your code through [rubocop](https://github.com/bbatsov/rubocop).
    # Clone your fork of the repo into the current directory
    git clone https://github.com/sendgrid/ruby-http-client
    # Navigate to the newly cloned directory
-   cd ruby-http-client
+   cd sendgrid-python
    # Assign the original repo to a remote called "upstream"
    git remote add upstream https://github.com/sendgrid/ruby-http-client
    ```
@@ -187,4 +191,4 @@ Please run your code through [rubocop](https://github.com/bbatsov/rubocop).
 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.
+If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 SendGrid
+Copyright (c) 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

LICENSE LICENSE.txtLICENSE renamed to LICENSE.txt

@@ -2,7 +2,21 @@
 
 **Quickly and easily access any REST or REST-like API.**
 
-Here is a quick example:
+# Announcements
+
+All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/ruby-http-client/blob/master/CHANGELOG.md).
+
+# Installation
+
+```bash
+gem install ruby_http_client
+```
+
+## Dependencies
+
+- Ruby 2.2 or higher
+
+# Quick Start
 
 `GET /your/api/{param}/call`
 
@@ -33,101 +47,31 @@ puts response.response_body
 puts response.response_headers
 ```
 
-# Installation
-
-`gem install ruby_http_client`
-
-## Usage ##
-
-Following is an example using SendGrid. You can get your free account [here](https://sendgrid.com/free?source=python-http-client).
-
-First, update your .env with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) and HOST. For this example HOST=https://api.sendgrid.com.
-
-Following is an abridged example, here is the [full working code](https://github.com/sendgrid/ruby-http-client/tree/master/examples).
-
-```ruby
-require 'ruby_http_client'
-
-SendGrid::Config.new
-headers = JSON.parse('
-  {
-    "Authorization": "Bearer ' + ENV['SENDGRID_API_KEY'] + '",
-    "Content-Type": "application/json"
-  }
-')
-host = ENV['LOCAL_HOST']
-client = SendGrid::Client.new(host: host, request_headers: headers)
-
-# GET Collection
-query_params = { 'limit' => 100, 'offset' => 0 }
-response = client.version('v3').api_keys.get(query_params: query_params)
-
-# POST
-request_body = JSON.parse('
-    {
-        "name": "My API Key Ruby Test",
-        "scopes": [
-            "mail.send",
-            "alerts.create",
-            "alerts.read"
-        ]
-    }
-')
-response = client.version('v3').api_keys.post(request_body: request_body)
-api_key_id = JSON.parse(response.response_body)['api_key_id']
-
-# GET Single
-response = client.version('v3').api_keys._(api_key_id).get
-
-# PATCH
-request_body = JSON.parse('
-    {
-        "name": "A New Hope"
-    }
-')
-response = client.api_keys._(api_key_id).patch(request_body: request_body)
-
-# PUT
-request_body = JSON.parse('
-    {
-        "name": "A New Hope",
-        "scopes": [
-            "user.profile.read",
-            "user.profile.update"
-        ]
-    }
-')
-response = client.api_keys._(api_key_id).put(request_body: request_body)
-
-# DELETE
-response = client.api_keys._(api_key_id).delete
-```
-
-# Announcements
+# Usage
 
-[2016.03.17] - We hit version 1!
+- [Example Code](https://github.com/sendgrid/ruby-http-client/tree/master/examples)
 
-# Roadmap
+## Roadmap
 
-[Milestones](https://github.com/sendgrid/ruby-http-client/milestones)
+If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/ruby-http-client/milestones). We would love to hear your feedback.
 
-# How to Contribute
+## How to Contribute
 
 We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md) guide for details.
 
-* [Feature Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#feature_request)
-* [Bug Reports](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#submit_a_bug_report)
-* [Improvements to the Codebase](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
+Quick links:
 
-# Thanks
+- [Feature Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#feature_request)
+- [Bug Reports](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#submit_a_bug_report)
+- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md)
+- [Improvements to the Codebase](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
 
-We were inspired by the work done on [birdy](https://github.com/inueni/birdy) and [universalclient](https://github.com/dgreisen/universalclient).
 
 # About
 
-![SendGrid Logo]
-(https://assets3.sendgrid.com/mkt/assets/logos_brands/small/sglogo_2015_blue-9c87423c2ff2ff393ebce1ab3bd018a4.png)
-
 ruby-http-client is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
 
 ruby-http-client is maintained and funded by SendGrid, Inc. The names and logos for ruby-http-client are trademarks of SendGrid, Inc.
+
+![SendGrid Logo]
+(https://assets3.sendgrid.com/mkt/assets/logos_brands/small/sglogo_2015_blue-9c87423c2ff2ff393ebce1ab3bd018a4.png)