freegeoip 0.1.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p125@freegeoip"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.11.5 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'guard-rspec'
+  gem 'growl', :require => false
+end
+
+group :test do
+  gem 'rake'
+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

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ezekiel Templin
+
+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,32 @@
+# FreeGeoIP
+
+Despite what the incredibly witty title might lead you to believe, this is a Ruby API client for [FreeGeoIP's IP geolocation API](http://freegeoip.net/static/index.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'freegeoip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freegeoip
+
+## Usage
+
+    require 'freegeoip'
+    
+    FreeGeoIP.locate("zeke.templ.in")
+    # => I'll fill this in later.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/freegeoip.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/freegeoip/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ezekiel Templin"]
+  gem.email         = ["zeke@templ.in"]
+  gem.description   = %q{Ruby Client for FreeGeoIP's geolocation API}
+  gem.summary       = %q{Ruby Client for FreeGeoIP's geolocation API}
+  gem.homepage      = "http://github.com/ezkl/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "freegeoip"
+  gem.require_paths = ["lib"]
+  gem.version       = FreeGeoIP::VERSION
+  
+  gem.add_runtime_dependency("faraday", "0.8.0.rc2")
+  gem.add_runtime_dependency("multi_json", "1.2.0")
+  gem.add_development_dependency("rspec", "~> 2.9.0")
+  gem.add_development_dependency("vcr", "~> 2.0.0")
+end

data/lib/freegeoip.rb

@@ -0,0 +1,19 @@
+require "faraday"
+require "multi_json"
+
+module FreeGeoIP  
+  CONNECTION = Faraday.new(:url => "http://freegeoip.net/json/") do |builder|
+    builder.adapter Faraday.default_adapter
+  end
+  
+  def self.locate(address)
+    if (response = CONNECTION.get(address)).success?
+      MultiJson.decode(response.body)
+    else
+      false
+    end
+  end
+end
+
+require "freegeoip/version"
+require "freegeoip/response"

data/lib/freegeoip/response.rb

@@ -0,0 +1,18 @@
+module FreeGeoIP
+  class Response
+    attr_reader :city, :region, :region_code, :longitude, :latitude, :country, :country_code, :ip, :zip_code, :metro_code
+    
+    def initialize(response_body)
+      @city         = response_body['city']
+      @region       = response_body['region_name']
+      @region_code  = response_body['region_code']
+      @longitude    = response_body['longitude']
+      @latitude     = response_body['latitude']
+      @country      = response_body['country_name']
+      @country_code = response_body['country_code']
+      @ip           = response_body['ip']
+      @zip_code     = response_body['zipcode']
+      @metro_code   = response_body['metrocode']
+    end
+  end
+end

data/lib/freegeoip/version.rb

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

data/spec/cassettes/locate.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://freegeoip.net/json/google-public-dns-a.google.com
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/0.7.67
+      date:
+      - Mon, 02 Apr 2012 02:47:46 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      access-control-allow-origin:
+      - ! '*'
+      etag:
+      - ! '"037319b5e2a1a8d7c5b59d6f8786d875c9ae7e41"'
+      content-length:
+      - '235'
+    body:
+      encoding: US-ASCII
+      string: ! '{"city": "Mountain View", "region_code": "CA", "longitude": "-122.057",
+        "region_name": "California", "country_code": "US", "latitude": "37.4192",
+        "country_name": "United States", "ip": "8.8.8.8", "zipcode": "94043", "metrocode":
+        "807"}'
+    http_version: 
+  recorded_at: Mon, 02 Apr 2012 02:46:43 GMT
+- request:
+    method: get
+    uri: http://freegeoip.net/json/8.8.8.8
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/0.7.67
+      date:
+      - Mon, 02 Apr 2012 02:47:47 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      access-control-allow-origin:
+      - ! '*'
+      etag:
+      - ! '"037319b5e2a1a8d7c5b59d6f8786d875c9ae7e41"'
+      content-length:
+      - '235'
+    body:
+      encoding: US-ASCII
+      string: ! '{"city": "Mountain View", "region_code": "CA", "longitude": "-122.057",
+        "region_name": "California", "country_code": "US", "latitude": "37.4192",
+        "country_name": "United States", "ip": "8.8.8.8", "zipcode": "94043", "metrocode":
+        "807"}'
+    http_version: 
+  recorded_at: Mon, 02 Apr 2012 02:46:43 GMT
+recorded_with: VCR 2.0.1

data/spec/freegeoip/response_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "FreeGeoIP::Response", :vcr do
+  before(:all) do
+    VCR.use_cassette("locate") do
+      @host = FreeGeoIP.locate("google-public-dns-a.google.com")
+    end
+    @google_dns = FreeGeoIP::Response.new(@host)
+  end
+  context "success" do
+    subject { @google_dns }
+    it "should have the proper values" do
+      subject.city.should eq "Mountain View"
+      subject.region.should eq "California"
+      subject.region_code.should eq "CA"
+      subject.longitude.should eq  "-122.057"
+      subject.latitude.should eq "37.4192"
+      subject.country.should eq "United States"
+      subject.country_code.should eq "US"
+      subject.ip.should eq "8.8.8.8"
+      subject.zip_code.should eq "94043"
+      subject.metro_code.should eq "807"
+    end
+  end
+end

data/spec/freeogeoip_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe FreeGeoIP do
+  describe "#locate" do
+    before(:all) do
+      VCR.use_cassette("locate") do
+        @host = subject.locate("google-public-dns-a.google.com")
+        @ip   = subject.locate("8.8.8.8")
+      end
+    end
+    
+    it "should not break" do
+      @host.should eq @ip
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "vcr"
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :faraday
+  c.configure_rspec_metadata!
+end
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/freegeoip')
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.mock_framework = :rspec
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: freegeoip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ezekiel Templin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0.rc2
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Ruby Client for FreeGeoIP's geolocation API
+email:
+- zeke@templ.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- freegeoip.gemspec
+- lib/freegeoip.rb
+- lib/freegeoip/response.rb
+- lib/freegeoip/version.rb
+- spec/cassettes/locate.yml
+- spec/freegeoip/response_spec.rb
+- spec/freeogeoip_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ezkl/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3507139357993624515
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3507139357993624515
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Ruby Client for FreeGeoIP's geolocation API
+test_files:
+- spec/cassettes/locate.yml
+- spec/freegeoip/response_spec.rb
+- spec/freeogeoip_spec.rb
+- spec/spec_helper.rb