redirus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23204aa2cdc879f6d5155a2568ff4d527509a74d
+  data.tar.gz: cc69405a2880bbf10a5fa310c25a69be55649290
+SHA512:
+  metadata.gz: 1acda32916df2f9b7c8e701e0e1814b9d9da535808ec117f43b187653b9970fe71dbdd6b9b09efdb9a3ffca95fb1451ecea21b1af02e471c1db3eebf6359ccb9
+  data.tar.gz: 5bde7b49d4a977fac684a83565d2b8ae209f0fa443e2941abf403c23f5098ad921abbdd837746d1b0c6fc5b934269e3850bff7df91b006fcbb2ce8aae42ae888

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=progress

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/.travis.yml

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

data/CHANGELOG

@@ -0,0 +1,5 @@
+v 0.1.0
+  - Add/Remove nginx redirection
+  - redirus executable
+  - redirus-client executable
+  - Possibility to add redirection properties

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    redirus (0.1.0)
+      sidekiq
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    colorize (0.5.8)
+    connection_pool (2.0.0)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.3.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (3.0.3)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    i18n (0.6.9)
+    json (1.8.1)
+    listen (2.4.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    redis (3.1.0)
+    redis-namespace (1.5.1)
+      redis (~> 3.0, >= 3.0.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rspec-sidekiq (0.5.1)
+      rspec (~> 2.0)
+      sidekiq (>= 2.4.0)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    sidekiq (3.2.2)
+      celluloid (>= 0.15.2)
+      connection_pool (>= 2.0.0)
+      json
+      redis (>= 3.0.6)
+      redis-namespace (>= 1.3.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.7)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    timers (1.1.0)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  coveralls
+  guard-rspec
+  rake
+  redirus!
+  rspec-sidekiq
+  shoulda-matchers

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})       { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')    { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marek Kasztelnik
+
+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,317 @@
+# Redirus [![build status](https://secure.travis-ci.org/dice-cyfronet/redirus.png)](https://travis-ci.org/dice-cyfronet/redirus) [![Code Climate](https://codeclimate.com/github/dice-cyfronet/redirus.png)](https://codeclimate.com/github/dice-cyfronet/redirus) [![Dependency Status](https://gemnasium.com/dice-cyfronet/redirus.png)](https://gemnasium.com/dice-cyfronet/redirus) [![Coverage Status](https://coveralls.io/repos/dice-cyfronet/redirus/badge.png?branch=master)](https://coveralls.io/r/dice-cyfronet/redirus)
+
+The redirus is responsible for creating/deleting subdomain redirections.
+It is done by generating the appropriate nginx configurations and
+reloading nginx server.
+
+## Requirements
+
+**This project is designed for Linux operating systems.**
+
+- Linux (tested on Ubuntu)
+- Nginx
+- Ruby 2.0+
+- Redis (can be installed on separate server)
+
+## Packages / Dependencies
+
+Install the required packages (needed to compile Ruby and nginx):
+
+```
+sudo apt-get update
+
+apt-get install autoconf bison build-essential libssl-dev libyaml-dev libreadline6 libreadline6-dev zlib1g zlib1g-dev g++ make libpcre3 libpcre3-dev libssl-dev
+```
+
+## Ruby
+
+You can use ruby installed by ruby version managers such as [RVM](http://rvm.io/)
+or [rbenv](https://github.com/sstephenson/rbenv), or install it globally from
+sources. The following manual presents global installation.
+
+Remove the old Ruby 1.8 if present
+
+```
+sudo apt-get remove ruby1.8
+```
+
+Download Ruby and compile it:
+
+```
+mkdir /tmp/ruby && cd /tmp/ruby
+curl --progress ftp://ftp.ruby-lang.org/pub/ruby/2.1/ruby-2.1.2.tar.gz | tar xz
+cd ruby-2.1.2
+./configure --disable-install-rdoc
+make
+sudo make install
+```
+
+## Nginx installation
+
+Download and compile nginx:
+
+```
+mkdir -p /tmp/nginx && cd /tmp/nginx
+curl http://nginx.org/download/nginx-1.7.4.tar.gz | tar xz
+cd nginx-1.7.4
+./configure --with-http_ssl_module --prefix=/nginx/installation/path
+make
+make install
+```
+
+Update nginx configuration:
+
+```
+edit /nginx/installation/path/conf/nginx.conf
+```
+
+the simplest configuration may look as follows:
+
+```
+worker_processes  1;
+
+pid /nginx/installation/path/nginx.pid;
+
+events {
+    worker_connections  1024;
+}
+
+
+http {
+    include       mime.types;
+    default_type  application/octet-stream;
+
+    sendfile        on;
+
+    keepalive_timeout  65;
+
+    types_hash_max_size 2048;
+    server_names_hash_bucket_size  128;
+
+    include /path/to/generated/nginx/configurations/*;
+}
+```
+Two elements from presented configuration need to be customized:
++ `/nginx/installation/path/nginx.pid` file where nginx pid will be written.
++ `/path/to/generated/nginx/configurations/*` path to the place where redirus
+worker will be generating configurations specific to registered redirections. `*`
+is necessary at the end in order to load all configurations from this directory.
+
+If  nginx is to bind to a low-numbered port, e.g. port 80,
+the following command needs to be executed as root:
+
+```
+# package required to invoke setcap
+apt-get install libcap2-bin
+
+# allow nginx to bind into low-numbered port
+setcap 'cap_net_bind_service=+ep' /path/to/nginx/sbin/nginx
+```
+
+## Self signed certificate
+
+In production environment valid certificate (with `*` in CN section) signed by trusted organization should be used. If you don't have such certificate than
+you can generate self signed certificate:
+
+```
+mkdir /usr/share/ssl/certs/my-domain.pl
+cd /usr/share/ssl/certs/my-domain.pl
+(umask 077 && touch host.key host.cert host.info host.pem)
+openssl genrsa 2048 > host.key
+openssl req -new -x509 -nodes -sha1 -days 3650 -key host.key > host.cert
+...[enter *.my-domain.pl for the Common Name]...
+openssl x509 -noout -fingerprint -text < host.cert > host.info
+cat host.cert host.key > host.pem
+chmod 400 host.key host.pem
+```
+
+## Redirus worker installation
+
+```bash
+# install redirus
+gem install redirus
+
+# Download sample redirus configuration
+curl -L --progress https://raw.githubusercontent.com/dice-cyfronet/redirus/master/config.yml.example > config.yml
+
+# Customise redis configuration and nginx config files locations
+edit config.yml
+```
+
+## Example config.yml
+
+```yaml
+queues:
+  - site_prefix
+  - second_site_prefix
+
+redis_url: redis://localhost:6379
+namespace: redirus
+
+nginx:
+  configs_path: /path/to/generated/nginx/configurations/
+  pid: /nginx/installation/path/nginx.pid
+  http_template: |
+    listen *:80;
+  https_template: |
+    listen *:443 ssl;
+    ssl_certificate     /path/to/cert/dir/server.crt;
+    ssl_certificate_key /path/to/cert/dir/server.key;
+  config_template: |
+    #{upstream}
+    server {
+      #{listen}
+      server_name #{name}.my-domain.pl;
+      server_tokens off;
+      proxy_set_header X-Server-Address $scheme://#{name}.my-domain.pl;
+      proxy_set_header Host $http_host;
+      location / {
+        proxy_pass http://#{upstream_name};
+        #{properties}
+      }
+    }
+  allowed_properties:
+    - proxy_sent_timeout \d
+    - proxy_read_timeout \d
+```
+
+Some elements from presented configuration need to be customized:
++ `/path/to/generated/nginx/configurations/` is the location where configuration
+specific for concrete redirection will be created. Value of this path **need** to
+be the same as in nginx configuration file.
++ `/nginx/installation/path/nginx.pid` is a file containing nginx pid. To this pid
+`SIGHUP` signal will be sent, which will triggers nginx configuration reload.
++ `/path/to/cert/dir/server.crt` path to ssl certificate used in https redirections.
+This certificate need to have `*` in CN field.
++ `/path/to/cert/dir/server.key` path to ssl certificate key file.
+
+By using `http_template`, `https_template`, `config_template` and
+`allowed_properties` you can customize how nginx configuration looks like for each
+subdomain.
+
++ `http_template` is used when an http redirection is created
++ `https_template` is used when an https redirection is created
++ `config_template` is used for http and https redirections.
+Inside this template, the `listen` variable section is specific to http or https
+redirections.
++ `allowed_properties` is used to define allowed parameters which can be
+passed in the generated configuration. Regular expressions can be used here.
+
+For example - when a redirection with the following parameters is requested:
+
+```ruby
+Sidekiq::Client.push(
+  'queue' => 'cyfronet',
+  'class' => Redirus::Worker::AddProxy,
+  'args' => ['subdomain', ['127.0.0.1:80'], :http, ["proxy_send_timeout 6000"]])
+```
+
+...then the following `/nginx/sites-enabled/subdomain_http` subdomain config file
+will be created:
+
+```
+upstream subdomain_http {
+  server 127.0.0.1:80;
+}
+server {
+  listen *:8000;
+  server_name subdomain.localhost;
+  server_tokens off;
+  location / {
+    proxy_pass http://subdomain_http;
+    proxy_send_timeout 6000;
+  }
+}
+```
+
+## Run redirus
+
+```bash
+redirus -c redirus_configuration_path
+```
+
+When no configuration path is given than redirus tries to load configuration from `config.yml` located in current dir.
+
+See `redirus -h` for details.
+
+## Run redirus client
+
+```
+redirus-client -c config.yml -a add -t http my_redirection 10.100.0.1:80,10.100.0.2:80
+redirus-client -c config.yml -a rm -t http my_redirection
+```
+
+See `redirus-client -h` for details.
+
+## Starting using upstart
+
+**NOTE**: presented configuration was tested on Ubuntu 14.04
+
+Copy upstart configuration files:
+
+```
+cd redirus-worker-directory
+mkdir -p ${HOME}/.config/upstart
+cd ${HOME}/.config/upstart
+
+curl -L --progress https://raw.githubusercontent.com/dice-cyfronet/redirus/master/support/upstart/redirus.conf > redirus.conf
+curl -L --progress https://raw.githubusercontent.com/dice-cyfronet/redirus/master/support/upstart/redirus-sidekiq.conf > redirus-sidekiq.conf
+curl -L --progress https://raw.githubusercontent.com/dice-cyfronet/redirus/master/support/upstart/redirus-nginx.conf > redirus-nginx.conf
+
+# Specify user name, path under which the redirus worker is installed and
+# the location of the nginx configuration directory to be created:
+editor ${HOME}/.config/upstart/redirus.conf
+
+# Similar as above, plus if you are using ruby version manager - uncomment and
+# customize the appropriate section for rbenv or rvm
+editor ${HOME}/.config/upstart/redirus-sidekiq-1.conf
+
+# Update path to nginx
+editor ${HOME}/.config/upstart/redirus-nginx.conf
+```
+Now you should be able to start/stop/restart redirus using the
+following commands:
+
+```
+initctl start redirus
+initctl stop redirus
+initctl restart redirus
+```
+
+## Generating Add/Remove redirection requests from ruby code
+
+```ruby
+require 'rubygems'
+require 'redirus/worker'
+require 'redirus/worker/add_proxy'
+require 'redirus/worker/rm_proxy'
+
+# configure sidekiq client
+Sidekiq.configure_client do |c|
+  c.redis = {
+    namespace: Redirus::Worker.config.namespace,
+    url: Redirus::Worker.config.redis_url,
+    queue: Redirus::Worker.config.queues.first
+  }
+end
+
+# add new redirection
+Sidekiq::Client.push(
+  'queue' => Redirus::Worker.config.queues.first,
+  'class' => Redirus::Worker::AddProxy,
+  'args' => ['subdomain', ['127.0.0.1'], :http, ["proxy_send_timeout 6000"]])
+
+# remove redirection
+Sidekiq::Client.push(
+  'queue' => Redirus::Worker.config.queues.first,
+  'class' => Redirus::Worker::RmProxy,
+  'args' => ['subdomain', :http])
+```
+
+## Contributing
+
+1. Fork the project
+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 new pull request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('rspec')
+
+task :default => :rspec

data/bin/redirus

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'redirus'
+
+cli = Redirus::ServerCLI.instance
+cli.parse
+cli.run

data/bin/redirus-client

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'redirus'
+
+cli = Redirus::CLI.instance
+cli.parse
+cli.run

data/config.yml.example

@@ -0,0 +1,32 @@
+queues:
+  - site_prefix
+  - second_site_prefix
+
+redis_url: redis://localhost:6379
+namespace: redirus
+
+nginx:
+  configs_path: /path/to/dir/with/nginx/configs/
+  pid: /path/to/nginx.pid
+  http_template: |
+    listen *:80;
+  https_template: |
+    listen *:443 ssl;
+    ssl_certificate     /path/to/cert/dir/server.crt;
+    ssl_certificate_key /path/to/cert/dir/server.key;
+  config_template: |
+    #{upstream}
+    server {
+      #{listen}
+      server_name #{name}.my-domain.pl;
+      server_tokens off;
+      proxy_set_header X-Server-Address $scheme://#{name}.my-domain.pl;
+      proxy_set_header Host $http_host;
+      location / {
+        proxy_pass http://#{upstream_name};
+        #{properties}
+      }
+    }
+  allowed_properties:
+    - proxy_sent_timeout \d
+    - proxy_read_timeout \d

data/lib/redirus/cli.rb

@@ -0,0 +1,136 @@
+require 'optparse'
+require 'singleton'
+
+module Redirus
+  class CLI
+    include Singleton
+
+    attr_reader :options
+
+    def parse(args = ARGV)
+      init_options(args)
+      validate!
+    end
+
+    def run
+      add? ? add : rm
+    end
+
+    private
+
+    def init_options(args)
+      opts = parse_options(args)
+      opts[:config_path] ||= 'config.yml'
+
+      Redirus.config_path = opts[:config_path]
+
+      @options = defaults.merge(opts)
+    end
+
+    def parse_options(args)
+      opts = {}
+
+      parser = OptionParser.new do |o|
+        o.on('-c', '--configuration PATH', 'Configuration path') do |arg|
+          opts[:config_path] = arg
+        end
+
+        o.on('-a',
+                '--action TYPE', [:add, :rm],
+                'Action type (add, rm)') do |arg|
+          opts[:action] = arg
+        end
+
+        o.on('-q', '--queue NAME', 'Queue name') do |arg|
+          opts[:queue] = arg
+        end
+
+        o.on(
+             '-t',
+             '--type TYPE',
+             [:http, :https],
+             'Rediraction type') do |arg|
+          opts[:type] = arg
+        end
+
+        o.on_tail("-h", "--help", "Show this message") do
+          puts o
+          exit
+        end
+
+        o.on_tail('-v', '--version', 'Show version') do
+          puts "Redirus #{Redirus.VERSION}"
+          exit
+        end
+      end
+
+      parser.banner = 'redirus-client [options] name [upstream1,upstream2,...]'
+      parser.parse!(args)
+
+      opts[:name] = args.shift
+
+      upstreams_str = args.shift
+      opts[:upstreams] = upstreams_str.split(',') if upstreams_str
+
+      opts
+    end
+
+    def defaults
+      {
+        config_path: 'config.yml',
+        type: :http,
+        queue: Redirus.config.queues.first
+      }
+    end
+
+    def validate!
+      unless File.exist?(options[:config_path])
+        puts "ERROR: Configuration file #{options[:config_path]} does not exist"
+        exit(1)
+      end
+
+      unless options[:name]
+        puts "ERROR: Redirection name is not set"
+        exit(1)
+      end
+
+      if add?
+        unless options[:upstreams]
+          puts "ERROR: Upstream locations are not set"
+          exit(1)
+        else
+          options[:upstreams].each do |u|
+            unless u.match(/\A\d{1,3}\.\d{1,3}\.\d{1,3}.\d{1,3}:\d+\z/)
+              puts "ERROR: #{u} is not valid upstream definition, use IP:PORT schema"
+              exit(1)
+            end
+          end
+        end
+      end
+
+      Redirus.config_path = options[:config_path]
+    end
+
+    def add?
+      options[:action] == :add
+    end
+
+    def add
+      puts "Adding new redirection #{options[:name]} with following upstreams #{options[:upstreams]}"
+
+      Sidekiq::Client.push(
+        'queue' => options[:queue],
+        'class' => Redirus::Worker::AddProxy,
+        'args' => [options[:name], options[:upstreams], options[:type]])
+    end
+
+    def rm
+      puts "Removing redirection #{options[:name]}"
+
+      Sidekiq::Client.push(
+        'queue' => options[:queue],
+        'class' => Redirus::Worker::RmProxy,
+        'args' => [options[:name], options[:type]])
+    end
+  end
+end