ruby_http_client 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f96204e110fa9585143ab6df25e1f452ac13a264
-  data.tar.gz: e61b148893688c666f487682a93693b08e32a276
+SHA256:
+  metadata.gz: a76e3392d677cadaf41d419bdec64bafc4ddda722b1c805171cec97ff27767da
+  data.tar.gz: 101c510d5c659e4108073466b6c963b54405fb770ccecd4f398c0b3328c9fd56
 SHA512:
-  metadata.gz: fd090f25ab9ef5fc013feeb1e78d955d749c78de5a78b062e3672b8d9fbdb5fecd0a2be6ce9740b99513d8155099ee1911fde3125ce398da9e9652cbbc51eeee
-  data.tar.gz: 17e37ac97e6b926f85e2ad97acdd72a6afb0f1ef533c114f0b74be513452da60ffa1fcaf5a571c443e0b757adec692e04438f9d79153b0f69cefe26857020293
+  metadata.gz: be8d8d553070cde4f609c23a8b24392c92260dc01146391f60e0cb095d620f4b8d7ca013283d8384150b0729ce61902972e9072c82ae9e67fcbaaddd57594406
+  data.tar.gz: e29ca74e02e911742d5d3af6e4ee537d78033e71ee4764762c8f092c76955bff5f377fa8b77070bf3c2bd73ee26578cbd04db0bdb1dd807567122bc17b5c0198

data/.env_sample

@@ -0,0 +1 @@
+export SENDGRID_API_KEY=''

data/.github/PULL_REQUEST_TEMPLATE

@@ -12,7 +12,7 @@ Closes #2
 ### Checklist
 - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
 - [ ] I have read the [Contribution Guide] and my PR follows them.
-- [ ] I updated my branch with the master branch.
+- [ ] I updated my branch with the development branch.
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] I have added necessary documentation about the functionality in the appropriate .md file
 - [ ] I have added in line documentation to the code I modified

data/.gitignore

@@ -1,4 +1,5 @@
 bin
+vendor/*
 *.gem
 *.rbc
 /.config

data/.rubocop.yml

@@ -0,0 +1,47 @@
+AllCops:
+  Exclude:
+    - bin/**/*
+    - script/**/*
+    - vendor/**/*
+    - cookbooks/**/*
+
+ClassLength:
+  Enabled: false
+CyclomaticComplexity:
+  Enabled: false
+Documentation:
+  Enabled: false
+Encoding:
+  Enabled: false
+LineLength:
+  Enabled: false
+MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+PerceivedComplexity:
+  Enabled: false
+Style/SpaceBeforeFirstArg:
+  Enabled: true
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/EmptyLinesAroundBlockBody:
+  Enabled: true
+Style/FileName:
+  Enabled: true
+Style/RescueModifier:
+  Enabled: true
+Style/StringLiterals:
+  Enabled: true
+Metrics/BlockLength:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/ExtraSpacing:
+  Enabled: true
+  AllowForAlignment: false
+  ForceEqualSignAlignment: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -1,17 +1,46 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=$CC_TEST_REPORTER_ID
+
 language: ruby
 rvm:
-- 2.2
+  - ruby-head
+  - 2.6
+  - 2.5
+  - 2.4
+  - jruby
+
 before_install:
 - gem install minitest
+- gem install simplecov
+
 notifications:
   hipchat:
     rooms:
       secure: S0K355wxCRxwK2cOmbcVOaQitRtIEIq0OEEW7JZp8XtooupGwpmJSm22gqeo7GR6eidqlV8Tp6SUffpLE6SvS0hed3LDbJw7oWoXA7XvRp7gh/AKvLZ0e2uz/a1WPSYy0gNS3TJ72PcyoMS6rPCKR0FyDu8mQ2sW8CpZG07NDCmJPgO+dKfnpeuEmElZoh0AZxE6u1RjvUdSzxnmCVjve621ghtMaKInd0fnNPOM6tm9L0HKSbaLI/buphYhQ/DLpO+dLvt7W2yN+9BwaGqPv7X04Sn0UVAu9+EjSouLLBVNRIsdUfgRGeooStm8/Iw0c1brY4goyYJxGs0TiPkfPeWJcNmQ68YSZLDhUGoMZWCZwGq0Lm/oThJX8K777r3qt0Td4iAXNG+bVN+1KZtZRra6B/qBKBcpTTs1p4WRfIUY9D6udwyWZMcGEOFecsyt/MRlkjdmu+zSvZsadvhvQCL+m+aUmTtlUbswXu46g5NxQrHS9UKzzPkk/3mUrO1r4HLhhuuNtn3LRMbx9WVMdidMiFaAxG99VFC0Gon//FMvpTShNrRRuNSW7EJ0V8gwpx69SticfxC88pfka/MEeY9KoZc3MJdILbpgLK5oPuFMih2F/emJP1muWnk8mjaEHqHPqnSuKRr4oqO1xbh+r2ggKW58akCe08a4TihD4rg=
     template:
-    - '<a href="https://travis-ci.org/%{repository}/builds/%{build_id}">%{repository}
-      Build %{build_number}</a> on branch <i>%{branch}</i> by %{author}: <strong>%{message}</strong>
-      <a href="https://github.com/sendgrid/%{repository}/commits/%{commit}">View on GitHub</a>'
+      - '<a href="https://travis-ci.org/%{repository}/builds/%{build_id}">%{repository}
+	Build %{build_number}</a> on branch <i>%{branch}</i> by %{author}: <strong>%{message}</strong>
+	<a href="https://github.com/sendgrid/%{repository}/commits/%{commit}">View on GitHub</a>'
     format: html
     notify: false
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
 script:
-    - rake
+  - rake
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: CWlfN170i/fHPrIufHHLWQ0utjuhxf4ELSxKeypIuO2CNTqNMzocDAa2vxMt4XfO6d2wFPV/LC+IHR7i+sp7PKvjRoa4BLUUxjfBNDboc0gGESeUYlAxwsJo0tOVCNmpxgjQKqtPLz/19A/v/xpxLv2Im/9Idqa5ATd06sMDdM8=
+  gem: ruby-http-client
+  on:
+    tags: true
+    rvm: '2.4'

data/CHANGELOG.md

@@ -3,7 +3,42 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [3.3.0] - 2017-10-30
+[2020-01-09] Version 3.4.0
+--------------------------
+**Library - Fix**
+- [PR #108](https://github.com/sendgrid/ruby-http-client/pull/108): Avoid mutating @url_path to avoid unexpected side effects. Thanks to [@tachyons](https://github.com/tachyons)!
+- [PR #49](https://github.com/sendgrid/ruby-http-client/pull/49): change year for the license file. Thanks to [@luiscobits](https://github.com/luiscobits)!
+- [PR #48](https://github.com/sendgrid/ruby-http-client/pull/48): update LICENSE - fix year. Thanks to [@pushkyn](https://github.com/pushkyn)!
+
+**Library - Docs**
+- [PR #105](https://github.com/sendgrid/ruby-http-client/pull/105): Add our Developer Experience Engineer career opportunity to the READM…. Thanks to [@mptap](https://github.com/mptap)!
+- [PR #61](https://github.com/sendgrid/ruby-http-client/pull/61): update CONTRIBUTING.md. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #86](https://github.com/sendgrid/ruby-http-client/pull/86): Add first time contributor documentation. Thanks to [@eyewritecode](https://github.com/eyewritecode)!
+- [PR #91](https://github.com/sendgrid/ruby-http-client/pull/91): update contribution to branch off development. Thanks to [@vikasnautiyal](https://github.com/vikasnautiyal)!
+- [PR #72](https://github.com/sendgrid/ruby-http-client/pull/72): Add USAGE.md. Thanks to [@ProZsolt](https://github.com/ProZsolt)!
+- [PR #73](https://github.com/sendgrid/ruby-http-client/pull/73): Create a Use Cases Directory. Thanks to [@ProZsolt](https://github.com/ProZsolt)!
+- [PR #41](https://github.com/sendgrid/ruby-http-client/pull/41): Create PULL_REQUEST_TEMPLATE.md. Thanks to [@flaredragon](https://github.com/flaredragon)!
+
+**Library - Chore**
+- [PR #80](https://github.com/sendgrid/ruby-http-client/pull/80): Missing Dev Dependencies + rubocop  #79. Thanks to [@kplimack](https://github.com/kplimack)!
+- [PR #66](https://github.com/sendgrid/ruby-http-client/pull/66): delete PULL_REQUEST_TEMPLATE.md. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #76](https://github.com/sendgrid/ruby-http-client/pull/76): Add Gemfile. Thanks to [@kplimack](https://github.com/kplimack)!
+- [PR #58](https://github.com/sendgrid/ruby-http-client/pull/58): [Closes #55] Add code coverage reporting to CC. Thanks to [@lauratpa](https://github.com/lauratpa)!
+- [PR #57](https://github.com/sendgrid/ruby-http-client/pull/57): [Closes #56] Fix some rubocop issues. Thanks to [@lauratpa](https://github.com/lauratpa)!
+- [PR #50](https://github.com/sendgrid/ruby-http-client/pull/50): Added unittest to check for specific repo files. Thanks to [@mptap](https://github.com/mptap)!
+- [PR #51](https://github.com/sendgrid/ruby-http-client/pull/51): Add License end year test. Thanks to [@diegous](https://github.com/diegous)!
+- [PR #39](https://github.com/sendgrid/ruby-http-client/pull/39): Add a .env_sample file. Thanks to [@thepriefy](https://github.com/thepriefy)!
+- [PR #112](https://github.com/sendgrid/ruby-http-client/pull/112): Auto-deploy upon successful tagged commit. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #111](https://github.com/sendgrid/ruby-http-client/pull/111): Update CHANGELOG heading format for automation. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #110](https://github.com/sendgrid/ruby-http-client/pull/110): Add Makefile for Librarian automation. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+**Library - Feature**
+- [PR #75](https://github.com/sendgrid/ruby-http-client/pull/75): Add ability to set proxy. Thanks to [@eitoball](https://github.com/eitoball)!
+- [PR #20](https://github.com/sendgrid/ruby-http-client/pull/20): Add option to set http attributes when creating an instance of Client. Thanks to [@jrectenwald](https://github.com/jrectenwald)!
+
+
+[2017-10-30] Version 3.3.0
+--------------------------
 ## Added
 - #11 fix: Allow for multiple values for a parameter
 - Thanks to [xiaoboa](https://github.com/xiaoboa) for the pull request!

data/CONTRIBUTING.md

@@ -73,11 +73,7 @@ git clone https://github.com/sendgrid/ruby-http-client.git
 cd ruby-http-client
 ```
 
-##### Execute: #####
-
-See the [examples folder](https://github.com/sendgrid/ruby-http-client/tree/master/examples) to get started quickly.
-
-To try the SendGrid example:
+### Environment Variables
 
 First, get your free SendGrid account [here](https://sendgrid.com/free?source=ruby-http-client).
 
@@ -89,6 +85,10 @@ echo "sendgrid.env" >> .gitignore
 source ./sendgrid.env
 ```
 
+##### Execute: #####
+
+See the [examples folder](https://github.com/sendgrid/ruby-http-client/tree/master/examples) to get started quickly.
+
 To run the example (after updating the emails):
 
 ```bash
@@ -130,8 +130,6 @@ rake
 
 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.
 
-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)
 
 Please run your code through:
@@ -159,7 +157,7 @@ Please run your code through:
    git pull upstream <dev-branch>
    ```
 
-3. Create a new topic branch (off the main project development branch) to
+3. Create a new topic branch off the `development` branch to
    contain your feature, change, or fix:
 
    ```bash
@@ -179,7 +177,7 @@ Please run your code through:
 5. Locally merge (or rebase) the upstream development branch into your topic branch:
 
    ```bash
-   git pull [--rebase] upstream master
+   git pull [--rebase] upstream development
    ```
 
 6. Push your topic branch up to your fork:
@@ -189,6 +187,6 @@ Please run your code through:
    ```
 
 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.
+    with a clear title and description against the `development` 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.

data/Gemfile

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

data/LICENSE.txt

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

data/Makefile

@@ -0,0 +1,7 @@
+.PHONY: install test
+
+install:
+	gem install minitest
+
+test:
+	rake

data/README.md

@@ -12,6 +12,7 @@
 If you are looking for the SendGrid API client library, please see [this repo](https://github.com/sendgrid/sendgrid-ruby).
 
 # Announcements
+**NEW:** If you're a software engineer who is passionate about #DeveloperExperience and/or #OpenSource, [this is an incredible opportunity to join our #DX team](https://sendgrid.com/careers/role/1421152/?gh_jid=1421152) as a Developer Experience Engineer and work with [@thinkingserious](https://github.com/thinkingserious) and [@aroach](https://github.com/aroach)! Tell your friends :)
 
 All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/ruby-http-client/blob/master/CHANGELOG.md).
 
@@ -31,6 +32,18 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/
 
 - Ruby version 2.2+
 
+## 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
 
 ```bash

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/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)

data/first-timers.md

@@ -0,0 +1,70 @@
+# How To Contribute to ruby-http-client for first-timers
+
+We know that contributing to an open source project for the first time can be intimidating. 
+
+This documentation serves to guide you on how to make your first contribution.
+
+Assuming you already have a [Github account](https://github.com/join), here are the steps to make your first contribution:
+
+## Finding a task you can handle
+
+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.
+
+- [Medium labeled issues](https://github.com/sendgrid/ruby-http-client/issues?q=is%3Aopen+is%3Aissue+label%3A%22difficulty%3A+medium%22)
+- [Hard labeled issues](https://github.com/sendgrid/ruby-http-client/issues?q=is%3Aopen+is%3Aissue+label%3A%22difficulty%3A+hard%22)
+
+
+## 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/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
+   ```
+
+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.

data/lib/ruby_http_client.rb

@@ -35,15 +35,19 @@ module SendGrid
     #                  Or just pass the version as part of the URL
     #                  (e.g. client._("/v3"))
     #   - +url_path+ -> A list of the url path segments
+    #   - +proxy_options+ -> A hash of proxy settings.
+    #                        (e.g. { host: '127.0.0.1', port: 8080 })
     #
-    def initialize(host: nil, request_headers: nil, version: nil, url_path: nil)
+    def initialize(host: nil, request_headers: nil, version: nil, url_path: nil, http_options: {}, proxy_options: {}) # rubocop:disable Metrics/ParameterLists
       @host = host
       @request_headers = request_headers || {}
       @version = version
       @url_path = url_path || []
-      @methods = %w(delete get patch post put)
+      @methods = %w[delete get patch post put]
       @query_params = nil
       @request_body = nil
+      @http_options = http_options
+      @proxy_options = proxy_options
     end
 
     # Update the headers for the request
@@ -138,20 +142,23 @@ module SendGrid
     def build_request(name, args)
       build_args(args) if args
       uri = build_url(query_params: @query_params)
-      @http = add_ssl(Net::HTTP.new(uri.host, uri.port))
+      @http = build_http(uri.host, uri.port)
       net_http = Kernel.const_get('Net::HTTP::' + name.to_s.capitalize)
       @request = build_request_headers(net_http.new(uri.request_uri))
-      if (@request_body &&
-          (!@request_headers.has_key?('Content-Type') ||
-           @request_headers['Content-Type'] == 'application/json')
-      )
+      if @request_body &&
+         (!@request_headers.key?('Content-Type') ||
+          @request_headers['Content-Type'] == 'application/json')
+
         @request.body = @request_body.to_json
         @request['Content-Type'] = 'application/json'
-      elsif !@request_body and (name.to_s == "post")
+      elsif !@request_body && (name.to_s == 'post')
         @request['Content-Type'] = ''
       else
         @request.body = @request_body
       end
+      @http_options.each do |attribute, value|
+        @http.send("#{attribute}=", value)
+      end
       make_request(@http, @request)
     end
 
@@ -169,6 +176,16 @@ module SendGrid
       Response.new(response)
     end
 
+    # Build HTTP request object
+    #
+    # * *Returns* :
+    #   - Request object
+    def build_http(host, port)
+      params = [host, port]
+      params += @proxy_options.values_at(:host, :port, :user, :pass) unless @proxy_options.empty?
+      add_ssl(Net::HTTP.new(*params))
+    end
+
     # Allow for https calls
     #
     # * *Args*    :
@@ -195,10 +212,10 @@ module SendGrid
     #   - Client object
     #
     def _(name = nil)
-      url_path = name ? @url_path.push(name) : @url_path
-      @url_path = []
+      url_path = name ? @url_path + [name] : @url_path
       Client.new(host: @host, request_headers: @request_headers,
-                 version: @version, url_path: url_path)
+                 version: @version, url_path: url_path,
+                 http_options: @http_options)
     end
 
     # Dynamically add segments to the url, then call a method.
@@ -209,6 +226,8 @@ module SendGrid
     # * *Returns* :
     #   - Client object or Response object
     #
+    # rubocop:disable Style/MethodMissingSuper
+    # rubocop:disable Style/MissingRespondToMissing
     def method_missing(name, *args, &_block)
       # Capture the version
       if name.to_s == 'version'
@@ -217,8 +236,11 @@ module SendGrid
       end
       # We have reached the end of the method chain, make the API call
       return build_request(name, args) if @methods.include?(name.to_s)
+
       # Add a segment to the URL
       _(name)
     end
+    # rubocop:enable Style/MethodMissingSuper
+    # rubocop:enable Style/MissingRespondToMissing
   end
 end

data/ruby_http_client.gemspec

@@ -1,20 +1,22 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name        = 'ruby_http_client'
-  spec.version     = '3.3.0'
-  spec.authors     = ['Elmer Thomas']
-  spec.email       = 'dx@sendgrid.com'
-  spec.summary     = 'A simple REST client'
+  spec.name = 'ruby_http_client'
+  spec.version = '3.4.0'
+  spec.authors = ['Elmer Thomas']
+  spec.email = 'dx@sendgrid.com'
+  spec.summary = 'A simple REST client'
   spec.description = 'Quickly and easily access any REST or REST-like API.'
-  spec.homepage    = 'http://github.com/sendgrid/ruby-http-client'
-  spec.license     = 'MIT'
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.homepage = 'http://github.com/sendgrid/ruby-http-client'
+  spec.license = 'MIT'
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
 end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+if ENV['CI'] == 'true'
+  require 'simplecov'
+  SimpleCov.start
+end

data/test/test_ruby_http_client.rb

@@ -1,3 +1,4 @@
+require './test/test_helper'
 require 'ruby_http_client'
 require 'minitest/autorun'
 
@@ -31,9 +32,14 @@ class TestClient < Minitest::Test
         ')
     @host = 'http://localhost:4010'
     @version = 'v3'
+    @http_options = { open_timeout: 60, read_timeout: 60 }
     @client = MockRequest.new(host: @host,
                               request_headers: @headers,
                               version: @version)
+    @client_with_options = MockRequest.new(host: @host,
+                                           request_headers: @headers,
+                                           version: @version,
+                                           http_options: @http_options)
   end
 
   def test_init
@@ -61,7 +67,7 @@ class TestClient < Minitest::Test
 
   def test_build_query_params
     url = ''
-    query_params = { 'limit' => 100, 'offset' => 0, 'categories' => ['category1', 'category2'] }
+    query_params = { 'limit' => 100, 'offset' => 0, 'categories' => %w[category1 category2] }
     url = @client.build_query_params(url, query_params)
     assert_equal('?limit=100&offset=0&categories=category1&categories=category2', url)
   end
@@ -91,8 +97,8 @@ class TestClient < Minitest::Test
     args = nil
     response = @client.build_request(name, args)
     assert_equal(200, response.status_code)
-    assert_equal({'message' => 'success'}, response.body)
-    assert_equal({'headers' => 'test'}, response.headers)
+    assert_equal({ 'message' => 'success' }, response.body)
+    assert_equal({ 'headers' => 'test' }, response.headers)
   end
 
   def test_build_request_post_empty_content_type
@@ -103,7 +109,7 @@ class TestClient < Minitest::Test
       request_headers: headers,
       version: 'v3'
     )
-    args = [{'request_body' => {"hogekey" => "hogevalue"}}]
+    args = [{ 'request_body' => { 'hogekey' => 'hogevalue' } }]
     client.build_request('post', args)
     assert_equal('application/json', client.request['Content-Type'])
     assert_equal('{"hogekey":"hogevalue"}', client.request.body)
@@ -143,10 +149,10 @@ class TestClient < Minitest::Test
     }
     client = MockRequest.new(
       host: 'https://localhost',
-      request_headers: headers,
+      request_headers: headers
     )
     name = 'post'
-    args = [{'request_body' => 'hogebody'}]
+    args = [{ 'request_body' => 'hogebody' }]
     client.build_request(name, args)
     assert_equal('multipart/form-data; boundary=xYzZY', client.request['Content-Type'])
     assert_equal('hogebody', client.request.body)
@@ -168,7 +174,112 @@ class TestClient < Minitest::Test
   def test_method_missing
     response = @client.get
     assert_equal(200, response.status_code)
-    assert_equal({'message' => 'success'}, response.body)
-    assert_equal({'headers' => 'test'}, response.headers)
+    assert_equal({ 'message' => 'success' }, response.body)
+    assert_equal({ 'headers' => 'test' }, response.headers)
+  end
+
+  def test_http_options
+    url1 = @client_with_options._('test')
+    assert_equal(@host, @client_with_options.host)
+    assert_equal(@headers, @client_with_options.request_headers)
+    assert_equal(['test'], url1.url_path)
+  end
+
+  def test_proxy_options
+    proxy_options = {
+      host: '127.0.0.1', port: 8080, user: 'anonymous', pass: 'secret'
+    }
+    client = MockRequest.new(
+      host: 'https://api.sendgrid.com',
+      request_headers: { 'Authorization' => 'Bearer xxx' },
+      proxy_options: proxy_options
+    ).version('v3').api_keys
+
+    assert(client.proxy_address, '127.0.0.1')
+    assert(client.proxy_pass, 'secret')
+    assert(client.proxy_port, 8080)
+    assert(client.proxy_user, 'anonymous')
+  end
+
+  def test_proxy_from_http_proxy_environment_variable
+    ENV['http_proxy'] = 'anonymous:secret@127.0.0.1:8080'
+
+    client = MockRequest.new(
+      host: 'https://api.sendgrid.com',
+      request_headers: { 'Authorization' => 'Bearer xxx' }
+    ).version('v3').api_keys
+
+    assert(client.proxy_address, '127.0.0.1')
+    assert(client.proxy_pass, 'secret')
+    assert(client.proxy_port, 8080)
+    assert(client.proxy_user, 'anonymous')
+  ensure
+    ENV.delete('http_proxy')
+  end
+
+  # def test_docker_exists
+  #   assert(File.file?('./Dockerfile') || File.file?('./docker/Dockerfile'))
+  # end
+
+  # def test_docker_compose_exists
+  #   assert(File.file?('./docker-compose.yml') || File.file?('./docker/docker-compose.yml'))
+  # end
+
+  def test_env_sample_exists
+    assert(File.file?('./.env_sample'))
+  end
+
+  def test_gitignore_exists
+    assert(File.file?('./.gitignore'))
+  end
+
+  def test_travis_exists
+    assert(File.file?('./.travis.yml'))
+  end
+
+  def test_codeclimate_exists
+    assert(File.file?('./.codeclimate.yml'))
+  end
+
+  def test_changelog_exists
+    assert(File.file?('./CHANGELOG.md'))
+  end
+
+  def test_code_of_conduct_exists
+    assert(File.file?('./CODE_OF_CONDUCT.md'))
+  end
+
+  def test_contributing_exists
+    assert(File.file?('./CONTRIBUTING.md'))
+  end
+
+  def test_issue_template_exists
+    assert(File.file?('./.github/ISSUE_TEMPLATE'))
+  end
+
+  def test_license_exists
+    assert(File.file?('./LICENSE.md') || File.file?('./LICENSE.txt'))
+  end
+
+  def test_pull_request_template_exists
+    assert(File.file?('./.github/PULL_REQUEST_TEMPLATE'))
+  end
+
+  def test_readme_exists
+    assert(File.file?('./README.md'))
+  end
+
+  def test_troubleshooting_exists
+    assert(File.file?('./TROUBLESHOOTING.md'))
+  end
+
+  def test_use_cases_exists
+    assert(File.file?('use_cases/README.md'))
+  end
+
+  def test_license_date_is_updated
+    license_end_year = IO.read('LICENSE.txt').match(/Copyright \(c\) 2016-(\d{4}) Twilio SendGrid/)[1].to_i
+    current_year = Time.new.year
+    assert_equal(current_year, license_end_year)
   end
 end

data/use_cases/README.md

@@ -0,0 +1,3 @@
+This directory provides examples for specific use cases. Please [open an issue](https://github.com/sendgrid/ruby-http-client/issues) or make a pull request for any use cases you would like us to document here. Thank you!
+
+ # Table of Contents

metadata

@@ -1,27 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: ruby_http_client
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Elmer Thomas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Quickly and easily access any REST or REST-like API.
@@ -31,21 +73,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".env_sample"
 - ".github/ISSUE_TEMPLATE"
 - ".github/PULL_REQUEST_TEMPLATE"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - TROUBLESHOOTING.md
+- USAGE.md
 - examples/example.rb
+- first-timers.md
 - lib/ruby_http_client.rb
 - ruby_http_client.gemspec
+- test/test_helper.rb
 - test/test_ruby_http_client.rb
+- use_cases/README.md
 homepage: http://github.com/sendgrid/ruby-http-client
 licenses:
 - MIT
@@ -65,10 +115,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A simple REST client
 test_files:
+- test/test_helper.rb
 - test/test_ruby_http_client.rb