periplus 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,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+gem "httparty"
+
+group :development do
+  gem "rspec", "~> 2.4.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  httparty
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (~> 2.4.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Crum
+
+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,33 @@
+= periplus
+
+Bing Maps REST API client.
+
+== Use it
+  require 'periplus'
+
+  my_request = Periplus::Request.new 'my_bing_key'
+  response = my_request.route [{:street => "1600 Pennsylvania Ave.",
+                                :city => "Washington",
+                                :state => "DC",
+                                :postal_code => "20500"},
+                               {:postal_code => "90210"}],
+                              :distanceUnit => :mi
+
+  puts "#{response.distance} #{response.distance_units.to_s}.pluralize, #{response.duration} seconds"
+  # "2665.06415 miles, 137797 seconds"
+     
+== Contributing to periplus
+ 
+* 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.
+
+== Copyright
+
+Copyright (c) 2011 Ryan Crum. See LICENSE.txt for
+further details.
+

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 = "periplus"
+  gem.homepage = "http://github.com/thorstadt/periplus"
+  gem.license = "MIT"
+  gem.summary = %Q{Bing Maps REST Client}
+  gem.description = %Q{A library that behaves as a client for the Bing Maps REST sdk}
+  gem.email = "ryan.j.crum@gmail.com"
+  gem.authors = ["Ryan Crum"]
+  # 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 = "periplus #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/periplus.rb

@@ -0,0 +1,116 @@
+require "httparty"
+
+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
+
+   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
+  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
+
+      @duration = primary_route["travelDuration"]
+
+      @route = primary_route
+    end
+  end
+end

data/periplus.gemspec

@@ -0,0 +1,64 @@
+# 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{periplus}
+  s.version = "0.1.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.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 = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/periplus.rb",
+    "periplus.gemspec",
+    "spec/request_spec.rb",
+    "spec/route_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/thorstadt/periplus}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Bing Maps REST Client}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 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<rspec>, ["~> 2.4.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 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"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/request_spec.rb

@@ -0,0 +1,54 @@
+require 'periplus'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Request" do
+  it "formats an address hash correctly" do
+    req = Periplus::Request.new 'fake_key'
+    address_hash = {
+      :street      => "123 Maple Lane",
+      :city        => "Beverly Hills",
+      :state       => "California",
+      :country     => "US",
+      :postal_code => 90210
+    }
+    
+    formatted = req.send :format_waypoint, address_hash
+    
+    formatted.should == "123 Maple Lane Beverly Hills, California US 90210"
+  end
+
+  it "hashifies a list of waypoints correctly for the HTTParty query" do
+    req = Periplus::Request.new 'fake_key'
+    
+    waypoints = ["New York, NY", "Buffalo, NY", "Louisville, KY"]
+    hash = req.send :hashify_waypoints, waypoints
+
+    hash.should == {
+      "wp.1" => "New York, NY",
+      "wp.2" => "Buffalo, NY",
+      "wp.3" => "Louisville, KY"
+    }
+  end
+
+  it "formats an address object correctly" do
+    class PeriplusAddress
+      attr_accessor :address
+      attr_accessor :city
+      attr_accessor :state
+      attr_accessor :country
+      attr_accessor :postal_code
+    end
+
+    address = PeriplusAddress.new 
+    address.address = "1600 Pennsylvania Ave"
+    address.city = "Washington"
+    address.state = "DC"
+    address.country = "US"
+    address.postal_code = 20500
+    
+    req = Periplus::Request.new 'fake key'
+    formatted = req.send :format_waypoint, address
+
+    formatted.should == "1600 Pennsylvania Ave Washington, DC US 20500"
+  end
+end

data/spec/route_spec.rb

@@ -0,0 +1,57 @@
+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 = {
+      "resourceSets" => [{
+                           "resources" => [{
+                                             "travelDistance" => 50,
+                                             "travelDuration" => 12345,
+                                             "distanceUnit" => "Mile"
+                                           }]
+                         }]
+    }
+
+    response = mock HTTParty::Response, :response => http_ok, :parsed_response => parsed_response
+    route = Periplus::Route.new response
+    
+    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/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'periplus'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: periplus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Crum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-16 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2156329600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156329600
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156329120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156329120
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2156328640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156328640
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2156328160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *2156328160
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2156327680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156327680
+description: A library that behaves as a client for the Bing Maps REST sdk
+email: ryan.j.crum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/periplus.rb
+- periplus.gemspec
+- spec/request_spec.rb
+- spec/route_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/thorstadt/periplus
+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'
+      segments:
+      - 0
+      hash: 3190034002806456688
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Bing Maps REST Client
+test_files: []