Contents

module MangoPay

  # See http://docs.mangopay.com/api-references/response-codes-rules/
  # and http://docs.mangopay.com/api-references/error-codes/
  #
  # Thrown from any MangoPay API call whenever
  # it returns response with HTTP code != 200.
  # Check @details hash for further info.
  #
  # Two example exceptions with details:
  #
  # * <MangoPay::ResponseError:
  #   One or several required parameters are missing or incorrect. [...]
  #   Email: The Email field is required.>
  # {"Message"=>"One or several required parameters are missing or incorrect.
  #   An incorrect resource ID also raises this kind of error.",
  #  "Type"=>"param_error",
  #  "Id"=>"66936e92-3f21-4a35-b6cf-f1d17c2fb6e5",
  #  "Date"=>1409047252.0,
  #  "errors"=>{"Email"=>"The Email field is required."},
  #  "Code"=>"400",
  #  "Url"=>"/v2/sdk-unit-tests/users/natural"}
  #
  # * <MangoPay::ResponseError: Internal Server Error>
  # {"Message"=>"Internal Server Error",
  #  "Type"=>"other",
  #  "Id"=>"7bdc5c6f-2000-4cd3-96f3-2a3fcb746f07",
  #  "Date"=>1409047251.0,
  #  "errors"=>nil,
  #  "Code"=>"500",
  #  "Url"=>"/v2/sdk-unit-tests/payins/3380640/refunds"}
  class ResponseError < StandardError

    attr_reader :request_url, :code, :details

    def initialize(request_url, code, details)
      @request_url = request_url
      @code = code
      @details = details
      super(message) if message
    end

    def type
      @details['Type'] if @details
    end

    def errors
      @details['errors'] if @details
    end

    def message
      return @message if @message
      msg = @details ? @details['Message'] : ''
      if errors && errors.is_a?(Hash)
        msg += errors.sort.map { |k, v| "\n#{k}: #{v}" }.join
      end
      @message = msg || "#{@code} #{@details['error']}"
    end

  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
mangopay-v4-4.1.0	lib/mangopay/common/response_error.rb
mangopay-v4-4.0.2	lib/mangopay/common/response_error.rb
mangopay-v4-4.0.1	lib/mangopay/common/response_error.rb