mediawiki_api-wikidata 0.0.1 → 0.3.0

data/README.md

@@ -1,37 +1,67 @@
-# WikidataAPI
-
-[![Build Status](https://api.travis-ci.org/wmde/WikidataApiGem.png?branch=master)](http://travis-ci.org/wmde/WikidataApiGem)
-
-A library for interacting with the Wikidata API from Ruby.
-Extends the [MediaWiki API Gem](https://github.com/wikimedia/mediawiki-ruby-api).
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'mediawiki_api-wikidata'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install mediawiki_api-wikidata
-
-## Usage
-
-```ruby
-require "mediawiki_api/wikidata"
-
-wikidata_client = MediawikiApi::Wikidata::WikidataClient.new "http://127.0.0.1/w/api.php" #instantiate new client
-wikidata_client.log_in "username", "password" #log in via the API
-wikidata_client.create_entity "data" #create a new item specified by "data"
-```
-
-## Release notes
-
-### 0.0.1 (2014-09-29)
-
-- Initial version
-- supports creation of entities via wbeditentity
+# Wikidata API Gem
+
+[![Build Status](https://api.travis-ci.org/wmde/WikidataApiGem.png?branch=master)](http://travis-ci.org/wmde/WikidataApiGem)
+
+A library for interacting with the Wikidata API from Ruby.
+Extends the [MediaWiki API Gem](https://github.com/wikimedia/mediawiki-ruby-api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mediawiki_api-wikidata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mediawiki_api-wikidata
+
+## Usage
+
+```ruby
+require "mediawiki_api/wikidata"
+
+wikidata_client = MediawikiApi::Wikidata::WikidataClient.new "http://127.0.0.1/w/api.php" #instantiate new client
+wikidata_client.log_in "username", "password" #log in via the API
+wikidata_client.create_item "data" #create a new item specified by "data"
+wikidata_client.create_property "data" #create a new property specified by "data"
+wikidata_client.add_sitelink "Q1234", "enwiki", "Berlin" #add a new sitelink enwiki/Berlin to item Q1234
+wikidata_client.remove_sitelink "Q1234", "enwiki" #remove enwiki sitelink from item Q1234
+wikidata_client.sitelink_exists? "enwiki", "Berlin" #returns true if enwiki/Berlin sitelink exists, false otherwise
+wikidata_client.create_claim "Q1234", "value", "P1234", '"test"' #adds claim with property P1234 and value "test" to item Q1234
+wikidata_client.search_entities "test", "en", "item" #searches for items containing the string "test" in their english labels, descriptions and aliases
+```
+
+## Release notes
+### 0.3.0 (2021-06-08)
+- Compatible with [mediawiki_api 7.0](https://rubygems.org/gems/mediawiki_api/versions/0.7.1)
+- Compatible with  Ruby 2.5
+- Support for several API actions.
+
+### 0.2.1 (2016-05-26)
+- Compatible with [mediawiki_api 6.0](https://rubygems.org/gems/mediawiki_api/versions/0.6.0)
+
+### 0.2.0 (2015-10-09)
+- Compatible with [mediawiki_api 5.0](https://rubygems.org/gems/mediawiki_api/versions/0.5.0)
+
+### 0.1.0 (2014-10-09)
+- Feature complete for [Wikidata BrowserTests](https://github.com/wmde/WikidataBrowserTests)
+- Support creating claims
+- Support searching entities
+
+### 0.0.2 (2014-10-09)
+
+- Support adding sitelinks
+- Support changing sitelinks
+- Support removing sitelinks
+- Support checking for existing sitelinks
+- Provide separate methods for creating items and properties
+- Removed custom edit summaries
+
+### 0.0.1 (2014-09-29)
+
+- Initial version
+- Supports creation of entities via wbeditentity

data/lib/mediawiki_api/wikidata/exceptions.rb

@@ -0,0 +1,10 @@
+module MediawikiApi
+  module Wikidata
+    class WikidataApiError < ApiError
+
+    end
+
+    class EntityIdentifierMismatchError < StandardError
+    end
+  end
+end

data/lib/mediawiki_api/wikidata/version.rb

@@ -1,5 +1,5 @@
 module MediawikiApi
   module Wikidata
-    VERSION = "0.0.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/mediawiki_api/wikidata/wikidata_client.rb

@@ -1,16 +1,80 @@
-# Author:: Tobias Gritschacher (tobias.gritschacher@wikimedia.de)
-# License:: GNU GPL v2+
-
-require "mediawiki_api/wikidata/version"
-
-module MediawikiApi
-  module Wikidata
-    class WikidataClient < Client
-
-      def create_entity(data, type = "item")
-        action(:wbeditentity, token_type: "edit", new: type, data: data, summary:"Created entity using mediawiki_api/wikidata gem")
-      end
-
-    end
-  end
-end
+# Author:: Tobias Gritschacher (tobias.gritschacher@wikimedia.de)
+# License:: GNU GPL v2+
+
+require "mediawiki_api/wikidata/version"
+require "mediawiki_api/wikidata/exceptions"
+
+module MediawikiApi
+  module Wikidata
+    class WikidataClient < Client
+
+      def create_entity(entity_data, type)
+        action(:wbeditentity, token_type: "csrf", new: type, data: entity_data)
+      end
+
+      def create_item(item_data)
+        create_entity(item_data, "item")
+      end
+
+      def create_property(property_data)
+        create_entity(property_data, "property")
+      end
+
+      def set_sitelink(entity_identifier, sitelink_site_id, sitelink_title = nil, badges = nil)
+        params = { token_type: "csrf", linksite: sitelink_site_id, linktitle: sitelink_title, badges: badges}
+        action(:wbsetsitelink, params.merge(parse_entity_identifier(entity_identifier)))
+      end
+
+      def add_sitelink(entity_identifier, sitelink_site_id, sitelink_title, badges = nil)
+        set_sitelink(entity_identifier, sitelink_site_id, sitelink_title, badges)
+      end
+
+      def remove_sitelink(entity_identifier, sitelink_site_id)
+        set_sitelink(entity_identifier, sitelink_site_id)
+      end
+
+      def sitelink_exists?(site_id, title)
+        resp = action(:wbgetentities, token_type: false, sites: [site_id], titles: [title] )
+        !resp.data["entities"]["-1"]
+      end
+
+      def search_entities(search, language, entity_type, limit = 10, continue = nil)
+        action(:wbsearchentities, token_type: false, search: search, language: language, type: entity_type, limit: limit,
+               continue: continue)
+      end
+
+      def create_claim(entity_id, snaktype = "value", property_id, value_data)
+        action(:wbcreateclaim, token_type: "csrf", entity: entity_id, snaktype: snaktype, property: property_id, value: value_data)
+      end
+
+      def get_entities(ids)
+        action(:wbgetentities, token_type: false, ids: ids)
+      end
+
+      def get_entities_by_titles(titles, sites)
+        action(:wbgetentities, token_type: false, titles: titles, sites: sites)
+      end
+
+      def set_qualifier(claim_id, snaktype = "value", property_id, value_data)
+        action(:wbsetqualifier, token_type: "csrf", claim: claim_id, snaktype: snaktype, property: property_id, value: value_data)
+      end
+
+      def set_reference(statement_id, snaks_data)
+        action(:wbsetreference, token_type: "csrf", statement: statement_id, snaks: snaks_data)
+      end
+
+      private
+
+      def parse_entity_identifier(identifier)
+        if identifier.is_a?(::Hash)
+          { site: identifier[:site_id], title: identifier[:title] }
+        elsif identifier.is_a?(String)
+          { id: identifier }
+        else
+          raise EntityIdentifierMismatchError, "Either entity id or site id and page title need to be set to identify the entity."
+        end
+      end
+
+    end
+  end
+end

data/mediawiki_api-wikidata.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "mediawiki_api", "~> 0.2.0"
+  spec.add_runtime_dependency "mediawiki_api", "~> 0.7.1"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 0"

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'webmock/rspec'
-require 'json'
-require 'mediawiki_api'
-require 'mediawiki_api/wikidata'
+require 'webmock/rspec'
+require 'json'
+require 'mediawiki_api'
+require 'mediawiki_api/wikidata'

data/spec/support/request_helpers.rb

@@ -1,34 +1,40 @@
-module MediawikiApi::Wikidata::RequestHelpers
-  def api_url
-    "http://localhost/api.php"
-  end
-
-  def index_url
-    "http://localhost/w/index.php"
-  end
-
-  def mock_token
-    "token123"
-  end
-
-  def stub_api_request(method, params)
-    params = params.each.with_object({}) { |(k, v), p| p[k] = v.to_s }
-
-    stub_request(method, api_url).
-        with((method == :post ? :body : :query) => params.merge(format: "json"))
-  end
-
-  def stub_action_request(action, params = {})
-    method = params.delete(:http_method) || :post
-
-    stub_api_request(method, params.merge(action: action, token: mock_token))
-  end
-
-  def stub_token_request(type, warning = nil)
-    response = { tokens: { "#{type}token" => mock_token } }
-    response[:warnings] = { type => { "*" => [warning] } } unless warning.nil?
-
-    stub_api_request(:get, action: "tokens", type: type).
-        to_return(body: response.to_json)
-  end
-end
+module MediawikiApi::Wikidata::RequestHelpers
+  def api_url
+    "http://localhost/api.php"
+  end
+
+  def index_url
+    "http://localhost/w/index.php"
+  end
+
+  def mock_token
+    "token123"
+  end
+
+  def stub_api_request(method, params)
+    params = params.each.with_object({}) { |(k, v), p| p[k] = v.to_s }
+
+    stub_request(method, api_url).
+        with((method == :post ? :body : :query) => params.merge(format: "json"))
+  end
+
+  def stub_action_request(action, params = {})
+    method = params.delete(:http_method) || :post
+
+    stub_api_request(method, params.merge(action: action, token: mock_token))
+  end
+
+  def stub_action_request_without_token(action, params = {})
+    method = params.delete(:http_method) || :post
+
+    stub_api_request(method, params.merge(action: action))
+  end
+
+  def stub_token_request(type, warning = nil)
+    response = { query: { tokens: { "#{type}token" => mock_token } } }
+    response[:warnings] = { type => { '*' => [warning] } } unless warning.nil?
+
+    stub_api_request(:get, action: 'query', meta: 'tokens', type: type).
+        to_return(body: response.to_json)
+  end
+end

data/spec/wikidata_client_spec.rb

@@ -1,32 +1,246 @@
-require 'spec_helper'
-require "webmock/rspec"
-require "support/request_helpers"
-
-describe MediawikiApi::Wikidata::WikidataClient do
-  include MediawikiApi::Wikidata::RequestHelpers
-
-  let(:client) { MediawikiApi::Wikidata::WikidataClient.new(api_url) }
-
-  subject { client }
-
-  describe "#create_entity" do
-    subject { client.create_entity(data, type) }
-
-    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},"descriptions":{"en":{"language":"en","value":"test_description"}}}' }
-    let(:type) { "item" }
-    let(:summary) { "Created entity using mediawiki_api/wikidata gem" }
-    let(:response) { {} }
-
-    before do
-      stub_token_request(:edit)
-      @edit_request = stub_action_request(:wbeditentity, data: data, new: type, summary: summary).
-          to_return(body: response.to_json)
-    end
-
-    it "makes the right request" do
-      subject
-      expect(@edit_request).to have_been_requested
-    end
-  end
-
-end
+require 'spec_helper'
+require "webmock/rspec"
+require "support/request_helpers"
+
+describe MediawikiApi::Wikidata::WikidataClient do
+  include MediawikiApi::Wikidata::RequestHelpers
+
+  let(:client) { MediawikiApi::Wikidata::WikidataClient.new(api_url) }
+
+  subject { client }
+
+  describe "#create_entity" do
+    subject { client.create_entity(data, type) }
+
+    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},
+                   "descriptions":{"en":{"language":"en","value":"test_description"}}}' }
+    let(:type) { "item" }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbeditentity, data: data, new: type).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#create_item" do
+    subject { client.create_item(data) }
+
+    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},
+                   "descriptions":{"en":{"language":"en","value":"test_description"}}}' }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbeditentity, data: data, new: "item").
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#create_property" do
+    subject { client.create_property(data) }
+
+    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},
+                   "descriptions":{"en":{"language":"en","value":"test_description"}},"datatype":"string"}' }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbeditentity, data: data, new: "property").
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#create_property" do
+    subject { client.create_property(data) }
+
+    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},
+                   "descriptions":{"en":{"language":"en","value":"test_description"}},"datatype":"string"}' }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbeditentity, data: data, new: "property").
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#set_sitelink (item identified by site/title)" do
+    subject { client.set_sitelink(entity_identifier, sitelink_site_id, sitelink_title, badges) }
+
+    let(:entity_identifier) { {site_id: "dewiki", title: "Berlin"} }
+    let(:sitelink_site_id) { "itwiki" }
+    let(:sitelink_title) { "Berlino" }
+    let(:badges) { true }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbsetsitelink, site: "dewiki", title: "Berlin", linksite: sitelink_site_id,
+                                          linktitle: sitelink_title, badges: badges).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#set_sitelink (item identified by ID)" do
+    subject { client.set_sitelink(entity_identifier, sitelink_site_id, sitelink_title, badges) }
+
+    let(:entity_identifier) { "Q1234" }
+    let(:sitelink_site_id) { "itwiki" }
+    let(:sitelink_title) { "Berlino" }
+    let(:badges) { true }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbsetsitelink, id: "Q1234", linksite: sitelink_site_id,
+                                          linktitle: sitelink_title, badges: badges).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#create_claim" do
+    subject { client.create_claim(entity_id, snaktype, property_id, value) }
+
+    let(:entity_id) { "Q1234" }
+    let(:snaktype) { "value" }
+    let(:property_id) { "P1234" }
+    let(:value) { '"stringtest"' }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbcreateclaim, entity: entity_id, snaktype: snaktype, property: property_id, value: value).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+  describe "#search_entities" do
+    subject { client.search_entities(search, language, entity_type, limit, continue) }
+
+    let(:search) { "test" }
+    let(:language) { "en" }
+    let(:entity_type) { "item" }
+    let(:limit) { 10 }
+    let(:continue) { "" }
+    let(:response) { {} }
+
+    before do
+      @edit_request = stub_action_request_without_token(:wbsearchentities, search: search, language: language, type: entity_type,
+                                                        limit: limit, continue: continue).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+  describe "#get_entities" do
+    subject { client.get_entities(entity_ids) }
+
+    let(:entity_ids) { ["Q1234","Q234"] }
+    let(:response) { {} }
+
+    before do
+      @edit_request = stub_action_request_without_token(:wbgetentities, ids: entity_ids.join("|")).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+  describe "#get_entities_by_titles" do
+    subject { client.get_entities_by_titles(titles, site_ids) }
+
+    let(:titles) { "mediawiki" }
+    let(:site_ids) { ["jawiki"] }
+    let(:response) { {} }
+
+    before do
+      @edit_request = stub_action_request_without_token(:wbgetentities, titles: titles, sites: site_ids.join("|")).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+  describe "#set_qualifier" do
+    subject { client.set_qualifier(claim_id, property_id, value) }
+
+    let(:claim_id) { "Q2$4554c0f4-47b2-1cd9-2db9-aa270064c9f3" }
+    let(:snaktype) { "value" }
+    let(:property_id) { "P1234" }
+    let(:value) { "stringtest".to_json }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbsetqualifier, claim: claim_id, snaktype: snaktype, property: property_id, value: value).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+  describe "#set_reference" do
+    subject { client.set_reference(statement_id, snaks) }
+
+    let(:statement_id) { "Q76$D4FDE516-F20C-4154-ADCE-7C5B609DFDFF" }
+    let(:property_id) { "P1234" }
+    let(:snaks) {{property_id=>[{"snaktype"=>"value", "property"=>property_id, "datavalue"=>"stringtest"}]}.to_json}
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:csrf)
+      @edit_request = stub_action_request(:wbsetreference, statement: statement_id, snaks: snaks).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+end