geo_ip 0.3.0 → 0.3.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Jeroen Jacobs
+Copyright (c) 2010-2011 Jeroen Jacobs
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/geo_ip.rb

@@ -21,12 +21,12 @@ class GeoIp
 
   # Retreive the remote location of a given ip address.
   #
-  # It takes two optional arguments: precision and timezone
-  # preceision can either be :city (default) or :country
-  # timezone can either be false (default) or true
+  # It takes two optional arguments:
+  # * +preceision+: can either be +:city+ (default) or +:country+
+  # * +timezone+: can either be +false+ (default) or +true+
   #
-  # Example:
-  # GeoIp.geolocation('209.85.227.104', {:precision => :city, :timezone => true})
+  # ==== Example:
+  #   GeoIp.geolocation('209.85.227.104', {:precision => :city, :timezone => true})
   def self.geolocation(ip, options={})
     @precision = options[:precision] || :city
     @timezone  = options[:timezone]  || false

data/spec/api.yml

@@ -0,0 +1 @@
+key: 704e80b26abee33fd191f94c1ea3f62e8ec12dc77514fb4a2b4dbf3cac5c60f2

data/spec/geo_ip_spec.rb

@@ -5,7 +5,7 @@ IP_LOCAL = '127.0.0.1'
 
 describe "GeoIp" do
 
-  before(:all) do
+  before :each do
     api_config = YAML.load_file(File.dirname(__FILE__) + '/api.yml')
     GeoIp.api_key = api_config['key']
   end

data/spec/spec_helper.rb

@@ -1,9 +1,3 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'bundler/setup'
 require 'geo_ip'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: geo_ip
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 17
+  prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jeroen Jacobs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 +01:00
+date: 2011-03-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,45 +42,36 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 9
         segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+        - 2
+        - 5
+        version: "2.5"
   type: :development
   version_requirements: *id002
 description: A call to the ipinfodb.com will be done to retreive the geolocation based on the IP address. No need to include a database file in the application.
-email: jacobsjeroen@gmail.com
+email: gems@jeroenj.be
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
-- CHANGES
 - LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- geo_ip.gemspec
-- init.rb
 - lib/geo_ip.rb
+- spec/api.yml
 - spec/api.yml.example
 - spec/geo_ip_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/jeroenj/geo_ip
+homepage: http://jeroenj.be
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -104,10 +95,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Retreive the geolocation of an IP address based on the ipinfodb.com webservice
 test_files: 
+- spec/api.yml
+- spec/api.yml.example
 - spec/geo_ip_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,22 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
-spec/api.yml

data/CHANGES

@@ -1,20 +0,0 @@
-== 0.3.0
-
-* Added support for API key requirement (Thanks to seanconaty and luigi)
-* Explicit gem dependency for json and removed rubygems requirement (idris) (http://tomayko.com/writings/require-rubygems-antipattern)
-* Removed deprecated GeoIp#remote_geolocation method
-
-== 0.2.0
-
-* Added support for timezone information. Use the optional {:timezone => true|false} option
-* Added support for country lookup. This will result in a faster reply since less queries need
-  to be done at ipinfodb's side. Use the optional {:precision => :city|:country} option
-* API change: GeoIp.remote_geolocation(ip) is deprecated in favor of GeoIp.geolocation(ip)
-
-== 0.1.1
-
-* Removed time zone information since this has been deprecated with the service
-
-== 0.1.0
-
-* Initial commit

data/README.rdoc

@@ -1,118 +0,0 @@
-= GeoIp
-
-Retreive the geolocation of an IP address based on the {ipinfodb.com}[http://ipinfodb.com/] webservice.
-
-As of 8th November 2010, the service is asking that all users {register}[http://ipinfodb.com/register.php] for an API key.
-
-Consider making a donation to {ipinfodb.com}[http://ipinfodb.com/] at {http://ipinfodb.com/donate.php}[http://ipinfodb.com/donate.php]
-
-== Usage
-
-=== Set API key
-  GeoIp.api_key = "YOUR_API_KEY"
-
-This must be done before making the geolocation call.
-
-=== Retrieve geolocation
-  GeoIp.geolocation(ip_address)
-
-=== Example
-
-  # 209.85.227.104 = google.be (US)
-  GeoIp.geolocation('209.85.227.104')
-
-returns:
-
-  {
-    :status           =>"OK",
-    :ip               =>"209.85.227.104"
-    :country_code     =>"US",
-    :country_name     =>"United States",
-    :region_code      =>"06",
-    :region_name      =>"California",
-    :city             =>"Mountain View",
-    :zip_postal_code  =>"94043",
-    :latitude         =>"37.4192",
-    :longitude        =>"-122.057"
-  }
-
-=== Country only
-
-There is an option to only retreive the country information and thus excluding the city details. This results in a faster response from the service since less queries need to be done.
-
-  GeoIp.geolocation('209.85.227.104', {:precision => :country})
-
-returns:
-
-  {
-    :status           => "OK",
-    :ip               => "209.85.227.104"
-    :country_code     => "US",
-    :country_name     => "United States"
-  }
-
-=== Timezone information
-
-There is an option now to retrieve optional timezone information too:
-
-  GeoIp.geolocation('209.85.227.104', {:timezone => true})
-
-returns:
-
-  {
-    :status           =>"OK",
-    :ip               =>"209.85.227.104"
-    :country_code     =>"US",
-    :country_name     =>"United States",
-    :region_code      =>"06",
-    :region_name      =>"California",
-    :city             =>"Mountain View",
-    :zip_postal_code  =>"94043",
-    :latitude         =>"37.4192",
-    :longitude        =>"-122.057"
-    :timezone_name    =>"America/Los_Angeles",
-    :utc_offset       =>-25200,
-    :dst?             =>true
-  }
-
-Obviously it is not possible to have the country precision enabled while retrieving the timezone information.
-
-== Getting it
-
-GeoIp can be installed as a Ruby Gem:
-
-  gem install geo_ip
-
-Alternatively, you can also install it as a Rails plugin:
-
-  ./script/plugin install git://github.com/jeroenj/geo_ip.git
-
-== Testing
-
-Set up your API key first for the test suite by creating a spec/api.yml file. Follow the example in spec/api.yml.example. Then run the tests with:
-
-  ruby spec/geo_ip_spec.rb
-
-If you get a LoadError, you should run the tests with:
-
-  ruby -rubygems spec/geo_ip_spec.rb
-
-== Colaborators
-
-* {seanconaty}[https://github.com/seanconaty]
-* {luigi}[https://github.com/luigi]
-* {idris}[https://github.com/idris]
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Jeroen Jacobs, {redstorm sprl}[http://www.redstorm.be]. See LICENSE for details.

data/Rakefile

@@ -1,46 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "geo_ip"
-    gem.summary = "Retreive the geolocation of an IP address based on the ipinfodb.com webservice"
-    gem.description = "A call to the ipinfodb.com will be done to retreive the geolocation based on the IP address. No need to include a database file in the application."
-    gem.email = "jacobsjeroen@gmail.com"
-    gem.homepage = "http://github.com/jeroenj/geo_ip"
-    gem.authors = ["Jeroen Jacobs"]
-    gem.add_dependency "json", "~> 1.4.6"
-    gem.add_development_dependency "rspec", "~> 1.3.0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "geo_ip #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.3.0

data/geo_ip.gemspec

@@ -1,61 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{geo_ip}
-  s.version = "0.3.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jeroen Jacobs"]
-  s.date = %q{2010-11-16}
-  s.description = %q{A call to the ipinfodb.com will be done to retreive the geolocation based on the IP address. No need to include a database file in the application.}
-  s.email = %q{jacobsjeroen@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "CHANGES",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "geo_ip.gemspec",
-     "init.rb",
-     "lib/geo_ip.rb",
-     "spec/api.yml.example",
-     "spec/geo_ip_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/jeroenj/geo_ip}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Retreive the geolocation of an IP address based on the ipinfodb.com webservice}
-  s.test_files = [
-    "spec/geo_ip_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::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json>, ["~> 1.4.6"])
-      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
-    else
-      s.add_dependency(%q<json>, ["~> 1.4.6"])
-      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
-    end
-  else
-    s.add_dependency(%q<json>, ["~> 1.4.6"])
-    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
-  end
-end
-

data/init.rb

@@ -1 +0,0 @@
-require 'geo_ip'