reverse_proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd7a654ee0db628e1d8cd826eaa284355beb6563
+  data.tar.gz: 6921bff9fe9fcdce24c6151a1a9e910dbd27d12c
+SHA512:
+  metadata.gz: f5bc61ef28f897978545e1a611bd2f172e16926da98394fc199186748f0b9762a8d95689ebf9185ea61a464145dc3a5a356ada9a5caee981ab39a0eed86ae6f4
+  data.tar.gz: 4fc4a47acef6dde4ad4557de8fddd61b39b242078ddba6b82a19b748f12a08f1eee7ad8972f304e9f80c1b0207de28189e1746d1888aec796b019db7e3cac87d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+reverse_proxy

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+# ReverseProxy
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/reverse_proxy`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reverse_proxy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reverse_proxy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/reverse_proxy/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reverse_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

data/bin/setup

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

data/lib/reverse_proxy.rb

@@ -0,0 +1,16 @@
+require "reverse_proxy/version"
+require "reverse_proxy/patch"
+
+require "reverse_proxy/instance"
+require "reverse_proxy/logger"
+
+require "reverse_proxy/bind"
+require "reverse_proxy/config"
+require "reverse_proxy/proxy"
+require "reverse_proxy/server"
+require "reverse_proxy/application"
+
+module ReverseProxy
+  extend ReverseProxy::Instance
+end
+

data/lib/reverse_proxy/application.rb

@@ -0,0 +1,25 @@
+module ReverseProxy
+  class Application
+    include Logger
+    attr_reader :proxy
+    def initialize proxy
+      @proxy = proxy
+    end
+    def socket
+      proxy.server.socket.unix.to_puma
+    end
+    def send_assets?
+      return false unless Object.const_defined?(:Rails)
+      return Rails.application.config.assets.compile == false
+    end
+    def assets
+      "/assets"
+    end
+    def mime_types
+      return unless Object.const_defined? :Mime
+      types = {}
+      Mime::EXTENSION_LOOKUP.each{|ext,type| types[type.to_s] ||= []; types[type.to_s] << ext }
+      types.collect{|name,extensions| [name,extensions.join(" ")]}.to_h
+    end
+  end
+end

data/lib/reverse_proxy/bind.rb

@@ -0,0 +1,46 @@
+module ReverseProxy
+  class Bind
+    class Formatter
+      class << self
+        def add type, format
+          formats[type.to_s] = format
+        end
+        def formats
+          @@formats ||= {}
+        end
+      end
+      attr_reader :data
+      def initialize data
+        @data = data
+      end
+      private
+      def format target
+        self.class.formats[target].call(self)
+      end
+      def method_missing method
+        return @bind.send method if @bind.respond_to? method
+        format("#{method}".scan(/^to_([a-z]+)/)[0][0])
+      end
+    end
+
+    class Unix < Formatter; def scheme; "unix"; end; end
+    class Tcp < Formatter;  def scheme; "tcp"; end; end
+    
+    def initialize bind
+      @bind = "#{bind}".sub(/[a-z0-9]+:\/\//,'')
+    end
+    def add type, format
+      Formatter.add type, format
+    end
+    def tcp
+      @tcp  ||= Tcp.new  @bind
+    end
+    def unix
+      @unix ||= Unix.new @bind
+    end
+    private
+    def method_missing method, *args, &block
+      @bind.send method, *args, &block
+    end
+  end
+end

data/lib/reverse_proxy/config.rb

@@ -0,0 +1,11 @@
+require "reverse_proxy/config/generic"
+require "reverse_proxy/config/nginx"
+
+module ReverseProxy
+  module Config
+    def self.for instance
+      config_klass = self.const_get instance.class.name.split('::').last
+      config_klass.new instance
+    end
+  end
+end

data/lib/reverse_proxy/config/generic.rb

@@ -0,0 +1,29 @@
+module ReverseProxy
+  module Config
+    class Generic
+      include Logger
+      attr_reader :proxy
+      def initialize proxy
+        @proxy = proxy
+        proxy.config = self
+        @written = false
+      end
+      def prepare type
+        return unless block_given?
+        result = yield
+        name   = result.to_s.strip
+        mkdir name if type.to_s =~ /^dir/
+        touch name if type.to_s =~ /^file/
+        result
+      end
+      private
+      def mkdir dir
+        FileUtils.mkdir_p dir
+      end
+      def touch file
+        mkdir File.dirname file
+        FileUtils.touch file
+      end
+    end
+  end
+end

data/lib/reverse_proxy/config/nginx.rb

@@ -0,0 +1,148 @@
+require "pathname"
+require "fileutils"
+require "active_support/core_ext/string/strip"
+require "erb"
+
+module ReverseProxy
+  module Config
+    class Nginx < Generic
+
+      def clean
+        File.unlink(file) rescue nil
+        File.unlink(pid)  rescue nil
+        FileUtils.rmdir(dir) rescue nil
+      end
+      alias_method :delete, :clean
+
+      def write
+        File.write(file, content) and updated! if updated?
+      end
+
+      def updated?
+        Digest::MD5.hexdigest(content) != @hash
+      end
+      def updated!
+        @hash = Digest::MD5.hexdigest(content)
+      end
+
+      def written?
+        File.exists? file
+      end
+
+      def content
+        ERB.new(<<-CONTENT.strip_heredoc).result(binding).gsub(/\n/,'').gsub(/\s{2,}/, ' ')
+          daemon off;
+          worker_processes 2;
+          worker_rlimit_nofile 8192;
+          pid <%= pid.relative_path_from chroot %>;
+          error_log error.log;
+          events {
+            worker_connections 2048;
+          }
+          http {
+            <%= types %>
+            <%= upstream %>
+            default_type  <%= default_type %>;
+            charset_types <%= charset_types %>;
+            keepalive_timeout 5;
+            tcp_nopush on;
+            sendfile on;
+            gzip on;
+            gzip_comp_level    5;
+            gzip_min_length    256;
+            gzip_proxied       any;
+            gzip_vary          on;
+            gzip_types <%= gzip_types %>;
+            server {
+              <%= listeners %>
+              <%= assets %>
+              <%= root %>
+              <%= redirect %>
+            }
+          }
+        CONTENT
+      end
+      def upstream
+        "upstream #{upstream_label} { server #{proxy.server.socket.unix.to_upstream} fail_timeout=0; }"
+      end
+      def default_type
+        "application/octet-stream"
+      end
+      def charset_types
+        %w{
+          text/xml
+          text/plain
+          text/vnd.wap.wml
+          application/x-javascript
+          application/rss+xml
+          text/css
+          application/javascript
+          application/json
+        }.join(" ")
+      end
+      def upstream_label
+        "application_#{proxy.id}"
+      end
+      def gzip_types
+        proxy.application.mime_types.keys.select do |type|type
+          type.match(/((font)|(^text)|(css)|(script)|(bmp$)|(ml$))/)
+        end.reject{|x|x=="text/html"}.join(" ")
+      end
+      def types
+        @types   = proxy.application.mime_types.collect{|type,extensions|"#{type} #{extensions};"}
+        @types ||= ["text/plain txt;"]
+        "types {" + @types.join + "}"
+      end
+      def listeners
+        proxy.binds.collect do |bind|
+          "listen #{bind.tcp.to_nginx};\n"
+        end.join
+      end
+      def root
+        "location / {
+          try_files $uri $uri/index.html $uri.html @#{proxy.id};
+        }"
+      end
+      def redirect
+        <<-REDIRECT.strip_heredoc
+        location @#{proxy.id} {
+          proxy_read_timeout    300;
+          proxy_connect_timeout 300;
+          proxy_redirect        off;
+
+          proxy_set_header  X-Forwarded-Proto https;
+          proxy_set_header  X-Forwarded-Ssl   on;
+          proxy_set_header  Host              $http_host;
+          proxy_set_header  X-Real-IP         $remote_addr;
+
+          proxy_pass http://#{upstream_label};
+        }
+        REDIRECT
+      end
+      def assets
+        return unless proxy.application.send_assets?
+        <<-ASSETS.strip_heredoc
+        location ~ ^#{proxy.application.assets}/  {
+            root #{Rails.root.join("public")};
+            gzip_static on;
+            expires max;
+            add_header Cache-Control public;
+            access_log /dev/null;
+        }
+        ASSETS
+      end
+      def pid
+        chroot.join("nginx.pid")
+      end
+      def file
+        chroot.join("nginx.cfg")
+      end
+      def chroot
+        prepare :dir do
+          Pathname.new "/tmp/#{proxy.id}"
+        end
+      end
+      alias_method :dir, :chroot
+    end
+  end
+end

data/lib/reverse_proxy/instance.rb

@@ -0,0 +1,8 @@
+module ReverseProxy
+  module Instance
+    attr_accessor :instance
+    def reload
+      instance.reload if instance
+    end
+  end
+end

data/lib/reverse_proxy/logger.rb

@@ -0,0 +1,7 @@
+module ReverseProxy
+  module Logger
+    def log *args
+      proxy.log *args
+    end
+  end
+end

data/lib/reverse_proxy/patch.rb

@@ -0,0 +1,11 @@
+require "reverse_proxy/patch/puma"
+
+module ReverseProxy
+  module Patch
+    def self.apply
+      ReverseProxy::Patch::Puma.patch
+    end
+  end
+end
+
+ReverseProxy::Patch.apply

data/lib/reverse_proxy/patch/puma.rb

@@ -0,0 +1,42 @@
+module ReverseProxy
+  module Patch
+    module Puma
+      module DSL
+        def reverse_proxy proxy
+          @proxy_klass ||= ReverseProxy::Proxy.const_get(proxy)
+          @proxy       ||= @proxy_klass.new server: :Puma
+
+          @proxy.hijack do |secondary_bind|
+            bind secondary_bind.unix.to_puma
+          end
+
+          after_worker_boot do
+            @options[:logger].register(:on_booted){@proxy.on_booted}
+          end
+          
+          @proxy.application_config = self
+          %i{
+            after_worker_boot
+            on_restart
+            on_worker_boot
+            on_worker_shutdown
+          }.each do |event|
+            self.send(event){ @proxy.send(event)}
+          end
+        end
+      end
+      def self.patch
+        require "puma/configuration" rescue return
+        require "puma/dsl" rescue return
+        require "puma/cluster" rescue return
+        ::Puma::DSL.send :include, ReverseProxy::Patch::Puma::DSL
+        # FIXME: This is a really ugly hack to receive events while the app is running
+        ::Puma::Cluster::Worker.send :remove_method, :booted?
+        ::Puma::Cluster::Worker.send :define_method, :booted? do
+          ::ReverseProxy.instance.send :"on_#{@stage}" if @stage == :booted
+          @stage == :booted
+        end
+      end
+    end
+  end
+end

data/lib/reverse_proxy/proxy.rb

@@ -0,0 +1,11 @@
+require "reverse_proxy/proxy/generic"
+require "reverse_proxy/proxy/nginx"
+
+module ReverseProxy
+  module Proxy
+    class << self
+      attr_accessor :id
+    end
+    self.id = SecureRandom.hex
+  end
+end

data/lib/reverse_proxy/proxy/generic.rb

@@ -0,0 +1,68 @@
+require "thread"
+require "set"
+
+module ReverseProxy
+  module Proxy
+    class Generic
+      class << self
+        attr_reader :events
+        private
+        def register_event event, *args, &callback
+          @events ||= {}
+          @events[event] ||= {}
+          @events[event][:methods]   ||= []
+          @events[event][:methods]   << args
+          @events[event][:callbacks] ||= []
+          @events[event][:callbacks] << callback
+        end
+        def method_missing method, *args, &block
+          self.send(:register_event, method, *args, &block) if method.to_s =~ /^(on|before|after)_/
+        end       
+      end
+
+      attr_reader :pid, :lock
+      attr_accessor :application, :config, :server, :binds
+
+      def initialize params={}
+        ReverseProxy.instance = self
+        @pid         = Process.pid
+        @lock      ||= Mutex.new
+        @server      = ReverseProxy::Server.const_get(params[:server]).new self
+        @binds     ||= Set.new
+        @application = Application.new self
+        @config    ||= Config.for self
+        prepare
+        on_initialize
+      end
+      def log message
+        puts "[#{pid}] #{message}"
+      end
+      def id
+        ReverseProxy::Proxy.id
+      end
+      def start
+        @start.call
+      end
+      def stop
+        @stop.call
+      end
+      def reload
+        @reload.call
+      end
+      private
+      def server_event event
+        methods   = self.class.events[event][:methods].flatten.compact   rescue []
+        callbacks = self.class.events[event][:callbacks].flatten.compact rescue []
+        methods.each do |method|
+          self.send method
+        end
+        callbacks.map do |callback|
+          callback.call
+        end
+      end
+      def method_missing method, *args, &block
+        self.send(:server_event, method) if method.to_s =~ /^(on|before|after)_/
+      end
+    end
+  end
+end

data/lib/reverse_proxy/proxy/nginx.rb

@@ -0,0 +1,77 @@
+require "uri"
+
+module ReverseProxy
+  module Proxy
+    class Nginx < Generic
+
+      on_booted          :start
+      on_worker_shutdown :stop
+
+      attr_reader   :stage
+      attr_accessor :nginx_executable
+
+      def prepare
+        Bind::Formatter.add :upstream, ->(data) { "#{data.scheme}:#{data.data}"}
+        Bind::Formatter.add :nginx, ->(data) { "#{data.data}"}
+        @stage  = :initialized
+        @nginx_executable = "nginx"
+      end
+
+      def start
+        sleep(Random.rand*0.1)
+        return if config.written?
+        config.write
+        log "Start Nginx, #{start_command}"
+        at_exit{ log "Stop Nginx"; stop }
+        Thread.new { `#{start_command}` }
+      end
+
+      def stop
+        return unless started?
+        `#{stop_command}`
+        config.clean
+      end
+
+      def restart
+        log "Restart NGinx"
+        stop
+        start
+      end
+      def reload
+        return unless config.updated?
+        start  unless started?
+        log "Reload Nginx"
+        config.write
+        `#{reload_command}`
+      end
+
+      def hijack
+        @binds  += server.binds.select{|x| x.match(/^tcp:/)}
+        server.binds = server.binds.reject{|x| x.match(/^tcp:/) }
+        @binds << server.default_bind if @binds.empty?
+        @binds = @binds.map{|b|Bind.new(b)}
+        yield Bind.new(application.socket)
+        log "Nginx listenens at #{@binds.map{|b|b.tcp.to_nginx}.join(", ")}"
+      end
+
+      def listen
+        @binds.collect do |bind|
+          bind.tcp.to_nginx
+        end
+      end
+
+      def basic_command
+        "#{nginx_executable} -p #{config.dir} -c #{config.file.relative_path_from config.dir}"
+      end
+      def reload_command
+        "#{basic_command} -s reload"
+      end
+      def stop_command
+        "#{basic_command} -s quit"
+      end
+      def start_command
+        "#{basic_command}"
+      end
+    end
+  end
+end

data/lib/reverse_proxy/server.rb

@@ -0,0 +1,2 @@
+require "reverse_proxy/server/generic"
+require "reverse_proxy/server/puma"

data/lib/reverse_proxy/server/generic.rb

@@ -0,0 +1,12 @@
+module ReverseProxy
+  module Server
+    class Generic
+      include Logger
+      def name
+        self.class.name.split("::").last
+      end
+      def socket
+      end
+    end
+  end
+end

data/lib/reverse_proxy/server/puma.rb

@@ -0,0 +1,26 @@
+module ReverseProxy
+  module Server
+    class Puma < Generic
+      attr_reader :server, :proxy, :default_bind
+      def initialize proxy
+        Bind::Formatter.add :puma, Proc.new {|data| "#{data.scheme}://#{data.data}"}
+        @server       = ::Puma
+        @proxy        = proxy
+        @default_bind = 'tcp://0.0.0.0:9292'
+      end
+      def config
+        @server.cli_config
+      end
+      def socket
+        @socket ||= Bind.new proxy.config.dir.join('puma.sock').to_s
+      end
+      def binds
+        ([] + config.options[:binds]).compact
+      end
+      def binds= binds
+        config.options[:binds] = binds
+        log "#{name} listens at #{binds.empty? ? "default" : binds.join(", ")}"
+      end
+    end
+  end
+end

data/lib/reverse_proxy/version.rb

@@ -0,0 +1,3 @@
+module ReverseProxy
+  VERSION = "0.1.0"
+end

data/reverse_proxy.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reverse_proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reverse_proxy"
+  spec.version       = ReverseProxy::VERSION
+  spec.authors       = ["Mathias Kaufmann"]
+  spec.email         = ["me@stei.gr"]
+
+  spec.summary       = %q{ReverseProxy starts a reverse proxy in front of a rails application server.}
+  spec.description   = %q{ReverseProxy starts a reverse proxy in front of a rails application server.}
+  spec.homepage      = "https://ruby.stei.gr/reverse_proxy"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: reverse_proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mathias Kaufmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ReverseProxy starts a reverse proxy in front of a rails application server.
+email:
+- me@stei.gr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reverse_proxy.rb
+- lib/reverse_proxy/application.rb
+- lib/reverse_proxy/bind.rb
+- lib/reverse_proxy/config.rb
+- lib/reverse_proxy/config/generic.rb
+- lib/reverse_proxy/config/nginx.rb
+- lib/reverse_proxy/instance.rb
+- lib/reverse_proxy/logger.rb
+- lib/reverse_proxy/patch.rb
+- lib/reverse_proxy/patch/puma.rb
+- lib/reverse_proxy/proxy.rb
+- lib/reverse_proxy/proxy/generic.rb
+- lib/reverse_proxy/proxy/nginx.rb
+- lib/reverse_proxy/server.rb
+- lib/reverse_proxy/server/generic.rb
+- lib/reverse_proxy/server/puma.rb
+- lib/reverse_proxy/version.rb
+- reverse_proxy.gemspec
+homepage: https://ruby.stei.gr/reverse_proxy
+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.4.6
+signing_key: 
+specification_version: 4
+summary: ReverseProxy starts a reverse proxy in front of a rails application server.
+test_files: []