Bump webmock from 3.9.4 to 3.9.5

[rails.git] / lib / osm.rb

diff --git a/lib/osm.rb b/lib/osm.rb
index 6a41a57b623ff7f7030d8248bd2d94db8681f25b..04cbf17faf193e215463281e31bd2e031bb96ee3 100644 (file)
--- a/lib/osm.rb
+++ b/lib/osm.rb
@@ -1,69 +1,68 @@
 # The OSM module provides support functions for OSM.
 module OSM
 # The OSM module provides support functions for OSM.
 module OSM

-  require 'time'
-  require 'rexml/parsers/sax2parser'
-  require 'rexml/text'
-  require 'xml/libxml'
+  require "time"
+  require "rexml/parsers/sax2parser"
+  require "rexml/text"
+  require "xml/libxml"

 
   if defined?(SystemTimer)
     Timer = SystemTimer
   else
 
   if defined?(SystemTimer)
     Timer = SystemTimer
   else

-    require 'timeout'
+    require "timeout"

     Timer = Timeout
   end
 
   # The base class for API Errors.
   class APIError < RuntimeError
     Timer = Timeout
   end
 
   # The base class for API Errors.
   class APIError < RuntimeError

-    def status
-      :internal_server_error
+    def initialize(message = "Generic API Error")
+      super message

     end
 
     end
 

-    def to_s
-      "Generic API Error"
+    def status
+      :internal_server_error

     end
   end
 
   # Raised when access is denied.
     end
   end
 
   # Raised when access is denied.

-  class APIAccessDenied < RuntimeError
-    def status
-      :forbidden
+  class APIAccessDenied < APIError
+    def initialize
+      super "Access denied"

     end
 
     end
 

-    def to_s
-      "Access denied"
+    def status
+      :forbidden

     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
+    def initialize
+      super "Object not found"

     end
 
     end
 

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

     end
   end
 
   # Raised when a precondition to an API action fails sanity check.
   class APIPreconditionFailedError < APIError
     def initialize(message = "")
     end
   end
 
   # Raised when a precondition to an API action fails sanity check.
   class APIPreconditionFailedError < APIError
     def initialize(message = "")

-      @message = message
+      super "Precondition failed: #{message}"

     end
 
     def status
       :precondition_failed
     end
     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
     def initialize(object = "object", object_id = "")
   end
 
   # Raised when to delete an already-deleted object.
   class APIAlreadyDeletedError < APIError
     def initialize(object = "object", object_id = "")

-      @object, @object_id = object, object_id
+      @object = object
+      @object_id = object_id
+
+      super "The #{object} with the id #{object_id} has already been deleted"

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


@@ -71,20 +70,16 @@ module OSM
     def status
       :gone
     end
     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
 
   # Raised when the user logged in isn't the same as the changeset
   class APIUserChangesetMismatchError < APIError

-    def status
-      :conflict
+    def initialize
+      super "The user doesn't own that changeset"

     end
 
     end
 

-    def to_s
-      "The user doesn't own that changeset"
+    def status
+      :conflict

     end
   end
 
     end
   end
 


@@ -92,6 +87,8 @@ module OSM
   class APIChangesetAlreadyClosedError < APIError
     def initialize(changeset)
       @changeset = changeset
   class APIChangesetAlreadyClosedError < APIError
     def initialize(changeset)
       @changeset = changeset

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

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -99,16 +96,14 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}"
-    end

   end
 
   # Raised when the changeset provided is not yet closed
   class APIChangesetNotYetClosedError < APIError
     def initialize(changeset)
       @changeset = changeset
   end
 
   # Raised when the changeset provided is not yet closed
   class APIChangesetNotYetClosedError < APIError
     def initialize(changeset)
       @changeset = changeset

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

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -116,16 +111,14 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "The changeset #{@changeset.id} is not yet closed."
-    end

   end
 
   # Raised when a user is already subscribed to the changeset
   class APIChangesetAlreadySubscribedError < APIError
     def initialize(changeset)
       @changeset = changeset
   end
 
   # Raised when a user is already subscribed to the changeset
   class APIChangesetAlreadySubscribedError < APIError
     def initialize(changeset)
       @changeset = changeset

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

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -133,16 +126,14 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "You are already subscribed to changeset #{@changeset.id}."
-    end

   end
 
   # Raised when a user is not subscribed to the changeset
   class APIChangesetNotSubscribedError < APIError
     def initialize(changeset)
       @changeset = changeset
   end
 
   # Raised when a user is not subscribed to the changeset
   class APIChangesetNotSubscribedError < APIError
     def initialize(changeset)
       @changeset = changeset

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

     end
 
     attr_reader :changeset
     end
 
     attr_reader :changeset


@@ -150,20 +141,16 @@ module OSM
     def status
       :not_found
     end
     def status
       :not_found
     end

-
-    def to_s
-      "You are not subscribed to changeset #{@changeset.id}."
-    end

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

-    def status
-      :conflict
+    def initialize
+      super "You need to supply a changeset to be able to make a change"

     end
 
     end
 

-    def to_s
-      "You need to supply a changeset to be able to make a change"
+    def status
+      :conflict

     end
   end
 
     end
   end
 


@@ -171,54 +158,47 @@ 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)

-      @provided, @allowed = provided, allowed
+      super "Changeset mismatch: Provided #{provided} but only #{allowed} is allowed"

     end
 
     def status
       :conflict
     end
     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)
   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
+      super "Unknown action #{provided}, choices are create, modify, delete"

     end
 
     def status
       :bad_request
     end
     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 = "")
   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
+      super "Cannot parse valid #{model} from xml string #{xml}. #{message}"

     end
 
     def status
       :bad_request
     end
     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
     def initialize(id, type, provided, latest)
   end
 
   # Raised when the provided version is not equal to the latest in the db.
   class APIVersionMismatchError < APIError
     def initialize(id, type, provided, latest)

-      @id, @type, @provided, @latest = id, type, provided, latest
+      @id = id
+      @type = type
+      @provided = provided
+      @latest = latest
+
+      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


@@ -226,17 +206,17 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}"
-    end

   end
 
   # raised when a two tags have a duplicate key string in an element.
   # this is now forbidden by the API.
   class APIDuplicateTagsError < APIError
     def initialize(type, id, tag_key)
   end
 
   # raised when a two tags have a duplicate key string in an element.
   # this is now forbidden by the API.
   class APIDuplicateTagsError < APIError
     def initialize(type, id, tag_key)

-      @type, @id, @tag_key = type, id, tag_key
+      @type = type
+      @id = id
+      @tag_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


@@ -244,17 +224,17 @@ module OSM
     def status
       :bad_request
     end
     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(id, provided, max)
   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(id, provided, max)

-      @id, @provided, @max = id, provided, max
+      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
     end
 
     attr_reader :id, :provided, :max


@@ -262,69 +242,45 @@ module OSM
     def status
       :bad_request
     end
     def status
       :bad_request
     end

-
-    def to_s
-      "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed"
-    end

   end
 
   ##
   # raised when user input couldn't be parsed
   class APIBadUserInput < APIError
   end
 
   ##
   # raised when user input couldn't be parsed
   class APIBadUserInput < APIError

-    def initialize(message)
-      @message = message
-    end
-

     def status
       :bad_request
     end
     def status
       :bad_request
     end

-
-    def to_s
-      @message
-    end

   end
 
   ##
   # raised when bounding box is invalid
   class APIBadBoundingBox < APIError
   end
 
   ##
   # raised when bounding box is invalid
   class APIBadBoundingBox < APIError

-    def initialize(message)
-      @message = message
-    end
-

     def status
       :bad_request
     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)
   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
+      super "Only method #{supported_method} is supported on this URI"

     end
 
     def status
       :method_not_allowed
     end
     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
   end
 
   ##
   # raised when an API call takes too long
   class APITimeoutError < APIError

-    def status
-      :request_timeout
+    def initialize
+      super "Request timed out"

     end
 
     end
 

-    def to_s
-      "Request timed out"
+    def status
+      :request_timeout

     end
   end
 
     end
   end
 


@@ -332,12 +288,12 @@ module OSM
   # raised when someone tries to redact a current version of
   # an element - only historical versions can be redacted.
   class APICannotRedactError < APIError
   # raised when someone tries to redact a current version of
   # an element - only historical versions can be redacted.
   class APICannotRedactError < APIError

-    def status
-      :bad_request
+    def initialize
+      super "Cannot redact current version of element, only historical versions may be redacted."

     end
 
     end
 

-    def to_s
-      "Cannot redact current version of element, only historical versions may be redacted."
+    def status
+      :bad_request

     end
   end
 
     end
   end
 


@@ -345,6 +301,8 @@ module OSM
   class APINoteAlreadyClosedError < APIError
     def initialize(note)
       @note = note
   class APINoteAlreadyClosedError < APIError
     def initialize(note)
       @note = note

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

     end
 
     attr_reader :note
     end
 
     attr_reader :note


@@ -352,16 +310,14 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "The note #{@note.id} was closed at #{@note.closed_at}"
-    end

   end
 
   # Raised when the note provided is already open
   class APINoteAlreadyOpenError < APIError
     def initialize(note)
       @note = note
   end
 
   # Raised when the note provided is already open
   class APINoteAlreadyOpenError < APIError
     def initialize(note)
       @note = note

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

     end
 
     attr_reader :note
     end
 
     attr_reader :note


@@ -369,16 +325,14 @@ module OSM
     def status
       :conflict
     end
     def status
       :conflict
     end

-
-    def to_s
-      "The note #{@note.id} is already open"
-    end

   end
 
   # raised when a two preferences have a duplicate key string.
   class APIDuplicatePreferenceError < APIError
     def initialize(key)
       @key = key
   end
 
   # raised when a two preferences have a duplicate key string.
   class APIDuplicatePreferenceError < APIError
     def initialize(key)
       @key = key

+
+      super "Duplicate preferences with key #{key}"

     end
 
     attr_reader :key
     end
 
     attr_reader :key


@@ -386,10 +340,6 @@ module OSM
     def status
       :bad_request
     end
     def status
       :bad_request
     end

-
-    def to_s
-      "Duplicate preferences with key #{@key}"
-    end

   end
 
   # Helper methods for going to/from mercator and lat/lng.
   end
 
   # Helper methods for going to/from mercator and lat/lng.


@@ -464,12 +414,12 @@ module OSM
         lonradius = PI
       end
 
         lonradius = PI
       end
 

-      minlat = (@lat - latradius) * 180 / PI
-      maxlat = (@lat + latradius) * 180 / PI
-      minlon = (@lon - lonradius) * 180 / PI
-      maxlon = (@lon + lonradius) * 180 / PI
+      minlat = [(@lat - latradius) * 180 / PI, -90].max
+      maxlat = [(@lat + latradius) * 180 / PI, 90].min
+      minlon = [(@lon - lonradius) * 180 / PI, -180].max
+      maxlon = [(@lon + lonradius) * 180 / PI, 180].min

 
 

-      { :minlat => minlat, :maxlat => maxlat, :minlon => minlon, :maxlon => maxlon }
+      BoundingBox.new(minlon, minlat, maxlon, maxlat)

     end
 
     # get the SQL to use to calculate distance
     end
 
     # get the SQL to use to calculate distance


@@ -482,42 +432,35 @@ module OSM
     def get_xml_doc
       doc = XML::Document.new
       doc.encoding = XML::Encoding::UTF_8
     def get_xml_doc
       doc = XML::Document.new
       doc.encoding = XML::Encoding::UTF_8

-      root = XML::Node.new 'osm'
-      root['version'] = API_VERSION.to_s
-      root['generator'] = GENERATOR
-      root['copyright'] = COPYRIGHT_OWNER
-      root['attribution'] = ATTRIBUTION_URL
-      root['license'] =  LICENSE_URL
+      root = XML::Node.new "osm"
+      xml_root_attributes.each do |k, v|
+        root[k] = v
+      end

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

-  end

 
 

-  def self.IPToCountry(ip_address)
-    Timer.timeout(4) do
-      ipinfo = Quova::IpInfo.new(ip_address)
+    def xml_root_attributes
+      { "version" => Settings.api_version,
+        "generator" => Settings.generator,
+        "copyright" => Settings.copyright_owner,
+        "attribution" => Settings.attribution_url,
+        "license" => Settings.license_url }
+    end
+  end

 
 

-      if ipinfo.status == Quova::Success
-        country = ipinfo.country_code
-      else
-        Net::HTTP.start('api.hostip.info') do |http|
-          country = http.get("/country.php?ip=#{ip_address}").body
-          country = "GB" if country == "UK"
-        end
-      end
+  def self.ip_to_country(ip_address)
+    ipinfo = maxmind_database.lookup(ip_address) if Settings.key?(:maxmind_database)

 
 

-      return country.upcase
-    end
+    return ipinfo.country.iso_code if ipinfo&.found?

 
 

-    return nil
-  rescue StandardError
-    return nil
+    nil

   end
 
   end
 

-  def self.IPLocation(ip_address)
-    code = OSM.IPToCountry(ip_address)
+  def self.ip_location(ip_address)
+    code = OSM.ip_to_country(ip_address)

 
 

-    if code && country = Country.find_by_code(code)
+    if code && country = Country.find(code)

       return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat }
     end
 
       return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat }
     end
 


@@ -527,14 +470,14 @@ module OSM
   # Parse a float, raising a specified exception on failure
   def self.parse_float(str, klass, *args)
     Float(str)
   # Parse a float, raising a specified exception on failure
   def self.parse_float(str, klass, *args)
     Float(str)

-  rescue
+  rescue StandardError

     raise klass.new(*args)
   end
 
   # Construct a random token of a given length
   def self.make_token(length = 30)
     raise klass.new(*args)
   end
 
   # Construct a random token of a given length
   def self.make_token(length = 30)

-    chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
-    token = ''
+    chars = "abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
+    token = ""

 
     length.times do
       token += chars[(rand * chars.length).to_i].chr
 
     length.times do
       token += chars[(rand * chars.length).to_i].chr


@@ -548,13 +491,24 @@ module OSM
     tilesql = QuadTile.sql_for_area(bbox, prefix)
     bbox = bbox.to_scaled
 
     tilesql = QuadTile.sql_for_area(bbox, prefix)
     bbox = bbox.to_scaled
 

-    "#{tilesql} AND #{prefix}latitude BETWEEN #{bbox.min_lat} AND #{bbox.max_lat} " +
+    "#{tilesql} AND #{prefix}latitude BETWEEN #{bbox.min_lat} AND #{bbox.max_lat} " \

       "AND #{prefix}longitude BETWEEN #{bbox.min_lon} AND #{bbox.max_lon}"
   end
 
       "AND #{prefix}longitude BETWEEN #{bbox.min_lon} AND #{bbox.max_lon}"
   end
 

+  # Return the terms and conditions text for a given country

   def self.legal_text_for_country(country_code)
   def self.legal_text_for_country(country_code)

-    file_name = File.join(Rails.root, "config", "legales", country_code.to_s + ".yml")
-    file_name = File.join(Rails.root, "config", "legales", DEFAULT_LEGALE + ".yml") unless File.exist? file_name
-    YAML.load_file(file_name)
+    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
+    YAML.load_file(file_name).transform_values!(&:html_safe)
+  end
+
+  # Return the HTTP client to use
+  def self.http_client
+    @http_client ||= Faraday.new
+  end
+
+  # Return the MaxMindDB database handle
+  def self.maxmind_database
+    @maxmind_database ||= MaxMindDB.new(Settings.maxmind_database) if Settings.key?(:maxmind_database)

   end
 end
   end
 end