periplus 0.1.0 → 0.2.0

data/Gemfile

@@ -7,6 +7,7 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 
 gem "httparty"
+gem "activesupport"
 
 group :development do
   gem "rspec", "~> 2.4.0"

data/Gemfile.lock

@@ -1,6 +1,8 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.1.0.rc4)
+      multi_json (~> 1.0)
     crack (0.1.8)
     diff-lcs (1.1.2)
     git (1.2.5)
@@ -10,6 +12,7 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    multi_json (1.0.3)
     rake (0.9.2)
     rcov (0.9.9)
     rspec (2.4.0)
@@ -25,6 +28,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   bundler (~> 1.0.0)
   httparty
   jeweler (~> 1.6.2)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/periplus/bing_response.rb

@@ -0,0 +1,25 @@
+module Periplus
+  class BingResponse
+    def initialize(httparty_response)
+      @response = httparty_response
+
+      if @response.response.kind_of? Net::HTTPClientError
+        http_code = @response.response.code
+        http_message = @response.response.message
+        raise "An error has occurred communicating with the Bing Maps service. HTTP Status: #{http_code} (#{http_message})"
+      end
+
+      parse
+    end
+
+    def parse
+      resource_sets = @response.parsed_response["resourceSets"]
+      raise "Not found." if resource_sets == nil or resource_sets.length == 0
+
+      resources = resource_sets.first["resources"]
+      raise "Not found." if resources == nil or resources.length == 0
+
+      @primary_resource = resources.first
+    end
+  end
+end

data/lib/periplus/location.rb

@@ -0,0 +1,19 @@
+module Periplus
+  class Location < BingResponse
+    attr_accessor :latitude
+    attr_accessor :longitude
+    attr_accessor :address
+    attr_accessor :confidence
+    attr_accessor :entity_type
+
+    def parse
+      super()
+
+      point = @primary_resource["point"]
+      @latitude, @longitude = point["coordinates"]
+      @address=  @primary_resource["address"]
+      @confidence = @primary_resource["confidence"].downcase.to_sym
+      @entity_type = @primary_resource["entityType"].downcase.to_sym
+    end
+  end
+end

data/lib/periplus/request.rb

@@ -0,0 +1,136 @@
+require File.expand_path(File.dirname(__FILE__) + "/route")
+require "uri"
+
+module Periplus
+  class Request    
+    def initialize(api_key)
+      @api_key = api_key
+    end
+    
+    BING_URL = "http://dev.virtualearth.net/REST/v1/"
+    ROUTE_PATH = "Routes"
+    LOCATION_PATH = "Locations"
+    ROUTE_IMAGE_PATH = "Imagery/Map/Road/Routes/Driving"
+    QUERY_IMAGE_PATH = "Imagery/Map/Road/"
+    
+    def route_details_url(waypoints, options = {})
+      options = default_options(options).merge(hashify_waypoints(waypoints))
+                                        .merge(:o => "json")
+
+      "#{BING_URL}#{ROUTE_PATH}?#{options.to_params}"
+    end
+
+    def route_map_url(waypoints, options = {})
+      options = options.merge(hashify_waypoints(waypoints))
+                       .merge(:key => @api_key)
+      "#{BING_URL}#{ROUTE_IMAGE_PATH}?#{options.to_params}"
+    end
+
+    def address_map_url(address, options = {})
+      options = default_options(options)
+      "#{BING_URL}#{QUERY_IMAGE_PATH}#{URI.escape(format_waypoint(address))}?#{options.to_params}"
+    end
+
+    def location_details_url(address, options = {})
+      options = default_options(options).merge(:o => "json")
+                                        .merge(structure_address(address))
+      "#{BING_URL}#{LOCATION_PATH}?#{options.to_params}"
+    end
+
+   private
+    def default_options(given_options)
+      given_options.merge(:key => @api_key)
+    end
+
+    # turns a list of waypoints into a bing-api-friendly "wp.1", "wp.2", etc...
+    def hashify_waypoints(waypoints)
+      counter = 1
+      waypoints.inject({}) do |hash, waypoint|
+        hash["wp.#{counter}"] = format_waypoint(waypoint)
+        counter = counter + 1
+        hash
+      end
+    end
+
+    def has_key_or_attribute?(object, key_or_attribute)
+      object.respond_to? key_or_attribute or 
+        (object.respond_to? :has_key? and object.has_key? key_or_attribute)
+    end
+
+    def get_by_key_or_attribute(object, key_or_attribute)
+      if object.respond_to? :has_key?
+        if object.has_key? key_or_attribute
+          object[key_or_attribute]
+        end
+      elsif object.respond_to? key_or_attribute
+        object.send key_or_attribute
+      end
+    end
+    
+    ADDRESS_STRUCTURE = {
+      :street => :addressLine,
+      :address => :addressLine,
+      :city => :locality,
+      :state => :adminDistrict,
+      :province => :adminDistrict,
+      :state_province => :adminDistrict,
+      :country => :countryRegion,
+      :postal_code => :postalCode,
+      :zip_code => :postalCode,
+      :zipcode => :postalCode,
+      :zip => :postalCode
+    }
+
+    def structure_address(address)
+      ADDRESS_STRUCTURE.inject({}) do |structured, key_val|
+        unconverted, converted = key_val
+        
+        if has_key_or_attribute? address, converted
+          structured[converted] = get_by_key_or_attribute address, converted
+        elsif has_key_or_attribute? address, unconverted
+          structured[converted] = get_by_key_or_attribute address, unconverted
+        end
+        structured
+      end
+    end
+
+    WAYPOINT_FORMAT = [:street, 
+                       :address, 
+                       :city, 
+                       ",", 
+                       :state, 
+                       :province, 
+                       :state_province, 
+                       :country, 
+                       :postal_code,
+                       :zipcode,
+                       :zip_code,
+                       :zip]
+
+    def format_waypoint(waypoint)
+      return waypoint if waypoint.instance_of? String
+      
+      if WAYPOINT_FORMAT
+          .find_all { |el| el.instance_of? Symbol }
+          .any? { |key| has_key_or_attribute?(waypoint, key) }
+        
+        # find all matching elements
+        q = WAYPOINT_FORMAT.map do |attr|
+          attr.instance_of?(String) ? attr : get_by_key_or_attribute(waypoint, attr)
+        end.find_all { |el| el }
+        
+        q.inject('') do |query, el|
+          # if it's punctuation or the first character, don't put a space before it
+          if el =~ /^[.,!?]$/ or query.length == 0
+            "#{query}#{el}"
+          else
+            "#{query} #{el}"
+          end
+        end
+      else
+        # we didn't have any elements matching
+        waypoint.to_s
+      end
+    end
+  end
+end

data/lib/periplus/route.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + "/bing_response")
+
+module Periplus
+  class Route < BingResponse
+    attr_accessor :response
+    attr_accessor :distance
+    attr_accessor :distance_unit
+    attr_accessor :duration
+    attr_accessor :route
+
+    def parse
+      super()
+
+      @distance = @primary_resource["travelDistance"]
+      @distance_unit = @primary_resource["distanceUnit"].downcase.to_sym
+      @duration = @primary_resource["travelDuration"]
+      @route = @primary_resource
+    end
+  end
+end

data/lib/periplus.rb

@@ -1,116 +1,32 @@
 require "httparty"
+require File.expand_path(File.dirname(__FILE__) + "/periplus/bing_response")
+require File.expand_path(File.dirname(__FILE__) + "/periplus/request")
+require File.expand_path(File.dirname(__FILE__) + "/periplus/route")
+require File.expand_path(File.dirname(__FILE__) + "/periplus/location")
 
 module Periplus
-  class Request
-    include HTTParty
-    format :json
-    
-    def initialize(api_key)
-      @api_key = api_key
-    end
-    
-    BING_URL = "http://dev.virtualearth.net/REST/v1/Routes"
-    def route(waypoints, options = {})
-      options = options.merge(hashify_waypoints(waypoints))
-                       .merge(:o => "json", :key => @api_key)
-      Route.new (self.class.get BING_URL, :query => options)
-    end
+  include HTTParty
+  format :json
 
-   private
-    # turns a list of waypoints into a bing-api-friendly "wp.1", "wp.2", etc...
-    def hashify_waypoints(waypoints)
-      counter = 1
-      waypoints.inject({}) do |hash, waypoint|
-        hash["wp.#{counter}"] = format_waypoint(waypoint)
-        counter = counter + 1
-        hash
-      end
-    end
-
-    def has_key_or_attribute?(object, key_or_attribute)
-      object.respond_to? key_or_attribute or 
-        (object.respond_to? :has_key? and object.has_key? key_or_attribute)
-    end
-
-    def get_by_key_or_attribute(object, key_or_attribute)
-      if object.respond_to? :has_key? and object.has_key? key_or_attribute
-        object[key_or_attribute]
-      elsif object.respond_to? key_or_attribute
-        object.send key_or_attribute
-      end
-    end
-    
-    WAYPOINT_FORMAT = [:street, 
-                       :address, 
-                       :city, 
-                       ",", 
-                       :state, 
-                       :province, 
-                       :state_province, 
-                       :country, 
-                       :postal_code]
-
-    def format_waypoint(waypoint)
-      return waypoint if waypoint.instance_of? String
-      
-      if WAYPOINT_FORMAT
-          .find_all { |el| el.instance_of? Symbol }
-          .any? { |key| has_key_or_attribute?(waypoint, key) }
-        
-        # find all matching elements
-        q = WAYPOINT_FORMAT.map do |attr|
-          attr.instance_of?(String) ? attr : get_by_key_or_attribute(waypoint, attr)
-        end.find_all { |el| el }
-        
-        q.inject('') do |query, el|
-          # if it's punctuation or the first character, don't put a space before it
-          if el =~ /^[.,!?]$/ or query.length == 0
-            "#{query}#{el}"
-          else
-            "#{query} #{el}"
-          end
-        end
-      else
-        # we didn't have any elements matching
-        waypoint.to_s
-      end
-    end
+  def self.route_details(key, waypoints, options = {})
+    request = Request.new key
+    url = request.route_details_url waypoints, options
+    Route.new (get url)
   end
 
-  class Route
-    attr_accessor :response
-    attr_accessor :distance
-    attr_accessor :distance_unit
-    attr_accessor :duration
-    attr_accessor :route
-
-    def initialize(httparty_response)
-      @response = httparty_response
-
-      if @response.response.kind_of? Net::HTTPClientError
-        http_code = @response.response.code
-        http_message = @response.response.message
-        raise "An error has occurred communicating with the Bing Maps service. HTTP Status: #{http_code} (#{http_message})"
-      end
-
-      parse_resource_sets
-    end
-
-    def parse_resource_sets      
-      resource_sets = @response.parsed_response["resourceSets"]
-      raise "No route found." if resource_sets == nil or resource_sets.length == 0
-
-      resources = resource_sets.first["resources"]
-      raise "No route found." if resources == nil or resources.length == 0
-
-      primary_route = resources.first
-      
-      @distance = primary_route["travelDistance"]
-      @distance_unit = primary_route["distanceUnit"].downcase.to_sym
+  def self.location_details(key, address, options = {})
+    request = Request.new key
+    url = request.location_details_url address, options
+    Location.new (get url)
+  end
 
-      @duration = primary_route["travelDuration"]
+  def self.route_map_url(key, waypoints, options = {})
+    request = Request.new key
+    request.route_map_url waypoints, options
+  end
 
-      @route = primary_route
-    end
+  def self.address_map_url(key, address, options = {})
+    request = Request.new key
+    request.address_map_url address, options
   end
 end

data/periplus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{periplus}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Crum"]
-  s.date = %q{2011-06-16}
+  s.date = %q{2011-06-22}
   s.description = %q{A library that behaves as a client for the Bing Maps REST sdk}
   s.email = %q{ryan.j.crum@gmail.com}
   s.extra_rdoc_files = [
@@ -26,7 +26,14 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/periplus.rb",
+    "lib/periplus/bing_response.rb",
+    "lib/periplus/location.rb",
+    "lib/periplus/request.rb",
+    "lib/periplus/route.rb",
     "periplus.gemspec",
+    "spec/bing_response.spec",
+    "spec/location_spec.rb",
+    "spec/periplus_spec.rb",
     "spec/request_spec.rb",
     "spec/route_spec.rb",
     "spec/spec_helper.rb"
@@ -42,12 +49,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.4.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.4.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
@@ -55,6 +64,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.4.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])

data/spec/bing_response.spec

@@ -0,0 +1,36 @@
+require 'periplus'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "BingResponse" do
+  it "throws an exception if the httparty response is HTTP status 4xx" do
+    http_error = Net::HTTPUnauthorized.new "1_1", 401, "Unauthorized"
+    response = mock HTTParty::Response, :response => http_error
+    
+    begin
+      Periplus::BingResponse.new(response)
+    rescue Exception => e
+      e.message.should == "An error has occurred communicating with the Bing Maps service. HTTP Status: 401 (Unauthorized)"
+    end
+  end
+
+  it "throws an exception if the httparty response contains no routes" do
+    http_ok = Net::HTTPOK.new "1_1", 200, "OK"
+    empty_resource_sets = {
+      "resourceSets" => []
+    }
+
+    empty_single_resource_set = {
+      "resourceSets" => [{"resources" => []}]
+    }
+
+    [empty_resource_sets, empty_single_resource_set].each do |parsed_response|
+      response = mock HTTParty::Response, :response => http_ok, :parsed_response => parsed_response
+      
+      begin
+        Periplus::BingResponse.new(response)
+      rescue Exception => e
+        e.message.should == "Not found."
+      end
+    end
+  end
+end

data/spec/location_spec.rb

@@ -0,0 +1,28 @@
+require 'periplus'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Location" do
+  it "stores shortcut attibutes property" do
+    http_ok = Net::HTTPOK.new "1_1", 200, "OK"
+    parsed_response = {
+      "resourceSets" => [{
+                           "resources" => [{
+                                             "point" => {
+                                               "coordinates" => [5, -5]
+                                             },
+                                             "address" => {:my_address => "junk"},
+                                             "confidence" => "High",
+                                             "entityType" => "Address"
+                                           }]
+                         }]
+    }
+
+    response = mock HTTParty::Response, :response => http_ok, :parsed_response => parsed_response
+    location = Periplus::Location.new response
+    location.latitude.should == 5
+    location.longitude.should == -5
+    location.address.should == {:my_address => "junk"}
+    location.confidence.should == :high
+    location.entity_type.should == :address
+  end
+end

data/spec/periplus_spec.rb

@@ -0,0 +1,29 @@
+require 'periplus'
+
+describe "Periplus" do
+  it "should get route details" do
+    request = mock Periplus::Request
+    request.should_receive(:route_details_url).and_return("http://awesome")
+    Periplus::Request.should_receive(:new).and_return(request)
+    
+    http_ok = Net::HTTPOK.new "1_1", 200, "OK"
+    parsed_response = {
+      "resourceSets" => [{
+                           "resources" => [{
+                                             "travelDistance" => 50,
+                                             "travelDuration" => 12345,
+                                             "distanceUnit" => "Mile"
+                                           }]
+                         }]
+    }
+    response = mock HTTParty::Response, :response => http_ok, :parsed_response => parsed_response
+    Periplus.should_receive(:get).and_return(response)
+
+    route = Periplus.route_details "KEY", [], {}
+    route.distance.should == 50
+    route.duration.should == 12345
+    route.distance_unit.should == :mile
+    route.route.should == parsed_response["resourceSets"].first["resources"].first
+    
+  end
+end

data/spec/request_spec.rb

@@ -30,6 +30,21 @@ describe "Request" do
     }
   end
 
+  it "generates a route map url correctly" do
+    req = Periplus::Request.new 'fake_key'
+    
+    waypoints = ["New York, NY", "Buffalo, NY", "Louisville, KY"]
+    url = req.route_map_url waypoints
+    url.should == "http://dev.virtualearth.net/REST/v1/Imagery/Map/Road/Routes/Driving?wp.1=New%20York%2C%20NY&wp.2=Buffalo%2C%20NY&wp.3=Louisville%2C%20KY&key=fake_key"
+  end
+
+  it "generates an address map url correctly" do
+    req = Periplus::Request.new 'fake_key'
+    address = "Anchorage, AK"
+    url = req.address_map_url address
+    url.should == "http://dev.virtualearth.net/REST/v1/Imagery/Map/Road/Anchorage,%20AK?key=fake_key"
+  end
+
   it "formats an address object correctly" do
     class PeriplusAddress
       attr_accessor :address
@@ -51,4 +66,18 @@ describe "Request" do
 
     formatted.should == "1600 Pennsylvania Ave Washington, DC US 20500"
   end
+
+  it "builds a location details url correctly" do
+    address = {
+      :street => "1600 Pennsylvania Ave",
+      :city => "Washington",
+      :state => "DC",
+      :country => "US",
+      :zip => 20500
+    }
+
+    req = Periplus::Request.new 'fake key'
+    url = req.location_details_url address
+    url.should == "http://dev.virtualearth.net/REST/v1/Locations?key=fake%20key&o=json&addressLine=1600%20Pennsylvania%20Ave&locality=Washington&adminDistrict=DC&countryRegion=US&postalCode=20500"
+  end
 end

data/spec/route_spec.rb

@@ -2,38 +2,6 @@ require 'periplus'
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Route" do
-  it "throws an exception if the httparty response is HTTP status 4xx" do
-    http_error = Net::HTTPUnauthorized.new "1_1", 401, "Unauthorized"
-    response = mock HTTParty::Response, :response => http_error
-    
-    begin
-      Periplus::Route.new(response)
-    rescue Exception => e
-      e.message.should == "An error has occurred communicating with the Bing Maps service. HTTP Status: 401 (Unauthorized)"
-    end
-  end
-
-  it "throws an exception if the httparty response contains no routes" do
-    http_ok = Net::HTTPOK.new "1_1", 200, "OK"
-    empty_resource_sets = {
-      "resourceSets" => []
-    }
-
-    empty_single_resource_set = {
-      "resourceSets" => [{"resources" => []}]
-    }
-
-    [empty_resource_sets, empty_single_resource_set].each do |parsed_response|
-      response = mock HTTParty::Response, :response => http_ok, :parsed_response => parsed_response
-      
-      begin
-        Periplus::Route.new(response)
-      rescue Exception => e
-        e.message.should == "No route found."
-      end
-    end
-  end
-
   it "stores shortcut attributes properly" do
     http_ok = Net::HTTPOK.new "1_1", 200, "OK"
     parsed_response = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periplus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-16 00:00:00.000000000 -04:00
+date: 2011-06-22 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2156329600 !ruby/object:Gem::Requirement
+  requirement: &2168771280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156329600
+  version_requirements: *2168771280
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2168769920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2168769920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156329120 !ruby/object:Gem::Requirement
+  requirement: &2168769200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +44,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *2156329120
+  version_requirements: *2168769200
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156328640 !ruby/object:Gem::Requirement
+  requirement: &2168768480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +55,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156328640
+  version_requirements: *2168768480
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156328160 !ruby/object:Gem::Requirement
+  requirement: &2168790180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +66,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *2156328160
+  version_requirements: *2168790180
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2156327680 !ruby/object:Gem::Requirement
+  requirement: &2168817340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156327680
+  version_requirements: *2168817340
 description: A library that behaves as a client for the Bing Maps REST sdk
 email: ryan.j.crum@gmail.com
 executables: []
@@ -84,7 +95,14 @@ files:
 - Rakefile
 - VERSION
 - lib/periplus.rb
+- lib/periplus/bing_response.rb
+- lib/periplus/location.rb
+- lib/periplus/request.rb
+- lib/periplus/route.rb
 - periplus.gemspec
+- spec/bing_response.spec
+- spec/location_spec.rb
+- spec/periplus_spec.rb
 - spec/request_spec.rb
 - spec/route_spec.rb
 - spec/spec_helper.rb
@@ -104,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3190034002806456688
+      hash: -1957350740199156852
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: