ruby_http_client 3.5.0 → 3.5.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +13 -8
  3. data/CHANGELOG.md +6 -0
  4. data/CONTRIBUTING.md +7 -25
  5. data/FIRST_TIMERS.md +79 -0
  6. data/ISSUE_TEMPLATE.md +5 -1
  7. data/Makefile +2 -2
  8. data/PULL_REQUEST_TEMPLATE.md +1 -1
  9. data/README.md +17 -15
  10. data/ruby_http_client.gemspec +4 -4
  11. data/static/img/github-fork.png +0 -0
  12. data/static/img/github-sign-up.png +0 -0
  13. data/twilio_sendgrid_logo.png +0 -0
  14. metadata +16 -13
  15. data/first-timers.md +0 -70
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 508dd343a5994fe2f5b5efa8c088213348488ca0524c99fe327cb7cd244dc5df
4
- data.tar.gz: a239ad23f4dc8f87dc65b738d8e05cc91a3904b0a04452eec6091005a215c893
3
+ metadata.gz: b0319ff91ddd522b5dd70bd67121289331e678d194f600d37c9fcf821d717203
4
+ data.tar.gz: cc2d4d5d4f5b913ad2c5130febd6def93d61788f2b905dd7098532c4bde02968
5
5
  SHA512:
6
- metadata.gz: 39e4db29d108b36ff22d9bdef44efaff457de7e6bee92921f3aa2eebcb25003e8dfca46c35ef005168e97859e578a409fc64669f9f6f82099d71eac2e7b605d5
7
- data.tar.gz: 5b74ee2d1306c0c47e282542391ba63ffe694360d53e10d93f5a64e1510f79bc392348c12ea61e55e0a4b1084e034a2a4352093820bf98ead47c206bc9eeae7d
6
+ metadata.gz: 80c39d7776bb3302b28ac3177f6e67f1e44547246319d3314e1e67f2fcd972aca77e639f96eef0725f317bf8fd1bfa8cd69daf07c7e0db67be78f5dc9b30ba96
7
+ data.tar.gz: fd255039aee276fb40bda796c8c13629adf400dbbe5fe3a7d5fcc42fbddcc98ec8c6b75852ffa67db4c9df2c572b7e3e279a36bcc6304424b1f6a2a5574ba710
data/.travis.yml CHANGED
@@ -8,18 +8,14 @@ rvm:
8
8
  - 2.6
9
9
  - 2.5
10
10
  - 2.4
11
- - jruby
12
- before_install:
13
- - gem install minitest
14
- - gem install simplecov
15
- - gem install codecov
11
+ - jruby-9.2
16
12
  before_script:
17
- - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
18
- > ./cc-test-reporter
13
+ - make install
14
+ - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
19
15
  - chmod +x ./cc-test-reporter
20
16
  - "./cc-test-reporter before-build"
21
17
  script:
22
- - rake
18
+ - make test
23
19
  after_script:
24
20
  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
25
21
  deploy:
@@ -31,3 +27,12 @@ deploy:
31
27
  tags: true
32
28
  rvm: '2.4'
33
29
  skip_cleanup: true
30
+
31
+ notifications:
32
+ slack:
33
+ if: branch = main
34
+ on_pull_requests: false
35
+ on_success: never
36
+ on_failure: change
37
+ rooms:
38
+ - secure: k9NxCTK/mvoRHWJ6QQ5ErM/+T7yy6KcUjNtb5WgsiA+OyjRgQb5qcm83pYXstDRP6JyEGmuLs4GLIQYSTte1yBvXzM2EqneltNZL2sc+r24zWFcVu6KZb/eq1+diJes+76W4tXT0w+uyyZc9sudFND32RUvcKr31jNvlHDpaII9sose9qC23YKf2u4PlxH8l7wRd3k58XeL9TaQ40xt+NiIrv1R+4QT1GnuYr9cqXrCbTNsZidrdnLmqHybsoJsHjqq7PRDi92CZBQitwzGDnyiOr40CBsqs0VoiUttsKxrG6WCglEDd2wlhYha8ti7z6GxshQHRk2bOePi2Z2YHLJXJcrkLxukCUcf/5GPu+M0vdVj+wWfrlIRa5yPW9dpEgain6Av8c/zc9GOMvTNKNlnxreh3710pQh6b9+C0PfKmsIR3kTqwrDFZxu63IHy8S/CfyFQqHAo2X1TMnJLvvWzXnxAu/qB729YGwuJX57qjk56pvun+pZXGiRsk2okjPcz1zlcoyQOd/a8WqUNN5FEIvHd+cNeDFnYm0QwqBoMTurNc+LyvlB61BNcdq+J2GdtGjAksIc55adFkeOnVGMioW349lGt0LkuhI5um7O3J8b3Y7WPOt1tcR9o44G6t2aZOnnVNZVV04/A3XjlZSJAmG26K6HoBBl3o9uL8aWk=
data/CHANGELOG.md CHANGED
@@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file.
3
3
 
4
4
  This project adheres to [Semantic Versioning](http://semver.org/).
5
5
 
6
+ [2020-08-19] Version 3.5.1
7
+ --------------------------
8
+ **Library - Chore**
9
+ - [PR #120](https://github.com/sendgrid/ruby-http-client/pull/120): update GitHub branch references to use HEAD. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
10
+
11
+
6
12
  [2020-03-04] Version 3.5.0
7
13
  --------------------------
8
14
  **Library - Fix**
data/CONTRIBUTING.md CHANGED
@@ -1,7 +1,5 @@
1
1
  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.
2
2
 
3
- - [CLAs and CCLAs](#cla)
4
- - [Roadmap & Milestones](#roadmap)
5
3
  - [Feature Request](#feature-request)
6
4
  - [Submit a Bug Report](#submit-a-bug-report)
7
5
  - [Improvements to the Codebase](#improvements-to-the-codebase)
@@ -11,22 +9,8 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
11
9
  - [Creating a Pull Request](#creating-a-pull-request)
12
10
  - [Code Reviews](#code-reviews)
13
11
 
14
- <a name="roadmap"></a>
15
12
  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.
16
13
 
17
- <a name="cla"></a>
18
- ## CLAs and CCLAs
19
-
20
- 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.
21
-
22
- 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.
23
-
24
- 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).
25
-
26
- 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.
27
-
28
- There are a few ways to contribute, which we'll enumerate below:
29
-
30
14
  <a name="feature-request"></a>
31
15
  ## Feature Request
32
16
 
@@ -52,7 +36,7 @@ Before you decide to create a new issue, please try the following:
52
36
 
53
37
  ### Please use our Bug Report Template
54
38
 
55
- In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/ruby-http-client/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.
39
+ In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).
56
40
 
57
41
  <a name="improvements-to-the-codebase"></a>
58
42
  ## Improvements to the Codebase
@@ -88,7 +72,7 @@ source ./sendgrid.env
88
72
 
89
73
  ##### Execute: #####
90
74
 
91
- See the [examples folder](https://github.com/sendgrid/ruby-http-client/tree/master/examples) to get started quickly.
75
+ See the [examples folder](examples) to get started quickly.
92
76
 
93
77
  To run the example (after updating the emails):
94
78
 
@@ -105,20 +89,20 @@ Working examples that demonstrate usage.
105
89
 
106
90
  **ruby_http_client.rb**
107
91
 
108
- An HTTP client with a fluent interface using method chaining and reflection. By returning self on [method_missing](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L209) and [_()](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L194), we can dynamically build the URL using method chaining and [method_missing](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L209) allows us to dynamically receive the method calls to achieve reflection.
92
+ An HTTP client with a fluent interface using method chaining and reflection. By returning self on [method_missing](lib/ruby_http_client.rb#L209) and [_()](lib/ruby_http_client.rb#L194), we can dynamically build the URL using method chaining and [method_missing](lib/ruby_http_client.rb#L209) allows us to dynamically receive the method calls to achieve reflection.
109
93
 
110
94
  This allows for the following mapping from a URL to a method chain:
111
95
 
112
- `/api_client/{api_key_id}/version` maps to `client.api_client._(api_key_id).version.<method>()` where <method> is a [HTTP verb](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L38).
96
+ `/api_client/{api_key_id}/version` maps to `client.api_client._(api_key_id).version.<method>()` where <method> is a [HTTP verb](lib/ruby_http_client.rb#L38).
113
97
 
114
98
  <a name="testing"></a>
115
99
  ## Testing
116
100
 
117
101
  All PRs require passing tests before the PR will be reviewed.
118
102
 
119
- All test files are in the [`test`](https://github.com/sendgrid/ruby-http-client/tree/master/test) directory.
103
+ All test files are in the [`test`](test) directory.
120
104
 
121
- 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.
105
+ For the purposes of contributing to this repo, please update the [`test_ruby_http_client.rb`](test/test_ruby_http_client.rb) file with unit tests as you modify the code.
122
106
 
123
107
  To run the tests:
124
108
 
@@ -190,9 +174,7 @@ Please run your code through:
190
174
  7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
191
175
  with a clear title and description against the `development` branch. All tests must be passing before we will review the PR.
192
176
 
193
- If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.
194
-
195
177
  <a name="code-reviews"></a>
196
178
  ## Code Reviews
197
179
 
198
- 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>
180
+ 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/FIRST_TIMERS.md ADDED
@@ -0,0 +1,79 @@
1
+ # How To Contribute to Twilio SendGrid Repositories via GitHub
2
+ Contributing to the Twilio SendGrid repositories is easy! All you need to do is find an open issue (see the bottom of this page for a list of repositories containing open issues), fix it and submit a pull request. Once you have submitted your pull request, the team can easily review it before it is merged into the repository.
3
+
4
+ To make a pull request, follow these steps:
5
+
6
+ 1. Log into GitHub. If you do not already have a GitHub account, you will have to create one in order to submit a change. Click the Sign up link in the upper right-hand corner to create an account. Enter your username, password, and email address. If you are an employee of Twilio SendGrid, please use your full name with your GitHub account and enter Twilio SendGrid as your company so we can easily identify you.
7
+
8
+ <img src="/static/img/github-sign-up.png" width="800">
9
+
10
+ 2. __[Fork](https://help.github.com/fork-a-repo/)__ the [ruby-http-client](https://github.com/sendgrid/ruby-http-client) repository:
11
+
12
+ <img src="/static/img/github-fork.png" width="800">
13
+
14
+ 3. __Clone__ your fork via the following commands:
15
+
16
+ ```bash
17
+ # Clone your fork of the repo into the current directory
18
+ git clone https://github.com/your_username/ruby-http-client
19
+ # Navigate to the newly cloned directory
20
+ cd ruby-http-client
21
+ # Assign the original repo to a remote called "upstream"
22
+ git remote add upstream https://github.com/sendgrid/ruby-http-client
23
+ ```
24
+
25
+ > Don't forget to replace *your_username* in the URL by your real GitHub username.
26
+
27
+ 4. __Create a new topic branch__ (off the main project development branch) to contain your feature, change, or fix:
28
+
29
+ ```bash
30
+ git checkout -b <topic-branch-name>
31
+ ```
32
+
33
+ 5. __Commit your changes__ in logical chunks.
34
+
35
+ 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. Probably you will also have to create tests (if needed) or create or update the example code that demonstrates the functionality of this change to the code.
36
+
37
+ 6. __Locally merge (or rebase)__ the upstream development branch into your topic branch:
38
+
39
+ ```bash
40
+ git pull [--rebase] upstream main
41
+ ```
42
+
43
+ 7. __Push__ your topic branch up to your fork:
44
+
45
+ ```bash
46
+ git push origin <topic-branch-name>
47
+ ```
48
+
49
+ 8. __[Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository/)__ with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
50
+
51
+ ## Important notice
52
+
53
+ Before creating a pull request, make sure that you respect the repository's constraints regarding contributions. You can find them in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
54
+
55
+ ## Repositories with Open, Easy, Help Wanted, Issue Filters
56
+
57
+ * [Python SDK](https://github.com/sendgrid/sendgrid-python/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
58
+ * [PHP SDK](https://github.com/sendgrid/sendgrid-php/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
59
+ * [C# SDK](https://github.com/sendgrid/sendgrid-csharp/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
60
+ * [Ruby SDK](https://github.com/sendgrid/sendgrid-ruby/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
61
+ * [Node.js SDK](https://github.com/sendgrid/sendgrid-nodejs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
62
+ * [Java SDK](https://github.com/sendgrid/sendgrid-java/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
63
+ * [Go SDK](https://github.com/sendgrid/sendgrid-go/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
64
+ * [Python STMPAPI Client](https://github.com/sendgrid/smtpapi-python/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
65
+ * [PHP STMPAPI Client](https://github.com/sendgrid/smtpapi-php/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
66
+ * [C# STMPAPI Client](https://github.com/sendgrid/smtpapi-csharp/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
67
+ * [Ruby STMPAPI Client](https://github.com/sendgrid/smtpapi-ruby/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
68
+ * [Node.js STMPAPI Client](https://github.com/sendgrid/smtpapi-nodejs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
69
+ * [Java STMPAPI Client](https://github.com/sendgrid/smtpapi-java/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
70
+ * [Go STMPAPI Client](https://github.com/sendgrid/smtpapi-go/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
71
+ * [Python HTTP Client](https://github.com/sendgrid/python-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
72
+ * [PHP HTTP Client](https://github.com/sendgrid/php-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
73
+ * [C# HTTP Client](https://github.com/sendgrid/csharp-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
74
+ * [Java HTTP Client](https://github.com/sendgrid/java-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
75
+ * [Ruby HTTP Client](https://github.com/sendgrid/ruby-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
76
+ * [Go HTTP Client](https://github.com/sendgrid/rest/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
77
+ * [Open API Definition](https://github.com/sendgrid/sendgrid-oai/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
78
+ * [DX Automator](https://github.com/sendgrid/dx-automator/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
79
+ * [Documentation](https://github.com/sendgrid/docs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
data/ISSUE_TEMPLATE.md CHANGED
@@ -1,5 +1,9 @@
1
1
  <!--
2
2
  If this is a feature request, make sure you search Issues for an existing request before creating a new one!
3
+
4
+ Please utilize the template below to help us resolve your issue.
5
+
6
+ Note that many issues can be resolved by updating to the latest version.
3
7
  -->
4
8
 
5
9
  ### Issue Summary
@@ -21,6 +25,6 @@ A summary of the issue and the environment in which it occurs. If suitable, incl
21
25
  ```
22
26
 
23
27
  ### Technical details:
24
- * ruby-http-client version:
28
+ * ruby-http-client version:
25
29
  * ruby version:
26
30
 
data/Makefile CHANGED
@@ -1,7 +1,7 @@
1
1
  .PHONY: install test
2
2
 
3
3
  install:
4
- gem install minitest
4
+ gem install bundler:1.14.6; bundle install
5
5
 
6
6
  test:
7
- rake
7
+ rake test
data/PULL_REQUEST_TEMPLATE.md CHANGED
@@ -23,7 +23,7 @@ A short description of what this PR does.
23
23
  - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
24
24
  - [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md) and my PR follows them
25
25
  - [ ] I have titled the PR appropriately
26
- - [ ] I have updated my branch with the master branch
26
+ - [ ] I have updated my branch with the main branch
27
27
  - [ ] I have added tests that prove my fix is effective or that my feature works
28
28
  - [ ] I have added necessary documentation about the functionality in the appropriate .md file
29
29
  - [ ] I have added inline documentation to the code I modified
data/README.md CHANGED
@@ -1,8 +1,8 @@
1
- ![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
1
+ ![SendGrid Logo](twilio_sendgrid_logo.png)
2
2
 
3
- [![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/ruby-http-client)
3
+ [![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=main)](https://travis-ci.org/sendgrid/ruby-http-client)
4
4
  [![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
5
- [![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
5
+ [![Gem Version](https://badge.fury.io/rb/ruby_http_client.svg)](https://badge.fury.io/rb/ruby_http_client)
6
6
  [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
7
7
  [![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
8
8
  [![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/ruby-http-client.svg)](https://github.com/sendgrid/ruby-http-client/graphs/contributors)
@@ -12,8 +12,9 @@
12
12
  If you are looking for the SendGrid API client library, please see [this repo](https://github.com/sendgrid/sendgrid-ruby).
13
13
 
14
14
  # Announcements
15
+ **The default branch name for this repository has been changed to `main` as of 07/27/2020.**
15
16
 
16
- All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/ruby-http-client/blob/master/CHANGELOG.md).
17
+ All updates to this library are documented in our [CHANGELOG](CHANGELOG.md).
17
18
 
18
19
  # Table of Contents
19
20
  - [Installation](#installation)
@@ -56,7 +57,7 @@ gem install ruby_http_client
56
57
 
57
58
  ```ruby
58
59
  require 'ruby_http_client'
59
- global_headers = {'Authorization' => 'Basic XXXXXXX' }
60
+ global_headers = {'Authorization' => 'Bearer XXXXXXX' }
60
61
  client = SendGrid::Client.new(host: 'base_url', request_headers: global_headers)
61
62
  client.your.api._(param).call.get
62
63
  puts response.status_code
@@ -68,7 +69,7 @@ puts response.headers
68
69
 
69
70
  ```ruby
70
71
  require 'ruby_http_client'
71
- global_headers = {'Authorization' => 'Basic XXXXXXX' }
72
+ global_headers = {'Authorization' => 'Bearer XXXXXXX' }
72
73
  client = SendGrid::Client.new(host: 'base_url', request_headers: global_headers)
73
74
  query_params = { 'hello' => 0, 'world' => 1 }
74
75
  request_headers = { 'X-Test' => 'test' }
@@ -84,7 +85,7 @@ puts response.headers
84
85
  <a name="usage"></a>
85
86
  # Usage
86
87
 
87
- - [Example Code](https://github.com/sendgrid/ruby-http-client/tree/master/examples)
88
+ - [Example Code](examples)
88
89
 
89
90
  <a name="roadmap"></a>
90
91
  # Roadmap
@@ -94,22 +95,23 @@ If you are interested in the future direction of this project, please take a loo
94
95
  <a name="contribute"></a>
95
96
  # How to Contribute
96
97
 
97
- We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md) guide for details.
98
+ We encourage contribution to our libraries, please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
98
99
 
99
100
  Quick links:
100
101
 
101
- - [Feature Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#feature-request)
102
- - [Bug Reports](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#submit-a-bug-report)
103
- - [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md)
104
- - [Improvements to the Codebase](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
105
- - [Review Pull Requests](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#code-reviews)
102
+ - [Feature Request](CONTRIBUTING.md#feature-request)
103
+ - [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
104
+ - [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
105
+ - [Review Pull Requests](CONTRIBUTING.md#code-reviews)
106
106
 
107
107
  <a name="about"></a>
108
108
  # About
109
109
 
110
- ruby-http-client is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
110
+ ruby-http-client is maintained and funded by Twilio SendGrid, Inc. The names and logos for ruby-http-client are trademarks of Twilio SendGrid, Inc.
111
111
 
112
- ruby-http-client is maintained and funded by SendGrid, Inc. The names and logos for ruby-http-client are trademarks of SendGrid, Inc.
112
+ If you need help installing or using the library, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).
113
+
114
+ 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!
113
115
 
114
116
  # License
115
117
  [The MIT License (MIT)](LICENSE.md)
data/ruby_http_client.gemspec CHANGED
@@ -3,9 +3,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
3
 
4
4
  Gem::Specification.new do |spec|
5
5
  spec.name = 'ruby_http_client'
6
- spec.version = '3.5.0'
6
+ spec.version = '3.5.1'
7
7
  spec.authors = ['Elmer Thomas']
8
- spec.email = 'dx@sendgrid.com'
8
+ spec.email = 'help@twilio.com'
9
9
  spec.summary = 'A simple REST client'
10
10
  spec.description = 'Quickly and easily access any REST or REST-like API.'
11
11
  spec.homepage = 'http://github.com/sendgrid/ruby-http-client'
@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
18
18
  spec.add_development_dependency 'codecov'
19
19
  spec.add_development_dependency 'minitest'
20
20
  spec.add_development_dependency 'rake'
21
- spec.add_development_dependency 'rubocop'
22
- spec.add_development_dependency 'simplecov'
21
+ spec.add_development_dependency 'rubocop', '~> 0.88.0'
22
+ spec.add_development_dependency 'simplecov', '~> 0.18.5'
23
23
  end
data/twilio_sendgrid_logo.png ADDED
Binary file
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ruby_http_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.5.0
4
+ version: 3.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elmer Thomas
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-03-04 00:00:00.000000000 Z
11
+ date: 2020-08-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: codecov
@@ -56,32 +56,32 @@ dependencies:
56
56
  name: rubocop
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
- - - ">="
59
+ - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: '0'
61
+ version: 0.88.0
62
62
  type: :development
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
- - - ">="
66
+ - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: '0'
68
+ version: 0.88.0
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: simplecov
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - ">="
73
+ - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: '0'
75
+ version: 0.18.5
76
76
  type: :development
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
- - - ">="
80
+ - - "~>"
81
81
  - !ruby/object:Gem::Version
82
- version: '0'
82
+ version: 0.18.5
83
83
  description: Quickly and easily access any REST or REST-like API.
84
- email: dx@sendgrid.com
84
+ email: help@twilio.com
85
85
  executables: []
86
86
  extensions: []
87
87
  extra_rdoc_files: []
@@ -94,6 +94,7 @@ files:
94
94
  - CHANGELOG.md
95
95
  - CODE_OF_CONDUCT.md
96
96
  - CONTRIBUTING.md
97
+ - FIRST_TIMERS.md
97
98
  - Gemfile
98
99
  - ISSUE_TEMPLATE.md
99
100
  - LICENSE.md
@@ -104,11 +105,13 @@ files:
104
105
  - TROUBLESHOOTING.md
105
106
  - USAGE.md
106
107
  - examples/example.rb
107
- - first-timers.md
108
108
  - lib/ruby_http_client.rb
109
109
  - ruby_http_client.gemspec
110
+ - static/img/github-fork.png
111
+ - static/img/github-sign-up.png
110
112
  - test/test_helper.rb
111
113
  - test/test_ruby_http_client.rb
114
+ - twilio_sendgrid_logo.png
112
115
  - use_cases/README.md
113
116
  homepage: http://github.com/sendgrid/ruby-http-client
114
117
  licenses:
@@ -129,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
129
132
  - !ruby/object:Gem::Version
130
133
  version: '0'
131
134
  requirements: []
132
- rubygems_version: 3.0.3
135
+ rubygems_version: 3.0.8
133
136
  signing_key:
134
137
  specification_version: 4
135
138
  summary: A simple REST client
data/first-timers.md DELETED
@@ -1,70 +0,0 @@
1
- # How To Contribute to ruby-http-client for first-timers
2
-
3
- We know that contributing to an open source project for the first time can be intimidating.
4
-
5
- This documentation serves to guide you on how to make your first contribution.
6
-
7
- Assuming you already have a [Github account](https://github.com/join), here are the steps to make your first contribution:
8
-
9
- ## Finding a task you can handle
10
-
11
- We label our issues according to their difficulty level. You can find easy ones [here](https://github.com/sendgrid/ruby-http-client/issues?q=is%3Aopen+is%3Aissue+label%3A%22difficulty%3A+easy%22) but feel free to explore other labels too.
12
-
13
- - [Medium labeled issues](https://github.com/sendgrid/ruby-http-client/issues?q=is%3Aopen+is%3Aissue+label%3A%22difficulty%3A+medium%22)
14
- - [Hard labeled issues](https://github.com/sendgrid/ruby-http-client/issues?q=is%3Aopen+is%3Aissue+label%3A%22difficulty%3A+hard%22)
15
-
16
-
17
- ## Creating a Pull Request<a name="creating-a-pull-request"></a>
18
-
19
- 1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
20
- and configure the remotes:
21
-
22
- ```bash
23
- # Clone your fork of the repo into the current directory
24
- git clone https://github.com/sendgrid/ruby-http-client
25
- # Navigate to the newly cloned directory
26
- cd ruby-http-client
27
- # Assign the original repo to a remote called "upstream"
28
- git remote add upstream https://github.com/sendgrid/ruby-http-client
29
- ```
30
-
31
- 2. If you cloned a while ago, get the latest changes from upstream:
32
-
33
- ```bash
34
- git checkout <dev-branch>
35
- git pull upstream <dev-branch>
36
- ```
37
-
38
- 3. Create a new topic branch (off of the main project development branch) to
39
- contain your feature, change, or fix:
40
-
41
- ```bash
42
- git checkout -b <topic-branch-name>
43
- ```
44
-
45
- 4. Commit your changes in logical chunks. Please adhere to these [git commit
46
- message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
47
- or your code is unlikely be merged into the main project. Use Git's
48
- [interactive rebase](https://help.github.com/articles/interactive-rebase)
49
- feature to tidy up your commits before making them public.
50
-
51
- 4a. Create tests.
52
-
53
- 4b. Create or update the example code that demonstrates the functionality of this change to the code.
54
-
55
- 5. Locally merge (or rebase) the upstream development branch into your topic branch:
56
-
57
- ```bash
58
- git pull [--rebase] upstream master
59
- ```
60
-
61
- 6. Push your topic branch up to your fork:
62
-
63
- ```bash
64
- git push origin <topic-branch-name>
65
- ```
66
-
67
- 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
68
- with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
69
-
70
- If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.