ruby_http_client 3.3.0 → 3.5.2

data/FIRST_TIMERS.md

@@ -0,0 +1,79 @@
+# How To Contribute to Twilio SendGrid Repositories via GitHub
+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.
+
+To make a pull request, follow these steps:
+
+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.
+
+<img src="/static/img/github-sign-up.png" width="800">
+
+2. __[Fork](https://help.github.com/fork-a-repo/)__ the [ruby-http-client](https://github.com/sendgrid/ruby-http-client) repository:
+
+<img src="/static/img/github-fork.png" width="800">
+
+3. __Clone__  your fork via the following commands:
+
+```bash
+# Clone your fork of the repo into the current directory
+git clone https://github.com/your_username/ruby-http-client
+# Navigate to the newly cloned directory
+cd ruby-http-client
+# Assign the original repo to a remote called "upstream"
+git remote add upstream https://github.com/sendgrid/ruby-http-client
+```
+
+> Don't forget to replace *your_username* in the URL by your real GitHub username.
+
+4. __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>
+```
+
+5. __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. 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.
+
+6. __Locally merge (or rebase)__ the upstream development branch into your topic branch:
+
+```bash
+git pull [--rebase] upstream main
+```
+
+7. __Push__ your topic branch up to your fork:
+
+```bash
+git push origin <topic-branch-name>
+```
+
+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.
+
+## Important notice
+
+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.
+
+## Repositories with Open, Easy, Help Wanted, Issue Filters
+
+* [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)
+* [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)
+* [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)
+* [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)
+* [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)
+* [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)
+* [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)
+* [Python SMTPAPI 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)
+* [PHP SMTPAPI 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)
+* [C# SMTPAPI 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)
+* [Ruby SMTPAPI 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)
+* [Node.js SMTPAPI 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)
+* [Java SMTPAPI 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)
+* [Go SMTPAPI 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)
+* [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)
+* [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)
+* [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)
+* [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)
+* [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)
+* [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)
+* [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)
+* [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)
+* [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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,30 @@
+<!--
+If this is a feature request, make sure you search Issues for an existing request before creating a new one!
+
+Please utilize the template below to help us resolve your issue.
+
+Note that many issues can be resolved by updating to the latest version.
+-->
+
+### 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, or code examples.
+
+### Steps to Reproduce
+1. This is the first step
+2. This is the second step
+3. Further steps, etc.
+
+### Code Snippet
+```ruby
+# paste code here
+```
+
+### Exception/Log
+```
+# paste exception/log here
+```
+
+### Technical details:
+* ruby-http-client version: 
+* ruby version:
+

data/{LICENSE.txt → LICENSE}

@@ -1,13 +1,13 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2016-2017 SendGrid, Inc.
+Copyright (C) 2021, Twilio SendGrid, Inc. <help@twilio.com>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

data/Makefile

@@ -0,0 +1,7 @@
+.PHONY: install test
+
+install:
+	gem install bundler:1.14.6; bundle install
+
+test:
+	rake test

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!--
+We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines, then fill out the blanks below.
+
+Please format the PR title appropriately based on the type of change:
+  <type>[!]: <description>
+Where <type> is one of: docs, chore, feat, fix, test.
+Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature).
+
+**All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.**
+
+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
+-->
+
+# Fixes #
+
+A short description of what this PR does.
+
+### Checklist
+- [x] I acknowledge that all my contributions will be made under the project's license
+- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
+- [ ] I have read the [Contribution Guidelines](https://github.com/sendgrid/ruby-http-client/blob/main/CONTRIBUTING.md) and my PR follows them
+- [ ] I have titled the PR appropriately
+- [ ] I have updated my branch with the main branch
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added the necessary documentation about the functionality in the appropriate .md file
+- [ ] I have added inline documentation to the code I modified
+
+If you have questions, please file a [support ticket](https://support.sendgrid.com), or create a GitHub Issue in this repository.

data/README.md

@@ -1,9 +1,9 @@
-![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
+![SendGrid Logo](twilio_sendgrid_logo.png)
 
-[![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/ruby-http-client)
+[![BuildStatus](https://travis-ci.com/sendgrid/ruby-http-client.svg?branch=main)](https://travis-ci.com/sendgrid/ruby-http-client)
 [![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
-[![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
-[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
+[![Gem Version](https://badge.fury.io/rb/ruby_http_client.svg)](https://badge.fury.io/rb/ruby_http_client)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 [![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
 [![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/ruby-http-client.svg)](https://github.com/sendgrid/ruby-http-client/graphs/contributors)
 
@@ -12,14 +12,14 @@
 If you are looking for the SendGrid API client library, please see [this repo](https://github.com/sendgrid/sendgrid-ruby).
 
 # Announcements
+**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
 
-All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/ruby-http-client/blob/master/CHANGELOG.md).
+All updates to this library are documented in our [CHANGELOG](CHANGELOG.md).
 
 # Table of Contents
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Usage](#usage)
-- [Roadmap](#roadmap)
 - [How to Contribute](#contribute)
 - [About](#about)
 - [License](#license)
@@ -29,7 +29,19 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/
 
 ## Prerequisites
 
-- Ruby version 2.2+
+- Ruby version >= 2.4
+
+## Setup Environment Variables
+
+### Environment Variable
+
+Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example:
+
+```bash
+echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
+echo "sendgrid.env" >> .gitignore
+source ./sendgrid.env
+```
 
 ## Install Package
 
@@ -44,7 +56,7 @@ gem install ruby_http_client
 
 ```ruby
 require 'ruby_http_client'
-global_headers = {'Authorization' => 'Basic XXXXXXX' }
+global_headers = {'Authorization' => 'Bearer XXXXXXX' }
 client = SendGrid::Client.new(host: 'base_url', request_headers: global_headers)
 client.your.api._(param).call.get
 puts response.status_code
@@ -56,7 +68,7 @@ puts response.headers
 
 ```ruby
 require 'ruby_http_client'
-global_headers = {'Authorization' => 'Basic XXXXXXX' }
+global_headers = {'Authorization' => 'Bearer XXXXXXX' }
 client = SendGrid::Client.new(host: 'base_url', request_headers: global_headers)
 query_params = { 'hello' => 0, 'world' => 1 }
 request_headers = { 'X-Test' => 'test' }
@@ -72,31 +84,28 @@ puts response.headers
 <a name="usage"></a>
 # Usage
 
-- [Example Code](https://github.com/sendgrid/ruby-http-client/tree/master/examples)
-
-<a name="roadmap"></a>
-# Roadmap
-
-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.
+- [Example Code](examples)
 
 <a name="contribute"></a>
 # 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.
+We encourage contribution to our libraries, please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
 
 Quick links:
 
-- [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)
+- [Feature Request](CONTRIBUTING.md#feature-request)
+- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
+- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
+- [Review Pull Requests](CONTRIBUTING.md#code-reviews)
 
 <a name="about"></a>
 # About
 
-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 Twilio SendGrid, Inc. The names and logos for ruby-http-client are trademarks of Twilio SendGrid, Inc.
+
+If you need help installing or using the library, please check the [Twilio SendGrid Support Help Center](https://support.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.
+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!
 
 # License
-[The MIT License (MIT)](LICENSE.txt)
+[The MIT License (MIT)](LICENSE)

data/Rakefile

@@ -4,5 +4,28 @@ Rake::TestTask.new do |t|
   t.libs << 'test'
 end
 
-desc "Run tests"
-task :default => :test
+desc 'run rubocop'
+task :rubocop do
+  sh 'rubocop -c .rubocop.yml --display-only-fail-level-offenses -D'
+end
+
+desc 'run rubocop w/autocorrect'
+task :rubocorrect do
+  sh 'rubocop -c .rubocop.yml -a'
+end
+
+desc 'run minitest'
+task :minitest do
+  Rake::Task[:test].invoke
+end
+
+desc 'Run tests'
+task default: 'test:quick'
+
+namespace :test do
+  desc 'Run all the quick tests'
+  task :quick do
+    Rake::Task['rubocop'].invoke
+    Rake::Task['minitest'].invoke
+  end
+end

data/TROUBLESHOOTING.md

@@ -8,7 +8,7 @@ If you can't find a solution below, please open an [issue](https://github.com/se
 <a name="request-body"></a>
 ## Viewing the Request Body
 
-When debugging or testing, it may be useful to exampine the raw request body to compare against the [documented format](https://sendgrid.com/docs/API_Reference/api_v3.html).
+When debugging or testing, it may be useful to examine the raw request body to compare against the [documented format](https://sendgrid.com/docs/API_Reference/api_v3.html).
 
 You can do this right before you call: `response = client.version('v3').api_keys.post(request_body: request_body)` like so:
 

data/USAGE.md

@@ -0,0 +1,108 @@
+# Usage
+
+Usage examples for SendGrid ruby-http-client
+
+## Initialization
+
+```ruby
+require_relative '../lib/ruby_http_client'
+
+# This uses the SendGrid API as an example
+headers = JSON.parse('
+  {
+    "Authorization": "Bearer ' + ENV['SENDGRID_API_KEY'] + '"
+  }
+')
+host = 'https://api.sendgrid.com'
+client = SendGrid::Client.new(host: host, request_headers: headers)
+```
+
+## Table of Contents
+
+- [GET](#get)
+- [DELETE](#delete)
+- [POST](#post)
+- [PUT](#put)
+- [PATCH](#patch)
+
+## GET
+
+#### GET Collection
+
+```ruby
+query_params = { 'limit' => 100, 'offset' => 0 }
+response = client.version('v3').api_keys.get(query_params: query_params)
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+#### GET Single
+
+```ruby
+response = client.version('v3').api_keys._(api_key_id).get
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+## DELETE
+
+```ruby
+response = client.api_keys._(api_key_id).delete
+puts response.status_code
+puts response.headers
+```
+
+## POST
+
+```ruby
+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)
+puts response.status_code
+puts response.body
+puts response.headers
+api_key_id = JSON.parse(response.body)['api_key_id']
+```
+
+## PUT
+
+```ruby
+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)
+puts response.status_code
+puts response.body
+puts response.headers
+```
+
+## PATCH
+
+```ruby
+request_body = JSON.parse('
+    {
+        "name": "A New Hope"
+    }
+')
+response = client.api_keys._(api_key_id).patch(request_body: request_body)
+puts response.status_code
+puts response.body
+puts response.headers
+```

data/examples/example.rb

@@ -6,9 +6,28 @@ headers = JSON.parse('
     "Authorization": "Bearer ' + ENV['SENDGRID_API_KEY'] + '"
   }
 ')
-host =  'https://api.sendgrid.com'
+host = 'https://api.sendgrid.com'
 client = SendGrid::Client.new(host: host, request_headers: headers)
 
+# You can pass in an http_options hash to set values for NET::HTTP attributes
+# https://ruby-doc.org/stdlib-2.4.1/libdoc/net/http/rdoc/Net/HTTP.html
+# client = SendGrid::Client.new(host: host,
+#                               request_headers: headers,
+#                               http_options: {open_timeout: 15, read_timeout: 30})
+
+# If you want to make request via proxy, you can set your proxy server in two ways.
+#
+# (1) Pass proxy_options hash
+#
+# client = SendGrid::Client.new(host: host,
+#                               request_headers: headers,
+#                               proxy_options: { host: '127.0.0.1', port: 8080 })
+#
+# (2) Set 'http_proxy' environment variable
+#
+# ENV['http_proxy'] = 'user:pass@127.0.0.1:8080'
+# 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)
@@ -69,3 +88,12 @@ puts response.headers
 response = client.api_keys._(api_key_id).delete
 puts response.status_code
 puts response.headers
+
+# Rate limit information
+response = client.version('v3').api_keys._(api_key_id).get
+puts response.ratelimit.limit
+puts response.ratelimit.remaining
+puts response.ratelimit.reset
+puts response.ratelimit.exceeded?
+# Sleep the current thread until the reset has happened
+response.ratelimit.wait!