pin_point 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzM2NjVlMmVlY2IxZmYwNDc1MDhhODQ5OWY2YzY2ZmNkZjVjMDFhNA==
+  data.tar.gz: !binary |-
+    YTU1ZmY2NDEzZDYyNjQ4ZjEzMjc1YmMyZDg2YWZjNjBiYzdmNDczYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmEwMTRkZGI5OWMxZTdiOWVhODNlZWZjNDI5MjZhZDQ4MjhmMTdjZjgyZDE3
+    NjcwYTc3OWY0ZThiNTQ2YzdiZWMxNzAwMDgzOTNlODQ3YWQ2MWMyMjNhZjcz
+    YzAzNjNmZjZjNGU5ZjEwMGNiYzdmMjMxZDhiZmYwNjMzMTFiZmU=
+  data.tar.gz: !binary |-
+    YzRhYzYyZjEyZDk5MjU3NzQwYTVkOTVhOGU2MjBmYjQzMmY1NjczM2UyZTg1
+    MmNmNDQyYWVkYzk0NGMxYmMzYjgwMmRiZjA1Y2YwY2I1MTkwMTU3NzFkYWNk
+    ZDQ5NzI5NTc1M2RiMDIyZDAyODZjNWQ1ZTUzZjU5MmQ3MWE1MGY=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Ross Cohen, John Cihocki
+
+MIT License
+
+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,51 @@
+# PinPoint
+
+Pinpoint a users location by their IP address.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pin_point'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pin_point
+
+## Usage
+
+To import the IP Block and location mapping data just run the provided rake task in your apps root directory:
+
+  $ rake pin_point:import
+
+Be aware that this imports over 2 million IP Blocks and then maps each of them to a location. This operation takes a while ( 30+ minutes ), even on fast machines.
+
+Once the data is all imported you can look up blocks based on IP strings:
+
+``` ruby
+PinPoint.ip '173.194.43.1'
+=># <PinPoint::IpBlock _id: 51e5ec3fbe8a5cbd5417c2ee,
+  #  range_low: 2915172352,
+  #  range_high: 2915197695,
+  #  location: 2703,
+  #  coordinates: [-122.0574, 37.4192],
+  #  city: "Mountain View",
+  #  state: "CA",
+  #  country: "US"> 
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See LICENSE.txt

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/pin_point/ip_block.rb

@@ -0,0 +1,46 @@
+require 'mongoid'
+
+module PinPoint
+  
+  class IpBlock
+    
+    include Mongoid::Document
+    
+    field :range_low, type: Integer
+    field :range_high, type: Integer
+    field :location, type: Integer
+    field :coordinates, type: Array, default: []
+    field :city, type: String
+    field :state, type: String
+    field :country, type: String  
+
+    index range_low: -1
+    index location: 1
+    
+    class << self
+      
+      def for_ip ip
+        val = ip_to_int ip
+        maybe = where( :range_low.lte => val ).order_by( [[:range_low, :desc]] ).first
+        if maybe.try( :range_high ).to_i >= val
+          return maybe
+        end
+        nil
+      end
+      
+      private
+        
+        def ip_to_int ip
+          val = 0
+          ip.split( "." ).inject( 3 ) do |exp, octet|
+            val += (octet.to_i  * (256 ** exp))
+            next exp - 1
+          end
+          val
+        end
+        
+    end
+    
+  end
+  
+end

data/lib/pin_point/railtie.rb

@@ -0,0 +1,12 @@
+require 'pin_point'
+require 'rails'
+
+module PinPoint
+  
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "#{File.dirname(__FILE__)}/tasks/pin_point.rake"
+    end
+  end
+  
+end

data/lib/pin_point/tasks/pin_point.rake

@@ -0,0 +1,111 @@
+require 'csv'
+require 'net/http'
+require 'zip/zipfilesystem'
+
+namespace :pin_point do
+  
+  task :import => :environment do
+    
+    TIME = Time.now.to_i
+    ZIP_FILE = "/tmp/pin_point_data_#{TIME}.zip"
+    BLOCK_FILE = "/tmp/pin_point_block_#{TIME}.csv"
+    LOCATION_FILE = "/tmp/pin_point_location_#{TIME}.csv"
+    REMOTE_DATA_DOMAIN = 'geolite.maxmind.com'
+    REMOTE_DATA_PATH = '/download/geoip/database/GeoLiteCity_CSV/GeoLiteCity-latest.zip'
+    
+    puts "Sourcing data..."
+    
+    Net::HTTP.start REMOTE_DATA_DOMAIN do |http|
+      response = http.get REMOTE_DATA_PATH
+      open ZIP_FILE, 'wb' do |file|
+        file.write response.body
+      end
+    end
+    
+    puts "Unzipping..."
+    
+    Zip::ZipFile.open ZIP_FILE do |zipfile|
+      zipfile.each do |file|
+        case file.name
+        when /block/i
+          zipfile.extract file.name, BLOCK_FILE
+        when /location/i
+          zipfile.extract file.name, LOCATION_FILE
+        end
+      end
+    end
+    
+    puts "Removing old IP Block data..."
+    
+    PinPoint::IpBlock.delete_all
+    
+    puts "Dropping existing indexes..."
+    
+    PinPoint::IpBlock.remove_indexes
+    
+    puts "Generating new indexes..."
+    
+    PinPoint::IpBlock.create_indexes
+    
+    puts "Importing IP Block data. This will take a while..."
+    
+    import_start = ip_block_start = Time.now
+    open BLOCK_FILE, 'r' do |file|
+      while line = file.gets
+        if $. > 2
+          begin
+            row = CSV.parse_line( line.force_encoding('UTF-8').chars.select{|i| i.valid_encoding?}.join, col_sep: ',' )
+          rescue CSV::MalformedCSVError
+            Rails.logger.debug "Failed to parse: #{line}\n#{$!.message}"
+          else
+            PinPoint::IpBlock.create({
+              range_low: row[0].to_i,
+              range_high: row[1].to_i,
+              location: row[2].to_i
+            })
+          end
+          if ($. - 2) % 100000 == 0
+            now = Time.now
+            current_count = ($. - 2)
+            per_second = ($. - 2) / ( ( now - ip_block_start ) / 1.second )
+            seconds = ( now - ip_block_start ) % 1.minute
+            minutes = ( now - ip_block_start ) / 1.minute
+            puts "%d blocks imported in %d minutes, %d seconds. %.2f blocks/s ..." % [ current_count, minutes, seconds, per_second ]
+          end
+        end
+      end
+    end
+    
+    puts "Mapping location data to IP Blocks..."
+    
+    location_start = Time.now
+    open LOCATION_FILE, 'r' do |file|
+      while line = file.gets
+        if $. > 2
+          begin
+            row = CSV.parse_line( line.force_encoding('UTF-8').chars.select{|i| i.valid_encoding?}.join, col_sep: ',' )
+          rescue CSV::MalformedCSVError
+            Rails.logger.debug "Failed to parse: #{line}\n#{$!.message}"
+          else
+            PinPoint::IpBlock.where( location: row[0].to_i ).update_all({
+              country: row[1],
+              state: row[2],
+              city: row[3],
+              coordinates: [row[6].to_f, row[5].to_f]
+            })
+          end
+          if ($. - 2) % 100000 == 0
+            now = Time.now
+            current_count = ($. - 2)
+            per_second = ($. - 2) / ( ( now - location_start ) / 1.second )
+            seconds = ( now - location_start ) % 1.minute
+            minutes = ( now - location_start ) / 1.minute
+            puts "%d locations mapped in %d minutes, %d seconds. %.2f locations/s ..." % [ current_count, minutes, seconds, per_second ]
+          end
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/pin_point/version.rb

@@ -0,0 +1,3 @@
+module PinPoint
+  VERSION = "0.0.1"
+end

data/lib/pin_point.rb

@@ -0,0 +1,15 @@
+require "pin_point/railtie" if defined?(Rails)
+require "pin_point/version"
+require "pin_point/ip_block"
+
+module PinPoint
+  
+  class << self
+    
+    def ip ip
+      IpBlock.for_ip ip
+    end
+    
+  end
+  
+end

data/pin_point.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pin_point/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pin_point"
+  spec.version       = PinPoint::VERSION
+  spec.authors       = ["Adam Ross Cohen", "John Cihocki"]
+  spec.email         = ["ross@startupgiraffe.com", "john@startupgiraffe.com"]
+  spec.description   = %q{Pinpoint a users location by their IP address.}
+  spec.summary       = %q{pin_point imports publicly available data about IP Blocks and their corresponding locations into mongodb. Once the dataset is imported lookups by IP address return associated location data.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mongoid"
+  spec.add_dependency "rake"
+  spec.add_dependency "rubyzip"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: pin_point
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Ross Cohen
+- John Cihocki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  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: rake
+  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: rubyzip
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Pinpoint a users location by their IP address.
+email:
+- ross@startupgiraffe.com
+- john@startupgiraffe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pin_point.rb
+- lib/pin_point/ip_block.rb
+- lib/pin_point/railtie.rb
+- lib/pin_point/tasks/pin_point.rake
+- lib/pin_point/version.rb
+- pin_point.gemspec
+homepage: ''
+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.0.5
+signing_key: 
+specification_version: 4
+summary: pin_point imports publicly available data about IP Blocks and their corresponding
+  locations into mongodb. Once the dataset is imported lookups by IP address return
+  associated location data.
+test_files: []