wikidata_adaptor 1.0.0

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

@@ -0,0 +1,302 @@
+# frozen_string_literal: true
+
+module WikidataAdaptor
+  module TestHelpers
+    module RestApi
+      # WebMock stubs for Wikibase REST API labels endpoints
+      module Labels
+        #####################################
+        # GET /v1/entities/items/:item_id/labels
+        #####################################
+        def stub_get_item_labels(item_id)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}/labels",
+            response_body: {
+              en: "Douglas Adams",
+              fr: "Douglas Adams"
+            }
+          )
+        end
+
+        ####################################################
+        # GET /v1/entities/items/:item_id/labels/:language_code
+        ####################################################
+        def stub_get_item_label(item_id, language_code)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}/labels/#{language_code}",
+            response_body: "Douglas Adams"
+          )
+        end
+
+        #########################################################################
+        # GET /v1/entities/items/:item_id/labels_with_language_fallback/:language_code
+        #########################################################################
+        def stub_get_item_label_with_language_fallback(item_id, language_code)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}/labels_with_language_fallback/#{language_code}",
+            response_body: "Douglas Adams"
+          )
+        end
+
+        #########################################################################
+        # GET /v1/entities/items/:item_id/labels_with_language_fallback/:language_code
+        # -> 307 Location: /v1/entities/items/:item_id/labels/:redirect_language_code
+        #########################################################################
+        def stub_get_item_label_with_language_fallback_redirect(item_id, language_code,
+                                                                redirect_language_code: language_code,
+                                                                response_body: "Douglas Adams")
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}/labels_with_language_fallback/#{language_code}",
+            response_status: 307,
+            response_headers: {
+              "Location" => "#{WIKIBASE_REST_ENDPOINT}/v1/entities/items/#{item_id}/labels/#{redirect_language_code}"
+            },
+            response_body: ""
+          )
+
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/items/#{item_id}/labels/#{redirect_language_code}",
+            response_body: response_body
+          )
+        end
+
+        ###########################################
+        # GET /v1/entities/properties/:property_id/labels
+        ###########################################
+        def stub_get_property_labels(property_id)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}/labels",
+            response_body: {
+              en: "instance of",
+              fr: "est un(e)"
+            }
+          )
+        end
+
+        ########################################################
+        # GET /v1/entities/properties/:property_id/labels/:language_code
+        ########################################################
+        def stub_get_property_label(property_id, language_code)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}/labels/#{language_code}",
+            response_body: "instance of"
+          )
+        end
+
+        #################################################################################
+        # GET /v1/entities/properties/:property_id/labels_with_language_fallback/:language_code
+        #################################################################################
+        def stub_get_property_label_with_language_fallback(property_id, language_code)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}/labels_with_language_fallback/#{language_code}",
+            response_body: "instance of"
+          )
+        end
+
+        #################################################################################
+        # GET /v1/entities/properties/:property_id/labels_with_language_fallback/:language_code
+        # -> 307 Location: /v1/entities/properties/:property_id/labels/:redirect_language_code
+        #################################################################################
+        def stub_get_property_label_with_language_fallback_redirect(property_id, language_code,
+                                                                    redirect_language_code: language_code,
+                                                                    response_body: "instance of")
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}/labels_with_language_fallback/#{language_code}",
+            response_status: 307,
+            response_headers: {
+              "Location" => "#{WIKIBASE_REST_ENDPOINT}/v1/entities/properties/#{property_id}/labels/#{redirect_language_code}"
+            },
+            response_body: ""
+          )
+
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}/labels/#{redirect_language_code}",
+            response_body: response_body
+          )
+        end
+
+        ##########################################################
+        # PUT /v1/entities/items/:item_id/labels/:language_code
+        ##########################################################
+        def stub_put_item_label(item_id, language_code, payload, response_body: nil)
+          stub_rest_api_request(
+            :put,
+            "/v1/entities/items/#{item_id}/labels/#{language_code}",
+            with: { body: payload.to_json },
+            response_body: response_body || payload["label"]
+          )
+        end
+
+        # Stub PUT item label 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_label_unexpected_error(item_id, language_code, payload)
+          stub_rest_api_request(
+            :put,
+            "/v1/entities/items/#{item_id}/labels/#{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/labels/:language_code
+        ################################################################
+        def stub_put_property_label(property_id, language_code, payload, response_body: nil)
+          stub_rest_api_request(
+            :put,
+            "/v1/entities/properties/#{property_id}/labels/#{language_code}",
+            with: { body: payload.to_json },
+            response_body: response_body || payload["label"]
+          )
+        end
+
+        # Stub PUT property label 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_label_unexpected_error(property_id, language_code, payload)
+          stub_rest_api_request(
+            :put,
+            "/v1/entities/properties/#{property_id}/labels/#{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/labels
+        ##########################################
+        def stub_patch_item_labels(item_id, payload, response_body: nil)
+          stub_rest_api_request(
+            :patch,
+            "/v1/entities/items/#{item_id}/labels",
+            with: { body: payload.to_json },
+            response_body: response_body || { en: "Douglas Noel Adams", fr: "Douglas Adams" }
+          )
+        end
+
+        # Stub PATCH item labels request returning 500 error
+        #
+        # @param item_id [String] The item ID
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        def stub_patch_item_labels_unexpected_error(item_id, payload)
+          stub_rest_api_request(
+            :patch,
+            "/v1/entities/items/#{item_id}/labels",
+            response_status: 500,
+            with: { body: payload.to_json },
+            response_body: { code: "unexpected-error", message: "Unexpected Error" }
+          )
+        end
+
+        ################################################
+        # PATCH /v1/entities/properties/:property_id/labels
+        ################################################
+        def stub_patch_property_labels(property_id, payload, response_body: nil)
+          stub_rest_api_request(
+            :patch,
+            "/v1/entities/properties/#{property_id}/labels",
+            with: { body: payload.to_json },
+            response_body: response_body || { en: "is instance of", fr: "est un(e)" }
+          )
+        end
+
+        # Stub PATCH property labels request returning 500 error
+        #
+        # @param property_id [String] The property ID
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        def stub_patch_property_labels_unexpected_error(property_id, payload)
+          stub_rest_api_request(
+            :patch,
+            "/v1/entities/properties/#{property_id}/labels",
+            response_status: 500,
+            with: { body: payload.to_json },
+            response_body: { code: "unexpected-error", message: "Unexpected Error" }
+          )
+        end
+
+        #############################################################
+        # DELETE /v1/entities/items/:item_id/labels/:language_code
+        #############################################################
+        def stub_delete_item_label(item_id, language_code, payload, response_body: "Label deleted")
+          stub_rest_api_request(
+            :delete,
+            "/v1/entities/items/#{item_id}/labels/#{language_code}",
+            with: { body: payload.to_json },
+            response_body: response_body
+          )
+        end
+
+        # Stub DELETE item label 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_label_unexpected_error(item_id, language_code, payload)
+          stub_rest_api_request(
+            :delete,
+            "/v1/entities/items/#{item_id}/labels/#{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/labels/:language_code
+        ###################################################################
+        def stub_delete_property_label(property_id, language_code, payload, response_body: "Label deleted")
+          stub_rest_api_request(
+            :delete,
+            "/v1/entities/properties/#{property_id}/labels/#{language_code}",
+            with: { body: payload.to_json },
+            response_body: response_body
+          )
+        end
+
+        # Stub DELETE property label 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_label_unexpected_error(property_id, language_code, payload)
+          stub_rest_api_request(
+            :delete,
+            "/v1/entities/properties/#{property_id}/labels/#{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/open_api_document.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module WikidataAdaptor
+  module TestHelpers
+    module RestApi
+      # https://doc.wikimedia.org/Wikibase/master/js/rest-api/#/OpenAPI%20document/getOpenApiDoc
+      module OpenApiDocument
+        ##################################
+        # GET /v1/openapi.json
+        ##################################
+        def stub_get_openapi_document(response_body = nil)
+          stub_rest_api_request(
+            :get,
+            "/v1/openapi.json",
+            response_body: response_body || {
+              openapi: "3.0.0",
+              info: {
+                title: "Wikibase REST API",
+                version: "...",
+                description: "OpenAPI definition of Wikibase REST API"
+              },
+              paths: {}
+            }
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+require_relative "support/support"
+module WikidataAdaptor
+  module TestHelpers
+    module RestApi
+      # WebMock stubs for Wikibase REST API properties endpoints
+      module Properties
+        include WikidataAdaptor::TestHelpers::RestApi::Support
+
+        ###############################
+        # GET /v1/entities/properties/:property_id
+        ###############################
+        def stub_get_property(property_id, response_body = nil)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}",
+            response_body: response_body || {
+              id: property_id.to_s,
+              type: "property",
+              labels: {
+                en: "instance of",
+                fr: "est un(e)"
+              },
+              descriptions: {
+                en: "that class of which this subject is a particular example and member",
+                fr: "classe dont ce sujet est un exemple particulier"
+              },
+              aliases: {
+                en: ["is a"],
+                fr: ["est un"]
+              },
+              statements: {}
+            }
+          )
+        end
+
+        # Stub GET property request returning 400 invalid property error
+        #
+        # @param property_id [String] The property ID
+        #
+        # @return [WebMock::RequestStub]
+        def stub_get_property_invalid_property(property_id)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}",
+            response_status: 400,
+            response_body: {
+              code: "invalid-property-id",
+              message: "Not a valid property ID: {#{property_id}}"
+            }
+          )
+        end
+
+        # Stub GET property request returning 404 not found error
+        #
+        # @param property_id [String] The property ID
+        #
+        # @return [WebMock::RequestStub]
+        def stub_get_property_not_found(property_id)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}",
+            response_status: 404,
+            response_body: {
+              code: "property-not-found",
+              message: "Could not find a property with the ID: {#{property_id}}"
+            }
+          )
+        end
+
+        # Stub GET property request returning 500 error
+        #
+        # @param property_id [String] The property ID
+        #
+        # @return [WebMock::RequestStub]
+        def stub_get_property_unexpected_error(property_id)
+          stub_rest_api_request(
+            :get,
+            "/v1/entities/properties/#{property_id}",
+            response_status: 500,
+            response_body: {
+              code: "unexpected-error",
+              message: "Unexpected Error"
+            }
+          )
+        end
+
+        ###############################
+        # POST /v1/entities/properties
+        ###############################
+        def stub_post_property(payload, response_body = nil)
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/properties",
+            response_status: 201,
+            with: { body: payload.to_json },
+            response_body: response_body || posted_property_response_fixture.to_json
+          )
+        end
+
+        # Stub POST property request returning 400 invalid property error
+        #
+        # @param response_body [Hash, nil] Optional response body
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_property_invalid_property(response_body = nil)
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/properties",
+            response_status: 400,
+            response_body: response_body || {
+              code: "invalid-property-data",
+              message: "The provided property data is invalid."
+            }
+          )
+        end
+
+        # Stub POST property request returning 403 access denied error
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_property_access_denied
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/properties",
+            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 property request returning 422 data policy violation error
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_property_data_policy_violation
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/properties",
+            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 property request returning 429 request limit reached error
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_property_request_limit_reached
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/properties",
+            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 property request returning 500 error
+        #
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        def stub_post_property_unexpected_error(payload)
+          stub_rest_api_request(
+            :post,
+            "/v1/entities/properties",
+            response_status: 500,
+            with: { body: payload.to_json },
+            response_body: {
+              code: "unexpected-error",
+              message: "Unexpected Error"
+            }
+          )
+        end
+
+        ##########################################
+        # PATCH /v1/entities/properties/:property_id
+        ##########################################
+        def stub_patch_property(property_id, payload, response_body: nil)
+          stub_rest_api_request(
+            :patch,
+            "/v1/entities/properties/#{property_id}",
+            with: { body: payload.to_json },
+            response_body: response_body || {
+              id: property_id.to_s,
+              type: "property",
+              data_type: "string",
+              labels: { en: "is instance of" },
+              descriptions: { en: "that class of which this subject is a particular example and member" },
+              aliases: { en: ["is a"] },
+              statements: {}
+            }
+          )
+        end
+
+        # Stub PATCH property request returning 500 error
+        #
+        # @param property_id [String] The property ID
+        # @param payload [Hash] The request payload
+        #
+        # @return [WebMock::RequestStub]
+        def stub_patch_property_unexpected_error(property_id, payload)
+          stub_rest_api_request(
+            :patch,
+            "/v1/entities/properties/#{property_id}",
+            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/property_data_types.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module WikidataAdaptor
+  module TestHelpers
+    module RestApi
+      # https://doc.wikimedia.org/Wikibase/master/js/rest-api/#/Property%20data%20types/getPropertyDataTypes
+      module PropertyDataTypes
+        ##########################################
+        # GET /v1/property-data-types
+        ##########################################
+        def stub_get_property_data_types
+          stub_rest_api_request(
+            :get,
+            "/v1/property-data-types",
+            response_body: {
+              "data-type" => "value-type"
+            }
+          )
+        end
+      end
+    end
+  end
+end