bing 0.2.0 → 0.3.0

data/History.txt

@@ -1,3 +1,18 @@
+=== 0.3.0 / 2014-06-22
+* 11 minor enhancement(s):
+
+  * Add info about traffic to Bing Maps routes
+  * Added imagery to manifest and rm'd hacks for Travis CI.
+  * Began imagery connection.
+  * Beginning stages of imagery integration.
+  * Hack to build.
+  * Imagery is basically done but is messy.
+  * Merge pull request #1 from skrobul/master
+  * Some readme notes.
+  * add duration in traffic
+  * add getter for traffic time
+  * see if build will succeed this time...
+
 === 0.2.0 / 2011-08-05
 * 4 minor enhancement(s):
 

data/Manifest.txt

@@ -7,6 +7,7 @@ Rakefile
 lib/bing.rb
 lib/bing/core_ext.rb
 lib/bing/errors.rb
+lib/bing/imagery.rb
 lib/bing/location.rb
 lib/bing/request.rb
 lib/bing/rest_resource.rb
@@ -14,6 +15,7 @@ lib/bing/route.rb
 lib/bing/route/itinerary.rb
 test/helper.rb
 test/test_bing.rb
+test/test_bing_imagery.rb
 test/test_bing_location.rb
 test/test_bing_request.rb
 test/test_bing_rest_resource.rb

data/README.txt

@@ -14,6 +14,15 @@ Bing api client library that exposes all of Bing's api features.
 
 == SYNOPSIS:
 
+All methods for retrieval strive to just pass through params to Bing. This is
+desired to have Bing be canonical on the API integration with limited mapping
+client side. What this means is that when Bing says it accepts the param
+"centerPoint", you can pass this straight through as :center_point. The values
+are simply strings which means when Bing says you do "centerPoint=47.610,
+-122.107", you will do :center_point => '47.610,-122.107'.
+
+Some code examples:
+
 # For locations
 require 'bing/location'
 
@@ -71,3 +80,4 @@ 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/lib/bing/imagery.rb

@@ -0,0 +1,83 @@
+require 'bing/rest_resource'
+
+##
+# Responsible for generating static Bing maps.
+# Note: Bing static map generation is not very good. Even examples on their
+# api docs (http://msdn.microsoft.com/en-us/library/ff701724.aspx) do not work
+# as expected. One typical usage that does work is:
+#
+# Bing::Imagery.find_by_query '123 Street City STATE'
+#
+# The Bing documentation is okay in that some params do not work with other
+# params like:
+#
+# Bing::Imagery.find_by_query '123 Street City STATE', :zoom_level => 20
+#
+# This has no affect on the static maps by query :(. The only way for it to
+# work is to use a point search:
+#
+# Bing::Imagery.find_by_center_point [LAT, LON]
+# Bing::Imagery.find_by_center_point [LAT, LON], :zoom_level => 10
+
+class Bing::Imagery < Bing::RestResource
+  # TODO need to clean up and have it work better, but I don't have time right
+  # now. This is a pretty big mess :(
+
+  def self.find_by_center_point coords, opts = {}
+    imagery_set = opts.delete :imagery_set
+    zoom_level  = opts.delete(:zoom_level) || 15
+
+    coords = coords.join ','
+    coords_and_zoom = [coords, zoom_level].join '/'
+    opts[:push_pin] ||= coords
+
+    # TODO need to figure out path below to potentially clean this up.
+    uri = Bing.config[:map_uri].merge(
+            "#{path imagery_set, coords_and_zoom}?key=#{Bing.config[:api_key]}&#{opts.to_lower_camelized_param}"
+          )
+
+    Bing::Request.get uri
+  end
+
+  ##
+  # Find a static map based off of a query E.g. 123 Street City STATE.
+  # +query+ should be a non-escaped text sequence. If it is already escaped
+  # Bing will 40* you. Basically GIGO.
+
+  def self.find_by_query query, opts = {}
+    imagery_set = opts.delete :imagery_set
+
+    # TODO need to figure out path below to potentially clean this up.
+    uri = Bing.config[:map_uri].merge(
+            "#{path imagery_set, query}?key=#{Bing.config[:api_key]}&#{opts.to_lower_camelized_param}"
+          )
+
+    Bing::Request.get uri
+  end
+
+  def self.find_by_waypoints waypoints, opts = {}
+    imagery_set = opts.delete :imagery_set
+
+    query = "Routes"
+    waypoints = format_waypoints waypoints
+    params    = [opts.to_lower_camelized_param, waypoints].join '&'
+
+    # TODO need to figure out path below to potentially clean this up.
+    uri = Bing.config[:map_uri].merge(
+            "#{path imagery_set, query}?key=#{Bing.config[:api_key]}&#{params}"
+          )
+
+    Bing::Request.get uri
+  end
+
+  # TODO this is not my favorite at all. I need to figure out a way to handle
+  # paths better
+
+  def self.path imagery_set = nil, resource = nil
+    imagery_set ||= 'Road'
+    resource = resource ? "/#{URI.escape resource}" : nil
+    super "/Imagery/Map/#{imagery_set}#{resource}"
+  end
+
+end
+

data/lib/bing/request.rb

@@ -13,6 +13,8 @@ class Bing::Request
   def self.get uri
     response = HTTP.request uri
 
+    puts uri if ENV['DEBUG']
+
     raise Bing::BadGateway.bad_response(response.code, uri) unless
       response.code =~ /20\d/
 

data/lib/bing/rest_resource.rb

@@ -7,14 +7,6 @@ class Bing::RestResource
 
   BASE_PATH = "/REST/#{Bing.config[:api_version]}"
 
-  def self._find uri
-    body = JSON.parse Bing::Request.get(uri).body
-
-    body['resourceSets'].first['resources'].map do |resource|
-      new resource
-    end.compact
-  end
-
   def self.map_uri params
     Bing.config[:map_uri].merge(
       "#{path}?key=#{Bing.config[:api_key]}&#{params}"
@@ -22,7 +14,12 @@ class Bing::RestResource
   end
 
   def self.map_find params
-    _find map_uri params
+    resp = Bing::Request.get map_uri params
+    body = JSON.parse resp.body
+
+    body['resourceSets'].first['resources'].map do |resource|
+      new resource
+    end.compact
   end
 
   def self.path subclass_path = nil
@@ -47,5 +44,18 @@ class Bing::RestResource
     }
   end
 
+  private
+
+  def self.format_waypoints waypoints
+    return unless waypoints
+    ways = []
+
+    waypoints.each_with_index do |way, i|
+      ways << "waypoint.#{i}=#{CGI.escape way}"
+    end
+
+    ways.join '&'
+  end
+
 end
 

data/lib/bing/route.rb

@@ -49,6 +49,7 @@ class Bing::Route < Bing::RestResource
   attr_reader :starting_coordinates
   attr_reader :total_distance
   attr_reader :total_duration
+  attr_reader :total_duration_traffic
   attr_reader :type
 
   def initialize resource
@@ -58,6 +59,7 @@ class Bing::Route < Bing::RestResource
     @duration_unit  = resource['durationUnit']
     @total_distance = resource['travelDistance']
     @total_duration = resource['travelDuration']
+    @total_duration_traffic = resource['travelDurationTraffic']
 
     if resource['bbox'] then
       @bounding_box = bbox resource['bbox']
@@ -84,19 +86,6 @@ class Bing::Route < Bing::RestResource
     end
   end
 
-  private
-
-  def self.format_waypoints waypoints
-    return unless waypoints
-    ways = []
-
-    waypoints.each_with_index do |way, i|
-      ways << "waypoint.#{i}=#{CGI.escape way}"
-    end
-
-    ways.join '&'
-  end
-
 end
 
 require 'bing/route/itinerary'

data/lib/bing.rb

@@ -5,7 +5,7 @@ require 'json'
 
 module Bing
 
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 
   DEFAULTS = {
     :api_key     => 'AtsQ7PXwSqL266EUdxMYj3b4-H5A6ubkf8DwH-B4k3rVmmPycUrhmH-lZKHeWXm-',

data/test/helper.rb

@@ -3,8 +3,8 @@ require 'logger'
 require "minitest/autorun"
 require "webmock"
 
-require "bing"
 require "bing/location"
+require "bing/imagery"
 require "bing/route"
 
 include WebMock::API

data/test/test_bing_imagery.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+# TODO need to add more tests.
+
+class TestBingImagery < MiniTest::Unit::TestCase
+  BI = Bing::Imagery
+
+  def test_cls_path
+    assert_match %r[Imagery/Map/Road], BI.path
+    assert_match %r[Imagery/Map/Road], BI.path('Road')
+    assert_match %r[Imagery/Map/AerialWithLabels], BI.path('AerialWithLabels')
+
+    assert_match %r[Imagery/Map/Road/funky], BI.path(nil, 'funky')
+    assert_match %r[Imagery/Map/Road/funky%20monkey], BI.path(nil, 'funky monkey')
+  end
+
+  def test_cls_find
+    location_body = {
+      "resourceSets" =>[{
+        "resources"  =>[{
+          "point" => {"coordinates" => [34.148294, -118.255262]}
+        }]
+      }]}.to_json
+
+    mock_map_request 200, Bing::Location.path, location_body
+    mock_map_request 200, BI.path, ''
+
+    BI.find_by_query "doesn't matter"
+  end
+
+end
+

data/test/test_bing_rest_resource.rb

@@ -1,6 +1,10 @@
 require 'helper'
 
 class Bing::RestResource
+  class << self
+    public :format_waypoints
+  end
+
   def initialize *args
   end
 end
@@ -13,10 +17,18 @@ class TestBingRestResource < MiniTest::Unit::TestCase
     assert_equal '/REST/v1', BRR::BASE_PATH
   end
 
-  def test_cls__find
-    stub_request(:any, /.*/).to_return(:status => 200, :body => body)
+  def test_format_waypoints
+    waypoints = ['start', 'end']
+
+    assert_equal 'waypoint.0=start&waypoint.1=end',
+      BRR.format_waypoints(waypoints)
+
+    waypoints = ["4.9, -1.2", "1.2, 2.2"]
+
+    assert_equal 'waypoint.0=4.9%2C+-1.2&waypoint.1=1.2%2C+2.2',
+      BRR.format_waypoints(waypoints)
 
-    assert_resource BRR._find URI.parse 'http://example.com'
+    assert_equal nil, BRR.format_waypoints(nil)
   end
 
   def test_map_uri

data/test/test_bing_route.rb

@@ -1,11 +1,5 @@
 require 'helper'
 
-class Bing::Route
-  class << self
-    public :format_waypoints
-  end
-end
-
 class TestBingRoute < MiniTest::Unit::TestCase
 
   BR = Bing::Route
@@ -24,20 +18,6 @@ class TestBingRoute < MiniTest::Unit::TestCase
     route = BR.find :waypoints => ['start', 'end']
   end
 
-  def test_cls_format_waypoints
-    waypoints = ['start', 'end']
-
-    assert_equal 'waypoint.0=start&waypoint.1=end',
-      BR.format_waypoints(waypoints)
-
-    waypoints = ["4.9, -1.2", "1.2, 2.2"]
-
-    assert_equal 'waypoint.0=4.9%2C+-1.2&waypoint.1=1.2%2C+2.2',
-      BR.format_waypoints(waypoints)
-
-    assert_equal nil, BR.format_waypoints(nil)
-  end
-
   def test_cls_path
     assert_match %r[Route], BR.path
   end

metadata

@@ -1,136 +1,154 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bing
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Adam Avilla
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: net-http-persistent
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 5
-        - 3
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.5.3
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: git
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: ZenTest
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 10
-        version: "2.10"
+      - !ruby/object:Gem::Version
+        version: '3.12'
   type: :development
-  version_requirements: *id007
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 description: Bing api client library that exposes all of Bing's api features.
-email: 
+email:
 - adam@avil.la
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
-files: 
+files:
 - .autotest
 - .gitignore
 - History.txt
@@ -140,6 +158,7 @@ files:
 - lib/bing.rb
 - lib/bing/core_ext.rb
 - lib/bing/errors.rb
+- lib/bing/imagery.rb
 - lib/bing/location.rb
 - lib/bing/request.rb
 - lib/bing/rest_resource.rb
@@ -147,6 +166,7 @@ files:
 - lib/bing/route/itinerary.rb
 - test/helper.rb
 - test/test_bing.rb
+- test/test_bing_imagery.rb
 - test/test_bing_location.rb
 - test/test_bing_request.rb
 - test/test_bing_rest_resource.rb
@@ -155,44 +175,38 @@ files:
 - test/test_core_ext.rb
 - .gemtest
 homepage: https://github.com/hekaldama/bing
-licenses: []
-
+licenses:
+- MIT
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.txt
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: bing
-rubygems_version: 1.8.6
+rubyforge_project: 
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Bing api client library that exposes all of Bing's api features.
-test_files: 
+test_files:
+- test/test_bing_route_itinerary.rb
 - test/test_bing.rb
-- test/test_bing_location.rb
-- test/test_bing_rest_resource.rb
-- test/test_core_ext.rb
 - test/test_bing_route.rb
-- test/test_bing_route_itinerary.rb
+- test/test_bing_rest_resource.rb
 - test/test_bing_request.rb
+- test/test_bing_imagery.rb
+- test/test_core_ext.rb
+- test/test_bing_location.rb