svlt-ruby-geonames 0.2.7

data/README.markdown

@@ -0,0 +1,87 @@
+# 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/).
+
+Modified by Suomen Verkkoliiketoiminta Oy to include place name searching and to get timezone at the same time
+
+## Installing ruby-geonames
+
+Install from the command line:
+
+    sudo gem install svlt-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
+
+**get timezone for a place name**
+
+		sc = Geonames::SearchCriteria.new
+		sc.name_starts_with = "tampere"
+		sc.feature_class = "P"
+		sc.style="full"
+		sc.country="fi"
+		location = Geonames::WebService.search sc
+		p location.toponyms[0].score
+		p location.toponyms[0].timezone
+
+
+## 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)
+		3. Ahto Jussila
+

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,60 @@
+#=============================================================================
+#
+# 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'
+require 'search_criteria'
+
+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,75 @@
+#=============================================================================
+#
+# 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'
+
+Geonames::username = 'svlt'
+Geonames::base_url = 'http://ws.geonames.net'
+# 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
+
+# get score and timezone of search hit
+sc = Geonames::SearchCriteria.new
+sc.name_starts_with = "tampere"
+sc.feature_class = "P"
+sc.style="full"
+sc.country="fi"
+location = Geonames::WebService.search sc
+p location.toponyms[0].score
+p location.toponyms[0].timezone
+

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/search_criteria.rb

@@ -0,0 +1,37 @@
+module Geonames
+    class SearchCriteria
+    
+        attr :q
+        attr :name
+        attr :name_equals
+        attr :name_starts_with
+        attr :max_rows
+        attr :start_row
+        attr :country
+        attr :country_bias
+        attr :continent_codes
+        attr :admin_code_1
+        attr :admin_code_2
+        attr :admin_code_3
+        attr :feature_class
+        attr :feature_codes
+        attr :language
+        attr :type
+        attr :style        
+        attr :is_name_required        
+        attr :tag
+        attr :operator
+        attr :charset
+        
+
+        attr_writer :q, :name, :name_equals, :name_starts_with
+        attr_writer :max_rows, :start_row
+        attr_writer :country, :country_bias, :continent_code
+        attr_writer :admin_code_1, :admin_code_2, :admin_code_3
+        attr_writer :feature_class, :feature_codes, :language
+        attr_writer :type, :style, :is_name_required
+        attr_writer :tag, :operator, :charset
+
+    
+    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
+
+