wrenchmode-rack 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58f083348339efd1edfece7a5f8a2385e79058a9
+  data.tar.gz: 730b06f6d008933865c86c4752b70428a3fb9a3c
+SHA512:
+  metadata.gz: 543dd1b8120bfccf7feff548bad8233287e827911442a5aaa7bbf4b26057a3b7187fc1bf260d84820e5d641d6cc660f2cc9e6a77c07d7f7d2cb846ee9e2a4f29
+  data.tar.gz: 2518bc795d9a5085a0006eaa8ad8369adf26e7880a674ccb386d2a632a0f0c7e90711996384030b89e5a01a54b78f640b453f5cb84292fcd6a08226511328756

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+wrenchmode-rack-*.gem
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Micah Wedemeyer
+
+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,80 @@
+# Wrenchmode Rack
+
+[![Gem Version](https://badge.fury.io/rb/wrenchmode-rack.svg)](https://badge.fury.io/rb/wrenchmode-rack)
+
+This is a [Rack Middleware](http://rack.github.io/) for managing maintenance mode on your Ruby/Rack/Rails web application using [Wrenchmode](http://wrenchmode.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wrenchmode-rack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wrenchmode-rack
+
+## Usage
+
+### In a Rails application
+
+```ruby
+# config/environments/production.rb
+config.middleware.use Wrenchmode::Rack, jwt: "your-long-jwt"
+
+# If you want to test in staging prior to deploying to production.
+# (Coming soon, still not implemented...)
+# config/environments/staging.rb
+config.middleware.use Wrenchmode::Rack, ignore_test_mode: false, jwt: "your-long-jwt"
+```
+
+### In a vanilla Rack application
+
+```ruby
+# your-app.rb
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+
+use Wrenchmode::Rack, jwt: "your-long-jwt"
+```
+
+## Advanced Configuration Options
+
+You can also specify the following options to the middleware layer:
+
+`force_open` - Set to true to force the middlware layer to allow all requests through, regardless of project status on Wrenchmode.com. Effectively disables the middleware. (Default false)
+
+`ignore_test_mode` - (Coming soon...) Set to false to if you want the middleware to respond to a project that is in Test mode on Wrenchmode.com This can be useful if you want to test Wrenchmode in a development or staging environment prior to deploying to production. (Default true)
+
+`disable_local_wrench` - (Coming soon...) Set to true if you want to disable LocalWrench mode, where the Wrenchmode page is served on your domain. Disabling it will instead force a redirect to the Wrenchmode.com domain. Note: Unless you explicitly want this behavior, it's best to leave this at the default. (Default false)
+
+`check_delay_secs` - Change this to modify the rate at which the middleware polls Wrenchmode for updates. Unlikely that this needs anything faster than the default. (Default 5)
+
+`logging` - Set to true in order to log information from the middleware layer to your logging facility. (Default false)
+
+## FAQ
+
+### Does every request to my server get proxied through Wrenchmode? Isn't that slow?
+
+No. The middleware does not function as a proxy at all in that fashion. Instead, the middleware spins up a separate thread that periodically checks the Wrenchmode API for changes and updates its own internal state. In other words, the middleware adds zero performance impact on requests to your server.
+
+### What if the Wrenchmode service is down? Will my project be brought down as well?
+
+No. The middleware is designed to fail open, meaning that if it encounters any errors or cannot contact the Wrenchmode API, it will automatically revert to "open" mode where it allows all requests to pass through normally to your server.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/micahwedemeyer/wrenchmode-rack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,207 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'ipaddr'
+
+module Wrenchmode
+  class Rack
+    CLIENT_NAME = "wrenchmode-rack"
+    VERSION = '0.0.10'
+
+    SWITCH_URL_KEY = "switch_url"
+    TEST_MODE_KEY = "test_mode"
+    IS_SWITCHED_KEY = "is_switched"
+    IP_WHITELIST_KEY = "ip_whitelist"
+    REVERSE_PROXY_KEY = "reverse_proxy"
+
+    def initialize(app, opts = {})
+      @app = app       
+
+      # Symbolize keys
+      opts = symbolize_keys(opts)
+      opts = {
+        force_open: false,
+        ignore_test_mode: true,
+        disable_local_wrench: false, # LocalWrench is our "brand name", want to avoid scaring people will talk of proxies
+        status_protocol: "https",
+        status_host: "api.wrenchmode.com",
+        status_path: "/api/projects/status",
+        check_delay_secs: 5,
+        logging: false,
+        read_timeout_secs: 3
+      }.merge(opts)
+
+      @jwt = opts[:jwt]
+      @ignore_test_mode = opts[:ignore_test_mode]
+      @disable_reverse_proxy = opts[:disable_local_wrench]
+      @force_open = opts[:force_open]
+      @status_url = "#{opts[:status_protocol]}://#{opts[:status_host]}#{opts[:status_path]}"
+      @check_delay_secs = opts[:check_delay_secs]
+      @logging = opts[:logging]
+      @read_timeout_secs = opts[:read_timeout_secs]
+      @ip_whitelist = []
+      @logger = nil
+
+      @enable_reverse_proxy = false
+
+      @made_contact = false
+    end
+
+    def call(env)      
+      @logger = env['rack.logger'] if @logging && !@logger
+
+      unless @jwt
+        log("[Wrenchmode] No JWT specified so bypassing Wrenchmode. Please configure Wrenchmode with a JWT.", Logger::ERROR)
+        return @app.call(env)
+      end
+
+      # On startup, we need to give it a chance to make contact
+      @check_thread ||= start_check_thread()
+      sleep(0.01) while !@made_contact
+
+      should_display_wrenchmode = false
+      if @switched
+        req = ::Rack::Request.new(env)
+
+        should_display_wrenchmode = !@force_open
+        should_display_wrenchmode &&= !ip_whitelisted?(req)
+      end
+
+      if should_display_wrenchmode
+        if @enable_reverse_proxy
+          reverse_proxy
+        else
+          redirect
+        end
+      else
+        @app.call(env)
+      end
+    end      
+
+    def update_status
+      json = fetch_status
+
+      @switch_url = json[SWITCH_URL_KEY]
+      test_mode = json[TEST_MODE_KEY] || false
+      @switched = json[IS_SWITCHED_KEY] && !(@ignore_test_mode && test_mode)
+      @ip_whitelist = json[IP_WHITELIST_KEY] || []
+
+      @enable_reverse_proxy = false
+      if json[REVERSE_PROXY_KEY] && !@disable_reverse_proxy
+        @enable_reverse_proxy = json[REVERSE_PROXY_KEY]["enabled"]
+        @reverse_proxy_config = symbolize_keys(json[REVERSE_PROXY_KEY])
+      end
+
+    rescue OpenURI::HTTPError => e
+      log("Wrenchmode Check HTTP Error: #{e.message}")
+      @switched = false
+    rescue JSON::JSONError => e
+      log("Wrenchmode Check JSON Error: #{e.message}")
+      @switched = false
+    rescue StandardError => e
+      log("Wrenchmode Check Unknown Error: #{e.message}")
+      @switched = false
+    ensure
+      @made_contact = true
+    end
+
+    private
+
+    def fetch_status
+      payload = JSON.generate(build_update_package)
+      body = nil
+
+      uri = URI.parse(@status_url)
+      use_ssl = uri.scheme == "https"
+      Net::HTTP.start(uri.host, uri.port, open_timeout: @read_timeout_secs, read_timeout: @read_timeout_secs, use_ssl: use_ssl) do |http|
+        response = http.post(uri, payload, post_headers)
+        body = response.read_body
+      end
+
+      JSON.parse(body)
+    end
+
+    def post_headers
+      {
+        "Content-Type" => "application/json",
+        "Accept" => "application/json",
+        "Authorization" => @jwt,
+        "User-Agent" => "#{CLIENT_NAME}-#{VERSION}"
+      }
+    end
+
+    def redirect
+      [
+        302,
+        {'Location' => @switch_url, 'Content-Type' => 'text/html', 'Content-Length' => '0'},
+        []
+      ]
+    end
+
+    def reverse_proxy
+      [
+        @reverse_proxy_config[:http_status],
+        @reverse_proxy_config[:response_headers],
+        [@reverse_proxy_config[:response_body]]
+      ]
+    end
+
+    def start_check_thread
+      Thread.new do
+        while true do
+          update_status
+          sleep(@check_delay_secs)
+        end
+      end
+    end
+
+    def ip_whitelisted?(request)
+      return false unless request.ip
+      client_ip = IPAddr.new(request.ip)
+      @ip_whitelist.any? do |ip_address|
+        IPAddr.new(ip_address).include?(client_ip)
+      end
+    end
+
+    def build_update_package
+      {
+        hostname: guess_hostname,
+        ip_address: guess_ip_address,
+        pid: guess_pid,
+        client_name: CLIENT_NAME,
+        client_version: VERSION
+      }
+    end
+
+    def guess_pid
+      Process.pid
+    rescue StandardError => e
+      log("Wrenchmode error trying to guess PID: #{e.inspect}")
+      nil
+    end
+
+    def guess_hostname
+      Socket.gethostname
+    rescue StandardError => e
+      log("Wrenchmode error trying to guess the hostname: #{e.inspect}")
+      nil
+    end
+
+    def guess_ip_address
+      address = Socket.ip_address_list.find { |addr| addr.ipv4? && !addr.ipv4_loopback? && !addr.ipv4_private? }
+      address ? address.ip_address : nil
+    rescue StandardError => e
+      log("Wrenchmode error trying to guess the IP address: #{e.inspect}")
+      nil
+    end
+
+    def log(message, level = nil)
+      @logger.add(level || Logger::INFO, message) if @logging && @logger
+    end
+
+    def symbolize_keys(hash)
+      hash.each_with_object({}) { |(k,v), h| h[k.to_sym] = v }
+    end
+
+  end
+end

data/lib/wrenchmode.rb

@@ -0,0 +1 @@
+require 'wrenchmode/rack'

data/wrenchmode-rack.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wrenchmode'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wrenchmode-rack"
+  spec.version       = Wrenchmode::Rack::VERSION
+  spec.authors       = ["Micah Wedemeyer"]
+  spec.email         = ["me@micahwedemeyer.com"]
+
+  spec.summary       = "Rack middleware for using maintenance mode with Wrenchmode.com"
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "http://github.com/micahwedemeyer/wrenchmode-rack"
+  spec.license       = "MIT"
+
+  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 "rack", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: wrenchmode-rack
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+platform: ruby
+authors:
+- Micah Wedemeyer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: 
+email:
+- me@micahwedemeyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wrenchmode.rb
+- lib/wrenchmode/rack.rb
+- wrenchmode-rack.gemspec
+homepage: http://github.com/micahwedemeyer/wrenchmode-rack
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware for using maintenance mode with Wrenchmode.com
+test_files: []