wikidatum 0.2.0 → 0.3.0

data/lib/wikidatum/reference.rb

@@ -4,28 +4,28 @@ class Wikidatum::Reference
   # @return [String] Hash of the reference (a cryptographic hash, not a Ruby hash).
   attr_reader :hash
 
-  # @return [Array<Wikidatum::Snak>]
-  attr_reader :snaks
+  # @return [Array<Wikidatum::ReferencePart>]
+  attr_reader :parts
 
   # @!visibility private
   # @param hash [String] Hash of the reference (a cryptographic hash, not a Ruby hash).
-  # @param snaks [Array<Wikidatum::Snak>]
-  def initialize(hash:, snaks:)
+  # @param parts [Array<Wikidatum::ReferencePart>]
+  def initialize(hash:, parts:)
     @hash = hash
-    @snaks = snaks
+    @parts = parts
   end
 
   # @return [Hash]
   def to_h
     {
       hash: @hash,
-      snaks: @snaks.map(&:to_h)
+      parts: @parts.map(&:to_h)
     }
   end
 
   # @return [String]
   def inspect
-    "<Wikidatum::Reference hash=#{@hash.inspect} snaks=#{@snaks.inspect}>"
+    "<Wikidatum::Reference hash=#{@hash.inspect} parts=#{@parts.inspect}>"
   end
 
   # @!visibility private
@@ -37,11 +37,11 @@ class Wikidatum::Reference
   # @param ref_json [Hash]
   # @return [Wikidatum::Reference]
   def self.marshal_load(ref_json)
-    snaks = ref_json['snaks'].values.flatten.map { |snak| Wikidatum::Snak.marshal_load(snak) }
+    parts = ref_json['parts'].map { |part| Wikidatum::ReferencePart.marshal_load(part) }
 
     Wikidatum::Reference.new(
       hash: ref_json['hash'],
-      snaks: snaks
+      parts: parts
     )
   end
 end

data/lib/wikidatum/reference_part.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class Wikidatum::ReferencePart
+  # @return [String] ID of the property used, in the format "P123".
+  attr_reader :property_id
+
+  # @return [String]
+  attr_reader :data_type
+
+  # 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::DataType::Base] the value of the statement, can take various forms
+  attr_reader :value
+
+  # @!visibility private
+  # @param property_id [String] ID of the property used, in the format "P123".
+  # @param data_type [String]
+  # @param value [DataType::GlobeCoordinate, DataType::MonolingualText, DataType::Quantity, DataType::WikibaseString, DataType::Time, DataType::WikibaseItem, DataType::NoValue, DataType::SomeValue]
+  def initialize(property_id:, data_type:, value:)
+    @property_id = property_id
+    @data_type = data_type
+    @value = value
+  end
+
+  # @return [Hash]
+  def to_h
+    {
+      property_id: @property_id,
+      data_type: @data_type,
+      value: @value.to_h
+    }
+  end
+
+  # @return [String]
+  def inspect
+    "<Wikidatum::ReferencePart property_id=#{@property_id.inspect} data_type=#{@data_type.inspect} value=#{@value.inspect}>"
+  end
+
+  # @!visibility private
+  #
+  # This takes in the JSON blob (as a hash) that is output for a given
+  # reference part in the API and turns it into an actual instance of a
+  # ReferencePart.
+  #
+  # @param part_json [Hash]
+  # @return [Wikidatum::ReferencePart]
+  def self.marshal_load(part_json)
+    Wikidatum::ReferencePart.new(
+      property_id: part_json.dig('property', 'id'),
+      data_type: part_json.dig('property', 'data-type'),
+      value: Wikidatum::Utils.ingest_snak(part_json)
+    )
+  end
+end

data/lib/wikidatum/statement.rb

@@ -7,8 +7,11 @@ class Wikidatum::Statement
   # @return [String] property ID, in the format of 'P123'.
   attr_accessor :property_id
 
-  # @return [Wikidatum::Snak]
-  attr_accessor :mainsnak
+  # @return [String]
+  attr_accessor :data_type
+
+  # @return [DataType::GlobeCoordinate, DataType::MonolingualText, DataType::Quantity, DataType::WikibaseString, DataType::Time, DataType::WikibaseItem, nil]
+  attr_accessor :data_value
 
   # @return [Array<Wikidatum::Qualifier>]
   attr_accessor :qualifiers
@@ -22,15 +25,17 @@ class Wikidatum::Statement
 
   # @param id [String]
   # @param property_id [String] The 'P123' ID of the property that this statement represents.
-  # @param mainsnak [Wikidatum::Snak]
+  # @param data_type [String]
+  # @param data_value [DataType::GlobeCoordinate, DataType::MonolingualText, DataType::Quantity, DataType::WikibaseString, DataType::Time, DataType::WikibaseItem, nil]
   # @param qualifiers [Array<Wikidatum::Qualifier>]
   # @param references [Array<Wikidatum::Reference>]
   # @param rank [String] The rank of the given statement.
   #   Can have the values "preferred", "normal", or "deprecated". Defaults to "normal".
-  def initialize(id:, property_id:, mainsnak:, qualifiers:, references:, rank: 'normal')
+  def initialize(id:, property_id:, data_type:, data_value:, qualifiers:, references:, rank: 'normal')
     @id = id
     @property_id = property_id
-    @mainsnak = mainsnak
+    @data_type = data_type
+    @data_value = data_value
     @qualifiers = qualifiers
     @references = references
     @rank = rank
@@ -41,7 +46,8 @@ class Wikidatum::Statement
     {
       id: @id,
       property_id: @property_id,
-      mainsnak: @mainsnak.to_h,
+      data_type: @data_type,
+      data_value: @data_value.to_h,
       qualifiers: @qualifiers.map(&:to_h),
       references: @references.map(&:to_h),
       rank: @rank
@@ -56,10 +62,13 @@ class Wikidatum::Statement
   # @param statement_json [Hash]
   # @return [Wikidatum::Statement]
   def self.marshal_load(statement_json)
-    mainsnak = Wikidatum::Snak.marshal_load(statement_json['mainsnak'])
+    data_type = Wikidatum::Utils.symbolized_name_for_data_type(statement_json['property']['data-type'])
+    data_value = Wikidatum::Utils.ingest_snak(statement_json)
+
+    property_id = statement_json['property']['id']
 
-    qualifiers = statement_json['qualifiers'].to_a.flat_map do |_qualifier_prop_id, qualifier|
-      qualifier.map { |q| Wikidatum::Qualifier.marshal_load(q) }
+    qualifiers = statement_json['qualifiers'].to_a.flat_map do |qualifier|
+      Wikidatum::Qualifier.marshal_load(qualifier)
     end
     references = statement_json['references'].flat_map do |reference|
       Wikidatum::Reference.marshal_load(reference)
@@ -67,8 +76,9 @@ class Wikidatum::Statement
 
     Wikidatum::Statement.new(
       id: statement_json['id'],
-      property_id: mainsnak.property,
-      mainsnak: mainsnak,
+      property_id: property_id,
+      data_type: data_type,
+      data_value: data_value,
       qualifiers: qualifiers,
       references: references,
       rank: statement_json['rank']

data/lib/wikidatum/utils.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Wikidatum::Utils
+  # Yum!
+  def self.ingest_snak(json)
+    # the type can be 'novalue' (no value) or 'somevalue' (unknown), so we handle those as somewhat special cases
+    case json['value']['type']
+    when 'novalue'
+      Wikidatum::DataType::Base.marshal_load('novalue', nil)
+    when 'somevalue'
+      Wikidatum::DataType::Base.marshal_load('somevalue', nil)
+    when 'value'
+      Wikidatum::DataType::Base.marshal_load(json['property']['data-type'], json['value']['content'])
+    end
+  end
+
+  def self.symbolized_name_for_data_type(data_type)
+    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]).symbolized_name
+  end
+end

data/lib/wikidatum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wikidatum
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/wikidatum.rb

@@ -1,19 +1,29 @@
 # frozen_string_literal: true
 
-require_relative 'wikidatum/client'
-require_relative 'wikidatum/data_value_type'
-require_relative 'wikidatum/item'
-require_relative 'wikidatum/qualifier'
-require_relative 'wikidatum/reference'
-require_relative 'wikidatum/sitelink'
-require_relative 'wikidatum/snak'
-require_relative 'wikidatum/statement'
-require_relative 'wikidatum/term'
-require_relative 'wikidatum/version'
+require 'wikidatum/client'
+require 'wikidatum/data_type'
+require 'wikidatum/item'
+require 'wikidatum/qualifier'
+require 'wikidatum/reference'
+require 'wikidatum/reference_part'
+require 'wikidatum/sitelink'
+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
+
   # rubocop:disable Naming/ConstantName
 
   # These language codes are not enforced, you can pass whatever language code
@@ -45,17 +55,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

data/wikidatum.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|))})
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|))}) || f.match(/\A(?:Gemfile|Rakefile)/)
     end
   end
   spec.bindir = "exe"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wikidatum
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 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
@@ -32,32 +32,30 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- Rakefile
 - bin/console
 - 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:
@@ -84,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/Gemfile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in wikidatum.gemspec
-gemspec
-
-gem 'rake', '~> 13.0'
-gem 'minitest', '~> 5.16'
-gem 'simplecov', '~> 0.21', require: false
-gem 'rubocop', '~> 1.30'
-gem 'yard', '~> 0.9'
-gem 'webmock', '~> 3.17', require: false

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    wikidatum (0.2.0)
-      faraday (~> 2.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    crack (0.4.5)
-      rexml
-    docile (1.4.0)
-    faraday (2.4.0)
-      faraday-net_http (~> 2.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.1.0)
-    hashdiff (1.0.1)
-    minitest (5.16.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    public_suffix (4.0.7)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rubocop (1.30.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.1.0)
-    webmock (3.17.1)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-
-PLATFORMS
-  arm64-darwin-21
-  x86_64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  minitest (~> 5.16)
-  rake (~> 13.0)
-  rubocop (~> 1.30)
-  simplecov (~> 0.21)
-  webmock (~> 3.17)
-  wikidatum!
-  yard (~> 0.9)
-
-BUNDLED WITH
-   2.3.3

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_spec.rb"]
-end
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

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