geo_redirect 0.5.1 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb805fe570535898e17ea6ce307d9678fca06592
-  data.tar.gz: f778479e3b46d3f14370918f92cbd609aa399b8d
+  metadata.gz: bb2df8b52f6869e6ed852973fa5774550c54f76c
+  data.tar.gz: b7e9c851cc2a67003efec2d8705eafc227176633
 SHA512:
-  metadata.gz: 26a9a0e3ec64548126373b48582e968ee617eeebab97d509679cbbe5b0e1b536d2865d1d43167adc6ae18ad601e411f2de81dba508342830449f12ccdf641604
-  data.tar.gz: 3d3cb9208831106ff865db2cd66840eaef622d43869a2660bdcc8ce790520f5e6eb7c9fc3d97a7bd0b1e7f91f894d79c836e26972019d0d828c7171ea821804d
+  metadata.gz: 2a654e3b640ef5c8eae208f5908e4c638816f933f42c31137b1c0c4c4a0108100282b72506d16c5f413354898c2323520cf2e5d2f54d25c8347b6bd540045e9b
+  data.tar.gz: 4ded31b14b6aa4c474a26f632af865bc7ec61ee75030aad98b6c0b39ef89d6321e8718e962bbdf61b88d2abaa9ec07c3b3a51c0a027c582608ab9c98301e4972

data/README.md

@@ -90,21 +90,27 @@ and unzip it into `db/` in your project, **or** you could use the following
 It'd be a good idea to use this task on your (Capistrano or whatever) deployment
 scripts.
 
-### Excluding certain URLs from redirection
+### Scoping redirects for certain URLs
 
-You may want certain URLs in your app to be ignored by GeoRedirect and to 
-respond normally to *all* incoming requests. You can configure this with the 
-`:exclude` option. 
+By default, GeoRedirect runs on *all* incoming requests and redirects
+accordingly.
+
+You may want GeoRedirect to either ignore some URLs (a blacklist), or only run
+the redirection logic over a certain list of URLs (a whitelist). This can be
+done through the `:exclude` and `:include` options.
+
+    Rails.application.middleware.use GeoRedirect::Middleware, include: '/'
+
+will only redirect incoming requests to 'example.org/', and ignore any other
+paths.
 
     Rails.application.middleware.use GeoRedirect::Middleware, exclude: '/excluded_path'
-    
-The value of the option can be a string or an array of strings which represent 
-the path(s) to be excluded. Note that each string must be an exact match of the 
-path portion of the URL, including the leading slash.
-
-    Rails.application.middleware.use GeoRedirect::Middleware, exclude: '/exclude'
-    
-will match `www.myapp.com/exclude` but not `www.myapp.com/other/path/exclude`
+
+will ignore requests to 'example.org/excluded_path' but redirect all other
+incoming requests.
+
+The value for both options can be either a single path string or an array of
+paths. All should include the leading slash.
 
 ### Custom paths
 

data/lib/geo_redirect/middleware.rb

@@ -6,16 +6,14 @@ module GeoRedirect
     attr_accessor :db, :config
 
     def initialize(app, options = {})
-      # Some defaults
-      options[:db] ||= DEFAULT_DB_PATH
-      options[:config] ||= DEFAULT_CONFIG_PATH
-
       @app = app
 
-      @logger   = init_logger(options[:logfile]) if options[:logfile]
-      @db       = init_db(options[:db])
-      @config   = init_config(options[:config])
-      @excludes = Array(options[:exclude])
+      @logger = init_logger(options[:logfile])
+      @db     = init_db(options[:db] || DEFAULT_DB_PATH)
+      @config = init_config(options[:config] || DEFAULT_CONFIG_PATH)
+
+      @include_paths = Array(options[:include])
+      @exclude_paths = Array(options[:exclude])
 
       log 'Initialized middleware'
     end
@@ -63,15 +61,22 @@ module GeoRedirect
 
     def skip_redirect?
       url = URI.parse(@request.url)
-      query_includes_skip_geo?(url) || path_excluded?(url)
+      query_includes_skip_geo?(url) ||
+        path_not_whitelisted?(url) ||
+        path_blacklisted?(url)
     end
 
     def query_includes_skip_geo?(url)
       Rack::Utils.parse_query(url.query).key? 'skip_geo'
     end
 
-    def path_excluded?(url)
-      @excludes.any? { |exclude| url.path == exclude }
+    def path_not_whitelisted?(url)
+      @include_paths.length > 0 &&
+        !@include_paths.any? { |exclude| url.path == exclude }
+    end
+
+    def path_blacklisted?(url)
+      @exclude_paths.any? { |exclude| url.path == exclude }
     end
 
     def handle_force
@@ -144,7 +149,7 @@ module GeoRedirect
     end
 
     def init_logger(path)
-      Logger.new(path)
+      Logger.new(path) if path
     rescue Errno::EINVAL, Errno::EACCES
       nil
     end

data/lib/geo_redirect/version.rb

@@ -1,3 +1,3 @@
 module GeoRedirect
-  VERSION = '0.5.1'
+  VERSION = '0.6'
 end

data/spec/lib/geo_redirect/middleware_spec.rb

@@ -50,7 +50,7 @@ describe GeoRedirect::Middleware do
   end
 
   describe '#log' do
-    describe 'with valid logfile path' do
+    context 'with valid logfile path' do
       before { mock_app }
 
       it 'initiates a log file' do
@@ -68,6 +68,11 @@ describe GeoRedirect::Middleware do
       mock_app logfile: '/no_such_file'
       expect(@app.instance_variable_get(:"@logger")).to be_nil
     end
+
+    it 'ignores empty logfile option' do
+      mock_app logfile: nil
+      expect(@app.instance_variable_get(:"@logger")).to be_nil
+    end
   end
 
   describe '#host_by_country' do
@@ -157,22 +162,22 @@ describe GeoRedirect::Middleware do
       end
     end
 
-    describe 'without session memory' do
-      describe 'for a foreign source' do
+    context 'without session memory' do
+      context 'for a foreign source' do
         let(:country_code) { 'US' }
         it { is_expected.to redirect_to :us }
         it { is_expected.to remember :us }
         it { is_expected.to remember_country 'US' }
       end
 
-      describe 'for a local source' do
+      context 'for a local source' do
         let(:country_code) { 'IL' }
         it { is_expected.to not_redirect }
         it { is_expected.to remember :il }
         it { is_expected.to remember_country 'IL' }
       end
 
-      describe 'for an unknown source' do
+      context 'for an unknown source' do
         let(:country_code) { 'SOMEWHERE OVER THE RAINBOW' }
         it { is_expected.to redirect_to :default }
         it { is_expected.to remember :default }
@@ -180,7 +185,7 @@ describe GeoRedirect::Middleware do
       end
     end
 
-    describe 'with valid session memory' do
+    context 'with valid session memory' do
       let(:request_session) { :default }
       let(:country_code) { 'US' }
       it { is_expected.to redirect_to :default }
@@ -188,7 +193,7 @@ describe GeoRedirect::Middleware do
       it { is_expected.to remember_country 'US' }
     end
 
-    describe 'with invalid session memory' do
+    context 'with invalid session memory' do
       let(:request_session) { 'foo' }
       let(:country_code) { 'US' }
 
@@ -201,7 +206,7 @@ describe GeoRedirect::Middleware do
       it { is_expected.to remember_country 'US' }
     end
 
-    describe 'with forced redirect flag' do
+    context 'with forced redirect flag' do
       let(:country_code) { 'US' }
       let(:request_args) { { redirect: 1 } }
 
@@ -214,7 +219,7 @@ describe GeoRedirect::Middleware do
       it { is_expected.to remember_country nil }
     end
 
-    describe 'with skip flag' do
+    context 'with skip flag' do
       let(:country_code) { 'US' }
       let(:request_args) { { skip_geo: true } }
       it { is_expected.to not_redirect }
@@ -222,45 +227,90 @@ describe GeoRedirect::Middleware do
       it { is_expected.to remember_country nil }
     end
 
-    describe 'with no recognizable IP' do
+    context 'with no recognizable IP' do
       let(:country_code) { nil }
       it { is_expected.to not_redirect }
       it { is_expected.to remember nil }
       it { is_expected.to remember_country nil }
     end
 
-    describe 'with an exclude option set' do
-      let(:app_options) { { exclude: ['/exclude_me', '/exclude_me/too'] } }
-
-      context 'when the request URL matches one of the excluded paths' do
-        let(:country_code) { 'US' }
-        let(:request_path) { '/exclude_me?query_param=value' }
+    describe 'include/exclude logic' do
+      let(:country_code) { 'US' }
 
+      shared_examples :skips_redirect do
         it { is_expected.to not_redirect }
         it { is_expected.to remember nil }
         it { is_expected.to remember_country nil }
       end
 
-      context 'when the request URL does not match one of the excluded paths' do
-        let(:country_code) { 'US' }
-        let(:request_path) { '/dont_exclude_me?query_param=value' }
-
+      shared_examples :does_not_skip_redirect do
         it { is_expected.to redirect_to :us }
         it { is_expected.to remember :us }
         it { is_expected.to remember_country 'US' }
       end
-    end
 
-    describe 'with a single excluded path' do
-      let(:app_options) { { exclude: '/exclude_me' } }
+      context 'with an include option' do
+        let(:app_options) { { include: include_value } }
 
-      context 'when the request URL matches one of the excluded paths' do
-        let(:country_code) { 'US' }
-        let(:request_path) { '/exclude_me?query_param=value' }
+        context 'when include is an array of paths' do
+          let(:include_value) { %w(/include_me /include_me/too) }
 
-        it { is_expected.to not_redirect }
-        it { is_expected.to remember nil }
-        it { is_expected.to remember_country nil }
+          context 'when request URL matches one of the included paths' do
+            let(:request_path) { '/include_me?query_param=value' }
+            it_behaves_like :does_not_skip_redirect
+          end
+
+          context 'when request URL does not match any of the included paths' do
+            let(:request_path) { '/dont_include_me?query_param=value' }
+            it_behaves_like :skips_redirect
+          end
+        end
+
+        context 'when include is a single path' do
+          let(:include_value) { '/include_me' }
+
+          context 'when request URL matches one of the included paths' do
+            let(:request_path) { '/include_me?query_param=value' }
+            it_behaves_like :does_not_skip_redirect
+          end
+
+          context 'when request URL does not match any of the included paths' do
+            let(:request_path) { '/dont_include_me?query_param=value' }
+            it_behaves_like :skips_redirect
+          end
+        end
+      end
+
+      context 'with an exclude option' do
+        let(:app_options) { { exclude: exclude_value } }
+
+        context 'when exclude is an array of paths' do
+          let(:exclude_value) { %w(/exclude_me /exclude_me/too) }
+
+          context 'when request URL matches one of the excluded paths' do
+            let(:request_path) { '/exclude_me?query_param=value' }
+            it_behaves_like :skips_redirect
+          end
+
+          context 'when request URL does not match any of the excluded paths' do
+            let(:request_path) { '/dont_exclude_me?query_param=value' }
+            it_behaves_like :does_not_skip_redirect
+          end
+        end
+
+        context 'when exclude is a single path' do
+          let(:exclude_value) { '/exclude_me' }
+
+          context 'when request URL matches the excluded path' do
+            let(:request_path) { '/exclude_me?query_param=value' }
+            it_behaves_like :skips_redirect
+          end
+
+          context 'when request URL does not match any of the excluded paths' do
+            let(:request_path) { '/dont_exclude_me?query_param=value' }
+            it_behaves_like :does_not_skip_redirect
+          end
+        end
       end
     end
   end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: geo_redirect
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: '0.6'
 platform: ruby
 authors:
 - Sagie Maoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-21 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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: geoip
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.33.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.33.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
 description: Geo-location based redirector
@@ -129,10 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -160,17 +160,17 @@ 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.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rack middleware to redirect clients to hostnames based on geo-location
@@ -183,4 +183,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/geo_redirect.rb
 - spec/support/rake.rb
-has_rdoc: