ya_yahoo_geocode 0.0.3 → 0.0.4

data/lib/ya_yahoo_geocode/client.rb

@@ -4,21 +4,35 @@ module YaYahooGeocode
     @@YAHOO_GEOCODE_ENDPOINT = 'http://where.yahooapis.com/geocode'
     @@YAHOO_PLACES_ENDPOINT = 'http://where.yahooapis.com/v1/place'
 
+    attr_accessor :app_id
+
+    def initialize(app_id = nil) 
+      self.app_id = app_id 
+    end 
+
     def search_for_place(search_terms)
       begin 
         url = @@YAHOO_GEOCODE_ENDPOINT + '?q=' + URI::escape(search_terms)
-        response = do_http_get(url)
-        response_hash = Nori.parse(response)['ResultSet']
+        url += '&appid=' + app_id if app_id #app_id is optional for this service call
+        do_search(url)
+      rescue Exception => e 
+        raise "Error searching for location: #{search_terms.inspect}.  Got error:  #{e.message}"
+      end 
+    end 
+
+    def search_for_place_by_location(lat, lon)
+      begin 
+        url = @@YAHOO_GEOCODE_ENDPOINT + '?q=' + lat.to_s + '+' + lon.to_s + '&gflags=R'
+        url += '&appid=' + app_id if app_id #app_id is optional for this service call
+        do_search(url)
       rescue Exception => e 
         raise "Error searching for location: #{search_terms.inspect}.  Got error:  #{e.message}"
       end 
-      handle_errors(response_hash, search_terms)
-      select_match(response_hash)
     end 
 
     def get_place_by_woeid(woeid) 
       begin 
-        url = @@YAHOO_PLACES_ENDPOINT + '/' + woeid.to_s + '?appid=' + 'g9.D9ZTV34Ehp4lJeRQCgIWfBYBQ9NumiUYf76y3LFB3xbI7XU1fDB70uJgsBFkQ'
+        url = @@YAHOO_PLACES_ENDPOINT + '/' + woeid.to_s + '?appid=' + app_id.to_s #app_id is required
         response = do_http_get(url)
         response = Nori.parse(response)
         response['place']
@@ -27,16 +41,21 @@ module YaYahooGeocode
       end 
     end 
 
-
-    
     private 
+    def do_search(url) 
+      response = do_http_get(url)
+      response_hash = Nori.parse(response)['ResultSet']
+      handle_errors(response_hash)
+      select_match(response_hash)
+    end 
+
     def do_http_get(url) 
       Net::HTTP.get_response(URI.parse(url)).body.to_s
     end 
 
-    def handle_errors(response_hash, search_terms) 
+    def handle_errors(response_hash) 
       if response_hash['Error'].to_i > 0 
-        raise "Error searching for location: #{search_terms.inspect}.  Got error:  #{response_hash['ErrorMessage']}"
+        raise "#{response_hash['ErrorMessage']}"
       end 
     end 
 

data/lib/ya_yahoo_geocode/version.rb

@@ -1,3 +1,3 @@
 module YaYahooGeocode
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/ya_yahoo_geocode/client_spec.rb

@@ -0,0 +1,100 @@
+require './lib/ya_yahoo_geocode'
+
+describe YaYahooGeocode::Client do 
+
+  def sample_search_for_place
+    # just copy the output of a successful call
+    <<END 
+<?xml version="1.0" encoding="UTF-8"?>
+<ResultSet version="1.0"><Error>0</Error><ErrorMessage>No error</ErrorMessage><Locale>us_US</Locale><Quality>50</Quality><Found>1</Found><Result><quality>50</quality><latitude>40.796761</latitude><longitude>-73.942207</longitude><offsetlat>40.796761</offsetlat><offsetlon>-73.942207</offsetlon><radius>2100</radius><name></name><line1></line1><line2>East Harlem, NY  10029</line2><line3></line3><line4>United States</line4><house></house><street></street><xstreet></xstreet><unittype></unittype><unit></unit><postal>10029</postal><neighborhood>East Harlem</neighborhood><city>New York</city><county>New York County</county><state>New York</state><country>United States</country><countrycode>US</countrycode><statecode>NY</statecode><countycode></countycode><uzip>10029</uzip><hash></hash><woeid>23511892</woeid><woetype>22</woetype></Result></ResultSet>
+<!-- gws25.maps.re3.yahoo.com uncompressed/chunked Fri Jun 10 13:42:37 PDT 2011 -->
+END
+  end 
+
+  def sample_search_for_place_by_woeid 
+    <<END 
+<?xml version="1.0" encoding="UTF-8"?>
+<ResultSet version="1.0"><Error>0</Error><ErrorMessage>No error</ErrorMessage><Locale>us_US</Locale><Quality>50</Quality><Found>1</Found><Result><quality>50</quality><latitude>40.796761</latitude><longitude>-73.942207</longitude><offsetlat>40.796761</offsetlat><offsetlon>-73.942207</offsetlon><radius>2100</radius><name></name><line1></line1><line2>East Harlem, NY  10029</line2><line3></line3><line4>United States</line4><house></house><street></street><xstreet></xstreet><unittype></unittype><unit></unit><postal>10029</postal><neighborhood>East Harlem</neighborhood><city>New York</city><county>New York County</county><state>New York</state><country>United States</country><countrycode>US</countrycode><statecode>NY</statecode><countycode></countycode><uzip>10029</uzip><hash></hash><woeid>23511892</woeid><woetype>22</woetype></Result></ResultSet>
+<!-- gws25.maps.re3.yahoo.com uncompressed/chunked Fri Jun 10 13:42:37 PDT 2011 -->
+END
+  end 
+
+  def sample_get_place_by_woeid
+  <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<place xmlns="http://where.yahooapis.com/v1/schema.rng" xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" yahoo:uri="http://where.yahooapis.com/v1/place/28751381" xml:lang="en-US"><woeid>28751381</woeid><placeTypeName code="22">Suburb</placeTypeName><name>Midtown</name><country type="Country" code="US">United States</country><admin1 type="State" code="US-NY">New York</admin1><admin2 type="County" code="">Manhattan</admin2><admin3></admin3><locality1 type="Town">New York</locality1><locality2 type="Suburb">Midtown</locality2><postal type="Zip Code">10017</postal><centroid><latitude>40.751122</latitude><longitude>-73.977859</longitude></centroid><boundingBox><southWest><latitude>40.734409</latitude><longitude>-73.996986</longitude></southWest><northEast><latitude>40.767841</latitude><longitude>-73.958817</longitude></northEast></boundingBox><areaRank>2</areaRank><popRank>0</popRank></place>
+END
+  end 
+
+  
+  it "should instantiate" do 
+    YaYahooGeocode::Client.new 
+  end 
+
+  describe "app_id" do 
+    it "should not have an app_id by default" do 
+      YaYahooGeocode::Client.new.app_id.should be_nil
+    end 
+    it "should accept the app_id at init" do 
+      client = YaYahooGeocode::Client.new('12345')
+      client.app_id.should == '12345'
+    end 
+    it "should accept the app_id with a setter" do 
+      client = YaYahooGeocode::Client.new
+      client.app_id = '12345'
+      client.app_id.should == '12345'
+    end 
+  end 
+
+  describe "#search_for_place" do 
+    context "all goes well" do 
+      before :each do 
+        @client = YaYahooGeocode::Client.new
+        @client.stub!(:do_http_get).and_return(sample_search_for_place)
+      end 
+      it "should find a  result for 'East Harlem, NY, NY'" do 
+        place_details = @client.search_for_place("East Harlem, NY, NY")
+        place_details['line2'].should include("East Harlem")
+      end 
+    end 
+    context "error occurs" do 
+      before :each do 
+        @client = YaYahooGeocode::Client.new
+        @client.stub!(:do_http_get).and_raise("yahoo hates you")
+      end 
+      it "should raise an exception" do 
+        lambda { @client.search_for_place("East Harlem, NY, NY") }.should raise_error(RuntimeError) { | error|
+          error.message.should include("East Harlem")
+          error.message.should include("Got error")
+        }
+      end 
+    end 
+  end 
+  
+  describe "#search_for_place_by_location" do 
+    before :each do 
+        @client = YaYahooGeocode::Client.new
+        @client.stub!(:do_http_get).and_return(sample_search_for_place_by_woeid)
+    end 
+      it "should find a place" do 
+        place_details = @client.search_for_place_by_location("40.796761", "-73.942207")
+        place_details['woeid'].should == 23511892.to_s
+      end 
+  end 
+
+  describe "#get_place_by_woeid" do 
+    context "all goes well" do 
+      before :each do 
+        # Note, an app id is actually required here
+        @client = YaYahooGeocode::Client.new '12345'
+        @client.stub!(:do_http_get).and_return(sample_get_place_by_woeid)
+      end 
+
+      it "should find Midtown by 28751381" do 
+        place = @client.get_place_by_woeid(28751381)
+        place['name'].should == "Midtown"
+      end 
+    end 
+  end 
+
+end 

metadata

@@ -2,7 +2,7 @@
 name: ya_yahoo_geocode
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - John Hinnegan
@@ -52,8 +52,7 @@ files:
 - lib/ya_yahoo_geocode.rb
 - lib/ya_yahoo_geocode/client.rb
 - lib/ya_yahoo_geocode/version.rb
-- spec/ya_yahoo_geocode/client__get_place_by_woeid_spec.rb
-- spec/ya_yahoo_geocode/client__search_for_place_spec.rb
+- spec/ya_yahoo_geocode/client_spec.rb
 - ya_yahoo_geocode.gemspec
 has_rdoc: true
 homepage: ""
@@ -84,5 +83,4 @@ signing_key:
 specification_version: 3
 summary: This is a gem to help make various calls to yahoo's geo-aware api's
 test_files: 
-- spec/ya_yahoo_geocode/client__get_place_by_woeid_spec.rb
-- spec/ya_yahoo_geocode/client__search_for_place_spec.rb
+- spec/ya_yahoo_geocode/client_spec.rb

data/spec/ya_yahoo_geocode/client__get_place_by_woeid_spec.rb

@@ -1,24 +0,0 @@
-require './lib/ya_yahoo_geocode.rb' 
-
-describe YaYahooGeocode::Client do 
-  def sample 
-  <<END
-<?xml version="1.0" encoding="UTF-8"?>
-<place xmlns="http://where.yahooapis.com/v1/schema.rng" xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" yahoo:uri="http://where.yahooapis.com/v1/place/28751381" xml:lang="en-US"><woeid>28751381</woeid><placeTypeName code="22">Suburb</placeTypeName><name>Midtown</name><country type="Country" code="US">United States</country><admin1 type="State" code="US-NY">New York</admin1><admin2 type="County" code="">Manhattan</admin2><admin3></admin3><locality1 type="Town">New York</locality1><locality2 type="Suburb">Midtown</locality2><postal type="Zip Code">10017</postal><centroid><latitude>40.751122</latitude><longitude>-73.977859</longitude></centroid><boundingBox><southWest><latitude>40.734409</latitude><longitude>-73.996986</longitude></southWest><northEast><latitude>40.767841</latitude><longitude>-73.958817</longitude></northEast></boundingBox><areaRank>2</areaRank><popRank>0</popRank></place>
-END
-  end 
-
-  describe "#get_place_by_woeid" do 
-    context "all goes well" do 
-      before :each do 
-        @client = YaYahooGeocode::Client.new 
-        @client.stub!(:do_http_get).and_return(sample)
-      end 
-
-      it "should find Midtown by 28751381" do 
-        place = @client.get_place_by_woeid(28751381)
-        place['name'].should == "Midtown"
-      end 
-    end 
-  end 
-end 

data/spec/ya_yahoo_geocode/client__search_for_place_spec.rb

@@ -1,42 +0,0 @@
-require './lib/ya_yahoo_geocode'
-
-describe YaYahooGeocode::Client do 
-
-  def sample
-    # just copy the output of a successful call
-    <<END 
-<?xml version="1.0" encoding="UTF-8"?>
-<ResultSet version="1.0"><Error>0</Error><ErrorMessage>No error</ErrorMessage><Locale>us_US</Locale><Quality>50</Quality><Found>1</Found><Result><quality>50</quality><latitude>40.796761</latitude><longitude>-73.942207</longitude><offsetlat>40.796761</offsetlat><offsetlon>-73.942207</offsetlon><radius>2100</radius><name></name><line1></line1><line2>East Harlem, NY  10029</line2><line3></line3><line4>United States</line4><house></house><street></street><xstreet></xstreet><unittype></unittype><unit></unit><postal>10029</postal><neighborhood>East Harlem</neighborhood><city>New York</city><county>New York County</county><state>New York</state><country>United States</country><countrycode>US</countrycode><statecode>NY</statecode><countycode></countycode><uzip>10029</uzip><hash></hash><woeid>23511892</woeid><woetype>22</woetype></Result></ResultSet>
-<!-- gws25.maps.re3.yahoo.com uncompressed/chunked Fri Jun 10 13:42:37 PDT 2011 -->
-END
-  end 
-  
-  it "should instantiate" do 
-    YaYahooGeocode::Client.new 
-  end 
-
-  describe "#search_for_place" do 
-    context "all goes well" do 
-      before :each do 
-        @client = YaYahooGeocode::Client.new
-        @client.stub!(:do_http_get).and_return(sample)
-      end 
-      it "should find a  result for 'East Harlem, NY, NY'" do 
-        place_details = @client.search_for_place("East Harlem, NY, NY")
-        place_details['line2'].should include("East Harlem")
-      end 
-    end 
-    context "error occurs" do 
-      before :each do 
-        @client = YaYahooGeocode::Client.new
-        @client.stub!(:do_http_get).and_raise("yahoo hates you")
-      end 
-      it "should raise an exception" do 
-        lambda { @client.search_for_place("East Harlem, NY, NY") }.should raise_error(RuntimeError) { | error|
-          error.message.should include("East Harlem")
-          error.message.should include("Got error")
-        }
-      end 
-    end 
-  end 
-end