class HTTParty::Parser
The default parser used by HTTParty, supports xml, json, html, csv and plain text.
Custom Parsers¶ ↑
If you'd like to do your own custom parsing, subclassing HTTParty::Parser will make that process much easier. There are a few different ways you can utilize HTTParty::Parser as a superclass.
@example Intercept the parsing for all formats
class SimpleParser < HTTParty::Parser def parse perform_parsing end end
@example Add the atom format and parsing method to the default parser
class AtomParsingIncluded < HTTParty::Parser SupportedFormats.merge!( {"application/atom+xml" => :atom} ) def atom perform_atom_parsing end end
@example Only support the atom format
class ParseOnlyAtom < HTTParty::Parser SupportedFormats = {"application/atom+xml" => :atom} def atom perform_atom_parsing end end
@abstract Read the Custom Parsers section for more information.
Constants
- SupportedFormats
Attributes
The response body of the request @return [String]
The intended parsing format for the request @return [Symbol] e.g. :json
Public Class Methods
Instantiate the parser and call {#parse}. @param [String] body the response body @param [Symbol] format the response format @return parsed response
# File lib/httparty/parser.rb, line 66 def self.call(body, format) new(body, format).parse end
@param [String] mimetype response MIME type @return [Symbol] @return [nil] mime type not supported
# File lib/httparty/parser.rb, line 78 def self.format_from_mimetype(mimetype) formats[formats.keys.detect {|k| mimetype.include?(k)}] end
@return [Hash] the SupportedFormats hash
# File lib/httparty/parser.rb, line 71 def self.formats const_get(:SupportedFormats) end
# File lib/httparty/parser.rb, line 93 def initialize(body, format) @body = body @format = format end
@return [Array<Symbol>] list of supported formats
# File lib/httparty/parser.rb, line 83 def self.supported_formats formats.values.uniq end
@param [Symbol] format e.g. :json, :xml @return [Boolean]
# File lib/httparty/parser.rb, line 89 def self.supports_format?(format) supported_formats.include?(format) end
Public Instance Methods
@return [Object] the parsed body @return [nil] when the response body is nil, an empty string, spaces only or “null”
# File lib/httparty/parser.rb, line 100 def parse return nil if body.nil? || body.strip.empty? || body == "null" if supports_format? parse_supported_format else body end end
Protected Instance Methods
# File lib/httparty/parser.rb, line 119 def csv CSV.parse(body) end
# File lib/httparty/parser.rb, line 123 def html body end
# File lib/httparty/parser.rb, line 115 def json JSON.load(body, nil) end
# File lib/httparty/parser.rb, line 135 def parse_supported_format send(format) rescue NoMethodError => e raise NotImplementedError, "#{self.class.name} has not implemented a parsing method for the #{format.inspect} format.", e.backtrace end
# File lib/httparty/parser.rb, line 127 def plain body end
# File lib/httparty/parser.rb, line 131 def supports_format? self.class.supports_format?(format) end
# File lib/httparty/parser.rb, line 111 def xml MultiXml.parse(body) end