ip_lookup 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fc773650faa6ffc425dca036e1e2ca80bacafd51548eb16754720ca8c5b07ec
+  data.tar.gz: b260b88a05a4366df81d10a5d44271c8d7c11d0650c3997d76e242d64003f3f2
+SHA512:
+  metadata.gz: 4b2c9138cde92e92ef7e795a3845c5e8a4fb097b7a236d83085cd00ef9270be86d32adc780c4b538d27594736dcd80aff82c2b04f07de46cc76ad01ef6daab6e
+  data.tar.gz: 3dec5779bc48e845223983eacc66050abc6e5e37e6d78d7f6c6f94ec616fbc932982555c777e6ff9e7c6fe6fb699ef2b040f6c482bbe1459ce97bc7680900ed2

data/README.md

@@ -0,0 +1,73 @@
+# IPLookup
+
+IPLookup uses [GeoIP2 MaxMind DB](http://maxmind.github.io/MaxMind-DB/) to lookup the country, timezone, coordinates and subdivision for a given ip address.
+
+## Dependencies
+
+* Uses the gem [maxminddb](https://github.com/yhirose/maxminddb) as a database reader.
+* Uses the gem [TZInfo](https://github.com/tzinfo/tzinfo) for timezone lookup.
+* Uses the gem [Zlib](https://github.com/ruby/zlib) to decompress database file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ip_lookup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ip_lookup
+
+### Configuration
+
+Before using the gem the db file needs to be downloaded / updated. 
+
+
+```ruby
+# download / update database
+IPLookup.DB.update update_period: 30, update_uri: "http://path_to_database_GeoLite2-City.mmdb.gz"
+```
+
+- default update_period (in days): 30
+- default update_uri: http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
+
+*NOTE: The gem provides a RubyGems post-install hook to download / update the db.*
+
+### Usage
+
+```ruby
+ip_lookup = IPLookup.new "213.61.214.178", silent_exceptions: false
+
+ip_lookup.country 
+# => "de"
+
+ip_lookup.timezone
+# => "Europe/Berlin"
+
+ip_lookup.coordinates
+# => [51.2993, 9.491]
+
+ip_lookup.subdivision
+# => "be"
+```
+
+*Defaults:*
+- silent_exceptions: false
+
+## Development
+
+After checking out the repo, run bin/setup to install dependencies. Then, run `rake spec` to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
+
+To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IPLookup project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/blinkist/ip-lookup/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new :spec
+
+task default: %i[rubocop spec]

data/lib/ip-lookup.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "maxminddb"
+require "tzinfo"
+
+require_relative "ip_lookup/db"
+require_relative "ip_lookup/defaults"
+require_relative "ip_lookup/errors"
+
+class IPLookup
+  attr_reader :result
+  attr_reader :silent_exceptions
+
+  def initialize(ip_address, silent_exceptions: false)
+    @silent_exceptions = silent_exceptions
+    @result = DB.new(silent_exceptions).lookup(ip_address)
+  end
+
+  def country
+    error_handler(DEFAULT_COUNTRY) do
+      iso_code = result.country.iso_code
+      iso_code ? iso_code.downcase : DEFAULT_COUNTRY
+    end
+  end
+
+  def timezone
+    error_handler(DEFAULT_TIMEZONE) do
+      timezone = result.location.time_zone
+
+      timezone ||= timezone_for result.country.iso_code if result.country.iso_code
+
+      timezone || DEFAULT_TIMEZONE
+    end
+  end
+
+  def coordinates
+    error_handler(DEFAULT_COORDINATES) do
+      [result.location.latitude, result.location.longitude]
+    end
+  end
+
+  def subdivision
+    error_handler(DEFAULT_SUBDIVISION) do
+      result.subdivisions.any? ? result.subdivisions.first.iso_code.downcase : DEFAULT_SUBDIVISION
+    end
+  end
+
+  private
+
+  def timezone_for(iso_code)
+    tz = TZInfo::Country.get iso_code
+    tz.zone_identifiers.first if tz.zone_identifiers.any?
+  end
+
+  def error_handler(default)
+    result&.found? ? yield : default
+  rescue IPAddr::InvalidAddressError, IPAddr::AddressFamilyError
+    raise e unless silent_exceptions
+
+    default
+  end
+end

data/lib/ip_lookup/db.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "zlib"
+require "net/http"
+
+class IPLookup
+  class DB
+    DEFAULT_UPDATE_PERIOD_IN_DAYS = 30
+    DEFAULT_UPDATE_URI = "https://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz"
+
+    attr_reader :silent_exceptions
+
+    def initialize(silent_exceptions)
+      @silent_exceptions = silent_exceptions
+    end
+
+    def lookup(ip_address)
+      db.lookup ip_address
+    rescue Errno::ENOENT
+      raise DBFileNotFoundError, "Couldn't find DB file. Please update DB before using lookup." unless silent_exceptions
+    end
+
+    def self.mutex
+      @mutex ||= Mutex.new
+    end
+
+    private
+
+    def db
+      self.class.mutex.synchronize do
+        @db ||= begin
+          MaxMindDB.new self.class.db_path
+        end
+      end
+    end
+
+    class << self
+      def update(update_period: DEFAULT_UPDATE_PERIOD_IN_DAYS, update_uri: DEFAULT_UPDATE_URI)
+        return unless update_db? update_period
+
+        save_db fetch_db(update_uri)
+      end
+
+      def fetch_db(update_uri)
+        uri = URI(update_uri)
+
+        response = Net::HTTP.get(uri)
+
+        sio_response = StringIO.new(response)
+        gz = Zlib::GzipReader.new(sio_response)
+        gz.read
+      end
+
+      def save_db(result)
+        File.open(db_path, 'w') do |file|
+          flock(file) do |f|
+            f.write(result)
+          end
+        end
+      end
+
+      def flock(file)
+        # return and don't update db if file is locked, because db is already been updated
+        return unless file.flock(File::LOCK_EX | File::LOCK_NB)
+
+        if file.flock(File::LOCK_EX)
+          begin
+            yield file
+          ensure
+            file.flock(File::LOCK_UN)
+          end
+        end
+      end
+
+      def update_db?(update_period)
+        !db_exists? || (update_period >= 0 && db_age > update_period)
+      end
+
+      def db_exists?
+        File.file? db_path
+      end
+
+      def db_age
+        (Time.now - File.mtime(db_path)) / (24 * 60 * 60)
+      end
+
+      def db_path
+        File.join(Gem.loaded_specs["ip_lookup"].full_gem_path, "/support/geolite-city.mmdb")
+      end
+    end
+  end
+end

data/lib/ip_lookup/defaults.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class IPLookup
+  DEFAULT_COUNTRY = "us"
+  DEFAULT_TIMEZONE = "America/Swift_Current"
+  DEFAULT_COORDINATES = [40.0, 74.0].freeze # NYC
+  DEFAULT_SUBDIVISION = nil
+end

data/lib/ip_lookup/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class IPLookup
+  class DBFileNotFoundError < StandardError; end
+end

data/lib/ip_lookup/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class IPLookup
+  VERSION = "1.0.1"
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,9 @@
+require_relative "ip_lookup"
+
+Gem.post_install do
+  puts "Started IPLookup database update."
+
+  IpLookup.DB.update
+
+  puts "Finished IPLookup database update."
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: ip_lookup
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Ole Richter
+- Tomek Poderski
+- Sebastian Schleicher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: maxminddb
+  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: tzinfo
+  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: zlib
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: IPLookup uses GeoIP2 MaxMind DB to lookup the country, timezone, coordinates
+  and locale for ip adresses.
+email:
+- ole@blinkist.com
+- tomek@blinkist.com
+- sj@blinkist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/ip-lookup.rb
+- lib/ip_lookup/db.rb
+- lib/ip_lookup/defaults.rb
+- lib/ip_lookup/errors.rb
+- lib/ip_lookup/version.rb
+- lib/rubygems_plugin.rb
+homepage: https://github.com/blinkist/ip-lookup
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7.7
+signing_key: 
+specification_version: 4
+summary: IPLookup uses GeoIP2 MaxMind DB to lookup the country, timezone, coordinates
+  and locale for ip adresses.
+test_files: []