mqproxy 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.rdoc

@@ -0,0 +1,75 @@
+= MQProxy
+
+Connect to Map Quest's API to:
+* geocode address
+* get route from one address to another
+
+== Installation
+
+=== gem
+	gem install mqproxy
+
+=== Plugin
+
+Rails <= 2.3.8
+	./script/plugin install git://github.com/cbrady/MQ-Proxy.git
+
+Rails >= 3.0
+	rails plugin install git://github.com/cbrady/MQ-Proxy.git
+
+== Example
+
+=== Set up the addresses:
+
+Addresses can be setup in a Hash:
+	address1 = {:postalCode => "<zip1>", :street => "<street1>", :adminArea1 => "<country1>", :adminArea3 => "<state1>", :adminArea4 => "<county1>",:adminArea5 => "<city1>"}
+	address2 = {:postalCode => "<zip2>", :street => "<street2>", :adminArea1 => "<country2>", :adminArea3 => "<state2>", :adminArea4 => "<county2>",:adminArea5 => "<city2>"}
+
+Or as strings:
+	address1 = "<street1> <city1>, <state1> <zip1>"
+	address2 = "<street2> <city2>, <state2> <zip2>"
+
+=== To get route:
+	proxy = MQProxy.new
+	route = proxy.get_route(address1, address2)
+
+This returns a MQProxyRoute object
+
+MQProxyRoute gives you access to certain attributes from the MapQuest response:
+	time - total estimated travel time (seconds)
+	distance - total distance of trip (default: miles - can be overwritten in options sent to MapQuest)
+	directions - array of all steps of the trip
+	raw - Hash containing entire response from MapQuest
+
+=== To get geocode:
+
+	proxy = MQProxy.new
+	code = proxy.geocode_address(address1)
+
+This returns a MQProxyGeocode object
+
+MQProxyGeocode gives you access to certain attributes from the MapQuest response:
+	street - address' street
+	city - address' city
+	zip - address' zip code
+	county - address' county
+	state - address' state
+	country - address' country
+	lat - address' latitude
+	lgn - address' longitude
+	raw - Hash containing entire response from MapQuest
+
+
+== Options:	
+To overwrite default MapQuest options pass mq_options Hash to method
+
+	proxy = MQProxy.new
+	route = MQProxy.get_route(address1, address2, :mq_proxy {:unit => 'k', :routeType => 'shortest'})
+
+The this tells MapQuest that you would like the shortest route possible and all of the distances in the response to be in kilometers instead of miles.
+
+For a full list of options see the MapQuest API documentation:
+
+http://www.mapquestapi.com/
+
+Copyright (c) 2011 Christopher Brady, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the mq_proxy plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the mq_proxy plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MQProxy'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/mqproxy.rb

@@ -0,0 +1,108 @@
+# MQProxy - Collection of classes used to access the MapQuest API.
+# Copyright (c) 2011 Christopher Brady
+# Licensed under the same terms as Ruby. No warranty is provided
+
+require 'json'
+require 'net/http'
+
+# Main class for MapQuest API calls 
+class MQProxy
+  # Get directions from one address to the other
+  def get_route(source, destination, options = {})
+    addresses = generate_route_json(source,destination, options[:mq_options])
+    return MQProxyRoute.new(route_addresses(addresses,options))
+  end
+  
+  # Get directions from one address to the other
+  def geocode_address(address, options = {})
+    doc = JSON.generate({:location => address, :options => options[:mq_options]})
+    xmlInputString = doc.to_s
+    return MQProxyGeocode.new(send_to_map_quest(xmlInputString, options))
+  end
+  
+  private
+    # Format JSON for MapQuest route call
+    def generate_route_json(source, destination, options)
+      doc = {:locations => [source, destination], :options => options}
+      doc = JSON.generate(doc)
+      return doc
+    end
+  
+    # Append proper path and send to MapQuest
+    def route_addresses(addresses, options)
+      xmlInputString = addresses.to_s
+      options[:path] ||= 'directions/v1/route'
+      return send_to_map_quest(xmlInputString, options)
+    end
+  
+    # Generic function to send data to MapQuest and handle response
+    def send_to_map_quest(xmlInputString, options)
+      options[:method] ||= 'POST'
+      options[:port] ||= 80
+      options[:name] ||= 'www.mapquestapi.com'
+      options[:path] ||= 'geocoding/v1/address'
+      url = URI.parse("http://"+options[:name]+"/"+options[:path] +"?key=#{APP_KEY}")
+      headers = {"Content-Type" => "text/json; charset=utf-8"}
+      http = Net::HTTP.new(url.host, url.port)
+      json ||= begin
+        response = http.start {  
+          http.post(url.request_uri ,xmlInputString,headers)
+        }
+        doc = JSON.parse(response.body)
+        if doc['info']['statuscode'] != 0
+          raise StandardError, "There was an error with your request: #{doc['info']['message']}"
+        end
+        doc
+      end
+    end
+end
+
+# Class to handle MapQuest directions request response
+class MQProxyRoute
+  attr_accessor :time, :distance, :directions, :raw
+  
+  # Initialize MQProxyRoute and set standard data
+  def initialize(route)
+    @raw = route
+    @time = extract_data('time')
+    @distance = extract_data('distance')
+    @directions = extract_data('legs')
+  end
+  
+  private
+  
+    # Extract information from repsonse
+    def extract_data(field)
+      return @raw['route'][field]
+    end
+end
+
+# Class to handle MapQuest geocode request response
+class MQProxyGeocode
+  attr_accessor :street, :city, :zip, :county, :state, :country, :lat, :lng, :raw
+  
+  # Initialize MQProxyGeocode and set standard data
+  def initialize(geocode)
+    @raw = geocode
+    @street = extract_data('street')
+    @city = extract_data('adminArea5')
+    @zip = extract_data('postalCode')
+    @county = extract_data('adminArea4')
+    @state = extract_data('adminArea3')
+    @country = extract_data('adminArea1')
+    @lng,@lat = extract_lat_lng
+  end
+  
+  private
+  
+    # Extract information from repsonse
+    def extract_data(field)
+      @raw['results'].first['locations'].first[field]
+    end
+  
+    # Extract latitude and longitude information from response
+    def extract_lat_lng
+      latLng = @raw['results'].first['locations'].first['latLng']
+      return [latLng['lng'],latLng['lat']]
+    end
+end

data/test/mqproxy_test.rb

@@ -0,0 +1,35 @@
+require './test_helper'
+
+class MQProxyTest < Test::Unit::TestCase
+  def setup
+    @proxy = MQProxy.new
+    @data = {:adminArea1 => "US",:adminArea3 => "NY",:adminArea4 => "",:adminArea5 => "Brooklyn",:postalCode => "11222",:street => "527 Leonard St."}
+  end
+  
+  def test_get_geocode
+    geocode = @proxy.geocode_address(@data)
+    assert_equal(geocode.street,"527 Leonard St")
+    assert_equal(geocode.city,"Brooklyn")
+    assert_equal(geocode.state,"NY")
+    assert_equal(geocode.county,"Kings County")
+    assert_equal(geocode.zip,"11222-3262")
+    assert_equal(geocode.country,"US")
+    assert_equal(geocode.lat,40.72307)
+    assert_equal(geocode.lng,-73.94939)
+  end
+  
+  def test_get_route
+    data2 = {:adminArea1 => "US",:adminArea3 => "NY",:adminArea4 => "",:adminArea5 => "Hastings on Hudson",:postalCode => "10706",:street => "603 Warburton Ave."}
+    route = @proxy.get_route(@data,data2)
+    assert_equal(route.time,2461)
+    assert_equal(route.distance,24.2259998321533)
+  end
+  
+  def test_route_with_string
+    address1 = '527 Leonard St. Brooklyn, NY 11222'
+    address2 = '603 Warburton Ave. Hastings on Hudson, NY 10706'
+    route = @proxy.get_route(address1,address2)
+    assert_equal(route.time,2461)
+    assert_equal(route.distance,24.2259998321533)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/mqproxy'
+APP_KEY = "GET YOUR OWN"

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: mqproxy
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "1.0"
+platform: ruby
+authors: 
+- Christopher Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-18 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A wrapper for the MapQuest API, provides ability to get route and to geocode an address
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mqproxy.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/mqproxy_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/cbrady/MQ-Proxy
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: A wrapper for the MapQuest API, provides ability to get route and to geocode an address
+test_files: 
+- test/mqproxy_test.rb