service-proxy 0.2.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: faf306e26c813332a695bf550b707d53f4c489f213e46e2dd4b658904781587e
+  data.tar.gz: dcdde7dbaf1031b60d8cb358678579eba7831c9f25126f3a128f1985a5e83df6
+SHA512:
+  metadata.gz: c58f05067a4aa1dd313ddebf14154c1c508fce79b4d21a270e0cb92893e44dc8f88a302b4113fb87df9b5ca0191eddb00a588563207434ed6606111a460667e1
+  data.tar.gz: '0256529216e31016783b0fa0c4e2645c1044160e59a331dc150d336fd92362b05abe6cd1cfcae4f2cd512eba26af89245708ddcb24a52df4681142d0683f9663'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Donald Piret
+
+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,75 @@
+# Service::Proxy
+
+When running a service-oriented architecture, it is sometimes desirable to allow your backend services to be mapped to URL paths within the application itself.
+
+This allows you for example to be able to share cookies and reduce the need for CORS calls or to expose your services in a way that they are accessible only through a particular front-end application.
+
+This gem allows you to easily set up these backend service proxy's through a simple YAML configuration file.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+
+source "https://rubygems.pkg.github.com/sephora-asia" do
+  gem 'service-proxy'
+end
+
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+Create a file named ``config/service_proxy.yml`` in your rails application directory. It should look something like this -
+
+```yml
+default: &default
+  services:
+    address-api:
+      path: /api/address
+      backend: https://www.my-address-api.com:8888/
+
+    user-api:
+      path: /api/user
+      backend: https://www.my-user-api.com/
+
+    rewards-api:
+      path: /api/rewards
+      backend: http://www.my-rewards-api.com:9999/
+
+    ads-api:
+      path: /api/ads
+      backend: http://www.my-ads-api.com:1101/
+      forward_cookies: false
+
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+```
+
+Each of the `services` block sequence in the `yml` file is given a - `sequence name`, and are expected to contain `path` and `backend` scalar. The request url that the app receives will be matched against each of these `path` and if a match is found, then the request will be forwarded to the corresponding backend. For eg. based on the above config, if our app is responding to https://www.my-app.com, then if a request to https://www.my-app.com/api/rewards?reward_id=1234 is made, it will be matched against the `rewards-api`  block sequence and the same request will get forwarded as http://www.my-rewards-api.com:9999/?reward_id=1234.
+
+Each block sequence can contain the following scalars -
+ - `path` :  The path that needs to be matched in the request url. It is a required field.
+ - `backend` : This is the destination URI that we need to forward the current request to. This needs to have a valid url scheme `[scheme]://[domain]:[port]/`. Supported `scheme` is either `http` or `https`. `port` is optional and the default value of 80 or 443 is used depending up on whether the scheme is `http` or `https`. This is also a required field.
+ - `forward_cookies`:  Can be `true` (default value) or `false`. Cookies will not be forwarded to `backend` if this is set to false.
+ - `read_timeout`: This sets the proxy timeout. By default it times out in 60 seconds.
+ - `verify_ssl`: Can be `true` (default value) or `false`. This tells `Net::HTTP` to not validate certs if set to `false`.
+
+## Contributing
+
+Run `make setup` in order to install your dev environment.
+
+This project uses the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit naming.
+
+Publishing is done automatically when a push to the master branch is detected.
+
+## 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,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Service::Proxy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/service/proxy.rb

@@ -0,0 +1,5 @@
+require 'service/proxy/version'
+require 'service/proxy/config'
+require 'service/proxy/middleware'
+require 'service/proxy/service_config'
+require 'service/proxy/railtie' if defined?(Rails)

data/lib/service/proxy/config.rb

@@ -0,0 +1,23 @@
+module Service
+  module Proxy
+    class Config
+      attr_reader :config
+
+      def initialize(config = {})
+        @config = config || {}
+      end
+
+      def proxied_paths_matcher
+        @proxied_paths_matcher ||= Regexp.union(services.collect(&:path_regexp))
+      end
+
+      def service_matching_path(path)
+        services.detect { |service| service.path_regexp =~ path }
+      end
+
+      def services
+        @services ||= config.fetch(:services, {}).map { |k, v| ServiceConfig.new(k, v)  }
+      end
+    end
+  end
+end

data/lib/service/proxy/middleware.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'rack-proxy'
+
+module Service
+  module Proxy
+    class Middleware < Rack::Proxy
+      def perform_request(env)
+        request = Rack::Request.new(env)
+
+        # use rack proxy for anything hitting our host app at /example_service
+        if config && request.path =~ config.proxied_paths_matcher
+          service = config.service_matching_path(request.path)
+
+          # most backends required host set properly, but rack-proxy doesn't set this for you automatically
+          # even when a backend host is passed in via the options
+          env['SERVER_NAME'] = env['HTTP_HOST'] = [service.backend.host, service.backend.port].compact.join(':')
+          env['SERVER_PORT'] = service.backend.port.to_s
+          env['rack.backend'] = service.backend
+          env['rack.url_scheme'] = service.backend.scheme
+          env['HTTPS'] = service.backend.scheme.downcase == 'https' ? 'on' : 'off'
+
+          # This is the only path that needs to be set currently on Rails 5 & greater
+          env['PATH_INFO'] = service.backend_path_for(request.path)
+
+          # don't send your sites cookies to target service, unless it is a trusted internal service that can parse all your cookies
+          env['HTTP_COOKIE'] = '' unless service.send_cookies?
+
+          # other Rack::Proxy opts
+          env['rack.ssl_verify_none'] = true unless service.verify_ssl?
+          env['http.read_timeout'] = service.read_timeout unless service.read_timeout.nil?
+
+          env['content-length'] = nil
+
+          super(env)
+        else
+          @app.call(env)
+        end
+      end
+
+      def rewrite_response(triplet)
+        status, headers, body = triplet
+        headers['content-length'] = nil
+        triplet
+      end
+
+      private
+
+      def config
+        return @config if instance_variable_defined?(:'@config')
+
+        if File.exist?(Rails.root.join('config/service_proxy.yml'))
+          config_data = Rails.application.config_for(:service_proxy)
+          @config = Config.new(config_data.deep_symbolize_keys) if config_data
+        end
+        @config ||= nil
+      end
+    end
+  end
+end

data/lib/service/proxy/railtie.rb

@@ -0,0 +1,9 @@
+module Service
+  module Proxy
+    class Railtie < ::Rails::Railtie
+      initializer 'service.proxy' do |app|
+        app.middleware.use Service::Proxy::Middleware
+      end
+    end
+  end
+end

data/lib/service/proxy/service_config.rb

@@ -0,0 +1,39 @@
+module Service
+  module Proxy
+    class ServiceConfig
+      def initialize(name, options)
+        @name = name
+        @options = options
+      end
+
+      def backend
+        @backend ||= URI(@options.fetch(:backend, ''))
+      end
+
+      def backend_path_for(original_path)
+        original_path.delete_prefix!(path)
+        [backend.path, original_path].compact.join('/').gsub(/\/+/, '/')
+      end
+
+      def path
+        @path ||= @options.fetch(:path)
+      end
+
+      def path_regexp
+        @path_regexp ||= Regexp.new("^#{Regexp.escape(path)}")
+      end
+
+      def send_cookies?
+        @options.fetch(:forward_cookies, true)
+      end
+
+      def verify_ssl?
+        @options.fetch(:verify_ssl, true)
+      end
+
+      def read_timeout
+        @options.fetch(:read_timeout, nil)
+      end
+    end
+  end
+end

data/lib/service/proxy/version.rb

@@ -0,0 +1,5 @@
+module Service
+  module Proxy
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/service/proxy_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :service_proxy do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: service-proxy
+version: !ruby/object:Gem::Version
+  version: 0.2.12
+platform: ruby
+authors:
+- Sephora Asia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: rack-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: sqlite3
+  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: Easily proxy paths in your rails application to other backend services.
+email:
+- dpiret@sephora.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/service/proxy.rb
+- lib/service/proxy/config.rb
+- lib/service/proxy/middleware.rb
+- lib/service/proxy/railtie.rb
+- lib/service/proxy/service_config.rb
+- lib/service/proxy/version.rb
+- lib/tasks/service/proxy_tasks.rake
+homepage: https://github.com/sephora-asia/service-proxy-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sephora-asia/service-proxy-rails
+  source_code_uri: https://github.com/sephora-asia/service-proxy-rails
+  github_repo: ssh://github.com/sephora-asia/service-proxy-rails
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Easily proxy paths in your rails application to other backend services.
+test_files: []