ez-nginx-proxy 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Caleb Spare
+
+MIT License
+
+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,55 @@
+# ez-nginx-proxy
+
+ez-nginx-proxy is a small wrapper around nginx. It requires nginx to already be installed. It is useful for
+development, when you want to very easily start a proxy that will send requests to various other
+development/production servers based on matching the routes.
+
+ez-nginx-proxy takes a very simple Ruby configuration file. Here is an example configuration:
+
+``` ruby
+[
+  ["/foo/bar", "localhost:1234"],
+  ["/", "amazon.com"]
+]
+```
+
+If you run this configuration like this:
+
+    $ ez-nginx-proxy -p 9000 my_config.rb
+
+ez-nginx-proxy will create a temporary nginx configuration file that redirects `localhost:9000/foo/bar` to
+`localhost:1234/foo/bar` and `localhost:9000/blah` to `amazon.com/blah`.
+
+## Usage
+
+    $ ez-nginx-proxy your_config.rb
+
+See `ez-nginx-proxy -h` for all the options.
+
+## Installation
+
+Install nginx. You can do this using your favorite package manager:
+
+    $ sudo apt-get install nginx
+    $ brew install nginx
+    # or whatever
+
+Now install ez-nginx-proxy
+
+    $ gem install ez-nginx-proxy
+
+## NOTE:
+
+You will probably see this error when ez-nginx-proxy starts:
+
+    nginx: [alert] could not open error log file: open() "/var/log/nginx/error.log" failed (13: Permission denied)
+
+This is because nginx initially tries to log to `/var/log/nginx/error.log` before it starts up. See [this
+nginx config page](http://wiki.nginx.org/CoreModule#error_log) for more information.
+
+
+## TODO
+
+* nginx regex matching
+* pattern replacement?
+* Hide the annoying 'permission denied' error

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/ez-nginx-proxy

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby
+
+# For developing the gem
+#$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+
+require "erb"
+require "securerandom"
+require "fileutils"
+
+require "trollop"
+require "dedent"
+require "colorize"
+
+require "ez-nginx-proxy/version"
+
+options = Trollop.options do
+  version EzNginxProxy::VERSION
+  banner <<-EOS.dedent
+    ez-nginx-proxy is a very simple reverse http proxy that can route requests based on pattern-matching the
+    URI. The configuration file is Ruby, and it must have the following form:
+
+      [
+        ["/foo/bar", "localhost:1234"], # Route requests to /foo/bar to a local server
+        ["/", "amazon.com"]           # / matches every request
+      ]
+
+    Usage:
+
+      $ ez-nginx-proxy [options] CONFIG_FILE
+
+    where [options] are:
+  EOS
+  opt :address, "Bind address", :default => "0.0.0.0"
+  opt :port, "Port", :default => 9876
+  opt :nginx_location, "Location of nginx", :default => `which nginx`
+  opt :version, "Show ez-nginx-proxy version"
+end
+
+Trollop.die "You must provide a configuration file" unless ARGV[0]
+Trollop.die "Invalid config file: #{ARGV[0]}" unless File.file? ARGV[0]
+begin
+  routes = eval(File.read(ARGV[0]))
+rescue
+  Trollop.die "Error reading or parsing the config file #{ARGV[0]}"
+end
+
+# Locate nginx
+nginx = nil
+([options[:nginx_location]] + %w(/usr/sbin/nginx /usr/local/sbin/nginx)).each do |guess_location|
+  if File.file? guess_location
+    nginx = guess_location
+    break
+  end
+end
+unless nginx
+  abort <<-EOS.dedent
+    Unable to locate nginx. Please install it using
+
+      $ sudo apt-get install nginx # Ubuntu
+
+    or
+
+      $ brew install nginx # Mac OS / homebrew
+
+    or similar. If nginx is installed to a nonstandard location, please pass that in with the --nginx-location
+    option.
+  EOS
+end
+
+# Locate the nginx configuration root
+config_output = `#{nginx} -V 2>&1`
+puts "\033[01;34m>>>> config_output: #{config_output.inspect}\e[m"
+match = config_output.match(/--prefix=([\S]+)/)
+unless match && match.size == 2
+  abort "Unable to determine the nginx prefix root from the output of `#{nginx} -V`."
+end
+prefix = match[1]
+
+routes.each do |pattern, target|
+  puts "Proxying `#{pattern}` to #{target}".green
+end
+
+template = ERB.new <<-EOS.dedent
+  # Template for nginx config
+  # Run in the foreground with no supervisor
+
+  daemon off;
+  master_process off;
+  worker_processes 1;
+  error_log stderr warn;
+  pid <%= pid_file %>
+  ;
+
+  events {
+    worker_connections 768;
+  }
+
+  http {
+    # Basic Settings copied from the default ubuntu nginx.conf
+    sendfile on;
+    tcp_nopush on;
+    tcp_nodelay on;
+    keepalive_timeout 65;
+    types_hash_max_size 2048;
+
+    include <%= prefix %>/mime.types;
+
+    default_type application/octet-stream;
+
+    # Write access logs. Obviously, this is slow.
+    access_log /dev/stdout;
+
+    gzip on;
+
+    proxy_temp_path <%= prefix_dir %>;
+    server {
+      listen <%= options[:port] %>;
+      server_name localhost;
+
+      <% routes.each do |pattern, target| %>
+        location <%= pattern %> {
+          proxy_pass <%= target %>;
+        }
+      <% end %>
+    }
+  }
+EOS
+
+prefix_dir = "/tmp/ez-nginx-#{SecureRandom.hex}/"
+FileUtils.mkdir(prefix_dir)
+pid_file = File.join(prefix_dir, "ez-nginx.pid")
+config_file = File.join(prefix_dir, "ez-nginx.conf")
+
+config_file_contents = template.result(binding)
+File.open(config_file, "w") { |f| f.write(config_file_contents) }
+
+pid = Process.spawn("#{nginx} -p #{prefix_dir} -c ez-nginx.conf")
+trap("SIGINT") { FileUtils.rm_rf(prefix_dir) }
+Process.wait(pid)
+# Clean up
+FileUtils.rm_rf(prefix_dir)

data/example_config.rb

@@ -0,0 +1,4 @@
+[
+  ["/foo/bar", "http://localhost:1234"],
+  ["/", "http://localhost:5678"]
+]

data/ez-nginx-proxy.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ez-nginx-proxy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Caleb Spare"]
+  gem.email         = ["cespare@gmail.com"]
+  gem.description   = %q{A very simple-to-use nginx wrapper for reverse proxying}
+  gem.summary       = %q{A very simple-to-use nginx wrapper for reverse proxying}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.name          = "ez-nginx-proxy"
+  gem.require_paths = ["lib"]
+  gem.version       = EzNginxProxy::VERSION
+
+  gem.add_dependency "trollop"
+  gem.add_dependency "colorize"
+  gem.add_dependency "dedent"
+end

data/lib/ez-nginx-proxy/version.rb

@@ -0,0 +1,3 @@
+module EzNginxProxy
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: ez-nginx-proxy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Caleb Spare
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: &24225920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *24225920
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: &24273800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *24273800
+- !ruby/object:Gem::Dependency
+  name: dedent
+  requirement: &24273380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *24273380
+description: A very simple-to-use nginx wrapper for reverse proxying
+email:
+- cespare@gmail.com
+executables:
+- ez-nginx-proxy
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ez-nginx-proxy
+- example_config.rb
+- ez-nginx-proxy.gemspec
+- lib/ez-nginx-proxy/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A very simple-to-use nginx wrapper for reverse proxying
+test_files: []
+has_rdoc: