rack-entrance 0.0.4 → 0.1.0

data/README.md

@@ -15,7 +15,7 @@ gem install rack-entrance
 #### Add it to your middleware stack
 
 ```ruby
-ENV['ENTRANCE_INTERNAL_IPS'] = "127.0.0.1,192.0.2.21"
+ENV['ENTRANCE_INTERNAL_CIDRS'] = "127.0.0.1,192.0.2.21"
 use Rack::Entrance
 ````
 

data/lib/rack/entrance.rb

@@ -1,4 +1,5 @@
 require 'rack'
+require 'ipaddr'
 
 module Rack
   class Entrance
@@ -7,24 +8,44 @@ module Rack
       @app = app
     end
 
+    def self.internal_cidrs
+      ENV['ENTRANCE_INTERNAL_CIDRS'].to_s.split ','
+    end
+
     def call(env)
-      request = Rack::Request.new(env)
-      ip = (env["action_dispatch.remote_ip"] || request.ip).to_s
-      request.env['entrance.ip']           = ip
-      request.env['entrance.internal_ips'] = internal_ips
-      request.env['entrance.internal']     = internal?(ip)
+      @env = env
+      request.env['entrance.user_ip']        = user_ip.to_s if user_ip.to_s != ''
+      request.env['entrance.internal_cidrs'] = self.class.internal_cidrs
+      request.env['entrance.internal']       = internal?
       @app.call env
     end
 
-    def internal?(ip)
-      internal_ips.each do |internal_ip|
-        return true if ip.to_s.start_with?(internal_ip)
-      end
-      false
+    def request
+      ::Rack::Request.new @env
+    end
+
+    def raw_user_ip
+      (@env["action_dispatch.remote_ip"] || request.ip).to_s
+    end
+
+    def user_ip
+      ::IPAddr.new raw_user_ip
+    rescue ArgumentError
+      nil
+    end
+
+    def internal?
+      internal_ips.any? { |ip| ip.include?(user_ip) }
     end
 
     def internal_ips
-      @internal_ips ||= ENV['ENTRANCE_INTERNAL_IPS'].to_s.split(',')
+      @internal_ips ||= self.class.internal_cidrs.map do |cidr|
+        begin
+          ::IPAddr.new cidr
+        rescue ArgumentError
+          nil
+        end
+      end.compact
     end
 
   end

data/lib/rack/entrance/version.rb

@@ -2,8 +2,8 @@ module Rack
   class Entrance
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 0
-      TINY  = 4
+      MINOR = 1
+      TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].compact.join('.')
     end

data/spec/lib/rack/entrance_spec.rb

@@ -1,55 +1,142 @@
 require 'spec_helper'
 
 describe Rack::Entrance do
-  include Rack::Test::Methods
+  let(:next_app) { lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['All good!']] } }
+  let(:app)      { Rack::Entrance.new next_app }
 
-  let(:inner_app) do
-    lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['All good!']] }
-  end
+  let(:user_ip)  { last_request.env['entrance.user_ip'] }
+  let(:internal) { last_request.env['entrance.internal'] }
+  let(:cidrs)    { last_request.env['entrance.internal_cidrs'] }
 
-  let(:app) { Rack::Entrance.new(inner_app) }
+  before do
+    ENV['ENTRANCE_INTERNAL_CIDRS'] = '192.0.2.0/24,198.51.100.0/32'
+  end
 
-  context 'internal request' do
+  context 'missing ENV' do
     before do
-      ENV['ENTRANCE_INTERNAL_IPS'] = '127.0.0.1,203.0.113.255'
+      ENV['ENTRANCE_INTERNAL_CIDRS'] = nil
       get '/'
     end
 
-    it 'sets internal to true' do
-      last_request.env['entrance.internal'].should be_true
+    it 'knows the user IP' do
+      expect(user_ip).to eq '127.0.0.1'
+    end
+
+    it 'has no cirds' do
+      expect(cidrs).to be_empty
+    end
+
+    it 'is external' do
+      expect(internal).to be false
     end
   end
 
-  context 'internal request by prefix' do
+  context 'invalid ENV' do
     before do
-      ENV['ENTRANCE_INTERNAL_IPS'] = '203.0.113.255,127.0.'
+      ENV['ENTRANCE_INTERNAL_CIDRS'] = 'but,why?,198.51.100.0/24,weird,,'
       get '/'
     end
 
-    it 'sets internal to true' do
-      last_request.env['entrance.internal'].should be_true
+    it 'knows the user IP' do
+      expect(user_ip).to eq '127.0.0.1'
+    end
+
+    it 'knows the original cidrs' do
+      expect(cidrs).to eq %w(but why? 198.51.100.0/24 weird)
+    end
+
+    it 'is external' do
+      expect(internal).to be false
     end
   end
 
-  context 'external request' do
+  context 'invalid user IP' do
     before do
-      ENV['ENTRANCE_INTERNAL_IPS'] = '192.0.2.21,203.0.113.255'
-      get '/'
+      get '/', {}, 'action_dispatch.remote_ip' => 'what the?'
     end
 
-    it 'sets internal to false' do
-      last_request.env['entrance.internal'].should be_false
+    it 'has no user IP' do
+      expect(user_ip).to be nil
+    end
+
+    it 'knows the cidrs' do
+      expect(cidrs).to eq %w(192.0.2.0/24 198.51.100.0/32)
+    end
+
+    it 'is external' do
+      expect(internal).to be false
     end
   end
 
-  context 'no env variable set' do
+  context 'internal request' do
     before do
-      ENV['ENTRANCE_INTERNAL_IPS'] = nil
-      get '/'
+      get '/', {}, 'action_dispatch.remote_ip' => '192.0.2.42'
+    end
+
+    it 'knows the user IP' do
+      expect(user_ip).to eq '192.0.2.42'
+    end
+
+    it 'knows the cidrs' do
+      expect(cidrs).to eq %w(192.0.2.0/24 198.51.100.0/32)
+    end
+
+    it 'is internal' do
+      expect(internal).to be true
+    end
+  end
+
+  context 'external request from same subnet in /16 range' do
+    before do
+      get '/', {}, 'action_dispatch.remote_ip' => '192.0.3.0'
+    end
+
+    it 'knows the user IP' do
+      expect(user_ip).to eq '192.0.3.0'
+    end
+
+    it 'knows the cidrs' do
+      expect(cidrs).to eq %w(192.0.2.0/24 198.51.100.0/32)
+    end
+
+    it 'is external' do
+      expect(internal).to be false
+    end
+  end
+
+  context 'external request from same subnet in /24 range' do
+    before do
+      get '/', {}, 'action_dispatch.remote_ip' => '198.51.101.0'
+    end
+
+    it 'knows the user IP' do
+      expect(user_ip).to eq '198.51.101.0'
+    end
+
+    it 'knows the cidrs' do
+      expect(cidrs).to eq %w(192.0.2.0/24 198.51.100.0/32)
+    end
+
+    it 'is external' do
+      expect(internal).to be false
+    end
+  end
+
+  context 'external request' do
+    before do
+      get '/', {}, 'action_dispatch.remote_ip' => '203.0.113.99'
+    end
+
+    it 'knows the user IP' do
+      expect(user_ip).to eq '203.0.113.99'
+    end
+
+    it 'knows the cidrs' do
+      expect(cidrs).to eq %w(192.0.2.0/24 198.51.100.0/32)
     end
 
-    it 'sets internal to false' do
-      last_request.env['entrance.internal'].should be_false
+    it 'is external' do
+      expect(internal).to be false
     end
   end
 

data/spec/spec_helper.rb

@@ -1,2 +1,10 @@
 require 'rack/test'
 require 'rack/entrance'
+
+RSpec.configure do |config|
+
+  include Rack::Test::Methods
+
+  config.raise_errors_for_deprecations!
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-entrance
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack