floodgate 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9db86194f10be4b4ce921bb9964d0c3600e4b2d
-  data.tar.gz: c9b0fafb0e2455a4db2d5c3629798ce7e5edcb45
+  metadata.gz: d934a5e26e5c75cb0b000f321de8a0ccfc42c010
+  data.tar.gz: 82b0183c0ec1edf9d9703635c2f003e856a65795
 SHA512:
-  metadata.gz: fbd81c3f94ca145f550f6d5e8986e3d19bc6f14f1420b9a6028e2109d0ba51cd03770a8dbdf824616ebd1ca1fb87b1a04f59fc4e36601dd63dbb14006af497b1
-  data.tar.gz: 98ce680b053a23e15d2e5c49faeeb0e1f700c323443491491b879633045611600c0368ef016c79dcc2c18274816b662933f011a93088d3f0d81e8e6b0bcdbb33
+  metadata.gz: da323e40805cee980fac69efa28f8ee1e803c81c55b2d792f0444e17c879aa370325a3e6841c0c8f8c1132faf2b35405920ef421dc962594ed71783be34a8bc7
+  data.tar.gz: 5aa2e49eeefd7c396c3f21d7403c630f222b581e9d61fc20bb50288a715f3f25d45baaa593a3ca5c8478e98a9e33c87d8ab3bdbd7e7e2f5b30bdc898de84a5e1

data/lib/floodgate/config.rb

@@ -18,12 +18,18 @@ module Floodgate
       @allowed_ip_addresses = json['allowed_ip_addresses'] || []
     end
 
-    def ip_address_allowed?(ip_address)
-      allowed_ip_addresses.include?(ip_address)
+    def potential_client_addresses(env)
+      %w(REMOTE_ADDR HTTP_X_FORWARDED_FOR).map { |name| env[name] }
+    end
+
+    def client_allowed?(env)
+      !!potential_client_addresses(env).find do |ip_address|
+        allowed_ip_addresses.include?(ip_address)
+      end
     end
 
     def filter_traffic?(env)
-      filter_traffic && !ip_address_allowed?(env['REMOTE_ADDR'])
+      filter_traffic && !client_allowed?(env)
     end
 
     def redirect?

data/lib/floodgate/version.rb

@@ -1,3 +1,3 @@
 module Floodgate
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/spec/lib/floodgate/config_spec.rb

@@ -20,41 +20,95 @@ module Floodgate
     let(:api_token) { 'def456' }
     let(:config) { Config.new(app_id, api_token) }
 
-    describe '#ip_address_allowed?' do
-      context 'when the allowed ip address list is nil' do
-        let(:allowed_ip_addresses) { nil }
-        let(:ip_address) { '127.0.0.1' }
+    describe '#client_allowed?' do
+      context 'when the environment specifies the client address in REMOTE_ADDR' do
+        let(:env) do
+          {
+            'REMOTE_ADDR' => ip_address
+          }
+        end
 
-        it 'is false' do
-          expect(config.ip_address_allowed?(ip_address)).to be_false
+        context 'when the allowed ip address list is nil' do
+          let(:allowed_ip_addresses) { nil }
+          let(:ip_address) { '127.0.0.1' }
+
+          it 'is false' do
+            expect(config.client_allowed?(env)).to be_false
+          end
         end
-      end
 
-      context 'when the allowed ip address list is empty' do
-        let(:allowed_ip_addresses) { [] }
-        let(:ip_address) { '127.0.0.1' }
+        context 'when the allowed ip address list is empty' do
+          let(:allowed_ip_addresses) { [] }
+          let(:ip_address) { '127.0.0.1' }
 
-        it 'is false' do
-          expect(config.ip_address_allowed?(ip_address)).to be_false
+          it 'is false' do
+            expect(config.client_allowed?(env)).to be_false
+          end
+        end
+
+        context 'when there are allowed ip addresses' do
+          let(:allowed_ip_addresses) { %w(198.81.129.107) }
+
+          context 'and the specified ip address is in the list' do
+            let(:ip_address) { '198.81.129.107' }
+
+            it 'is true' do
+              expect(config.client_allowed?(env)).to be_true
+            end
+          end
+
+          context 'but the specified ip address is not in the list' do
+            let(:ip_address) { '198.81.129.108' }
+
+            it 'is false' do
+              expect(config.client_allowed?(env)).to be_false
+            end
+          end
         end
       end
 
-      context 'when there are allowed ip addresses' do
-        let(:allowed_ip_addresses) { %w(198.81.129.107) }
+      context 'when the environment specifies the client address in HTTP_X_FORWARDED_FOR' do
+        let(:env) do
+          {
+            'HTTP_X_FORWARDED_FOR' => ip_address
+          }
+        end
 
-        context 'and the specified ip address is in the list' do
-          let(:ip_address) { '198.81.129.107' }
+        context 'when the allowed ip address list is nil' do
+          let(:allowed_ip_addresses) { nil }
+          let(:ip_address) { '127.0.0.1' }
 
-          it 'is true' do
-            expect(config.ip_address_allowed?(ip_address)).to be_true
+          it 'is false' do
+            expect(config.client_allowed?(env)).to be_false
           end
         end
 
-        context 'but the specified ip address is not in the list' do
-          let(:ip_address) { '198.81.129.108' }
+        context 'when the allowed ip address list is empty' do
+          let(:allowed_ip_addresses) { [] }
+          let(:ip_address) { '127.0.0.1' }
 
           it 'is false' do
-            expect(config.ip_address_allowed?(ip_address)).to be_false
+            expect(config.client_allowed?(env)).to be_false
+          end
+        end
+
+        context 'when there are allowed ip addresses' do
+          let(:allowed_ip_addresses) { %w(198.81.129.107) }
+
+          context 'and the specified ip address is in the list' do
+            let(:ip_address) { '198.81.129.107' }
+
+            it 'is true' do
+              expect(config.client_allowed?(env)).to be_true
+            end
+          end
+
+          context 'but the specified ip address is not in the list' do
+            let(:ip_address) { '198.81.129.108' }
+
+            it 'is false' do
+              expect(config.client_allowed?(env)).to be_false
+            end
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: floodgate
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Mark McEahern