Move api messages resources to api namespace

[rails.git] / lib / osm.rb

diff --git a/lib/osm.rb b/lib/osm.rb
index a4ac7fc576aa91db7d47131e7c4866c7d4db0fbd..46f37036f92d796243960cf1c7c8b63fdd91244e 100644 (file)
--- a/lib/osm.rb
+++ b/lib/osm.rb
@@ -5,17 +5,10 @@ module OSM
   require "rexml/text"
   require "xml/libxml"
 
   require "rexml/text"
   require "xml/libxml"
 

-  if defined?(SystemTimer)
-    Timer = SystemTimer
-  else
-    require "timeout"
-    Timer = Timeout
-  end
-

   # The base class for API Errors.
   class APIError < RuntimeError
     def initialize(message = "Generic API Error")
   # The base class for API Errors.
   class APIError < RuntimeError
     def initialize(message = "Generic API Error")

-      super message
+      super

     end
 
     def status
     end
 
     def status


@@ -26,7 +19,7 @@ module OSM
   # Raised when access is denied.
   class APIAccessDenied < APIError
     def initialize
   # Raised when access is denied.
   class APIAccessDenied < APIError
     def initialize

-      super "Access denied"
+      super("Access denied")

     end
 
     def status
     end
 
     def status


@@ -37,7 +30,7 @@ module OSM
   # Raised when an API object is not found.
   class APINotFoundError < APIError
     def initialize
   # Raised when an API object is not found.
   class APINotFoundError < APIError
     def initialize

-      super "Object not found"
+      super("Object not found")

     end
 
     def status
     end
 
     def status


@@ -48,7 +41,7 @@ module OSM
   # Raised when a precondition to an API action fails sanity check.
   class APIPreconditionFailedError < APIError
     def initialize(message = "")
   # Raised when a precondition to an API action fails sanity check.
   class APIPreconditionFailedError < APIError
     def initialize(message = "")

-      super "Precondition failed: #{message}"
+      super("Precondition failed: #{message}")

     end
 
     def status
     end
 
     def status


@@ -62,7 +55,7 @@ module OSM
       @object = object
       @object_id = object_id
 
       @object = object
       @object_id = object_id
 

-      super "The #{object} with the id #{object_id} has already been deleted"
+      super("The #{object} with the id #{object_id} has already been deleted")

     end
 
     attr_reader :object, :object_id
     end
 
     attr_reader :object, :object_id


@@ -75,7 +68,7 @@ module OSM
   # Raised when the user logged in isn't the same as the changeset
   class APIUserChangesetMismatchError < APIError
     def initialize
   # Raised when the user logged in isn't the same as the changeset
   class APIUserChangesetMismatchError < APIError
     def initialize

-      super "The user doesn't own that changeset"
+      super("The user doesn't own that changeset")

     end
 
     def status
     end
 
     def status


@@ -88,7 +81,7 @@ module OSM
     def initialize(changeset)
       @changeset = changeset
 
     def initialize(changeset)
       @changeset = changeset
 

-      super "The changeset #{changeset.id} was closed at #{changeset.closed_at}"
+      super("The changeset #{changeset.id} was closed at #{changeset.closed_at}")

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -103,7 +96,7 @@ module OSM
     def initialize(changeset)
       @changeset = changeset
 
     def initialize(changeset)
       @changeset = changeset
 

-      super "The changeset #{changeset.id} is not yet closed."
+      super("The changeset #{changeset.id} is not yet closed.")

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -118,7 +111,7 @@ module OSM
     def initialize(changeset)
       @changeset = changeset
 
     def initialize(changeset)
       @changeset = changeset
 

-      super "You are already subscribed to changeset #{changeset.id}."
+      super("You are already subscribed to changeset #{changeset.id}.")

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -133,7 +126,7 @@ module OSM
     def initialize(changeset)
       @changeset = changeset
 
     def initialize(changeset)
       @changeset = changeset
 

-      super "You are not subscribed to changeset #{changeset.id}."
+      super("You are not subscribed to changeset #{changeset.id}.")

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -146,7 +139,7 @@ module OSM
   # Raised when a change is expecting a changeset, but the changeset doesn't exist
   class APIChangesetMissingError < APIError
     def initialize
   # Raised when a change is expecting a changeset, but the changeset doesn't exist
   class APIChangesetMissingError < APIError
     def initialize

-      super "You need to supply a changeset to be able to make a change"
+      super("You need to supply a changeset to be able to make a change")

     end
 
     def status
     end
 
     def status


@@ -158,7 +151,7 @@ module OSM
   # the changeset ID that the diff was uploaded to.
   class APIChangesetMismatchError < APIError
     def initialize(provided, allowed)
   # the changeset ID that the diff was uploaded to.
   class APIChangesetMismatchError < APIError
     def initialize(provided, allowed)

-      super "Changeset mismatch: Provided #{provided} but only #{allowed} is allowed"
+      super("Changeset mismatch: Provided #{provided} but only #{allowed} is allowed")

     end
 
     def status
     end
 
     def status


@@ -170,7 +163,7 @@ module OSM
   # modify, or delete
   class APIChangesetActionInvalid < APIError
     def initialize(provided)
   # modify, or delete
   class APIChangesetActionInvalid < APIError
     def initialize(provided)

-      super "Unknown action #{provided}, choices are create, modify, delete"
+      super("Unknown action #{provided}, choices are create, modify, delete")

     end
 
     def status
     end
 
     def status


@@ -182,7 +175,7 @@ module OSM
   # they should.
   class APIBadXMLError < APIError
     def initialize(model, xml, message = "")
   # they should.
   class APIBadXMLError < APIError
     def initialize(model, xml, message = "")

-      super "Cannot parse valid #{model} from xml string #{xml}. #{message}"
+      super("Cannot parse valid #{model} from xml string #{xml}. #{message}")

     end
 
     def status
     end
 
     def status


@@ -198,7 +191,7 @@ module OSM
       @provided = provided
       @latest = latest
 
       @provided = provided
       @latest = latest
 

-      super "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}"
+      super("Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}")

     end
 
     attr_reader :provided, :latest, :id, :type
     end
 
     attr_reader :provided, :latest, :id, :type


@@ -216,7 +209,7 @@ module OSM
       @id = id
       @tag_key = tag_key
 
       @id = id
       @tag_key = tag_key
 

-      super "Element #{type}/#{id} has duplicate tags with key #{tag_key}"
+      super("Element #{type}/#{id} has duplicate tags with key #{tag_key}")

     end
 
     attr_reader :type, :id, :tag_key
     end
 
     attr_reader :type, :id, :tag_key


@@ -230,7 +223,25 @@ module OSM
   # This prevents ways from being to long and difficult to work with
   class APITooManyWayNodesError < APIError
     def initialize(id, provided, max)
   # This prevents ways from being to long and difficult to work with
   class APITooManyWayNodesError < APIError
     def initialize(id, provided, max)

-      super "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed"
+      super("You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed")
+
+      @id = id
+      @provided = provided
+      @max = max
+    end
+
+    attr_reader :id, :provided, :max
+
+    def status
+      :bad_request
+    end
+  end
+
+  # Raised when a relation has more than the configured number of relation members.
+  # This prevents relations from being too complex and difficult to work with
+  class APITooManyRelationMembersError < APIError
+    def initialize(id, provided, max)
+      super("You tried to add #{provided} members to relation #{id}, however only #{max} are allowed")

 
       @id = id
       @provided = provided
 
       @id = id
       @provided = provided


@@ -247,10 +258,6 @@ module OSM
   ##
   # raised when user input couldn't be parsed
   class APIBadUserInput < APIError
   ##
   # raised when user input couldn't be parsed
   class APIBadUserInput < APIError

-    def initialize(message)
-      super message
-    end
-

     def status
       :bad_request
     end
     def status
       :bad_request
     end


@@ -259,10 +266,6 @@ module OSM
   ##
   # raised when bounding box is invalid
   class APIBadBoundingBox < APIError
   ##
   # raised when bounding box is invalid
   class APIBadBoundingBox < APIError

-    def initialize(message)
-      super message
-    end
-

     def status
       :bad_request
     end
     def status
       :bad_request
     end


@@ -272,7 +275,7 @@ module OSM
   # raised when an API call is made using a method not supported on that URI
   class APIBadMethodError < APIError
     def initialize(supported_method)
   # raised when an API call is made using a method not supported on that URI
   class APIBadMethodError < APIError
     def initialize(supported_method)

-      super "Only method #{supported_method} is supported on this URI"
+      super("Only method #{supported_method} is supported on this URI")

     end
 
     def status
     end
 
     def status


@@ -284,7 +287,7 @@ module OSM
   # raised when an API call takes too long
   class APITimeoutError < APIError
     def initialize
   # raised when an API call takes too long
   class APITimeoutError < APIError
     def initialize

-      super "Request timed out"
+      super("Request timed out")

     end
 
     def status
     end
 
     def status


@@ -297,7 +300,7 @@ module OSM
   # an element - only historical versions can be redacted.
   class APICannotRedactError < APIError
     def initialize
   # an element - only historical versions can be redacted.
   class APICannotRedactError < APIError
     def initialize

-      super "Cannot redact current version of element, only historical versions may be redacted."
+      super("Cannot redact current version of element, only historical versions may be redacted.")

     end
 
     def status
     end
 
     def status


@@ -310,7 +313,7 @@ module OSM
     def initialize(note)
       @note = note
 
     def initialize(note)
       @note = note
 

-      super "The note #{note.id} was closed at #{note.closed_at}"
+      super("The note #{note.id} was closed at #{note.closed_at}")

     end
 
     attr_reader :note
     end
 
     attr_reader :note


@@ -325,7 +328,7 @@ module OSM
     def initialize(note)
       @note = note
 
     def initialize(note)
       @note = note
 

-      super "The note #{note.id} is already open"
+      super("The note #{note.id} is already open")

     end
 
     attr_reader :note
     end
 
     attr_reader :note


@@ -340,7 +343,7 @@ module OSM
     def initialize(key)
       @key = key
 
     def initialize(key)
       @key = key
 

-      super "Duplicate preferences with key #{key}"
+      super("Duplicate preferences with key #{key}")

     end
 
     attr_reader :key
     end
 
     attr_reader :key


@@ -350,6 +353,28 @@ module OSM
     end
   end
 
     end
   end
 

+  # Raised when a rate limit is exceeded
+  class APIRateLimitExceeded < APIError
+    def initialize
+      super("Rate limit exceeded")
+    end
+
+    def status
+      :too_many_requests
+    end
+  end
+
+  # Raised when a size limit is exceeded
+  class APISizeLimitExceeded < APIError
+    def initialize
+      super("Size limit exceeded")
+    end
+
+    def status
+      :payload_too_large
+    end
+  end
+

   # Helper methods for going to/from mercator and lat/lng.
   class Mercator
     include Math
   # Helper methods for going to/from mercator and lat/lng.
   class Mercator
     include Math


@@ -362,23 +387,23 @@ module OSM
       yscale = ysize / height
       scale = [xscale, yscale].max
 
       yscale = ysize / height
       scale = [xscale, yscale].max
 

-      xpad = width * scale - xsize
-      ypad = height * scale - ysize
+      xpad = (width * scale) - xsize
+      ypad = (height * scale) - ysize

 
       @width = width
       @height = height
 
 
       @width = width
       @height = height
 

-      @tx = xsheet(min_lon) - xpad / 2
-      @ty = ysheet(min_lat) - ypad / 2
+      @tx = xsheet(min_lon) - (xpad / 2)
+      @ty = ysheet(min_lat) - (ypad / 2)

 
 

-      @bx = xsheet(max_lon) + xpad / 2
-      @by = ysheet(max_lat) + ypad / 2
+      @bx = xsheet(max_lon) + (xpad / 2)
+      @by = ysheet(max_lat) + (ypad / 2)

     end
 
     # the following two functions will give you the x/y on the entire sheet
 
     def ysheet(lat)
     end
 
     # the following two functions will give you the x/y on the entire sheet
 
     def ysheet(lat)

-      log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180)
+      log(tan((PI / 4) + (lat * PI / 180 / 2))) / (PI / 180)

     end
 
     def xsheet(lon)
     end
 
     def xsheet(lon)


@@ -386,12 +411,17 @@ module OSM
     end
 
     # and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME
     end
 
     # and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME

+    # If the bbox has no extent, return the centre of the image to avoid dividing by zero.

 
     def y(lat)
 
     def y(lat)

+      return @height / 2 if (@by - @ty).zero?
+

       @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
     end
 
     def x(lon)
       @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
     end
 
     def x(lon)

+      return @width / 2 if (@bx - @tx).zero?
+

       ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
     end
   end
       ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
     end
   end


@@ -409,7 +439,7 @@ module OSM
     def distance(lat, lon)
       lat = lat * PI / 180
       lon = lon * PI / 180
     def distance(lat, lon)
       lat = lat * PI / 180
       lon = lon * PI / 180

-      6372.795 * 2 * asin(sqrt(sin((lat - @lat) / 2)**2 + cos(@lat) * cos(lat) * sin((lon - @lon) / 2)**2))
+      6372.795 * 2 * asin(sqrt((sin((lat - @lat) / 2)**2) + (cos(@lat) * cos(lat) * (sin((lon - @lon) / 2)**2))))

     end
 
     # get the worst case bounds for a given radius from the base position
     end
 
     # get the worst case bounds for a given radius from the base position


@@ -417,7 +447,7 @@ module OSM
       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2)**2))
 
       begin
       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2)**2))
 
       begin

-        lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2)**2 / cos(@lat)**2))
+        lonradius = 2 * asin(sqrt((sin(radius / 6372.795 / 2)**2) / (cos(@lat)**2)))

       rescue Errno::EDOM, Math::DomainError
         lonradius = PI
       end
       rescue Errno::EDOM, Math::DomainError
         lonradius = PI
       end


@@ -437,7 +467,7 @@ module OSM
   end
 
   class API
   end
 
   class API

-    def get_xml_doc
+    def xml_doc

       doc = XML::Document.new
       doc.encoding = XML::Encoding::UTF_8
       root = XML::Node.new "osm"
       doc = XML::Document.new
       doc.encoding = XML::Encoding::UTF_8
       root = XML::Node.new "osm"


@@ -483,15 +513,8 @@ module OSM
   end
 
   # Construct a random token of a given length
   end
 
   # Construct a random token of a given length

-  def self.make_token(length = 30)
-    chars = "abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
-    token = ""
-
-    length.times do
-      token += chars[(rand * chars.length).to_i].chr
-    end
-
-    token
+  def self.make_token(length = 24)
+    SecureRandom.urlsafe_base64(length)

   end
 
   # Return an SQL fragment to select a given area of the globe
   end
 
   # Return an SQL fragment to select a given area of the globe


@@ -505,14 +528,15 @@ module OSM
 
   # Return the terms and conditions text for a given country
   def self.legal_text_for_country(country_code)
 
   # Return the terms and conditions text for a given country
   def self.legal_text_for_country(country_code)

-    file_name = Rails.root.join("config", "legales", country_code.to_s + ".yml")
-    file_name = Rails.root.join("config", "legales", Settings.default_legale + ".yml") unless File.exist? file_name
+    file_name = Rails.root.join("config", "legales", "#{country_code}.yml")
+    file_name = Rails.root.join("config", "legales", "#{Settings.default_legale}.yml") unless File.exist? file_name

     YAML.load_file(file_name).transform_values!(&:html_safe)
   end
 
   # Return the HTTP client to use
   def self.http_client
     YAML.load_file(file_name).transform_values!(&:html_safe)
   end
 
   # Return the HTTP client to use
   def self.http_client

-    @http_client ||= Faraday.new
+    @http_client ||= Faraday.new(:request => { :timeout => 15 },
+                                 :headers => { :user_agent => Settings.server_url })

   end
 
   # Return the MaxMindDB database handle
   end
 
   # Return the MaxMindDB database handle