geonames 0.2.2 → 0.3.3

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle
+.rvmrc
+coverage
+Gemfile.lock
+vendor/bundle
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rcov", "~> 0.9.9", :platforms => :ruby_18
+end

data/README.markdown

@@ -0,0 +1,82 @@
+# Geonames Ruby API [![Build Status](https://api.travis-ci.org/mceachen/ruby-geonames.png?branch=master)](https://travis-ci.org/mceachen/ruby-geonames)
+
+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 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
+
+## Language Support
+
+Geonames uses 'en' as the default locale. You can change the requested language like this:
+
+    Geonames.lang = 'de'
+
+In a Rails application, you could set the language from the I18n.locale:
+
+    Geonames.lang = I18n.locale
+
+## 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 could go into `config/initializers/geonames.rb`.
+
+# Contributors
+
+    1. Adam Wisniewski
+    2. Nicolas Marchildon (elecnix)
+    3. Chris Griego

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new
+
+namespace :spec do
+  RSpec::Core::RakeTask.new :rcov do |task|
+    task.rcov      = true
+    task.rcov_opts = "--exclude spec/*,gems/*"
+  end if RUBY_VERSION < "1.9"
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "geonames")

data/lib/geonames.rb

@@ -1,12 +1,13 @@
 #=============================================================================
 #
-# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca>
+# Contributions by Chris Griego
 #
 # 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 
+# the License at
 #
-#  http://www.apache.org/licenses/LICENSE-2.0 
+#  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
@@ -15,26 +16,41 @@
 # the License.
 #
 #=============================================================================
+require 'geonames/version'
 
-require 'cgi'
-require 'net/http'
-require 'rexml/document'
+module Geonames
+  autoload :BoundingBox,              'geonames/bounding_box'
+  autoload :Config,                   'geonames/config'
+  autoload :CountryInfo,              'geonames/country_info'
+  autoload :CountrySubdivision,       'geonames/country_subdivision'
+  autoload :Intersection,             'geonames/intersection'
+  autoload :PostalCode,               'geonames/postal_code'
+  autoload :PostalCodeSearchCriteria, 'geonames/postal_code_search_criteria'
+  autoload :Timezone,                 'geonames/timezone'
+  autoload :Toponym,                  'geonames/toponym'
+  autoload :ToponymSearchCriteria,    'geonames/toponym_search_criteria'
+  autoload :ToponymSearchResult,      'geonames/toponym_search_result'
+  autoload :WebService,               'geonames/web_service'
+  autoload :WikipediaArticle,         'geonames/wikipedia_article'
 
-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'
+  GEONAMES_SERVER = "http://ws.geonames.net"
+  USER_AGENT      = "geonames ruby webservice client #{VERSION}"
 
-module Geonames
-  
-  GEONAMES_SERVER = "http://ws.geonames.org"
-  USER_AGENT = "geonames ruby webservice client 0.1"
-  
-end
+  class << self
+    def config
+      Thread.current[:geonames_config] ||= Geonames::Config.new
+    end
 
+    %w(base_url lang username token).each do |method|
+      module_eval <<-DELEGATORS, __FILE__, __LINE__ + 1
+        def #{method}
+          config.#{method}
+        end
+
+        def #{method}=(value)
+          config.#{method} = (value)
+        end
+      DELEGATORS
+    end
+  end
+end

data/lib/geonames/bounding_box.rb

@@ -0,0 +1,12 @@
+module Geonames
+  class BoundingBox
+    attr_accessor :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
+  end
+end

data/lib/{country_subdivision.rb → geonames/config.rb}

@@ -1,12 +1,13 @@
 #=============================================================================
 #
-# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+# Copyright 2010 Jan Schwenzien <jan@schwenzien.info>
+# Contributions by Chris Griego
 #
 # 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 
+# the License at
 #
-#  http://www.apache.org/licenses/LICENSE-2.0 
+#  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
@@ -17,16 +18,28 @@
 #=============================================================================
 
 module Geonames
-    class CountrySubdivision
-        attr :country_code
-        attr :country_name
-        attr :admin_code_1
-        attr :admin_name_1
-        
-        attr_writer :country_code, :country_name
-        attr_writer :admin_name_1, :admin_code_1
-        
+  class Config
+    @@default_base_url = "http://api.geonames.org"
+    @@default_lang     = "en"
+    @@default_username = nil
+    @@default_token    = nil
+
+    attr_writer :base_url, :lang, :username, :token
+
+    def base_url
+      @base_url || @@default_base_url
+    end
+
+    def lang
+      @lang || @@default_lang
     end
-end
 
+    def username
+      @username || @@default_username
+    end
 
+    def token
+      @token || @@default_token
+    end
+  end
+end

data/lib/geonames/country_info.rb

@@ -0,0 +1,18 @@
+require 'geonames/bounding_box'
+
+module Geonames
+  class CountryInfo
+    attr_accessor :country_code, :country_name, :iso_numeric, :iso_alpha_3,
+                  :fips_code, :continent, :capital, :area_sq_km, :population,
+                  :currency_code, :geoname_id, :bounding_box, :languages
+
+    def initialize
+      @bounding_box = BoundingBox.new
+      @languages    = []
+    end
+
+    def set_bounding_box(north, south, east, west)
+      @bounding_box = BoundingBox.new(north, south, east, west)
+    end
+  end
+end

data/lib/{Rakefile.rb → geonames/country_subdivision.rb}

@@ -1,12 +1,13 @@
 #=============================================================================
 #
-# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca>
+# Contributions by Chris Griego
 #
 # 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 
+# the License at
 #
-#  http://www.apache.org/licenses/LICENSE-2.0 
+#  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
@@ -16,6 +17,10 @@
 #
 #=============================================================================
 
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
+module Geonames
+  class CountrySubdivision
+    attr_accessor :country_code, :country_name,
+                  :admin_name_1, :admin_code_1,
+                  :code_fips, :code_iso
+  end
+end

data/lib/geonames/intersection.rb

@@ -0,0 +1,28 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca>
+# Contributions by Chris Griego
+#
+# 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_accessor :street_1, :street_2,
+                  :postal_code, :place_name, :country_code,
+                  :latitude, :longitude, :admin_name_1,
+                  :admin_code_1, :admin_name_2, :admin_code_2,
+                  :distance
+  end
+end

data/lib/{toponym_search_result.rb → geonames/postal_code.rb}

@@ -1,12 +1,13 @@
 #=============================================================================
 #
-# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca>
+# Contributions by Chris Griego
 #
 # 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 
+# the License at
 #
-#  http://www.apache.org/licenses/LICENSE-2.0 
+#  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
@@ -17,17 +18,10 @@
 #=============================================================================
 
 module Geonames
-    class ToponymSearchResult
-        
-        attr :total_results_count
-        attr :toponyms
-    
-        attr_writer :total_results_count, :toponyms
-        
-        def initialize
-            @toponyms = Array.new
-        end
-    end
+  class PostalCode
+    attr_accessor :postal_code, :place_name, :country_code,
+                  :latitude, :longitude, :admin_name_1,
+                  :admin_code_1, :admin_name_2, :admin_code_2,
+                  :distance
+  end
 end
-
-

data/lib/geonames/postal_code_search_criteria.rb

@@ -0,0 +1,50 @@
+#=============================================================================
+#
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca>
+# Contributions by Chris Griego
+#
+# 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'
+
+module Geonames
+  class PostalCodeSearchCriteria
+    attr_accessor :postal_code, :place_name, :country_code,
+                  :latitude, :longitude, :style,
+                  :max_rows,  :is_or_operator, :radius
+    
+    def initialize(params={})
+      params.each do |attr, value|
+        self.public_send("#{attr}=", value)
+      end if params
+
+      @is_or_operator = false
+    end
+
+    def to_query_params_string
+      url = ''
+      url << "&postalcode=" + CGI.escape(@postal_code)    unless @postal_code.nil?
+      url << "&placename="  + CGI.escape(@place_name)     unless @place_name.nil?
+      url << "&lat="        + CGI.escape(@latitude.to_s)  unless @latitude.nil?
+      url << "&lng="        + CGI.escape(@longitude.to_s) unless @longitude.nil?
+      url << "&style="      + CGI.escape(@style)          unless @style.nil?
+      url << "&country="    + CGI.escape(@country_code)   unless @country_code.nil?
+      url << "&maxRows="    + CGI.escape(@max_rows.to_s)  unless @max_rows.nil?
+      url << "&radius="     + CGI.escape(@radius.to_s)    unless @radius.nil?
+      url << "&operator=OR" if @is_or_operator
+      url
+    end
+  end
+end

data/lib/{timezone.rb → geonames/timezone.rb}

@@ -1,12 +1,13 @@
 #=============================================================================
 #
-# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca> 
+# Copyright 2007 Adam Wisniewski <adamw@tbcn.ca>
+# Contributions by Chris Griego
 #
 # 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 
+# the License at
 #
-#  http://www.apache.org/licenses/LICENSE-2.0 
+#  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
@@ -17,13 +18,11 @@
 #=============================================================================
 
 module Geonames
-    class Timezone
-        attr :timezone_id
-        attr :gmt_offset
-        attr :dst_offset
-        
-        attr_writer :timezone_id, :gmt_offset, :dst_offset
+  class Timezone
+    attr_accessor :timezone_id, :gmt_offset, :dst_offset, :raw_offset
+
+    def tzinfo
+      TZInfo::Timezone.get(timezone_id)
+    end
   end
 end
-
-