Class: Ecfr::VersionerService::Reference

Inherits:
Base
  • Object
show all
Extended by:
ResponseHelper
Defined in:
lib/ecfr/versioner_service/reference.rb,
lib/ecfr/testing/extensions/versioner_service/reference_extensions.rb

Overview

References in the topics endpoint provide detailed information about CFR references mentioned in topics and agencies.

Each reference contains a CFR reference string and a description.

Instance Attribute Summary collapse

Class Method Summary collapse

Methods included from ResponseHelper

stubbed_response

Methods inherited from Base

base_url, service_name, service_path

Instance Attribute Details

#description ⇒ String (readonly)

description of the reference

Returns:

  • (String) 


15
16
 
# File 'lib/ecfr/versioner_service/reference.rb', line 15

attribute :description,
desc: "description of the reference"

#reference ⇒ String (readonly)

CFR reference ('1 CFR 1')

Returns:

  • (String) 


12
13
 
# File 'lib/ecfr/versioner_service/reference.rb', line 12

attribute :reference,
desc: "CFR reference ('1 CFR 1')"

Class Method Details

.response_for(references) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
 
# File 'lib/ecfr/testing/extensions/versioner_service/reference_extensions.rb', line 4

def self.response_for(references)
  references = references.is_a?(Array) ? references : [references]

  results = {
    references: references
  }.compact

  build(
    response: stubbed_response(results.to_json)
  )
end