ip2location 0.1.0

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem 'rake',     '~> 0.8.7'
+  gem 'ore-tasks', '~> 0.4'
+  gem 'rspec', '~> 2.4'
+	gem 'guard', '~> 0.4.2'
+	gem 'guard-rspec', '~> 0.4.0'
+	gem 'growl', '~> 1.0.3'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ezekiel Templin
+
+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,42 @@
+ip2location
+===========
+
+Description
+-----------
+This is a stupid simple client for [IP2LocationAPI](http://www.ip2locationapi.com/) written with [David Balatero](https://github.com/dbalatero)'s awesome [monster_mash](https://github.com/dbalatero/monster_mash) library. I wrote it more or less 
+as practice and to continue to familiarize myself with Ruby 1.9, RSpec, and Typhoeus.
+
+Usage
+--------
+    require 'ip2location'
+    
+    # Ip2Location.api_key = YOUR_API_KEY
+    # Ip2Location.user = YOUR_API_USERNAME
+    #
+    #  OR
+    
+    Ip2Location.setup do |s|
+      s.api_key = YOUR_API_KEY
+      s.user    = YOUR_API_USERNAME
+    end
+
+    puts Ip2Location.ip2l('8.8.8.8')
+    #=> <struct Ip2Location::Location ip="8.8.8.8", country_code="US", country="United States", region="California", city="Mountain View", latitude="34.305", longitude="-86.2981">
+  
+
+Requirements
+------------
+  * monster_mash (~> 0.2.3)
+  * A username and API key from [IP2LocationAPI](http://www.ip2locationapi.com/geoip-location-api/signup.php) (free)
+
+
+Install
+-------
+    gem install ip2location
+
+
+Copyright
+---------
+Copyright (c) 2011 Ezekiel Templin
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'ore/tasks'
+Ore::Tasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.title = "ip2location"
+end
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test => :spec
+task :default => :spec
+

data/gemspec.yml

@@ -0,0 +1,12 @@
+name: ip2location
+summary: "Client for the IP2Location API"
+description: "A simple client for the free IP2Location API."
+license: MIT
+authors: "Ezekiel Templin"
+homepage: http://github.com/ezkl/ip2location
+
+runtime_dependencies:
+  monster_mash: ~> 0.2
+
+development_dependencies:
+  bundler: ~> 1.0.0

data/ip2location.gemspec

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gemspec|
+  files = if File.directory?('.git')
+            `git ls-files`.split($/)
+          elsif File.directory?('.hg')
+            `hg manifest`.split($/)
+          elsif File.directory?('.svn')
+            `svn ls -R`.split($/).select { |path| File.file?(path) }
+          else
+            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+          end
+
+  filter_files = lambda { |paths|
+    case paths
+    when Array
+      (files & paths)
+    when String
+      (files & Dir[paths])
+    end
+  }
+
+  version = {
+    :file => 'lib/ip2location/version.rb',
+    :constant => 'Ip2Location::VERSION'
+  }
+
+  defaults = {
+    'name' => File.basename(File.dirname(__FILE__)),
+    'files' => files,
+    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
+    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
+  }
+
+  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+
+  gemspec.name = metadata.fetch('name',defaults[:name])
+  gemspec.version = if metadata['version']
+                      metadata['version']
+                    elsif File.file?(version[:file])
+                      require File.join('.',version[:file])
+                      eval(version[:constant])
+                    end
+
+  gemspec.summary = metadata.fetch('summary',metadata['description'])
+  gemspec.description = metadata.fetch('description',metadata['summary'])
+
+  case metadata['license']
+  when Array
+    gemspec.licenses = metadata['license']
+  when String
+    gemspec.license = metadata['license']
+  end
+
+  case metadata['authors']
+  when Array
+    gemspec.authors = metadata['authors']
+  when String
+    gemspec.author = metadata['authors']
+  end
+
+  gemspec.email = metadata['email']
+  gemspec.homepage = metadata['homepage']
+
+  case metadata['require_paths']
+  when Array
+    gemspec.require_paths = metadata['require_paths']
+  when String
+    gemspec.require_path = metadata['require_paths']
+  end
+
+  gemspec.files = filter_files[metadata['files']]
+
+  gemspec.executables = metadata['executables']
+  gemspec.extensions = metadata['extensions']
+
+  if Gem::VERSION < '1.7.'
+    gemspec.default_executable = gemspec.executables.first
+  end
+
+  gemspec.test_files = filter_files[metadata['test_files']]
+
+  unless gemspec.files.include?('.document')
+    gemspec.extra_rdoc_files = metadata['extra_doc_files']
+  end
+
+  gemspec.post_install_message = metadata['post_install_message']
+  gemspec.requirements = metadata['requirements']
+
+  if gemspec.respond_to?(:required_ruby_version=)
+    gemspec.required_ruby_version = metadata['required_ruby_version']
+  end
+
+  if gemspec.respond_to?(:required_rubygems_version=)
+    gemspec.required_rubygems_version = metadata['required_ruby_version']
+  end
+
+  parse_versions = lambda { |versions|
+    case versions
+    when Array
+      versions.map { |v| v.to_s }
+    when String
+      versions.split(/,\s*/)
+    end
+  }
+
+  if metadata['dependencies']
+    metadata['dependencies'].each do |name,versions|
+      gemspec.add_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['runtime_dependencies']
+    metadata['runtime_dependencies'].each do |name,versions|
+      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['development_dependencies']
+    metadata['development_dependencies'].each do |name,versions|
+      gemspec.add_development_dependency(name,parse_versions[versions])  
+    end
+  end
+end

data/lib/ip2location.rb

@@ -0,0 +1,30 @@
+require 'ostruct'
+require 'monster_mash'
+
+require 'ip2location/version'
+require 'ip2location/base'
+require 'ip2location/request'
+
+module Ip2Location
+  BASE_URI = "http://api.ip2locationapi.com/"
+  @api_key  = nil
+  @user     = nil
+  
+  class << self
+    attr_accessor :api_key, :user
+    
+    def setup
+      yield self if block_given?
+    end
+    
+    def request(ip)
+      Ip2Location::Request.ip2l(ip)
+    end
+    alias_method :ip2l, :request
+     
+  end
+  
+  class InvalidApiKeyError < StandardError; end
+  class NoLocationDataError < StandardError; end
+  class APIConnectionError < StandardError; end
+end

data/lib/ip2location/base.rb

@@ -0,0 +1,10 @@
+module Ip2Location  
+  class Base < MonsterMash::Base
+    defaults do
+      cache_timeout 999999
+      user_agent "Ip2LocationAPI Ruby (v#{VERSION})[https://github.com/ezkl/ip2location]"
+      params  :key => Ip2Location.api_key,
+              :user => Ip2Location.user
+    end
+  end
+end

data/lib/ip2location/request.rb

@@ -0,0 +1,36 @@
+module Ip2Location
+  Location = Struct.new(:ip, :country_code, :country, :region, :city, :latitude, :longitude)
+  
+  class Request < Base
+    get(:ip2l) do |ip|
+      uri "#{BASE_URI}"
+      params  :user =>  Ip2Location.user,
+              :key =>   Ip2Location.api_key,
+              :ip   =>  ip
+      handler do |response|
+        if response.success? && (parsed = parse_response(response.body, ip))
+          parsed
+        else
+          raise APIConnectionError, "There was a problem making your request!"
+        end
+      end
+    end
+    
+    def self.parse_response(body, ip)
+      check_response_for_errors(body)
+      location_parts = body.split(/,/)
+      Location.new(ip, location_parts[0], location_parts[1], location_parts[2], location_parts[3], location_parts[4], location_parts[5])
+    end
+    
+    def self.check_response_for_errors(body)
+      case body
+      when /Invalid user name or API key/
+        raise InvalidApiKeyError, "The API key [#{Ip2Location.api_key}] or Username [#{Ip2Location.user}] is invalid!"
+      when /NO DATA/
+        raise NoLocationDataError, "The IP you requested has no associated location data."
+      else 
+        body
+      end
+    end
+  end
+end

data/lib/ip2location/version.rb

@@ -0,0 +1,3 @@
+module Ip2Location
+  VERSION = "0.1.0"
+end

data/spec/ip2location/request_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'ip2location'
+
+describe Ip2Location::Request do
+  it "should return a properly parsed Location structure" do    
+    @api_key = "1fe480f5bac2c5261cf686f6265eed138953b98c"
+    @user    = "ip2location_ruby"
+    
+    Ip2Location.setup do |s|
+      s.api_key = @api_key
+      s.user    = @user
+    end
+
+    Ip2Location.request("8.8.8.8").should eq Location.new("8.8.8.8", "US","United States","California","Mountain View","34.305","-86.2981")
+  end
+  
+  describe "Parsing" do
+    before(:all) do
+      @no_data = "NO DATA"
+      @bad_api = "Sorry, Invalid user name or API key!"
+      @good_response = "US,United States,California,Mountain View,34.305,-86.2981"
+    end
+
+    it "should process responses properly" do
+      ->{ Ip2Location::Request.check_response_for_errors(@no_data) }.should raise_error(NoLocationDataError, "The IP you requested has no associated location data.")
+      ->{ Ip2Location::Request.check_response_for_errors(@bad_api) }.should raise_error(InvalidApiKeyError)
+      ->{ Ip2Location::Request.check_response_for_errors(@good_response) }.should_not raise_error
+    end
+
+    it "should return body unless response matches an error" do
+      Ip2Location::Request.check_response_for_errors(@good_response).should eq @good_response
+    end
+  end
+end

data/spec/ip2location_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'ip2location'
+
+describe Ip2Location do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+  
+  describe "#setup" do
+    it "should take @api_key and @user" do
+      Ip2Location.setup do |s|
+        s.api_key = "1234"
+        s.user    = "username"
+      end
+      
+      Ip2Location.api_key.should eq "1234"
+      Ip2Location.user.should eq "username"
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'ip2location'
+
+include Ip2Location

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: ip2location
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ezekiel Templin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: monster_mash
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.2"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: A simple client for the free IP2Location API.
+email: []
+
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- ip2location.gemspec
+- lib/ip2location.rb
+- lib/ip2location/base.rb
+- lib/ip2location/request.rb
+- lib/ip2location/version.rb
+- spec/ip2location/request_spec.rb
+- spec/ip2location_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ezkl/ip2location
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: ip2location
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Client for the IP2Location API
+test_files: 
+- spec/ip2location/request_spec.rb
+- spec/ip2location_spec.rb