roda-proxy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ae4d0a181837cb04d8af444ad3a7876bc1182c83a943bd615487da7e72c011f
+  data.tar.gz: 1cd548656ada75429ccd2bb0d918a33d1854f008b1247bcd7fe24028cf20e815
+SHA512:
+  metadata.gz: 29cc8cef4d73ce1a109aee475a25da1adfe4d34eb027ba3928d70f84beb6369460adc602666872b1a2ad34cd1b61ad038cd46f34246e2e4b0a68d48fcc2c88a5
+  data.tar.gz: 5009c2e0962d5c2a36b8301bacad8f75d3950855d34a79dd6df636f4f30293ed31d9952f7200ed9ed1bacd3da3bd3bde5466e292a5d57dabba25987e473077e2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Layout/SpaceInsideParens:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Layout/TrailingWhitespace:
+  Enabled: false
+
+Style/Semicolon:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in roda-proxy.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nigel Brookes-Thomas
+
+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,91 @@
+# Roda::Proxy
+
+Roda Proxy is a very simple reverse proxy for Roda. It is designed to proxy APIs, it will not rewrite HTML. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'roda-proxy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install roda-proxy
+
+## Usage
+
+Add the plugin to your Roda app and pass it two parameters (one is required, one is optional).
+
+```ruby
+require 'roda'
+require 'roda/proxy'
+
+class App < Roda
+  plugin :proxy, 
+         to: 'https://my.server.com', 
+         path_prefix: '/my/api/path'
+```
+
+The `to:` parameter is required. It should describe the scheme, host and port of the proxy. It should **not** end with a `/`.
+
+The `path_prefix:` parameter is optional. It defaults to `/`. If you chose to specify it, it **should** start and end with a `/`.
+
+The plugin provides both an unconditional and a conditional proxy directive.
+
+To invoke the proxy in your routes, see this example:
+
+```ruby
+route do |r|
+  # /my
+  r.on 'my' do
+    # /my/api
+    r.on 'api' do
+      # /my/api/path
+      r.is 'path' do
+        # GET /my/api/path
+        r.get do
+          r.proxy
+        end
+      end
+    end
+  end
+end
+```
+
+The proxy will always be invoked. Headers and body are passed through unmodified in both directions with the exception of `Host` which is rewritten to match the target.
+
+Also provided is a conditional proxy:
+
+```ruby
+route do |r|
+  # /my
+  r.on 'my' do
+    # /my/api
+    r.on 'api' do
+      # /my/api/path
+      r.is 'path' do
+        # GET /my/api/path
+        r.get do
+          r.proxy_when(r.env['HTTP_PROXY'] == 'true', probability: 0.5) do
+            'This request has not been proxied'
+          end
+        end
+      end
+    end
+  end
+end
+```
+
+With `proxy_when` the first optional parameter expects a truthy value or a block / lambda that returns a truthy value. This must be equivalent to `true` for the proxying to occur. The optional probability is a float between 0 and 1 indicating the probability that proxying will happen. Both paramters can be used alone or in isolation.
+
+If and only if proxying does not occur will the block be evaluated and return to Roda for rendering.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'roda/proxy'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.ru

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require './addressing'
+
+run App

data/lib/roda/proxy.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'roda/proxy/version'
+
+# :nodoc:
+class Roda
+  # :nodoc:
+  module RodaPlugins
+    # Roda plugin for simple API proxying
+    module Proxy
+    
+      # Respond to the configure method to set the destination when proxying
+      # Expects the following options:
+      # [to] Required. The scheme and host of the proxy. Should not end with a slash.
+      # [path_prefix] Optional. The path to append to the above for proxying.
+      #        The current request path will be prefixed on to this value.
+      #        Should begin and end with a +/+. Defaults to +/+.
+      #        For example, if the path prefix is +/foo/+ and the request received
+      #        by Roda is +GET /postcode/lookup+, The proxied request will be dispatched
+      #        to +GET /home/postcode/lookup+
+      # Example:
+      #   plugin :proxy, to: 'https://foo.bar', path: '/my/api'
+      def self.configure(app, opts = {})
+        app.opts[:proxy_to] = opts.fetch(:to, nil) 
+        app.opts[:proxy_path] = opts.fetch(:path_prefix, '/')
+        
+        raise 'Proxy host not set, use "plugin :proxy, to: http://example.com"' unless app.opts[:proxy_to]
+      end
+
+      # :nodoc:
+      module RequestMethods
+        
+        # Proxies the request, forwarding all headers except +Host+ which is 
+        # rewritten to be the destination host. The response headers, body and
+        # status are returned to the client.
+        def proxy
+          method = Faraday.method(env['REQUEST_METHOD'].downcase.to_sym)
+          f_response = method.call(_proxy_url) { |req| _proxy_request(req) }
+          _respond(f_response)
+        end
+        
+        # Conditionally proxies when +condition+ is true and with selective probability.
+        # For instance, to proxy 50% of the time:
+        #   r.proxy_when(probability: 0.5)
+        # Condition can be a truthy value or a block / lambda, in which case
+        # the result from the +#call+ is expected to be truthy.
+        #   r.proxy_when( r.env['HTTP_PROXY_ME'] == 'true' )
+        # The two parameters can be combined, the probability is evaluated first.
+        #   r.proxy_when( r.env['HTTP_PROXY_ME'] == 'true', probability: 0.8 )
+        # If and only if this method choses not to proxy is the block evaluated.
+        # The block is then expected to return a meaningful response to Roda.
+        def proxy_when(condition = true, probability: 1.0)
+          shall_proxy = Random.rand(0.0..1.0) <= probability
+                    
+          if shall_proxy && ( condition.respond_to?(:call) ? condition.call : condition )
+            yield(self)
+          else
+            proxy
+          end
+        end
+        
+        private
+        
+        
+        def _proxy_url
+          @_proxy_url ||= URI(roda_class.opts[:proxy_to])
+                          .then { |uri| uri.path = roda_class.opts[:proxy_path]; uri }
+                          .then { |uri| uri.query = env['QUERY_STRING']; uri }
+        end
+        
+        def _proxy_headers
+          env
+            .select { |k, _v| k.start_with? 'HTTP_' }
+            .reject { |k, _v| k == 'HTTP_HOST' }
+            .transform_keys do |k| 
+              k.sub(/^HTTP_/, '')
+               .split('_')
+               .map(&:capitalize)
+               .join('-')
+            end.merge({ 'Host' => "#{_proxy_url.host}:#{_proxy_url.port}" })
+        end
+        
+        def _proxy_request(req)
+          req.headers = _proxy_headers
+        end
+        
+        def _respond(proxied_response)
+          response.status = proxied_response.status
+          proxied_response.headers.each { |k, v| response[k] = v }
+          response.write(proxied_response.body)
+        end
+      end
+    end
+    
+    register_plugin :proxy, Proxy
+  end
+end

data/lib/roda/proxy/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Roda
+  module Proxy
+    VERSION = '1.0.0'
+  end
+end

data/roda-proxy.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/roda/proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'roda-proxy'
+  spec.version       = Roda::Proxy::VERSION
+  spec.authors       = ['Nigel Brookes-Thomas']
+  spec.email         = ['nigel@brookes-thomas.co.uk']
+
+  spec.summary       = 'Reverse proxy plugin for Roda'
+  spec.description   = 'A very simple reverse proxy for Roda'
+  spec.homepage      = 'https://github.com/BillyRuffian/roda-proxy'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/BillyRuffian/roda-proxy'
+  spec.metadata['changelog_uri'] = 'https://github.com/BillyRuffian/roda-proxy'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'roda', '~> 3.0'
+  
+  spec.add_development_dependency 'rerun', '~> 0.13'
+  spec.add_development_dependency 'rubocop', '~> 0.80'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: roda-proxy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nigel Brookes-Thomas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rerun
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+description: A very simple reverse proxy for Roda
+email:
+- nigel@brookes-thomas.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.ru
+- lib/.DS_Store
+- lib/roda/.DS_Store
+- lib/roda/proxy.rb
+- lib/roda/proxy/.DS_Store
+- lib/roda/proxy/version.rb
+- roda-proxy.gemspec
+homepage: https://github.com/BillyRuffian/roda-proxy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/BillyRuffian/roda-proxy
+  source_code_uri: https://github.com/BillyRuffian/roda-proxy
+  changelog_uri: https://github.com/BillyRuffian/roda-proxy
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Reverse proxy plugin for Roda
+test_files: []