ask_geo 0.1.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'json'
+
+group :development do
+  gem "rake"
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Scott W. Bradley
+
+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,93 @@
+ask_geo
+=======
+
+Ruby client library for the [AskGeo](http://www.askgeo.com/) web service. From the AskGeo website:
+
+> AskGeo provides a simple, fast, and accurate web api for finding out the time zone information for a given location (latitude and longitude). It's simple: you give latitude and longitude and the API returns a time zone ID (e.g., "America/Chicago", or "Europe/London"). We built the API because we needed it for a different project and decided to make it available because no other such tools seem to exist that are accurate and capable of returning a large number of results in a short period of time.
+>
+> Unlike GeoNames, look-ups are based on an actual map of the world, rather than "closest point of interest", which ensures accuracy and that you actually get a result for all locations. And unlike EarthTools, we return an actual time zone ID (e.g., "America/Los_Angeles") rather than just an offset. The API is also very fast: when used in batch mode, it is capable of returning thousands of results in a couple seconds.
+
+Installation
+============
+
+Install the gem:
+
+    gem install ask_geo
+
+Or, if you are using bundler, add it to your Gemfile:
+
+    gem "ask_geo"
+
+Usage
+=====
+
+First, you will need to create an [AskGeo](http://www.askgeo.com/) account. Currently they only support doing this via OpenID with a gmail account. Once you have created an account, they give you an Account ID and an API Key. You will need those to make calls to their web service through this library.
+
+From there, usage of the client library is fairly straight-forward:
+
+```ruby
+# Instantiate a client
+client = AskGeo.new(:account_id => 'XXXXXX', :api_key => 'XXXXXX')
+
+# Lookup a single lat/lon
+resp = client.lookup("47.62057,-122.349761")
+# => {
+#      "timeZone" => "America/Los_Angeles",
+#      "currentOffsetMs" => -25200000,
+#      "latitude" => 47.62057,
+#      "longitude" => -122.349761
+#    }
+
+# Lookup a batch of lat/lon points (faster than multiple calls)
+resp = client.lookup(["47.62057,-122.349761", "40.748529,-73.98563"])
+# => [{
+#       "timeZone" => "America/Los_Angeles",
+#       "currentOffsetMs" => -25200000,
+#       "latitude" => 47.62057,
+#       "longitude" => -122.349761
+#     },
+#     {
+#       "timeZone" => "America/New_York",
+#       "currentOffsetMs" => -14400000,
+#       "latitude" => 40.748529,
+#       "longitude" => -73.98563
+#     }]
+
+# Points can be specified by Hash too...
+resp = client.lookup(:lat => 47.62057, :lon => -122.349761)
+
+resp = client.lookup(
+  [
+    {:lat => 47.62057, :lon => -122.349761},
+    {:lat => 40.748529, :lon => -73.98563}
+  ]
+)
+```
+
+Contributing to ask_geo
+=======================
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Running the Tests
+=================
+
+In order to run the tests, you first need to edit `spec/spec_helper.rb` and follow the `TODO` comment to insert your AskGeo account ID and API key. Then, you should be able to run the tests with:
+
+```
+rake spec
+```
+
+Copyright
+=========
+
+Copyright (c) 2011 Scott W. Bradley. See LICENSE.txt for
+further details.
+
+AskGeo, GeoNames, and EarthTools are copyright/trademark their respective owners.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+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
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ask_geo"
+  gem.homepage = "http://github.com/scottwb/ask_geo"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby client library for the AskGeo web service (http://www.askgeo.com)"}
+  gem.description = %Q{Ruby client library for the AskGeo web service (http://www.askgeo.com). AskGeo provides a simple, fast, and accurate web api for finding out the time zone information for a given location (latitude and longitude)."}
+  gem.email = "scottwb@gmail.com"
+  gem.authors = ["Scott W. Bradley"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ask_geo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ask_geo.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ask_geo}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott W. Bradley"]
+  s.date = %q{2011-07-19}
+  s.description = %q{Ruby client library for the AskGeo web service (http://www.askgeo.com). AskGeo provides a simple, fast, and accurate web api for finding out the time zone information for a given location (latitude and longitude)."}
+  s.email = %q{scottwb@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "ask_geo.gemspec",
+    "lib/ask_geo.rb",
+    "spec/ask_geo_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/scottwb/ask_geo}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby client library for the AskGeo web service (http://www.askgeo.com)"}
+
+  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
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/ask_geo.rb

@@ -0,0 +1,49 @@
+require 'net/http'
+require 'uri'
+require 'cgi'
+require 'json'
+
+class AskGeo
+  class APIError < StandardError; end
+
+  attr_accessor :account_id, :api_key
+
+  def initialize(opts = {})
+    @account_id = opts[:account_id]
+    @api_key    = opts[:api_key]
+  end
+
+  def base_url
+    "http://www.askgeo.com/api"
+  end
+
+  def serialize_point(point)
+    case point
+    when Hash
+      "#{point[:lat]},#{point[:lon]}"
+    else
+      # Assume this is something whose #to_s makes a "lat,lon" string.
+      point.to_s.gsub(/\s+/, '')
+    end
+  end
+
+  def serialize_points(points)
+    points = [points] if !points.kind_of?(Array)
+    points.map{|p| serialize_point(p)}.join(';')
+  end
+
+  def format_url(points)
+    "#{base_url}/#{account_id}/#{api_key}/timezone.json?points=#{CGI::escape(serialize_points(points))}"
+  end
+
+  def lookup(points)
+    response = JSON.parse(Net::HTTP.get URI.parse(format_url(points)))
+    if response['code'] != 0
+      raise APIError.new(response['message'] || 'Unknown server error')
+    end
+    data = response['data']
+    data.size == 1 ? data.first : data
+  rescue JSON::ParserError
+    raise APIError.new("Invalid server response")
+  end
+end

data/spec/ask_geo_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AskGeo" do
+  describe "#lookup" do
+    before :each do
+      @client = AskGeo.new(
+        :account_id => ASKGEO_ACCOUNT_ID,
+        :api_key    => ASKGEO_API_KEY
+      )
+    end
+
+    it "should support points specified by comma-separated lat,lon string" do
+      @client.lookup("47.62057,-122.349761")['timeZone'].should == 'America/Los_Angeles'
+    end
+
+    it "should support points specified by {:lat,:lon} hash" do
+      @client.lookup(:lat => 47.62057, :lon => -122.349761)['timeZone'].should == 'America/Los_Angeles'
+    end
+
+    it "should get a single response for a single point" do
+      response = @client.lookup("47.62057,-122.349761")
+      response.should be_a Hash
+      response['timeZone'].should == 'America/Los_Angeles'
+      response['latitude'].should be_within(0.000001).of(47.62057)
+      response['longitude'].should be_within(0.0000001).of(-122.349761)
+      (response['currentOffsetMs'] % 3600000).should == 0
+      (-8..-7).should include(response['currentOffsetMs'] / 3600000)
+    end
+
+    it "should get multiple responses for multiple points" do
+      needle = {
+        :lat => 47.62057,
+        :lon => -122.349761
+      }
+
+      empire = {
+        :lat  => 40.748529,
+        :lon  => -73.98563
+      }
+
+      response = @client.lookup([needle, empire])
+      response.should be_an Array
+      response.should have(2).responses
+
+      needle_response = response.first
+      needle_response['timeZone'].should == 'America/Los_Angeles'
+      needle_response['latitude'].should be_within(0.000001).of(needle[:lat])
+      needle_response['longitude'].should be_within(0.0000001).of(needle[:lon])
+      (needle_response['currentOffsetMs'] % 3600000).should == 0
+      (-8..-7).should include(needle_response['currentOffsetMs'] / 3600000)
+
+      empire_response = response.last
+      empire_response['timeZone'].should == 'America/New_York'
+      empire_response['latitude'].should be_within(0.000001).of(empire[:lat])
+      empire_response['longitude'].should be_within(0.0000001).of(empire[:lon])
+      (empire_response['currentOffsetMs'] % 3600000).should == 0
+      (-5..-4).should include(empire_response['currentOffsetMs'] / 3600000)
+    end
+
+    it "should raise AskGeo::APIError on malformed points" do
+      expect{@client.lookup("47.62057")}.to raise_exception AskGeo::APIError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'ask_geo'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+#
+# TODO: Update these with the values provided by askgeo.com for your account.
+#
+ASKGEO_ACCOUNT_ID = '282009'
+ASKGEO_API_KEY    = 'fbic289vke82uhi8n8qarr2dpf'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: ask_geo
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott W. Bradley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  name: json
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rake
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: *id006
+description: Ruby client library for the AskGeo web service (http://www.askgeo.com). AskGeo provides a simple, fast, and accurate web api for finding out the time zone information for a given location (latitude and longitude)."
+email: scottwb@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- ask_geo.gemspec
+- lib/ask_geo.rb
+- spec/ask_geo_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/scottwb/ask_geo
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby client library for the AskGeo web service (http://www.askgeo.com)"
+test_files: []
+