freegeoip-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df91150c1279ff29613c0169914cd73c8163bd09068c200382a5833d0efe3f22
+  data.tar.gz: c89707641b2ce7cc3c27ea4ab0a0b4d93c52c315c289e162d2ae8aabec218872
+SHA512:
+  metadata.gz: 77c7ef528044946767eab99403e395a1955b3173c83158e1a87836f803329e5d5cec4b27b9c61df344b6ba9e812a205fe365b4b866162b884bc0206bc4a11b4c
+  data.tar.gz: 9f7cf21e4f5bc808bde053b810babeb86c74f6bcb3681e1cd8b3cc9afaf6d686b8053b193f7729ebdcee6fb1c25231c22a0137177b55b5c8bed57fc5bace8710

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Varvet AB
+
+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.md

@@ -0,0 +1,49 @@
+[![Build status](https://travis-ci.org/varvet/freegeoip-rails.svg?branch=master)](https://travis-ci.org/varvet/freegeoip-rails)
+
+# Freegeoip
+
+This gem provides a simple Rails engine with an IP geolocation API that ducks with [Freegeoip](https://github.com/fiorix/freegeoip).
+
+It reads MaxMindDB's open source GeoLite2 City database, with the help of [maxminddb](https://github.com/yhirose/maxminddb) gem, a pure Ruby implementation.
+
+You can find MaxMind's GeoLite2 City database [here](https://dev.maxmind.com/geoip/geoip2/geolite2/).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "freegeoip-rails", require: "freegeoip"
+```
+
+Mount the engine in your routes file:
+
+```ruby
+  mount Freegeoip::Engine, at: "/json"
+```
+
+Add an initializer like `config/initializers/freegeoip.rb` and tell the engine where it can find your GeoLite2 City database:
+
+```ruby
+  Freegeoip.configure do |config|
+    # Anything that can be opened by OpenURI
+    config.db_location = Rails.root.join "vendor/maxminddb/GeoLite2-City.mmdb"
+  end
+```
+
+Start your web server and point your browser to `http://localhost:3000/json/www.ruby-lang.org` or `http://localhost:3000/json/151.101.1.178` and you should get a response with JSON data.
+
+## Contributing
+
+Contributions are always welcome.
+
+
+## Varvet
+
+Crafted with love at [Varvet](https://www.varvet.com/).
+Skapad med omsorg av [Varvet digital byrå](https://www.varvet.se/).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/freegeoip/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Freegeoip
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/freegeoip/lookups_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Freegeoip
+  class LookupsController < ApplicationController
+    def show
+      if result = Freegeoip::Lookup.hostname_or_ip(params[:hostname_or_ip])
+        render json: result
+      else
+        render body: "404 page not found", status: 404
+      end
+    end
+  end
+end

data/app/models/freegeoip/lookup.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "resolv"
+require "maxminddb"
+require "open-uri"
+
+module Freegeoip
+  class Lookup
+    def self.hostname_or_ip(string, locale = "en")
+      ip = resolve string.to_s
+
+      return nil unless ip
+
+      result = lookup(ip)
+
+      return nil if result.empty?
+
+      {
+        ip: ip,
+        country_code: result.dig("country", "iso_code"),
+        country_name: result.dig("country", "names", locale),
+        region_code: result.dig("subdivisions", 0, "iso_code"),
+        region_name: result.dig("subdivisions", 0, "names", locale),
+        city: result.dig("city", "names", locale),
+        zip_code: result.dig("postal", "code"),
+        time_zone: result.dig("location", "time_zone"),
+        latitude: result.dig("location", "latitude"),
+        longitude: result.dig("location", "longitude"),
+        metro_code: (result.dig("location", "metro_code") || 0),
+      }
+    end
+
+    private
+    def self.resolve(string)
+      return string if string =~ Resolv::IPv4::Regex
+      Resolv.getaddress string
+    rescue Resolv::ResolvError
+      nil
+    end
+
+    def self.lookup(ip)
+      db.lookup(ip).to_hash
+    end
+
+    def self.db
+      return @db if instance_variable_defined?("@db")
+      @db = MaxMindDB.new read_db
+    end
+
+
+    def self.read_db
+      if Freegeoip.config.db_location
+        open Freegeoip.config.db_location
+      else
+        raise Freegeoip::ConfigError, "GeoLite2-City database location not configured"
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Freegeoip::Engine.routes.draw do
+  resources :lookups, only: :show, param: :hostname_or_ip, format: false
+  get "/*hostname_or_ip", to: "lookups#show", format: false
+end

data/lib/freegeoip.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "freegeoip/engine"
+
+module Freegeoip
+  autoload :Config, 'freegeoip/config'
+
+  class ConfigError < StandardError; end
+
+  def self.configure(&block)
+    Config.configure(&block)
+  end
+
+  def self.config
+    Config
+  end
+end

data/lib/freegeoip/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Freegeoip
+  module Config
+    extend self
+
+    attr_accessor :db_location, :param_name
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/freegeoip/engine.rb

@@ -0,0 +1,5 @@
+module Freegeoip
+  class Engine < ::Rails::Engine
+    isolate_namespace Freegeoip
+  end
+end

data/lib/freegeoip/version.rb

@@ -0,0 +1,3 @@
+module Freegeoip
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: freegeoip-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ingemar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Rails engine that provides an IP geolocation API that ducks with Freegeoip
+email:
+- ingemar@xox.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/freegeoip/application_controller.rb
+- app/controllers/freegeoip/lookups_controller.rb
+- app/models/freegeoip/lookup.rb
+- config/routes.rb
+- lib/freegeoip.rb
+- lib/freegeoip/config.rb
+- lib/freegeoip/engine.rb
+- lib/freegeoip/version.rb
+homepage: https://varvet.com
+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.4
+signing_key: 
+specification_version: 4
+summary: Rails engine with IP geolocation API like Freegeoip
+test_files: []