Class: Forms::Responses::Response

Inherits:

Common::Base

Object
Common::Base
Forms::Responses::Response

Defined in:: lib/forms/responses/response.rb

Overview

Model for Forms responses. Body is passed straight through from the service with a validation check that it matches the expected schema.

Instance Attribute Summary collapse

#body ⇒ Hash

Validated response body.
#status ⇒ Integer

The HTTP status code.

Attributes inherited from Common::Base

#errors_hash, #metadata

Instance Method Summary collapse

#initialize(status, body, schema_name) ⇒ Response constructor

A new instance of Response.

Methods inherited from Common::Base

#changed, #changed?, #changes, default_sort, filterable_attributes, max_per_page, per_page, sortable_attributes

Constructor Details

#initialize(status, body, schema_name) ⇒ `Response`

Returns a new instance of Response.

# File 'lib/forms/responses/response.rb', line 21

def initialize(status, body, schema_name)
  self.body = body if json_format_is_valid?(body, schema_name)
  self.status = status
end

Instance Attribute Details

#body ⇒ `Hash`

Returns Validated response body.

Returns:

(Hash) —

Validated response body.

# File 'lib/forms/responses/response.rb', line 17

class Response < Common::Base
  attribute :body, String
  attribute :status, Integer

  def initialize(status, body, schema_name)
    self.body = body if json_format_is_valid?(body, schema_name)
    self.status = status
  end

  private

  def json_format_is_valid?(body, schema_name)
    schema_path = Rails.root.join('lib', 'forms', 'schemas', "#{schema_name}.json").to_s
    JSON::Validator.validate!(schema_path, body, strict: false)
  end
end

#status ⇒ `Integer`

Returns The HTTP status code.