class Restforce::Middleware::JsonRequest

Request middleware that encodes the body as JSON.

Processes only requests with matching Content-type or those without a type. If a request doesn’t have a type but has a body, it sets the Content-type to JSON MIME-type.

Doesn’t try to encode bodies that already are in string form. rubocop:disable Style/ClassAndModuleChildren

Constants

CONTENT_TYPE

This is the only line that differs substantively from the version in Faraday. In Faraday, this refers to a Faraday constant.

MIME_TYPE
MIME_TYPE_REGEX

Public Instance Methods

call(env) click to toggle source

Taken from ‘lib/faraday/middleware.rb` in the `faraday` gem (<github.com/lostisland/faraday/blob/08b7d4d/lib/faraday/middleware.rb>), with a tiny adaptation to refer to the `@app` instance variable rather than expecting an `attr_reader` to exist.

In Faraday versions before v1.2.0, ‘#call` is missing.

Copyright © 2009-2022 Rick Olson, Zack Hobson Licensed under the MIT License.

# File lib/restforce/middleware/json_request.rb, line 47
def call(env)
  on_request(env) if respond_to?(:on_request)
  @app.call(env).on_complete do |environment|
    on_complete(environment) if respond_to?(:on_complete)
  end
end
on_request(env) click to toggle source
# File lib/restforce/middleware/json_request.rb, line 54
def on_request(env)
  match_content_type(env) do |data|
    env[:body] = encode(data)
  end
end

Private Instance Methods

body?(env) click to toggle source
# File lib/restforce/middleware/json_request.rb, line 78
def body?(env)
  (body = env[:body]) && !(body.respond_to?(:to_str) && body.empty?)
end
encode(data) click to toggle source
# File lib/restforce/middleware/json_request.rb, line 62
def encode(data)
  ::JSON.generate(data)
end
match_content_type(env) { |env| ... } click to toggle source
# File lib/restforce/middleware/json_request.rb, line 66
def match_content_type(env)
  return unless process_request?(env)

  env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
  yield env[:body] unless env[:body].respond_to?(:to_str)
end
process_request?(env) click to toggle source
# File lib/restforce/middleware/json_request.rb, line 73
def process_request?(env)
  type = request_type(env)
  body?(env) && (type.empty? || type.match?(MIME_TYPE_REGEX))
end
request_type(env) click to toggle source
# File lib/restforce/middleware/json_request.rb, line 82
def request_type(env)
  type = env[:request_headers][CONTENT_TYPE].to_s
  type = type.split(';', 2).first if type.index(';')
  type
end