max_mind 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+max_mind-*.gem

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/maxmind.rb
+script/console
+script/destroy
+script/generate
+spec/maxmind_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,42 @@
+= max_mind
+
+    http://github.com/crushlovely/max_mind
+
+== DESCRIPTION:
+
+Ruby library for interacting with the MaxMind GeoIP Web Services.
+
+== SYNOPSIS:
+
+Just set your license key (an initializer is a good spot if you're using a Rails app):
+
+    MaxMind::Service.license_key = 'abcdefg'
+
+== INSTALL:
+
+    sudo gem install max_mind
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Crush + Lovely
+
+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,44 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/max_mind'
+
+# Jeweler 1.0.0
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "max_mind"
+    gemspec.summary = "Ruby library for interacting with the MaxMind GeoIP Web Services."
+    gemspec.email = ["pj@crushlovely.com", "nate@nateclark.com"]
+    gemspec.homepage = "http://github.com/crushlovely/max_mind"
+    gemspec.description = "Ruby library for interacting with the MaxMind GeoIP Web Services."
+    gemspec.authors = ["PJ Kelly", "Nate Clark"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+
+# # Generate all the Rake tasks
+# # Run 'rake -T' to see list of generated tasks (from gem root directory)
+# $hoe = Hoe.new('max_mind', MaxMind::VERSION) do |p|
+#   p.developer('FIXME full name', 'FIXME email')
+#   p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+#   p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+#   p.rubyforge_name       = p.name # TODO this is default value
+#   # p.extra_deps         = [
+#   #   ['activesupport','>= 2.0.2'],
+#   # ]
+#   p.extra_dev_deps = [
+#     ['newgem', ">= #{::Newgem::VERSION}"]
+#   ]
+#   
+#   p.clean_globs |= %w[**/.DS_Store tmp *.log]
+#   path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+#   p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+#   p.rsync_args = '-av --delete --ignore-errors'
+# end
+
+# require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 0
+:patch: 0

data/lib/autotest/discover.rb

@@ -0,0 +1,5 @@
+$:.push(File.join(File.dirname(__FILE__), %w[.. .. rspec]))
+
+Autotest.add_discovery do
+  "rspec"
+end

data/lib/max_mind.rb

@@ -0,0 +1,32 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'active_support'
+
+require 'uri'
+require 'cgi'
+require 'net/http'
+require 'logger'
+require 'yaml'
+require 'csv'
+
+class Hash
+  def to_query_string
+    self.to_a.collect { |p| "#{p.first.to_s}=#{p.last}" }.join("&")
+  end
+end
+
+require 'max_mind/service'
+require 'max_mind/service/country'
+require 'max_mind/service/city'
+require 'max_mind/service/city_isp_org'
+
+module MaxMind
+  class LicenseError < StandardError; end
+  class ConfigurationError < StandardError; end
+  class ConnectionError < StandardError; end
+  class RequestError < StandardError; end
+  class ResponseError < StandardError; end
+
+  VERSION = '1.0.0'
+end

data/lib/max_mind/service.rb

@@ -0,0 +1,55 @@
+module MaxMind
+  class Service
+    cattr_accessor :license_key
+
+    cattr_accessor :base_url
+    self.base_url = 'http://geoip1.maxmind.com'
+
+    class_inheritable_accessor :base_path
+
+    attr_accessor :response
+
+    def self.fetch_for_ip(ip)
+      raise RequestError.new("Cannot make a request without an IP address") if ip.nil?
+      service = self.new
+      service.make_request(ip)
+      service.parsed_response
+    end
+
+    # This method should be implemented in subclasses
+    # Here, we're only returning the raw data returned by the server
+    def parsed_response
+      self.response
+    end
+
+    def make_request(ip)
+      if license_key.nil?
+        raise LicenseError.new("License Key is missing")
+      end
+
+      uri = URI.parse(base_url)
+
+      begin
+        self.response = Net::HTTP.get(uri.host, build_path(:l => license_key, :i => ip), uri.port)
+      rescue EOFError => e
+        raise ConnectionError, "The remote server dropped the connection"
+      rescue Errno::ECONNRESET => e
+        raise ConnectionError, "The remote server reset the connection"
+      rescue Errno::ECONNREFUSED => e
+        raise ConnectionError, "The remote server refused the connection"
+      rescue Timeout::Error, Errno::ETIMEDOUT => e
+        raise ConnectionError, "The connection to the remote server timed out"
+      end
+
+    end
+
+    def build_path(params = {})
+      raise RequestError.new("Cannot build a valid request path!") unless !base_path.nil? && params.is_a?(Hash)
+      base_path + '?' + params.to_query_string
+    end
+
+    def valid_response?
+      !self.response.blank?
+    end
+  end
+end

data/lib/max_mind/service/city.rb

@@ -0,0 +1,29 @@
+module MaxMind
+  class CityService < Service
+
+    self.base_path = '/b'
+
+    def parsed_response
+      if self.valid_response?
+        parsed_response = CSV.parse_line(self.response)
+        {
+          :country => parsed_response[0],
+          :state => parsed_response[1],
+          :city => parsed_response[2],
+          :latitude => parsed_response[3],
+          :longitude => parsed_response[4],
+          :api_response => self.response
+        }
+      else
+        {
+          :api_response => self.response
+        }
+      end
+    end
+
+    def valid_response?
+      super && !(self.response =~ /,,,,,(.+?)/)
+    end
+
+  end
+end

data/lib/max_mind/service/city_isp_org.rb

@@ -0,0 +1,30 @@
+module MaxMind
+  class CityIspOrgService < Service
+
+    self.base_path = '/f'
+
+    def parsed_response
+      if self.valid_response?
+        parsed_response = CSV.parse_line(self.response)
+        {
+          :country => parsed_response[0],
+          :state => parsed_response[1],
+          :city => parsed_response[2],
+          :postal_code => parsed_response[3],
+          :latitude => parsed_response[4],
+          :longitude => parsed_response[5],
+          :api_response => self.response
+        }
+      else
+        {
+          :api_response => self.response
+        }
+      end
+    end
+
+    def valid_response?
+      super && !(self.response =~ /,,,,,,,,,,(.+?)/)
+    end
+
+  end
+end

data/lib/max_mind/service/country.rb

@@ -0,0 +1,25 @@
+module MaxMind
+  class CountryService < Service
+
+    self.base_path = '/a'
+
+    def parsed_response
+      if self.valid_response?
+        parsed_response = CSV.parse_line(self.response)
+        {
+          :country => parsed_response[0],
+          :api_response => self.response
+        }
+      else
+        {
+          :api_response => self.response
+        }
+      end
+    end
+
+    def valid_response?
+      super && !(self.response =~ /\(NULL\),(.+?)/)
+    end
+
+  end
+end

data/max_mind.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{max_mind}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["PJ Kelly", "Nate Clark"]
+  s.date = %q{2009-10-22}
+  s.description = %q{Ruby library for interacting with the MaxMind GeoIP Web Services.}
+  s.email = ["pj@crushlovely.com", "nate@nateclark.com"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "Manifest.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/autotest/discover.rb",
+     "lib/max_mind.rb",
+     "lib/max_mind/service.rb",
+     "lib/max_mind/service/city.rb",
+     "lib/max_mind/service/city_isp_org.rb",
+     "lib/max_mind/service/country.rb",
+     "max_mind.gemspec",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "spec/city_isp_org_spec.rb",
+     "spec/city_spec.rb",
+     "spec/country_spec.rb",
+     "spec/max_mind_spec.rb",
+     "spec/service_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/rspec.rake"
+  ]
+  s.homepage = %q{http://github.com/crushlovely/max_mind}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby library for interacting with the MaxMind GeoIP Web Services.}
+  s.test_files = [
+    "spec/city_isp_org_spec.rb",
+     "spec/city_spec.rb",
+     "spec/country_spec.rb",
+     "spec/max_mind_spec.rb",
+     "spec/service_spec.rb",
+     "spec/spec_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  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/maxmind.rb'}"
+puts "Loading maxmind 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/spec/city_isp_org_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe MaxMind::CityIspOrgService do
+  
+  it "base_path should be /f by default" do
+    MaxMind::CityIspOrgService.base_path.should == '/f'
+  end
+
+  describe "response parsing" do
+  
+    before(:each) do
+      @ip = '12.12.12.12'
+      MaxMind::CityIspOrgService.license_key = '1234'
+    end
+  
+    it "should return a hash of values if response is valid" do
+      @valid_response = 'US,NY,Brooklyn,11222,40.728001,-73.945297,501,718,"Road Runner","Road Runner"'
+      Net::HTTP.stub!(:get).and_return(@valid_response)
+      @response = MaxMind::CityIspOrgService.fetch_for_ip(@ip)
+      @response.should == {:latitude=>"40.728001", :longitude=>"-73.945297", :country=>"US", :city=>"Brooklyn", :postal_code=>"11222", :state=>"NY", :api_response => @valid_response}
+    end
+
+    ['WHAteVEr', 'g@rbag3', '432153'].each do |r|
+      it "should return nil if response is invalid" do
+        @invalid_response = ",,,,,,,,,,#{r}"
+        Net::HTTP.stub!(:get).and_return(@invalid_response)
+        @response = MaxMind::CityIspOrgService.fetch_for_ip(@ip)
+        @response.should == {:api_response => @invalid_response}
+      end
+    end
+
+  end
+
+end

data/spec/city_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe MaxMind::CityService do
+  
+  it "base_path should be /b by default" do
+    MaxMind::CityService.base_path.should == '/b'
+  end
+
+  describe "response parsing" do
+  
+    before(:each) do
+      @ip = '12.12.12.12'
+      MaxMind::CityService.license_key = '1234'
+    end
+  
+    it "should return a hash of values if response is valid" do
+      @valid_response = 'US,NY,Brooklyn,40.728001,-73.945297'
+      Net::HTTP.stub!(:get).and_return(@valid_response)
+      @response = MaxMind::CityService.fetch_for_ip(@ip)
+      @response.should == {:latitude=>"40.728001", :longitude=>"-73.945297", :country=>"US", :city=>"Brooklyn", :state=>"NY", :api_response => @valid_response}
+    end
+
+    ['WHAteVEr', 'g@rbag3', '432153'].each do |r|
+      it "should return nil if response is invalid" do
+        @invalid_response = ",,,,,#{r}"
+        Net::HTTP.stub!(:get).and_return(@invalid_response)
+        @response = MaxMind::CityService.fetch_for_ip(@ip)
+        @response.should == {:api_response => @invalid_response}
+      end
+    end
+
+  end
+
+end

data/spec/country_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe MaxMind::CountryService do
+  
+  it "base_path should be /a by default" do
+    MaxMind::CountryService.base_path.should == '/a'
+  end
+
+  describe "response parsing" do
+  
+    before(:each) do
+      @ip = '12.12.12.12'
+      MaxMind::CountryService.license_key = '1234'
+    end
+  
+    it "should return a hash of values if response is valid" do
+      @valid_response = 'US'
+      Net::HTTP.stub!(:get).and_return(@valid_response)
+      @response = MaxMind::CountryService.fetch_for_ip(@ip)
+      @response.should == {:country=>"US", :api_response => @valid_response}
+    end
+
+    ['WHAteVEr', 'g@rbag3', '432153'].each do |r|
+      it "should return nil if response is invalid" do
+        @invalid_response = "(NULL),#{r}"
+        Net::HTTP.stub!(:get).and_return(@invalid_response)
+        @response = MaxMind::CountryService.fetch_for_ip(@ip)
+        @response.should == {:api_response => @invalid_response}
+      end
+    end
+
+  end
+
+end

data/spec/max_mind_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe MaxMind do
+
+  it "should specify version as a constant" do
+    MaxMind::VERSION.should_not be_nil
+  end
+  
+end

data/spec/service_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe MaxMind::Service do
+  
+  before(:each) do
+    MaxMind::Service.license_key = nil
+  end
+  
+  describe "class attributes" do 
+
+    it "should have a @@base_url defined" do
+      MaxMind::Service.base_url.should_not be_nil
+    end
+
+    it "@@base_url should be http://geoip1.maxmind.com by default" do
+      MaxMind::Service.base_url.should == 'http://geoip1.maxmind.com'
+    end
+
+    it "should have no license_key initially" do
+      MaxMind::Service.license_key.should == nil
+    end
+
+    it "should have no base_path initially" do
+      MaxMind::Service.base_path.should == nil
+    end
+
+  end
+
+  describe "class and instance methods" do
+
+    before(:each) do
+      @ip = '12.12.12.12'
+      @sample_response = 'US,NY,Brooklyn,11222,40.728001,-73.945297,501,718,"Road Runner","Road Runner"'
+      @base_path = '/z'
+      Net::HTTP.stub!(:get).and_return(@sample_response)
+      MaxMind::Service.stub!(:base_path).and_return(@base_path)
+    end
+
+    describe ".fetch_for_ip" do
+  
+      it "should raise a license error if api key is not set" do
+        lambda {
+          MaxMind::Service.fetch_for_ip(@ip)
+        }.should raise_error(MaxMind::LicenseError)
+      end
+
+      describe "with license key" do
+
+        it "should return response" do
+          MaxMind::Service.license_key = '1234'
+          MaxMind::Service.fetch_for_ip(@ip).should == @sample_response
+        end
+
+      end
+
+    end
+    
+    describe ".license_key=" do
+    
+      it "allows the service subclass to inherit the license key" do
+        MaxMind::Service.license_key = 'abcdefg'
+        MaxMind::CityService.license_key.should == 'abcdefg'
+      end
+      
+    end
+    
+    describe ".base_url=" do
+      it "allows the service subclass to inherit the license key" do
+        MaxMind::Service.base_url = 'http://geoip3.maxmind.com'
+        MaxMind::CityService.base_url.should == 'http://geoip3.maxmind.com'
+      end
+    end
+    
+    
+
+    describe "instance methods" do
+    
+      before(:each) do
+        MaxMind::Service.license_key = '1234'
+        @service = MaxMind::Service.new
+      end
+    
+      it "should make request" do
+        @service.make_request(@ip).should == @sample_response
+      end
+    
+      it "should build a proper path" do
+        query_params = {:meow => '1', :woof => '2'}
+        @service.build_path(query_params).should == "#{@base_path}?#{query_params.to_query_string}"
+      end
+
+      it "valid_response? should ensure response is not blank" do
+        @service = MaxMind::Service.new
+        @service.valid_response?.should be_false
+        @service.response = @sample_response
+        @service.valid_response?.should be_true
+      end
+
+    end
+  
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../lib/max_mind'
+
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: max_mind
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- PJ Kelly
+- Nate Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ruby library for interacting with the MaxMind GeoIP Web Services.
+email: 
+- pj@crushlovely.com
+- nate@nateclark.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/autotest/discover.rb
+- lib/max_mind.rb
+- lib/max_mind/service.rb
+- lib/max_mind/service/city.rb
+- lib/max_mind/service/city_isp_org.rb
+- lib/max_mind/service/country.rb
+- max_mind.gemspec
+- script/console
+- script/destroy
+- script/generate
+- spec/city_isp_org_spec.rb
+- spec/city_spec.rb
+- spec/country_spec.rb
+- spec/max_mind_spec.rb
+- spec/service_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/crushlovely/max_mind
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby library for interacting with the MaxMind GeoIP Web Services.
+test_files: 
+- spec/city_isp_org_spec.rb
+- spec/city_spec.rb
+- spec/country_spec.rb
+- spec/max_mind_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb