wikidatum 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50ad5328f1593f1de47d492e6c4e761d80d3e43bb967bcf9386f72053881b705
-  data.tar.gz: eb17d97dfdbe7c45c2b10bc7d34aeeb76136b3473c72817f7a1b053f0e2d16eb
+  metadata.gz: d2ee435a3831b816e6e64465040a5197de654450551812b835b28329be9c287d
+  data.tar.gz: d23fb1902df5465b123fc0bcea0c7594fb64a6e918604a9f1bb1f4e4eadf6eff
 SHA512:
-  metadata.gz: f6cb6a7968e9f8943b6b6cd06311d74139a8580dde6e925a83cdf891292d5e6028a63b027394af2b04b31cadc78af88170f3a3fd3c92c2d4aeaca72560048402
-  data.tar.gz: d27a8240fec4fd41caa3ec21ce7bab706fed304bd364b076c741b7577bc04ce1fdd3df5db1675a5cbc431872ad1fe69f7f7b035a696b6212a38a97afec3bc2c6
+  metadata.gz: ccd8210a5120fbbfb35ed03899938bf4ca4e5302bc93e3e53652180b86b221a3ec23afe57db78777ffcda5971150f7c0ed6af89cde7b294fe21d716491653c49
+  data.tar.gz: cb4e092b80c6ab871c1dd7f5bd46f700029eab7438c7a4063a2aee42b389c0e86ec0e387fc15fa996037d2478f494ac46572879078930c41c18ae6b7e4073e00

data/CHANGELOG.md

@@ -6,8 +6,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
 
+## 0.3.1 - 2022-12-28
+### Added
+
+- Add an error message when attempting to make a bot edit without authentication, as this will always trigger a 403 error from the REST API.
+
+### Fixed
+
+- Fix the creation of WikibaseItem statements, the format used in the previous release was incorrect.
+
+## 0.3.0 - 2022-12-27
+### Added
+
+- Add `allow_ip_edits` argument on `Wikidatum::Client.new`. This protects users from making IP address-exposing edits if they haven't explicitly opted-in to doing that. The argument defaults to false.
+- Add code to raise errors when various types of invalid input are passed to `Wikidatum::Client#add_statement`.
+- Start testing the gem on Ruby 3.2.
+
+### Fixed
+
+- Update the serializers and `add_statement` method to account for various changes that have been made upstream to the Wikibase REST API.
+
 ## 0.2.1 - 2022-08-13
 ### Fixed
+
 - Fix a mistake that broke loading the gem.
 
 ## 0.2.0 - 2022-08-13
@@ -28,4 +49,3 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Added
 
 - Initial release, nothing is really usable yet.
-

data/README.md

@@ -2,7 +2,9 @@
 
 This gem supports making requests to the [new Wikidata/Wikibase REST API](https://doc.wikimedia.org/Wikibase/master/js/rest-api/).
 
-**The gem is currently in very early development and is not ready for production usage**.
+The [Wikimedia Docs on Wikibase's JSON format](https://doc.wikimedia.org/Wikibase/master/php/docs_topics_json.html) are also very useful for interacting with/contributing to this gem.
+
+**The gem is currently in early development and is not ready for production usage**.
 
 ## Installation
 
@@ -24,7 +26,7 @@ Or install it yourself as:
 
 You can view the YARD docs on GitHub Pages [here](https://connorshea.github.io/wikidatum/index.html).
 
-Currently, the gem is able to hit a few GET endpoints, and currently has no way to provide authentication and perform POST/PUT/DELETE requests. The additional features will be added later.
+Currently, the gem is able to hit a few of the basic endpoints, and currently has no way to provide authentication. The additional features will be added later.
 
 ```ruby
 require 'wikidatum'
@@ -57,6 +59,26 @@ item.label(lang: :en).value #=> "Earth"
 
 # Get the values for all English aliases on this item.
 item.aliases(langs: [:en]).map(&:value) #=> ["Planet Earth", "Pale Blue Dot"]
+
+statement_id = 'Q123$4543523c-1d1d-1111-1e1e-11b11111b1f1'
+statement = wikidatum_client.statement(id: statement_id) #=> Wikidatum::Statement
+
+# Add a statement to Q193581 for P577 (publication date) that has a time value of November 16, 2004.
+wikidatum_client.add_statement(
+  id: 'Q193581',
+  property: 'P577',
+  value: Wikidatum::DataType::Time.new(
+    time: '+2004-11-16T00:00:00Z',
+    precision: 11,
+    calendar_model: 'https://www.wikidata.org/entity/Q12138'
+  )
+)
+
+# Delete a statement and include an edit summary.
+wikidatum_client.delete_statement(
+  id: 'Q123$4543523c-1d1d-1111-1e1e-11b11111b1f1',
+  comment: 'Deleting this statement because it is inaccurate.'
+)
 ```
 
 ## Development

data/lib/wikidatum/client.rb

@@ -6,7 +6,19 @@ require 'faraday/net_http'
 module Wikidatum
   class Client
     ITEM_REGEX = /^Q?\d+$/.freeze
+    PROPERTY_REGEX = /^P?\d+$/.freeze
     STATEMENT_REGEX = /^Q?\d+\$[\w-]+$/.freeze
+    VALID_RANKS = ['preferred', 'normal', 'deprecated'].freeze
+    VALID_DATA_TYPES = [
+      'Wikidatum::DataType::GlobeCoordinate',
+      'Wikidatum::DataType::MonolingualText',
+      'Wikidatum::DataType::NoValue',
+      'Wikidatum::DataType::Quantity',
+      'Wikidatum::DataType::SomeValue',
+      'Wikidatum::DataType::Time',
+      'Wikidatum::DataType::WikibaseItem',
+      'Wikidatum::DataType::WikibaseString'
+    ].freeze
 
     # @return [String] the root URL of the Wikibase instance we want to interact
     #   with. If not provided, will default to Wikidata.
@@ -20,31 +32,41 @@ module Wikidatum
     #   Wikibase API.
     attr_reader :user_agent
 
+    # @return [Boolean] whether this client should allow non-GET requests if
+    #   authentication hasn't been provided. Defaults to false.
+    attr_reader :allow_ip_edits
+
     # Create a new Wikidatum::Client to interact with the Wikibase REST API.
     #
     # @example
     #  wikidatum_client = Wikidatum::Client.new(
-    #    user_agent: 'REPLACE ME WITH THE NAME OF YOUR BOT!',
+    #    user_agent: 'Bot Name',
     #    wikibase_url: 'https://www.wikidata.org',
     #    bot: true
     #  )
     #
     # @param user_agent [String] The UserAgent header to send with all requests
-    #   to the Wikibase API.
+    #   to the Wikibase API. This will be prepended with the string "Wikidatum
+    #   Ruby gem vX.X.X:".
     # @param wikibase_url [String] The root URL of the Wikibase instance we want
     #   to interact with. If not provided, will default to
     #   `https://www.wikidata.org`. Do not include a `/` at the end of the URL.
     # @param bot [Boolean] Whether requests sent by this client instance should
     #   be registered as bot requests. Defaults to `true`.
+    # @param allow_ip_edits [Boolean] whether this client should allow non-GET
+    #   requests if authentication hasn't been provided. Defaults to false. If
+    #   this is set to true, the IP address of the device from which the
+    #   request was sent will be credited for the edit. Make sure not to allow
+    #   these edits if you don't want your IP address (and in many cases, a
+    #   very close approximation of your physical location) exposed publicly.
     # @return [Wikidatum::Client]
-    def initialize(user_agent:, wikibase_url: 'https://www.wikidata.org', bot: true)
+    def initialize(user_agent:, wikibase_url: 'https://www.wikidata.org', bot: true, allow_ip_edits: false)
       raise ArgumentError, "Wikibase URL must not end with a `/`, got #{wikibase_url.inspect}." if wikibase_url.end_with?('/')
 
-      # TODO: Add the Ruby gem version to the UserAgent automatically, and
-      # restrict the ability for end-users to actually set the UserAgent?
-      @user_agent = user_agent
+      @user_agent = "Wikidatum Ruby gem v#{Wikidatum::VERSION}: #{user_agent}"
       @wikibase_url = wikibase_url
       @bot = bot
+      @allow_ip_edits = allow_ip_edits
 
       Faraday.default_adapter = :net_http
     end
@@ -97,7 +119,7 @@ module Wikidatum
     #   wikidatum_client.add_statement(
     #     id: 'Q123',
     #     property: 'P23',
-    #     datavalue: Wikidatum::DataValueType::WikibaseString.new(string: 'Foo'),
+    #     value: Wikidatum::DataType::WikibaseString.new(string: 'Foo'),
     #     comment: 'Adding something or another.'
     #   )
     #
@@ -105,7 +127,7 @@ module Wikidatum
     #   wikidatum_client.add_statement(
     #     id: 'Q123',
     #     property: 'P124',
-    #     datavalue: Wikidatum::DataValueType::NoValue.new(
+    #     value: Wikidatum::DataType::NoValue.new(
     #       type: :no_value,
     #       value: nil
     #     )
@@ -115,7 +137,7 @@ module Wikidatum
     #   wikidatum_client.add_statement(
     #     id: 'Q123',
     #     property: 'P124',
-    #     datavalue: Wikidatum::DataValueType::SomeValue.new(
+    #     value: Wikidatum::DataType::SomeValue.new(
     #       type: :some_value,
     #       value: nil
     #     )
@@ -125,7 +147,7 @@ module Wikidatum
     #   wikidatum_client.add_statement(
     #     id: 'Q123',
     #     property: 'P124',
-    #     datavalue: Wikidatum::DataValueType::GlobeCoordinate.new(
+    #     value: Wikidatum::DataType::GlobeCoordinate.new(
     #       latitude: 52.51666,
     #       longitude: 13.3833,
     #       precision: 0.01666,
@@ -137,7 +159,7 @@ module Wikidatum
     #   wikidatum_client.add_statement(
     #     id: 'Q123',
     #     property: 'P124',
-    #     datavalue: Wikidatum::DataValueType::MonolingualText.new(
+    #     value: Wikidatum::DataType::MonolingualText.new(
     #       language: 'en',
     #       text: 'Foobar'
     #     )
@@ -147,10 +169,8 @@ module Wikidatum
     #   wikidatum_client.add_statement(
     #     id: 'Q123',
     #     property: 'P124',
-    #     datavalue: Wikidatum::DataValueType::Quantity.new(
+    #     value: Wikidatum::DataType::Quantity.new(
     #       amount: '+12',
-    #       upper_bound: nil,
-    #       lower_bound: nil,
     #       unit: 'https://wikidata.org/entity/Q1234'
     #     )
     #   )
@@ -159,9 +179,8 @@ module Wikidatum
     #   wikidatum_client.add_statement(
     #     id: 'Q123',
     #     property: 'P124',
-    #     datavalue: Wikidatum::DataValueType::Time.new(
+    #     value: Wikidatum::DataType::Time.new(
     #       time: '+2022-08-12T00:00:00Z',
-    #       time_zone: 0,
     #       precision: 11,
     #       calendar_model: 'https://wikidata.org/entity/Q1234'
     #     )
@@ -171,66 +190,70 @@ module Wikidatum
     #   wikidatum_client.add_statement(
     #     id: 'Q123',
     #     property: 'P124',
-    #     datavalue: Wikidatum::DataValueType::WikibaseEntityId.new(
-    #       entity_type: 'item',
-    #       numeric_id: 1234,
+    #     value: Wikidatum::DataType::WikibaseItem.new(
     #       id: 'Q1234'
     #     )
     #   )
     #
-    # @param id [String] the ID of the item on which the statement will be added.
-    # @param property [String] property ID in the format 'P123'.
-    # @param datavalue [Wikidatum::DataValueType::GlobeCoordinate, Wikidatum::DataValueType::MonolingualText, Wikidatum::DataValueType::Quantity, Wikidatum::DataValueType::WikibaseString, Wikidatum::DataValueType::Time, Wikidatum::DataValueType::WikibaseEntityId, Wikidatum::DataValueType::NoValue, Wikidatum::DataValueType::SomeValue] the datavalue of the statement being created.
-    # @param datatype [String, nil] if nil, it'll determine the type based on what was passed for the statement argument. This may differ from the type of the Statement's datavalue (for example with the 'url' type).
-    # @param qualifiers [Hash<String, Array<Wikidatum::Snak>>]
+    # @param id [String, Integer] the ID of the item on which the statement will be added.
+    # @param property [String, Integer] property ID in the format 'P123', or an integer.
+    # @param value [Wikidatum::DataType::GlobeCoordinate, Wikidatum::DataType::MonolingualText, Wikidatum::DataType::Quantity, Wikidatum::DataType::WikibaseString, Wikidatum::DataType::Time, Wikidatum::DataType::WikibaseItem, Wikidatum::DataType::NoValue, Wikidatum::DataType::SomeValue] the value of the statement being created.
+    # @param qualifiers [Array<Wikidatum::Qualifier>]
     # @param references [Array<Wikidatum::Reference>]
-    # @param rank [String]
+    # @param rank [String, Symbol] Valid ranks are 'preferred', 'normal', or
+    #   'deprecated'. Defaults to 'normal'. Also accepts Symbol for these ranks.
     # @param tags [Array<String>]
     # @param comment [String, nil]
     # @return [Boolean] True if the request succeeded.
-    def add_statement(id:, property:, datavalue:, datatype: nil, qualifiers: {}, references: [], rank: 'normal', tags: [], comment: nil)
+    def add_statement(id:, property:, value:, qualifiers: [], references: [], rank: 'normal', tags: [], comment: nil)
       raise ArgumentError, "#{id.inspect} is an invalid Wikibase QID. Must be an integer, a string representation of an integer, or in the format 'Q123'." unless id.is_a?(Integer) || id.match?(ITEM_REGEX)
+      raise ArgumentError, "#{property.inspect} is an invalid Wikibase PID. Must be an integer, a string representation of an integer, or in the format 'P123'." unless property.is_a?(Integer) || property.match?(PROPERTY_REGEX)
+      raise ArgumentError, "#{rank.inspect} is an invalid rank. Must be normal, preferred, or deprecated." unless VALID_RANKS.include?(rank.to_s)
+      raise ArgumentError, "Expected an instance of one of Wikidatum::DataType's subclasses for value, but got #{value.inspect}." unless VALID_DATA_TYPES.include?(value.class.to_s)
 
       id = coerce_item_id(id)
+      property = coerce_property_id(property)
 
-      # Unless datatype is set explicitly by the caller, just assume we can pull the
-      # default from the datavalue class.
-      datatype ||= datavalue.wikibase_datatype
-
-      case datavalue.class.to_s
-      when 'Wikidatum::DataValueType::NoValue'
+      case value.class.to_s
+      when 'Wikidatum::DataType::NoValue'
         statement_hash = {
-          mainsnak: {
-            snaktype: 'novalue',
-            property: property,
-            datatype: datatype
+          property: {
+            id: property
+          },
+          value: {
+            type: 'novalue'
           }
         }
-      when 'Wikidatum::DataValueType::SomeValue'
+      when 'Wikidatum::DataType::SomeValue'
         statement_hash = {
-          mainsnak: {
-            snaktype: 'somevalue',
-            property: property,
-            datatype: datatype
+          property: {
+            id: property
+          },
+          value: {
+            type: 'somevalue'
           }
         }
-      when 'Wikidatum::DataValueType::GlobeCoordinate', 'Wikidatum::DataValueType::MonolingualText', 'Wikidatum::DataValueType::Quantity', 'Wikidatum::DataValueType::WikibaseString', 'Wikidatum::DataValueType::Time', 'Wikidatum::DataValueType::WikibaseEntityId'
+      when 'Wikidatum::DataType::GlobeCoordinate', 'Wikidatum::DataType::MonolingualText', 'Wikidatum::DataType::Quantity', 'Wikidatum::DataType::WikibaseString', 'Wikidatum::DataType::Time', 'Wikidatum::DataType::WikibaseItem'
         statement_hash = {
-          mainsnak: {
-            snaktype: 'value',
-            property: property,
-            datatype: datatype,
-            datavalue: {
-              type: datavalue.wikibase_type,
-              value: datavalue.marshal_dump
-            }
+          property: {
+            id: property
+          },
+          value: {
+            type: 'value',
+            content: value.marshal_dump
           }
         }
-      else
-        raise ArgumentError, "Expected an instance of one of Wikidatum::DataValueType's subclasses for datavalue, but got #{datavalue.inspect}."
       end
 
-      body = { statement: statement_hash.merge({ qualifiers: qualifiers, references: references, rank: rank, type: "statement" }) }
+      body = {
+        statement: statement_hash.merge(
+          {
+            qualifiers: qualifiers,
+            references: references,
+            rank: rank.to_s
+          }
+        )
+      }
 
       response = post_request("/entities/items/#{id}/statements", body, tags: tags, comment: comment)
 
@@ -261,6 +284,29 @@ module Wikidatum
       response.success?
     end
 
+    # Is the current instance of Client authenticated as a Wikibase user?
+    #
+    # @return [Boolean]
+    def authenticated?
+      # TODO: Make it possible for this to be true once authentication
+      #   is implemented.
+      false
+    end
+
+    # Does the current instance of Client allow anonymous IP-based edits?
+    #
+    # @return [Boolean]
+    def allow_ip_edits?
+      @allow_ip_edits
+    end
+
+    # Is the current instance of Client editing as a bot?
+    #
+    # @return [Boolean]
+    def bot?
+      @bot
+    end
+
     private
 
     # For now this just returns the `@wikibase_url`, but in the future the API
@@ -309,7 +355,9 @@ module Wikidatum
     # @param tags [Array<String>] The tags to apply to the edit being made by this request, for PUT/POST/DELETE requests.
     # @param comment [String] The edit description, for PUT/POST/DELETE requests.
     # @return [Hash] JSON response, parsed into a hash.
-    def post_request(path, body = {}, tags: nil, comment: nil)
+    def post_request(path, body = {}, tags: [], comment: nil)
+      ensure_edit_permitted!
+
       url = "#{api_url}#{path}"
 
       body[:bot] = @bot
@@ -323,6 +371,13 @@ module Wikidatum
 
       puts response.body.inspect if ENV['DEBUG']
 
+      # Error handling if it doesn't return a 200
+      unless response.success?
+        puts 'Something went wrong with this request!'
+        puts "Status Code: #{response.status}"
+        puts response.body.inspect
+      end
+
       response
     end
 
@@ -333,6 +388,8 @@ module Wikidatum
     # @param comment [String] The edit description, for PUT/POST/DELETE requests.
     # @return [Hash] JSON response, parsed into a hash.
     def delete_request(path, tags: [], comment: nil)
+      ensure_edit_permitted!
+
       url = "#{api_url}#{path}"
 
       body = {}
@@ -368,5 +425,31 @@ module Wikidatum
 
       "Q#{id}"
     end
+
+    # Coerce a Property ID in the formats 'P123', '123' or 123 into a consistent
+    # 'P123' format. We need to have the ID in the format 'P123' for the API
+    # request, which is why coercion is necessary.
+    #
+    # @param property_id [String, Integer]
+    # @return [String]
+    def coerce_property_id(property_id)
+      return property_id if property_id.to_s.start_with?('P')
+
+      "P#{property_id}"
+    end
+
+    # Check if authentication has been provided, and then check if IP edits
+    # are allowed. If neither condition returns true, raise an error.
+    #
+    # Also check if the user is performing IP edits as a bot, which will
+    # always return a 403 error from the REST API, and return a specific
+    # error message if so.
+    #
+    # @return [void]
+    # @raise [DisallowedIpEditError, DisallowedBotEditError]
+    def ensure_edit_permitted!
+      raise DisallowedIpEditError if !authenticated? && !allow_ip_edits?
+      raise DisallowedBotEditError if !authenticated? && bot?
+    end
   end
 end

data/lib/wikidatum/data_type/base.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# For more information on the possible types that can be returned by
+# datavalues, see the official documentation:
+# https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_json.html#json_datavalues
+module Wikidatum::DataType
+  class Base
+    # Represents the type for this instance.
+    #
+    # Possible values for the `type` attribute are:
+    #
+    # - `:no_value`: No value
+    # - `:some_value`: Unknown value
+    # - `:globe_coordinate`: {DataType::GlobeCoordinate}
+    # - `:monolingual_text`: {DataType::MonolingualText}
+    # - `:quantity`: {DataType::Quantity}
+    # - `:string`: {DataType::WikibaseString}
+    # - `:time`: {DataType::Time}
+    # - `:wikibase_item`: {DataType::WikibaseItem}
+    #
+    # @return [Symbol]
+    attr_reader :type
+
+    # The value of the "content" attribute in the response.
+    #
+    # If the `type` is `novalue` or `somevalue`, this returns `nil`.
+    #
+    # @return [DataType::GlobeCoordinate, DataType::MonolingualText, DataType::Quantity, DataType::WikibaseString, DataType::Time, DataType::WikibaseItem, nil]
+    attr_reader :content
+
+    # @param type [Symbol]
+    # @param content [DataType::GlobeCoordinate, DataType::MonolingualText, DataType::Quantity, DataType::WikibaseString, DataType::Time, DataType::WikibaseItem, nil] nil if type is no_value or some_value
+    # @return [void]
+    def initialize(type:, content:)
+      @type = type
+      @content = content
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        type: @type,
+        content: @content&.to_h
+      }
+    end
+
+    # @!visibility private
+    #
+    # @param data_type [String] The value of `data-type` for the given Statement or Qualifier's property.
+    # @param data_value_json [Hash] The `content` part of value object.
+    # @return [Wikidatum::DataType::Base] An instance of Base.
+    def self.marshal_load(data_type, data_value_json)
+      unless Wikidatum::DataType::DATA_TYPES.keys.include?(data_type.to_sym)
+        puts "WARNING: Unsupported data type (#{data_type})"
+        return nil
+      end
+
+      Object.const_get(Wikidatum::DataType::DATA_TYPES[data_type.to_sym]).marshal_load(data_value_json)
+    end
+  end
+end

data/lib/wikidatum/{data_value_type → data_type}/globe_coordinate.rb

@@ -1,23 +1,27 @@
 # frozen_string_literal: true
 
-require 'wikidatum/data_value_type/base'
+require 'wikidatum/data_type/base'
 
-# The Globe Coordinate type datavalue JSON looks like this:
+# The Globe Coordinate type JSON looks like this:
 #
 # ```json
 # {
-#   "datavalue": {
-#     "value": {
-#       "latitude": 52.516666666667,
-#       "longitude": 13.383333333333,
-#       "precision": 0.016666666666667,
+#   "property": {
+#     "id": "P740",
+#     "data-type": "globe-coordinate"
+#   },
+#   "value": {
+#     "type": "value",
+#     "content": {
+#       "latitude": 38.8977,
+#       "longitude": -77.0365,
+#       "precision": 0.0001,
 #       "globe": "http://www.wikidata.org/entity/Q2"
-#     },
-#     "type": "globecoordinate"
+#     }
 #   }
 # }
 # ```
-class Wikidatum::DataValueType::GlobeCoordinate
+class Wikidatum::DataType::GlobeCoordinate
   # @return [Float]
   attr_reader :latitude
 
@@ -56,22 +60,19 @@ class Wikidatum::DataValueType::GlobeCoordinate
   #
   # @return [String]
   def wikibase_type
-    'globecoordinate'
+    'globe-coordinate'
   end
 
-  # The "datatype" value used by Wikibase, usually identical to wikibase_type
-  # but not always.
-  #
-  # @return [String]
-  def wikibase_datatype
-    'globe-coordinate' # yes, really
+  # @return [Symbol]
+  def self.symbolized_name
+    :monolingual_text
   end
 
   # @!visibility private
   def self.marshal_load(data_value_json)
-    Wikidatum::DataValueType::Base.new(
-      type: :globe_coordinate,
-      value: new(
+    Wikidatum::DataType::Base.new(
+      type: symbolized_name,
+      content: new(
         latitude: data_value_json['latitude'],
         longitude: data_value_json['longitude'],
         precision: data_value_json['precision'],

data/lib/wikidatum/{data_value_type → data_type}/monolingual_text.rb

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
-require 'wikidatum/data_value_type/base'
+require 'wikidatum/data_type/base'
 
-# The Monolingual Text type datavalue JSON looks like this:
+# The Monolingual Text type JSON looks like this:
 #
 # ```json
 # {
-#   "datavalue": {
-#     "value": {
-#       "text": "South Pole Telescope eyes birth of first massive galaxies",
-#       "language": "en"
-#     },
-#     "type": "monolingualtext"
+#   "property": {
+#     "id": "P13432",
+#     "data-type": "monolingualtext"
+#   },
+#   "value": {
+#     "type": "value",
+#     "content": {
+#       "text": "foo",
+#       "language": "en-gb"
+#     }
 #   }
 # }
 # ```
-class Wikidatum::DataValueType::MonolingualText
+class Wikidatum::DataType::MonolingualText
   # @return [String] the language code, e.g. 'en'
   attr_reader :language
 
@@ -45,19 +49,16 @@ class Wikidatum::DataValueType::MonolingualText
     'monolingualtext'
   end
 
-  # The "datatype" value used by Wikibase, usually identical to wikibase_type
-  # but not always.
-  #
-  # @return [String]
-  def wikibase_datatype
-    wikibase_type
+  # @return [Symbol]
+  def self.symbolized_name
+    :monolingual_text
   end
 
   # @!visibility private
   def self.marshal_load(data_value_json)
-    Wikidatum::DataValueType::Base.new(
-      type: :monolingual_text,
-      value: new(
+    Wikidatum::DataType::Base.new(
+      type: symbolized_name,
+      content: new(
         language: data_value_json['language'],
         text: data_value_json['text']
       )

data/lib/wikidatum/{data_value_type → data_type}/no_value.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'wikidatum/data_value_type/base'
+require 'wikidatum/data_type/base'
 
 # The NoValue type actually has no datavalue key in the blob at all. We work
 # around this by just passing nil to the serializer.
 
 # Represents "no value".
-class Wikidatum::DataValueType::NoValue < Wikidatum::DataValueType::Base
+class Wikidatum::DataType::NoValue < Wikidatum::DataType::Base
   # The "type" value used by Wikibase, for use when creating/updating statements.
   #
   # @return [String]
@@ -14,16 +14,8 @@ class Wikidatum::DataValueType::NoValue < Wikidatum::DataValueType::Base
     'string'
   end
 
-  # The "datatype" value used by Wikibase, usually identical to wikibase_type
-  # but not always.
-  #
-  # @return [String]
-  def wikibase_datatype
-    wikibase_type
-  end
-
   # @!visibility private
   def self.marshal_load(_data_value_json)
-    new(type: :no_value, value: nil)
+    new(type: :no_value, content: nil)
   end
 end