Class: Ecfr::VersionerService::Authority

Inherits:
Base
  • Object
show all
Defined in:
lib/ecfr/versioner_service/authority.rb

Overview

Authority entries represent individual references in the Parallel Table of Authorities.

Constant Summary collapse

AUTHORITIES_PATH = 
"v1/authorities"

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Base

base_url, service_name, service_path

Instance Attribute Details

#categories ⇒ String (readonly)

reference categories included in this response

Returns:

  • (String) 


27
28
 
# File 'lib/ecfr/versioner_service/authority.rb', line 27

metadata :categories,
desc: "reference categories included in this response"

#components ⇒ String (readonly)

authority citation components

Returns:

  • (String) 


13
14
 
# File 'lib/ecfr/versioner_service/authority.rb', line 13

attribute :components,
desc: "authority citation components"

#date ⇒ Date (readonly)

authority citation date

Returns:

  • (Date) 


16
17
18
 
# File 'lib/ecfr/versioner_service/authority.rb', line 16

attribute :date,
type: :date,
desc: "authority citation date"

#kind ⇒ String (readonly)

authority reference kind

Returns:

  • (String) 


10
11
 
# File 'lib/ecfr/versioner_service/authority.rb', line 10

attribute :kind,
desc: "authority reference kind"

#references ⇒ String (readonly)

CFR titles, parts, and hierarchies that cite this authority

Returns:

  • (String) 


20
21
 
# File 'lib/ecfr/versioner_service/authority.rb', line 20

attribute :references,
desc: "CFR titles, parts, and hierarchies that cite this authority"

Class Method Details

.all(options = {}) ⇒ Authority

Retrieves the Parallel Table of Authorities data.

Parameters:

  • options (<Hash>) (defaults to: {})

Options Hash (options):

  • :year (String) — default: "current" —

    the year or 'current' to retrieve authorities for

Returns:

  • (Authority) —

    grouped authority data and metadata



38
39
40
41
42
43
44
45
 
# File 'lib/ecfr/versioner_service/authority.rb', line 38

def self.all(options = {})
  year = options.fetch(:year, "current")

  perform(
    :get,
    "#{AUTHORITIES_PATH}/#{year}"
  )
end