ip_filter 0.8.0

data/lib/ip_filter/providers/s3.rb

@@ -0,0 +1,51 @@
+require 'aws-sdk'
+require 'aws-sdk-v1'
+
+module IpFilter
+  module Providers
+    class S3
+      attr_accessor :remote, :bucket_name, :urls
+
+      def initialize
+        @bucket_name = IpFilter.configuration.s3_bucket_name
+        AWS.config(
+          access_key_id: IpFilter.configuration.s3_access_key_id,
+          secret_access_key: IpFilter.configuration.s3_secret_access_key
+        )
+        @remote = AWS::S3.new
+        @bucket = create_bucket
+        @urls = {}
+        return self
+      end
+
+      def create_bucket
+        bucket = remote.buckets[bucket_name]
+        unless bucket.exists?
+          bucket = remote.buckets.create(bucket_name)
+        end
+        return bucket
+      end
+
+      def upload!
+        IpFilter.database_files.each do |file|
+          file_name = File.basename(file)
+          obj = @bucket.objects[file_name].write(file: file)
+          urls[file_name] = obj.url_for(:read, expires: Time.now.to_i + 840_000)
+        end
+        urls
+      end
+
+      def download!(name = nil)
+        if name.nil?
+          name = File.basename(IpFilter.configuration.geo_ip_dat)
+        end
+        geoip_db = @bucket.objects[name]
+        File.open(IpFilter.configuration.geo_ip_dat, 'wb') do |file|
+          geoip_db.read do |chunk|
+            file.write(chunk)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ip_filter/railtie.rb

@@ -0,0 +1,23 @@
+require 'ip_filter'
+require 'ip_filter/controller/geo_ip_lookup'
+
+module IpFilter
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'ip_filter.insert_into_action_controller' do
+        ActiveSupport.on_load :action_controller do
+          IpFilter::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      if defined?(::ActionController::Base)
+        ::ActionController::Base.send :include, Controller::GeoIpLookup
+      end
+    end
+  end
+end

data/lib/ip_filter/request.rb

@@ -0,0 +1,14 @@
+require 'ip_filter'
+
+module IpFilter
+  module Request
+    def location
+      # For now just grab the first value as the best guess.
+      @location ||= IpFilter.search(ip).try(:first)
+    end
+  end
+end
+
+if defined?(Rack) && defined?(Rack::Request)
+  Rack::Request.send :include, IpFilter::Request
+end

data/lib/ip_filter/results/base.rb

@@ -0,0 +1,39 @@
+module IpFilter
+  module Result
+    class Base
+      attr_accessor :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def [](attribute)
+        @data[attribute.to_sym]
+      end
+
+      def to_hash
+        @data
+      end
+
+      def country_code
+        raise NotImplementedError.new
+      end
+
+      def country_code2
+        raise NotImplementedError.new
+      end
+
+      def country_code3
+        raise NotImplementedError.new
+      end
+
+      def country_name
+        raise NotImplementedError.new
+      end
+
+      def continent_code
+        raise NotImplementedError.new
+      end
+    end
+  end
+end

data/lib/ip_filter/results/geoip.rb

@@ -0,0 +1,19 @@
+require 'ip_filter/results/base'
+
+module IpFilter
+  module Result
+    class Geoip < Base
+      def self.response_attributes
+        %w(
+          ip country_code country_code2 country_code3 country_name continent_code
+        )
+      end
+
+      response_attributes.each do |a|
+        define_method a do
+          @data[a.to_sym]
+        end
+      end
+    end
+  end
+end

data/lib/ip_filter/version.rb

@@ -0,0 +1,3 @@
+module IpFilter
+  VERSION = '0.8.0'
+end

data/spec/cache/dallistore_spec.rb

@@ -0,0 +1,16 @@
+require 'active_support/cache'
+require 'ip_filter'
+require 'ip_filter/cache'
+require 'ip_filter/cache/dallistore'
+require 'spec_helper'
+
+describe IpFilter::Cache::DalliStore do
+  extend EnableDallistoreCache
+  activate_dallistore!
+
+  subject { described_class.new(IpFilter.Configuration.cache) }
+
+  it { expect respond_to(:reset).with(0).arguments }
+  it { expect respond_to(:[]).with(1).arguments }
+  it { expect respond_to(:[]=).with(2).arguments }
+end

data/spec/cache/redis_spec.rb

@@ -0,0 +1,56 @@
+require 'ip_filter'
+require 'ip_filter/cache'
+require 'ip_filter/cache/redis'
+require 'spec_helper'
+
+describe IpFilter::Cache::Redis do
+  extend EnableRedisCache
+  activate_redis!
+
+  let!(:prefix) do
+    IpFilter.configuration { |c| c.cache_prefix = 'ip_filter_test:' }
+  end
+
+  subject { described_class.new(IpFilter.configuration.cache, prefix) }
+
+  it { expect respond_to(:reset).with(0).arguments }
+  it { expect respond_to(:[]).with(1).arguments }
+  it { expect respond_to(:[]=).with(2).arguments }
+
+  context '#reset' do
+    let!(:post_created_ips) do
+      IpFilter.search('100.10.220.10')
+      IpFilter.search('55.10.220.10')
+      IpFilter.search('125.10.220.10')
+      IpFilter.search('200.10.220.10')
+    end
+
+    let!(:keys) { IpFilter.configuration.cache.keys('ip_filter_test:*') }
+
+    it 'should drop all existing cache keys' do
+      subject.reset
+      expect(
+        subject.store.keys("#{prefix}*")
+      ).to be_empty
+    end
+  end
+
+  context '#[] (getter)' do
+    let!(:post_saved_ip) { IpFilter.search('55.10.220.10') }
+
+    it 'should return result from cache' do
+      expected_cache = subject.store.keys("#{prefix}:55.10.220.10")
+      expect(expected_cache).to be_empty
+      expect(expected_cache).not_to include post_saved_ip
+    end
+  end
+
+  context '#[]= (setter)' do
+    it 'should return result from cache' do
+      subject['55.10.220.10'] = { this: 'is a test' }
+      result = subject['55.10.220.10']
+
+      expect(result.to_h).to eq(this: 'is a test')
+    end
+  end
+end

data/spec/controller/ip_controller_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'action_controller'
+require 'ip_filter'
+require 'ip_filter/controller/geo_ip_lookup'
+
+class IpController < ::ActionController::Base
+  include IpFilter::Controller::GeoIpLookup
+  include IpFilter::Request
+
+  validate_ip
+  skip_validate_ip only: [:test_action_skip]
+
+  def test_action
+    render text: 'Testing test output'
+  end
+
+  def test_action_skip
+    render text: 'Testing test output'
+  end
+end
+
+describe IpController do
+  context 'ip_validate' do
+    before(:each) do
+      allow(IpFilter.configuration).to receive(:ip_whitelist) {['127.0.0.1/24']}
+    end
+
+    it 'should validate IP and raise error' do
+      expect { action_call(IpController, :test_action, ip: '246.243.3.83')
+      }.to raise_error(ArgumentError, /GeoIP/)
+    end
+
+    it 'should validate IP 127.0.0.1 and success' do
+      expect {
+        action_call(IpController, :test_action, ip: '127.0.0.1')
+      }.to_not raise_error
+    end
+
+    it 'should validate IP 127.0.0.254 and success' do
+      expect {
+        action_call(IpController, :test_action, ip: '127.0.0.254')
+      }.to_not raise_error
+    end
+  end
+  context 'skip_ip_validate' do
+    before(:each) do
+      IpFilter.configuration.ip_whitelist = proc { ['127.0.0.1/24'] }
+    end
+
+    it 'should validate IP and not raise error' do
+      expect {
+        action_call(IpController, :test_action_skip, ip: '146.243.3.83')
+      }.to_not raise_error
+    end
+  end
+end

data/spec/fixtures/LICENSE.txt

@@ -0,0 +1,31 @@
+OPEN DATA LICENSE (GeoLite Country and GeoLite City databases)
+
+Copyright (c) 2008 MaxMind, Inc.  All Rights Reserved.
+
+All advertising materials and documentation mentioning features or use of
+this database must display the following acknowledgment:
+"This product includes GeoLite data created by MaxMind, available from
+http://maxmind.com/"
+
+Redistribution and use with or without modification, are permitted provided
+that the following conditions are met:
+1. Redistributions must retain the above copyright notice, this list of
+conditions and the following disclaimer in the documentation and/or other
+materials provided with the distribution. 
+2. All advertising materials and documentation mentioning features or use of
+this database must display the following acknowledgement:
+"This product includes GeoLite data created by MaxMind, available from
+http://maxmind.com/"
+3. "MaxMind" may not be used to endorse or promote products derived from this
+database without specific prior written permission.
+
+THIS DATABASE IS PROVIDED BY MAXMIND, INC ``AS IS'' AND ANY 
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL MAXMIND BE LIABLE FOR ANY 
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
+DATABASE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/spec/ip_filter_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe IpFilter do
+  context 'Methods' do
+    context '#ip_address?' do
+      it 'should success on IP range ' do
+        expect(
+          described_class.send(:ip_address?, '1.2.3.4/1')
+        ).to be_truthy
+      end
+
+      it 'should success on IP ' do
+        expect(
+          described_class.send(:ip_address?, '1.2.3.4')
+        ).to be_truthy
+      end
+    end
+  end
+end

data/spec/providers/max_mind_spec.rb

@@ -0,0 +1,11 @@
+require 'ip_filter'
+require 'ip_filter/providers/max_mind'
+
+describe IpFilter::Providers::MaxMind do
+  subject { IpFilter::Providers::MaxMind.new }
+
+  it { expect respond_to(:update!).with(0).argument }
+  it { expect respond_to(:config).with(0).argument }
+  it { expect respond_to(:folder).with(0).argument }
+  it { expect respond_to(:refresh_file_list).with(0).argument }
+end

data/spec/providers/s3_spec.rb

@@ -0,0 +1,11 @@
+require 'ip_filter'
+require 'ip_filter/providers/s3'
+
+describe IpFilter::Providers::S3 do
+  it { expect respond_to(:new).with(0).argument }
+  it { expect respond_to(:upload!).with(0).argument }
+  it { expect respond_to(:create_bucket).with(0).argument }
+  it { expect respond_to(:download!).with(0).argument }
+  it { expect respond_to(:download!).with(1).argument }
+  it { expect respond_to(:refresh_file_list).with(0).argument }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+# require File.expand_path('../../rails_app/config/environment', __FILE__)
+require 'rails/all'
+require 'rspec'
+require 'rspec/rails'
+require 'ip_filter'
+
+# Load support helpers
+require 'support/enable_dallistore_cache'
+require 'support/enable_redis_cache'
+
+# Configure RSpec
+RSpec.configure do |config|
+  # config.include Rack::Test::Methods
+end
+
+# Configure IP filter gem
+IpFilter.configure do |config|
+  config.data_folder   = File.expand_path('../fixtures', __FILE__)
+  config.geo_ip_dat    = File.expand_path('../fixtures/GeoIP.dat', __FILE__)
+  config.ip_code_type  = 'country_code2'
+  config.ip_codes      = ['country_code2']
+  config.ip_whitelist  = ['127.0.0.1/24']
+  config.cache         = nil
+  config.allow_loopback = false
+  config.ip_exception  = Proc.new {
+    raise ArgumentError, ('GeoIP: IP is not in whitelist')
+  }
+end
+
+# Stub Rack::Request and preload IpFilter::Request
+# to get IP location as a request's attribute.
+Rack::Request.send :include, IpFilter::Request
+
+def action_call(controller, action, opts)
+  env = Rack::MockRequest.env_for('/', 'REMOTE_ADDR' => opts[:ip] || '127.0.0.1')
+  status, headers, body = controller.action(action).call(env)
+  ActionDispatch::TestResponse.new(status, headers, body)
+end

data/spec/support/enable_dallistore_cache.rb

@@ -0,0 +1,15 @@
+require 'dalli'
+
+module EnableDallistoreCache
+  def activate_dallistore!
+    let(:cache) { Dalli::Client.new }
+
+    before do
+      allow(IpFilter.configuration).to receive_messages(cache: cache)
+    end
+
+    after do
+      allow(IpFilter.configuration).to receive_messages(cache: nil)
+    end
+  end
+end

data/spec/support/enable_redis_cache.rb

@@ -0,0 +1,15 @@
+require 'fakeredis'
+
+module EnableRedisCache
+  def activate_redis!
+    let(:cache) { Redis.new }
+
+    before do
+      allow(IpFilter.configuration).to receive(:cache) { cache }
+    end
+
+    after do
+      allow(IpFilter.configuration).to receive(:cache) { nil }
+    end
+  end
+end