ruby_http_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 962d8241ec81889b1f89348c24fd6cc490a9aa98
+  data.tar.gz: 4cceab98eddf6359e7e8173e511b1018b803f882
+SHA512:
+  metadata.gz: 9c75159dfae79c5f06a7b1590aaa0d985e389099c87e258c381371993d524e2114eaabe9f7055eda1caa12c5a7cbace192fd22960cdbb93b168b96ffb7d02681
+  data.tar.gz: b13713f036cdd34a1054b6aa0cb046261c4787a9252575d0cbf335003d002477c77e49391458c75fec8b795d31ba931c1d4e2b2c3da9a133f2c79f57a8019d3a

data/.env_sample

@@ -0,0 +1,4 @@
+HOST=<base_url_for_live_api_host>
+MOCK_HOST=<base_url_for_remote_mocked_api_host>
+LOCAL_HOST=<base_url_for_local_mocked_api_host>
+SENDGRID_API_KEY=<your_sendgrid_api_key>

data/.github/ISSUE_TEMPLATE

@@ -0,0 +1,17 @@
+#### 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: [commit number])
+* Ruby Version: 2.2

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.env

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+- 2.2
+notifications:
+  hipchat:
+    rooms:
+      secure: gYBEwOGBTxHE2nrxsHQqp2UdjRtCX04wVLYEimeT9RG/0LClS4nzJF7DaXLWlAwgLPmk+KV2+nXuLO5oausBr9ODmWhho8G0F90RPR47NupcvT1RM+I2ZbxSjHCUICL22mdnZd8ye/mrk/YtFWYmgmH7ILRK3BuYovXFoKoRnLg=
+    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>'
+    format: html
+    notify: false
+script:
+    - rake

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0] - 2016-03-17
+### Added
+- We are live!

data/CONTRIBUTING.md

@@ -0,0 +1,194 @@
+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.
+
+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)
+
+There are a few ways to contribute, which we'll enumerate below:
+
+<a name="feature_request"></a>
+## Feature Request
+
+If you'd like to make a feature request, please read this section.
+
+The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:
+
+- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
+- Please be respectful and considerate of others when commenting on issues
+
+<a name="submit_a_bug_report"></a>
+## Submit a Bug Report
+
+Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
+
+A software bug is a demonstrable issue in the code base. In order for us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.
+
+Before you decide to create a new issue, please try the following:
+
+1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
+2. Update to the latest version of this code and check if issue has already been fixed
+3. Copy and fill in the Bug Report Template we have provided below
+
+### 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
+```
+
+<a name="improvements_to_the_codebase"></a>
+## Improvements to the Codebase
+
+We welcome direct contributions to the python-http-client code base. Thank you!
+
+### Development Environment ###
+
+#### Install and run locally ####
+
+##### Prerequisites #####
+
+* Ruby 2.2
+* There are no external dependencies
+
+##### Initial setup: #####
+
+```
+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.
+
+<a name="understanding_the_codebase"></a>
+## Understanding the Code Base
+
+**/examples**
+
+Working examples that demonstrate usage.
+
+**ruby_http_client.rb**
+
+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.
+
+This allows for the following mapping from a URL to a method chain:
+
+`/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).
+
+**congfig.rb**
+
+Loads the environment variables.
+
+<a name="testing"></a>
+## Testing
+
+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.
+
+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.
+
+<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)
+
+Please run your code through [rubocop](https://github.com/bbatsov/rubocop).
+
+### Directory Structure
+
+* `examples` for example calls
+* `test`, for all tests
+* `libs`, for the client library
+
+## 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/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 SendGrid
+
+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.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+[![Travis Badge](https://travis-ci.org/sendgrid/python-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/ruby-http-client)
+
+**Quickly and easily access any REST or REST-like API.**
+
+Here is a quick example:
+
+`GET /your/api/{param}/call`
+
+```ruby
+require ruby_http_client
+global_headers = {'Authorization' => 'Basic XXXXXXX' }
+client = SendGrid::Client(host: 'base_url', request_headers: global_headers)
+client.your.api._(param).call.get
+puts response.status_code
+puts response.response_body
+puts response.response_headers
+```
+
+`POST /your/api/{param}/call` with headers, query parameters and a request body with versioning.
+
+```ruby
+import ruby_http_client
+global_headers = {'Authorization' => 'Basic XXXXXXX' }
+client = SendGrid::Client(host: 'base_url', request_headers: global_headers)
+query_params = { 'hello' => 0, 'world' => 1 }
+request_headers = { 'X-Test' => 'test' }
+data = { 'some' => 1, 'awesome' => 2, 'data' => 3}
+response = client.your.api._(param).call.post(request_body: data,
+                                              query_params: query_params,
+                                              request_headers: request_headers)
+puts response.status_code
+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
+
+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
+
+[2016.03.17] - We hit version 1!
+
+# Roadmap
+
+[Milestones](https://github.com/sendgrid/ruby-http-client/milestones)
+
+# 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)
+
+# Thanks
+
+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.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/examples/example.rb

@@ -0,0 +1,73 @@
+require_relative '../lib/config'
+require_relative '../lib/ruby_http_client'
+
+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)
+puts response.status_code
+puts response.response_body
+puts response.response_headers
+
+# 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)
+puts response.status_code
+puts response.response_body
+puts response.response_headers
+api_key_id = JSON.parse(response.response_body)['api_key_id']
+
+# GET Single
+response = client.version('v3').api_keys._(api_key_id).get
+puts response.status_code
+puts response.response_body
+puts response.response_headers
+
+# PATCH
+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.response_body
+puts response.response_headers
+
+# 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)
+puts response.status_code
+puts response.response_body
+puts response.response_headers
+
+# DELETE
+response = client.api_keys._(api_key_id).delete
+puts response.status_code
+puts response.response_headers

data/lib/config.rb

@@ -0,0 +1,10 @@
+# Loads environment variables from a .env file.
+class Config
+  def initialize
+    File.open('./.env').readlines.each do |line|
+      key, value = line.split '='
+      ENV[key] = value.chomp
+    end
+    ENV
+  end
+end

data/lib/ruby_http_client.rb

@@ -0,0 +1,221 @@
+# Quickly and easily access any REST or REST-like API.
+module SendGrid
+  require 'json'
+  require 'net/http'
+  require 'net/https'
+
+  # Holds the response from an API call.
+  class Response
+    # * *Args*    :
+    #   - +response+ -> A NET::HTTP response object
+    #
+    attr_reader :status_code, :response_body, :response_headers
+    def initialize(response)
+      @status_code = response.code
+      @response_body = response.body
+      @response_headers = response.to_hash.inspect
+    end
+  end
+
+  # A simple REST client.
+  class Client
+    attr_reader :host, :request_headers, :url_path
+    # * *Args*    :
+    #   - +host+ -> Base URL for the api. (e.g. https://api.sendgrid.com)
+    #   - +request_headers+ -> A hash of the headers you want applied on
+    #                          all calls
+    #   - +version+ -> The version number of the API.
+    #                  Subclass add_version for custom behavior.
+    #                  Or just pass the version as part of the URL
+    #                  (e.g. client._("/v3"))
+    #   - +url_path+ -> A list of the url path segments
+    #
+    def initialize(host: nil, request_headers: nil, version: nil, url_path: nil)
+      @host = host
+      @request_headers = request_headers ? request_headers : {}
+      @version = version
+      @url_path = url_path ? url_path : []
+      @methods = %w(delete get patch post put)
+      @query_params = nil
+      @request_body = nil
+    end
+
+    # Update the headers for the request
+    #
+    # * *Args*    :
+    #   - +request_headers+ -> Hash of request header key/values
+    #
+    def update_headers(request_headers)
+      @request_headers = @request_headers.merge(request_headers)
+    end
+
+    # Build the final request headers
+    #
+    # * *Args*    :
+    #   - +request+ -> HTTP::NET request object
+    # * *Returns* :
+    #   - HTTP::NET request object
+    #
+    def build_request_headers(request)
+      @request_headers.each do |key, value|
+        request[key] = value
+      end
+      request
+    end
+
+    # Add the API version, subclass this function to customize
+    #
+    # * *Args*    :
+    #   - +url+ -> An empty url string
+    # * *Returns* :
+    #   - The url string with the version pre-pended
+    #
+    def add_version(url)
+      url.concat("/#{@version}")
+      url
+    end
+
+    # Add query parameters to the url
+    #
+    # * *Args*    :
+    #   - +url+ -> path to endpoint
+    #   - +query_params+ -> hash of query parameters
+    # * *Returns* :
+    #   - The url string with the query parameters appended
+    #
+    def build_query_params(url, query_params)
+      url.concat('?')
+      count = 0
+      query_params.each do |key, value|
+        url.concat('&') if count > 0
+        url.concat("#{key}=#{value}")
+        count += 1
+      end
+      url
+    end
+
+    # Set the query params, request headers and request body
+    #
+    # * *Args*    :
+    #   - +args+ -> array of args obtained from method_missing
+    #
+    def build_args(args)
+      args.each do |arg|
+        arg.each do |key, value|
+          case key.to_s
+          when 'query_params'
+            @query_params = value
+          when 'request_headers'
+            update_headers(value)
+          when 'request_body'
+            @request_body = value
+          end
+        end
+      end
+    end
+
+    # Build the final url
+    #
+    # * *Args*    :
+    #   - +query_params+ -> A hash of query parameters
+    # * *Returns* :
+    #   - The final url string
+    #
+    def build_url(query_params: nil)
+      url = ''
+      url = add_version(url) if @version
+      @url_path.each do |x|
+        url.concat("/#{x}")
+      end
+      url = build_query_params(url, query_params) if query_params
+      URI.parse("#{@host}#{url}")
+    end
+
+    # Build the API request for HTTP::NET
+    #
+    # * *Args*    :
+    #   - +name+ -> method name, received from method_missing
+    #   - +args+ -> args passed to the method
+    # * *Returns* :
+    #   - A Response object from make_request
+    #
+    def build_request(name, args)
+      build_args(args) if args
+      uri = build_url(query_params: @query_params)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http = add_ssl(http)
+      net_http = Kernel.const_get('Net::HTTP::' + name.to_s.capitalize)
+      request = net_http.new(uri.request_uri)
+      request = build_request_headers(request)
+      request.body = @request_body.to_json if @request_body
+      make_request(http, request)
+    end
+
+    # Make the API call and return the response. This is separated into
+    # it's own function, so we can mock it easily for testing.
+    #
+    # * *Args*    :
+    #   - +http+ -> NET:HTTP request object
+    #   - +request+ -> NET::HTTP request object
+    # * *Returns* :
+    #   - Response object
+    #
+    def make_request(http, request)
+      response = http.request(request)
+      Response.new(response)
+    end
+
+    # Allow for https calls
+    #
+    # * *Args*    :
+    #   - +http+ -> HTTP::NET object
+    # * *Returns* :
+    #   - HTTP::NET object
+    #
+    def add_ssl(http)
+      protocol = host.split(':')[0]
+      if protocol == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http
+    end
+
+    # Add variable values to the url.
+    # (e.g. /your/api/{variable_value}/call)
+    # Another example: if you have a ruby reserved word, such as true,
+    # in your url, you must use this method.
+    #
+    # * *Args*    :
+    #   - +name+ -> Name of the url segment
+    # * *Returns* :
+    #   - Client object
+    #
+    def _(name = nil)
+      url_path = name ? @url_path.push(name) : @url_path
+      @url_path = []
+      Client.new(host: @host, request_headers: @request_headers,
+                 version: @version, url_path: url_path)
+    end
+
+    # Dynamically add segments to the url, then call a method.
+    # (e.g. client.name.name.get())
+    #
+    # * *Args*    :
+    #   - The args are autmoatically passed in
+    # * *Returns* :
+    #   - Client object or Response object
+    #
+    def method_missing(name, *args, &_block)
+      # Capture the version
+      if name.to_s == 'version'
+        @version = args[0]
+        return _
+      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
+  end
+end

data/ruby_http_client.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name        = 'ruby_http_client'
+  spec.version     = '1.0.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.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+end

data/test/test_ruby_http_client.rb

@@ -0,0 +1,117 @@
+require_relative '../lib/ruby_http_client'
+require 'minitest/autorun'
+
+class MockResponse
+  attr_reader :status_code, :response_body, :response_headers
+
+  def initialize(response)
+    @status_code = response['code']
+    @response_body = response['body']
+    @response_headers = response['headers']
+  end
+end
+
+class MockRequest < SendGrid::Client
+  def make_request(_http, _request)
+    response = {}
+    response['code'] = 200
+    response['body'] = { 'message' => 'success' }
+    response['headers'] = { 'headers' => 'test' }
+    MockResponse.new(response)
+  end
+end
+
+class TestClient < Minitest::Test
+  def setup
+    @headers = JSON.parse('
+            {
+                "Authorization": "Bearer XXXXXXX",
+                "Content-Type": "application/json"
+            }
+        ')
+    @host = 'http://localhost:4010'
+    @version = 'v3'
+    @client = MockRequest.new(host: @host,
+                              request_headers: @headers,
+                              version: @version)
+  end
+
+  def test_init
+    assert_equal(@host, @client.host)
+    assert_equal(@headers, @client.request_headers)
+  end
+
+  def test_update_headers
+    request_headers = { 'X-Test' => 'test' }
+    @client.update_headers(request_headers)
+    assert_equal(@headers.merge(request_headers), @client.request_headers)
+  end
+
+  def test_build_request_headers
+    request = {}
+    request = @client.build_request_headers(request)
+    assert_equal(@client.request_headers, request)
+  end
+
+  def test_add_version
+    url = ''
+    @client.add_version(url)
+    assert_equal(url, "/#{@version}")
+  end
+
+  def test_build_query_params
+    url = ''
+    query_params = { 'limit' => 100, 'offset' => 0 }
+    url = @client.build_query_params(url, query_params)
+    assert_equal(url, '?limit=100&offset=0')
+  end
+
+  def test_build_url
+    url1 = @client.my.path.to.the.endpoint
+    params = { 'limit' => 100, 'offset' => 0 }
+    url = URI.parse(@host + '/' + @version +
+                    '/my/path/to/the/endpoint?limit=100&offset=0')
+    assert_equal(url1.build_url(query_params: params), url)
+
+    url1 = url1.one_more
+    params = { 'limit' => 100, 'offset' => 0 }
+    url = URI.parse(@host + '/' + @version +
+                    '/my/path/to/the/endpoint/one_more?limit=100&offset=0')
+    assert_equal(url1.build_url(query_params: params), url)
+
+    url2 = @client.my.path._('to').the.endpoint
+    params = { 'limit' => 100, 'offset' => 0 }
+    url = URI.parse(@host + '/' + @version +
+                    '/my/path/to/the/endpoint?limit=100&offset=0')
+    assert_equal(url2.build_url(query_params: params), url)
+  end
+
+  def test_build_request
+    name = 'get'
+    args = nil
+    response = @client.build_request(name, args)
+    assert_equal(response.status_code, 200)
+    assert_equal(response.response_body, 'message' => 'success')
+    assert_equal(response.response_headers, 'headers' => 'test')
+  end
+
+  def add_ssl
+    uri = URI.parse('https://localhost:4010')
+    http = Net::HTTP.new(uri.host, uri.port)
+    http = @client.add_ssl(http)
+    assert_equal(http.use_ssl, true)
+    assert_equal(http.verify_mode, OpenSSL::SSL::VERIFY_NONE)
+  end
+
+  def test__
+    url1 = @client._('test')
+    assert_equal(url1.url_path, ['test'])
+  end
+
+  def test_method_missing
+    response = @client.get
+    assert_equal(response.status_code, 200)
+    assert_equal(response.response_body, 'message' => 'success')
+    assert_equal(response.response_headers, 'headers' => 'test')
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ruby_http_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elmer Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-18 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Quickly and easily access any REST or REST-like API.
+email: dx@sendgrid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env_sample"
+- ".github/ISSUE_TEMPLATE"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- Rakefile
+- examples/example.rb
+- lib/config.rb
+- lib/ruby_http_client.rb
+- ruby_http_client.gemspec
+- test/test_ruby_http_client.rb
+homepage: http://github.com/sendgrid/ruby-http-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A simple REST client
+test_files:
+- test/test_ruby_http_client.rb