enviado 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7e1943dbd8d6e37281506f08e806b24aed7982f
+  data.tar.gz: f295bd264502f95a3bf46f84a0e7051831d08075
+SHA512:
+  metadata.gz: cfa7045eff817ac48a1cb45a38ebaf200d046e1c69a8ebf79732cb2f126d50fddb26b55c327a7102a16389c924b04ee1f734adf0ea4871d96872bd6eecede4c1
+  data.tar.gz: 79c1b78238ef5ba68eb0b530e78f00c2a9d2bb00c19d49ffb5f0839128ad324a343e3ce44b4581b72ed50a7e22f25c729d6673af55f6b66610584ce2015b6326

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## 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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.2
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enviado.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,65 @@
+# Enviado
+
+Enviado is a ruby wrapper for the [envoy](https://github.com/lyft/envoy) proxy, making it easy to use enviado with your services or gems in a transparent way.
+
+Because enviado embeds a binary version of `envoy`, it needs a specific binary for each operating system. Right now it only supports `x86_64-linux-gnu` but PRs are welcome to add more binaries!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enviado'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install enviado
+```
+
+## Usage
+
+To start envoy with a given [configuration file](https://lyft.github.io/envoy/docs/configuration/configuration.html):
+
+```ruby
+require 'enviado'
+
+Enviado.start(config_path: 'path/to/envoy/config/file.json')
+```
+
+Now you can perform requests to envoy.
+
+To see an example of an envoy configuration that deals with a flaky service, see <examples/flaky_requests/flaky_requests.rb>.
+
+Running in docker:
+
+```bash
+$ cd examples/flaky_requests.rb
+$ docker-compose build example && docker-compose run example
+Starting web server...
+Doing 100 requests WITHOUT enviado...
+Results: {500=>44, 200=>56}
+Starting enviado
+[2016-11-19 13:14:58.039][211][warning][main] initializing epoch 0 (hot restart version=3.2490504)
+[2016-11-19 13:14:58.041][211][warning][main] all clusters initialized. starting workers
+[2016-11-19 13:14:58.041][211][warning][main] starting main dispatch loop
+Doing 100 requests WITH enviado...
+Results: {200=>100}
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/ivoanjo/enviado>.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'enviado'
+
+require 'pry'
+Pry.start

data/enviado.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'enviado/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'enviado'
+  spec.version       = Enviado::VERSION
+  spec.authors       = ['Ivo Anjo']
+  spec.email         = ['ivo.anjo@ist.utl.pt']
+
+  spec.summary       = %q{A ruby wrapper for the envoy proxy}
+  spec.homepage      = 'https://github.com/ivoanjo/enviado'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'pry'
+end

data/examples/flaky_requests/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.3.2
+MAINTAINER Ivo Anjo <ivo.anjo@ist.utl.pt>
+
+ENV APP_HOME=/example BUNDLE_JOBS=10 BUNDLE_PATH=/bundle
+
+RUN gem install bundler
+
+RUN mkdir $APP_HOME
+WORKDIR $APP_HOME
+
+ADD Gemfile* $APP_HOME/
+RUN bundle install
+
+ADD . $APP_HOME

data/examples/flaky_requests/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'enviado', git: 'https://github.com/ivoanjo/enviado.git'
+gem 'rack'
+gem 'faraday'
+gem 'pry'

data/examples/flaky_requests/docker-compose.yml

@@ -0,0 +1,6 @@
+example: &BASE
+  build: .
+  command: 'bundle exec ruby flaky_requests.rb'
+  dns:
+    - 8.8.8.8
+    - 8.8.4.4

data/examples/flaky_requests/envoy_service_to_service_simple.json

@@ -0,0 +1,102 @@
+{
+  "listeners": [
+    {
+      "port": 9211,
+      "filters": [
+        {
+          "type": "read",
+          "name": "http_connection_manager",
+          "config": {
+            "codec_type": "auto",
+            "http_codec_options": "no_compression",
+            "tracing": {
+              "operation_name": "ingress"
+            },
+            "idle_timeout_s": 840,
+            "access_log": [
+              {
+                "path": "ingress_http.log",
+                "filter": {
+                  "type": "not_healthcheck"
+                },
+                "format": "[%START_TIME%] \"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%\" %RESPONSE_CODE% %FAILURE_REASON% %BYTES_RECEIVED% %BYTES_SENT% %DURATION% %RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)% \"%REQ(X-FORWARDED-FOR)%\" \"%REQ(USER-AGENT)%\" \"%REQ(X-REQUEST-ID)%\" \"%REQ(:AUTHORITY)%\"\n"
+              }
+            ],
+            "stat_prefix": "ingress_http",
+            "route_config": {
+              "virtual_hosts": [
+                {
+                  "name": "local_service",
+                  "domains": [
+                    "*"
+                  ],
+                  "routes": [
+                    {
+                      "timeout_ms": 0,
+                      "prefix": "/",
+                      "cluster": "local_service",
+                      "retry_policy": {
+                        "retry_on": "connect-failure,5xx",
+                        "num_retries": 20
+                      }
+                    }
+                  ]
+                }
+              ]
+            },
+            "filters": [
+              {
+                "type": "both",
+                "name": "health_check",
+                "config": {
+                  "pass_through_mode": true,
+                  "cache_time_ms": 2500,
+                  "endpoint": "/healthcheck"
+                }
+              },
+              {
+                "type": "decoder",
+                "name": "buffer",
+                "config": {
+                  "max_request_bytes": 5242880,
+                  "max_request_time_s": 120
+                }
+              },
+              {
+                "type": "decoder",
+                "name": "router",
+                "config": {}
+              }
+            ]
+          }
+        }
+      ]
+    }
+  ],
+  "admin": {
+    "access_log_path": "admin_access.log",
+    "port": 9901
+  },
+  "flags_path": "./flags",
+  "cluster_manager": {
+    "clusters": [
+      {
+        "name": "local_service",
+        "connect_timeout_ms": 250,
+        "type": "static",
+        "lb_type": "round_robin",
+        "circuit_breakers": {
+          "default": {
+            "max_pending_requests": 30,
+            "max_connections": 100
+          }
+        },
+        "hosts": [
+          {
+            "url": "tcp://127.0.0.1:8080"
+          }
+        ]
+      }
+    ]
+  }
+}

data/examples/flaky_requests/flaky_requests.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+require 'pry'
+require 'rack'
+require 'enviado'
+
+REQUESTS=100
+PORT=8080
+
+def start_web_server
+  Thread.new do
+    Rack::Handler::WEBrick.run(
+      proc { |env|
+        if rand <= 0.5
+          [200, {"Content-Type" => "text/html"}, ["Hello, World!\n"]]
+        else
+          [500, {"Content-Type" => "text/html"}, ["I am a small potato\n"]]
+        end
+      },
+      Host: '127.0.0.1',
+      Port: PORT,
+      Logger: WEBrick::Log.new('/dev/null'),
+      AccessLog: [],
+    )
+  end
+
+  sleep 1
+end
+
+def perform_requests(url)
+  connection = Faraday.new(url: url)
+
+  codes = Hash.new { |h, k| h[k] = 0 }
+
+  REQUESTS.times do
+    response = connection.get
+    codes[response.status] += 1
+  end
+
+  codes
+end
+
+def main
+  puts "Starting web server..."
+  start_web_server
+
+  puts "Doing #{REQUESTS} requests WITHOUT enviado..."
+  puts "Results: #{perform_requests('http://localhost:8080')}"
+
+  puts "Starting enviado"
+  Enviado.start(config_path: 'envoy_service_to_service_simple.json')
+
+  puts "Doing #{REQUESTS} requests WITH enviado..."
+  puts "Results: #{perform_requests('http://localhost:9211')}"
+end
+
+main

data/lib/enviado.rb

@@ -0,0 +1,13 @@
+require 'enviado/version'
+
+module Enviado
+  ENVOY_PATH = File.expand_path("../ext/#{RUBY_PLATFORM}/envoy", __FILE__)
+
+  class << self
+    def start(config_path:)
+      pid = spawn("#{ENVOY_PATH} -c #{config_path}")
+      sleep 5 # for good measure! ;)
+      pid
+    end
+  end
+end

data/lib/enviado/version.rb

@@ -0,0 +1,3 @@
+module Enviado
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: enviado
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ivo Anjo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- ivo.anjo@ist.utl.pt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- enviado.gemspec
+- examples/flaky_requests/Dockerfile
+- examples/flaky_requests/Gemfile
+- examples/flaky_requests/Gemfile.lock
+- examples/flaky_requests/docker-compose.yml
+- examples/flaky_requests/envoy_service_to_service_simple.json
+- examples/flaky_requests/flaky_requests.rb
+- lib/enviado.rb
+- lib/enviado/version.rb
+- lib/ext/x86_64-linux/envoy
+homepage: https://github.com/ivoanjo/enviado
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for the envoy proxy
+test_files: []