ip_filter 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d1ba59fc5df3909b9e00d5e6d920ed3ed310336
+  data.tar.gz: 4f970604687e630ae7bcaace9aa8cf53bf1245bd
+SHA512:
+  metadata.gz: ccffe9b88880990d11a0196437b7972f2f8cb024454166799909ab13d76ab2d56d444c151a77bf7d2933525ffade02031ab42c22654475021dc29412ffd40c4a
+  data.tar.gz: 0d97e6c882d15a45b0a979cdc4ffe91732c8400177aef2b3b5ed2f05761ce1e154db193426c988d445a25cf746339059b3ce917fe010dbd57258ba47eded0854

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+rdoc/*
+*.gem
+.bundle
+spec/log/*

data/.rspec

@@ -0,0 +1 @@
+--color --format Fuubar

data/CHANGELOG

@@ -0,0 +1,29 @@
+IpFilter
+
+v0.7.2
+
+All cached objects return an OpenStruct.
+
+v0.7.1
+
+Fix bad ip adress definition (remote_ip = nil)
+
+v0.7.0
+
+Add missing tests
+Enhance Configuration handling
+Clean debug messages
+
+v0.6.0
+
+Fix bug with cache
+
+v0.0.4
+============================================
+Add Redis handling for caching.
+Add S3 Download/Upload for GeoipDat files
+Use geoipupdate to update GeoIp databases
+
+v0.0.3
+============================================
+Add IP range support - Thanks Ihor!

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    ip_filter (0.8.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (4.2.3)
+      actionview (= 4.2.3)
+      activesupport (= 4.2.3)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    aws-sdk (2.1.2)
+      aws-sdk-resources (= 2.1.2)
+    aws-sdk-core (2.1.2)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.1.2)
+      aws-sdk-core (= 2.1.2)
+    aws-sdk-v1 (1.64.0)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+    builder (3.2.2)
+    dalli (2.7.4)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    fakeredis (0.5.0)
+      redis (~> 3.0)
+    fuubar (2.0.0)
+      rspec (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    i18n (0.7.0)
+    jmespath (1.0.2)
+      multi_json (~> 1.0)
+    json (1.8.3)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    multi_json (1.11.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.3)
+      actionpack (= 4.2.3)
+      activesupport (= 4.2.3)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    redis (3.2.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-rails (3.3.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    ruby-progressbar (1.7.5)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  aws-sdk
+  aws-sdk-v1
+  dalli
+  fakeredis
+  fuubar
+  ip_filter!
+  rspec
+  rspec-rails
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-11 Alex Reisner
+
+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.rdoc

@@ -0,0 +1,232 @@
+= IpFilter
+
+IpFilter is IP filtering solution for Ruby. Common use case for this is DRM.
+Uses a GeoIP (or Geo::IP) database to determine the request ip's location.
+
+
+== Compatibility
+
+* Supports Ruby version: 1.9.2 to 2.2.0
+* Supports cache store: Memcache, Redis.
+* Supports Rails 3.
+
+
+== Install
+
+=== As a Gem
+
+Add to your Gemfile:
+
+  gem "ip_filter"
+
+and run at the command prompt:
+
+  bundle install
+
+
+=== Or As a Plugin
+
+At the command prompt:
+
+  rails plugin install git://github.com/chtrinh/ip_filter.git
+
+
+== Typical Rails Configuration
+
+  # config/initializers/ip_filter.rb
+
+  IpFilter.configure do |config|
+    # Location of GeoIP database files.
+    config.data_folder = "lib/assets/"
+
+    # Level of filtering : Country, city...
+    config.geoip_level = 'country'
+
+    # Type of ip country code to compare by.
+    config.ip_code_type = "country_code2"
+
+    # Accepts a proc that must return an array with corresponding format as :ip_code_type
+    config.ip_codes = Proc.new { ["FI", "US", "GB"] }
+
+    # Accepts a proc that must return an array of IPs or IP range to
+    config.ip_whitelist = Proc.new { ["22.33.11.0/24", "2.3.1.4"] }
+
+    # Exception to throw when IP is NOT allowed.
+    # Accepts a Proc for fine-grain control of the appropriate response.
+    config.ip_exception = Proc.new { raise Api::Exception::AuthorizationError.new("You region is blocked!") }
+
+    # Cache object (Memcache or Redis).
+    config.cache = Rails.cache
+
+    ## MaxMind binary require a configuration file.
+    # If empty,
+    # Configuration path for geoipupdate binary
+    config.geoipupdate_config = '/usr/local/etc/GeoIP.conf'
+
+    ## S3 credentials ##
+    # if access_key_id is nil, S3 isn't loaded.
+    config.access_key_id = nil
+
+    # S3 Secret API key
+    config.secret_access_key = nil
+
+    # S3 bucket name
+    config.bucket_name = 'ottsm-geoip'
+  end
+
+=== Default Values
+
++data_folder+           : "/tmp/geoip"
+
++geo_ip_dat+            : data/GeoIP.dat
+
++geoip_level+           : :country
+
++update_method+         : Proc {}
+
++ip_code_type+          : nil
++ip_codes+              : Proc {}
+
++ip_whitelist+          : Proc {}
+
++ip_exception+          : Proc {}
+
++allow_loopback+        : true
+
++cache+                 : nil
+
++cache_prefix+          : 'ip_filter:'
+
++geoipupdate_config+    : '/usr/local/etc/GeoIP.conf'
+
++s3_access_key_id+      : nil
+
++s3_secret_access_key+  : nil
+
++s3_bucket_name+        : 'ip_filter-geoip'
+
++refresh_delay+         : 86400
+
+== Whitelist Ip
+
+See above configuration.
+
+== Validate IP
+
+Add the following method to any controller to validate the <tt>Request#ip</tt>.
+<tt>IpFilter::Configuration.ip_exception</tt> is a +Proc+ which is called when ip is NOT within the specified region/country code and NOT in IP whitelist. You can pass in filter options similar to those in +before_filter+.
+
+  validate_ip
+
+You can also pass a block (with filter options) to be executed when validation of ip fails like so (defaults to <tt>IpFilter::Configuration.ip_exception</tt> proc if no block present):
+
+  validate_ip do
+    raise Exception.new "Sorry access not granted!"
+  end
+
+By default, loopback/private network addresses are allowed. You can disable this in like so:
+
+  #config/initializers/ip_filter.rb
+
+  IpFilter.configure do |config|
+    config.allow_loopback = false
+  end
+
+
+== Skip validation of IP
+
+Add the following method to any controller that contains <tt>validate_ip</tt> to skip over the
+validation.
+
+  skip_validate_ip
+
+Internally it is just <tt>skip_before_filter</tt> so filter options can be pass to it as well.
+
+  skip_validate_ip :only => [:index, :show], :if => lambda { account.roles == "admin" }
+
+
+== Request Geocoding by IP Address
+
+IpFilter adds a +location+ method to the standard <tt>Rack::Request</tt> object so you can easily look up the location of any HTTP request by IP address. For example, in a Rails controller:
+
+  # returns IpFilter::Result object
+  result = request.location
+
+See "Advanced Geocoding" below for more information about IpFilter::Result objects.
+
+
+== Advanced Geocoding
+
+So far we have looked at shortcuts for assigning geocoding results to object attributes.
+
+Every <tt>IpFilter::Result</tt> object, +result+, provides the following data:
+
+* <tt>result.ip</tt> - string
+* <tt>result.country_code</tt> - string
+* <tt>result.country_code2</tt> - string
+* <tt>result.country_code3</tt> - string
+* <tt>result.country_name</tt> - string
+* <tt>result.continent_code</tt> - string
+
+== Update Geoip database files
+
+To update Geoip database file, you just have to instantiate :
+
+  IpFilter::Providers::MaxMind.new
+
+This will update files located in <tt>IpFilter::Configuration.data_folder</tt>
+
+== S3
+
+The database files could also be uploaded or downloaded from S3.
+
+Upload to S3 :
+
+  IpFilter.s3.upload!
+
+Download from s3 :
+
+  IpFilter.s3.download!
+
+  These actions could be done exclusively if you provide you access key ID
+  and your secret access key in IpFilter configuration.
+
+== Caching
+
+It's easy to cache ip results with IpFilter, just configure a cache store:
+
+  IpFilter.configure do |config|
+    config.cache = Rails.cache
+  end
+
+Currently only Memcache and redis are supported.
+
+You can also set a custom prefix to be used for cache keys:
+
+  IpFilter.configure do |config|
+    config.cache_prefix = "whatever:"
+  end
+
+By default the prefix is <tt>ip_filter:</tt>
+
+<i>Before you implement caching in your app please be sure that doing so does not violate the Terms of Service for your geocoding service.</i>
+
+
+== Use Outside of Rails
+
+You can use IpFilter outside of Rails by calling the <tt>IpFilter.search</tt> method:
+
+  results = IpFilter.search("147.243.3.83")
+
+This returns an array of <tt>IpFilter::Result</tt> objects. Please see above and in the code for details.
+
+== Contributors
+
+Jeremy Le Massu
+
+Based on Chris Trinh gem, helped by Ihor Ratsyborynskyy.
+
+== Acknowledgements
+
+The architecture/design of this gem is heavily based off of Geocoder (by Alex Reisner https://github.com/alexreisner/geocoder).
+Whereas Geocoder was built with 3rd party API resources in mind, IpFilter uses a local database file (.dat) similar to Geoip (by Clifford Heath https://github.com/cjheath/geoip).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/data/geoip/country_code.yml

@@ -0,0 +1,255 @@
+# Ordered list of the ISO3166 2-character country codes, ordered by GeoIP ID
+--- 
+- --
+- AP
+- EU
+- AD
+- AE
+- AF
+- AG
+- AI
+- AL
+- AM
+- AN
+- AO
+- AQ
+- AR
+- AS
+- AT
+- AU
+- AW
+- AZ
+- BA
+- BB
+- BD
+- BE
+- BF
+- BG
+- BH
+- BI
+- BJ
+- BM
+- BN
+- BO
+- BR
+- BS
+- BT
+- BV
+- BW
+- BY
+- BZ
+- CA
+- CC
+- CD
+- CF
+- CG
+- CH
+- CI
+- CK
+- CL
+- CM
+- CN
+- CO
+- CR
+- CU
+- CV
+- CX
+- CY
+- CZ
+- DE
+- DJ
+- DK
+- DM
+- DO
+- DZ
+- EC
+- EE
+- EG
+- EH
+- ER
+- ES
+- ET
+- FI
+- FJ
+- FK
+- FM
+- FO
+- FR
+- FX
+- GA
+- GB
+- GD
+- GE
+- GF
+- GH
+- GI
+- GL
+- GM
+- GN
+- GP
+- GQ
+- GR
+- GS
+- GT
+- GU
+- GW
+- GY
+- HK
+- HM
+- HN
+- HR
+- HT
+- HU
+- ID
+- IE
+- IL
+- IN
+- IO
+- IQ
+- IR
+- IS
+- IT
+- JM
+- JO
+- JP
+- KE
+- KG
+- KH
+- KI
+- KM
+- KN
+- KP
+- KR
+- KW
+- KY
+- KZ
+- LA
+- LB
+- LC
+- LI
+- LK
+- LR
+- LS
+- LT
+- LU
+- LV
+- LY
+- MA
+- MC
+- MD
+- MG
+- MH
+- MK
+- ML
+- MM
+- MN
+- MO
+- MP
+- MQ
+- MR
+- MS
+- MT
+- MU
+- MV
+- MW
+- MX
+- MY
+- MZ
+- NA
+- NC
+- NE
+- NF
+- NG
+- NI
+- NL
+- "NO"
+- NP
+- NR
+- NU
+- NZ
+- OM
+- PA
+- PE
+- PF
+- PG
+- PH
+- PK
+- PL
+- PM
+- PN
+- PR
+- PS
+- PT
+- PW
+- PY
+- QA
+- RE
+- RO
+- RU
+- RW
+- SA
+- SB
+- SC
+- SD
+- SE
+- SG
+- SH
+- SI
+- SJ
+- SK
+- SL
+- SM
+- SN
+- SO
+- SR
+- ST
+- SV
+- SY
+- SZ
+- TC
+- TD
+- TF
+- TG
+- TH
+- TJ
+- TK
+- TM
+- TN
+- TO
+- TL
+- TR
+- TT
+- TV
+- TW
+- TZ
+- UA
+- UG
+- UM
+- US
+- UY
+- UZ
+- VA
+- VC
+- VE
+- VG
+- VI
+- VN
+- VU
+- WF
+- WS
+- YE
+- YT
+- RS
+- ZA
+- ZM
+- ME
+- ZW
+- A1
+- A2
+- O1
+- AX
+- GG
+- IM
+- JE
+- BL
+- MF