carlosparamio-geoplanet 0.1.0 → 0.1.1

data/geoplanet.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "geoplanet"
-  s.version  = "0.1.0"
+  s.version  = "0.1.1"
   s.date     = "2009-02-25"
   s.summary  = "A Ruby wrapper for the Yahoo! GeoPlanet API."
   s.email    = "carlosparamio@gmail.com"

data/lib/geoplanet/base.rb

@@ -1,14 +1,16 @@
 module GeoPlanet
   class Base
     class << self
-      def build_url(resource_name, options = {})
+      def build_url(resource_path, options = {})
+        check_options_for(resource_path, options)
+        
         filters       = extract_filters(options)
         matrix_params = extract_matrix_params(options)
         query_params  = extract_query_params(options)
 
         query_params[:appid] ||= GeoPlanet.appid # use default appid if not provided
 
-        raise ArgumentError if query_params[:appid].nil? || resource_name == 'places' && filters[:q].nil? # required
+        raise ArgumentError 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]
@@ -20,10 +22,42 @@ module GeoPlanet
         
         query_string += "#{matrix_params}#{query_params}"
         
-        "#{GeoPlanet::API_URL}#{resource_name}#{query_string}"
+        "#{GeoPlanet::API_URL}#{resource_path}#{query_string}"
+      end
+      
+      def get(url)
+        RestClient.get(url)
+      rescue RestClient::RequestFailed
+        raise BadRequest, "appid or q filter invalid"
+      rescue RestClient::ResourceNotFound
+        raise NotFound, "woeid or URI invalid"
+      rescue RestClient::RequestFailed
+        raise NotAcceptable, "format invalid"
       end
 
       protected
+      def supported_options_for(resource_path)
+        case resource_path
+        when 'places'
+          %w(q type start count lang format callback select appid)
+        when /^place\/\d+\/parent$/, /^place\/\d+\/ancestors$/, /^place\/\d+$/, 'placetype'
+          %w(lang format callback select appid)
+        when /^place\/\d+\/belongtos$/, /^place\/\d+\/children$/, 'placetypes'
+          %w(type start count lang format callback select appid)
+        when /^place\/\d+\/neighbors$/, /^place\/\d+\/siblings$/
+          %w(start count lang format callback select appid)
+        else
+          raise NotFound, "URI invalid"
+        end
+      end
+      
+      def check_options_for(resource_path, options)
+        supported = supported_options_for(resource_path)
+        unless options.keys.all?{|o| supported.include?(o.to_s)}
+          raise ArgumentError, "invalid option(s) for #{resource_path}. Supported are: #{supported.join(', ')}. You used: #{options.keys.join(', ')}"
+        end
+      end
+      
       def extract_filters(options)
         filters = %w(q type)
         Hash[*(options.select{|k,v| filters.include?(k.to_s)}).flatten(1)]

data/lib/geoplanet/place.rb

@@ -15,18 +15,22 @@ module GeoPlanet
     alias_method :lon, :longitude
 
     def initialize(woe_or_attrs)
-      attrs =
-        case woe_or_attrs
-        when Integer
-          url = self.class.build_url("place/#{woe_or_attrs}", :format => "json")
-          puts "Yahoo GeoPlanet: GET #{url}"
-          JSON.parse(RestClient.get(url))['place'] rescue nil
-        when Hash
-          woe_or_attrs
-        else
-          raise ArgumentError
-        end
-
+      case woe_or_attrs
+      when Integer then initialize_with_woe(woe_or_attrs)
+      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}"
+      initialize_with_attrs JSON.parse(Place.get(url))['place']
+    end
+    
+    
+    def initialize_with_attrs(attrs)
       @version = attrs['centroid'] ? 'long' : 'short'
 
       # short
@@ -70,12 +74,9 @@ module GeoPlanet
     %w(parent ancestors belongtos neighbors siblings children).each do |association|
       self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{association}(options = {})
-          url = self.class.build_url("place/\#{self.woeid}/#{association}", options.merge(:format => "json"))
+          url = Place.build_url("place/\#{self.woeid}/#{association}", options.merge(:format => "json"))
           puts "Yahoo GeoPlanet: GET \#{url}"
-          results = JSON.parse RestClient.get(url)
-          results['places']['place'].map{|r| Place.new(r)} rescue nil
-        rescue
-          raise GeoPlanet::Error
+          Place.get_then_parse(url)
         end
       RUBY
     end
@@ -90,12 +91,17 @@ module GeoPlanet
     
     class << self
       def search(text, options = {})
-        url = build_url('places', options.merge(:q => text, :format => "json"))
+        text = URI.encode(text)
+        url = build_url('places', options.merge(:q => text, :format => 'json'))
         puts "Yahoo GeoPlanet: GET #{url}"
-        results = JSON.parse RestClient.get(url)
-        results['places']['place'].map{|r| Place.new(r)} rescue nil
-      rescue
-        raise GeoPlanet::Error
+        get_then_parse(url)
+      end
+      
+      def get_then_parse(url)
+        results = JSON.parse get(url)
+        return results['places']['place'].map{|attrs| Place.new attrs} if results['places']
+        return Place.new(results['place']) if results['place']
+        nil
       end
     end
   end

data/lib/geoplanet/version.rb

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

data/lib/geoplanet.rb

@@ -12,5 +12,7 @@ module GeoPlanet
     attr_accessor :appid
   end
 
-  class Error < StandardError; end
+  class BadRequest           < StandardError; end
+  class NotFound             < StandardError; end
+  class NotAcceptable        < StandardError; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: carlosparamio-geoplanet
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Carlos Paramio