carlosparamio-geoplanet 0.1.1 → 0.1.3

data/README.rdoc

@@ -35,11 +35,11 @@ but this version supports better usage of matrix and query parameters, uses JSON
   a.placetype        # "Town"
   a.placetype_code   # 7
   a.admin1           # "Andalucia"
-	a.admin1_code      # "ES-AN"
-	a.admin1_placetype # "Autonomous Community"
-	a.admin2           # "Cadiz"
-	a.admin2_code      # ""
-	a.admin2_placetype # "Province"
+  a.admin1_code      # "ES-AN"
+  a.admin1_placetype # "Autonomous Community"
+  a.admin2           # "Cadiz"
+  a.admin2_code      # ""
+  a.admin2_placetype # "Province"
   a.latitude         # 36.127602
                      # Latitude and Longitude are values at Centroid
   a.bounding_box     # [[36.109779, -5.47725], [36.164268, -5.43527]]
@@ -56,6 +56,26 @@ but this version supports better usage of matrix and query parameters, uses JSON
 
   # Postal Codes at Algeciras
   a.children(:select => "long", :type => 11)
+  
+  # You can use multiple types on the same query.
+  # e.g. Country and Province for Algeciras
+  a.belongtos(:type => [12, 9])
+  
+  # You can specify the language you want for the results.
+  a.belongtos(:type => 12, :lang => 'es_ES').first.name  # España
+  
+  a = GeoPlanet::Place.new(752067, :lang => :es)
+  a.country  # España
+
+=== Debug Mode
+
+If you want to look at the requests that are being executed against the Yahoo GeoPlanet API, you can enable the debug mode. It uses the standard output.
+
+  GeoPlanet.debug = true
+  GeoPlanet::Place.new(752067, :lang => :es)
+  # outputs:
+  # Yahoo GeoPlanet: GET http://where.yahooapis.com/v1/place/752067?appid=[your_appid]&format=json&lang=es
+
 
 == REQUIREMENTS:
 
@@ -69,7 +89,7 @@ Additionally, geoplanet has the following gem dependencies:
 
 == INSTALL:
 
-* gem install carlosparamiogeoplanet --source http://gems.github.com
+* gem install carlosparamio-geoplanet --source http://gems.github.com
 
 == LICENSE:
 

data/geoplanet.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "geoplanet"
-  s.version  = "0.1.1"
-  s.date     = "2009-02-25"
+  s.version  = "0.1.3"
+  s.date     = "2009-02-26"
   s.summary  = "A Ruby wrapper for the Yahoo! GeoPlanet API."
   s.email    = "carlosparamio@gmail.com"
   s.homepage = "http://github.com/carlosparamio/geoplanet/"
@@ -22,6 +22,6 @@ Gem::Specification.new do |s|
   s.add_dependency("rest-client",   [">= 0.9"])
   s.add_dependency("json", [">= 1.1.3"])
   
-  s.has_rdoc = true
+  s.has_rdoc = false
   s.rdoc_options = ["--main", "README.rdoc"]
 end

data/lib/geoplanet/base.rb

@@ -10,7 +10,7 @@ module GeoPlanet
 
         query_params[:appid] ||= GeoPlanet.appid # use default appid if not provided
 
-        raise ArgumentError if query_params[:appid].nil? || resource_path == 'places' && filters[:q].nil? # required
+        raise ArgumentError, "appid or q filter missing" if query_params[:appid].nil? || resource_path == 'places' && filters[:q].nil? # required
 
         q = ".q('#{filters[:q]}')" if filters[:q]
         type = ".type('#{filters[:type].is_a?(Array) ? filters[:type].to_a.join(',') : filters[:type]}')" if filters[:type]
@@ -28,11 +28,9 @@ module GeoPlanet
       def get(url)
         RestClient.get(url)
       rescue RestClient::RequestFailed
-        raise BadRequest, "appid or q filter invalid"
+        raise BadRequest, "appid, q filter or format invalid"
       rescue RestClient::ResourceNotFound
         raise NotFound, "woeid or URI invalid"
-      rescue RestClient::RequestFailed
-        raise NotAcceptable, "format invalid"
       end
 
       protected

data/lib/geoplanet/place.rb

@@ -14,18 +14,18 @@ module GeoPlanet
     alias_method :lat, :latitude 
     alias_method :lon, :longitude
 
-    def initialize(woe_or_attrs)
+    def initialize(woe_or_attrs, options = {})
       case woe_or_attrs
-      when Integer then initialize_with_woe(woe_or_attrs)
+      when Integer then initialize_with_woe(woe_or_attrs, options)
       when Hash    then initialize_with_attrs(woe_or_attrs)
       else
         raise ArgumentError
       end
     end
     
-    def initialize_with_woe(woe)
-      url = self.class.build_url("place/#{woe}", :format => "json")
-      puts "Yahoo GeoPlanet: GET #{url}"
+    def initialize_with_woe(woe, options = {})
+      url = self.class.build_url("place/#{woe}", options.merge(:format => "json"))
+      puts "Yahoo GeoPlanet: GET #{url}" if GeoPlanet.debug
       initialize_with_attrs JSON.parse(Place.get(url))['place']
     end
     
@@ -75,7 +75,7 @@ module GeoPlanet
       self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{association}(options = {})
           url = Place.build_url("place/\#{self.woeid}/#{association}", options.merge(:format => "json"))
-          puts "Yahoo GeoPlanet: GET \#{url}"
+          puts "Yahoo GeoPlanet: GET \#{url}" if GeoPlanet.debug
           Place.get_then_parse(url)
         end
       RUBY
@@ -93,7 +93,7 @@ module GeoPlanet
       def search(text, options = {})
         text = URI.encode(text)
         url = build_url('places', options.merge(:q => text, :format => 'json'))
-        puts "Yahoo GeoPlanet: GET #{url}"
+        puts "Yahoo GeoPlanet: GET #{url}" if GeoPlanet.debug
         get_then_parse(url)
       end
       
@@ -102,6 +102,8 @@ module GeoPlanet
         return results['places']['place'].map{|attrs| Place.new attrs} if results['places']
         return Place.new(results['place']) if results['place']
         nil
+      rescue
+        nil
       end
     end
   end

data/lib/geoplanet/version.rb

@@ -2,7 +2,7 @@ module GeoPlanet
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 1
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/geoplanet.rb

@@ -9,7 +9,7 @@ module GeoPlanet
   API_URL     = "http://where.yahooapis.com/#{API_VERSION}/"
     
   class << self
-    attr_accessor :appid
+    attr_accessor :appid, :debug
   end
 
   class BadRequest           < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: carlosparamio-geoplanet
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors: 
 - Carlos Paramio
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-25 00:00:00 -08:00
+date: 2009-02-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,7 @@ files:
 - lib/geoplanet/base.rb
 - lib/geoplanet/place.rb
 - lib/geoplanet/version.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/carlosparamio/geoplanet/
 post_install_message: 
 rdoc_options: