ppe-ruby-geonames 0.2.7

data/README.markdown

@@ -0,0 +1,72 @@
+# Geonames Ruby API
+
+Ruby library for [Geonames Web Services](http://www.geonames.org/export/)
+
+Created by [TouchBase Counsulting](http://www.tbcn.ca/geonames) to support GIS processes for [Carpool Connect](http://www.carpoolconnect.com/). Inspired by the Geonames [Java Client API library](http://www.geonames.org/source-code/).
+
+## Installing ruby-geonames
+
+Install from the command line:
+
+    sudo gem install elecnix-ruby-geonames
+
+## Examples
+
+The following exercises several of the Geonames web services, [full list of services](http://www.geonames.org/export/).
+
+**Load the the geonames API**
+
+    require 'geonames'
+
+**get list of places near by longitude/longitude location**
+
+    places_nearby = Geonames::WebService.find_nearby_place_name 43.900120387, -78.882869834
+    p places_nearby
+
+outputs:
+
+`[#<Geonames::Toponym:0x6c8c98 @population=nil, @geoname_id='6094578', @longitude=-78.849568878, @feature_class_name=nil, @country_name='Canada', @latitude=43.900120387, @feature_class='P', @country_code='CA', @name='Oshawa', @feature_code_name=nil, @elevation=nil, @distance=2.6679930307932, @alternate_names=nil, @feature_code='PPL'>]`
+
+**get timezone for longitude/longitude location**
+
+    timezone = Geonames::WebService.timezone 43.900120387, -78.882869834
+    p timezone
+
+**get country code for longitude/longitude location**
+
+    country_code = Geonames::WebService.country_code 43.900120387, -78.882869834
+    p country_code
+
+**get country sub-division info for longitude/longitude location**
+
+    country_subdivision = Geonames::WebService.country_subdivision 43.900120387, -78.882869834
+    p country_subdivision
+
+**get postal codes for a given location**
+
+    postal_code_sc = Geonames::PostalCodeSearchCriteria.new
+    postal_code_sc.place_name = "Oshawa"
+    postal_codes = Geonames::WebService.postal_code_search postal_code_sc
+    p postal_codes
+
+**get nearby postal codes for a place name**
+
+    postal_code_sc = Geonames::PostalCodeSearchCriteria.new
+    postal_code_sc.place_name = "Oshawa"
+    postal_codes_nearby = Geonames::WebService.find_nearby_postal_codes postal_code_sc
+    p postal_codes_nearby
+
+## Commercial Service Support
+
+If you use the commercial service, you should put something like this in your configuration:
+
+    Geonames::username = 'username'
+    Geonames::base_url = 'http://ws.geonames.net'
+
+In a Rails application, this would go in the `config/environment.rb` file.
+
+# Contributors
+
+    1. Adam Wisniewski
+    2. Nicolas Marchildon (elecnix)
+

data/lib/Rakefile.rb

@@ -0,0 +1,21 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'

data/lib/address.rb

@@ -0,0 +1,25 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+  class Address
+    
+  end
+end
+
+

data/lib/bounding_box.rb

@@ -0,0 +1,18 @@
+module Geonames
+  class BoundingBox
+    attr_reader :north_point, :south_point, :east_point, :west_point
+    attr_writer :north_point, :south_point, :east_point, :west_point
+    
+    def initialize(north=0.0, south=0.0, east=0.0, west=0.0)
+      self.north_point = north
+      self.south_point = south
+      self.east_point = east
+      self.west_point = west
+    end
+    
+    def contains?(point)
+      #todo implement me
+      return false
+    end
+  end
+end

data/lib/country_info.rb

@@ -0,0 +1,36 @@
+module Geonames
+  class CountryInfo
+    attr_reader :country_code, :country_name, :iso_numeric, :iso_alpha_3
+    attr_reader :fips_code, :continent, :capital, :area_sq_km, :population
+    attr_reader :currency_code, :geoname_id
+    
+    attr_writer :country_code, :country_name, :iso_numeric, :iso_alpha_3
+    attr_writer :fips_code, :continent, :capital, :area_sq_km, :population
+    attr_writer :currency_code, :geoname_id
+    
+    def initialize
+      @langs = []
+      @bounding_box = BoundingBox.new()
+    end
+    
+    def bounding_box
+      return @bounding_box
+    end
+    
+    def bounding_box=(new_bb)
+      @bounding_box = new_bb
+    end
+    
+    def set_bounding_box(north, south, east, west)
+      @bounding_box = BoundingBox.new(north, south, east, west)
+    end
+    
+    def languages
+      return @langs
+    end
+    
+    def languages=(new_langs)
+      @langs = new_langs
+    end
+  end
+end

data/lib/country_subdivision.rb

@@ -0,0 +1,35 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+    class CountrySubdivision
+        attr :country_code
+        attr :country_name
+        attr :admin_code_1
+        attr :admin_name_1
+        attr :code_fips
+        attr :code_iso
+        
+        attr_writer :country_code, :country_name
+        attr_writer :admin_name_1, :admin_code_1
+        attr_writer :code_fips, :code_iso
+        
+    end
+end
+
+

data/lib/geonames.rb

@@ -0,0 +1,59 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+require 'cgi'
+require 'net/http'
+require 'rexml/document'
+
+require 'web_service'
+require 'toponym'
+require 'toponym_search_result'
+require 'toponym_search_criteria'
+require 'postal_code'
+require 'postal_code_search_criteria'
+require 'timezone'
+require 'country_subdivision'
+require 'wikipedia_article'
+require 'intersection'
+
+module Geonames
+  
+  GEONAMES_SERVER = "http://ws.geonames.org"
+  USER_AGENT = "geonames ruby webservice client 0.1"
+  
+  @@username = nil
+  @@base_url = "http://ws.geonames.org"
+
+  def self.username
+    @@username
+  end
+
+  def self.username=(username)
+    @@username = username
+  end
+
+  def self.base_url
+    @@base_url
+  end
+
+  def self.base_url=(base_url)
+    @@base_url = base_url
+  end
+
+end
+

data/lib/intersection.rb

@@ -0,0 +1,42 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+    class Intersection
+        attr :street_1
+        attr :street_2
+        attr :latitude
+        attr :longitude
+        attr :distance
+        attr :postal_code
+        attr :place_name
+        attr :country_code
+        attr :admin_code_1
+        attr :admin_name_2
+        attr :admin_code_2
+        attr :admin_name_1
+        
+        attr_writer :street_1, :street_2
+        attr_writer :postal_code, :place_name, :country_code
+        attr_writer :latitude, :longitude, :admin_name_1
+        attr_writer :admin_code_1, :admin_name_2, :admin_code_2
+        attr_writer :distance 
+    end
+end
+
+

data/lib/main.rb

@@ -0,0 +1,63 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+# Contributions by Andrew Turner, High Earth Orbit
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+require 'geonames'
+require 'pp'
+
+# get the nearest intersection
+intersection = Geonames::WebService.find_nearest_intersection 40.7574053333333, -73.9734773333333
+puts intersection.street_1 #=> Park Ave
+puts intersection.street_2 #=> E 51st St
+
+# get wikipedia articles by lat / long
+articles_nearby = Geonames::WebService.find_nearby_wikipedia :lat => 43.900120387, :long => -78.882869834
+p articles_nearby
+
+# get wikipedia articles by bounding box
+articles_nearby = Geonames::WebService.find_bounding_box_wikipedia :north => 43.900120387, :east => -78.882869834, :south => 43.82, :west => 79.0
+p articles_nearby
+
+# get list of places near by longitude/longitude location
+places_nearby = Geonames::WebService.find_nearby_place_name 43.900120387, -78.882869834
+p places_nearby
+
+# get timezone for longitude/longitude location
+timezone = Geonames::WebService.timezone 43.900120387, -78.882869834
+p timezone
+
+# get country code for longitude/longitude location
+country_code = Geonames::WebService.country_code 43.900120387, -78.882869834
+p country_code
+
+# get country sub-division info for longitude/longitude location
+country_subdivision = Geonames::WebService.country_subdivision 43.900120387, -78.882869834
+p country_subdivision
+
+# get postal codes for a given location
+postal_code_sc = Geonames::PostalCodeSearchCriteria.new
+postal_code_sc.place_name = "Oshawa"
+postal_codes = Geonames::WebService.postal_code_search postal_code_sc
+p postal_codes
+
+# get nearby postal codes for a place name
+postal_code_sc = Geonames::PostalCodeSearchCriteria.new
+postal_code_sc.place_name = "Oshawa"
+postal_codes_nearby = Geonames::WebService.find_nearby_postal_codes postal_code_sc
+p postal_codes_nearby
+

data/lib/postal_code.rb

@@ -0,0 +1,40 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+    class PostalCode
+        attr :postal_code
+        attr :place_name
+        attr :country_code
+        attr :latitude
+        attr :longitude
+        attr :admin_name_1
+        attr :admin_code_1
+        attr :admin_name_2
+        attr :admin_code_2
+        attr :distance
+        
+        attr_writer :postal_code, :place_name, :country_code
+        attr_writer :latitude, :longitude, :admin_name_1
+        attr_writer :admin_code_1, :admin_name_2, :admin_code_2
+        attr_writer :distance
+        
+    end
+end
+
+

data/lib/postal_code_search_criteria.rb

@@ -0,0 +1,84 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+    class PostalCodeSearchCriteria
+
+	attr :postal_code
+        attr :place_name
+        attr :country_code
+        attr :latitude
+        attr :longitude
+        attr :style
+        attr :max_rows
+        attr :is_or_operator
+        attr :radius
+        
+        attr_writer :postal_code, :place_name, :country_code
+        attr_writer :latitude, :longitude, :style
+        attr_writer :max_rows,  :is_or_operator, :radius
+        
+        def initialize
+          @is_or_operator = false
+        end
+
+        def to_query_params_string
+            url = ''
+
+            if !@postal_code.nil? 
+              url = url + "&postalcode=" + CGI::escape( @postal_code )
+            end
+            
+            if !@place_name.nil? 
+              url = url + "&placename=" + CGI::escape( @place_name )
+            end
+            
+            if !@latitude.nil?
+                url = url + "&lat" + CGI::escape( @latitude.to_s )
+            end
+            
+            if !@longitude.nil?
+                url = url + "&lng" + CGI::escape( @longitude.to_s )
+            end
+
+            if !@style.nil?
+                url = url + "&style" + CGI::escape( @style )
+            end
+            
+            if !@country_code.nil? 
+              url = url + "&country=" + CGI::escape( @country_code )
+            end
+            
+            if !@max_rows.nil? 
+              url = url + "&maxRows=" + CGI::escape( @max_rows )
+            end
+
+            if !@radius.nil? 
+              url = url + "&radius=" + CGI::escape( @radius.to_s )
+            end
+            
+            if @is_or_operator 
+              url = url + "&operator=OR"
+            end
+            
+            url
+        end
+    end
+end
+
+

data/lib/tc_country_info.rb

@@ -0,0 +1,56 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'geonames'
+require 'test/unit'
+
+class TestCountryInfo < Test::Unit::TestCase
+  def setup
+    @test_code = "TH"
+    
+    @expected = 
+      {:country_code => 'TH', :country_name => 'Thailand', :iso_numeric => 764,
+        :iso_alpha_3 => 'THA', :fips_code => 'TH', :continent => 'AS', 
+        :capital => 'Bangkok', :area_sq_km => 514000.0, :population => 65493000,
+        :currency_code => 'THB', :geonameId => 1605651, 
+        :languages => ['th', 'en'],
+        :box_north => 20.4631977081299, :box_south => 5.60999917984009, 
+        :box_east => 105.63939666748, :box_west => 97.3456268310547}
+  end
+  
+  def teardown
+    #nothing here really
+  end
+  
+  def test_simple_values
+    info = Geonames::WebService.country_info(@test_code)
+    
+    assert_equal(@expected[:country_code], info.country_code)
+    assert_equal(@expected[:country_name], info.country_name)
+    assert_equal(@expected[:iso_numeric], info.iso_numeric)
+    assert_equal(@expected[:iso_alpha_3], info.iso_alpha_3)
+    assert_equal(@expected[:fips_code], info.fips_code)
+    assert_equal(@expected[:continent], info.continent)
+    assert_equal(@expected[:capital], info.capital)
+    assert_equal(@expected[:area_sq_km], info.area_sq_km)
+    assert_equal(@expected[:population], info.population)
+    assert_equal(@expected[:currency_code], info.currency_code)
+    assert_equal(@expected[:geonameId], info.geoname_id )
+  end
+  
+  def test_languages
+    info = Geonames::WebService.country_info(@test_code)
+    
+    assert_equal(2, info.languages.size)
+    assert_equal(@expected[:languages][0], info.languages[0])
+    assert_equal(@expected[:languages][1], info.languages[1])
+  end
+  
+  def test_bounding_box
+    info = Geonames::WebService.country_info(@test_code)
+    
+    assert_equal(@expected[:box_north], info.bounding_box.north_point)
+    assert_equal(@expected[:box_south], info.bounding_box.south_point)
+    assert_equal(@expected[:box_east], info.bounding_box.east_point)
+    assert_equal(@expected[:box_west], info.bounding_box.west_point)
+  end
+end

data/lib/timezone.rb

@@ -0,0 +1,29 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+    class Timezone
+        attr :timezone_id
+        attr :gmt_offset
+        attr :dst_offset
+        
+        attr_writer :timezone_id, :gmt_offset, :dst_offset
+  end
+end
+
+

data/lib/toponym.rb

@@ -0,0 +1,45 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+    class Toponym
+
+        attr :geoname_id
+        attr :name
+        attr :alternate_names
+        attr :country_code
+        attr :country_name
+        attr :population
+        attr :elevation
+        attr :feature_class
+        attr :feature_class_name
+        attr :feature_code
+        attr :feature_code_name
+        attr :latitude
+        attr :longitude
+        attr :distance
+
+        attr_writer :geoname_id, :name, :alternate_names, :country_code
+        attr_writer :country_name, :population, :elevation, :feature_class
+        attr_writer :feature_class_name, :feature_code,:feature_code_name
+        attr_writer :latitude, :longitude, :distance
+    
+    end
+end
+
+

data/lib/toponym_search_criteria.rb

@@ -0,0 +1,44 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+    class ToponymSearchCriteria
+    
+        attr :q
+        attr :country_code
+        attr :name
+        attr :name_equals
+        attr :name_starts_with
+        attr :tag
+        attr :language
+        attr :style
+        attr :feature_class
+        attr :feature_codes
+        attr :admin_code_1
+        attr :max_rows
+        attr :start_row
+
+        attr_writer :q, :country_code, :name, :name_equals
+        attr_writer :name_starts_with, :tag, :language, :style
+        attr_writer :feature_class, :feature_codes, :admin_code_1
+        attr_writer :max_rows, :start_row
+    
+    end
+end
+
+

data/lib/toponym_search_result.rb

@@ -0,0 +1,33 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at 
+#
+#  http://www.apache.org/licenses/LICENSE-2.0 
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+    class ToponymSearchResult
+        
+        attr :total_results_count
+        attr :toponyms
+    
+        attr_writer :total_results_count, :toponyms
+        
+        def initialize
+            @toponyms = Array.new
+        end
+    end
+end
+
+

data/lib/web_service.rb

@@ -0,0 +1,504 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca>
+# Contributions by Andrew Turner, High Earth Orbit
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+  class WebService
+    def WebService.get_element_child_text( element, child )
+      if !element.elements[child].nil?
+        element.elements[child][0].to_s
+      end
+    end
+
+    def WebService.get_element_child_float( element, child )
+      if !element.elements[child].nil?
+        element.elements[child][0].to_s.to_f
+      end
+    end
+
+    def WebService.get_element_child_int( element, child )
+      if !element.elements[child].nil?
+        element.elements[child][0].to_s.to_i
+      end
+    end
+
+    def WebService.element_to_postal_code ( element )
+      postal_code = PostalCode.new
+
+      postal_code.admin_code_1    = WebService::get_element_child_text( element, 'adminCode1' )
+      postal_code.admin_code_2    = WebService::get_element_child_text( element, 'adminCode2' )
+      postal_code.admin_name_1    = WebService::get_element_child_text( element, 'adminName1' )
+      postal_code.admin_name_2    = WebService::get_element_child_text( element, 'adminName2' )
+      postal_code.country_code    = WebService::get_element_child_text( element, 'countryCode' )
+      postal_code.distance        = WebService::get_element_child_float( element, 'distance' )
+      postal_code.longitude       = WebService::get_element_child_float( element, 'lng' )
+      postal_code.latitude        = WebService::get_element_child_float( element, 'lat' )
+      postal_code.place_name      = WebService::get_element_child_text( element, 'name' )
+      postal_code.postal_code     = WebService::get_element_child_text( element, 'postalcode' )
+
+      return postal_code
+
+    end
+
+    def WebService.element_to_wikipedia_article ( element )
+      article = WikipediaArticle.new
+
+      article.language              = WebService::get_element_child_text( element, 'lang' )
+      article.title                 = WebService::get_element_child_text( element, 'title' )
+      article.summary               = WebService::get_element_child_text( element, 'summary' )
+      article.wikipedia_url         = WebService::get_element_child_text( element, 'wikipediaUrl' )
+      article.feature               = WebService::get_element_child_text( element, 'feature' )
+      article.population            = WebService::get_element_child_text( element, 'population' )
+      article.elevation             = WebService::get_element_child_text( element, 'elevation' )
+      article.latitude              = WebService::get_element_child_float( element, 'lat' )
+      article.longitude             = WebService::get_element_child_float( element, 'lng' )
+      article.thumbnail_img         = WebService::get_element_child_text( element, 'thumbnailImg' )
+      article.distance              = WebService::get_element_child_float( element, 'distance' )
+
+      return article
+
+    end
+
+    def WebService.element_to_toponym ( element )
+      toponym = Toponym.new
+
+      toponym.name                = WebService::get_element_child_text( element, 'name' )
+      toponym.alternate_names     = WebService::get_element_child_text( element, 'alternateNames' )
+      toponym.latitude            = WebService::get_element_child_float( element, 'lat' )
+      toponym.longitude           = WebService::get_element_child_float( element, 'lng' )
+      toponym.geoname_id          = WebService::get_element_child_text( element, 'geonameId' )
+      toponym.country_code        = WebService::get_element_child_text( element, 'countryCode' )
+      toponym.country_name        = WebService::get_element_child_text( element, 'countryName' )
+      toponym.feature_class       = WebService::get_element_child_text( element, 'fcl' )
+      toponym.feature_code        = WebService::get_element_child_text( element, 'fcode' )
+      toponym.feature_class_name  = WebService::get_element_child_text( element, 'fclName' )
+      toponym.feature_code_name   = WebService::get_element_child_text( element, 'fCodeName' )
+      toponym.population          = WebService::get_element_child_int( element, 'population' )
+      toponym.elevation           = WebService::get_element_child_text( element, 'elevation' )
+      toponym.distance            = WebService::get_element_child_float( element, 'distance' )
+
+      return toponym
+
+    end
+
+    def WebService.element_to_intersection ( element )
+      intersection = Intersection.new
+
+      intersection.street_1        = WebService::get_element_child_text( element, 'street1' )
+      intersection.street_2        = WebService::get_element_child_text( element, 'street2' )
+      intersection.admin_code_1    = WebService::get_element_child_text( element, 'adminCode1' )
+      intersection.admin_code_1    = WebService::get_element_child_text( element, 'adminCode1' )
+      intersection.admin_code_2    = WebService::get_element_child_text( element, 'adminCode2' )
+      intersection.admin_name_1    = WebService::get_element_child_text( element, 'adminName1' )
+      intersection.admin_name_2    = WebService::get_element_child_text( element, 'adminName2' )
+      intersection.country_code    = WebService::get_element_child_text( element, 'countryCode' )
+      intersection.distance        = WebService::get_element_child_float( element, 'distance' )
+      intersection.longitude       = WebService::get_element_child_float( element, 'lat' )
+      intersection.latitude        = WebService::get_element_child_float( element, 'lng' )
+      intersection.place_name      = WebService::get_element_child_text( element, 'name' )
+      intersection.postal_code     = WebService::get_element_child_text( element, 'postalcode' )
+
+      return intersection
+
+    end
+    
+    def WebService.element_to_country_info(element)
+      country_info = CountryInfo.new
+      
+      country_info.country_code = WebService.get_element_child_text(element, 'countryCode')
+      country_info.country_name = WebService.get_element_child_text(element, 'countryName')
+      country_info.iso_numeric = WebService.get_element_child_int(element, 'isoNumeric')
+      country_info.iso_alpha_3 = WebService.get_element_child_text(element, 'isoAlpha3')
+      country_info.fips_code = WebService.get_element_child_text(element, 'fipsCode')
+      country_info.continent = WebService.get_element_child_text(element, 'continent')
+      country_info.capital = WebService.get_element_child_text(element, 'capital')
+      country_info.area_sq_km = WebService.get_element_child_float(element, 'areaInSqKm')
+      country_info.population = WebService.get_element_child_int(element, 'population')
+      country_info.currency_code = WebService.get_element_child_text(element, 'currencyCode')
+      #actually an array of the available languages
+      country_info.languages = WebService.get_element_child_text(element, 'languages').split(",")
+      country_info.geoname_id = WebService.get_element_child_int(element, 'geonameId')
+      
+      north = WebService.get_element_child_float(element, 'bBoxNorth')
+      south = WebService.get_element_child_float(element, 'bBoxSouth')
+      east = WebService.get_element_child_float(element, 'bBoxEast')
+      west = WebService.get_element_child_float(element, 'bBoxWest')
+      
+      country_info.set_bounding_box(north, south, east, west)
+      
+      return country_info
+    end
+
+    def WebService.postal_code_search( postal_code, place_name, country_code )
+      postal_code_sc = PostalCodeSearchCriteria.new
+      postal_code_sc.postal_code = postal_code
+      postal_code_sc.place_name = place_name
+      postal_code_sc.country_code = country_code
+
+      WebService.postal_code_search postal_code_sc
+    end
+
+    def WebService.postal_code_search( search_criteria )
+      # postal codes to reutrn
+      postal_codes = Array.new
+
+      url = "/postalCodeSearch?a=a"
+      url = url + search_criteria.to_query_params_string
+
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      doc.elements.each("geonames/code") do |element|
+        postal_codes << WebService::element_to_postal_code( element )
+      end
+
+      postal_codes
+
+    end
+
+    def WebService.find_nearby_postal_codes( search_criteria )
+      # postal codes to reutrn
+      postal_codes = Array.new
+
+      url = "/findNearbyPostalCodes?a=a"
+      url = url + search_criteria.to_query_params_string
+
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      doc.elements.each("geonames/code") do |element|
+        postal_codes << WebService::element_to_postal_code( element )
+      end
+
+      postal_codes
+
+    end
+
+    def WebService.find_nearby_place_name( lat, long )
+      places = Array.new
+
+      url = "/findNearbyPlaceName?a=a"
+
+      url = url + "&lat=" + lat.to_s
+      url = url + "&lng=" + long.to_s
+
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      doc.elements.each("geonames/geoname") do |element|
+
+        places << WebService::element_to_toponym( element )
+
+      end
+
+      return places
+
+    end
+
+    def WebService.find_nearest_intersection( lat, long )
+
+      url = "/findNearestIntersection?a=a"
+
+      url = url + "&lat=" + lat.to_s
+      url = url + "&lng=" + long.to_s
+
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      intersection = []
+      doc.elements.each("geonames/intersection") do |element|
+
+        intersection = WebService::element_to_intersection( element )
+
+      end
+
+      return intersection
+
+    end
+
+    def WebService.timezone( lat, long, *args )
+      res = make_request("/timezone?lat=#{lat.to_s}&lng=#{long.to_s}", args)
+      doc = REXML::Document.new res.body
+      timezone = Timezone.new
+      doc.elements.each("geonames/timezone") do |element|
+        timezone.timezone_id    = WebService::get_element_child_text( element, 'timezoneId' )
+        timezone.gmt_offset     = WebService::get_element_child_float( element, 'gmtOffset' )
+        timezone.dst_offset     = WebService::get_element_child_float( element, 'dstOffset' )
+      end
+      timezone
+    end
+
+    def WebService.make_request(path_and_query, *args)
+      url = Geonames::base_url + path_and_query
+      url = url + "&username=#{Geonames::username}" if Geonames::username
+      options = {
+        :open_timeout => 60,
+        :read_timeout => 60
+      }
+      options.update(args.last.is_a?(::Hash) ? args.pop : {})
+      uri = URI.parse(url)
+      req = Net::HTTP::Get.new(uri.path + '?' + uri.query)
+      Net::HTTP.start(uri.host, uri.port) { |http|
+        http.read_timeout = options[:read_timeout]
+        http.open_timeout = options[:open_timeout]
+        http.request(req)
+      }
+    end
+
+    def WebService.findNearbyWikipedia( hashes )
+      # here for backwards compatibility
+      WebService.find_nearby_wikipedia( hashes )
+    end
+    
+    def WebService.find_nearby_wikipedia( hashes )
+      articles = Array.new
+
+      lat = hashes[:lat]
+      long = hashes[:long]
+      lang = hashes[:lang]
+      radius = hashes[:radius]
+      max_rows = hashes[:max_rows]
+      country = hashes[:country]
+      postalcode = hashes[:postalcode]
+      q = hashes[:q]
+
+      url = "/findNearbyWikipedia?a=a"
+
+      if !lat.nil? && !long.nil?
+        url = url + "&lat=" + lat.to_s
+        url = url + "&lng=" + long.to_s
+        url = url + "&radius=" + radius.to_s unless radius.nil?
+        url = url + "&max_rows=" + max_rows.to_s unless max_rows.nil?
+
+      elsif !q.nil?
+        url = url + "&q=" + q
+        url = url + "&radius=" + radius.to_s unless radius.nil?
+        url = url + "&max_rows=" + max_rows.to_s unless max_rows.nil?
+      end
+
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      doc.elements.each("geonames/entry") do |element|
+        articles << WebService::element_to_wikipedia_article( element )
+      end
+
+      return articles
+
+    end
+
+    def WebService.findBoundingBoxWikipedia( hashes )
+      # here for backwards compatibility
+      WebService.find_bounding_box_wikipedia( hashes )
+    end
+    
+    def WebService.find_bounding_box_wikipedia( hashes )
+      articles = Array.new
+
+      north = hashes[:north]
+      east = hashes[:east]
+      south = hashes[:south]
+      west = hashes[:west]
+      lang = hashes[:lang]
+      radius = hashes[:radius]
+      max_rows = hashes[:max_rows]
+      country = hashes[:country]
+      postalcode = hashes[:postalcode]
+      q = hashes[:q]
+
+      url = "/wikipediaBoundingBox?a=a"
+
+      url = url + "&north=" + north.to_s
+      url = url + "&east=" + east.to_s
+      url = url + "&south=" + south.to_s
+      url = url + "&west=" + west.to_s
+      url = url + "&radius=" + radius.to_s unless radius.nil?
+      url = url + "&max_rows=" + max_rows.to_s unless max_rows.nil?
+
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      doc.elements.each("geonames/entry") do |element|
+        articles << WebService::element_to_wikipedia_article( element )
+      end
+
+      return articles
+
+    end
+
+    def WebService.country_subdivision ( lat, long, radius = 0, maxRows = 1 )
+      
+      country_subdivisions = Array.new
+      
+      # maxRows is only implemented in the xml version:
+      # http://groups.google.com/group/geonames/browse_thread/thread/f7f1bb2504ed216e
+      # Therefore 'type=xml' is added:
+      url = "/countrySubdivision?a=a&type=xml"
+
+      url = url + "&lat=" + lat.to_s
+      url = url + "&lng=" + long.to_s
+      url = url + "&maxRows=" + maxRows.to_s
+      url = url + "&radius=" + radius.to_s
+
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      doc.elements.each("geonames/countrySubdivision") do |element|
+
+        country_subdivision = CountrySubdivision.new
+
+        country_subdivision.country_code    = WebService::get_element_child_text( element, 'countryCode' )
+        country_subdivision.country_name    = WebService::get_element_child_text( element, 'countryName' )
+        country_subdivision.admin_code_1    = WebService::get_element_child_text( element, 'adminCode1' )
+        country_subdivision.admin_name_1    = WebService::get_element_child_text( element, 'adminName1' )
+        country_subdivision.code_fips       = WebService::get_element_child_text( element, 'code[@type="FIPS10-4"]')
+        country_subdivision.code_iso        = WebService::get_element_child_text( element, 'code[@type="ISO3166-2"]')
+
+        country_subdivisions << country_subdivision
+
+      end
+
+      return country_subdivisions
+
+    end
+
+    def WebService.country_info(country_code)
+      url = "/countryInfo?a=a"
+      
+      url += "&country=#{country_code.to_s}"
+      res = make_request(url)
+      
+      doc = REXML::Document.new res.body
+      
+      return WebService.element_to_country_info(doc.elements["geonames/country"])
+    end
+
+    def WebService.country_code ( lat, long, radius = 0, maxRows = 1 )
+      # maxRows is only implemented in the xml version:
+      # http://groups.google.com/group/geonames/browse_thread/thread/f7f1bb2504ed216e
+      # Therefore 'type=xml' is added:
+      url = "/countrycode?a=a&type=xml"
+
+      countries = Array.new
+
+      url = url + "&lat=" + lat.to_s
+      url = url + "&lng=" + long.to_s
+      url = url + "&maxRows=" + maxRows.to_s
+      url = url + "&radius=" + radius.to_s
+
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      doc.elements.each("geonames/country") do |element|
+
+        countries << WebService::element_to_toponym( element )
+
+      end
+
+      return countries
+
+    end
+
+    def WebService.search( search_criteria )
+      #toponym search results to return
+      toponym_sr = ToponymSearchResult.new
+
+      url = "/search?a=a"
+
+      if !search_criteria.q.nil?
+        url = url + "&q=" + CGI::escape( search_criteria.q )
+      end
+
+      if !search_criteria.name_equals.nil?
+        url = url + "&name_equals=" + CGI::escape( search_criteria.name_equals )
+      end
+
+      if !search_criteria.name_starts_with.nil?
+        url = url + "&name_startsWith=" + CGI::escape( search_criteria.name_starts_with )
+      end
+
+      if !search_criteria.name.nil?
+        url = url + "&name=" + CGI::escape( search_criteria.name )
+      end
+
+      if !search_criteria.tag.nil?
+        url = url + "&tag=" + CGI::escape( search_criteria.tag )
+      end
+
+      if !search_criteria.country_code.nil?
+        url = url + "&country=" + CGI::escape( search_criteria.country_code )
+      end
+
+      if !search_criteria.admin_code_1.nil?
+        url = url + "&adminCode1=" + CGI::escape( search_criteria.admin_code_1 )
+      end
+
+      if !search_criteria.language.nil?
+        url = url + "&lang=" + CGI::escape( search_criteria.language )
+      end
+
+      if !search_criteria.feature_class.nil?
+        url = url + "&featureClass=" + CGI::escape( search_criteria.feature_class )
+      end
+
+      if !search_criteria.feature_codes.nil?
+        for feature_code in search_criteria.feature_codes
+          url = url + "&fcode=" + CGI::escape( feature_code )
+        end
+      end
+
+      if !search_criteria.max_rows.nil?
+        url = url + "&maxRows=" + CGI::escape( search_criteria.max_rows )
+      end
+
+      if !search_criteria.start_row.nil?
+        url = url + "&startRow=" + CGI::escape( search_criteria.start_row )
+      end
+
+      if !search_criteria.style.nil?
+        url = url + "&style=" + CGI::escape( search_criteria.style )
+      end
+      
+      res = make_request(url)
+
+      doc = REXML::Document.new res.body
+
+      toponym_sr.total_results_count = doc.elements["geonames/totalResultsCount"].text
+
+      doc.elements.each("geonames/geoname") do |element|
+
+        toponym_sr.toponyms << WebService::element_to_toponym( element )
+
+      end
+
+      return toponym_sr
+    end
+    
+  end
+end
+
+#alias WebService.find_nearby_wikipedia findNearbyWikipedia
+#alias find_bounding_box_wikipedia findBoundingBoxWikipedia

data/lib/wikipedia_article.rb

@@ -0,0 +1,42 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca>
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+#
+#=============================================================================
+
+module Geonames
+  class WikipediaArticle
+
+    attr :language
+    attr :title
+    attr :summary
+    attr :wikipedia_url
+    attr :feature
+    attr :population
+    attr :elevation
+    attr :latitude
+    attr :longitude
+    attr :thumbnail_img
+    attr :distance
+
+    attr_writer :language, :title, :summary
+    attr_writer :wikipedia_url, :feature, :population
+    attr_writer :elevation, :latitude, :longitude
+    attr_writer :thumbnail_img, :distance
+
+  end
+end
+
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: ppe-ruby-geonames
+version: !ruby/object:Gem::Version 
+  version: 0.2.7
+platform: ruby
+authors: 
+- Adam Wisniewski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-07 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: adamw@tbcn.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- lib/timezone.rb
+- lib/wikipedia_article.rb
+- lib/geonames.rb
+- lib/postal_code_search_criteria.rb
+- lib/intersection.rb
+- lib/country_subdivision.rb
+- lib/toponym.rb
+- lib/toponym_search_result.rb
+- lib/bounding_box.rb
+- lib/web_service.rb
+- lib/postal_code.rb
+- lib/toponym_search_criteria.rb
+- lib/tc_country_info.rb
+- lib/main.rb
+- lib/Rakefile.rb
+- lib/address.rb
+- lib/country_info.rb
+has_rdoc: true
+homepage: http://github.com/elecnix/ruby-geonames
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby library for Geonames Web Services (http://www.geonames.org/export/)
+test_files: []
+