Class: W3cApi::Hal

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/w3c_api/hal.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Hal

Returns a new instance of Hal.



8
9
10
 
# File 'lib/w3c_api/hal.rb', line 8

def initialize
  setup
end

Instance Method Details

#client ⇒ Object 



12
13
14
 
# File 'lib/w3c_api/hal.rb', line 12

def client
  @client ||= Lutaml::Hal::Client.new(api_url: 'https://api.w3.org/')
end

#register ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lib/w3c_api/hal.rb', line 16

def register
  return @register if @register

  @register = Lutaml::Hal::ModelRegister.new(name: :w3c_api, client: client)
  Lutaml::Hal::GlobalRegister.instance.register(:w3c_api, @register)
  @register
end

#setup ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/w3c_api/hal.rb', line 24

def setup
  register.add_endpoint(id: :affiliation_index, type: :index, url: '/affiliations', model: Models::AffiliationIndex)
  register.add_endpoint(id: :affiliation_resource, type: :resource, url: '/affiliations/{id}',
                        model: Models::Affiliation)
  register.add_endpoint(id: :affiliation_participants_index, type: :index, url: '/affiliations/{id}/participants',
                        model: Models::ParticipantIndex)
  register.add_endpoint(id: :affiliation_participations_index, type: :index, url: '/affiliations/{id}/participations',
                        model: Models::ParticipationIndex)

  # register.add_endpoint(id: :charter_resource, type: :resource, url: '/charters/{id}', model: Models::Charter)

  register.add_endpoint(id: :ecosystem_index, type: :index, url: '/ecosystems', model: Models::EcosystemIndex)
  register.add_endpoint(id: :ecosystem_resource, type: :resource, url: '/ecosystems/{id}', model: Models::Ecosystem)
  register.add_endpoint(id: :ecosystem_evangelists_index, type: :index, url: '/ecosystems/{shortname}/evangelists',
                        model: Models::EvangelistIndex)
  register.add_endpoint(id: :ecosystem_groups_index, type: :index, url: '/ecosystems/{shortname}/groups',
                        model: Models::GroupIndex)
  register.add_endpoint(id: :ecosystem_member_organizations_index, type: :index, url: '/ecosystems/{shortname}/member-organizations',
                        model: Models::AffiliationIndex)

  register.add_endpoint(id: :group_index, type: :index, url: '/groups', model: Models::GroupIndex)
  register.add_endpoint(id: :group_resource, type: :resource, url: '/groups/{id}', model: Models::Group)
  register.add_endpoint(id: :group_specifications_index, type: :index, url: '/groups/{id}/specifications',
                        model: Models::SpecificationIndex)
  register.add_endpoint(id: :group_charters_index, type: :index, url: '/groups/{id}/charters',
                        model: Models::CharterIndex)
  register.add_endpoint(id: :group_users_index, type: :index, url: '/groups/{id}/users',
                        model: Models::UserIndex)
  register.add_endpoint(id: :group_chairs_index, type: :index, url: '/groups/{id}/chairs',
                        model: Models::ChairIndex)
  register.add_endpoint(id: :group_team_contacts_index, type: :index, url: '/groups/{id}/teamcontacts',
                        model: Models::TeamContactIndex)
  register.add_endpoint(id: :group_participations_index, type: :index, url: '/groups/{id}/participations',
                        model: Models::ParticipationIndex)

  # register.add_endpoint(id: :participation_index, type: :index, url: '/participations', model: Models::ParticipationIndex)
  register.add_endpoint(id: :participation_resource, type: :resource, url: '/participations/{id}',
                        model: Models::Participation)
  register.add_endpoint(id: :participation_participants_index, type: :index, url: '/participations/{id}/participants',
                        model: Models::ParticipantIndex)

  register.add_endpoint(id: :serie_index, type: :index, url: '/specification-series', model: Models::SerieIndex)
  register.add_endpoint(id: :serie_resource, type: :resource, url: '/specification-series/{shortname}',
                        model: Models::Serie)

  register.add_endpoint(id: :serie_specification_resource, type: :index,
                        url: '/specification-series/{shortname}/specifications', model: Models::SpecificationIndex)

  register.add_endpoint(id: :specification_index, type: :index, url: '/specifications',
                        model: Models::SpecificationIndex)
  register.add_endpoint(id: :specification_resource, type: :resource, url: '/specifications/{shortname}',
                        model: Models::Specification)
  register.add_endpoint(id: :specification_resource_version_index, type: :index, url: '/specifications/{shortname}/versions',
                        model: Models::SpecVersionIndex)

  register.add_endpoint(
    id: :specification_resource_version_resource,
    type: :resource,
    url: '/specifications/{shortname}/versions/{version}',
    model: Models::SpecVersion
  )
  register.add_endpoint(
    id: :specification_version_predecessors_index,
    type: :index,
    url: '/specifications/{shortname}/versions/{version}/predecessors',
    model: Models::SpecVersionIndex
  )
  register.add_endpoint(
    id: :specification_version_successors_index,
    type: :index,
    url: '/specifications/{shortname}/versions/{version}/successors',
    model: Models::SpecVersionIndex
  )
  register.add_endpoint(
    id: :specification_by_status_index,
    type: :index,
    url: '/specifications-by-status/{status}',
    model: Models::SpecificationIndex
  )
  register.add_endpoint(
    id: :specification_supersedes_index,
    type: :index,
    url: '/specifications/{shortname}/supersedes',
    model: Models::SpecificationIndex
  )
  register.add_endpoint(
    id: :specification_superseded_by_index,
    type: :index,
    url: '/specifications/{shortname}/superseded',
    model: Models::SpecificationIndex
  )
  register.add_endpoint(
    id: :specification_version_editors_index,
    type: :index,
    url: '/specifications/{shortname}/version/{version}/editors',
    model: Models::UserIndex
  )
  register.add_endpoint(
    id: :specification_version_deliverers_index,
    type: :index,
    url: '/specifications/{shortname}/version/{version}/deliverers',
    model: Models::UserIndex
  )

  # TODO: Why is this endpoint needed? There already is /specifications/{shortname}...
  # register.add_endpoint(
  #   id: :specification_by_shortname_index,
  #   type: :index,
  #   url: '/specifications-by-shortname/{shortname}',
  #   model: Models::SpecificationIndex
  # )

  register.add_endpoint(id: :translation_index, type: :index, url: '/translations', model: Models::TranslationIndex)
  register.add_endpoint(id: :translation_resource, type: :resource, url: '/translations/{id}',
                        model: Models::Translation)

  # NOTE: This endpoint doesn't exist, just here for reference.
  # register.add_endpoint(id: :user_index, type: :index, url: '/users', model: Models::UserIndex)

  register.add_endpoint(id: :user_groups_index, type: :index, url: '/users/{hash}/groups',
                        model: Models::GroupIndex)

  register.add_endpoint(id: :user_resource, type: :resource, url: '/users/{hash}', model: Models::User)

  register.add_endpoint(id: :user_affiliations_index, type: :index, url: '/users/{hash}/affiliations',
                        model: Models::AffiliationIndex)

  register.add_endpoint(id: :user_participations_index, type: :index, url: '/users/{hash}/participations',
                        model: Models::ParticipationIndex)

  register.add_endpoint(id: :user_chair_of_groups_index, type: :index, url: '/users/{hash}/chair-of-groups',
                        model: Models::GroupIndex)

  register.add_endpoint(id: :user_team_contact_of_groups_index, type: :index, url: '/users/{hash}/team-contact-of-groups',
                        model: Models::GroupIndex)

  register.add_endpoint(id: :user_specifications_index, type: :index, url: '/users/{hash}/specifications',
                        model: Models::SpecificationIndex)
end