console_ip_whitelist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 161b072cdb2b8c9fd68096613fe00d764a304ede5e6df7ef73d6d88022b52de1
+  data.tar.gz: 3c41ed813822e98daf8394a50678271572e25e5825b7762ae3377646fcad02a7
+SHA512:
+  metadata.gz: 3dc4e61701bfbe35cc20a49208fe941ebfdb6ef19ede2e82e9fc09d15c36e0253372f1f8bd8a3476ef8c7569e5a89d70d37cd22f0dc50bf1d97c11d2d48e9339
+  data.tar.gz: cadfc3385ced37fa18c10e2c18356c4c16f8fed10b59d838b39c6235ec1d7f4dd9416c6f532f9f9a4f40baca426c06d41b28f439d9d892e48db12c171d114c12

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Murugan
+
+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,28 @@
+# ConsoleIpWhitelist
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'console_ip_whitelist'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install console_ip_whitelist
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,36 @@
+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    = 'ConsoleIpWhitelist'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/bin/ipwhitelist

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+require 'yaml'
+include FileUtils
+
+ip_address =  ARGV[0]
+path = Pathname.new File.expand_path('../../whitelist.yml', __FILE__)
+whitelisted_ips = if File.exist?(path)
+                    YAML.load_file(path)
+                  else
+                    []
+                  end
+
+whitelisted_ips << ip_address
+whitelisted_ips = whitelisted_ips.uniq.compact
+
+File.open(path, 'w') {|f| f.write whitelisted_ips.to_yaml }
+
+puts "Stopping Rails server. Please restart it."
+`kill -9 $(lsof -i tcp:8080 -t) >/dev/null 2>/dev/null`

data/lib/console_ip_whitelist.rb

@@ -0,0 +1,7 @@
+require "better_errors"
+require "console_ip_whitelist/engine"
+require "console_ip_whitelist/middleware"
+
+module ConsoleIpWhitelist
+  # Your code goes here...
+end

data/lib/console_ip_whitelist/engine.rb

@@ -0,0 +1,46 @@
+module ConsoleIpWhitelist
+  class Engine < ::Rails::Engine
+    isolate_namespace ConsoleIpWhitelist
+
+    initializer "console_ip_whitelist.configure_rails_initialization" do |app|
+      if enable?
+        insert_middleware
+      end
+    end
+
+    config.after_initialize do
+      path = Rails.root.join('whitelist.yml')
+      default_whitelist_path = Rails.root.join("default_whitelist.yml")
+      whitelisted_ips = []
+
+      if File.exist?(path)
+        whitelisted_ips = YAML.load_file(path)
+      end
+
+      if File.exist?(default_whitelist_path)
+        whitelisted_ips = whitelisted_ips.concat(YAML.load_file(default_whitelist_path))
+      end
+
+      whitelisted_ips.each do |ip|
+        BetterErrors::Middleware.allow_ip!(ip)
+      end
+    end
+
+    def insert_middleware
+      if defined? BetterErrors::Middleware
+        app.middleware.insert_after BetterErrors::Middleware, ConsoleIpWhitelist::Middleware
+      else
+        app.middleware.use ConsoleIpWhitelist::Middleware
+      end
+    end
+
+    def enable?
+      !Rails.env.production? and app.config.consider_all_requests_local
+    end
+
+    def app
+      Rails.application
+    end
+
+  end
+end

data/lib/console_ip_whitelist/middleware.rb

@@ -0,0 +1,110 @@
+module ConsoleIpWhitelist
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      @ip = request.ip
+      @app.call(env)
+    rescue Exception => ex
+      if pass_through?
+        @app.call(env)
+      else
+        [200, {"Content-Type" => "text/html"}, [error_message]]
+      end
+    end
+
+    def pass_through?
+      path = Rails.root.join('whitelist.yml')
+      default_whitelist_path = Rails.root.join("default_whitelist.yml")
+      whitelisted_ips = []
+      file_exist = false
+
+      if File.exist?(path)
+        file_exist = true
+        whitelisted_ips = YAML.load_file(path)
+      end
+
+      if File.exist?(default_whitelist_path)
+        file_exist = true
+        whitelisted_ips = whitelisted_ips.concat(YAML.load_file(default_whitelist_path))
+      end
+
+      if file_exist
+        whitelisted_ips.include?(@ip)
+      else
+        true
+      end
+    end
+
+    def error_message
+      <<-HTML
+      <!DOCTYPE html>
+<html>
+
+<head>
+  <title>Enhance your error page</title>
+
+  <!-- Expand the number of characters we can use in the document beyond basic ASCII 🎉 -->
+  <meta charset="utf-8">
+
+  <!-- Connect Bootstrap CSS -->
+  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css">
+
+  <!-- Make it responsive to small screens -->
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+</head>
+
+<body>
+  <div class="container pt-4 text-center">
+    <div class="row mb-3">
+      <div class="col-md-8 offset-md-2">
+        <div class="alert alert-danger">
+          <p class="h2">
+            Hey you — yes, <span style="text-transform: uppercase;">you</span> — <em>read</em> this message, don't ignore it.
+          </p>
+        </div>
+      </div>
+    </div>
+
+    <div class="row mb-3">
+      <div class="col-md-8 offset-md-2">
+        <h1 class="display-4">Congratulations! There's an error in your code. That means you're making progress!</h1>
+      </div>
+    </div>
+
+    <div class="row mb-3">
+      <div class="col-md-8 offset-md-2">
+        <p class="h3">Now it's time to debug. To get a really helpful error page, copy-paste this command at a terminal prompt:</p>
+      </div>
+    </div>
+
+    <div class="row mb-3">
+      <div class="col-md-8 offset-md-2">
+        <div class="jumbotron py-2 mb-3">
+          <pre style="font-size: 2em;"><code>bin/whitelist #{@ip}</code></pre>
+        </div>
+      </div>
+    </div>
+
+    <div class="row mb-3">
+      <div class="col-md-8 offset-md-2">
+        <p class="h3">and then <span style="text-transform: uppercase;">restart your server</span>. Then, refresh this page. You'll see a supercharged error page. In addition to the high-level error message at the top of the page, you'll have:</p>
+      </div>
+    </div>
+
+    <div class="row mb-3">
+      <div class="col-md-8 offset-md-2">
+        <img src="https://firstdraft.github.io/console_ip_whitelist/better_errors_diagram.png" class="img-fluid">
+      </div>
+    </div>
+  </div>
+</body>
+
+</html>
+      HTML
+    end
+  end
+end

data/lib/console_ip_whitelist/version.rb

@@ -0,0 +1,3 @@
+module ConsoleIpWhitelist
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: console_ip_whitelist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Murugan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: better_errors
+  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: ConsoleIpWhitelist.
+email:
+- murugan@firstdraft.com
+executables:
+- ipwhitelist
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/ipwhitelist
+- lib/console_ip_whitelist.rb
+- lib/console_ip_whitelist/engine.rb
+- lib/console_ip_whitelist/middleware.rb
+- lib/console_ip_whitelist/version.rb
+homepage: https://github.com/firstdraft
+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.7.8
+signing_key: 
+specification_version: 4
+summary: ConsoleIpWhitelist.
+test_files: []