autometal-geoip 0.1.2

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.1.1 2010-10-11
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+autometal-geoip.gemspec
+bin/install_geoip
+lib/geoip.rb
+lib/geoip/geolocatable.rb
+lib/geoip/installer.rb
+script/console
+script/destroy
+script/generate
+shellscripts/install_binary
+shellscripts/install_db
+test/test_geoip.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+Thank you for installing autometal-geoip
+
+Please run +sudo install_geoip+ to install the MaxMind binaries
+
+For more information on autometal-geoip, see http://humbuckercode.co.uk/licks/gems/geoip/
+

data/README.rdoc

@@ -0,0 +1,88 @@
+= autometal-geoip
+
+* http://github.com/Achillefs/geoip
+
+== DESCRIPTION:
+A wrapper to MaxMind's GeoIP services, that can work with both free and paid versions.
+Also provides geo-location methods to Active Record and Sequel Models.
+
+This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com/."
+
+== FEATURES/PROBLEMS:
+
+* While you are installing the MaxMind binaries on Linux systems, you mayget an error similar to this: 
+    libGeoIP.so.1: cannot open shared object file: No such file or directory
+  If you do, do the following:
+    $ vim /etc/ld.so.conf (and add the directory the libraries were installed in usually /var/lib or /var/shared/lib)
+    $ ldconfig
+  And rerun the installer
+
+== SYNOPSIS:
+  
+Autometal::Geoip provides a standalone GeoIP service:
+  require "rubygems"
+  require "geoip"
+  @geo = Autometal::Geoip.new("66.102.13.106")
+  @geo.country
+  => US
+
+You can also pass it a domain instead of an IP address
+  @geo = Autometal::Geoip.new("www.google.com")
+  @geo.country
+  => US
+  
+You can make any object Geo-location aware, as long as it has an IP or a domain attribute:
+  require "rubygems"
+  require "geoip"
+  class Site
+    include Geolocatable
+  end
+  Site.new(:domain => "google.com")
+  site.country
+  => "US"
+
+The above will work if your class has a +domain+ attribute.
+You can override the attribute used to geolocate by overriding +geo_attr+
+
+  require "rubygems"
+  require "geoip"
+  class Site
+    include Geolocatable
+    def geo_attr; self.weird_ip_field_name; end
+  end
+  Site.new(:weird_ip_field_name => "66.102.13.106")
+  site.country
+  => "US"
+
+== REQUIREMENTS:
+
+* GeoIP C bindings (installed along with the Gem)
+* Active Support (sudo gem install active-support --no-ri --no-rdoc)
+  This isn't really needed, I just like using the 1.day.ago stuff too much...
+
+== INSTALL:
+
+sudo gem install autometal-geoip
+
+== LICENSE:
+
+Copyright (c) 2010 Achillefs Charmpilas, Humbucker Ltd
+
+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/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/geoip'
+
+Hoe.plugin :newgem
+$hoe = Hoe.spec 'autometal-geoip' do
+  self.developer 'Achillefs Charmpilas', 'ac@humbuckercode.co.uk'
+  self.post_install_message = File.read('PostInstall.txt')
+  self.rubyforge_name       = self.name
+  self.extra_deps           = [['activesupport','>= 0']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/autometal-geoip.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{autometal-geoip}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Achillefs Charmpilas"]
+  s.date = %q{2010-10-11}
+  s.description = %q{A wrapper to MaxMind's GeoIP services, that can work with both free and paid versions.
+Also provides geo-location methods to Active Record and Sequel Models.}
+  s.email = ["ac@humbuckercode.co.uk"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt"]
+  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "geoip.gemspec", "lib/geoip.rb", "lib/geoip/geolocatable.rb", "lib/geoip/installer.rb", "script/console", "script/destroy", "script/generate", "shellscripts/install_binary", "shellscripts/install_db", "test/test_geoip.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://github.com/Achillefs/geoip}
+  s.post_install_message = %q{Thank you for installing autometal-geoip
+This gem will install and use MaxMind's GeoLiteCity database by default.
+
+For more information on autometal-geoip, see http://humbuckercode.co.uk/licks/gems/geoip/}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{autometal-geoip}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A wrapper to MaxMind's GeoIP services, that can work with both free and paid versions}
+  s.test_files = ["test/test_geoip.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rubyforge>, [">= 2.0.4"])
+      s.add_development_dependency(%q<hoe>, [">= 2.6.2"])
+    else
+      s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
+      s.add_dependency(%q<hoe>, [">= 2.6.2"])
+    end
+  else
+    s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
+    s.add_dependency(%q<hoe>, [">= 2.6.2"])
+  end
+end

data/bin/install_geoip

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+require "rubygems"
+require "geoip"
+
+puts "Attempting to install MaxMind GeoIP binaries..."
+Autometal::Geoip::Installer.new("GeoLiteCity")
+puts "Done."

data/lib/geoip.rb

@@ -0,0 +1,40 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+%W[installer geolocatable].each { |r| require "#{File.dirname(__FILE__)}/geoip/#{r}" } 
+
+module Autometal
+  class Geoip
+    VERSION = '0.1.2'
+    DEFAULT_PACKAGE = "GeoLiteCity"
+    DATA_FILE_PATH = "/usr/local/share/GeoIP/"
+    BIN = "geoiplookup"
+    
+    def self.bin_installed?
+      %x{ #{BIN} --version } == "" ? false : true
+    end
+    
+    def initialize ip_or_domain, opts = {}
+      raise LoadError.new("No GeoIP binary is installed on your system.") unless self.class.bin_installed?
+      package = opts.delete(:package) || DEFAULT_PACKAGE
+      @data_file = File.join(DATA_FILE_PATH,"#{package}.dat")
+      @response = self.lookup ip_or_domain
+      ar = @response.split(", ")
+      @version = ar[0]
+      @country = ar[1].gsub("Rev 1: ","")
+      @county = ar[2]
+      @city = ar[3]
+      @lat = ar[5].to_f
+      @lng = ar[6].to_f
+    end
+    attr_accessor :country, :county, :city, :lat, :lng
+    def lookup ip_or_domain
+      %x{ #{BIN} -f #{@data_file} #{ip_or_domain} }
+    end
+    
+    def latlng
+      [self.lat,self.lng]
+    end
+    alias :latlon :latlng
+  end
+end

data/lib/geoip/geolocatable.rb

@@ -0,0 +1,27 @@
+module Autometal
+  module Geolocatable
+    def geoip
+      @geoip = Autometal::Geoip.new(geo_attr) unless @geoip
+      @geoip
+    end
+    def geo_attr
+      begin
+        send(:ip)
+      rescue NoMethodError => e
+        send(:domain)
+      end
+    end
+    def country; geoip.country; end
+
+    def county; geoip.county; end
+
+    def city; geoip.city; end
+
+    def lat; geoip.lat; end
+
+    def lng; geoip.lng; end
+
+    def latlng; geoip.latlng; end
+    alias :latlon :latlng
+  end
+end

data/lib/geoip/installer.rb

@@ -0,0 +1,34 @@
+require "active_support"
+
+module Autometal
+  class Geoip
+    class Installer
+      BASE_DB_URL = "http://geolite.maxmind.com/download/geoip/database/*.dat.gz"
+      PACKAGE_URL = "http://geolite.maxmind.com/download/geoip/api/c/GeoIP.tar.gz"
+
+      def initialize package_name = "GeoLiteCity"
+        @package_name = package_name
+        @db_url = BASE_DB_URL.gsub("*",@package_name)
+        install_binary
+        install_database
+      end
+
+    private
+      def install_binary
+        if Autometal::Geoip.bin_installed?
+          puts "Binary already installed, skipping"
+        else
+          `cd #{File.dirname(__FILE__)}/../../shellscripts/ && ./install_binary #{PACKAGE_URL}` 
+        end
+      end
+
+      def install_database
+        if File::ctime(File.join(Autometal::Geoip::DATA_FILE_PATH,"#{@package_name}.dat")) > 1.month.ago
+          puts "Datafile is up to date, skipping"
+        else
+          `cd #{File.dirname(__FILE__)}/../../shellscripts/ && ./install_db #{@db_url}`
+        end
+      end
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/geoip.rb'}"
+puts "Loading geoip gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/shellscripts/install_binary

@@ -0,0 +1,7 @@
+#! /bin/bash
+mkdir ./tmp && cd ./tmp
+wget $1
+tar -xzvf *.gz && cd GeoIP*
+./configure && make && make check && sudo make install
+cd ../..
+rm -rf ./tmp

data/shellscripts/install_db

@@ -0,0 +1,9 @@
+#! /bin/bash
+mkdir ./tmp
+cd ./tmp
+wget $1
+gunzip *.gz
+sudo mkdir -p /usr/local/share/GeoIP/
+sudo mv *.dat /usr/local/share/GeoIP/
+cd ..
+rm -rf ./tmp

data/test/test_geoip.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGeoip < Test::Unit::TestCase
+
+  def setup
+    @dummy = Dummy.new
+    @dummy2 = AnotherDummy.new
+  end
+  
+  def test_objects_are_geolocatable
+    assert_not_nil @dummy.country
+  end
+  
+  def test_gem_can_install_binaries
+    assert_nothing_raised do
+      Autometal::Geoip::Installer.new("GeoLiteCity")
+    end
+    assert_equal true, Autometal::Geoip.bin_installed?
+    assert_not_nil @dummy.country, "Country should not be nil"
+    assert_not_nil @dummy.city, "City should not be nil"
+    assert_not_nil @dummy.lat, "Latitude should not be nil"
+    assert_not_nil @dummy.lng, "Longitude should not be nil"
+  end
+  
+  def test_can_override_geo_attribute
+    assert_equal @dummy.country, @dummy2.country
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+%W[ stringio test/unit open-uri #{File.dirname(__FILE__)}/../lib/geoip ].each { |r| require r }
+
+class Dummy
+  include Autometal::Geolocatable
+  attr_accessor :ip
+  
+  def initialize
+    @ip = open("http://check-rankings.co.uk").read rescue "66.102.13.105"
+  end
+end
+
+class AnotherDummy
+  include Autometal::Geolocatable
+  attr_accessor :pantera
+  
+  def initialize
+    @pantera = open("http://check-rankings.co.uk").read rescue "66.102.13.105"
+  end
+  def geo_attr; pantera; end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: autometal-geoip
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Achillefs Charmpilas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  type: :development
+  version_requirements: *id003
+description: |-
+  A wrapper to MaxMind's GeoIP services, that can work with both free and paid versions.
+  Also provides geo-location methods to Active Record and Sequel Models.
+  
+  This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com/."
+email: 
+- ac@humbuckercode.co.uk
+executables: 
+- install_geoip
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- autometal-geoip.gemspec
+- bin/install_geoip
+- lib/geoip.rb
+- lib/geoip/geolocatable.rb
+- lib/geoip/installer.rb
+- script/console
+- script/destroy
+- script/generate
+- shellscripts/install_binary
+- shellscripts/install_db
+- test/test_geoip.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/Achillefs/geoip
+licenses: []
+
+post_install_message: |+
+  
+  Thank you for installing autometal-geoip
+  
+  Please run +sudo install_geoip+ to install the MaxMind binaries
+  
+  For more information on autometal-geoip, see http://humbuckercode.co.uk/licks/gems/geoip/
+  
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: autometal-geoip
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A wrapper to MaxMind's GeoIP services, that can work with both free and paid versions
+test_files: 
+- test/test_geoip.rb
+- test/test_helper.rb