sina_geoip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43f6a00a13e71ec4b1c3cef10443298448c14269
+  data.tar.gz: 04adb8329b0f6a93890f8c2ffe69aa5b699f61e6
+SHA512:
+  metadata.gz: 498faaf5950bf134201e4601d8c515a5daf64079996170c9bc90f2fd4f61fc4664df60f246c6af2faab44035c821c968feace7c85ee2ceb6c04a6edc3230a738
+  data.tar.gz: 8c4fb48308db1a8a0efa6ddc36c0c8439708498acf0c13e89a62faf534343a9d77edebfea00ba39b025156b0544dbff44ebfd58c48147db14ae671e24340eedb

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sina_geoip.gemspec
+gemspec
+group :development , :test do
+ gem 'rspec' , '~>2.5.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jdd
+
+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,108 @@
+# SinaGeoip
+
+Retreive the geolocation of an IP address based on the [http://int.dpool.sina.com.cn/iplookup/iplookup.php](http://int.dpool.sina.com.cn/iplookup/iplookup.php) webservice.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sina_geoip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sina_geoip
+
+## Usage
+
+
+
+### Retrieve geolocation
+    SinaGeoIp.geolocation(ip_address)
+
+### Example
+
+    # 12.130.132.30 = sina.com.cn (CN)
+    GeoIp.geolocation('12.130.132.30')
+
+returns:  
+
+  {
+    :ret => 1, 
+    :start => "202.108.24.0", 
+    :end => "202.108.58.255", 
+    :country => "中国", 
+    :province => "北京", 
+    :city => "北京", 
+    :district => "", 
+    :isp => "联通", 
+    :type => "", 
+    :desc => ""
+  } 
+
+
+### precision
+
+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.
+
+#### precision country 
+
+    GeoIp.geolocation('202.108.24.0', :precision => :country)
+
+returns:
+
+  {
+    :country => "中国"
+  }
+
+#### precision province 
+
+    GeoIp.geolocation('202.108.24.0', :precision => :province)
+
+returns:
+
+  {
+    :country => "中国",
+    :province => "北京"
+  } 
+
+#### precision city 
+
+    GeoIp.geolocation('202.108.24.0', :precision => :city)
+
+returns:
+
+  {
+    :country => "中国",
+    :province => "北京",
+    :city => "北京"
+
+  } 
+
+## Test
+
+    rspec spec/sina_geoip/sina_geoip_spec.rb
+
+## Contributors
+
+* [geo_ip](https://github.com/jeroenj/geo_ip)
+
+## Bugs
+
+Please report them on the [Github issue tracker](https://github.com/pobing/sina_geoip/issues)
+for this project.
+
+If you have a bug to report, please include the following information:
+
+* **Version information for bierdopje, Rails and Ruby.**
+* Stack trace and error message.
+
+You may also fork this project on Github and create a pull request.
+Do not forget to include tests.
+
+## Copyright
+
+Copyright (c) 2013 by pobing.

data/Rakefile

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

data/lib/sina_geoip.rb

@@ -0,0 +1,81 @@
+#encoding: utf-8
+require "sina_geoip/version"
+require 'json'
+require 'rest-client'
+
+class SinaGeoIp
+  SERVICE_URL = 'http://int.dpool.sina.com.cn/iplookup/iplookup.php'
+  IPV4_REGEXP = /\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}\z/
+
+  @@timeout = 1
+  @@fallback_timeout = 3
+
+  class << self
+
+
+    def timeout
+      @@timeout
+    end
+
+    def timeout= timeout
+      @@timeout = timeout
+    end
+
+    def fallback_timeout
+      @@fallback_timeout
+    end
+
+    def fallback_timeout= fallback_timeout
+      @@fallback_timeout = fallback_timeout
+    end
+
+    def set_defaults_if_necessary options
+     args = [:country, :province,:city]
+      if options[:precision] && !args.include?(options[:precision])
+        raise 'Invalid precision.'  
+      end
+    end
+
+    def lookup_url(ip, options = {})
+      set_defaults_if_necessary options
+      raise 'Invalid IP address' unless ip.to_s =~ IPV4_REGEXP
+      #http://int.dpool.sina.com.cn/iplookup/iplookup.php?format=json&ip=202.102.154.3
+      "#{SERVICE_URL}?format=json&ip=#{ip}"
+    end
+
+    # Retreive the remote location of a given ip address.
+    #
+    # It takes two optional arguments:
+    #
+    # ==== Example:
+    #   GeoIp.geolocation('209.85.227.104', {:precision => :city})
+    def geolocation(ip, options={})
+      location = nil
+      Timeout.timeout(self.fallback_timeout) do
+        parsed_response = JSON.parse RestClient::Request.execute(:method => :get, :url => lookup_url(ip, options), :timeout => self.timeout)
+        location = to_j(parsed_response, options)
+      end
+      location
+    end
+
+    private
+
+    #hash => {"ret"=>1, "start"=>"202.102.151.208", "end"=>"202.102.154.255", "country"=>"中国", "province"=>"山东", "city"=>"济南", "district"=>"", "isp"=>"联通",   "type"=>"", "desc"=>""}
+    def to_j(hash, options={})
+      h = {ret: hash['ret'], start: hash['start'], end: hash['end'], country: hash['country'], province: hash['province'], city: hash['city'],\
+         district: hash['district'], isp: hash['isp'], type: hash['type'], desc: hash['desc']}
+      case options[:precision]
+      when :country
+        h = {country: hash['country']} # only return country
+      when :province
+        h = {country: hash['country'], province: hash['province']} # only country,province
+      when :city
+        h = {country: hash['country'], province: hash['province'],city: hash['city']} #  only country,province, city
+      else
+        h # return all
+      end
+      h
+    end
+  end
+end
+

data/lib/sina_geoip/version.rb

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

data/sina_geoip.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sina_geoip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sina_geoip"
+  spec.version       = SinaGeoip::VERSION
+  spec.authors       = ["pobing"]
+  spec.email         = ["cn.jdong@gmail.com"]
+  spec.description   = %q{Retreive the geolocation of an IP address based on the http://int.dpool.sina.com.cn/iplookup/iplookup.php webservice}
+  spec.summary       = %q{A call to the sina geoip app . will be done to retreive the geolocation based on the IP address. No need to include a database file in the application.}
+  spec.homepage      = "https://github.com/pobing/sina_geoip"
+  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 'json', '~> 1.4.6'
+  spec.add_dependency 'rest-client', '~> 1.6.1'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/sina_geoip/sina_geoip_spec.rb

@@ -0,0 +1,37 @@
+# encoding:utf-8
+require "spec_helper"
+
+describe SinaGeoIp do
+	before :all do
+		IP = "12.130.132.30"
+	end
+  it "execute success and return ok" do
+    res = SinaGeoIp.geolocation(IP)
+    res.class.should == Hash
+    res.size == 10
+    res[:ret].should == 1
+  end
+  
+  it "precision country"  do
+  	res = SinaGeoIp.geolocation(IP,:precision=>:country)
+  	res.size.should == 1
+  	res.keys.include?(:country)
+  end
+  
+  it "precision province"  do
+  	res = SinaGeoIp.geolocation(IP,:precision => :province)
+  	res.size.should == 2
+  	res.keys.include?(:province)
+  end
+
+  it "precision city"  do
+  	res = SinaGeoIp.geolocation(IP,:precision=>:city)
+  	res.size.should == 3
+  	res.keys.include?(:city)
+  end
+
+  it "Invalid IP address"  do
+   	expect { SinaGeoIp.geolocation("125.3366.363.25") }.to raise_error(RuntimeError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sina_geoip'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sina_geoip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- pobing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !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: Retreive the geolocation of an IP address based on the http://int.dpool.sina.com.cn/iplookup/iplookup.php
+  webservice
+email:
+- cn.jdong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sina_geoip.rb
+- lib/sina_geoip/version.rb
+- sina_geoip.gemspec
+- spec/sina_geoip/sina_geoip_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pobing/sina_geoip
+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.3
+signing_key: 
+specification_version: 4
+summary: A call to the sina geoip app . will be done to retreive the geolocation based
+  on the IP address. No need to include a database file in the application.
+test_files:
+- spec/sina_geoip/sina_geoip_spec.rb
+- spec/spec_helper.rb