wikidata_adaptor 1.0.0

data/lib/wikidata_adaptor/test_helpers/rest_api/descriptions.rb

@@ -0,0 +1,308 @@
+# frozen_string_literal: true
+
+module WikidataAdaptor
+  module TestHelpers
+    module RestApi
+      # WebMock stubs for Wikibase REST API descriptions endpoints
+      module Descriptions
+        ###########################################
+        # GET /v1/entities/items/:item_id/descriptions
+        ###########################################
+        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
+
+        ##########################################################
+        # GET /v1/entities/items/:item_id/descriptions/:language_code
+        ##########################################################
+        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
+
+        ###############################################################################
+        # GET /v1/entities/items/:item_id/descriptions_with_language_fallback/:language_code
+        ###############################################################################
+        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
+
+        ###############################################################################
+        # GET /v1/entities/items/:item_id/descriptions_with_language_fallback/:language_code
+        # -> 307 Location: /v1/entities/items/:item_id/descriptions/:redirect_language_code
+        ###############################################################################
+        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
+
+        ##############################################
+        # GET /v1/entities/properties/:property_id/descriptions
+        ##############################################
+        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
+
+        ################################################################
+        # GET /v1/entities/properties/:property_id/descriptions/:language_code
+        ################################################################
+        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
+
+        #######################################################################################
+        # GET /v1/entities/properties/:property_id/descriptions_with_language_fallback/:language_code
+        #######################################################################################
+        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
+
+        #######################################################################################
+        # GET /v1/entities/properties/:property_id/descriptions_with_language_fallback/:language_code
+        # -> 307 Location: /v1/entities/properties/:property_id/descriptions/:redirect_language_code
+        #######################################################################################
+        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
+
+        ################################################################
+        # PUT /v1/entities/items/:item_id/descriptions/:language_code
+        ################################################################
+        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 request returning 500 error
+        #
+        # @param item_id [String] The item ID
+        # @param language_code [String] The language code
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        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
+
+        ######################################################################
+        # PUT /v1/entities/properties/:property_id/descriptions/:language_code
+        ######################################################################
+        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 request returning 500 error
+        #
+        # @param property_id [String] The property ID
+        # @param language_code [String] The language code
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        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
+
+        ################################################
+        # PATCH /v1/entities/items/:item_id/descriptions
+        ################################################
+        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 request returning 500 error
+        #
+        # @param item_id [String] The item ID
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        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
+
+        ######################################################
+        # PATCH /v1/entities/properties/:property_id/descriptions
+        ######################################################
+        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 request returning 500 error
+        #
+        # @param property_id [String] The property ID
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        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
+
+        #####################################################################
+        # DELETE /v1/entities/items/:item_id/descriptions/:language_code
+        #####################################################################
+        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 request returning 500 error
+        #
+        # @param item_id [String] The item ID
+        # @param language_code [String] The language code
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        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
+
+        ###########################################################################
+        # DELETE /v1/entities/properties/:property_id/descriptions/:language_code
+        ###########################################################################
+        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 request returning 500 error
+        #
+        # @param property_id [String] The property ID
+        # @param language_code [String] The language code
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        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
+      end
+    end
+  end
+end

data/lib/wikidata_adaptor/test_helpers/rest_api/items.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require_relative "support/support"
+module WikidataAdaptor
+  module TestHelpers
+    module RestApi
+      # WebMock stubs for Wikibase REST API items endpoints
+      module Items
+        include WikidataAdaptor::TestHelpers::RestApi::Support
+
+        ###############################
+        # GET /v1/entities/items/:item_id
+        ###############################
+        def stub_get_item(item_id, response_body = nil)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}",
+            response_body: response_body || load_path_example(
+              "/v1/entities/items/{item_id}", "get"
+            )
+          )
+        end
+
+        # Stub GET item request returning 400 invalid item error
+        #
+        # @param item_id [String] The item ID
+        #
+        # @return [WebMock::RequestStub]
+        def stub_get_item_invalid_item(item_id)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}",
+            response_status: 400,
+            response_body: {
+              code: "invalid-item-id",
+              message: "Not a valid item ID: {#{item_id}}"
+            }
+          )
+        end
+
+        # Stub GET item request returning 404 not found error
+        #
+        # @param item_id [String] The item ID
+        #
+        # @return [WebMock::RequestStub]
+        def stub_get_item_not_found(item_id)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}",
+            response_status: 404,
+            response_body: {
+              code: "item-not-found",
+              message: "Could not find an item with the ID: {#{item_id}}"
+            }
+          )
+        end
+
+        # Stub GET item request returning 500 error
+        #
+        # @param item_id [String] The item ID
+        #
+        # @return [WebMock::RequestStub]
+        def stub_get_item_unexpected_error(item_id)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}",
+            response_status: 500,
+            response_body: {
+              code: "unexpected-error",
+              message: "Unexpected Error"
+            }
+          )
+        end
+
+        ###############################
+        # POST /v1/entities/items
+        ###############################
+        def stub_post_item(payload, response_body = nil)
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/items",
+            response_status: 201,
+            with: { body: payload.to_json },
+            response_body: response_body || posted_item_response_fixture.to_json
+          )
+        end
+
+        # Stub POST item request returning 400 invalid item error
+        #
+        # @param response_body [Hash, nil] Optional response body
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_item_invalid_item(response_body = nil)
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/items",
+            response_status: 400,
+            response_body: response_body || {
+              code: "invalid-item-data",
+              message: "The provided item data is invalid."
+            }
+          )
+        end
+
+        # Stub POST item request returning 403 access denied error
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_item_access_denied
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/items",
+            response_status: 403,
+            response_body: {
+              code: "permission-denied",
+              message: "Access to resource is denied",
+              context: {
+                denial_reason: "{reason_code}",
+                denial_context: "{additional_context}"
+              }
+            }
+          )
+        end
+
+        # Stub POST item request returning 422 data policy violation error
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_item_data_policy_violation
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/items",
+            response_status: 422,
+            response_body: {
+              code: "data-policy-violation",
+              message: "Edit violates data policy",
+              context: {
+                violation: "{violation_code}",
+                violation_context: {
+                  some: "context"
+                }
+              }
+            }
+          )
+        end
+
+        # Stub POST item request returning 429 request limit reached error
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_item_request_limit_reached
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/items",
+            response_status: 429,
+            response_body: {
+              code: "request-limit-reached",
+              message: "Exceeded the limit of actions that can be performed in a given span of time",
+              context: {
+                reason: "{reason_code}"
+              }
+            }
+          )
+        end
+
+        # Stub POST item request returning 500 error
+        #
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_item_unexpected_error(payload)
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/items",
+            response_status: 500,
+            with: { body: payload.to_json },
+            response_body: {
+              code: "unexpected-error",
+              message: "Unexpected Error"
+            }
+          )
+        end
+
+        ################################
+        # PATCH /v1/entities/items/:item_id
+        ################################
+        def stub_patch_item(item_id, payload, response_body: nil)
+          stub_rest_api_request(
+            :patch,
+            "/v1/entities/items/#{item_id}",
+            with: { body: payload.to_json },
+            response_body: response_body || load_path_example(
+              "/v1/entities/items/{item_id}", "get"
+            )
+          )
+        end
+
+        # Stub PATCH item request returning 500 error
+        #
+        # @param item_id [String] The item ID
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        def stub_patch_item_unexpected_error(item_id, payload)
+          stub_rest_api_request(
+            :patch,
+            "/v1/entities/items/#{item_id}",
+            response_status: 500,
+            with: { body: payload.to_json },
+            response_body: { code: "unexpected-error", message: "Unexpected Error" }
+          )
+        end
+      end
+    end
+  end
+end