Couple of bugfixes, brackets and quotes

[rails.git] / lib / osm.rb

diff --git a/lib/osm.rb b/lib/osm.rb
index ae8b81f5b13f1433f8fa3162cdeded0592c27f64..4c99de2f144e8f111e0bce5c719c015b2409185d 100644 (file)
--- a/lib/osm.rb
+++ b/lib/osm.rb
@@ -10,61 +10,159 @@ module OSM
 
   # The base class for API Errors.
   class APIError < RuntimeError
 
   # The base class for API Errors.
   class APIError < RuntimeError

-    def render_opts
-      { :text => "", :status => :internal_server_error }
+    def status
+      :internal_server_error
+    end
+
+    def to_s
+      "Generic API Error"

     end
   end
 
   # Raised when an API object is not found.
   class APINotFoundError < APIError
     end
   end
 
   # Raised when an API object is not found.
   class APINotFoundError < APIError

+    def status
+      :not_found
+    end
+
+    def to_s
+      "Object not found"
+    end

   end
 
   # Raised when a precondition to an API action fails sanity check.
   class APIPreconditionFailedError < APIError
   end
 
   # Raised when a precondition to an API action fails sanity check.
   class APIPreconditionFailedError < APIError

-    def render_opts
-      { :text => "", :status => :precondition_failed }
+    def initialize(message = "")
+      @message = message
+    end
+
+    def status
+      :precondition_failed    
+    end
+
+    def to_s
+      "Precondition failed: #{@message}"

     end
   end
 
   # Raised when to delete an already-deleted object.
   class APIAlreadyDeletedError < APIError
     end
   end
 
   # Raised when to delete an already-deleted object.
   class APIAlreadyDeletedError < APIError

-    def render_opts
-      { :text => "", :status => :gone }
+    def initialize(object = "object", object_id = "")
+      @object, @object_id = object, object_id
+    end
+    
+    attr_reader :object, :object_id
+
+    def status
+      :gone
+    end
+    
+    def to_s
+      "The #{object} with the id #{object_id} has already been deleted"

     end
   end
 
   # Raised when the user logged in isn't the same as the changeset
   class APIUserChangesetMismatchError < APIError
     end
   end
 
   # Raised when the user logged in isn't the same as the changeset
   class APIUserChangesetMismatchError < APIError

-    def render_opts
-      { :text => "The user doesn't own that changeset", :status => :conflict }
+    def status
+      :conflict
+    end
+
+    def to_s
+      "The user doesn't own that changeset"

     end
   end
 
   # Raised when the changeset provided is already closed
   class APIChangesetAlreadyClosedError < APIError
     end
   end
 
   # Raised when the changeset provided is already closed
   class APIChangesetAlreadyClosedError < APIError

-    def render_opts
-      { :text => "The supplied changeset has already been closed", :status => :conflict }
+    def initialize(changeset)
+      @changeset = changeset
+    end
+
+    attr_reader :changeset
+
+    def status
+      :conflict
+    end
+
+    def to_s
+      "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}"

     end
   end
   
   # Raised when a change is expecting a changeset, but the changeset doesn't exist
   class APIChangesetMissingError < APIError
     end
   end
   
   # Raised when a change is expecting a changeset, but the changeset doesn't exist
   class APIChangesetMissingError < APIError

-    def render_opts
-      { :text => "You need to supply a changeset to be able to make a change", :status => :conflict }
+    def status
+      :conflict
+    end
+
+    def to_s
+      "You need to supply a changeset to be able to make a change"
+    end
+  end
+
+  # Raised when a diff is uploaded containing many changeset IDs which don't match
+  # the changeset ID that the diff was uploaded to.
+  class APIChangesetMismatchError < APIError
+    def initialize(provided, allowed)
+      @provided, @allowed = provided, allowed
+    end
+
+    def status
+      :conflict
+    end
+
+    def to_s
+      "Changeset mismatch: Provided #{@provided} but only #{@allowed} is allowed"
+    end
+  end
+  
+  # Raised when a diff upload has an unknown action. You can only have create,
+  # modify, or delete
+  class APIChangesetActionInvalid < APIError
+    def initialize(provided)
+      @provided = provided
+    end
+
+    def status
+      :bad_request
+    end
+    
+    def to_s
+      "Unknown action #{@provided}, choices are create, modify, delete"
+    end
+  end
+
+  # Raised when bad XML is encountered which stops things parsing as
+  # they should.
+  class APIBadXMLError < APIError
+    def initialize(model, xml, message="")
+      @model, @xml, @message = model, xml, message
+    end
+
+    def status
+      :bad_request
+    end
+
+    def to_s
+      "Cannot parse valid #{@model} from xml string #{@xml}. #{@message}"

     end
   end
 
   # Raised when the provided version is not equal to the latest in the db.
   class APIVersionMismatchError < APIError
     end
   end
 
   # Raised when the provided version is not equal to the latest in the db.
   class APIVersionMismatchError < APIError

-    def initialize(provided, latest)
-      @provided, @latest = provided, latest
+    def initialize(id, type, provided, latest)
+      @id, @type, @provided, @latest = id, type, provided, latest

     end
 
     end
 

-    attr_reader :provided, :latest
+    attr_reader :provided, :latest, :id, :type

 
 

-    def render_opts
-      { :text => "Version mismatch: Provided " + provided.to_s +
-      ", server had: " + latest.to_s, :status => :conflict }
+    def status
+      :conflict
+    end
+
+    def to_s
+      "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}"

     end
   end
 
     end
   end
 


@@ -77,9 +175,74 @@ module OSM
 
     attr_reader :type, :id, :tag_key
 
 
     attr_reader :type, :id, :tag_key
 

-    def render_opts
-      { :text => "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}.",
-        :status => :bad_request }
+    def status
+      :bad_request
+    end
+
+    def to_s
+      "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}"
+    end
+  end
+  
+  # Raised when a way has more than the configured number of way nodes.
+  # This prevents ways from being to long and difficult to work with
+  class APITooManyWayNodesError < APIError
+    def initialize(provided, max)
+      @provided, @max = provided, max
+    end
+    
+    attr_reader :provided, :max
+
+    def status
+      :bad_request
+    end
+    
+    def to_s
+      "You tried to add #{provided} nodes to the way, however only #{max} are allowed"
+    end
+  end
+
+  ##
+  # raised when user input couldn't be parsed
+  class APIBadUserInput < APIError
+    def initialize(message)
+      @message = message
+    end
+
+    def status
+      :bad_request
+    end
+
+    def to_s
+      @message
+    end
+  end
+
+  ##
+  # raised when an API call is made using a method not supported on that URI
+  class APIBadMethodError < APIError
+    def initialize(supported_method)
+      @supported_method = supported_method
+    end
+
+    def status
+      :method_not_allowed
+    end
+
+    def to_s
+      "Only method #{@supported_method} is supported on this URI"
+    end
+  end
+
+  ##
+  # raised when an API call takes too long
+  class APITimeoutError < APIError
+    def status
+      :request_timeout
+    end
+
+    def to_s
+      "Request timed out"

     end
   end
 
     end
   end
 


@@ -160,7 +323,7 @@ module OSM
   class GeoRSS
     def initialize(feed_title='OpenStreetMap GPS Traces', feed_description='OpenStreetMap GPS Traces', feed_url='http://www.openstreetmap.org/traces/')
       @doc = XML::Document.new
   class GeoRSS
     def initialize(feed_title='OpenStreetMap GPS Traces', feed_description='OpenStreetMap GPS Traces', feed_url='http://www.openstreetmap.org/traces/')
       @doc = XML::Document.new

-      @doc.encoding = 'UTF-8' 
+      @doc.encoding = XML::Encoding::UTF_8

 
       rss = XML::Node.new 'rss'
       @doc.root = rss
 
       rss = XML::Node.new 'rss'
       @doc.root = rss


@@ -246,10 +409,10 @@ module OSM
   class API
     def get_xml_doc
       doc = XML::Document.new
   class API
     def get_xml_doc
       doc = XML::Document.new

-      doc.encoding = 'UTF-8' 
+      doc.encoding = XML::Encoding::UTF_8

       root = XML::Node.new 'osm'
       root['version'] = API_VERSION
       root = XML::Node.new 'osm'
       root['version'] = API_VERSION

-      root['generator'] = 'OpenStreetMap server'
+      root['generator'] = GENERATOR

       doc.root = root
       return doc
     end
       doc.root = root
       return doc
     end


@@ -260,16 +423,8 @@ module OSM
       Net::HTTP.start('api.hostip.info') do |http|
         country = http.get("/country.php?ip=#{ip_address}").body
         country = "GB" if country == "UK"
       Net::HTTP.start('api.hostip.info') do |http|
         country = http.get("/country.php?ip=#{ip_address}").body
         country = "GB" if country == "UK"

-        Net::HTTP.start('ws.geonames.org') do |http|
-          xml = REXML::Document.new(http.get("/countryInfo?country=#{country}").body)
-          xml.elements.each("geonames/country") do |ele|
-            minlon = ele.get_text("bBoxWest").to_s
-            minlat = ele.get_text("bBoxSouth").to_s
-            maxlon = ele.get_text("bBoxEast").to_s
-            maxlat = ele.get_text("bBoxNorth").to_s
-            return { :minlon => minlon, :minlat => minlat, :maxlon => maxlon, :maxlat => maxlat }
-          end
-        end
+        country = Country.find_by_code(country)
+        return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat }

       end
     end
 
       end
     end