geonames_api 0.0.6 → 0.1.0

data/lib/geonames_api/country_code.rb

@@ -0,0 +1,8 @@
+module GeoNamesAPI
+  class CountryCode < SingletonEndpoint
+
+    METHOD = "countryCodeJSON"
+    FIND_PARAMS = %w(lat lng type lang radius)
+
+  end
+end

data/lib/geonames_api/country_subdivision.rb

@@ -0,0 +1,8 @@
+module GeoNamesAPI
+  class CountrySubdivision < SingletonEndpoint
+
+    METHOD = "countrySubdivisionJSON"
+    FIND_PARAMS = %w(lat lng)
+
+  end
+end

data/lib/geonames_api/earthquake.rb

@@ -0,0 +1,8 @@
+module GeoNamesAPI
+  class Earthquake < ListEndpoint
+
+    METHOD = "earthquakesJSON"
+    FIND_PARAMS = %w(north east south west date minMagnitude maxRows)
+
+  end
+end

data/lib/geonames_api/elevation.rb

@@ -0,0 +1,16 @@
+module GeoNamesAPI
+  class Elevation < SingletonEndpoint
+
+    METHOD = "astergdemJSON"
+    FIND_PARAMS = %w(lat lng)
+
+  end
+end
+
+=begin
+{
+  "astergdem": 192,
+  "lng": 10.2,
+  "lat": 50.01
+}
+=end

data/lib/geonames_api/entity.rb

@@ -0,0 +1,64 @@
+require 'forwardable'
+
+module GeoNamesAPI
+  class Entity
+    include Enumerable
+    extend Forwardable
+    def_delegator :geonames, :each
+    alias_method :size, :count
+    attr_reader :request_params
+
+    def initialize(response, request_params = nil)
+      @response = response
+      @request_params = request_params
+      parse_response
+    end
+
+    def parse_response
+      @response.keys.each { |ea| parse_attr(ea) }
+    end
+
+    def parse_attr(key)
+      return unless @response.has_key? key
+
+      aliases = []
+      value = @response[key]
+      parsed_value = case (key)
+        when 'geonames', 'streetSegment'
+          aliases = [:geonames, :results]
+          value.map { |ea| self.class.new(ea) }
+        when 'alternateNames'
+          AlternateNames.new(value)
+        when 'timezone'
+          TimeZone.new(value)
+        else
+          set_default_type(value)
+      end
+
+      attr_name = create_attribute(key, *aliases)
+      instance_variable_set(attr_name, parsed_value)
+    end
+
+    def create_attribute(attribute, *attribute_aliases)
+      attr_name = attribute.underscore.to_sym
+      self.class.send(:attr_reader, attr_name) unless respond_to?(attr_name)
+
+      attribute_aliases.each do |ea|
+        self.class.send(:alias_method, ea, attr_name) unless respond_to?(ea)
+      end
+
+      "@#{attr_name}".to_sym
+    end
+
+    def set_default_type(value)
+      case value
+        when /\A-?\d+\Z/
+          value.to_i
+        when /\A-?\d*\.\d*\Z/
+          value.to_f
+        else
+          value
+      end
+    end
+  end
+end

data/lib/geonames_api/error.rb

@@ -1,5 +1,28 @@
 module GeoNamesAPI
   class Error < StandardError
-    
+    # See http://www.geonames.org/export/webservice-exception.html
+    def self.from_status(status)
+      val = status['value'].to_i
+      error_type = case val
+        when 12, 13, 22
+          Timeout
+        when 14
+          InvalidParameter
+        when 21
+          InvalidInput
+        else
+          Error
+      end
+      raise error_type, "#{status['message']} (#{val})"
+    end
   end
-end
+
+  class Timeout < Error
+  end
+
+  class InvalidParameter < Error
+  end
+
+  class InvalidInput < Error
+  end
+end

data/lib/geonames_api/geoname.rb

@@ -0,0 +1,4 @@
+module GeoNamesAPI
+  class GeoName < Entity
+  end
+end

data/lib/geonames_api/hierarchy.rb

@@ -0,0 +1,10 @@
+module GeoNamesAPI
+  # This endpoint returns a list of geonames, but it's a single hierarchy,
+  # so it should be considered a singleton endpoint.
+  class Hierarchy < SingletonEndpoint
+
+    METHOD = "hierarchyJSON"
+    FIND_PARAMS = %w(geonameId)
+
+  end
+end

data/lib/geonames_api/list_endpoint.rb

@@ -0,0 +1,21 @@
+require 'forwardable'
+module GeoNamesAPI
+  class ListEndpoint < Base
+    def self.endpoint_returns_list?
+      true
+    end
+
+    def next_page
+      self.class.where(request_params.merge(
+        startRow: request_params[:startRow].to_i + size
+      ))
+    end
+
+    # Pages are 0-indexed.
+    def to_page(page_idx)
+      self.class.where(request_params.merge(
+        startRow: (request_params[:maxRows] || size).to_i * page_idx
+      ))
+    end
+  end
+end

data/lib/geonames_api/nearby_postal_code.rb

@@ -0,0 +1,17 @@
+module GeoNamesAPI
+  class NearbyPostalCode < ListEndpoint
+
+    #radius in km
+    METHOD = "findNearbyPostalCodesJSON"
+    FIND_PARAMS = %w(postalcode country radius maxRows)
+
+    def self.find_all_by_lat_lng(lat, lng, radius=10, maxRows=5)
+      where({
+        'lat' => lat,
+        'lng' => lng,
+        'radius' => radius,
+        'maxRows' => maxRows
+      }).collect { |response| PostalCode.new(response) if response }.compact
+    end
+  end
+end

data/lib/geonames_api/place.rb

@@ -0,0 +1,8 @@
+module GeoNamesAPI
+  class Place < ListEndpoint
+
+    METHOD = "findNearbyJSON"
+    FIND_PARAMS = %w(lat lng radius maxRows)
+
+  end
+end

data/lib/geonames_api/place_name.rb

@@ -0,0 +1,8 @@
+module GeoNamesAPI
+  class PlaceName < ListEndpoint
+
+    METHOD = "findNearbyPlaceNameJSON"
+    FIND_PARAMS = %w(lat lng radius maxRows)
+
+  end
+end

data/lib/geonames_api/place_search.rb

@@ -0,0 +1,16 @@
+module GeoNamesAPI
+  class PlaceSearch < ListEndpoint
+
+    METHOD = 'searchJSON'
+    FIND_PARAMS = %w(q maxRows)
+    DEFAULT_MAX_ROWS = 100
+
+    def self.find_by_place_name(name, max_rows = DEFAULT_MAX_ROWS)
+      where(name: name, maxRows: max_rows)
+    end
+
+    def self.find_by_exact_place_name(name, max_rows = DEFAULT_MAX_ROWS)
+      where(name_equals: name, maxRows: max_rows)
+    end
+  end
+end

data/lib/geonames_api/postal_code.rb

@@ -0,0 +1,23 @@
+module GeoNamesAPI
+  class PostalCode < ListEndpoint
+
+    METHOD = "postalCodeLookupJSON"
+    FIND_PARAMS = %w(postalcode country)
+
+    def city
+      place_name
+    end
+
+    def state
+      admin_name1
+    end
+
+    def state_short
+      admin_code1
+    end
+
+    def nearby_codes(radius=10, maxRows=5)
+      NearbyPostalCode.all(postalcode, country_code, radius, maxRows)
+    end
+  end
+end

data/lib/geonames_api/singleton_endpoint.rb

@@ -0,0 +1,7 @@
+module GeoNamesAPI
+  class SingletonEndpoint < Base
+    def self.endpoint_returns_list?
+      false
+    end
+  end
+end

data/lib/geonames_api/street.rb

@@ -0,0 +1,8 @@
+module GeoNamesAPI
+  class Street < ListEndpoint
+
+    METHOD = "findNearbyStreetsJSON"
+    FIND_PARAMS = %w(lat lng radius maxRows)
+
+  end
+end

data/lib/geonames_api/time_zone.rb

@@ -1,31 +1,34 @@
 module GeoNamesAPI
-  class TimeZone < GeoNamesAPI::Object
-    
+  class TimeZone < SingletonEndpoint
+
     METHOD = "timezoneJSON"
-    ID = ["lat", "lng"]
-    NESTED = false
-    
+    FIND_PARAMS = %w(lat lng radius date)
+
     def time_zone
       ActiveSupport::TimeZone.new(timezone_id)
     end
-    
+
+    def common_name
+      ActiveSupport::TimeZone::MAPPING.key(timezone_id)
+    end
+
     def local(time_type)
       t = DateTime.parse(send(time_type))
       time_zone.local(t.year, t.month, t.day, t.hour, t.minute)
     end
-    
+
     def utc(time_type)
       local(time_type).utc
     end
-    
+
     def method_missing(method, *args)
       case method
-      # Provides the local and utc time variant of each time
-      # Examples: time_zone.sunrise_local, time_zone.time_utc
-      when /\A(.*)_(local|utc)\Z/
-        send($2, $1)
+        # Provides the local and utc time variant of each time
+        # Examples: time_zone.sunrise_local, time_zone.time_utc
+        when /\A(.*)_(local|utc)\Z/
+          send($2, $1)
       end
     end
-    
+
   end
-end
+end

data/lib/geonames_api/version.rb

@@ -1,3 +1,3 @@
 module GeoNamesAPI
-  VERSION = "0.0.6"
-end
+  VERSION = Gem::Version.new('0.1.0')
+end

data/lib/geonames_api/weather.rb

@@ -1,38 +1,38 @@
 module GeoNamesAPI
-  class Weather < GeoNamesAPI::Object
-    
+  class Weather < List
+
     METHOD = "findNearByWeatherJSON"
-    ID = ["lat", "lng"]
-    
+    FIND_PARAMS = %w(lat lng radius)
+
     def geo_names_api_country
       @geo_names_api_country ||= GeoNamesAPI::Country.find(country_code)
     end
-    
+
     def geo_names_api_time_zone
       @geo_names_api_time_zone ||= GeoNamesAPI::TimeZone.find(lat, lng)
     end
-    
+
     def time_zone
       geo_names_api_time_zone.time_zone
     end
-        
+
     def at_local
       t = DateTime.parse(datetime)
       time_zone.local(t.year, t.month, t.day, t.hour, t.minute)
     end
-    
+
     def at_utc
       at_local.utc
     end
-    
+
     def elevation_feet
       elevation * 3.28084 if elevation
     end
-    
+
     def elevation_meters
       elevation if elevation
     end
-        
+
     def convert_c_to_f(temp)
       temp * 9.to_f / 5.to_f + 32
     end
@@ -40,18 +40,18 @@ module GeoNamesAPI
     def temperature_f
       convert_c_to_f(temperature) if temperature
     end
-    
+
     def temperature_c
       temperature if temperature
     end
-    
+
     def dew_point_f
       convert_c_to_f(dew_point) if temperature
     end
-    
+
     def dew_point_c
       dew_point if temperature
     end
-    
+
   end
-end
+end

data/lib/geonames_api/weather_i_c_a_o.rb

@@ -0,0 +1,8 @@
+module GeoNamesAPI
+  class WeatherICAO < SingletonEndpoint
+
+    METHOD = 'weatherIcaoJSON'
+    FIND_PARAMS = %w(ICAO)
+
+  end
+end

data/lib/geonames_api/wikipedia.rb

@@ -1,8 +1,8 @@
 module GeoNamesAPI
-  class Wikipedia < GeoNamesAPI::Object
-    
+  class Wikipedia < ListEndpoint
+
     METHOD = "findNearbyWikipediaJSON"
-    ID = %W(lat lng)
-    
+    FIND_PARAMS = %W(lat lng radius maxRows)
+
   end
-end
+end

data/spec/geonames_api/country_subdivision_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+
+describe GeoNamesAPI::CountrySubdivision do
+  def should_be_sf(result)
+    result.should be_present
+    result.admin_code1.should == 'CA'
+    result.admin_name1.should == 'California'
+    result.country_code.should == 'US'
+    result.country_name.should == 'United States'
+  end
+
+  describe '::find' do
+    it 'should find one subdivision' do
+      result = GeoNamesAPI::CountrySubdivision.find(37.8, -122.4)
+      should_be_sf(result)
+    end
+  end
+
+  describe '::all' do
+    it 'should find multiple subdivisions' do
+      result = GeoNamesAPI::CountrySubdivision.all(37.8, -122.4)
+      result.size.should > 0
+      should_be_sf(result.first)
+    end
+  end
+end