wikidatum 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8f1ec02cd83bf3ea3e432868a8283474f810bfd55740b5759c820d880f95e31
-  data.tar.gz: a5af62f917570a29ceceb6e420377154775d9820dec8abb02eb84e037f0bab89
+  metadata.gz: 50ad5328f1593f1de47d492e6c4e761d80d3e43bb967bcf9386f72053881b705
+  data.tar.gz: eb17d97dfdbe7c45c2b10bc7d34aeeb76136b3473c72817f7a1b053f0e2d16eb
 SHA512:
-  metadata.gz: a6c46eacdb7d7455ee5e96d3cf7c0970bd85ffc3abd1dc09c856b0f92062beaede5d451c9587ab72afc14d3b3c3a4e800c9685b435fbb4074b7d5e0b77cda463
-  data.tar.gz: bf4810fc7384b5b5cecf2db956758a1125a1664b62b8f7275d77347c7e0b78d64fbd76d011375914162c7a3a687bb4b679fd2ace7e8addcda2ad84775b88503f
+  metadata.gz: f6cb6a7968e9f8943b6b6cd06311d74139a8580dde6e925a83cdf891292d5e6028a63b027394af2b04b31cadc78af88170f3a3fd3c92c2d4aeaca72560048402
+  data.tar.gz: d27a8240fec4fd41caa3ec21ce7bab706fed304bd364b076c741b7577bc04ce1fdd3df5db1675a5cbc431872ad1fe69f7f7b035a696b6212a38a97afec3bc2c6

data/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
 
+## 0.2.1 - 2022-08-13
+### Fixed
+- Fix a mistake that broke loading the gem.
+
 ## 0.2.0 - 2022-08-13
 ### Added
 

data/bin/console

@@ -7,9 +7,5 @@ require "wikidatum"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require "irb"
 IRB.start(__FILE__)

data/lib/wikidatum/client.rb

@@ -3,368 +3,370 @@
 require 'faraday'
 require 'faraday/net_http'
 
-class Wikidatum::Client
-  ITEM_REGEX = /^Q?\d+$/.freeze
-  STATEMENT_REGEX = /^Q?\d+\$[\w-]+$/.freeze
-
-  # @return [String] the root URL of the Wikibase instance we want to interact
-  #   with. If not provided, will default to Wikidata.
-  attr_reader :wikibase_url
-
-  # @return [Boolean] whether this client instance should identify itself
-  #   as a bot when making requests.
-  attr_reader :bot
-
-  # @return [String] the UserAgent header to send with all requests to the
-  #   Wikibase API.
-  attr_reader :user_agent
-
-  # 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!',
-  #    wikibase_url: 'https://www.wikidata.org',
-  #    bot: true
-  #  )
-  #
-  # @param user_agent [String] The UserAgent header to send with all requests
-  #   to the Wikibase API.
-  # @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`.
-  # @return [Wikidatum::Client]
-  def initialize(user_agent:, wikibase_url: 'https://www.wikidata.org', bot: true)
-    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
-    @wikibase_url = wikibase_url
-    @bot = bot
-
-    Faraday.default_adapter = :net_http
-  end
+module Wikidatum
+  class Client
+    ITEM_REGEX = /^Q?\d+$/.freeze
+    STATEMENT_REGEX = /^Q?\d+\$[\w-]+$/.freeze
+
+    # @return [String] the root URL of the Wikibase instance we want to interact
+    #   with. If not provided, will default to Wikidata.
+    attr_reader :wikibase_url
+
+    # @return [Boolean] whether this client instance should identify itself
+    #   as a bot when making requests.
+    attr_reader :bot
+
+    # @return [String] the UserAgent header to send with all requests to the
+    #   Wikibase API.
+    attr_reader :user_agent
+
+    # 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!',
+    #    wikibase_url: 'https://www.wikidata.org',
+    #    bot: true
+    #  )
+    #
+    # @param user_agent [String] The UserAgent header to send with all requests
+    #   to the Wikibase API.
+    # @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`.
+    # @return [Wikidatum::Client]
+    def initialize(user_agent:, wikibase_url: 'https://www.wikidata.org', bot: true)
+      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
+      @wikibase_url = wikibase_url
+      @bot = bot
+
+      Faraday.default_adapter = :net_http
+    end
 
-  # Get an item from the Wikibase API based on its QID.
-  #
-  # @example
-  #   wikidatum_client.item(id: 'Q123')
-  #   wikidatum_client.item(id: 123)
-  #   wikidatum_client.item(id: '123')
-  #
-  # @param id [String, Integer] Either a string or integer representation of
-  #   the item's QID, e.g. `"Q123"`, `"123"`, or `123`.
-  # @return [Wikidatum::Item]
-  def item(id:)
-    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)
+    # Get an item from the Wikibase API based on its QID.
+    #
+    # @example
+    #   wikidatum_client.item(id: 'Q123')
+    #   wikidatum_client.item(id: 123)
+    #   wikidatum_client.item(id: '123')
+    #
+    # @param id [String, Integer] Either a string or integer representation of
+    #   the item's QID, e.g. `"Q123"`, `"123"`, or `123`.
+    # @return [Wikidatum::Item]
+    def item(id:)
+      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)
 
-    id = coerce_item_id(id)
+      id = coerce_item_id(id)
 
-    response = get_request("/entities/items/#{id}")
+      response = get_request("/entities/items/#{id}")
 
-    puts JSON.pretty_generate(response) if ENV['DEBUG']
+      puts JSON.pretty_generate(response) if ENV['DEBUG']
 
-    Wikidatum::Item.marshal_load(response)
-  end
+      Wikidatum::Item.marshal_load(response)
+    end
 
-  # Get a statement from the Wikibase API based on its ID.
-  #
-  # @example
-  #   wikidatum_client.statement(id: 'Q123$f004ec2b-4857-3b69-b370-e8124f5bd3ac')
-  #
-  # @param id [String] A string representation of the statement's ID.
-  # @return [Wikidatum::Statement]
-  def statement(id:)
-    raise ArgumentError, "#{id.inspect} is an invalid Wikibase Statement ID. Must be a string in the format 'Q123$f004ec2b-4857-3b69-b370-e8124f5bd3ac'." unless id.match?(STATEMENT_REGEX)
+    # Get a statement from the Wikibase API based on its ID.
+    #
+    # @example
+    #   wikidatum_client.statement(id: 'Q123$f004ec2b-4857-3b69-b370-e8124f5bd3ac')
+    #
+    # @param id [String] A string representation of the statement's ID.
+    # @return [Wikidatum::Statement]
+    def statement(id:)
+      raise ArgumentError, "#{id.inspect} is an invalid Wikibase Statement ID. Must be a string in the format 'Q123$f004ec2b-4857-3b69-b370-e8124f5bd3ac'." unless id.match?(STATEMENT_REGEX)
 
-    response = get_request("/statements/#{id}")
+      response = get_request("/statements/#{id}")
 
-    puts JSON.pretty_generate(response) if ENV['DEBUG']
+      puts JSON.pretty_generate(response) if ENV['DEBUG']
 
-    Wikidatum::Statement.marshal_load(response)
-  end
+      Wikidatum::Statement.marshal_load(response)
+    end
 
-  # Add a statement to an item.
-  #
-  # NOTE: Adding references/qualifiers with `add_statement` is untested and
-  # effectively unsupported for now.
-  #
-  # @example Add a string statement.
-  #   wikidatum_client.add_statement(
-  #     id: 'Q123',
-  #     property: 'P23',
-  #     datavalue: Wikidatum::DataValueType::WikibaseString.new(string: 'Foo'),
-  #     comment: 'Adding something or another.'
-  #   )
-  #
-  # @example Add a 'no value' statement.
-  #   wikidatum_client.add_statement(
-  #     id: 'Q123',
-  #     property: 'P124',
-  #     datavalue: Wikidatum::DataValueType::NoValue.new(
-  #       type: :no_value,
-  #       value: nil
-  #     )
-  #   )
-  #
-  # @example Add an 'unknown value' statement.
-  #   wikidatum_client.add_statement(
-  #     id: 'Q123',
-  #     property: 'P124',
-  #     datavalue: Wikidatum::DataValueType::SomeValue.new(
-  #       type: :some_value,
-  #       value: nil
-  #     )
-  #   )
-  #
-  # @example Add a globe coordinate statement.
-  #   wikidatum_client.add_statement(
-  #     id: 'Q123',
-  #     property: 'P124',
-  #     datavalue: Wikidatum::DataValueType::GlobeCoordinate.new(
-  #       latitude: 52.51666,
-  #       longitude: 13.3833,
-  #       precision: 0.01666,
-  #       globe: 'https://wikidata.org/entity/Q2'
-  #     )
-  #   )
-  #
-  # @example Add a monolingual text statement.
-  #   wikidatum_client.add_statement(
-  #     id: 'Q123',
-  #     property: 'P124',
-  #     datavalue: Wikidatum::DataValueType::MonolingualText.new(
-  #       language: 'en',
-  #       text: 'Foobar'
-  #     )
-  #   )
-  #
-  # @example Add a quantity statement.
-  #   wikidatum_client.add_statement(
-  #     id: 'Q123',
-  #     property: 'P124',
-  #     datavalue: Wikidatum::DataValueType::Quantity.new(
-  #       amount: '+12',
-  #       upper_bound: nil,
-  #       lower_bound: nil,
-  #       unit: 'https://wikidata.org/entity/Q1234'
-  #     )
-  #   )
-  #
-  # @example Add a time statement.
-  #   wikidatum_client.add_statement(
-  #     id: 'Q123',
-  #     property: 'P124',
-  #     datavalue: Wikidatum::DataValueType::Time.new(
-  #       time: '+2022-08-12T00:00:00Z',
-  #       time_zone: 0,
-  #       precision: 11,
-  #       calendar_model: 'https://wikidata.org/entity/Q1234'
-  #     )
-  #   )
-  #
-  # @example Add a Wikibase item statement.
-  #   wikidatum_client.add_statement(
-  #     id: 'Q123',
-  #     property: 'P124',
-  #     datavalue: Wikidatum::DataValueType::WikibaseEntityId.new(
-  #       entity_type: 'item',
-  #       numeric_id: 1234,
-  #       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 references [Array<Wikidatum::Reference>]
-  # @param rank [String]
-  # @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)
-    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)
-
-    id = coerce_item_id(id)
-
-    # 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'
-      statement_hash = {
-        mainsnak: {
-          snaktype: 'novalue',
-          property: property,
-          datatype: datatype
+    # Add a statement to an item.
+    #
+    # NOTE: Adding references/qualifiers with `add_statement` is untested and
+    # effectively unsupported for now.
+    #
+    # @example Add a string statement.
+    #   wikidatum_client.add_statement(
+    #     id: 'Q123',
+    #     property: 'P23',
+    #     datavalue: Wikidatum::DataValueType::WikibaseString.new(string: 'Foo'),
+    #     comment: 'Adding something or another.'
+    #   )
+    #
+    # @example Add a 'no value' statement.
+    #   wikidatum_client.add_statement(
+    #     id: 'Q123',
+    #     property: 'P124',
+    #     datavalue: Wikidatum::DataValueType::NoValue.new(
+    #       type: :no_value,
+    #       value: nil
+    #     )
+    #   )
+    #
+    # @example Add an 'unknown value' statement.
+    #   wikidatum_client.add_statement(
+    #     id: 'Q123',
+    #     property: 'P124',
+    #     datavalue: Wikidatum::DataValueType::SomeValue.new(
+    #       type: :some_value,
+    #       value: nil
+    #     )
+    #   )
+    #
+    # @example Add a globe coordinate statement.
+    #   wikidatum_client.add_statement(
+    #     id: 'Q123',
+    #     property: 'P124',
+    #     datavalue: Wikidatum::DataValueType::GlobeCoordinate.new(
+    #       latitude: 52.51666,
+    #       longitude: 13.3833,
+    #       precision: 0.01666,
+    #       globe: 'https://wikidata.org/entity/Q2'
+    #     )
+    #   )
+    #
+    # @example Add a monolingual text statement.
+    #   wikidatum_client.add_statement(
+    #     id: 'Q123',
+    #     property: 'P124',
+    #     datavalue: Wikidatum::DataValueType::MonolingualText.new(
+    #       language: 'en',
+    #       text: 'Foobar'
+    #     )
+    #   )
+    #
+    # @example Add a quantity statement.
+    #   wikidatum_client.add_statement(
+    #     id: 'Q123',
+    #     property: 'P124',
+    #     datavalue: Wikidatum::DataValueType::Quantity.new(
+    #       amount: '+12',
+    #       upper_bound: nil,
+    #       lower_bound: nil,
+    #       unit: 'https://wikidata.org/entity/Q1234'
+    #     )
+    #   )
+    #
+    # @example Add a time statement.
+    #   wikidatum_client.add_statement(
+    #     id: 'Q123',
+    #     property: 'P124',
+    #     datavalue: Wikidatum::DataValueType::Time.new(
+    #       time: '+2022-08-12T00:00:00Z',
+    #       time_zone: 0,
+    #       precision: 11,
+    #       calendar_model: 'https://wikidata.org/entity/Q1234'
+    #     )
+    #   )
+    #
+    # @example Add a Wikibase item statement.
+    #   wikidatum_client.add_statement(
+    #     id: 'Q123',
+    #     property: 'P124',
+    #     datavalue: Wikidatum::DataValueType::WikibaseEntityId.new(
+    #       entity_type: 'item',
+    #       numeric_id: 1234,
+    #       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 references [Array<Wikidatum::Reference>]
+    # @param rank [String]
+    # @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)
+      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)
+
+      id = coerce_item_id(id)
+
+      # 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'
+        statement_hash = {
+          mainsnak: {
+            snaktype: 'novalue',
+            property: property,
+            datatype: datatype
+          }
         }
-      }
-    when 'Wikidatum::DataValueType::SomeValue'
-      statement_hash = {
-        mainsnak: {
-          snaktype: 'somevalue',
-          property: property,
-          datatype: datatype
+      when 'Wikidatum::DataValueType::SomeValue'
+        statement_hash = {
+          mainsnak: {
+            snaktype: 'somevalue',
+            property: property,
+            datatype: datatype
+          }
         }
-      }
-    when 'Wikidatum::DataValueType::GlobeCoordinate', 'Wikidatum::DataValueType::MonolingualText', 'Wikidatum::DataValueType::Quantity', 'Wikidatum::DataValueType::WikibaseString', 'Wikidatum::DataValueType::Time', 'Wikidatum::DataValueType::WikibaseEntityId'
-      statement_hash = {
-        mainsnak: {
-          snaktype: 'value',
-          property: property,
-          datatype: datatype,
-          datavalue: {
-            type: datavalue.wikibase_type,
-            value: datavalue.marshal_dump
+      when 'Wikidatum::DataValueType::GlobeCoordinate', 'Wikidatum::DataValueType::MonolingualText', 'Wikidatum::DataValueType::Quantity', 'Wikidatum::DataValueType::WikibaseString', 'Wikidatum::DataValueType::Time', 'Wikidatum::DataValueType::WikibaseEntityId'
+        statement_hash = {
+          mainsnak: {
+            snaktype: 'value',
+            property: property,
+            datatype: datatype,
+            datavalue: {
+              type: datavalue.wikibase_type,
+              value: datavalue.marshal_dump
+            }
           }
         }
-      }
-    else
-      raise ArgumentError, "Expected an instance of one of Wikidatum::DataValueType's subclasses for datavalue, but got #{datavalue.inspect}."
-    end
+      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, type: "statement" }) }
 
-    response = post_request("/entities/items/#{id}/statements", body, tags: tags, comment: comment)
+      response = post_request("/entities/items/#{id}/statements", body, tags: tags, comment: comment)
 
-    puts JSON.pretty_generate(response) if ENV['DEBUG']
+      puts JSON.pretty_generate(response) if ENV['DEBUG']
 
-    response.success?
-  end
-
-  # Delete a statement from an item.
-  #
-  # @example
-  #   wikidatum_client.delete_statement(
-  #     id: 'Q123$4543523c-1d1d-1111-1e1e-11b11111b1f1',
-  #     comment: "Deleting this statement because it's bad."
-  #   )
-  #
-  # @param id [String] the ID of the statemnt being deleted.
-  # @param tags [Array<String>]
-  # @param comment [String, nil]
-  # @return [Boolean] True if the request succeeded.
-  def delete_statement(id:, tags: [], comment: nil)
-    raise ArgumentError, "#{id.inspect} is an invalid Wikibase Statement ID. Must be a string in the format 'Q123$f004ec2b-4857-3b69-b370-e8124f5bd3ac'." unless id.match?(STATEMENT_REGEX)
-
-    response = delete_request("/statements/#{id}", tags: tags, comment: comment)
-
-    puts JSON.pretty_generate(response) if ENV['DEBUG']
-
-    response.success?
-  end
+      response.success?
+    end
 
-  private
+    # Delete a statement from an item.
+    #
+    # @example
+    #   wikidatum_client.delete_statement(
+    #     id: 'Q123$4543523c-1d1d-1111-1e1e-11b11111b1f1',
+    #     comment: "Deleting this statement because it's bad."
+    #   )
+    #
+    # @param id [String] the ID of the statemnt being deleted.
+    # @param tags [Array<String>]
+    # @param comment [String, nil]
+    # @return [Boolean] True if the request succeeded.
+    def delete_statement(id:, tags: [], comment: nil)
+      raise ArgumentError, "#{id.inspect} is an invalid Wikibase Statement ID. Must be a string in the format 'Q123$f004ec2b-4857-3b69-b370-e8124f5bd3ac'." unless id.match?(STATEMENT_REGEX)
+
+      response = delete_request("/statements/#{id}", tags: tags, comment: comment)
+
+      puts JSON.pretty_generate(response) if ENV['DEBUG']
+
+      response.success?
+    end
 
-  # For now this just returns the `@wikibase_url`, but in the future the API
-  # routes will presumably be nested further, so this is just future-proofing
-  # to allow that to be easily changed later.
-  #
-  # @return [String] URL for the Wikibase API endpoint.
-  def api_url
-    @api_url ||= "#{@wikibase_url}/w/rest.php/wikibase/v0"
-  end
+    private
 
-  # Default headers to be sent with every request.
-  #
-  # @return [Hash] A hash of some headers that should be used when sending a request.
-  def universal_headers
-    @universal_headers ||= {
-      'User-Agent' => @user_agent,
-      'Content-Type' => 'application/json'
-    }
-  end
+    # For now this just returns the `@wikibase_url`, but in the future the API
+    # routes will presumably be nested further, so this is just future-proofing
+    # to allow that to be easily changed later.
+    #
+    # @return [String] URL for the Wikibase API endpoint.
+    def api_url
+      @api_url ||= "#{@wikibase_url}/w/rest.php/wikibase/v0"
+    end
 
-  # Make a GET request to a given Wikibase endpoint.
-  #
-  # @param path [String] The relative path for the API endpoint.
-  # @param params [Hash] Query parameters to send with the request, if any.
-  # @return [Hash] JSON response, parsed into a hash.
-  def get_request(path, params = nil)
-    url = "#{api_url}#{path}"
-
-    response = Faraday.get(url, params, universal_headers)
-
-    # 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
+    # Default headers to be sent with every request.
+    #
+    # @return [Hash] A hash of some headers that should be used when sending a request.
+    def universal_headers
+      @universal_headers ||= {
+        'User-Agent' => @user_agent,
+        'Content-Type' => 'application/json'
+      }
     end
 
-    JSON.parse(response.body)
-  end
+    # Make a GET request to a given Wikibase endpoint.
+    #
+    # @param path [String] The relative path for the API endpoint.
+    # @param params [Hash] Query parameters to send with the request, if any.
+    # @return [Hash] JSON response, parsed into a hash.
+    def get_request(path, params = nil)
+      url = "#{api_url}#{path}"
 
-  # Make a POST request to a given Wikibase endpoint.
-  #
-  # @param path [String] The relative path for the API endpoint.
-  # @param body [Hash] The body to post to the endpoint.
-  # @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)
-    url = "#{api_url}#{path}"
-
-    body[:bot] = @bot
-    body[:tags] = tags unless tags.empty?
-    body[:comment] = comment unless comment.nil?
-
-    response = Faraday.post(url) do |req|
-      req.body = JSON.generate(body)
-      req.headers = universal_headers
+      response = Faraday.get(url, params, universal_headers)
+
+      # 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
+
+      JSON.parse(response.body)
     end
 
-    puts response.body.inspect if ENV['DEBUG']
+    # Make a POST request to a given Wikibase endpoint.
+    #
+    # @param path [String] The relative path for the API endpoint.
+    # @param body [Hash] The body to post to the endpoint.
+    # @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)
+      url = "#{api_url}#{path}"
 
-    response
-  end
+      body[:bot] = @bot
+      body[:tags] = tags unless tags.empty?
+      body[:comment] = comment unless comment.nil?
 
-  # Make a DELETE request to a given Wikibase endpoint.
-  #
-  # @param path [String] The relative path for the API endpoint.
-  # @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 delete_request(path, tags: [], comment: nil)
-    url = "#{api_url}#{path}"
-
-    body = {}
-    body[:bot] = @bot
-    body[:tags] = tags unless tags.empty?
-    body[:comment] = comment unless comment.nil?
-
-    response = Faraday.delete(url) do |req|
-      req.body = JSON.generate(body)
-      req.headers = universal_headers
-    end
+      response = Faraday.post(url) do |req|
+        req.body = JSON.generate(body)
+        req.headers = universal_headers
+      end
 
-    puts response.body.inspect if ENV['DEBUG']
+      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
+      response
     end
 
-    response
-  end
+    # Make a DELETE request to a given Wikibase endpoint.
+    #
+    # @param path [String] The relative path for the API endpoint.
+    # @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 delete_request(path, tags: [], comment: nil)
+      url = "#{api_url}#{path}"
+
+      body = {}
+      body[:bot] = @bot
+      body[:tags] = tags unless tags.empty?
+      body[:comment] = comment unless comment.nil?
+
+      response = Faraday.delete(url) do |req|
+        req.body = JSON.generate(body)
+        req.headers = universal_headers
+      end
+
+      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
 
-  # Coerce an Item ID in the formats 'Q123', '123' or 123 into a consistent
-  # 'Q123' format. We need to have the ID in the format 'Q123' for the API
-  # request, which is why coercion is necessary.
-  #
-  # @param id [String, Integer]
-  # @return [String]
-  def coerce_item_id(id)
-    return id if id.to_s.start_with?('Q')
+    # Coerce an Item ID in the formats 'Q123', '123' or 123 into a consistent
+    # 'Q123' format. We need to have the ID in the format 'Q123' for the API
+    # request, which is why coercion is necessary.
+    #
+    # @param id [String, Integer]
+    # @return [String]
+    def coerce_item_id(id)
+      return id if id.to_s.start_with?('Q')
 
-    "Q#{id}"
+      "Q#{id}"
+    end
   end
 end

data/lib/wikidatum/version.rb

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

data/lib/wikidatum.rb

@@ -1,15 +1,15 @@
 # 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_value_type'
+require 'wikidatum/item'
+require 'wikidatum/qualifier'
+require 'wikidatum/reference'
+require 'wikidatum/sitelink'
+require 'wikidatum/snak'
+require 'wikidatum/statement'
+require 'wikidatum/term'
+require 'wikidatum/version'
 
 module Wikidatum
   class Error < StandardError; 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikidatum
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Connor Shea
@@ -32,11 +32,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
 - lib/wikidatum.rb

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]