geoplanet 0.2.6 → 0.2.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48f9a1e864994edc2566bf32bb9fa7c847437fa6
+  data.tar.gz: 40ad06343c7b5a48b2dc16a683592e3c58ba975e
+SHA512:
+  metadata.gz: 7b9cb13658ac365bc6229e075f78454dccf658033be8630cfd04bf1525f3c96ef6144b599bf5341393da8aae02c48b67520f84a4ce6f5859fcbdacd9d6c5d9a1
+  data.tar.gz: 114fcc912096be99bf91f8681d99c559bb8d3e57e468552bdff1d585e2a6229345d66e44ec28f1b9b8093818b3c431dfa8c5c8e3a7aa8aaa395780fc3f7fced3

data/CONTRIBUTORS

@@ -0,0 +1 @@
+David Ramalho (https://github.com/dramalho)

data/README.rdoc

@@ -15,28 +15,31 @@ but this version supports better usage of matrix and query parameters, uses JSON
 
   require 'geoplanet'
   GeoPlanet.appid = [Your App ID Here]
-  
+
   # Search for places that matches "Springfield" (the API returns 1 by default)
   GeoPlanet::Place.search("Springfield")
-  
+
   # Search for *all* places that matches "Springfield"
   GeoPlanet::Place.search("Springfield", :count => 0)
-  
+
+  # Search for "Toronto" with focus on "Canada"
+  GeoPlanet::Place.search("Toronto", :focus => "ca")
+
   # You can pass in any Matrix or Query parameters this way too
   # For more details see the following URLs:
   # http://developer.yahoo.com/geo/guide/resources_and_collections.html#matrix_parameters
   # http://developer.yahoo.com/geo/guide/resources_and_collections.html#query_parameters
-  
+
 === Initializing by Where On Earth ID && Associations
-  
+
   require 'geoplanet'
   GeoPlanet.appid = [Your App ID Here]
-  
+
   a = GeoPlanet::Place.new(752067) # WoE ID for Algeciras
-  
+
   # Everything you get back from the API you have direct access to
   # through the Place object. For example:
-  
+
   a.version          # "long"
   a.placetype        # "Town"
   a.placetype_code   # 7
@@ -55,33 +58,36 @@ but this version supports better usage of matrix and query parameters, uses JSON
   a.area_rank        # 4
                      # Code representing the size of the place
                      # See codes at http://developer.yahoo.com/geo/geoplanet/guide/api_docs.html
-  
+
   # We unlock the true power of GeoPlanet with association collections
   # Check out this truly amazing stuff:
-  
+
   # A list of other towns in the area
   a.siblings
-  
+
   # A complete hierarchy, from country down to municipality
   a.ancestors
 
+  # All descendants for a location
+  a.descendants(count: 0)
+
   # 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
-  
+
   # It is also possible to query for any association directly using a WOE ID, without
   # create a Place object. Append a '_of' suffix to the association name to build the
   # method name to execute. The first argument is the WOE ID.
-  
+
   GeoPlanet::Place.belongtos_of(752067, :type => [12, 9])
 
 === Debug Mode
@@ -96,7 +102,7 @@ If you want to look at the requests that are being executed against the Yahoo Ge
 
 == REQUIREMENTS:
 
-To use this library, you must have a valid Yahoo! App ID. 
+To use this library, you must have a valid Yahoo! App ID.
 You can get one at http://developer.yahoo.com/wsregapp/
 
 Additionally, geoplanet has the following gem dependencies:
@@ -128,4 +134,10 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+== Credits
+
+Carlos Paramio
+
+http://h1labs.com

data/geoplanet.gemspec

@@ -1,25 +1,26 @@
 Gem::Specification.new do |s|
   s.name     = "geoplanet"
-  s.version  = "0.2.6"
-  s.date     = "2010-06-30"
+  s.version  = "0.2.7"
+  s.date     = "2014-05-09"
   s.summary  = "A Ruby wrapper for the Yahoo! GeoPlanet API."
   s.email    = "carlosparamio@gmail.com"
   s.homepage = "http://github.com/carlosparamio/geoplanet/"
   s.description = "A Ruby wrapper for the Yahoo! GeoPlanet API. It uses JSON format by default to minimize bandwidth usage. See http://developer.yahoo.com/geo/ for more information about the API."
   s.authors  = ["Carlos Paramio"]
-  
+
   s.files    = [
 		"README.rdoc",
-		"geoplanet.gemspec", 
+    "CONTRIBUTORS",
+		"geoplanet.gemspec",
 		"lib/geoplanet.rb",
 		"lib/geoplanet/base.rb",
 		"lib/geoplanet/place.rb",
 		"lib/geoplanet/version.rb"
 	]
-  
+
   s.add_dependency("rest-client",   [">= 0.9"])
   s.add_dependency("json", [">= 1.1.3"])
-  
+
   s.has_rdoc = false
   s.rdoc_options = ["--main", "README.rdoc"]
 end

data/lib/geoplanet/base.rb

@@ -3,7 +3,7 @@ module GeoPlanet
     class << self
       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)
@@ -12,19 +12,23 @@ module GeoPlanet
 
         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]
+        if filters[:q]
+          query = [filters[:q], filters[:focus]].compact.map { |t| "'#{t}'" }.join(',')
+          q = ".q(#{query})"
+        end
+
         type = ".type('#{filters[:type]}')" if filters[:type]
-        
+
         query_string = q && type ? "$and(#{q},#{type})" : "#{q}#{type}"
-        
+
         matrix_params = matrix_params.any? ? ";#{matrix_params.map{|k,v| "#{k}=#{v}"}.join(';')}" : nil
         query_params  = query_params.any? ? "?#{query_params.map{|k,v| "#{k}=#{v}"}.join('&')}" : nil
-        
+
         query_string += "#{matrix_params}#{query_params}"
-        
+
         "#{GeoPlanet::API_URL}#{resource_path}#{query_string}"
       end
-      
+
       def get(url)
         RestClient.get(url)
       rescue RestClient::RequestFailed
@@ -37,40 +41,40 @@ module GeoPlanet
       def supported_options_for(resource_path)
         case resource_path
         when 'places'
-          %w(q type start count lang format callback select appid)
+          %w(q type start count lang format callback select appid focus)
         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+\/belongtos$/, /^place\/\d+\/children$/, /^place\/\d+\/descendants$/, 'placetypes'
+          %w(type start count lang format callback select appid degree view)
         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)
+        filters = %w(q focus type degree)
         options[:type] = options[:type].join(",") if options[:type].is_a?(Array)
         Hash[*(options.select{|k,v| filters.include?(k.to_s)}).flatten]
       end
-      
+
       def extract_matrix_params(options)
         matrix_params = %w(start count)
         Hash[*(options.select{|k,v| matrix_params.include?(k.to_s)}).flatten]
       end
-      
+
       def extract_query_params(options)
-        query_params = %w(lang format callback select appid)
+        query_params = %w(lang format callback select appid view)
         Hash[*(options.select{|k,v| query_params.include?(k.to_s)}).flatten]
       end
     end
   end
-end
+end

data/lib/geoplanet/place.rb

@@ -12,7 +12,7 @@ module GeoPlanet
     attr_reader  :locality1, :locality1_placetype
     attr_reader  :locality2, :locality2_placetype
     attr_reader  :pop_rank, :area_rank
-    alias_method :lat, :latitude 
+    alias_method :lat, :latitude
     alias_method :lon, :longitude
 
     # Class methods
@@ -22,7 +22,7 @@ module GeoPlanet
       puts "Yahoo GeoPlanet: GET #{url}" if GeoPlanet.debug
       get_then_parse(url)
     end
-    
+
     def self.get_then_parse(url)
       results = JSON.parse get(url).to_s
       return results['places']['place'].map{|attrs| Place.new attrs} if results['places']
@@ -32,7 +32,7 @@ module GeoPlanet
       nil
     end
 
-    %w(parent ancestors belongtos neighbors siblings children).each do |association|
+    %w(parent ancestors belongtos neighbors siblings children descendants).each do |association|
       self.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
         def self.#{association}_of(woeid, options = {})
           url = build_url("place/\#{woeid}/#{association}", options.merge(:format => "json"))
@@ -41,7 +41,7 @@ module GeoPlanet
         end
       RUBY
     end
-    
+
     # Instance methods
     def initialize(woe_or_attrs, options = {})
       case woe_or_attrs
@@ -51,14 +51,14 @@ module GeoPlanet
         raise ArgumentError
       end
     end
-    
+
     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
-    
-    
+
+
     def initialize_with_attrs(attrs)
       @version = attrs['centroid'] ? 'long' : 'short'
 
@@ -96,31 +96,31 @@ module GeoPlanet
         @locality2           = attrs['locality2']
         @locality2_placetype = attrs['locality2 attrs']['type'] rescue nil
         @pop_rank            = attrs['popRank']
-        @area_rank           = attrs['areaRank']                
+        @area_rank           = attrs['areaRank']
       end
       self
     end
 
     # Association Collections
-    %w(parent ancestors belongtos neighbors siblings children).each do |association|
+    %w(parent ancestors belongtos neighbors siblings children descendants).each do |association|
       self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{association}(options = {})
           Place.send("#{association}_of", self.woeid, options)
         end
       RUBY
     end
-    
+
     def to_s
       self.name
     end
-    
+
     def to_i
       self.woeid.to_i
     end
-    
+
     def inspect
       "#<GeoPlanet::Place #{instance_variables.map{|ivar| "#{ivar}: #{instance_variable_get(ivar).inspect}"}.join(', ')}>"
     end
-    
+
   end
-end
+end

metadata

@@ -1,103 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: geoplanet
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 6
-  version: 0.2.6
+version: !ruby/object:Gem::Version
+  version: 0.2.7
 platform: ruby
-authors: 
+authors:
 - Carlos Paramio
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-30 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 1
-        - 3
+      - !ruby/object:Gem::Version
         version: 1.1.3
   type: :runtime
-  version_requirements: *id002
-description: A Ruby wrapper for the Yahoo! GeoPlanet API. It uses JSON format by default to minimize bandwidth usage. See http://developer.yahoo.com/geo/ for more information about the API.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+description: A Ruby wrapper for the Yahoo! GeoPlanet API. It uses JSON format by default
+  to minimize bandwidth usage. See http://developer.yahoo.com/geo/ for more information
+  about the API.
 email: carlosparamio@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- CONTRIBUTORS
 - README.rdoc
 - geoplanet.gemspec
 - lib/geoplanet.rb
 - lib/geoplanet/base.rb
 - lib/geoplanet/place.rb
 - lib/geoplanet/version.rb
-has_rdoc: true
 homepage: http://github.com/carlosparamio/geoplanet/
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --main
+rdoc_options:
+- "--main"
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby wrapper for the Yahoo! GeoPlanet API.
 test_files: []
-