wikidatum 0.2.1 → 0.3.1

data/lib/wikidatum.rb

@@ -1,19 +1,38 @@
 # frozen_string_literal: true
 
 require 'wikidatum/client'
-require 'wikidatum/data_value_type'
+require 'wikidatum/data_type'
 require 'wikidatum/item'
 require 'wikidatum/qualifier'
 require 'wikidatum/reference'
+require 'wikidatum/reference_part'
 require 'wikidatum/sitelink'
-require 'wikidatum/snak'
 require 'wikidatum/statement'
 require 'wikidatum/term'
+require 'wikidatum/utils'
 require 'wikidatum/version'
 
 module Wikidatum
   class Error < StandardError; end
 
+  # If the Wikidatum::Client is set to disallow IP Edits (the default) and no
+  # authentication has been provided, this error will be raised when performing
+  # any non-GET requests.
+  class DisallowedIpEditError < Error
+    def message
+      'No authentication provided. If you want to perform unauthenticated edits and are comfortable exposing your IP address publicly, set `allow_ip_edits: true` when instantiating your client with `Wikidatum::Client.new`.'
+    end
+  end
+
+  # If the Wikidatum::Client is set to mark their edits as belonging to a bot,
+  # they must be authenticated as a bot user. We will disallow these edits
+  # as long as they're not authenticated as a specific user.
+  class DisallowedBotEditError < Error
+    def message
+      'No authentication provided, but attempted to edit as a bot. You cannot make edits as a bot unless you have authenticated as a user with the Bot flag.'
+    end
+  end
+
   # rubocop:disable Naming/ConstantName
 
   # These language codes are not enforced, you can pass whatever language code
@@ -45,17 +64,18 @@ module Wikidatum
     # rubocop:enable Naming/ConstantName
   end
 
-  module DataValueType
+  module DataType
+    # TODO: Add commonsMedia and url to the possible types.
     # rubocop:disable Lint/SymbolConversion
-    DATA_VALUE_TYPES = {
-      'globecoordinate': 'Wikidatum::DataValueType::GlobeCoordinate',
-      'monolingualtext': 'Wikidatum::DataValueType::MonolingualText',
-      'novalue': 'Wikidatum::DataValueType::NoValue',
-      'quantity': 'Wikidatum::DataValueType::Quantity',
-      'somevalue': 'Wikidatum::DataValueType::SomeValue',
-      'string': 'Wikidatum::DataValueType::WikibaseString',
-      'time': 'Wikidatum::DataValueType::Time',
-      'wikibase-entityid': 'Wikidatum::DataValueType::WikibaseEntityId'
+    DATA_TYPES = {
+      'globe-coordinate': 'Wikidatum::DataType::GlobeCoordinate',
+      'monolingualtext': 'Wikidatum::DataType::MonolingualText',
+      'novalue': 'Wikidatum::DataType::NoValue',
+      'quantity': 'Wikidatum::DataType::Quantity',
+      'somevalue': 'Wikidatum::DataType::SomeValue',
+      'string': 'Wikidatum::DataType::WikibaseString',
+      'time': 'Wikidatum::DataType::Time',
+      'wikibase-item': 'Wikidatum::DataType::WikibaseItem'
     }.freeze
     # rubocop:enable Lint/SymbolConversion
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wikidatum
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Connor Shea
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-13 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,23 +38,24 @@ files:
 - bin/setup
 - lib/wikidatum.rb
 - lib/wikidatum/client.rb
-- lib/wikidatum/data_value_type.rb
-- lib/wikidatum/data_value_type/base.rb
-- lib/wikidatum/data_value_type/globe_coordinate.rb
-- lib/wikidatum/data_value_type/monolingual_text.rb
-- lib/wikidatum/data_value_type/no_value.rb
-- lib/wikidatum/data_value_type/quantity.rb
-- lib/wikidatum/data_value_type/some_value.rb
-- lib/wikidatum/data_value_type/time.rb
-- lib/wikidatum/data_value_type/wikibase_entity_id.rb
-- lib/wikidatum/data_value_type/wikibase_string.rb
+- lib/wikidatum/data_type.rb
+- lib/wikidatum/data_type/base.rb
+- lib/wikidatum/data_type/globe_coordinate.rb
+- lib/wikidatum/data_type/monolingual_text.rb
+- lib/wikidatum/data_type/no_value.rb
+- lib/wikidatum/data_type/quantity.rb
+- lib/wikidatum/data_type/some_value.rb
+- lib/wikidatum/data_type/time.rb
+- lib/wikidatum/data_type/wikibase_item.rb
+- lib/wikidatum/data_type/wikibase_string.rb
 - lib/wikidatum/item.rb
 - lib/wikidatum/qualifier.rb
 - lib/wikidatum/reference.rb
+- lib/wikidatum/reference_part.rb
 - lib/wikidatum/sitelink.rb
-- lib/wikidatum/snak.rb
 - lib/wikidatum/statement.rb
 - lib/wikidatum/term.rb
+- lib/wikidatum/utils.rb
 - lib/wikidatum/version.rb
 - wikidatum.gemspec
 homepage:
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Ruby gem for the new Wikidata REST API.

data/lib/wikidatum/data_value_type/base.rb

@@ -1,61 +0,0 @@
-# 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::DataValueType
-  class Base
-    # Represents the type for this datavalue instance.
-    #
-    # Possible values for the `type` attribute are:
-    #
-    # - `:no_value`: No value
-    # - `:some_value`: Unknown value
-    # - `:globe_coordinate`: {DataValueType::GlobeCoordinate}
-    # - `:monolingual_text`: {DataValueType::MonolingualText}
-    # - `:quantity`: {DataValueType::Quantity}
-    # - `:string`: {DataValueType::WikibaseString}
-    # - `:time`: {DataValueType::Time}
-    # - `:wikibase_entity_id`: {DataValueType::WikibaseEntityId}
-    #
-    # @return [Symbol]
-    attr_reader :type
-
-    # The value of the datavalue object in the response.
-    #
-    # If the `type` is `novalue` or `somevalue`, this returns `nil`.
-    #
-    # @return [DataValueType::GlobeCoordinate, DataValueType::MonolingualText, DataValueType::Quantity, DataValueType::WikibaseString, DataValueType::Time, DataValueType::WikibaseEntityId, nil]
-    attr_reader :value
-
-    # @param type [Symbol]
-    # @param value [DataValueType::GlobeCoordinate, DataValueType::MonolingualText, DataValueType::Quantity, DataValueType::WikibaseString, DataValueType::Time, DataValueType::WikibaseEntityId, nil] nil if type is no_value or some_value
-    # @return [void]
-    def initialize(type:, value:)
-      @type = type
-      @value = value
-    end
-
-    # @return [Hash]
-    def to_h
-      {
-        type: @type,
-        value: @value&.to_h
-      }
-    end
-
-    # @!visibility private
-    #
-    # @param data_value_type [String] The value of `type` for the given Snak's datavalue.
-    # @param data_value_json [Hash] The `value` part of datavalue.
-    # @return [Wikidatum::DataValueType::Base] An instance of Base.
-    def self.marshal_load(data_value_type, data_value_json)
-      unless Wikidatum::DataValueType::DATA_VALUE_TYPES.keys.include?(data_value_type.to_sym)
-        puts 'WARNING: Unsupported datavalue type.'
-        return nil
-      end
-
-      Object.const_get(Wikidatum::DataValueType::DATA_VALUE_TYPES[data_value_type.to_sym]).marshal_load(data_value_json)
-    end
-  end
-end

data/lib/wikidatum/data_value_type/quantity.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require 'wikidatum/data_value_type/base'
-
-# The Quantity type datavalue JSON looks like this:
-#
-# ```json
-# {
-#   "datavalue": {
-#     "value": {
-#       "amount": "+10.38",
-#       "upperBound": "+10.375",
-#       "lowerBound": "+10.385",
-#       "unit": "http://www.wikidata.org/entity/Q712226"
-#     },
-#     "type": "quantity"
-#   }
-# }
-# ```
-class Wikidatum::DataValueType::Quantity
-  # @return [String] A string value like "+2", usually an integer but not always.
-  attr_reader :amount
-
-  # @return [String, nil] upper bound, if one is defined.
-  attr_reader :upper_bound
-
-  # @return [String, nil] lower bound, if one is defined.
-  attr_reader :lower_bound
-
-  # @return [String] a URL describing the unit for this quantity, e.g. "meter", "kilometer", "pound", "chapter", "section", etc.
-  attr_reader :unit
-
-  # @param amount [String]
-  # @param upper_bound [String]
-  # @param lower_bound [String]
-  # @param unit [String]
-  # @return [void]
-  def initialize(amount:, upper_bound:, lower_bound:, unit:)
-    @amount = amount
-    @upper_bound = upper_bound
-    @lower_bound = lower_bound
-    @unit = unit
-  end
-
-  # @return [Hash]
-  def to_h
-    {
-      amount: @amount,
-      upper_bound: @upper_bound,
-      lower_bound: @lower_bound,
-      unit: @unit
-    }
-  end
-
-  # The "type" value used by Wikibase, for use when creating/updating statements.
-  #
-  # @return [String]
-  def wikibase_type
-    'quantity'
-  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)
-    Wikidatum::DataValueType::Base.new(
-      type: :quantity,
-      value: new(
-        amount: data_value_json['amount'],
-        upper_bound: data_value_json['upperBound'],
-        lower_bound: data_value_json['lowerBound'],
-        unit: data_value_json['unit']
-      )
-    )
-  end
-
-  # @!visibility private
-  def marshal_dump
-    {
-      amount: @amount,
-      upperBound: @upper_bound,
-      lowerBound: @lower_bound,
-      unit: @unit
-    }
-  end
-end

data/lib/wikidatum/data_value_type/wikibase_entity_id.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require 'wikidatum/data_value_type/base'
-
-# The Wikibase Entity ID type datavalue JSON looks like this:
-#
-# ```json
-# {
-#   "datavalue": {
-#     "value": {
-#       "entity-type": "item",
-#       "numeric-id": 552863,
-#       "id": "Q552863"
-#     },
-#     "type": "wikibase-entityid"
-#   }
-# }
-# ```
-class Wikidatum::DataValueType::WikibaseEntityId
-  # @return [String] usually "item"
-  attr_reader :entity_type
-
-  # @return [Integer] the integer representation of the Wikibase ID.
-  attr_reader :numeric_id
-
-  # @return [String] in the format "Q123".
-  attr_reader :id
-
-  # @param entity_type [String]
-  # @param numeric_id [Integer]
-  # @param id [String]
-  # @return [void]
-  def initialize(entity_type:, numeric_id:, id:)
-    @entity_type = entity_type
-    @numeric_id = numeric_id
-    @id = id
-  end
-
-  # @return [Hash]
-  def to_h
-    {
-      entity_type: @entity_type,
-      numeric_id: @numeric_id,
-      id: @id
-    }
-  end
-
-  # The "type" value used by Wikibase, for use when creating/updating statements.
-  #
-  # @return [String]
-  def wikibase_type
-    'wikibase-entityid'
-  end
-
-  # The "datatype" value used by Wikibase, usually identical to wikibase_type
-  # but not always.
-  #
-  # @return [String]
-  def wikibase_datatype
-    'wikibase-item' # yes, really
-  end
-
-  # @!visibility private
-  def self.marshal_load(data_value_json)
-    Wikidatum::DataValueType::Base.new(
-      type: :wikibase_entity_id,
-      value: new(
-        entity_type: data_value_json['entity-type'],
-        numeric_id: data_value_json['numeric-id'],
-        id: data_value_json['id']
-      )
-    )
-  end
-
-  # @!visibility private
-  def marshal_dump
-    {
-      'entity-type': @entity_type,
-      'numeric-id': @numeric_id,
-      id: @id
-    }
-  end
-end

data/lib/wikidatum/data_value_type.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'wikidatum/data_value_type/base'
-require 'wikidatum/data_value_type/globe_coordinate'
-require 'wikidatum/data_value_type/monolingual_text'
-require 'wikidatum/data_value_type/no_value'
-require 'wikidatum/data_value_type/quantity'
-require 'wikidatum/data_value_type/some_value'
-require 'wikidatum/data_value_type/time'
-require 'wikidatum/data_value_type/wikibase_entity_id'
-require 'wikidatum/data_value_type/wikibase_string'

data/lib/wikidatum/snak.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-class Wikidatum::Snak
-  # @return [String] Hash of a snak (a cryptographic hash, not a Ruby hash).
-  attr_reader :hash
-
-  # @return [String]
-  attr_reader :snaktype
-
-  # @return [String] ID of the property for this Snak, in the format 'P123'.
-  attr_reader :property
-
-  # @return [String]
-  attr_reader :datatype
-
-  # 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
-  #
-  # @return [Wikidatum::DataValueType::Base] the value of the statement, can take various forms
-  attr_reader :datavalue
-
-  # @!visibility private
-  # @param hash [String] Hash of a snak (a cryptographic hash, not a Ruby hash).
-  # @param snaktype [String]
-  # @param property [String] ID of the property for this Snak, in the format 'P123'.
-  # @param datatype [String]
-  # @param datavalue [DataValueType::GlobeCoordinate, DataValueType::MonolingualText, DataValueType::Quantity, DataValueType::WikibaseString, DataValueType::Time, DataValueType::WikibaseEntityId]
-  def initialize(hash:, snaktype:, property:, datatype:, datavalue:)
-    @hash = hash
-    @snaktype = snaktype
-    @property = property
-    @datatype = datatype
-    @datavalue = datavalue
-  end
-
-  # @return [Hash]
-  def to_h
-    {
-      hash: @hash,
-      snaktype: @snaktype,
-      property: @property,
-      datatype: @datatype,
-      datavalue: @datavalue.to_h
-    }
-  end
-
-  # @return [String]
-  def inspect
-    "<Wikidatum::Snak hash=#{@hash.inspect} snaktype=#{@snaktype.inspect} property=#{@property.inspect} datatype=#{@datatype.inspect} datavalue=#{@datavalue.inspect}>"
-  end
-
-  # @!visibility private
-  #
-  # This takes in the JSON blob (as a hash) that is output for a given
-  # snak in the API and turns it into an actual instance of a Snak.
-  #
-  # @param snak_json [Hash]
-  # @return [Wikidatum::Snak]
-  def self.marshal_load(snak_json)
-    # snaktype can be 'novalue' (no value) or 'somevalue' (unknown), so we handle those as somewhat special cases
-    case snak_json['snaktype']
-    when 'novalue'
-      datavalue = Wikidatum::DataValueType::Base.marshal_load('novalue', nil)
-    when 'somevalue'
-      datavalue = Wikidatum::DataValueType::Base.marshal_load('somevalue', nil)
-    when 'value'
-      datavalue = Wikidatum::DataValueType::Base.marshal_load(snak_json['datavalue']['type'], snak_json['datavalue']['value'])
-    end
-
-    Wikidatum::Snak.new(
-      hash: snak_json['hash'],
-      snaktype: snak_json['snaktype'],
-      property: snak_json['property'],
-      datatype: snak_json['datatype'],
-      datavalue: datavalue
-    )
-  end
-end