bing-location 0.0.1b

data/README.md

@@ -0,0 +1,9 @@
+# bing-location rubygem
+## Important
+This is nowhere near ready to be implemented. The code still includes debugging steps, please do not try to implement this without being willing to do some work to get it ready for your project
+## Ignored File 'config/api.yml'
+The file listed in .gitignore will need to be recreated with the following syntax. This file is needed to run the tests as-is. Alternatively, you can edit the API key request in the files to a string.
+    production:
+     key: YOUR API KEY 
+    development:
+     key: YOUR API KEY 

data/bing-location.gemspec

@@ -0,0 +1,12 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'bing-location'
+  s.version = '0.0.1b'
+  s.summary = 'Access the Bing Maps API by creating location objects with string based queries or geolocation data'
+  s.files = Dir.glob("**/**/**")
+  s.test_files = Dir.glob("test/*")
+  s.author = "Justin Reese"
+  s.email = "justin.x.reese@gmail.com"
+  s.has_rdoc = false
+end

data/config/api.yml

@@ -0,0 +1,4 @@
+production:
+ key: Aig7nAJS24mxOdd_jt--chlMU7NziVCGDjpElE4KXyJztr2kng_XRxiHnUFuf2cS
+development:
+ key: Aig7nAJS24mxOdd_jt--chlMU7NziVCGDjpElE4KXyJztr2kng_XRxiHnUFuf2cS

data/lib/location.rb

@@ -0,0 +1,191 @@
+require 'net/http'
+require 'tempfile'
+require 'fileutils'
+require 'yaml'
+
+# This class is a wrapper for the Bing Maps API ({API Documentation}[http://msdn.microsoft.com/en-us/library/ff701724.aspx])
+# that makes it easy to get more information about a location or create maps.
+# 
+# Currently the class is built for dealing with one object (point on a map/location).
+# 
+# =Example Usage
+#   my_loc = BingLocator.new()
+#   my_loc.api_key = "YOU-BING-MAPS-API-KEY"
+#   my_loc.country_region = 'US'
+#   my_loc.admin_district = 'PA'
+#   my_loc.locality = 'Pittsburgh'
+#   my_loc.address_line = '430 Atwood St'
+#   my_loc.obj_type = 'json'
+#   my_loc.get_obj_by_address
+#   puts my_loc.object
+#
+#
+#   my_loc = BingLocator.new()
+#   my_loc.api_key = "YOU-BING-MAPS-API-KEY"
+#   my_loc.query = 'University of Pittsburgh'
+#   puts my_loc.get_img_url_by_query(800,600)
+#
+class BingLocator
+  attr_accessor	:country_region, :admin_district, :postal_code, :locality, 
+		:address_line, :api_key, :obj_type, :query, :map_type, :show_traffic, 
+		:zoom_level, # All above are possible sent values in REST request
+		:name, :point, :latitude, :longitude, :admin_district_2, :formatted_address, :confidence, # Returned in REST object
+		:object, :image # Returned Objects
+  $img_base_url = "http://dev.virtualearth.net/REST/v1/Imagery/Map/"
+  $obj_base_url = "http://dev.virtualearth.net/REST/v1/Locations/"
+
+  # Makes assumptions for required fields that are not yet defined. Assumptions can be overridden by assigning values
+  # [country_region] Country or region, i.e. 'US'
+  # [admin_district] Administrative District. In the US this is State i.e. 'PA'
+  # [postal_code] Postal code or zip code. i.e. '15213'
+  # [locality] Locality The locality, such as the city or neighborhood, that corresponds to an address i.e. 'Pittsburgh'
+  # [address_line] The official street line of an address relative to the area i.e. '430 Atwood St'
+  # [obj_type] Type of object returned by REST request
+  # [map_type] Imagery to use for maps
+  # [zoom_level] Zoom level of a map
+  def set_defaults
+    self.country_region = '-' unless self.country_region
+    self.admin_district = '-' unless self.admin_district
+    self.postal_code    = '-' unless self.postal_code
+    self.locality       = '-' unless self.locality
+    self.address_line   = '-' unless self.address_line
+    # Allowed values - json, xml
+    self.obj_type = 'json'    unless self.obj_type
+    # Allowed values - Aerial, AerialWithLabels, Road
+    self.map_type = 'Road'    unless self.map_type
+    # Allowed values - An integer between 1 and 22 
+    self.zoom_level = '11'    unless self.zoom_level
+  end
+
+  # Uses the object's address to get a Location object from the Bing API. The object contains a normalized address, extra
+  # information, and latitude, longitude information
+  def get_obj_by_address
+    self.set_defaults
+    return 'No address set for location' if !self.country_region && !self.admin_district &&
+					    !self.postal_code && !self.locality && !self.address_line
+    # Reformat strings
+    address_line = self.address_line.gsub(' ','%20')
+    locality = self.locality.gsub(' ','%20')
+    # Build request URL
+    params = "#{self.country_region}/#{self.admin_district}/#{self.postal_code}/"
+    params += "#{locality}/#{address_line}?o=#{self.obj_type}"
+    request_url = $obj_base_url+params+"&key=#{self.api_key}"
+    # REST request !
+    begin
+      self.object = Net::HTTP.get_response(URI.parse(request_url)).body 
+      return self.object
+    rescue
+      return FALSE
+    end
+  end
+
+  # Uses the object's latitude and longitude to get a Location object from the Bing API. 
+  # The object contains a normalized address, extra information, and latitude, longitude information
+  def get_obj_by_point
+    self.set_defaults
+    return 'No latitude or longitude set for location' unless self.latitude && self.longitude
+    # Build request URL
+    params = +"#{self.latitude},#{self.longitude}?o=#{self.obj_type}"
+    request_url = $obj_base_url+params+"&key=#{self.api_key}"
+    # REST request !
+    begin
+      self.object = Net::HTTP.get_response(URI.parse(request_url)).body 
+      return self.object
+    rescue
+      return FALSE
+    end
+  end
+
+  
+  # Uses the object's query to get a Location object from the Bing API. 
+  # The object contains a normalized address, extra information, and latitude, longitude information
+  def get_obj_by_query
+    self.set_defaults
+    return 'No query set for location' if !self.query
+    query = self.query.gsub(' ','%20')
+    # Build request URL
+    params = "#{query}?o=#{self.obj_type}"
+    request_url = $obj_base_url+params+"&key=#{self.api_key}"
+    # REST request !
+    begin
+      self.object = Net::HTTP.get_response(URI.parse(request_url)).body 
+      return self.object
+    rescue
+      return FALSE
+    end
+  end
+
+  # Uses the object's query to get an image file from the Bing API.
+  #
+  # The file will be returned as a File object. To save the file use something like the following: 
+  #   File.rename(my_loc.get_img_by_query(800,600).path,'map.jpeg')
+  def get_img_by_query(width,height)
+    self.set_defaults
+    return 'No query set for location' unless self.query
+    query = self.query.gsub(' ','%20')
+    # Build request URL
+    params = "#{self.map_type}/#{query}?mapSize=#{width},#{height}"
+    params += "&mapLayer=TrafficFlow" if self.show_traffic == TRUE 
+    request_url = $img_base_url+params+"&key=#{self.api_key}"
+    # REST request !
+    begin
+      tmp = Tempfile.new('map_image.jpeg')
+      tmp.write Net::HTTP.get_response(URI.parse(request_url)).body 
+      return tmp.flush
+    rescue
+      return FALSE
+    end
+  end
+
+  # Uses the object's query to get an image url from the Bing API. Using the Bing URL is discouraged.
+  def get_img_url_by_query(width,height)
+    self.set_defaults
+    return 'No query set for location' unless self.query
+    query = self.query.gsub(' ','%20')
+    # Build request URL
+    params = "#{self.map_type}/#{query}?mapSize=#{width},#{height}"
+    params += "&mapLayer=TrafficFlow" if self.show_traffic == TRUE 
+    request_url = $img_base_url+params+"&key=#{self.api_key}"
+    return request_url
+  end
+  
+  # Uses the object's latitude and longitude to get an image url from the Bing API. 
+  # Using the Bing URL is discouraged.
+  def get_img_url_by_point(width,height)
+    self.set_defaults
+    return 'No latitude or longitude set for location' unless self.latitude && self.longitude
+    # Build request URL
+    params = "#{self.map_type}/#{self.latitude},#{self.longitude}/#{self.zoom_level}"
+    params += "?mapSize=#{width},#{height}&pushpin=#{self.latitude},#{self.longitude}"
+    params += "&mapLayer=TrafficFlow" if self.show_traffic == TRUE 
+    request_url = $img_base_url+params+"&key=#{self.api_key}"
+    return request_url
+  end
+
+  # Uses the object's latitude and longitude to get an image file from the Bing API.
+  #
+  # The file will be returned as a File object. To save the file use something like the following: 
+  #   File.rename(my_loc.get_img_by_point(800,600).path,'map.jpeg')
+  def get_img_by_point(width,height)
+    self.set_defaults
+    return 'No latitude or longitude set for location' unless self.latitude && self.longitude
+    # Build request URL
+    params = "#{self.map_type}/#{self.latitude},#{self.longitude}/#{self.zoom_level}"
+    params += "?mapSize=#{width},#{height}&pushpin=#{self.latitude},#{self.longitude}"
+    params += "&mapLayer=TrafficFlow" if self.show_traffic == TRUE 
+    request_url = $img_base_url+params+"&key=#{self.api_key}"
+    # REST request !
+    begin
+      tmp = Tempfile.new('map_image.jpeg')
+      tmp.write Net::HTTP.get_response(URI.parse(request_url)).body 
+      return tmp.flush
+    rescue
+      return FALSE
+    end
+  end
+
+  def parse_obj
+  # TODO - WRITE THIS
+  end
+
+end

data/test/api_key.rb

@@ -0,0 +1,5 @@
+require 'yaml'
+
+config = YAML.load_file('../config/api.yml')
+api_key = config['production']['key']
+puts api_key

data/test/images.rb

@@ -0,0 +1,20 @@
+require '../lib/location'
+
+my_loc = BingLocator.new()
+my_loc.api_key = YAML.load_file('../config/api.yml')['production']['key']
+
+# my_loc.country_region = 'US'
+# my_loc.admin_district = 'PA'
+ my_loc.locality = 'Pittsburgh'
+# my_loc.address_line = '48 Shady Dr W'
+# my_loc.obj_type = 'json'
+# my_loc.get_obj_by_address
+# puts my_loc.object
+
+# my_loc.query = '48 Shady Dr W Pittsburgh PA 15228'
+# my_loc.query = 'south side'
+my_loc.query = 'eifel tower'
+# my_loc.latitude = 40.383545
+# my_loc.longitude = -80.046509
+
+puts my_loc.get_img_url_by_query(800,600)

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: bing-location
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 0
+  - 1b
+  version: 0.0.1b
+platform: ruby
+authors: 
+- Justin Reese
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-07 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: justin.x.reese@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bing-location.gemspec
+- config/api.yml
+- lib/location.rb
+- README.md
+- test/api_key.rb
+- test/images.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Access the Bing Maps API by creating location objects with string based queries or geolocation data
+test_files: 
+- test/api_key.rb
+- test/images.rb