ipgeobase_mongoid 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0e5cbb09ad2be8ac852e6ea1e095ba7ce740856
+  data.tar.gz: 73494a90e0379e760c2e853bc4698e8f9159841d
+SHA512:
+  metadata.gz: d90141814628009a088cd1ea9d18232a187a760fadf4a8f8a5feaf9ea76ac1e4bab145e981b8ae718f815f9e01bd49d577f6d523d0426d307287727c96cfa052
+  data.tar.gz: e02820ebe2dc60906dd5d4beea648d2609274df1e56a7fbaa7e240e147ff2370617bd5a296d6f52febd2a0ec87d464126c71316dfffd12d771ec82deb80611fd

data/.gitignore

@@ -1 +1 @@
-/.idea
+/tmp/*

data/.ruby-gemset

@@ -0,0 +1 @@
+ipgeobase

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in ipgeobase.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    ipgeobase_mongoid (1.0.0)
+      mongoid (>= 3.0, < 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    diff-lcs (1.2.4)
+    i18n (0.6.5)
+    mongoid (3.1.4)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.5.1)
+    multi_json (1.7.9)
+    origin (1.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.1)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.21)
+  ipgeobase_mongoid!
+  rspec (>= 2.14.0)

data/README.rdoc

@@ -1,38 +1,48 @@
 = IPGeoBase
 
-Russia and Ukraine geoip lookup with DB from http://ipgeobase.ru for Mongoid 2
-Гем для работы с архивом с сайта http://ipgeobase.ru, содержащим базу местонахождений российских и украинских ip-адресов (с точностью до города) for Mongoid 2.
+Russia and Ukraine geoip lookup with DB from http://ipgeobase.ru for Mongoid 3/4
+
+WARNING: 1.0 breaks backward compatibility. For mongoid 2 use ~> 0
+
+Гем для работы с архивом с сайта http://ipgeobase.ru, содержащим базу местонахождений российских и украинских ip-адресов (с точностью до города) для MongoDB (Mongoid 3/4).
 
 == Installation
 
 (1) Add to Gemfile:
-    gem "ipgeobase_mongoid", require: 'ipgeobase'
+    gem "ipgeobase_mongoid"
 (2) Install required gems:
     bundle install
 
 == Upload new database
 
 * Update cities and regions. Downloads file if it's not present in tmp/cities.txt
-  rake ipgeobase:cities
+* city id's are not changed on DB update and can be used as foreign keys
+
+    rake ipgeobase:cities
 
 * Update geo ips. Downloads file if it's not present in tmp/cidr_optim.txt
-  rake ipgeobase:ips
+
+    rake ipgeobase:ips
 
 == Methods
 
-После того, как выполнены все предыдущие шаги можно искать регион по IP адресу:
+Search for city by IP (Russia and Ukraine only):
 
+После того, как выполнены все предыдущие шаги можно искать город по IP адресу:
 Работает только для РФ и Украины.
 
-> Ipgeobase::find_region_by_ip('95.170.177.170')
- => #<IpgeobaseCity _id: 5059d68ee779891c72000201, _type: nil, geo_id: 1428, city: "Красноярск", region: "Красноярский край", district: "Сибирский федеральный округ", lat: 56.001251, lon: 92.88559, country_id: BSON::ObjectId('5059d68de779891c72000001')>
-> Ipgeobase::find_region_by_ip('95.170.177.170').city
- => "Красноярск"
-> Ipgeobase::find_region_by_ip('95.170.177.170').region
- => "Красноярский край"
-> Ipgeobase::find_region_by_ip('95.170.177.170').district
- => "Сибирский федеральный округ"
-> Ipgeobase::find_region_by_ip('95.170.177.170').country.name
- => "Россия"
-> Ipgeobase::find_region_by_ip('95.170.177.170').country.code
- => "RU"
+    > geo = Ipgeobase::find_region_by_ip('95.170.177.170')
+    > pp geo
+    => #<Ipgeobase::City _id: 5059d68ee779891c72000201, _type: nil, geo_id: 1428, city: "Красноярск",
+        region: "Красноярский край", district: "Сибирский федеральный округ", lat: 56.001251, lon: 92.88559,
+        country_id: BSON::ObjectId('5059d68de779891c72000001')>
+    > geo.city
+    => "Красноярск"
+    > geo.region
+    => "Красноярский край"
+    > geo.district
+    => "Сибирский федеральный округ"
+    > geo.country.name
+    => "Россия"
+    > geo.country.code
+    => "RU"

data/Rakefile

@@ -1 +1,3 @@
 require "bundler/gem_tasks"
+
+load File.join(File.dirname(__FILE__), 'lib', 'ipgeobase', 'tasks.rake')

data/app/models/ipgeobase/city.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+module Ipgeobase
+  class City
+    include Mongoid::Document
+
+    field :geo_id, type: Integer
+    index({geo_id: 1}, {unique: true})
+
+    field :city, type: String
+    field :region, type: String
+    field :district, type: String
+
+    field :lat, type: Float
+    field :lon, type: Float
+
+    belongs_to :country, class_name: 'Ipgeobase::Country'
+    has_many :ips, class_name: 'Ipgeobase::Ip'
+
+    validates_presence_of :city, :country, :geo_id
+  end
+end

data/app/models/ipgeobase/country.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+module Ipgeobase
+  class Country
+    include Mongoid::Document
+
+    field :name, type: String
+    field :code, type: String
+
+    has_many :cities, class_name: 'Ipgeobase::City'
+
+    validates_presence_of :name
+  end
+end

data/app/models/ipgeobase/ip.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+module Ipgeobase
+  class Ip
+    include Mongoid::Document
+
+    field :start_ip, type: Integer
+    index({start_ip: 1}, {unique: true})
+    field :end_ip, type: Integer
+
+    belongs_to :city, class_name: 'Ipgeobase::City'
+    validates_presence_of :start_ip, :end_ip, :city_id
+  end
+end

data/ipgeobase_mongoid.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors = ["GlebTv"]
   s.email = ["glebtv@gmail.com"]
   s.homepage = "https://github.com/rs-pro/ipgeobase_mongoid"
-  s.description = "IPGeoBase.ru for mongoid 2"
-  s.summary = "IPGeoBase.ru for mongoid 2"
+  s.description = "IPGeoBase.ru for mongoid 3/4"
+  s.summary = "IPGeoBase.ru for mongoid 3/4"
 
   s.rubyforge_project = "ipgeobase_mongoid"
 
@@ -19,6 +19,9 @@ Gem::Specification.new do |s|
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_dependency "mongoid", '~> 2.4'
+  s.add_runtime_dependency('mongoid', [">= 3.0", "< 5.0"])
   s.required_ruby_version = '>= 1.9.2'
+
+  s.add_development_dependency(%q<rspec>, [">= 2.14.0"])
+  s.add_development_dependency(%q<bundler>, [">= 1.0.21"])
 end

data/lib/ipgeobase.rb

@@ -1,35 +1,30 @@
 # coding: utf-8
 
 require "ipgeobase/version"
+require 'ipaddr'
 
-module Ipgeobase
-  if defined?(Rails) && defined?(Rails::Engine)
-    class Engine < ::Rails::Engine
-    end
+if defined? Rails::Engine
+  require 'ipgeobase/engine'
+end
 
-    module Rails
-      class Railtie < ::Rails::Railtie
-      end
-    end
-  end
+if defined? Rails::Railtie
+  require 'ipgeobase/railtie'
+end
 
-  def self.find_region_by_ip(user_ip)
-    raise ArgumentError, "Must have a ip addres by template 0.0.0.0" unless user_ip =~ /^[\d\.]+$/
-    long = ip2long(user_ip)
-    ip = IpgeobaseIp.where(start_ip: { '$lte' => long }).order_by({ start_ip: -1 }).limit(1).first
-    p ip
-    if ip.nil?
-      nil
-    else
-      ip.city
+module Ipgeobase
+  class << self
+    def find_region_by_ip(user_ip)
+      long = ip2long(user_ip)
+      ip = Ipgeobase::Ip.where(start_ip: { '$lte' => long }).order_by({ start_ip: -1 }).limit(1).first
+      if ip.nil? or ip.end_ip < long
+        nil
+      else
+        ip.city
+      end
     end
-  end
 
-  def self.ip2long(ip)
-    long = 0
-    ip.split(/\./).reverse.each_with_index do |b, i|
-      long += b.to_i << (8*i)
+    def ip2long(ip)
+      IPAddr.new(ip, Socket::AF_INET).to_i
     end
-    long
   end
 end

data/lib/ipgeobase/engine.rb

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

data/lib/ipgeobase/railtie.rb

@@ -0,0 +1,8 @@
+module Ipgeobase
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "ipgeobase/tasks.rake"
+    end
+  end
+end
+

data/lib/ipgeobase/task.rb

@@ -1,17 +1,19 @@
-# coding: utf-8
-
-module Ipgeobase
-  module Task
-    def self.obtain_content_by_filename(filename)
-      file = ::Rails.root.join('tmp', filename)
-      if File.file? file
-        puts 'using local copy'
-        `iconv -f cp1251 -t utf8 #{file}`
-      else
-        puts 'downloading database'
-        url = 'http://ipgeobase.ru/files/db/Main/geo_files.tar.gz'
-        `curl -0 #{url} | tar -xzO #{file} | iconv -f cp1251 -t utf8`
-      end
-    end
-  end
-end
+# coding: utf-8
+
+module Ipgeobase
+  module Task
+    def self.obtain_content_by_filename(filename)
+      if defined? Rails
+        file = ::Rails.root.join('tmp', filename)
+      else
+        file = File.join(File.dirname(__FILE__), '..', '..', 'tmp', filename)
+      end
+      unless File.exist? file
+        puts 'downloading database'
+        url = 'http://ipgeobase.ru/files/db/Main/geo_files.tar.gz'
+        Kernel.system("curl #{url} | tar -xzOf - #{filename} | iconv -f cp1251 -t utf-8 > #{file}")
+      end
+      File.read(file)
+    end
+  end
+end

data/lib/{tasks/ipgeobase.rake → ipgeobase/tasks.rake}

@@ -5,10 +5,9 @@ require "ipgeobase/task"
 namespace :ipgeobase do
   desc "Update cities and regions. Downloads file if it's not present in tmp/cities.txt"
   task :cities => :environment do
-    IpgeobaseIp.delete_all
-    IpgeobaseCity.delete_all
-    russia = IpgeobaseCountry.find_or_create_by(name: 'Россия', code: 'RU')
-    ukraine = IpgeobaseCountry.find_or_create_by(name: 'Украина', code: 'UA')
+    puts 'updating cities'
+    russia = Ipgeobase::Country.find_or_create_by(name: 'Россия', code: 'RU')
+    ukraine = Ipgeobase::Country.find_or_create_by(name: 'Украина', code: 'UA')
     content = Ipgeobase::Task.obtain_content_by_filename('cities.txt')
     content.each_line do |c|
       options = c.split("\t")
@@ -17,24 +16,27 @@ namespace :ipgeobase do
                 else
                   russia
                 end
-      IpgeobaseCity.create!(geo_id: options[0], city: options[1], region: options[2], district: options[3], lat: options[4], lon: options[5], country: country)
+      city = Ipgeobase::City.find_or_initialize_by(geo_id: options[0])
+      city.assign_attributes(city: options[1], region: options[2], district: options[3], lat: options[4], lon: options[5], country: country)
+      city.save!
     end
   end
 
   desc "Update geo ips. Downloads file if it's not present in tmp/cidr_optim.txt"
   task :ips => :environment do
+    puts 'updating ips'
     content = Ipgeobase::Task.obtain_content_by_filename('cidr_optim.txt')
-    IpgeobaseIp.delete_all
+    Ipgeobase::Ip.delete_all
     content.each_line do |c|
       options = c.split("\t")
       next if options.last.to_i.zero?
-      city = IpgeobaseCity.where(geo_id: options.last.strip.to_i).first
+      city = Ipgeobase::City.where(geo_id: options.last.strip.to_i).first
       if city.nil?
         p "No city"
         p options
         next
       end
-      IpgeobaseIp.create(:start_ip => options.first.to_i, :end_ip => options.second.to_i, city_id: city.id)
+      Ipgeobase::Ip.create(:start_ip => options.first.to_i, :end_ip => options.second.to_i, city_id: city.id)
     end
   end
 end

data/lib/ipgeobase/version.rb

@@ -1,3 +1,3 @@
 module Ipgeobase
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/ipgeobase_mongoid.rb

@@ -0,0 +1,2 @@
+require 'ipgeobase'
+

data/spec/ipgeobase_spec.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Ipgeobase do
+  it 'finds city by ip' do
+    geo = Ipgeobase::find_region_by_ip('95.170.177.170')
+    geo.region.should eq 'Красноярский край'
+    geo.country.code.should eq 'RU'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'mongoid'
+require 'ipgeobase'
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Mongoid.configure do |config|
+  ENV["MONGOID_ENV"] = "test"
+  Mongoid.load!("spec/support/mongoid.yml")
+end
+
+require File.dirname(__FILE__) + '/../app/models/ipgeobase/city.rb'
+require File.dirname(__FILE__) + '/../app/models/ipgeobase/country.rb'
+require File.dirname(__FILE__) + '/../app/models/ipgeobase/ip.rb'
+
+Ipgeobase::City.create_indexes
+Ipgeobase::Ip.create_indexes
+
+require 'rake'
+app = Rake.application
+app.init
+# do this as many times as needed
+# app.add_import 'lib/ipgeobase/tasks.rake'
+# this loads the Rakefile and other imports
+app.load_rakefile
+app["ipgeobase:cities"].execute
+moscow_id1 = Ipgeobase::City.where(city: 'Москва').first.id
+
+app["ipgeobase:cities"].execute
+moscow_id2 = Ipgeobase::City.where(city: 'Москва').first.id
+# check that city ids are not changed on reimport
+raise 'city id changed' if moscow_id1 != moscow_id2
+
+app["ipgeobase:ips"].execute
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/support/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: ipgeobase
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

metadata

@@ -1,33 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: ipgeobase_mongoid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - GlebTv
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.4'
-description: IPGeoBase.ru for mongoid 2
+        version: 1.0.21
+description: IPGeoBase.ru for mongoid 3/4
 email:
 - glebtv@gmail.com
 executables: []
@@ -35,39 +66,51 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-gemset
+- .ruby-version
 - Gemfile
+- Gemfile.lock
 - README.rdoc
 - Rakefile
-- app/models/ipgeobase_city.rb
-- app/models/ipgeobase_country.rb
-- app/models/ipgeobase_ip.rb
+- app/models/ipgeobase/city.rb
+- app/models/ipgeobase/country.rb
+- app/models/ipgeobase/ip.rb
 - ipgeobase_mongoid.gemspec
 - lib/ipgeobase.rb
+- lib/ipgeobase/engine.rb
+- lib/ipgeobase/railtie.rb
 - lib/ipgeobase/task.rb
+- lib/ipgeobase/tasks.rake
 - lib/ipgeobase/version.rb
-- lib/tasks/ipgeobase.rake
+- lib/ipgeobase_mongoid.rb
+- spec/ipgeobase_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.yml
+- tmp/.gitkeep
 homepage: https://github.com/rs-pro/ipgeobase_mongoid
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: ipgeobase_mongoid
-rubygems_version: 1.8.22
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
-summary: IPGeoBase.ru for mongoid 2
-test_files: []
+specification_version: 4
+summary: IPGeoBase.ru for mongoid 3/4
+test_files:
+- spec/ipgeobase_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.yml

data/app/models/ipgeobase_city.rb

@@ -1,21 +0,0 @@
-# coding: utf-8
-
-class IpgeobaseCity
-  include Mongoid::Document
-
-  field :geo_id, type: Integer
-  index :geo_id
-
-  field :city, type: String
-  field :region, type: String
-  field :district, type: String
-
-  field :lat, type: Float
-  field :lon, type: Float
-
-
-  belongs_to :country, class_name: 'IpgeobaseCountry'
-  has_many :ips, class_name: 'IpgeobaseIp'
-
-  validates_presence_of :city, :country, :geo_id
-end

data/app/models/ipgeobase_country.rb

@@ -1,12 +0,0 @@
-# coding: utf-8
-
-class IpgeobaseCountry
-  include Mongoid::Document
-
-  field :name, type: String
-  field :code, type: String
-
-  has_many :cities, class_name: 'IpgeobaseCity'
-
-  validates_presence_of :name
-end

data/app/models/ipgeobase_ip.rb

@@ -1,11 +0,0 @@
-# coding: utf-8
-
-class IpgeobaseIp
-  include Mongoid::Document
-
-  field :start_ip, type: Integer
-  field :end_ip, type: Integer
-
-  belongs_to :city, class_name: 'IpgeobaseCity'
-  validates_presence_of :start_ip, :end_ip, :city_id
-end