Module: WikidataAdaptor::TestHelpers::RestApi::Descriptions

Included in:
WikidataAdaptor::TestHelpers::RestApi
Defined in:
lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb

Overview

WebMock stubs for Wikibase REST API descriptions endpoints

Instance Method Summary collapse

Instance Method Details

#stub_delete_item_description(item_id, language_code, payload, response_body: "Description deleted") ⇒ Object

DELETE /v1/entities/items/:item_id/descriptions/:language_code



251
252
253
254
255
256
257
258
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 251

def stub_delete_item_description(item_id, language_code, payload, response_body: "Description deleted")
  stub_rest_api_request(
    :delete,
    "/v1/entities/items/#{item_id}/descriptions/#{language_code}",
    with: { body: payload.to_json },
    response_body: response_body
  )
end

#stub_delete_item_description_unexpected_error(item_id, language_code, payload) ⇒ WebMock::RequestStub

Stub DELETE item description request returning 500 error

Parameters:

  • item_id (String) —

    The item ID

  • language_code (String) —

    The language code

  • payload (Hash) —

    The request payload

Returns:

  • (WebMock::RequestStub) 


267
268
269
270
271
272
273
274
275
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 267

def stub_delete_item_description_unexpected_error(item_id, language_code, payload)
  stub_rest_api_request(
    :delete,
    "/v1/entities/items/#{item_id}/descriptions/#{language_code}",
    response_status: 500,
    with: { body: payload.to_json },
    response_body: { code: "unexpected-error", message: "Unexpected Error" }
  )
end

#stub_delete_property_description(property_id, language_code, payload, response_body: "Description deleted") ⇒ Object

DELETE /v1/entities/properties/:property_id/descriptions/:language_code



280
281
282
283
284
285
286
287
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 280

def stub_delete_property_description(property_id, language_code, payload, response_body: "Description deleted")
  stub_rest_api_request(
    :delete,
    "/v1/entities/properties/#{property_id}/descriptions/#{language_code}",
    with: { body: payload.to_json },
    response_body: response_body
  )
end

#stub_delete_property_description_unexpected_error(property_id, language_code, payload) ⇒ WebMock::RequestStub

Stub DELETE property description request returning 500 error

Parameters:

  • property_id (String) —

    The property ID

  • language_code (String) —

    The language code

  • payload (Hash) —

    The request payload

Returns:

  • (WebMock::RequestStub) 


296
297
298
299
300
301
302
303
304
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 296

def stub_delete_property_description_unexpected_error(property_id, language_code, payload)
  stub_rest_api_request(
    :delete,
    "/v1/entities/properties/#{property_id}/descriptions/#{language_code}",
    response_status: 500,
    with: { body: payload.to_json },
    response_body: { code: "unexpected-error", message: "Unexpected Error" }
  )
end

#stub_get_item_description(item_id, language_code) ⇒ Object

GET /v1/entities/items/:item_id/descriptions/:language_code



25
26
27
28
29
30
31
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 25

def stub_get_item_description(item_id, language_code)
  stub_rest_api_request(
    :get,
    "/v1/entities/items/#{item_id}/descriptions/#{language_code}",
    response_body: "English science fiction writer and humourist"
  )
end

#stub_get_item_description_with_language_fallback(item_id, language_code) ⇒ Object

GET /v1/entities/items/:item_id/descriptions_with_language_fallback/:language_code



36
37
38
39
40
41
42
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 36

def stub_get_item_description_with_language_fallback(item_id, language_code)
  stub_rest_api_request(
    :get,
    "/v1/entities/items/#{item_id}/descriptions_with_language_fallback/#{language_code}",
    response_body: "English science fiction writer and humourist"
  )
end

#stub_get_item_description_with_language_fallback_redirect(item_id, language_code, redirect_language_code: language_code, response_body: "English science fiction writer and humourist") ⇒ Object

GET /v1/entities/items/:item_id/descriptions_with_language_fallback/:language_code -> 307 Location: /v1/entities/items/:item_id/descriptions/:redirect_language_code



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 48

def stub_get_item_description_with_language_fallback_redirect(item_id, language_code,
                                                              redirect_language_code: language_code,
                                                              response_body: "English science fiction writer and humourist")
  stub_rest_api_request(
    :get,
    "/v1/entities/items/#{item_id}/descriptions_with_language_fallback/#{language_code}",
    response_status: 307,
    response_headers: {
      "Location" => "#{WIKIBASE_REST_ENDPOINT}/v1/entities/items/#{item_id}/descriptions/#{redirect_language_code}"
    },
    response_body: ""
  )

  stub_rest_api_request(
    :get,
    "/v1/entities/items/#{item_id}/descriptions/#{redirect_language_code}",
    response_body: response_body
  )
end

#stub_get_item_descriptions(item_id) ⇒ Object

GET /v1/entities/items/:item_id/descriptions



11
12
13
14
15
16
17
18
19
20
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 11

def stub_get_item_descriptions(item_id)
  stub_rest_api_request(
    :get,
    "/v1/entities/items/#{item_id}/descriptions",
    response_body: {
      en: "English science fiction writer and humourist",
      fr: "écrivain de science-fiction et humoriste anglais"
    }
  )
end

#stub_get_property_description(property_id, language_code) ⇒ Object

GET /v1/entities/properties/:property_id/descriptions/:language_code



85
86
87
88
89
90
91
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 85

def stub_get_property_description(property_id, language_code)
  stub_rest_api_request(
    :get,
    "/v1/entities/properties/#{property_id}/descriptions/#{language_code}",
    response_body: "that class of which this subject is a particular example and member"
  )
end

#stub_get_property_description_with_language_fallback(property_id, language_code) ⇒ Object

GET /v1/entities/properties/:property_id/descriptions_with_language_fallback/:language_code



96
97
98
99
100
101
102
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 96

def stub_get_property_description_with_language_fallback(property_id, language_code)
  stub_rest_api_request(
    :get,
    "/v1/entities/properties/#{property_id}/descriptions_with_language_fallback/#{language_code}",
    response_body: "that class of which this subject is a particular example and member"
  )
end

#stub_get_property_description_with_language_fallback_redirect(property_id, language_code, redirect_language_code: language_code, response_body: "that class of which this subject is a particular example and member") ⇒ Object

GET /v1/entities/properties/:property_id/descriptions_with_language_fallback/:language_code -> 307 Location: /v1/entities/properties/:property_id/descriptions/:redirect_language_code



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 108

def stub_get_property_description_with_language_fallback_redirect(property_id, language_code,
                                                                  redirect_language_code: language_code,
                                                                  response_body: "that class of which this subject is a particular example and member")
  stub_rest_api_request(
    :get,
    "/v1/entities/properties/#{property_id}/descriptions_with_language_fallback/#{language_code}",
    response_status: 307,
    response_headers: {
      "Location" => "#{WIKIBASE_REST_ENDPOINT}/v1/entities/properties/#{property_id}/descriptions/#{redirect_language_code}"
    },
    response_body: ""
  )

  stub_rest_api_request(
    :get,
    "/v1/entities/properties/#{property_id}/descriptions/#{redirect_language_code}",
    response_body: response_body
  )
end

#stub_get_property_descriptions(property_id) ⇒ Object

GET /v1/entities/properties/:property_id/descriptions



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 71

def stub_get_property_descriptions(property_id)
  stub_rest_api_request(
    :get,
    "/v1/entities/properties/#{property_id}/descriptions",
    response_body: {
      en: "that class of which this subject is a particular example and member",
      fr: "classe dont ce sujet est un exemple particulier"
    }
  )
end

#stub_patch_item_descriptions(item_id, payload, response_body: nil) ⇒ Object

PATCH /v1/entities/items/:item_id/descriptions



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 189

def stub_patch_item_descriptions(item_id, payload, response_body: nil)
  stub_rest_api_request(
    :patch,
    "/v1/entities/items/#{item_id}/descriptions",
    with: { body: payload.to_json },
    response_body: response_body || {
      en: "British author",
      fr: "écrivain de science-fiction et humoriste anglais"
    }
  )
end

#stub_patch_item_descriptions_unexpected_error(item_id, payload) ⇒ WebMock::RequestStub

Stub PATCH item descriptions request returning 500 error

Parameters:

  • item_id (String) —

    The item ID

  • payload (Hash) —

    The request payload

Returns:

  • (WebMock::RequestStub) 


207
208
209
210
211
212
213
214
215
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 207

def stub_patch_item_descriptions_unexpected_error(item_id, payload)
  stub_rest_api_request(
    :patch,
    "/v1/entities/items/#{item_id}/descriptions",
    response_status: 500,
    with: { body: payload.to_json },
    response_body: { code: "unexpected-error", message: "Unexpected Error" }
  )
end

#stub_patch_property_descriptions(property_id, payload, response_body: nil) ⇒ Object

PATCH /v1/entities/properties/:property_id/descriptions



220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 220

def stub_patch_property_descriptions(property_id, payload, response_body: nil)
  stub_rest_api_request(
    :patch,
    "/v1/entities/properties/#{property_id}/descriptions",
    with: { body: payload.to_json },
    response_body: response_body || {
      en: "class membership",
      fr: "classe dont ce sujet est un exemple particulier"
    }
  )
end

#stub_patch_property_descriptions_unexpected_error(property_id, payload) ⇒ WebMock::RequestStub

Stub PATCH property descriptions request returning 500 error

Parameters:

  • property_id (String) —

    The property ID

  • payload (Hash) —

    The request payload

Returns:

  • (WebMock::RequestStub) 


238
239
240
241
242
243
244
245
246
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 238

def stub_patch_property_descriptions_unexpected_error(property_id, payload)
  stub_rest_api_request(
    :patch,
    "/v1/entities/properties/#{property_id}/descriptions",
    response_status: 500,
    with: { body: payload.to_json },
    response_body: { code: "unexpected-error", message: "Unexpected Error" }
  )
end

#stub_put_item_description(item_id, language_code, payload, response_body: nil) ⇒ Object

PUT /v1/entities/items/:item_id/descriptions/:language_code



131
132
133
134
135
136
137
138
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 131

def stub_put_item_description(item_id, language_code, payload, response_body: nil)
  stub_rest_api_request(
    :put,
    "/v1/entities/items/#{item_id}/descriptions/#{language_code}",
    with: { body: payload.to_json },
    response_body: response_body || payload["description"]
  )
end

#stub_put_item_description_unexpected_error(item_id, language_code, payload) ⇒ WebMock::RequestStub

Stub PUT item description request returning 500 error

Parameters:

  • item_id (String) —

    The item ID

  • language_code (String) —

    The language code

  • payload (Hash) —

    The request payload

Returns:

  • (WebMock::RequestStub) 


147
148
149
150
151
152
153
154
155
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 147

def stub_put_item_description_unexpected_error(item_id, language_code, payload)
  stub_rest_api_request(
    :put,
    "/v1/entities/items/#{item_id}/descriptions/#{language_code}",
    response_status: 500,
    with: { body: payload.to_json },
    response_body: { code: "unexpected-error", message: "Unexpected Error" }
  )
end

#stub_put_property_description(property_id, language_code, payload, response_body: nil) ⇒ Object

PUT /v1/entities/properties/:property_id/descriptions/:language_code



160
161
162
163
164
165
166
167
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 160

def stub_put_property_description(property_id, language_code, payload, response_body: nil)
  stub_rest_api_request(
    :put,
    "/v1/entities/properties/#{property_id}/descriptions/#{language_code}",
    with: { body: payload.to_json },
    response_body: response_body || payload["description"]
  )
end

#stub_put_property_description_unexpected_error(property_id, language_code, payload) ⇒ WebMock::RequestStub

Stub PUT property description request returning 500 error

Parameters:

  • property_id (String) —

    The property ID

  • language_code (String) —

    The language code

  • payload (Hash) —

    The request payload

Returns:

  • (WebMock::RequestStub) 


176
177
178
179
180
181
182
183
184
 
# File 'lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb', line 176

def stub_put_property_description_unexpected_error(property_id, language_code, payload)
  stub_rest_api_request(
    :put,
    "/v1/entities/properties/#{property_id}/descriptions/#{language_code}",
    response_status: 500,
    with: { body: payload.to_json },
    response_body: { code: "unexpected-error", message: "Unexpected Error" }
  )
end