overlord 0.1.1 → 0.1.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Justin Ball
+Copyright (c) 2009 Tatemae
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -4,6 +4,8 @@ Talk to the Google ajax apis and render the results.  This gem contains several
 out to the Google Ajax Apis (http://code.google.com/apis/ajax/).
 
 == Usage
+
+=== Settings
 This gem requires some configuration before it will work in your Rails application:
 You will need a global_config file with 'google_ajax_api_key' defined.  You can set it up thus:
 
@@ -46,9 +48,9 @@ Then in global_config.yml:
 
     application_url: 'localhost:3000'
 
-
+=== Models
 If you want to use the methods 'convert_google_feed_json_to_feed', 'convert_google_find_feeds_json_to_feeds', and 
-'convert_google_feed_json_to_entries' you will also need a Feed and Entry class with specific attributes.  See the rails application
+'convert_google_feed_json_to_entries' you will also need a Feed, Service and Entry class with specific attributes.  See the rails application
 inside of the test directory for more information on how to create these classes.
 
   # Required attributes:
@@ -111,4 +113,4 @@ inside of the test directory for more information on how to create these classes
                          
 == Copyright
 
-Copyright (c) 2009 Justin Ball. See LICENSE for details.
+Copyright (c) 2009 Tatemae. See LICENSE for details.

data/Rakefile

@@ -9,9 +9,9 @@ begin
     gem.name = "overlord"
     gem.summary = "Talk with our Google overlords"
     gem.description = "Code to interact with the google ajax apis on the server and the client."
-    gem.email = "justinball@gmail.com"
+    gem.email = "justin@tatemae.com"
     gem.homepage = "http://github.com/jbasdf/overlord"
-    gem.authors = ["Justin Ball"]
+    gem.authors = ["Justin Ball", "Joel Duffin"]
     gem.add_development_dependency "thoughtbot-shoulda"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/app/helpers/overlord_google_helper.rb

@@ -125,6 +125,20 @@ module OverlordGoogleHelper
     render :partial => 'google/slide_show', :locals => { :feed => feed, :content_id => content_id, :options => options }
   end
 
+  # Generate a google map that includes the location of each item in 
+  # mapped_objects.  Each object in mapped_objects must define a lat and lng attribute.
+  # 
+  # mapped_objects:  Collection of objects to be mapped.
+  # content_id: Name of the div that will hold the widget google generates.
+  #             If this method is called more than once on a given page then you will need to 
+  #             specify different content_ids for each call.
+  # options:    A hash containing the values to pass to the Google widget.
+  def google_map(mapped_objects,
+                content_id = 'map_content',
+                options = {})
+    render :partial => 'google/map', :locals => { :mapped_objects => mapped_objects, :content_id => content_id, :options => options }
+  end
+  
   # Given a feed attempts to assign an appropriate class
   def feed_class(feed)
     return '' if feed.service.blank?
@@ -287,6 +301,13 @@ module OverlordGoogleHelper
     google_ajax_api_scripts + '<script type="text/javascript">google.load("search", "1");</script>'
   end
   
+  # Output include script for google maps
+  def google_load_maps
+    return '' if defined?(@google_load_maps_included)
+    @google_load_maps_included = true
+    google_ajax_api_scripts + '<script type="text/javascript">google.load("maps", "2");</script>'
+  end
+  
   # Output include script to load jquery from google
   def google_load_jquery
     return '' if defined?(@google_load_jquery_included)

data/app/views/google/_map.html.erb

@@ -0,0 +1,56 @@
+<% content_for :head do -%>
+  <%= google_load_maps -%>
+<% end -%>
+
+<script type="text/javascript">
+google.setOnLoadCallback(function() {
+  if (google.maps.BrowserIsCompatible()) {
+    var map = new google.maps.Map2(document.getElementById("<%=content_id%>"));
+    map.setCenter(new google.maps.LatLng(37.4419, -122.1419), 13);
+    map.addControl(new google.maps.SmallMapControl());
+    map.addControl(new google.maps.MapTypeControl());
+
+    // Create a base icon for all of our markers that specifies the
+    // shadow, icon dimensions, etc.
+    var baseIcon = new google.maps.Icon(G_DEFAULT_ICON);
+    baseIcon.shadow = "http://www.google.com/mapfiles/shadow50.png";
+    baseIcon.iconSize = new google.maps.Size(20, 34);
+    baseIcon.shadowSize = new google.maps.Size(37, 34);
+    baseIcon.iconAnchor = new google.maps.Point(9, 34);
+    baseIcon.infoWindowAnchor = new google.maps.Point(9, 2);
+
+    // Creates a marker whose info window displays the letter corresponding
+    // to the given index.
+    function createMarker(point, index) {
+      // Create a lettered icon for this point using our icon class
+      var letter = String.fromCharCode("A".charCodeAt(0) + index);
+      var letteredIcon = new google.maps.Icon(baseIcon);
+      letteredIcon.image = "http://www.google.com/mapfiles/marker" + letter + ".png";
+
+      // Set up our google.maps.MarkerOptions object
+      markerOptions = { icon:letteredIcon };
+      var marker = new google.maps.Marker(point, markerOptions);
+
+      google.maps.Event.addListener(marker, "click", function() {
+        marker.openInfoWindowHtml("Marker <b>" + letter + "</b>");
+      });
+      return marker;
+    }
+
+    // Add 10 markers to the map at random locations
+    var bounds = map.getBounds();
+    var southWest = bounds.getSouthWest();
+    var northEast = bounds.getNorthEast();
+    var lngSpan = northEast.lng() - southWest.lng();
+    var latSpan = northEast.lat() - southWest.lat();
+    for (var i = 0; i < 10; i++) {
+      var latlng = new google.maps.LatLng(southWest.lat() + latSpan * Math.random(),
+        southWest.lng() + lngSpan * Math.random());
+      map.addOverlay(createMarker(latlng, i));
+    }
+  }
+});
+</script>
+
+onunload="google.maps.Unload()"
+<div id="<%=content_id%>" style="width: 500px; height: 300px"></div>

data/lib/overlord/google_search_request.rb

@@ -0,0 +1,85 @@
+module Overlord
+  # Google ajax search api reference:
+  # http://code.google.com/apis/ajaxsearch/documentation
+  #
+  # Google code playground:
+  # http://code.google.com/apis/ajax/playground
+  #
+  class GoogleSearchRequest
+    include HTTParty
+    format :json
+  
+    # Initialize Google Request.
+    # Parameters:
+    # api_key_id:     Valid Google access key (optional)
+    def initialize(api_key_id = nil)
+      @api_key_id = api_key_id
+    end
+  
+    # Run a local search
+    # Google docs:
+    # http://code.google.com/apis/ajaxsearch/documentation/reference.html#_fonje_local
+    # For example:
+    # rsz     This optional argument supplies the number of results that the application would like to recieve. A value of small 
+    #         indicates a small result set size or 4 results. A value of large indicates a large result set or 8 results. 
+    #         If this argument is not supplied, a value of small is assumed.
+    # start   This optional argument supplies the start index of the first search result. Each successful response contains 
+    #         a cursor object (see below) which includes an array of pages. The start property for a page may be used as a 
+    #         valid value for this argument.
+    #
+    # Pass any of the standard search options:
+    #  http://code.google.com/apis/ajaxsearch/documentation/reference.html#_intro_fonje
+    #
+    # Pass any of the following options:
+    # sll     This optional argument supplies the search center point for a local search. It's value is a comma separated latitude/longitude pair, e.g., sll=48.8565,2.3509.
+    # sspn    This optional argument supplies a bounding box that the local search should be relative to. When using a Google Map, the sspn value can be computed using: myMap.getBounds().toSpan().toUrlValue(); (e.g., sspn=0.065169,0.194149).
+    # mrt     This optional argument specifies which type of listing the user is interested in. Valid values include:
+    #    * blended - request KML, Local Business Listings, and Geocode results
+    #    * kmlonly - request KML and Geocode results
+    #    * localonly - request Local Business Listings and Geocode results
+    #     If this argument is not supplied, the default value of localonly is used.
+    # 
+    def self.local_search(query, options = {})
+      get('http://ajax.googleapis.com/ajax/services/search/local', :query => build_google_query(options.merge(:q => query)))
+    end
+
+    # Converts json returned from google into a feed object
+    # Each object has the following attributes.  For more details on each attribute see http://code.google.com/apis/ajaxsearch/documentation/reference.html#_intro_fonje
+    # viewportmode      "computed"
+    # country           "United States"
+    # streetAddress     "300 Grove St"
+    # region            "CA"
+    # titleNoFormatting "Jardiniere Restaurant"
+    # ddUrlFromHere     "http://www.google.com/maps?source=uds&saddr=300+Grove+St%2C+San+Francisco%2C+CA+%28Jardiniere+Restaurant%29+%4037.778127%2C-122.421735&iwstate1=dir%3Afrom"
+    # content           ""
+    # ddUrlToHere       "http://www.google.com/maps?source=uds&daddr=300+Grove+St%2C+San+Francisco%2C+CA+%28Jardiniere+Restaurant%29+%4037.778127%2C-122.421735&iwstate1=dir%3Ato"
+    # url               "http://www.google.com/local?source=uds&q=food&sll=37.778127%2C-122.421735&latlng=37778127%2C-122421735%2C16134753875200198327&near=37.778127%2C-122.421735"
+    # city              "San Francisco"
+    # accuracy          "8"
+    # phoneNumbers      [{"number"=>"(415) 861-5555", "type"=>""}, {"number"=>"(415) 555-1212", "type"=>""}]
+    # listingType       "local"
+    # maxAge            604800
+    # title             "Jardiniere Restaurant"
+    # ddUrl             "http://www.google.com/maps?source=uds&daddr=300+Grove+St%2C+San+Francisco%2C+CA+%28Jardiniere+Restaurant%29+%4037.778127%2C-122.421735&saddr"
+    # staticMapUrl      "http://mt.google.com/mapdata?cc=us&tstyp=5&Point=b&Point.latitude_e6=37778127&Point.longitude_e6=-122421735&Point.iconid=15&Point=e&w=150&h=100&zl=4"
+    # GsearchResultClass  "GlocalSearch"
+    # lat               "37.778127"
+    # addressLines      ["300 Grove St", "San Francisco, CA"]
+    # lng               "-122.421735"
+    def self.convert_google_search_json_to_objects(json)
+      if json['responseStatus'] == 200
+        if json['responseData']['results']
+          json['responseData']['results'].collect{ |result| OpenStruct.new(result) }
+        end
+      end
+    end
+    
+    # Add standard items to the google query
+    def self.build_google_query(query_options)
+      query_options[:v] = '1.0'
+      query_options[:key] = GlobalConfig.google_ajax_api_key if GlobalConfig.google_ajax_api_key
+      query_options
+    end
+  
+  end
+end

data/overlord.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{overlord}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Justin Ball"]
-  s.date = %q{2009-10-31}
+  s.authors = ["Justin Ball", "Joel Duffin"]
+  s.date = %q{2009-11-30}
   s.description = %q{Code to interact with the google ajax apis on the server and the client.}
-  s.email = %q{justinball@gmail.com}
+  s.email = %q{justin@tatemae.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -30,10 +30,12 @@ Gem::Specification.new do |s|
      "app/views/google/_feed_search.html.erb",
      "app/views/google/_feeds_scripts.html.erb",
      "app/views/google/_hot_trends.html.erb",
+     "app/views/google/_map.html.erb",
      "app/views/google/_search.html.erb",
      "app/views/google/_slide_show.html.erb",
      "lib/overlord.rb",
      "lib/overlord/google_feed_request.rb",
+     "lib/overlord/google_search_request.rb",
      "overlord.gemspec",
      "rails/init.rb",
      "test/rails_root/.gitignore",
@@ -51,6 +53,7 @@ Gem::Specification.new do |s|
      "test/rails_root/app/views/default/google_dynamic_feeds_vertical.html.erb",
      "test/rails_root/app/views/default/google_feed_search.html.erb",
      "test/rails_root/app/views/default/google_feeds.html.erb",
+     "test/rails_root/app/views/default/google_map.html.erb",
      "test/rails_root/app/views/default/google_search.html.erb",
      "test/rails_root/app/views/default/google_slide_show.html.erb",
      "test/rails_root/app/views/default/index.html.erb",
@@ -577,7 +580,8 @@ Gem::Specification.new do |s|
      "test/rails_root/test/shoulda_macros/plugins.rb",
      "test/rails_root/test/test_helper.rb",
      "test/rails_root/test/unit/.keep",
-     "test/rails_root/test/unit/google_feed_request_test.rb"
+     "test/rails_root/test/unit/google_feed_request_test.rb",
+     "test/rails_root/test/unit/google_search_request_test.rb"
   ]
   s.homepage = %q{http://github.com/jbasdf/overlord}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -623,7 +627,8 @@ Gem::Specification.new do |s|
      "test/rails_root/test/shoulda_macros/pagination.rb",
      "test/rails_root/test/shoulda_macros/plugins.rb",
      "test/rails_root/test/test_helper.rb",
-     "test/rails_root/test/unit/google_feed_request_test.rb"
+     "test/rails_root/test/unit/google_feed_request_test.rb",
+     "test/rails_root/test/unit/google_search_request_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/rails_root/app/controllers/default_controller.rb

@@ -23,7 +23,11 @@ class DefaultController < ApplicationController
   def google_slide_show
     @feed = Feed.new(:uri => 'feed://api.flickr.com/services/feeds/photos_public.gne?tags=autumn&lang=en-us&format=rss_200')
   end
-    
+  
+  def google_map
+    @mapped_objects = []
+  end
+      
   def setup
     @terms = CGI.unescape('mountain biking')
 

data/test/rails_root/app/views/default/google_map.html.erb

@@ -0,0 +1 @@
+<%= google_map(@mapped_objects) %>

data/test/rails_root/test/unit/google_feed_request_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require File.dirname(__FILE__) + '/../test_helper'
 
 class GoogleFeedRequestTest < ActiveSupport::TestCase 
   

data/test/rails_root/test/unit/google_search_request_test.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GoogleSearchRequestTest < ActiveSupport::TestCase 
+  
+  context "google search requests" do
+    setup do
+    end
+    
+    context "local search" do
+      setup do
+        @results = Overlord::GoogleSearchRequest.local_search('food')
+      end
+      should "get local search results" do
+        assert @results.length > 0
+        assert_equal 200, @results['responseStatus']
+      end
+      should "convert google json into objects" do
+        @objects = Overlord::GoogleSearchRequest.convert_google_search_json_to_objects(@results)
+        assert @objects.length > 0
+        assert @objects[0].country
+      end
+    end
+
+  end
+  
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: overlord
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Justin Ball
+- Joel Duffin
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-31 00:00:00 -06:00
+date: 2009-11-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +24,7 @@ dependencies:
         version: "0"
     version: 
 description: Code to interact with the google ajax apis on the server and the client.
-email: justinball@gmail.com
+email: justin@tatemae.com
 executables: []
 
 extensions: []
@@ -45,10 +46,12 @@ files:
 - app/views/google/_feed_search.html.erb
 - app/views/google/_feeds_scripts.html.erb
 - app/views/google/_hot_trends.html.erb
+- app/views/google/_map.html.erb
 - app/views/google/_search.html.erb
 - app/views/google/_slide_show.html.erb
 - lib/overlord.rb
 - lib/overlord/google_feed_request.rb
+- lib/overlord/google_search_request.rb
 - overlord.gemspec
 - rails/init.rb
 - test/rails_root/.gitignore
@@ -66,6 +69,7 @@ files:
 - test/rails_root/app/views/default/google_dynamic_feeds_vertical.html.erb
 - test/rails_root/app/views/default/google_feed_search.html.erb
 - test/rails_root/app/views/default/google_feeds.html.erb
+- test/rails_root/app/views/default/google_map.html.erb
 - test/rails_root/app/views/default/google_search.html.erb
 - test/rails_root/app/views/default/google_slide_show.html.erb
 - test/rails_root/app/views/default/index.html.erb
@@ -593,6 +597,7 @@ files:
 - test/rails_root/test/test_helper.rb
 - test/rails_root/test/unit/.keep
 - test/rails_root/test/unit/google_feed_request_test.rb
+- test/rails_root/test/unit/google_search_request_test.rb
 has_rdoc: true
 homepage: http://github.com/jbasdf/overlord
 licenses: []
@@ -661,3 +666,4 @@ test_files:
 - test/rails_root/test/shoulda_macros/plugins.rb
 - test/rails_root/test/test_helper.rb
 - test/rails_root/test/unit/google_feed_request_test.rb
+- test/rails_root/test/unit/google_search_request_test.rb